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 WrangledDatasets Get v4.

Contents:


Get the specified wrangled dataset.

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

Version: v3

Required Permissions

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

Request

Request Type: GET

Endpoint:

/v3/wrangledDatasets/<id>

Endpoint with embedded reference:

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

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

where:

ParameterDescription
<id>Internal identifier for the wrangled dataset

Request URI - Example:

/v3/wrangledDatasets/35/

Request Body:

Empty.

Response

Response Status Code - Success: 200 - OK

Response Body Example:

{
  "id": 35,
  "wrangled": true,
  "createdAt": "2017-02-03T05:16:55.844Z",
  "updatedAt": "2017-02-03T05:16:56.998Z",
  "createdBy": 1,
  "updatedBy": 1,
  "name": "base_type_map_array_record_large",
  "description": null,
  "activeSample": {
    "id": 12
  },
  "flow": {
    "id": 12
  },
  "script": {
    "id": 36
  }
}

Response Body Example with embedded reference:

{
  "id": 35,
  "wrangled": true,
  "createdAt": "2017-02-03T05:16:55.844Z",
  "updatedAt": "2017-02-03T05:16:56.998Z",
  "createdBy": 1,
  "updatedBy": 1,
  "name": "base_type_map_array_record_large",
  "description": null,
  "activeSample": {
    "id": 12
  },
  "flow": {
    "id": 12,
    "name": "base_type_map_array_record_large Flow",
    "description": null,
    "createdAt": "2017-02-03T05:16:55.684Z",
    "updatedAt": "2017-02-03T05:16:55.684Z",
    "createdBy": 1,
    "updatedBy": 1
  },
  "script": {
    "id": 36
  }
}

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
createdByInternal identifier of the user who created the wrangled dataset
updatedByInternal identifier of the user who last updated the wrangled 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

flowInternal identifier of the flow that contains this dataset
scriptInternal identifier of the recipe associated with this dataset

Embedded Flow:

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

This page has no comments.