Retrieve the flow information for a specified flow identifier.
The authenticated user must have access to the specified flow.
NOTE: Each request to the Trifacta® platform must include authentication credentials. See API Authentication.
|Internal identifier of the flow to retrieve.|
Endpoint with flow name:
Instead of submitting the internal identifier, you can use the following endpoint and parameter to request the flow object by its display name:
Display name of the flow to retrieve.
NOTE: This value is case-insensitive. If multiple flow names match with different capitalization, both flow objects are returned.
Request URI - Example:
Query parameter reference:
The following query parameters can be submitted with this endpoint:
|Query Parameter||Data Type||Description|
Comma-separated list of objects to include part of the response.
If set to
For more information, see API Common Query Parameters v4.
Response Status Code - Success:
200 - OK
Response Body Example:
|id||Internal identifier for the flow|
|name||Display text for the flow|
|description||User-friendly description for the flow|
|createdAt||Timestamp for when the flow was created|
|updatedAt||Timestamp for when the flow was last modified|
(Returned only when retrieving flow by display name)
NOTE: For internal platform use only. Do not attempt to modify.
|creator.id||Internal ID of the user who created the flow.|
|updater.id||Internal identifier of the user who last updated the flow.|
|folder||If the flow has been added to a folder, this value contains the path to the folder.|
|workspace.id||Internal identifier of the workspace to which this flow belongs. In most environments, this value is |
This page has no comments.