Page tree

 

This is the latest version of the APIs.

Contents:


Create a 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 Trifacta® platform must include authentication credentials. See API Authentication.

Request

Request Type: POST

Endpoint:

/v4/writesettings

Request Body:

Following creates a writesettings object that writes a new Parquet file to the designated location each time that the job is run.

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

Response

Response Status Code - Success:  201 - Created

{
    "delim": ",",
    "id": 7,
    "path": "hdfs://hadoop:50070/trifacta/queryResults/admin@example.com/POS_r03.pqt",
    "action": "create",
    "format": "pqt",
    "compression": "none",
    "header": false,
    "asSingleFile": false,
    "prefix": null,
    "suffix": "_increment",
    "hasQuotes": false,
    "updatedAt": "2018-11-08T00:15:22.948Z",
    "createdAt": "2018-11-08T00:15:22.948Z",
    "creator": {
        "id": 1
    },
    "updater": {
        "id": 1
    },
    "outputObjectId": 5
}

Reference

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

This page has no comments.