API OutputObjects Get 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:

Get the specified objectobject.

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

Endpoint:

/v4/outputobjects/<id>

Endpoint with embedded references:

Within the returned outputobject, you can embed any writesettings and publications objects that are associated with it:

/v4/outputobjects/<id>?embed=writesettings,publications

Query parameter reference:

The following query parameters can be submitted with this endpoint:

Query Parameter	Data Type	Description
embed	string	Comma-separated list of objects to include part of the response.
includeDeleted	string	If set to `true`, response includes deleted objects.

For more information, see API Common Query Parameters v4.

Request URI - Example:

/v4/outputobjects/3/

Request Body:

Empty.

Response

Response Status Code - Success: 200 - OK

Response Body Example:

{
    "id": 3,
    "execution": "photon",
    "profiler": true,
    "isAdhoc": true,
    "createdAt": "2018-11-08T18:51:56.633Z",
    "updatedAt": "2018-11-08T18:52:44.535Z",
    "creator": {
        "id": 1
    },
    "updater": {
        "id": 1
    },
    "flowNode": {
        "id": 13
    }
}

Response Body Example with embedded reference:

The following example response includes embedded information on the writesettings and publications associated with the outputobject:

{
    "id": 3,
    "execution": "photon",
    "profiler": true,
    "isAdhoc": true,
    "createdAt": "2018-11-08T18:51:56.633Z",
    "updatedAt": "2018-11-08T18:52:44.535Z",
    "writeSettings": {
        "data": [
            {
                "delim": ",",
                "id": 4,
                "path": "hdfs://hadoop:50070/trifacta/queryResults/admin@example.com/POS_r01.avro",
                "action": "create",
                "format": "avro",
                "compression": "none",
                "header": false,
                "asSingleFile": false,
                "prefix": null,
                "suffix": "_increment",
                "hasQuotes": false,
                "createdAt": "2018-11-08T18:52:44.526Z",
                "updatedAt": "2018-11-08T18:52:44.526Z",
                "creator": {
                    "id": 1
                },
                "updater": {
                    "id": 1
                },
                "outputObject": {
                    "id": 3
                }
            },
            {
                "delim": ",",
                "id": 3,
                "path": "hdfs://hadoop:50070/trifacta/queryResults/admin@example.com/POS-r01.csv",
                "action": "create",
                "format": "csv",
                "compression": "none",
                "header": true,
                "asSingleFile": true,
                "prefix": null,
                "suffix": "_increment",
                "hasQuotes": true,
                "createdAt": "2018-11-08T18:51:56.871Z",
                "updatedAt": "2018-11-08T18:51:56.871Z",
                "creator": {
                    "id": 1
                },
                "updater": {
                    "id": 1
                },
                "outputObject": {
                    "id": 3
                }
            }
        ]
    },
    "publications": {
        "data": [
            {
                "path": [
                    "default"
                ],
                "id": 1,
                "tableName": "POS_r01",
                "targetType": "hive",
                "action": "dropAndLoad",
                "createdAt": "2018-11-08T18:52:43.871Z",
                "updatedAt": "2018-11-08T18:52:43.871Z",
                "creator": {
                    "id": 1
                },
                "updater": {
                    "id": 1
                },
                "outputObject": {
                    "id": 3
                },
                "connection": {
                    "id": 1
                }
            }
        ]
    },
    "creator": {
        "id": 1
    },
    "updater": {
        "id": 1
    },
    "flowNode": {
        "id": 13
    }
}

Reference

Property	Description
id	Internal identifier of the outputobject
execution	The running environment on which the job was executed to generate the output. Possible values: `photon` - Job is executed on the Trifacta Photon running environment on the Alteryx node. This environment is suitable for small- to medium-sized jobs. `spark` - Job is executed on the Spark cluster to which the Designer Cloud Powered by Trifacta platform is connected. See Configure for Spark. `emrSpark` - Job is executed on integrated EMR cluster. See Configure for EMR. `databricksSpark` - Job is executed on the Azure Databricks cluster connected to the platform. See Configure for Azure Databricks. For more information, see Running Environment Options.
profiler	If `true`, a visual profile of the results is generated as part of the output.
isAdhoc	Determines if the outputobject is included as part of any scheduled execution of the flow: `true` - outputobject is ad-hoc only, which means it is triggered only when a user manually runs a job on the wrangled dataset. `false` - outputobject is included as part of any scheduled job run and can be manually triggered by a user.
createdAt	Timestamp for when the outputobject was created
updatedAt	Timestamp for when the outputobject was last updated
creator.id	Internal identifier of the user who created the object
updater.id	Internal identifier of the user who last updated the object
flowNode.id	Internal identifier of the recipe (wrangledDataset) with which this outputobject is associated

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

For more information on the publications properties, see API Publications Get v4.

Send Feedback

Page tree

API OutputObjects Get v4

Required Permissions

Request

Response

Reference