Outdated release! Latest docs are Release 8.2: API OutputObjects Get v4
For the latest updates on available API endpoints and documentation, see api.trifacta.com.
Get the specified outputObject.
||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.
||A writeSettings object defines file-based outputs within an outputObject. Settings include path, format, compression, and delimiters.|
||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.|
NOTE: Each request to the Trifacta® platform must include authentication credentials. See API Authentication.
Endpoint with embedded references:
Within the returned outputObject, you can embed any writeSettings and publications objects that are associated with it:
Query parameter reference:
The following query parameters can be submitted with this endpoint:
|Query Parameter||Data Type||Description|
Comma-separated list of objects to include part of the response.
If set to
For more information, see API Common Query Parameters v4.
Request URI - Example:
Response Status Code - Success:
200 - OK
Response Body Example:
Response Body Example with embedded reference:
The following example response includes embedded information on the writeSettings and publications associated with the outputObject:
|id||Internal identifier of the outputObject|
The running environment on which the job was executed to generate the output. Possible values:
Determines if the outputObject is included as part of any scheduled execution of the flow:
|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.
This page has no comments.