Add the specified imported dataset to a flow based on its internal identifier.

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/importedDatasets/<id>/addToFlow

where:

ParameterDescription
<id>Internal identifier for the imported dataset

Request URI - Example:

/v4/importedDatasets/18/addToFlow

Request Body:

{
    "flow": {
        "id": 12
    }
}

Response

Response Status Code - Success:  201 - Created

Response Body:

{
    "id": 47,
    "wrangled": false,
    "updatedAt": "2019-02-12T00:51:59.961Z",
    "createdAt": "2019-02-12T00:51:59.931Z",
    "referenceInfo": null,
    "activeSample": {
        "id": 52
    },
    "creator": {
        "id": 1
    },
    "updater": {
        "id": 1
    },
    "recipe": {
        "id": 37
    },
    "referencedFlowNode": null,
    "flow": {
        "id": 12
    }
}

Reference

PropertyDescription
idInternal identifier for the new wrangled dataset.
wrangledThis value is always  true.
updatedAt

Timestamp for when the dataset was updated.

createdAt

Timestamp for when the dataset was created.

referenceInfoReference information for the new object in the flow. Since the dataset has just been added, this value should be null.
activeSample.id

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.id

Internal identifier for the recipe for the dataset.

If null, the dataset has not been wrangled in the Transformer page and does not have initial parsing steps.

referencedFlowNodeInternal identifier of the node of the flow that this dataset references. Since this dataset is an imported dataset, there is no reference. This value should be null.
flow.idInternal identifier of the flow that contains this dataset.

For more information on the other properties, see API ImportedDatasets Get v4.