Support for basic CRUD (Create, Read, Update, and Delete) operations across most platform objects.
NOTE: Some of these specific operations may not be supported in the current release. For a complete list, see API Endpoints.
|Operation||HTTP Method||Example URL||Notes|
An association can be referenced using the above URL structuring or by applying the
embed query parameter as part of the reference to the specific resource. In the following example, the sub-jobs of a jobGroup are embedded in the response for jobGroup=1:
|Client request that expects a response body||request header:||should include|
|Client request that includes a request body||request header:||required|
|Server response that includes a response body||response header:||required|
The REST APIs use the same authentication methods as the UI. Each Each call to an API endpoint must include authentication credentials for a user with access to the requested objects. See API Authentication.
NOTE: API versioning is not synchronized to specific releases of
In the next release of
APIs are designed to be backward compatible so that scripts and other tooling built on a previous version of an endpoint remain valid until the previous version has reached end-of-life. Each API is supported across a window of
|D s product|
For more information, see see API Version Support Matrix.
By chaining together sequences of calls to API endpoints, you can create, read, update, and delete objects using identifiers accessible through the returned JSON. For more information, see see API Endpoints.
For more information on endpoint workflows, see see API Workflows.
The REST APIs can also be used for integrating the core transformation experience of the
|D s platform|
About This Documentation