Page tree

Outdated release! Latest docs are Release 8.2: API Flows Get v4

   

For the latest updates on available API endpoints and documentation, see api.trifacta.com.

This is the latest version of the APIs.

Contents:


Retrieve the flow information for a specified flow identifier.  

Version: v4

Required Permissions

The authenticated user must have access to the specified flow.

NOTE: Each request to the Trifacta® platform must include authentication credentials. See API Authentication.

Request

Request Type: GET

Endpoint:

/v4/flows/<id>
ParameterDescription
<id>Internal identifier of the flow to retrieve.


Request URI - Example:

/v4/flows/6

Request Body:

Empty.

Response

Response Status Code - Success:  200 - OK

Response Body Example:

{
    "id": 6,
    "name": "2013 POS",
    "description": null,
    "createdAt": "2019-01-08T17:25:21.392Z",
    "updatedAt": "2019-01-08T17:30:30.959Z",
    "creator": {
        "id": 1
    },
    "updater": {
        "id": 1
    },
    "folder": null,
    "workspace": {
        "id": 1
    }
}

Reference

PropertyDescription
idInternal identifier for the flow
nameDisplay text for the flow
descriptionUser-friendly description for the flow
createdAtTimestamp for when the flow was created
updatedAtTimestamp for when the flow was last modified
creator.idInternal ID of the user who created the flow.
updater.idInternal identifier of the user who last updated the flow.
folderIf the flow has been added to a folder, this value contains the path to the folder.
workspace.idInternal identifier of the workspace to which this flow belongs. In most environments, this value is 1.

This page has no comments.