API Overview

...

Element Description Example

<http/https>

HTTP protocol identifier. The protocol should be https in a production environment.

https

<my_server>

Name of the

d-s-item
item
node

wrangler.example.com

<port_number>

Port number over which you access the

D s platform

. By default, this value is 3005.

3005

<version>

API version number.

Info
NOTE: Unless stated otherwise, the versions for all API endpoints is `v3` `v4`.

v3

v4

<endpoint> Name of the API endpoint to use. /connections

[resource_id] Internal identifier for the specific resource requested from the endpoint. This value defines the object against which the requested operation is performed. /10

[association]

If applicable, the association identifiers the API endpoint that is requested using the context determined by the <endpoint> and the [resource_id].

Associations can also be referenced by query parameter. See Embedding Associations below.

/jobGroups

[?args] In some cases, arguments can be passed to the endpoint in the form of query parameters. ?arg1=value1&arg2=value2

...

Operation	HTTP Method	Example URL	Notes
Create	`POST`	`/v3v4/people`
Create	`POST`	`/v3v4/jobResultsconnections`
Read	`GET`	`/v3v4/people/1`	`1` = internal user Id
	`GET`	`/v3v4/jobResultsconnections/10`	`10` = internal job connection Id
	`GET`	`/v3v4/people/1/jobGroupsflows`
`GET`	`/v3/jobGroups/4/flowNode`	`flowNode` is a singular reference. Most resource names are plural.
List	`GET`	`/v3v4/people`
List	`GET`	`/v3v4/jobResultsconnections`
Update	`PATCH`	`/v3v4/people/1`	Partial replacement
	`PATCH`	`/v3v4/jobResultsconnections/10`	Partial replacement
	`PUT`	`/v3v4/people/1`	Full replacement
	`PUT`	`/v3v4/jobResultsconnections/10`	Full replacement
Delete	`DELETE`	`/v3v4/people/1`
Delete	`DELETE`	`/v3v4/jobResultsconnections/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. ExampleIn the following example, the sub-jobs of a jobGroup are embedded in the response for jobGroup=1:

Code Block
https:/wrangler.example.com//v3v4/jobGroups/61?embed=flowNodejobs

Example response:

Code Block

{
    "id": 61,
    "name": null,
    "description": null,
    "ranfrom": "ui",
    "ranfor": "recipe",
    "status": "Complete",
    "profilingEnabled": true,
    "runParameterReferenceDate": "2019-04-23T17:00:56.000Z",
    "createdAt": "2019-04-23T17:00:56.728Z",
    "updatedAt": "2019-04-23T17:01:03.084Z",
    "jobs": {
        "data": [
            {
                "id": 1,
                "executionLanguage": "photon",
                "cpJobId": null,
                "templateLocation": null,
                "createdAt": "2019-04-23T17:00:56.952Z",
                "updatedAt": "2019-04-23T17:01:00.670Z",
                "status": "Complete",
                "jobType": "wrangle",
                "sampleSize": 100,
                "percentComplete": 100,
                "lastHeartbeatAt": "2019-04-23T17:00:58.589Z",
                "creator": {
                    "id": 1
                },
                "jobGroup": {
                    "id": 1
                },
                "errorMessage": null,
                "wrangleScript": null,
                "emrcluster": null
            },
            {
                "id": 2,
                "createdAt": "2019-04-23T17:00:57.034Z",
                "updatedAt": "2019-04-23T17:01:02.642Z",
                "status": "Complete",
                "jobType": "filewriter",
                "sampleSize": 100,
                "percentComplete": 100,
                "lastHeartbeatAt": "2019-04-23T17:01:00.922Z",
 "A nifty job group",
  "flowNode               "creator": {
                    "id": 1
                },
                "jobGroup": {
                    "id": 1
                },
     "script           "errorMessage": null,
                "scriptResult": {
                    "id": 1
                },
        "terminal": true
    ...
  }
}        "writeSetting": {
                    "id": 2
                }
            },
            {
                "id": 3,
                "createdAt": "2019-04-23T17:00:57.037Z",
                "updatedAt": "2019-04-23T17:01:03.077Z",
                "status": "Complete",
                "jobType": "filewriter",
                "sampleSize": 100,
                "percentComplete": 100,
                "lastHeartbeatAt": "2019-04-23T17:01:00.843Z",
                "creator": {
                    "id": 1
                },
                "jobGroup": {
                    "id": 1
                },
                "errorMessage": null,
                "scriptResult": {
                    "id": 2
                },
                "writeSetting": {
                    "id": 1
                }
            }
        ]
    },
    "workspace": {
        "id": 1
    },
    "creator": {
        "id": 1
    },
    "updater": {
        "id": 1
    },
    "snapshot": {
        "id": 8
    },
    "wrangledDataset": {
        "id": 7
    },
    "flowRun": null
}

The id value of the association is always included in the response.

...

Info

NOTE: API versioning is not synchronized to specific releases of

D s product

. For example, some API endpoints for v4 may be updated, while v3 instances of the API endpoint are still supported. APIs are designed to be backward compatible.

Warning

In the next release of

D s product

product	ee

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.

...

Request Method	Request Endpoint	HTTP Status Code (success)
`POST`	`/v3v4/<resource>`	201 Created
`GET`	`/v3v4/<resource>`	200 OK
`GET`	`/v3v4/<resource>/<id>`	304 Not Modified when client has cached version. See Caching below.
`PATCH`	`/v3v4/<resource>/<id>`	200 OK
`PUT`	`/v3v4/<resource>/<id>`	200 OK
`DELETE`	`/v3v4/<resource>/<id>`	204 No Content

...

Unless otherwise noted, the documentation and examples apply to version 3 4 (v3v4) of the
D s platform
APIs.
Examples may require modification to work in your environment.

Page tree

Versions Compared

Old Version 1

New Version Current

Key

Embedding Associations