Page tree

 

This is the latest version of the APIs.

Contents:


Get the specified writesettings object.

The writesettings values allow you to specify aspects of the publication of results to the specified path location.

NOTE: writesettings values are required if you are running this specified job for the dataset for the first time.

NOTE: To specify multiple outputs, you can include additional writesettings objects in the request. For example, if you want to generate output to csv and json, you can duplicate the writesettings object for csv and change the format value in the second one to json.

These settings correspond to values that you can apply through the UI. For UI information, see Run Job Page.

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: GET

Endpoint:

/v4/writesettings/<id>

Request URI - Example:

/v4/writesettings/6/

Query parameter reference:

The following query parameters can be submitted with this endpoint:

Query ParameterData TypeDescription
embedstring

Comma-separated list of objects to include part of the response.

includeDeletedstring

If set to true, response includes deleted objects.

For more information, see API Common Query Parameters v4.

Request Body:

Empty.

Response

Response Status Code - Success:  200 - OK

Response Body Example:

{
    "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
    }
}

Reference

PropertyDescription
delimThe delimiter between field values in an output row
idInternal identifier of the writesettings object
path(required) The fully qualified path to the output location where to write the results
action

(required) If the output file or directory exists, you can specify one of the following actions:

  • create - Create a new, parallel location, preserving the old results.
  • append - Add the new results to the old results.
  • overwrite - Replace the old results with the new results.
format

(required) Output format for the results. Specify one of the following values:

  • csv
  • json
  • avro
  • pqt (Parquet)

  • tde (Tableau)

NOTE: To specify multiple output formats, create additional writesettings object for each output format.

compression

(optional) For csv and json results, you can optionally compress them using bzip2 or gzip compression. Default is none.

NOTE: If compression is applied, the filename in the path value must end with the appropriate extension for the type of compression:

  • .gz for GZIP
  • .bz2 for BZIP2
header(optional) For csv results with action set to create or append, this value determines if a header row with column names is inserted at the top of the results. Default is false.
asSingleFile(optional) For csv and json results, this value determines if the results are concatenated into a single file or stored as multiple files. Default is false.
prefix

NOTE: Do not use or modify. For internal platform use only.

suffix

NOTE: Do not use or modify. For internal platform use only.

hasQuotesIf true, each field in the output is wrapped in double-quotes.
createdAtTimestamp for when the writesettings object was created
updatedAtTimestamp for when the writesettings object was last updated
creator.idInternal identifier of the user who created the object
updater.idInternal identifier of the user who last updated the object
outputObject.idIf specified, this value is the internal identifier of the outputobject with which this writesettings object is associated.

This page has no comments.