API WriteSettings Get List v4

Release 6.0.2

Contents:

Expand all Collapse all

For the latest updates on available API endpoints and documentation, see api.trifacta.com.

This is the latest version of the APIs.

Contents:

Get the list of accessible writesettings objects for the authenticated user.

Version: v4

Terms...

Relevant terms:

Term	Description
`outputObjects`	An outputObject is a definition of one or more types of outputs and how they are generated. It must be associated with a recipe. NOTE: An outputObject must be created for a recipe before you can run a job on it. One and only one outputObject can be associated with a recipe.
`writeSettings`	A writeSettings object defines file-based outputs within an outputObject. Settings include path, format, compression, and delimiters.
`publications`	A publications object is used to specify a table-based output and is associated with an outputObject. Settings include the connection to use, path, table type, and write action to apply.

Required Permissions

NOTE: Each request to the Designer Cloud Powered by Trifacta® platform must include authentication credentials. See https://api.trifacta.com/ee/6.0/index.html#section/Authentication.

Request

Request Type: GET

Endpoint:

/v4/writesettings

For more information, see API WriteSettings Get v4.

Request Body:

Empty.

Response

Response Status Code - Success: 200 - OK

Response Body Example:

{
    "data": [
        {
            "delim": ",",
            "id": 6,
            "path": "hdfs://hadoop:50070/trifacta/queryResults/admin@example.com/POS_r01.pqt",
            "action": "create",
            "format": "pqt",
            "compression": "none",
            "header": false,
            "asSingleFile": false,
            "prefix": null,
            "suffix": "_increment",
            "hasQuotes": false,
            "createdAt": "2018-11-07T23:47:15.144Z",
            "updatedAt": "2018-11-07T23:47:15.144Z",
            "creator": {
                "id": 1
            },
            "updater": {
                "id": 1
            },
            "outputObject": {
                 "id": 5
            }
        },
        {
            "delim": ",",
            "id": 1,
            "path": "hdfs://hadoop:50070/trifacta/queryResults/admin@example.com/AllFileFormats_2Fweb.csv",
            "action": "create",
            "format": "csv",
            "compression": "none",
            "header": true,
            "asSingleFile": true,
            "prefix": null,
            "suffix": "_increment",
            "hasQuotes": true,
            "createdAt": "2018-11-07T16:01:53.699Z",
            "updatedAt": "2018-11-07T16:01:53.699Z",
            "creator": {
                "id": 1
            },
            "updater": {
                "id": 1
            },
            "outputObject": {
                "id": 1
            }
        }
    ]
}

Reference

For more information on the properties of a writesettings object, see API WriteSettings Get v4.

Send Feedback

Page tree

API WriteSettings Get List v4

Required Permissions

Request

Response

Reference