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

container

The container locator of the requested data flows.

fields

Specifies the fields to return in the response. One or more of objects or metadata. Defaults to objects

filter

An optional FIQL filter expression. Supports searching by the 'name' attribute. For example filter=name=='Object Name'

ltk

The authentication token.

Response Fields

Path Type Description

data.objects[].locator

String

The object resource locator of the requested data flow.

status

String

Status of the response. One of: OK, ERROR, SKIPPED or ASYNC

data.objects[].object.id

String

The identity of the data flow.

data.objects[].object.name

String

The name of the data flow.

data.objects[].object.searchPathSet

String

Object resource locator identifying the search path that the dataflow uses to locate nodes it references.

data.objects[].object.runProperties

Object

A map of run property definitions for the data flow.

data.objects[].object.runProperties.Run Property Name

Object

The run property name is used as the key.

data.objects[].object.runProperties.Run Property Name.name

String

Name of the run property. This should be used when setting the run property value.

data.objects[].object.runProperties.Run Property Name.dataType

String

The run property type.

data.objects[].object.runProperties.Run Property Name.visibility

Number

The visibility level of the run property.

data.objects[].object.runProperties.Run Property Name.runParameter

Boolean

Indicates that the property is a run property. This is called runParameter for legacy reasons.

data.objects[].object.runProperties.Run Property Name.documentation

String

Documentation for the run property.

data.objects[].object.runProperties.Run Property Name.values

Array

For property definitions of type choice this is an array of the allowed values.

data.objects[].object.runProperties.Run Property Name.validators

Array

Reserved for future use.

data.objects[].object.runProperties.Run Property Name.defaultSource

String

Reserved for future use.

data.objects[].object.runProperties.Run Property Name.sources

Array

Reserved for future use.

data.objects[].object.runProperties.Run Property Name.currentEditor

String

Reserved for future use.

data.objects[].object.runProperties.Run Property Name.editors

Array

Reserved for future use.

data.objects[].object.runProperties.Run Property Name.associatedInputs

Array

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'&ltk=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

Table 1. /api/v3/dataflows/{locator}
Parameter Description

locator

The object resource locator of the requested data flow.

Request Parameters

Parameter Description

ltk

The authentication token.

fields

Specifies the fields to return in the response. One or more of objects or metadata. Defaults to objects

Response Fields

Path Type Description

data.locator

String

The object resource locator of the requested data flow.

status

String

Status of the response. One of: OK, ERROR, SKIPPED or ASYNC

data.object.id

String

The identity of the data flow.

data.object.name

String

The name of the data flow.

data.object.searchPathSet

String

Object resource locator identifying the search path that the dataflow uses to locate nodes it references.

data.object.runProperties

Object

A map of run property definitions for the data flow.

data.object.runProperties.Run Property Name

Object

The run property name is used as the key.

data.object.runProperties.Run Property Name.name

String

Name of the run property. This should be used when setting the run property value.

data.object.runProperties.Run Property Name.dataType

String

The run property type.

data.object.runProperties.Run Property Name.visibility

Number

The visibility level of the run property.

data.object.runProperties.Run Property Name.runParameter

Boolean

Indicates that the property is a run property. This is called runParameter for legacy reasons.

data.object.runProperties.Run Property Name.documentation

String

Documentation for the run property.

data.object.runProperties.Run Property Name.values

Array

For property definitions of type choice this is an array of the allowed values.

data.object.runProperties.Run Property Name.validators

Array

Reserved for future use.

data.object.runProperties.Run Property Name.defaultSource

String

Reserved for future use.

data.object.runProperties.Run Property Name.sources

Array

Reserved for future use.

data.object.runProperties.Run Property Name.currentEditor

String

Reserved for future use.

data.object.runProperties.Run Property Name.editors

Array

Reserved for future use.

data.object.runProperties.Run Property Name.associatedInputs

Array

Reserved for future use.

data.metadata

Object

Metadata for the resource.

data.metadata.locator

String

The resource locator that uniquely identifies the resource.

data.metadata.createdBy

String

The userid of the user that created the resource.

data.metadata.createdByName

String

The username of the user that created the resource.

data.metadata.createdOn

String

Creation time of resource in ISO-8601 format.

data.metadata.modifiedBy

String

The userid of the user that last modified the resource.

data.metadata.modifiedByName

String

The username of the user that last modified the resource.

data.metadata.modifiedOn

String

Last modification time of resource in ISO-8601 format.

data.metadata.containerLocator

String

The resource locator that uniquely identifies the container resource.

data.metadata.resourceId.objectType

String

The resource type.

data.metadata.resourceId.objectId

String

The resource id.

data.metadata.resourceId.universal

Boolean

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" : "2022-11-25T16:49:02+0000",
      "modifiedBy" : "modified-by-user-Id",
      "modifiedOn" : "2022-11-25T16:49:02+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"
        }
      }
    }
  }
}