CRM Analytics REST API Developer Guide
jNote: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
Dataflow Resource
- Resource URL
-
1/wave/dataflows/<dataflowId> - Formats
- JSON
- Available Version
- 37.0
Available in Postman
To view and test a working example of this resource, see getDataflow in Postman. For information about how to authenticate your org with Postman, see the CRM Analytics Rest API Quick Start.
- HTTP Methods
- GET PATCH (50.0) PUT
- Run a Dataflow
- To schedule a dataflow, use the Dataflow Jobs Resource API. For examples of how to start and stop dataflows, see Start and Stop a Dataflow Job or Recipe.
- Schedule a Dataflow
- To schedule a dataflow, use the Schedule Resource API. For examples of how to schedule dataflows, see Schedule Dataflows, Recipes, and Data Syncs.
- Request parameters for GET
-
Parameter Name Type Description Required or Optional Available Version historyId String Use the history ID to request a specific dataflow version. Optional 42.0 - Response body for GET, PATCH, and PUT
- Dataflow
- Request body for PATCH
- Dataflow Input
- Request body for PUT
- Use the PUT API request to revert to a previous historical version.
Asset Revert History Input
The following JSON shows the revert request for a dataflow version.
1{ 2 "historyId" : "0RmS7000000xxxxxxx" 3}