Get All Parts
get
/rest/v16/parts
Use this endpoint to retrieve a list of all parts.
Request
Supported Media Types
- application/json
Query Parameters
-
expand: string
Allows expansion of relationships.
-
fields: string
Restrict which fields shall be returned. The value is a comma delimited string and each token is a field name.
-
limit: integer
The requested page size, which limits the number of elements the collection should max return.
-
offset: integer
The offset of the page. By default, offset is 0, which means first page will be returned.
-
orderby: string
Specifies a comma-separated list of pairs to order the response by.
-
q: string
Allows to specify one or more filtering criteria. By default, no filtering is applied.
-
totalResults: boolean
Specifies that the total count of records should be included in the response when doing pagination.
Response
Supported Media Types
- application/json
Default Response
Root Schema : Part Collection Definitions
Type:
object
Title:
Show Source
Part Collection Definitions
-
count:
integer
The number of resource instances returned in the current range.
-
hasMore:
boolean
Returns true if more resources are available on the server than the subset returned in current page.
-
items:
array items
-
limit:
integer
The actual paging size used by the server.
-
offset:
integer
The offset used in the current page.
-
totalResults:
integer
Capture the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.
Nested Schema : items
Type:
Show Source
array
-
Array of:
object Part Instance Definitions
Title:
Part Instance Definitions
Nested Schema : Part Instance Definitions
Type:
object
Title:
Show Source
Part Instance Definitions
-
bomItemVariableName:
string
Title:
Default Bom Item Variable Name
Variable name of the root BOM item. -
configurableFlag:
object Configurable Flag
Title:
Configurable Flag
Part Configurable Flag -
dateAdded:
string
Title:
Date Added
System field indicating the date on which the Resource was created. -
dateModified:
string
Title:
Date Modified
System field indicating the date on which the Resource was last modified. -
defaultUOMCode:
string
Title:
Default UOM Code
Default Unit of Measure. -
description:
string
Title:
Description
Description of the part -
directBuy:
object Direct Buy
Title:
Direct Buy
Determines how the part must be purchased. -
eligibleForService:
string
Title:
Eligible for Service
Enable this option, when integrating with a service request application. -
eligibleToSell:
string
Title:
Eligible to Sell
Check this if the part should be visible to a sales person (If the part is sellable or not). -
enableSelfService:
string
Title:
Enable Customer Self-Service
When integrating with any customer self service application- enable this option to identify parts as self-service eligible. -
externalKey1:
string
Title:
External Key 1
References for parts coming in from external third party system. -
externalKey2:
string
Title:
External Key 2
References for parts coming in from external third party system. -
id:
integer
Title:
Id
Primary Key of the part resource. -
leadTime:
integer
Title:
Lead Time
Time taken in days for the part to be shipped. -
numberOfPricePeriods:
integer
Title:
Number of Price Periods
Default number of price periods for a part. -
partDisplayNumber:
string
Title:
Part Display Number
Part Number for display purpose. -
partNumber:
string
Title:
Part Number
Part Number used to identify a part. -
partNumberLower:
string
Title:
Part Number Lower
Used to store part number in lower case. -
pricePeriod:
string
Title:
Price Period
Default price period for the period. -
priceType:
string
Title:
Price Type
Default price type applicable to the part- e.g. One-Time, Recurring or Usage-based. -
salesProductType:
string
Title:
Sales Product Type
Categorize the product by selecting a product type. -
status:
object Product Status
Title:
Product Status
Status of the product -
units:
string
Title:
Units
Number of units for the part number
Nested Schema : Configurable Flag
Type:
object
Title:
Configurable Flag
Part Configurable Flag
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Nested Schema : Direct Buy
Type:
object
Title:
Direct Buy
Determines how the part must be purchased.
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Nested Schema : Product Status
Type:
object
Title:
Product Status
Status of the product
Show Source
-
displayValue:
string
Title:
Display Value
Translated display name of the type for which fixed list of values can be defined. -
id:
integer
Title:
Id
Primary Key of the fixed list of value resource. -
lookupCode:
string
Title:
Lookup Code
Language independent code of the fixed list of value.
Examples
The following examples show how to retrieve a list of all parts by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl - X GET - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json" https://sitename.oracle.com/rest/v16/parts?limit=3
Request Body Sample
{ "offset": 0, "limit": 3, "count": 3, "hasMore": true, "links": [{ "rel": "canonical", "href": "https://sitename.oracle.com/rest/v16/parts" }, { "rel": "next", "href": "https://sitename.oracle.com/rest/v16/parts?limit=3&offset=3" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v16/parts?limit=3&offset=0" } ], "items": [{ "enableSelfService": null, "_part_custom_field10": { "lookupCode": "External", "displayValue": "External", "id": 38272229, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v16/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22_PART_field10%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v16/lookupValues/38272229" } ] }, "dateAdded": "2017-10-19T01:28:51.000Z", "bomItemVariableName": null, "_part_custom_field9": null, "id": 36551467, "_part_custom_field3": null, "_part_custom_field4": null, "_part_custom_field1": null, "_part_custom_field2": null, "_part_custom_field8": null, "_part_custom_field5": 0.0, "salesProductType": null, "configurableFlag": { "lookupCode": "0", "displayValue": "Not Configurable", "id": 38831190, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v16/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIGURABLE_FLAG%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v16/lookupValues/38831190" } ] }, "status": { "lookupCode": "ORA_CREATED", "displayValue": "Created", "id": 38831140, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v16/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_PRODUCT_SETUP_STATUS%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v16/lookupValues/38831140" } ] }, "eligibleForService": null, "directBuy": { "lookupCode": "1", "displayValue": "Direct Buy", "id": 36549639, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v16/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_PARTS_DIRECT_BUY%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v16/lookupValues/36549639" } ] }, "defaultUOMCode": null, "description": null, "leadTime": -1, "units": null, "eligibleToSell": null, "priceType": null, "numberOfPricePeriods": 0, "dateModified": "2021-04-19T12:10:26.000Z", "partDisplayNumber": "Green Server", "pricePeriod": null, "partNumberLower": "gs5004", "partNumber": "GS5004", "externalKey1": null, "externalKey2": null, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/parts/36551467" }, { "kind": "", "rel": "child", "name": "translations", "href": "https://sitename.oracle.com/rest/v16/parts/36551467/translations" } ] }, { "enableSelfService": null, "_part_custom_field10": { "lookupCode": "External", "displayValue": "External", "id": 38272229, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v16/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22_PART_field10%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v16/lookupValues/38272229" } ] }, "dateAdded": "2017-11-13T13:57:14.000Z", "bomItemVariableName": null, "_part_custom_field9": null, "id": 36594573, "_part_custom_field3": null, "_part_custom_field4": null, "_part_custom_field1": null, "_part_custom_field2": null, "_part_custom_field8": { "lookupCode": "One Time", "displayValue": "One Time", "id": 36657633, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v16/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22_PART_field8%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v16/lookupValues/36657633" } ] }, "_part_custom_field5": 50.0, "salesProductType": null, "configurableFlag": { "lookupCode": "0", "displayValue": "Not Configurable", "id": 38831190, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v16/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIGURABLE_FLAG%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v16/lookupValues/38831190" } ] }, "status": { "lookupCode": "ORA_CREATED", "displayValue": "Created", "id": 38831140, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v16/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_PRODUCT_SETUP_STATUS%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v16/lookupValues/38831140" } ] }, "eligibleForService": null, "directBuy": { "lookupCode": "1", "displayValue": "Direct Buy", "id": 36549639, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v16/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_PARTS_DIRECT_BUY%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v16/lookupValues/36549639" } ] }, "defaultUOMCode": null, "description": null, "leadTime": -1, "units": null, "eligibleToSell": null, "priceType": null, "numberOfPricePeriods": 0, "dateModified": "2021-04-19T12:10:26.000Z", "partDisplayNumber": "Vario Tablet", "pricePeriod": null, "partNumberLower": "vario tablet custom", "partNumber": "Vario Tablet Custom", "externalKey1": null, "externalKey2": null, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/parts/36594573" }, { "kind": "", "rel": "child", "name": "translations", "href": "https://sitename.oracle.com/rest/v16/parts/36594573/translations" } ] }, { "enableSelfService": null, "_part_custom_field10": { "lookupCode": "External", "displayValue": "External", "id": 38272229, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v16/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22_PART_field10%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v16/lookupValues/38272229" } ] }, "dateAdded": "2017-11-13T13:57:56.000Z", "bomItemVariableName": null, "_part_custom_field9": null, "id": 36594576, "_part_custom_field3": null, "_part_custom_field4": null, "_part_custom_field1": null, "_part_custom_field2": null, "_part_custom_field8": { "lookupCode": "One Time", "displayValue": "One Time", "id": 36657633, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v16/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22_PART_field8%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v16/lookupValues/36657633" } ] }, "_part_custom_field5": 20.0, "salesProductType": null, "configurableFlag": { "lookupCode": "0", "displayValue": "Not Configurable", "id": 38831190, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v16/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIGURABLE_FLAG%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v16/lookupValues/38831190" } ] }, "status": { "lookupCode": "ORA_CREATED", "displayValue": "Created", "id": 38831140, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v16/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_CONFIG_PRODUCT_SETUP_STATUS%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v16/lookupValues/38831140" } ] }, "eligibleForService": null, "directBuy": { "lookupCode": "1", "displayValue": "Direct Buy", "id": 36549639, "links": [{ "rel": "domain", "href": "https://sitename.oracle.com/rest/v16/lookupValues?q=%7B%22lookupType%22%3A%7B%22%24eq%22%3A%22BM_PARTS_DIRECT_BUY%22%7D%7D" }, { "rel": "canonical", "href": "https://sitename.oracle.com/rest/v16/lookupValues/36549639" } ] }, "defaultUOMCode": null, "description": "Quad Core 1.9 GHz", "leadTime": -1, "units": null, "eligibleToSell": null, "priceType": null, "numberOfPricePeriods": 0, "dateModified": "2021-04-19T12:10:26.000Z", "partDisplayNumber": "Quad Core 1.9 GHz", "pricePeriod": null, "partNumberLower": "cpu-100m-19", "partNumber": "CPU-100M-19", "externalKey1": null, "externalKey2": null, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v16/parts/36594576" }, { "kind": "", "rel": "child", "name": "translations", "href": "https://sitename.oracle.com/rest/v16/parts/36594576/translations" } ] } ] }