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 Designer Cloud Powered by Trifacta® platform must include authentication credentials. See https://api.trifacta.com/ee/6.4/index.html#section/Authentication.
Request
Request Type: GET
Endpoint:
/v4/flows/<id>
| Parameter | Description |
|---|---|
<id> | 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:
/v4/flows?filter=<flow_name>
| Parameter | Description |
|---|---|
<flow_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:
/v4/flows/6
Query parameter reference:
The following query parameters can be submitted with this endpoint:
| Query Parameter | Data Type | Description |
|---|---|---|
| embed | string | Comma-separated list of objects to include part of the response. |
| includeDeleted | string | If set to |
For more information, see API Common Query Parameters v4.
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
| Property | Description |
|---|---|
| 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 |
| transient.highlighted.name | (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 1. |
This page has no comments.