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 r0681

...

To enable programmatic control over its objects, the 

D s
rtrue
 supports a range of REST API endpoints across the objects in the platform. This section provides an overview of the API design, methods, and supported use cases.

Supported operations:

  • Connections: Get information about connections
  • Datasets: Create, list, update, and delete operations on datasets
    • Swap datasets
  • Jobs and Results:
    • Launch job
    • Get job status
    • Publish job results
    • Create dataset from results
  • Get profile metadata:
    • Quality bar status
    • Schema (column names and types)
  • Users: Create, list, delete

Uses:

...

-product
rtrue
 supports a range of REST API endpoints across the objects in the platform. This section provides an overview of the API design, methods, and supported use cases.


Design Overview

URL Format 

...

ElementDescriptionExample
<http/https>

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

https
<my_server>

Name of the

D s node

myapp.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 v4.

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

...

OperationHTTP MethodExample URLNotes
CreatePOST/v4/people jobgroups  
POST/v4/connectionsimportedDatasets 
ReadGET/v4/peoplejobgroups/11 = internal user jobgroup Id
GET/v4/connectionsimportedDatasets/1010 = internal connection imported dataset IdGET
/v4/people/1/flows ListGET/v4/peopleflows 
GET/v4/connectionswrangledDatasets 
UpdatePATCH/v4/people/1Partial replacementPATCH/v4/connections/wrangledDatasets/10Partial replacement
PUT/v4/peopleoutputObjects/1Full replacementPUT/v4/connections/10Full Partial replacement
DeleteDELETE/v4/peopleimportedDatasets/1 
DELETE/v4/connectionsoutputObjects/10 

Embedding Associations

...

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 
requiredresponse bodyresponse header:
Content-Type: application/json 
required

Request identifier

Each request contains a request identifier in the following form:

Code Block
x-trifacta-request-id: <myRequestId>

The above request header also appears as a header in the response.

Info

NOTE: If you have an issue with a specific request, please include the x-trifacta-request-id value when you contact

D s support
.

Authentication

Each call to an API endpoint must include authentication credentials for a user with access to the requested objects. See API Authentication.

...

If SSL has been enabled for the 

D s platform
the platform, requests to URL endpoints are automatically redirected to the HTTPS equivalent.

...

Unless otherwise noted, the documentation and examples apply to latest version of the 

D s platform
 APIsthe platform APIs.

API examples

Examples may require modification to work in your environment.

...