ProductResource

The Product resource provides access to the product hierarchy structure nodes within InService.

Named Objects & Collections

NameDescription
children The child product nodes.
parents The parent product nodes.
parentPath The parent product nodes from the current node to the root.
primaryTopicRoot The topic root node for the given product structure.

Data Model Objects

  • SCProductHierarchyRoot
  • SCProductHierarchyNode

The following resources are applicable:

GET /products/{productId}

Retrieves a product node by ID, with the ability to include product node children and the primaryTopicRoot using the $expand parameter.

Request Parameters

name type description default
productId path The ID of the product node to retrieve. 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 primary topic root object when requesting the product node use: $expand=primaryTopicRoot

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

To expand the effectivity filter collection when requesting the product node use: $expand=effectivityFilters

 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 an invalid SCID is passed.
404 Returned when a product hierarchy node is not found for the given productId.

Response Body

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

GET /products

Retrieves a list of the root product nodes.

Request Parameters

name type description default
$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
productFilterKey query n/a

Response Body

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

GET /products/{productId}/children

Retrieves the children for the specific product node ID.

Request Parameters

name type description default
productId path The ID of the product node whose children 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
productFilterKey query n/a

Response Codes

code condition
404 Returned when a product hierarchy node is not found for the given productId.

Response Body

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

GET /products/{productId}/childitems

Retrieves the product children.

Request Parameters

name type description default
productId path The ID of the product node whose children/elements to retrieve. n/a
$expand query Additional items to return with the request. Acceptable values include
$expand=productInstances for including product instance nodes in the result list		 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
404 Returned when a product hierarchy node is not found for the given productId.

Response Body

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

GET /products/{productId}/parents

Retrieves the parent product nodes for the requested product node ID.

Request Parameters

name type description default
productId path The product 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 product node ID is not valid.

Response Body

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

GET /products/{productId}/parentpath

Retrieves the parent path for the requested product node ID. 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
productId path The product 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 product node ID is not valid.

Response Body

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

GET /products/{productId}/instances

Retrieves instances of a given product identified by the product node ID.

Request Parameters

name type description default
productId path The product node ID whose instances 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 product node ID is not valid.

Response Body

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

GET /products/{productId}/topicRoots

Retrieves ISRootNodes of a given product identified by the product node ID.

Request Parameters

name type description default
productId path The product node ID whose instances 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 product node ID is not valid.

Response Body

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

GET /products/{productId}/thumbnail

Retrieves the thumbnail for the product.

Request Parameters

name type description default
Accept header The type of files that are acceptable. n/a
productId path The product node ID 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)

GET /products/{productId}/effectivityfilters

Retrieves custom effectivity filters of a given product identified by the product node ID.

Request Parameters

name type description default
productId path The product node ID whose effectivity filters 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 product node ID is not valid.

Response Body

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