API WriteSettings Update v4

Release 6.4.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:

Modify the specified writesettings object.

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.4/index.html#section/Authentication.

Request

Request Type: PUT

Endpoint:

/v4/writesettings/<id>

Request URI - Example:

/v4/writesettings/6/

Request Body:

{
    "delim": ",",
    "path": "hdfs://hadoop:50070/trifacta/queryResults/admin@example.com/POS_r01a.pqt",
    "action": "create",
    "format": "pqt",
    "compression": "none",
    "header": false,
    "asSingleFile": false,
    "prefix": null,
    "suffix": "_increment",
    "hasQuotes": true,
    "outputObjectId": 5
}

Response

Response Status Code - Success: 200 - OK

Response Body Example:

{
    "id": 6,
    "updater": {
        "id": 1
    },
    "updatedAt": "2018-11-08T00:13:43.819Z"
}

Reference

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

Send Feedback

Page tree

API WriteSettings Update v4

Required Permissions

Request

Response

Reference