Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from space DEV and version r0642

D s api version

D toc

Get the specified objectobject.

Version:  v4

D s terms
areaoutputobjects

Required Permissions

D s api auth

Request

Request Type: GET

Endpoint:

Code Block
/v4/outputobjects/<id>

Endpoint with embedded references:

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

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

Query parameter reference:

The following query parameters can be submitted with this endpoint:

Excerpt Include
API Query Parameters Get v4
API Query Parameters Get v4
nopaneltrue

For more information, see API Common Query Parameters v4.

Request URI - Example:

Code Block
/v4/outputobjects/3/

 

Request Body:

Empty.

Response

Response Status Code - Success:  200 - OK

Response Body Example:

Code Block
{
    "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:

Code Block
{
    "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

 

PropertyDescription
idInternal 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
    D s photon
    running environment on the
    D s node
    . This environment is suitable for small- to medium-sized jobs.
  • spark - Job is executed on the Spark cluster to which the
    D s platform
    is connected. See Configure for Spark.

For more information, see Running Environment Options.

profilerIf 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.
createdAtTimestamp for when the outputobject was created
updatedAtTimestamp for when the outputobject was last updated
creator.idInternal identifier of the user who created the object
updater.idInternal identifier of the user who last updated the object
flowNode.idInternal 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.