API OutputObjects Create v4

Enterprise Release 6.8.2

Contents:

Send Feedback

Outdated release! Latest docs are Release 8.2: API OutputObjects Create v4

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

This is the latest version of the APIs.

Contents:

Create an outputObject.

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

NOTE: If an outputObject already exists for the recipe (flowNodeId) to which you are posting, you must either modify the object instead or delete it before posting your new object.

Endpoint:

/v4/outputObjects

Request Body:

Following creates an outputObject with an embedded writeSettings object to write an Avro file to the specified location:

{
    "execution": "photon",
    "profiler": true,
    "isAdhoc": true,
    "writeSettings": {
        "data": [
            {
                "delim": ",",
                "path": "hdfs://hadoop:50070/trifacta/queryResults/admin@example.com/POS_999.avro",
                "action": "create",
                "format": "avro",
                "compression": "none",
                "header": false,
                "asSingleFile": false,
                "prefix": null,
                "suffix": "_increment",
                "hasQuotes": false,
                "outputObject": {
                    "id": 4
                }
            }
        ]
    },
    "flowNode": {
        "id": 15
    }
}

For more information on these properties, see API OutputObjects Get v4.

For more information on the writeSettings parameters, see API WriteSettings Get v4.

Response

Response Status Code - Success: 201 - Created

{
    "id": 6,
    "execution": "photon",
    "profiler": true,
    "isAdhoc": true,
    "updatedAt": "2018-11-08T19:08:57.517Z",
    "createdAt": "2018-11-08T19:08:57.517Z",
    "creator": {
        "id": 1
    },
    "updater": {
        "id": 1
    },
    "flowNode": {
        "id": 15
    }
}

Reference

For more information on the properties of an outputObject, see API OutputObjects Get v4.