API Publications 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 publications object.

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/publications/<id>

Request URI - Example:

/v4/publications/1/

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

Empty.

Response

Response Status Code - Success: 200 - OK

Response Body Example:

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

Reference

Property	Description
path	Path to the database where the table is to be written.
id	Internal identifier of the publications object
tableName	Name of the table to write
targetType	Type of table that you are writing. Example values: `hive` `redshift` `sqldatawarehouse` For more information, see Connection Types.
action	The write action to apply to the table, in the event that the table exists: `create` - create a new table with each publication `createAndLoad` - append your data to the table `truncateAndLoad` - truncate the table and load it with your data `dropAndLoad` - drop the table and write the new table in its place
createdAt	Timestamp for when the publications object was created
updatedAt	Timestamp for when the publications object 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
outputObject.id	Internal identifier of the outputobject with which the publication object is associated
connection.id	Internal identifier of the connection to use when publishing

Send Feedback

Page tree

API Publications Get v4

Required Permissions

Request

Response

Reference