Data flows
Dataflow Service is a RESTful service for listing data flows.
Get a list of data flows
GET
request returns the list of data flows.
Path Parameters
None
Request Parameters
Parameter | Description |
---|---|
|
The container locator of the requested data flows. |
|
Specifies the fields to return in the response. One or more of |
|
An optional FIQL filter expression. Supports searching by the 'name' attribute. For example |
|
The authentication token. |
Response Fields
Path | Type | Description |
---|---|---|
|
|
The object resource locator of the requested data flow. |
|
|
Status of the response. One of: |
|
|
The identity of the data flow. |
|
|
The name of the data flow. |
|
|
Object resource locator identifying the search path that the dataflow uses to locate nodes it references. |
|
|
A map of run property definitions for the data flow. |
|
|
The run property name is used as the key. |
|
|
Name of the run property. This should be used when setting the run property value. |
|
|
The run property type. |
|
|
The visibility level of the run property. |
|
|
Indicates that the property is a run property. This is called |
|
|
Documentation for the run property. |
|
|
For property definitions of type |
|
|
Reserved for future use. |
|
|
Reserved for future use. |
|
|
Reserved for future use. |
|
|
Reserved for future use. |
|
|
Reserved for future use. |
|
|
Reserved for future use. |
Example request
GET /api/v3/dataflows?container=object:!tenant:defaultTenant~directory:workspace-id&fields=object&filter=name%3D%3D'Data%20Flow%20Name'<k=AUTHENTICATION_TOKEN HTTP/1.1
Host: localhost:8080
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1695
{
"status" : "OK",
"data" : {
"objects" : [ {
"locator" : "object:!tenant:defaultTenant~directory:workspace-id~dataflow:dataflow-id-001",
"object" : {
"id" : "dataflow-id-001",
"name" : "First Dataflow",
"searchPathSet" : "object:!tenant:defaultTenant~directory:workspace-id",
"runProperties" : {
"Run Property Name" : {
"name" : "Run Property Name",
"dataType" : "string",
"values" : [ ],
"validators" : [ ],
"documentation" : "A Run Property Definition",
"runParameter" : true,
"visibility" : 1,
"defaultSource" : "defaultSource",
"associatedInputs" : [ ],
"sources" : [ ],
"editors" : [ ],
"currentEditor" : "currentEditor"
}
}
}
}, {
"locator" : "object:!tenant:defaultTenant~directory:workspace-id~dataflow:dataflow-id-002",
"object" : {
"id" : "dataflow-id-002",
"name" : "Second Dataflow",
"searchPathSet" : "object:!tenant:defaultTenant~directory:workspace-id",
"runProperties" : {
"Run Property Name" : {
"name" : "Run Property Name",
"dataType" : "string",
"values" : [ ],
"validators" : [ ],
"documentation" : "A Run Property Definition",
"runParameter" : true,
"visibility" : 1,
"defaultSource" : "defaultSource",
"associatedInputs" : [ ],
"sources" : [ ],
"editors" : [ ],
"currentEditor" : "currentEditor"
}
}
}
} ]
}
}
Get data flow
GET
request returns a specified data flow.
Path Parameters
Parameter | Description |
---|---|
|
The object resource locator of the requested data flow. |
Request Parameters
Parameter | Description |
---|---|
|
The authentication token. |
|
Specifies the fields to return in the response. One or more of |
Response Fields
Path | Type | Description |
---|---|---|
|
|
The object resource locator of the requested data flow. |
|
|
Status of the response. One of: |
|
|
The identity of the data flow. |
|
|
The name of the data flow. |
|
|
Object resource locator identifying the search path that the dataflow uses to locate nodes it references. |
|
|
A map of run property definitions for the data flow. |
|
|
The run property name is used as the key. |
|
|
Name of the run property. This should be used when setting the run property value. |
|
|
The run property type. |
|
|
The visibility level of the run property. |
|
|
Indicates that the property is a run property. This is called |
|
|
Documentation for the run property. |
|
|
For property definitions of type |
|
|
Reserved for future use. |
|
|
Reserved for future use. |
|
|
Reserved for future use. |
|
|
Reserved for future use. |
|
|
Reserved for future use. |
|
|
Reserved for future use. |
|
|
Metadata for the resource. |
|
|
The resource locator that uniquely identifies the resource. |
|
|
The userid of the user that created the resource. |
|
|
The username of the user that created the resource. |
|
|
Creation time of resource in ISO-8601 format. |
|
|
The userid of the user that last modified the resource. |
|
|
The username of the user that last modified the resource. |
|
|
Last modification time of resource in ISO-8601 format. |
|
|
The resource locator that uniquely identifies the container resource. |
|
|
The resource type. |
|
|
The resource id. |
|
|
True if the resource id is universally addressable. |
Example request
GET /api/v3/dataflows/object:!tenant:defaultTenant~directory:workspace-id~dataflow:dataflow-id?ltk=AUTHENTICATION_TOKEN&fields=metadata,object HTTP/1.1
Host: localhost:8080
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1479
{
"status" : "OK",
"data" : {
"metadata" : {
"createdByName" : "Created By User Name",
"modifiedByName" : "Modified By User Name",
"locator" : "object:!tenant:defaultTenant~directory:workspace-id~dataflow:dataflow-id",
"containerLocator" : "object:!tenant:defaultTenant~directory:workspace-id",
"createdBy" : "created-by-user-Id",
"createdOn" : "2023-05-31T03:10:06+0000",
"modifiedBy" : "modified-by-user-Id",
"modifiedOn" : "2023-05-31T03:10:06+0000",
"resourceId" : {
"objectType" : "dataflow",
"objectId" : "dataflow-id",
"universal" : false
},
"universalLocator" : null,
"universalContainerLocator" : null
},
"locator" : "object:!tenant:defaultTenant~directory:workspace-id~dataflow:dataflow-id",
"object" : {
"id" : "dataflow-id",
"name" : "Data flow",
"searchPathSet" : "object:!tenant:defaultTenant~directory:workspace-id",
"runProperties" : {
"Run Property Name" : {
"name" : "Run Property Name",
"dataType" : "string",
"values" : [ ],
"validators" : [ ],
"documentation" : "A Run Property Definition",
"runParameter" : true,
"visibility" : 1,
"defaultSource" : "defaultSource",
"associatedInputs" : [ ],
"sources" : [ ],
"editors" : [ ],
"currentEditor" : "currentEditor"
}
}
}
}
}