v1

latestOpenAPI 3.1.02026-08-0420819698.7 KB
Routes
Assets
Parts

Asset Parts

This request returns a list of Part Asset Relations with top level information such as part, asset, qty, last edited, etc.

Note: this endpoint supports pagination. Please refer to the Pagination section for more information.

Return data description

relationID | The Relations ID. e.g. 1 partID | The ID of the Part in this Relation assetID | The ID of the Asset in this Relation qty | The qty of the Part related to this Asset createdAt | The unix timestamp at which this Relation was created lastEdited | The unix timestamp at which this Relation last saw a change associationType | The method used to create this Relation. At this time, only "manual" is supported

get/v2/assets/parts

Query parameters

assetsstring

This parameter is used to only get specific Assets. This parameter expects a comma delimited list of Asset IDs.

limitinteger

This parameter is a result limiter. The default is set to return no more than 100 results at one time.

pageinteger

This parameter is used to paginate results based on the limit. Refer to Pagination section for more information.

cursorinteger

This parameter is a cursor that selects what ID you want to start receiving results at. Without ordering, this will return results with an ID greater than the value of cursor. With ordering, this will return results starting at the next item in the order, regardless of whether its ID is greater than or lesser than the value of cursor.

partsstring

This parameter is used to only get specific Parts. This parameter accepts a comma delimited list of part IDs.

relationsstring

This parameter is used to only get specific relations. This parameter expects a comma delimited list of relation IDs.

startinteger

This parameter is used to only get relations that were last edited after the unix timestamp passed into the start parameter. For example, all relations that were last edited after April 18th, 2018.

endinteger

This parameter is used to only get relations that were last edited before the unix timestamp passed into the end parameter.

Response

Asset Parts

relationIDinteger
partIDinteger
assetIDinteger
qtyinteger
createdAtinteger
lastEditedinteger
associationTypestring