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

Version:  v4

D s terms
areaoutputobjects

Required Permissions

D s api auth

Request

Request Type: GET

Endpoint:

Code Block
/v4/publications/<id>

Request URI - Example:

Code Block
/v4/publications/1/

 

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

Empty.

Response

Response Status Code - Success:  200 - OK

Response Body Example:

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

PropertyDescription
pathPath to the database where the table is to be written.
idInternal identifier of the publications object
tableNameName 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
createdAtTimestamp for when the publications object was created
updatedAtTimestamp for when the publications object was last updated
creator.idInternal identifier of the user who created the object
updater.idInternal identifier of the user who last updated the object
outputObject.idInternal identifier of the outputobject with which the publication object is associated
connection.idInternal identifier of the connection to use when publishing