The ArcGIS Data Pipelines REST API allows you to programmatically submit and manage data pipeline runs for ArcGIS Online and ArcGIS Enterprise. This means that you can orchestrate running data pipeline workflows using any framework that can make HTTP requests.
The API is organized into resources and operations. Resources are entities within ArcGIS Data Pipelines that hold some information and have a well-defined state. Operations act on these resources and update their information or state. Resources and operations are hierarchical and have unique universal resource locators (URLs).
Getting Started
The hierarchical root of the REST API begins with a well-defined URL called the site root URL. This is accessible as follows:
https://machine.example.com:14443/arcgis/rest/services/datapipelineshttps://datapipelinesservices.arcgis.com/<orgId>/arcgis/rest/services/datapipelinesOrganized hierarchically from the site URL are the various resources and operations that are exposed by the REST API. To access a resource or invoke an operation you must create a request by:
- Constructing a URL to the selected resource or operation as defined in the API Reference
- Providing the relevant parameters in their specified format
- Accessing the URL over the prescribed HTTP method (typically GET or POST)
The API is stateless, which means that the service does not keep track of transactions from one request to the next. Each request must contain all the information necessary for successful processing. The service will process each request and return a well-defined response.