- Home
- Resources
- ProductInstanceResource
The Product Instance resource provides read-only access to Product and Product events in InService.
Data Model Objects
- SCProductInstance
- SCProductEvent
R
The following resources are applicable:
GET /productinstances/{productInstanceId}
Retrieves a product instance by ID.
Request Parameters
name |
type |
description |
default |
productInstanceId |
path |
the ID of the product instance to retrieve. |
n/a |
$expand |
query |
OData expand clause used to expand collections. |
n/a |
$filter |
query |
-- Reserved for future use. -- |
n/a |
$orderby |
query |
the OData order by |
n/a |
$skip |
query |
number of items to skip to the start of this page |
n/a |
$top |
query |
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 instance is not found for the
given productInstanceId. |
Response Body
media type |
data type |
application/vnd.ptc.sc+json |
SCItem
(JSON) |
GET /productinstances/{productInstanceId}/product
Retrieves the product which is represented by the product instance.
Request Parameters
name |
type |
description |
default |
productInstanceId |
path |
the ID of the product instance. |
n/a |
$expand |
query |
OData expand clause used to expand collections. |
n/a |
$filter |
query |
-- Reserved for future use. -- |
n/a |
$orderby |
query |
the OData order by |
n/a |
$skip |
query |
number of items to skip to the start of this page |
n/a |
$top |
query |
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 instance is not found for the
given productInstanceId. |
Response Body
media type |
data type |
application/vnd.ptc.sc+json |
SCItem
(JSON) |
GET /productinstances/{productInstanceId}/topicRoots
Retrieves ISRootNodes of a given product identified by the product instance ID.
Request Parameters
name |
type |
description |
default |
productInstanceId |
path |
The product instance 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 /productinstances/{productInstanceId}/thumbnail
Request Parameters
name |
type |
description |
default |
Accept |
header |
|
n/a |
productInstanceId |
path |
|
n/a |
Response Body
media type |
data type |
application/vnd.ptc.sc+json |
object
(JSON) |
GET /productinstances/{productInstanceId}/parentpath
Retrieves the parent path for the requested product instance.
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 |
productInstanceId |
path |
The product instance 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 instance ID is not valid. |
Response Body
media type |
data type |
application/vnd.ptc.sc+json |
SCList
(JSON) |
POST /productinstances/info/batch
Retrieves the availability information for a list of serial number context.
Request Body
media type |
data type |
application/json |
array of object
(JSON) |
application/xml |
list of anyType
(XML) |
Response Codes
code |
condition |
404 |
Returned when serial number context is not found. |
400 |
Returned when the number of serial number context exceed the limit. |
Response Body
media type |
data type |
application/vnd.ptc.sc+json |
array of object
(JSON) |
GET /productinstances
Retrieves a product leaf node and its corresponding InService viewer URL based on the specified input.
Uses the search APIs to identify the correct product based on the serial number.
If not provided, an exact match of the productName is used.
The client URL is sent as part of the metadata of the product SCItem.
Request Parameters
name |
type |
description |
default |
productName |
query |
Exact Match of the name of a product hierarchy node |
n/a |
sn |
query |
The Serial Number to identify the asset |
n/a |
Response Body
media type |
data type |
application/vnd.ptc.sc+json |
object
(JSON) |