- Home
- Resources
- PartResource
The Part resource provides read-only access to SCPart and its related data in InService.
Customization Points
Class | Description |
com.ptc.sc.parts.DefaultSupersessionMultiPathDelegate |
You can implement a custom SupersessionDelegate to modify the
default supersession history behavior which currently includes xref
and multipath parts. |
com.ptc.sc.services.plugins.DefaultPreferredPartDelegate |
You can implement a custom PreferredPartDelegate to modify the
default preferred part behavior which currently sets the latest
part as preferred part from the supersession history chain. |
com.ptc.sc.services.plugins.DefaultOrgNameDelegate |
You can implement a custom OrgNameDelegate to modify the
default behavior which currently returns org name itself as the display name
of that org. |
com.ptc.sc.services.plugins.DefaultRecommendationDelegate |
You can implement a custom RecommendationDelegate to modify the
default behavior which currently returns recommendation for
part, partslist and partslistItem. |
Named Objects & Collections
Name | Description |
part |
The SCPart for a given part number. |
partnumbers |
The parts that match the supplied part number irrespective of the organization. |
alternates |
The alternate parts history for a given part identifier. |
supersessions |
The superseding parts history for a given part identifier. |
xref |
The xref parts for a given part identifier |
partslists |
The list of Partslist where the part is used. |
Action Links
Name | Description |
action_get_self |
The link to retrieve a SCPart for a given part identifier. |
Data Model Objects
The following resources are applicable:
GET /parts
Retrieves a SCPart for a given part number and its organization name.
Request Parameters
name |
type |
description |
default |
orgName |
query |
Holds the part organization name. |
n/a |
partNumber |
query |
Holds the part number. |
n/a |
Response Codes
code |
condition |
404 |
Returned when a SCPart is not found in the system for the given
parameters. |
Response Body
media type |
data type |
application/vnd.ptc.sc+json |
SCItem
(JSON) |
GET /parts/partnumber
Find all parts that match the supplied part number.
Request Parameters
name |
type |
description |
default |
$expand |
query |
The OData expand clause used to expand related objects |
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 |
partNumber |
query |
the part number used to lookup matching parts. |
n/a |
Response Codes
code |
condition |
400 |
when the partNumber is null or empty. |
Response Body
media type |
data type |
application/vnd.ptc.sc+json |
SCList
(JSON) |
GET /parts/{partId}
Retrieves a Part for a given part identifier.
Request Parameters
name |
type |
description |
default |
partId |
path |
Holds reference to a part |
n/a |
$expand |
query |
The OData expand clause used to expand related objects, such as [recommendation] |
n/a |
$filter |
query |
-- Reserved for future use. -- |
n/a |
Response Codes
code |
condition |
404 |
Returned when a Part is not found in the system for the given
parameters. |
400 |
Returned when the Id representation of Part is not in valid
format. |
Response Body
media type |
data type |
application/vnd.ptc.sc+json |
SCItem
(JSON) |
GET /parts/{partId}/alternates
Retrieves the alternate parts history for a given Part identifier.
Request Parameters
name |
type |
description |
default |
partId |
path |
Holds the SCId representation of a Part identifier. |
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 |
Holds the effectivity filter information |
n/a |
Response Codes
code |
condition |
404 |
Returned when a Part is not found in the system of the given
parameters or alternates not found. |
400 |
Returned when the Id representation of Part is not in valid
format. |
Response Body
media type |
data type |
application/vnd.ptc.sc+json |
SCList
(JSON) |
GET /parts/{partId}/supersessions
Retrieves the superseded parts history for a given part identifier.
Request Parameters
name |
type |
description |
default |
partId |
path |
Holds the SCId representation of a Part identifier. |
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 |
Holds the effectivity filter information |
n/a |
showPartHistory |
query |
|
n/a |
Response Codes
code |
condition |
404 |
Returned when a Part is not found in the system of the given
parameters or supersedes not found. |
400 |
Returned when the Id representation of Part is not in valid
format. |
Response Body
media type |
data type |
application/vnd.ptc.sc+json |
SCList
(JSON) |
GET /parts/{partId}/supersessions/{chainType}
Retrieves the superseded parts history for a given part identifier.
Request Parameters
name |
type |
description |
default |
chainType |
path |
[ all, forward, backward ] |
n/a |
partId |
path |
Holds the SCId representation of a Part identifier. |
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 |
Holds the effectivity filter information |
n/a |
Response Codes
code |
condition |
404 |
Returned when a Part is not found in the system of the given
parameters or supersedes not found. |
400 |
Returned when the Id representation of Part is not in valid
format. |
Response Body
media type |
data type |
application/vnd.ptc.sc+json |
SCList
(JSON) |
GET /parts/{partId}/xrefs
Retrieves the Cross-Reference parts for a given part identifier.
Request Parameters
name |
type |
description |
default |
partId |
path |
Holds the SCId representation of a Part identifier. |
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 |
Holds the effectivity filter information |
n/a |
Response Codes
code |
condition |
404 |
Returned when a Part is not found in the system of the given
parameters or xref parts not found. |
400 |
Returned when the Id representation of Part is not in valid
format. |
Response Body
media type |
data type |
application/vnd.ptc.sc+json |
SCList
(JSON) |
GET /parts/{partId}/includedin_kits
Retrieves Included-In Kit Parts or Referenced Kits for a given part identifier.
Request Parameters
name |
type |
description |
default |
partId |
path |
Holds the SCId representation of a Part identifier. |
n/a |
$skip |
query |
Holds the skip value of page |
n/a |
$top |
query |
Holds the top value of page |
n/a |
effectivity |
query |
effectivity Holds the effectivity filter information |
n/a |
Response Codes
code |
condition |
404 |
Returned when a Part is not found in the system of the given
parameters |
400 |
Returned when the Id representation of Part is not in valid format. |
Response Body
media type |
data type |
application/vnd.ptc.sc+json |
SCItem
(JSON) |
GET /parts/{partId}/related_kits
Retrieves related Kit parts for a given part identifier.
Request Parameters
name |
type |
description |
default |
partId |
path |
Holds the SCId representation of a Part identifier. |
n/a |
$skip |
query |
Holds the skip value of page |
n/a |
$top |
query |
Holds the top value of page |
n/a |
effectivity |
query |
effectivity Holds the effectivity filter information |
n/a |
Response Codes
code |
condition |
404 |
Returned when a Part is not found in the system of the given
parameters |
400 |
Returned when the Id representation of Part is not in valid format. |
Response Body
media type |
data type |
application/vnd.ptc.sc+json |
SCItem
(JSON) |
GET /parts/{partId}/supplementary_parts
Retrieves Supplementary parts for a given part identifier.
"Supplementary Parts" are strongly recommended to be replaced
together with the selected part.
Request Parameters
name |
type |
description |
default |
partId |
path |
Holds the SCId representation of a Part identifier. |
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 |
Holds the effectivity filter information |
n/a |
Response Codes
code |
condition |
404 |
Returned when a Part is not found in the system of the given
parameters. |
400 |
Returned when the Id representation of Part is not in valid
format. |
Response Body
media type |
data type |
application/vnd.ptc.sc+json |
SCItem
(JSON) |
GET /parts/{partId}/partslists
Retrieves the parts lists where the part identified by given Part identifier are used.
This API retrieves the Where-Used Partslists.
Request Parameters
name |
type |
description |
default |
partId |
path |
Holds the SCId representation of a Part identifier. |
n/a |
$expand |
query |
The OData expand clause used to expand related objects |
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 |
Response Codes
code |
condition |
404 |
Returned when a Part is not found in the system of the given
parameters. |
400 |
Returned when the Id representation of Part is not in valid
format. |
Response Body
media type |
data type |
application/vnd.ptc.sc+json |
SCList
(JSON) |
GET /parts/orgnames
Retrieves a distinct list of available organization names for a Part.
Response Body
media type |
data type |
application/vnd.ptc.sc+json |
array of object
(JSON) |
GET /parts/{partId}/images/{fileName}
Retrieves the image identified by a media identifier for the Part identified by given Part identifier.
Request Parameters
name |
type |
description |
default |
Accept |
header |
The header parameter which represents the Content-Type |
n/a |
fileName |
path |
Holds the name of the image file. |
n/a |
partId |
path |
Holds the SCId representation of a Part identifier. |
n/a |
Response Codes
code |
condition |
404 |
Returned when an image is not found for the Part |
400 |
Returned when the Id representation of Part is not in valid or the Media Id representation
is not valid |
Response Body
media type |
data type |
application/json |
object
(JSON) |
application/xml |
anyType
(XML) |
GET /parts/{partId}/images
Retrieves the images for a Part identified by given Part identifier.
Request Parameters
name |
type |
description |
default |
partId |
path |
Holds the SCId representation of a Part identifier. |
n/a |
Response Codes
code |
condition |
404 |
Returned when a Part is not found in the system of the given
identifier. |
400 |
Returned when the Id representation of Part is not in valid
format. |
Response Body
media type |
data type |
application/vnd.ptc.sc+json |
SCList
(JSON) |
GET /parts/{partId}/alternates/find
Searches the keyword in the alternate parts history for a given Part identifier
and returns the page numbers and count of occurrences
Request Parameters
name |
type |
description |
default |
partId |
path |
Holds the SCId representation of a Part identifier. |
n/a |
attributesToSearch |
query |
holds the attributes in which the keyword needs to be searched. |
n/a |
effectivity |
query |
Holds the effectivity filter information. |
n/a |
keyWord |
query |
holds the keyword that needs to be search for. |
n/a |
pageSize |
query |
holds the current page size. |
n/a |
Response Codes
code |
condition |
404 |
Returned when a Part is not found in the system of the given
parameters or alternates not found. |
400 |
Returned when the Id representation of Part is not in valid
format. |
Response Body
media type |
data type |
application/vnd.ptc.sc+json |
array of object
(JSON) |
GET /parts/{partId}/supersessions/find
Searches for the keyword in the superseded parts history for a given part identifier and
returns the page number and count of occurrences
Request Parameters
name |
type |
description |
default |
partId |
path |
Holds the SCId representation of a Part identifier. |
n/a |
attributesToSearch |
query |
holds the attributes in which the keyword needs to be searched. |
n/a |
effectivity |
query |
Holds the effectivity filter information |
n/a |
keyWord |
query |
holds the keyword that needs to be search for. |
n/a |
pageSize |
query |
holds the current page size. |
n/a |
Response Codes
code |
condition |
404 |
Returned when a Part is not found in the system of the given
parameters or supersedes not found. |
400 |
Returned when the Id representation of Part is not in valid
format. |
Response Body
media type |
data type |
application/vnd.ptc.sc+json |
array of object
(JSON) |
GET /parts/{partId}/partslists/find
Searches for the keyword in the partslists where the parts identified by given Part identifier are used
and returns the page number and count of occurrences.
Request Parameters
name |
type |
description |
default |
partId |
path |
Holds the SCId representation of a Part identifier. |
n/a |
attributesToSearch |
query |
holds the attributes in which the keyword needs to be searched. |
n/a |
keyWord |
query |
holds the keyword that needs to be search for. |
n/a |
pageSize |
query |
holds the current page size. |
n/a |
Response Codes
code |
condition |
404 |
Returned when a Part is not found in the system of the given
parameters |
400 |
Returned when the Id representation of Part is not in valid
format. |
Response Body
media type |
data type |
application/vnd.ptc.sc+json |
array of object
(JSON) |
GET /parts/{partId}/xrefs/find
Searches for the keyword in the xref parts for a given part identifier and
returns the page number and count of occurrences
Request Parameters
name |
type |
description |
default |
partId |
path |
Holds the SCId representation of a Part identifier. |
n/a |
attributesToSearch |
query |
holds the attributes in which the keyword needs to be searched. |
n/a |
effectivity |
query |
Holds the effectivity filter information |
n/a |
keyWord |
query |
holds the keyword that needs to be search for. |
n/a |
pageSize |
query |
holds the current page size. |
n/a |
Response Codes
code |
condition |
404 |
Returned when a Part is not found in the system of the given
parameters or supersedes not found. |
400 |
Returned when the Id representation of Part is not in valid
format. |
Response Body
media type |
data type |
application/vnd.ptc.sc+json |
array of object
(JSON) |
GET /parts/{partId}/thumbnail
Retrieves the thumbnail for the part.
Request Parameters
name |
type |
description |
default |
Accept |
header |
The type of files that are acceptable. |
n/a |
partId |
path |
The ID of the part 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 /parts/{partId}/preview
Retrieves a Part for a given part identifier which is used in search preview
Request Parameters
name |
type |
description |
default |
partId |
path |
Holds SCId representation of a Part identifier. |
n/a |
Response Codes
code |
condition |
404 |
Returned when a Part is not found in the system for the given
parameters. |
400 |
Returned when the Id representation of Part is not in valid
format. |
Response Body
media type |
data type |
application/vnd.ptc.sc+json |
SCItem
(JSON) |
GET /parts/{partId}/recommendations
Retrieves recommended parts for the given part identifier.
Request Parameters
name |
type |
description |
default |
partId |
path |
the Id for the part for which to find recommended parts. |
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 |
filter information |
n/a |
Response Codes
code |
condition |
400 |
Returned when the partId is not of valid ID format. |
404 |
Returned when a part is not found for the given partId |
501 |
Returned when there is no recommendation delegate in the system. |
503 |
Returned when an external recommendation delegate is offline. |
Response Body
media type |
data type |
application/vnd.ptc.sc+json |
SCList
(JSON) |
GET /parts/{partId}/documents
Searches related documents for part details for given part identifier.
Request Parameters
name |
type |
description |
default |
partId |
path |
Holds the SCId representation of a SCPart identifier. |
n/a |
$filter |
query |
OData expression that represents a search criteria. |
n/a |
$skip |
query |
Used for paging, the number of the result to start from. |
n/a |
$top |
query |
Used for paging, the number of the result to return to. |
n/a |
effectivity |
query |
Parameter to provide the effectivity filter criteria information. |
n/a |
value |
query |
parameter is used to provide additional query expression. |
n/a |
Response Codes
code |
condition |
404 |
Returned when a SCPart is not found in the system of the given
parameters or alternates not found. |
400 |
Returned when the Id representation of SCPart is not in valid
format. |
Response Body
media type |
data type |
application/vnd.ptc.sc+json |
SCItem
(JSON) |
GET /parts/{partId}/documentTabEnable
Request Parameters
name |
type |
description |
default |
partId |
path |
|
n/a |
$filter |
query |
|
n/a |
$skip |
query |
|
n/a |
$top |
query |
|
n/a |
effectivity |
query |
|
n/a |
value |
query |
|
n/a |
Response Body
media type |
data type |
application/vnd.ptc.sc+json |
SCItem
(JSON) |
GET /parts/{partId}/relatedDocuments
Retrieves Related Documents for particular Part.
Request Parameters
name |
type |
description |
default |
partId |
path |
Holds the SCId representation of a SCPart identifier. |
n/a |
$filter |
query |
OData expression that represents a search criteria. |
n/a |
$skip |
query |
Used for paging, the number of the result to start from. |
n/a |
$top |
query |
Used for paging, the number of the result to return to. |
n/a |
effectivity |
query |
Parameter to provide the effectivity filter criteria information. |
n/a |
value |
query |
parameter is used to provide additional query expression. |
n/a |
Response Codes
code |
condition |
404 |
Returned when a SCPart is not found in the system of the given
parameters or alternates not found. |
400 |
Returned when the Id representation of SCPart is not in valid
format. |
Response Body
media type |
data type |
application/vnd.ptc.sc+json |
SCItem
(JSON) |
GET /parts/details
Retrieves a part, partsList container and their corresponding InService viewer URL based on the specified input.
Uses the Part APIs to fetch the part and its container parts list (if parts List Persistent Id was provided)
within the context of Serial number or product Name if provided
The client URL is sent as part of the metadata of the product SCItem.
Request Parameters
name |
type |
description |
default |
collectionId |
query |
collection Id of the partsList |
n/a |
fullSearch |
query |
retrieve part relations |
n/a |
orgName |
query |
Holds the part organization name. |
n/a |
partNumber |
query |
Holds the part number. |
n/a |
partsList |
query |
Holds the partsList's container persistenId |
n/a |
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 |
validatePartsList |
query |
validate if part exists in the given parts list container |
n/a |
Response Codes
code |
condition |
404 |
Returned when a SCPart is not found in the system of the given
parameters |
Response Body
media type |
data type |
application/vnd.ptc.sc+json |
SCItem
(JSON) |
GET /parts/partURL
Retrieves part's and partsList's container InService viewer URL based on the specified input.
Uses the Part APIs to fetch the part and its container parts list (if parts List Persistent Id was provided)
within the context of Serial number or product Name if provided
The client URL is sent as part of the metadata of the product SCItem.
Request Parameters
name |
type |
description |
default |
collectionId |
query |
collection Id of the partsList |
n/a |
orgName |
query |
Holds the part organization name. |
n/a |
partNumber |
query |
Holds the part number. |
n/a |
partsList |
query |
Holds the partsList's container persistenId |
n/a |
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 |
validatePartsList |
query |
validate if part exists in the given parts list container |
n/a |
Response Codes
code |
condition |
404 |
Returned when a SCPart is not found in the system of the given
parameters |
Response Body
media type |
data type |
application/vnd.ptc.sc+json |
SCItem
(JSON) |