Page tree

 

This is the latest version of the APIs.

Contents:


Get the specified wrangled dataset.

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

Version:  v4

Required Permissions

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

Request

Request Type: GET

Endpoint:

/v4/wrangledDatasets/<id>

Endpoint with embedded reference:

Use the following endpoint to embed information about the flow that contains the dataset in the response body.

/v4/wrangledDatasets/<id>?embed=flow

where:

ParameterDescription
<id>Internal identifier for the wrangled dataset

Request URI - Example:

/v4/wrangledDatasets/6/

Query parameter reference:

The following query parameters can be submitted with this endpoint:

Query ParameterData TypeDescription
embedstring

Comma-separated list of objects to include part of the response.

includeDeletedstring

If set to true, response includes deleted objects.

For more information, see API Common Query Parameters v4.

Request Body:

Empty.

Response

Response Status Code - Success:  200 - OK

Response Body Example:

{
    "id": 6,
    "wrangled": true,
    "createdAt": "2018-02-06T19:43:02.791Z",
    "updatedAt": "2018-02-06T19:43:02.838Z",
    "recipe": {
        "id": 6
    },
    "name": "POS-r01",
    "description": null,
    "referenceInfo": null,
    "activeSample": {
        "id": 6
    },
    "creator": {
        "id": 1
    },
    "updater": {
        "id": 1
    },
    "flow": {
        "id": 1
    }
}

Response Body Example with embedded reference:

{
    "id": 6,
    "wrangled": true,
    "createdAt": "2018-02-06T19:43:02.791Z",
    "updatedAt": "2018-02-06T19:43:02.838Z",
    "flow": {
        "id": 1,
        "name": "2013 POS",
        "description": null,
        "createdAt": "2018-02-06T19:42:55.091Z",
        "updatedAt": "2018-02-06T19:42:55.091Z",
        "creator": {
            "id": 1
        },
        "updater": {
            "id": 1
        }
    },
    "recipe": {
        "id": 6
    },
    "name": "POS-r01",
    "description": null,
    "referenceInfo": null,
    "activeSample": {
        "id": 6
    },
    "creator": {
        "id": 1
    },
    "updater": {
        "id": 1
    }
}

Reference

Wrangled Dataset:

These properties apply to the source of the wrangled dataset.

PropertyDescription
idInternal identifier of the wrangled dataset
wrangledIf true, this dataset is a wrangled dataset
createdAtTimestamp for when the dataset was imported
updatedAtTimestamp for when the dataset was last updated
scriptInternal identifier of the recipe associated with this dataset
nameInternal name of the wrangled dataset
descriptionUser-friendly description for the wrangled dataset
activeSample

Internal identifier of the currently active sample for this dataset

creatorInternal identifier of the user who created the wrangled dataset
updaterInternal identifier of the user who last updated the wrangled dataset
flowInternal identifier of the flow that contains this dataset

Embedded Flow:

For more information on the embedded flow properties, see API Flows Get v4.

This page has no comments.