v1

latestOpenAPI 3.1.02026-08-0420819698.7 KB
Routes
Parts
Fields

Part Fields

This request gets detailed information about custom set Part Fields.

This request will return an array of objects that have a file name and a link you can use to download that image. All links are only valid for 15 minutes, a new call will generate a new link.

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

get/v2/parts/fields

Query parameters

fieldsstring

This parameter is used to only get specific fields by ID. This parameter expects a comma delimited list of fieldIDs.

namestring

This parameter is used to only get specific field by name. This parameter expects a string full name of a field or partial name with the wildcard %.

partsinteger

This parameter is used to only get part fields for a specific Part. This parameter expects a partID.

startinteger

This parameter is used to only get part fields for parts that were last edited after the unix timestamp passed into the start parameter.

endinteger

This parameter is used to only get parts fields for part fields that were last edited before the unix timestamp passed into the end parameter.

cursorinteger

This parameter is a cursor that selects what fieldID you want to start receiving results at. e.g. passing 137 here will only get you vendor fields with an id greater than 137.

limitinteger

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

valuestring

This parameter is used to only get specific field by value. This parameter expects a string full name of a field or partial name with the wildcard %.

locationsstring

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

valuesinteger

This parameter is used to get part fields by their valueID. This parameter expects a comma delimited list of Value IDs.

pageinteger

Response

Part Fields

fieldIDinteger
partIDinteger
fieldNamestring
{"stackTrail":"paths:/v2/parts/fields:get:responses:200:content:application/json:schema:items:properties:value","oasType":"schema","type":"unknown"}
valueIDinteger
fieldTypestring
lastEditedinteger
locationIDinteger