Contents:
Retrieve the flow information for a specified flow identifier.
Version: v3
Required Permissions
The authenticated user must be an admin.
NOTE: Each request to the Designer Cloud Powered by Trifacta® platform must include authentication credentials. See https://api.trifacta.com/ee/5.0/index.html#section/Authentication.
Request
Request Type: GET
Endpoint:
/v3/flows/<id>
| Parameter | Description |
|---|---|
<id> | Internal identifier of the flow to retrieve. |
Request URI - Example:
/v3/flows/10
Request Body:
Empty.
Response
Response Status Code - Success: 200 - OK
Response Body Example:
[
{
"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
| Property | Description |
|---|---|
| id | Internal identifier for the flow |
| name | Display text for the flow |
| description | User-friendly description for the flow |
| cpProject | Not used. |
| createdAt | Timestamp for when the flow was created |
| updatedAt | Timestamp for when the flow was last modified |
| createdBy | Internal identifier of the user who created the flow |
| updatedBy | Internal identifier of the user who last updated the flow |
| associatedPeople.outputHomeDir | Output directory for the associated person. |
| associatedPeople.name | Name of the associated person. |
| associatedPeople.email | User ID (email address) of the associated person. |
| associatedPeople.id | Internal ID for the associated person. |
| associatedPeople.flowpermission.flowId | Internal ID for the flow. |
| associatedPeople.flowpermission.personId | Internal ID for the permitted user. |
| associatedPeople.flowpermission.role | Role for the permitted user.
|
This page has no comments.