Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space DEV and version r0641

...

Support for basic CRUD (Create, Read, Update, and Delete) operations across most platform objects.

Info

NOTE: Some of these specific operations may not be supported in the current release. For a complete list, see API Endpoints.

OperationHTTP MethodExample URLNotes
CreatePOST/v4/people  
POST/v4/connections 
ReadGET/v4/people/11 = internal user Id
GET/v4/connections/1010 = internal connection Id
GET/v4/people/1/flows 
ListGET/v4/people 
GET/v4/connections 
UpdatePATCH/v4/people/1Partial replacement
PATCH/v4/connections/10Partial replacement
PUT/v4/people/1Full replacement
PUT/v4/connections/10Full replacement
DeleteDELETE/v4/people/1 
DELETE/v4/connections/10 

 

Embedding Associations

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:

...

ActionHeaderRequired?
Client request that expects a response bodyrequest header:
Accept: application/json 
should include
Client request that includes a request bodyrequest header:
Content-Type: application/json 
required
Server response that includes a response bodyresponse header:
Content-Type: application/json 
required

Authentication

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.

...

Info

NOTE: API versioning is not synchronized to specific releases of

D s product
. APIs are designed to be backward compatible.

Warning

In the next release of

D s product
productee
after Release 6.0, the v3 endpoints are scheduled to be deprecated. You should move to v4 endpoints at this time. For more information, see API Migration to v4.

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
 releases, after which you must reference a newer version of the API.

...

Code Block
<http/https>://<my_server>:<port_number>/<version>/version

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.

UI Integrations

The REST APIs can also be used for integrating the core transformation experience of the 

D s platform
into  into a third-party application. Using a series of URL-based calls, you can retrieve and display specified datasets in the Transformer page, where authenticated users can wrangle datasets controlled by the third-party application. See See API - UI Integrations.

About This Documentation

...