Jump to

• Request
• Response
• Examples

Get a Part

get

/rest/v16/parts/{id}

Use this endpoint to retrieve the specified part.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): integer
  Primary Key of the part resource.

Query Parameters

• expand: string
  Allows expansion of relationships.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Part Instance Definitions

Type: object

Title: Part Instance Definitions

Show Source

• 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

{
    "type":"object",
    "properties":{
        "bomItemVariableName":{
            "type":"string",
            "description":"Variable name of the root BOM item.",
            "title":"Default Bom Item Variable Name"
        },
        "configurableFlag":{
            "type":"object",
            "description":"Part Configurable Flag",
            "title":"Configurable Flag",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "dateAdded":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was created.",
            "title":"Date Added"
        },
        "dateModified":{
            "type":"string",
            "description":"System field indicating the date on which the Resource was last modified.",
            "title":"Date Modified"
        },
        "defaultUOMCode":{
            "type":"string",
            "description":"Default Unit of Measure.",
            "title":"Default UOM Code"
        },
        "description":{
            "type":"string",
            "description":"Description of the part",
            "title":"Description"
        },
        "directBuy":{
            "type":"object",
            "description":"Determines how the part must be purchased.",
            "title":"Direct Buy",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "eligibleForService":{
            "type":"string",
            "description":"Enable this option, when integrating with a service request application.",
            "title":"Eligible for Service"
        },
        "eligibleToSell":{
            "type":"string",
            "description":"Check this if the part should be visible to a sales person (If the part is sellable or not).",
            "title":"Eligible to Sell"
        },
        "enableSelfService":{
            "type":"string",
            "description":"When integrating with any customer self service application- enable this option to identify parts as self-service eligible.",
            "title":"Enable Customer Self-Service"
        },
        "externalKey1":{
            "type":"string",
            "description":"References for parts coming in from external third party system.",
            "title":"External Key 1"
        },
        "externalKey2":{
            "type":"string",
            "description":"References for parts coming in from external third party system.",
            "title":"External Key 2"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the part resource.",
            "title":"Id"
        },
        "leadTime":{
            "type":"integer",
            "description":"Time taken in days for the part to be shipped.",
            "title":"Lead Time"
        },
        "numberOfPricePeriods":{
            "type":"integer",
            "description":"Default number of price periods for a part.",
            "title":"Number of Price Periods"
        },
        "partDisplayNumber":{
            "type":"string",
            "description":"Part Number for display purpose.",
            "title":"Part Display Number"
        },
        "partNumber":{
            "type":"string",
            "description":"Part Number used to identify a part.",
            "title":"Part Number"
        },
        "partNumberLower":{
            "type":"string",
            "description":"Used to store part number in lower case.",
            "title":"Part Number Lower"
        },
        "pricePeriod":{
            "type":"string",
            "description":"Default price period for the period.",
            "title":"Price Period"
        },
        "priceType":{
            "type":"string",
            "description":"Default price type applicable to the part- e.g. One-Time, Recurring or Usage-based.",
            "title":"Price Type"
        },
        "salesProductType":{
            "type":"string",
            "description":"Categorize the product by selecting a product type.",
            "title":"Sales Product Type"
        },
        "status":{
            "type":"object",
            "description":"Status of the product",
            "title":"Product Status",
            "properties":{
                "lookupCode":{
                    "type":"string",
                    "description":"Language independent code of the fixed list of value.",
                    "title":"Lookup Code"
                },
                "id":{
                    "type":"integer",
                    "description":"Primary Key of the fixed list of value resource.",
                    "title":"Id"
                },
                "displayValue":{
                    "type":"string",
                    "description":"Translated display name of the type for which fixed list of values can be defined.",
                    "title":"Display Value"
                }
            }
        },
        "units":{
            "type":"string",
            "description":"Number of units for the part number",
            "title":"Units"
        }
    },
    "title":"Part Instance Definitions"
}

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.

{
    "type":"object",
    "description":"Part Configurable Flag",
    "title":"Configurable Flag",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display 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.

{
    "type":"object",
    "description":"Determines how the part must be purchased.",
    "title":"Direct Buy",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display 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.

{
    "type":"object",
    "description":"Status of the product",
    "title":"Product Status",
    "properties":{
        "lookupCode":{
            "type":"string",
            "description":"Language independent code of the fixed list of value.",
            "title":"Lookup Code"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the fixed list of value resource.",
            "title":"Id"
        },
        "displayValue":{
            "type":"string",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "title":"Display Value"
        }
    }
}

Back to Top

Examples

The following examples show how to retrieve the specified part 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/36594583

Request Body Sample

{
  "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:59:28.000Z",
  "bomItemVariableName": null,
  "_part_custom_field9": null,
  "id": 36594583,
  "_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": 10.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": "1GB Memory",
  "leadTime": -1,
  "units": null,
  "eligibleToSell": null,
  "priceType": null,
  "numberOfPricePeriods": 0,
  "dateModified": "2021-04-19T12:10:26.000Z",
  "partDisplayNumber": "1GB Memory",
  "pricePeriod": null,
  "partNumberLower": "mem-100m-1",
  "partNumber": "MEM-100M-1",
  "externalKey1": null,
  "externalKey2": null,
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/parts/36594583"
    }, {
      "kind": "",
      "rel": "child",
      "name": "translations",
      "href": "https://sitename.oracle.com/rest/v16/parts/36594583/translations"
    }
  ]
}

Back to Top