Page tree

 

As of Release 6.4, the v3 APIs are End of Life (EOL). Before using this release or a later one, you should migrate to using the latest available API version. For more information, see API Version Support Matrix.
Latest version of this endpoint: API Flows Patch v4.

Contents:


Update an existing flow based on the specified identifier.

NOTE: You cannot add datasets to the flow through this endpoint. Moving pre-existing datasets into a flow is not supported in this release. Create the flow first and then when you create the datasets, associate them with the flow at the time of creation.


Version:
v3

Required Permissions

The authenticated user must be an admin.

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

Request

Request Type: PATCH

Endpoint:

/v3/flows/<id>
ParameterDescription
<id>Internal identifier of the flow to update.

Request URI - Example:

/v3/flows/6

Request Body:

You can modify the following properties. 

{
  "name": "My Flow",
  "description": "This is my flow."
}

Response

Response Status Code - Success:  200 - Ok

Response Body Example:

{
  "id": 6,
  "updatedBy": 1,
  "updatedAt": "2017-02-17T18:28:47.675Z"
}

Reference

For more information on the properties of a flow, see API Flows Get v3.

 

This page has no comments.