Add the specified wrangled dataset to a flow as a reference. A reference is a link from one flow to the output of a wrangled dataset that is sourced from another flow.

Tip: In the UI, the WrangledDataset object is called a recipe.


NOTE: Datasets can be added to flows based on the permissions of the access token used on this endpoint. Datasets can be added to flows that are shared by the user.

Version:  v4

Required Permissions

Request

Request Type: POST

Endpoint:

/v4/wrangledDatasets/<id>/addToFlow

where:

ParameterDescription
<id>Internal identifier for the wrangled dataset

Request URI - Example:

/v4/wrangledDatasets/15/addToFlow

Request Body:

{
    "flow": {
        "id": 27
    }
}

Response

Response Status Code - Success:  201 - Created

Response Body:

{
    "id": 43,
    "wrangled": false,
    "updatedAt": "2019-01-26T01:09:38.022Z",
    "createdAt": "2019-01-26T01:09:38.022Z",
    "referenceInfo": null,
    "activeSample": null,
    "creator": {
        "id": 1
    },
    "updater": {
        "id": 1
    },
    "recipe": null,
    "referencedFlowNode": {
        "id": 27
    },
    "flow": {
        "id": 15
    }
}

Reference

PropertyDescription
idInternal identifier for the new wrangled dataset.
wrangled

If true, the dataset is a wrangled dataset.

If false, the dataset is a reference dataset.

updatedAt

Timestamp for when the dataset was updated.

createdAt

Timestamp for when the dataset was created.

referenceInfoIf the wrangled dataset has a reference object defined for it, its information is listed here.
activeSample

Internal identifier for the currently active sample for the dataset.

If null, there is no currently active sample for the dataset.

creator.IdInternal identifier of the user who created the flow.
updater.IdInternal identifier of the user who performed the update.
recipe

Internal identifier for the recipe associated with the dataset in its new flow.

If null, the dataset has not been wrangled in the Transformer page.

referencedFlowNode.idInternal identifier of the original dataset's internal identifier.
flow.IdInternal identifier of the flow that contains this dataset