Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin

D toc

Retrieve the flow information for a specified flow identifier.  

Version: v3

Required Permissions

The authenticated user must be an admin.

D s api auth

Request

Request Type: GET

Endpoint:

Code Block
/v3/flows/<id>
ParameterDescription
<id>Internal identifier of the flow to retrieve.


Request URI - Example:

Code Block
/v3/flows/10

Request Body:

Empty.

Response

Response Status Code - Success:  200 - OK

Response Body Example:

Code Block
[
   {
        "id": 10,
        "name": "2013 POS",
        "description": null,
        "deleted_at": null,
        "cpProject": null,
        "createdAt": "2017-11-07T17:02:34.662Z",
        "updatedAt": "2017-11-07T17:02:34.662Z",
        "createdBy": 1,
        "updatedBy": 1,
        "associatedPeople": [
            {
                "outputHomeDir": "/trifacta/queryResults/admin@trifacta.local",
                "name": "Administrator",
                "email": "admin@trifacta.local",
                "id": 1,
                "flowpermission": {
                    "flowId": 3,
                    "personId": 1,
                    "role": "owner"
                }
            }
        ]
    }
]

Reference

PropertyDescription
idInternal identifier for the flow
nameDisplay text for the flow
descriptionUser-friendly description for the flow
cpProjectNot used.
createdAtTimestamp for when the flow was created
updatedAtTimestamp for when the flow was last modified
createdByInternal identifier of the user who created the flow
updatedByInternal identifier of the user who last updated the flow
associatedPeople.outputHomeDirOutput directory for the associated person.
associatedPeople.nameName of the associated person.
associatedPeople.emailUser ID (email address) of the associated person.
associatedPeople.idInternal ID for the associated person.
associatedPeople.flowpermission.flowIdInternal ID for the flow.
associatedPeople.flowpermission.personIdInternal ID for the permitted user.
associatedPeople.flowpermission.role

Role for the permitted user.

  • owner - can do anything to the flow.
  • collaborator - can do most actions on the flow except change the name and delete the flow.