PublicationsResource

The Publications resource provides access to publication structures in InService.

Named Objects & Collections

NameDescription
children The child topic nodes.
elements The information elements connected to the topic.
parents The parent publication nodes.
parentPath The parent publication nodes from the current node to the root.

Data Model Objects

  • SCPSRoot
  • SCPSNode

The following resources are applicable:

GET /publications/{publicationNodeId}

Retrieves the publication node for the requested ID, with the ability to include the publication node's children or information elements.

Request Parameters

name type description default
publicationNodeId path The ID of the requested publication node. n/a
$expand query The OData expand clause used to expand related objects and collections.

To expand the children collection when requesting the product node use: $expand=children

To expand the infoElements collection when requesting the product node use: $expand=elements

 n/a
$filter query -- Reserved for future use. -- n/a
$orderby query The OData order by n/a
$skip query The number of items to skip for the start of this page. n/a
$top query The number of objects to return in this page. n/a
effectivity query The OData filter including the effectivity filter to apply. n/a

Response Codes

code condition
400 Returned when the publication node ID is not valid.
404 Returned when a publication node is not found for the given ID.

Response Body

media type data type
application/vnd.ptc.sc+json SCItem (JSON)

GET /publications/{publicationNodeId}/children

Retrieves the child publication nodes of the requested publication node.

This endpoint can be used to retrieve the complete TOC structure for a publication by supplying $expand=children.

Request Parameters

name type description default
publicationNodeId path the publication node ID whose children to retrieve. n/a
$expand query The OData expand clause used to expand related objects and collections.

To expand the children collection and retrieve a full TOC structure use: $expand=children

 n/a
$filter query -- Reserved for future use. -- n/a
$orderby query The OData order by. n/a
$skip query The number of items to skip for the start of this page. n/a
$top query The number of objects to return in this page. n/a
effectivity query The OData filter including the effectivity filter to apply. n/a

Response Codes

code condition
400 Returned when the publication node ID is not valid.

Response Body

media type data type
application/vnd.ptc.sc+json SCList (JSON)

GET /publications/{publicationNodeId}/childitems

Retrieves the child/element publication nodes of the requested publication node.

Request Parameters

name type description default
publicationNodeId path the publication node ID whose children/elements to retrieve. n/a
$skip query The number of items to skip for the start of this page. n/a
$top query The number of objects to return in this page. n/a
effectivity query The OData filter including the effectivity filter to apply. n/a

Response Codes

code condition
400 Returned when the publication node ID is not valid.

Response Body

media type data type
application/vnd.ptc.sc+json SCList (JSON)

GET /publications/{publicationNodeId}/parents

Retrieves the parent publication nodes of the requested publication node.

Request Parameters

name type description default
publicationNodeId path The publication node ID whose parents to retrieve. n/a
$expand query The OData expand clause used to expand related objects and collections. n/a
$filter query -- Reserved for future use. -- n/a
$orderby query The OData order by. n/a
$skip query The number of items to skip for the start of this page. n/a
$top query The number of objects to return in this page. n/a
effectivity query The OData filter including the effectivity filter to apply. n/a

Response Codes

code condition
400 Returned when the publication node ID is not valid.

Response Body

media type data type
application/vnd.ptc.sc+json SCList (JSON)

GET /publications/{publicationNodeId}/parentpath

Retrieves the parent path of the requested publication node. The path is represented by a list starting from the top most (root) node with each node there after the child of the preceeding node. The lists ends with the node requested. The first element is the highest element in the structure that could be found which is either a root or has two parents (preventing further traversal of the structure).

Request Parameters

name type description default
publicationNodeId path The publication node ID whose path to retrieve. n/a
$expand query The OData expand clause used to expand related objects and collections. n/a
$filter query -- Reserved for future use. -- n/a
$orderby query The OData order by. n/a
$skip query The number of items to skip for the start of this page. n/a
$top query The number of objects to return in this page. n/a
effectivity query The OData filter including the effectivity filter to apply. n/a

Response Codes

code condition
400 Returned when the publication node ID is not valid.

Response Body

media type data type
application/vnd.ptc.sc+json SCList (JSON)

GET /publications/{publicationNodeId}/elements

Retrieves the information elements of the requested publication node.

Request Parameters

name type description default
publicationNodeId path the publication node ID whose information elements to retrieve. n/a
$expand query The OData expand clause used to expand related objects and collections. n/a
$filter query -- Reserved for future use. -- n/a
$orderby query The OData order by. n/a
$skip query The number of items to skip for the start of this page. n/a
$top query The number of objects to return in this page. n/a
effectivity query The OData filter including the effectivity filter to apply. n/a

Response Codes

code condition
400 Returned when the publication node ID is not valid.

Response Body

media type data type
application/vnd.ptc.sc+json SCList (JSON)

GET /publications/{publicationNodeId}/thumbnail

Retrieves the thumbnail for the publication.

Request Parameters

name type description default
Accept header The type of files that are acceptable. n/a
publicationNodeId path The ID for the publication whose thumbnail we're looking for. n/a
dealerId query n/a

Response Body

media type data type
application/vnd.ptc.sc+json object (JSON)