Contents:
Get the list of accessible wrangled datasets for the authenticated user.
Tip: In the Designer Cloud application UI, the WrangledDataset object is called a recipe.
Version: v4
Required Permissions
NOTE: Each request to the Designer Cloud Powered by Trifacta® platform must include authentication credentials. See https://api.trifacta.com/ee/6.4/index.html#section/Authentication.
Request
Request Type: GET
Endpoint:
/v4/wrangledDatasets
Endpoint with embedded flow:
/v4/wrangledDatasets?embed=flow
For more information, see API WrangledDatasets Get v4.
Endpoint with paged retrieval:
By default, this endpoint returns results in sets of 25.
You can apply query parameters to change the size of the default set and to page through result sets. The following example queries for results 100 at a time. In this case, the query asks for results 3-102:
/v4/wrangledDatasets?embed=flow&limit=100&offset=2
If the count of retrieved results is less than the limit, you have reached the end of the results.
Query Parameter reference:
The following query parameters are supported for this type of endpoint.
| Query Parameter | Data Type | Description |
|---|---|---|
| embed | string | Comma-separated list of objects to include part of the response. |
| includeDeleted | string | If set to |
| limit | integer | Maximum number of objects to fetch. Default: |
| noLimit | string | If set to |
| offset | integer | Offset after which to start returning objects. For use with |
| sort | string | Defines sort order for returned objects. |
| filterFields | string | Comma-separated list of fields against which to match the |
| filter | string | Value for fuzzy-filtering objects. See |
| flowNodeId | integer | (some endpoints) Internal value. Do not modify. |
| sharedRole | string | (some endpoints) The role type required to list the connection |
| flowFilter | string | (some endpoints) The type of flows to list. Values: all, shared, owned |
For more information, see API Common Query Parameters v4.
Request Body:
Empty.
Response
Response Status Code - Success: 200 - OK
Response Body Example:
{
"data": [
{
"id": 7,
"wrangled": true,
"createdAt": "2018-02-06T19:47:56.146Z",
"updatedAt": "2018-02-06T19:47:56.183Z",
"recipe": {
"id": 7
},
"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
}
},
"name": "REF_CAL",
"description": null,
"referenceInfo": null,
"activeSample": {
"id": 7
},
"creator": {
"id": 1
},
"updater": {
"id": 1
}
},
{
"id": 6,
"wrangled": true,
"createdAt": "2018-02-06T19:43:02.791Z",
"updatedAt": "2018-02-06T19:43:02.838Z",
"recipe": {
"id": 6
},
"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
}
},
"name": "POS-r01",
"description": null,
"referenceInfo": null,
"activeSample": {
"id": 6
},
"creator": {
"id": 1
},
"updater": {
"id": 1
}
}
]
}
Reference
For more information on the properties of a wrangled dataset, see API ImportedDatasets Get v4.
For more information on the embedded flow properties, see API Flows Get v4.
This page has no comments.