Jump to

• Request
• Response
• Examples

Get All BOM Item Definitions

get

/rest/v16/bomItemSetups

Use this endpoint to retrieve a list of BOM item definitions.

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.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : BOM Item Setup Collection Definitions

Type: object

Title: BOM Item Setup Collection Definitions

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "offset":{
            "type":"integer",
            "description":"The offset used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "totalResults":{
            "type":"integer",
            "description":"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."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Returns true if more resources are available on the server than the subset returned in current page."
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/bomItemSetups"
            }
        }
    },
    "title":"BOM Item Setup Collection Definitions"
}

Nested Schema : items

Type: array

Show Source

• Array of: object BOM Item Setup Instance Definitions
  Title: BOM Item Setup Instance Definitions

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/bomItemSetups"
    }
}

Nested Schema : BOM Item Setup Instance Definitions

Type: object

Title: BOM Item Setup Instance Definitions

Show Source

• bomPrice: number
  Title: BOM Price

  BOM Price
• configurableFlag: boolean
  Title: Configurable Flag

  Whether the BOM item tree is configurable
• defaultQuantity: number
  Title: Default Quantity

  Default quantity for the BOM item
• effectiveFrom: string
  Title: Effective From

  The effective from date for the BOM item
• effectiveTo: string
  Title: Effective To

  The effective to date for the BOM item
• isIncludedInBasePrice: boolean
  Title: Is Included In Base Price

  Whether the BOM item is included in the base price
• isManufacturingItem: boolean
  Title: Is Manufacturing Item

  Whether the BOM item is a manufacturing item
• isModel: boolean
  Title: Is Model

  Whether the BOM item is a model
• isOptional: boolean
  Title: Is Optional

  Whether the BOM item is optional
• isRootModel: boolean
  Title: Is Root Model

  Whether the BOM item is the root model
• isSalesItem: boolean
  Title: Is Sales Item

  Whether the BOM item is a sales item
• itemIdentifier: string
  Title: Item Identifier

  BOM item identifier
• itemType: string
  Title: Item Type

  BOM item type
• label: string
  Title: Label

  BOM item label
• modelPath: string
  Title: Model Path

  The path to a model in the BOM hierarchy
• parentVariableName: string
  Title: Parent Variable Name

  Variable name of the parent BOM item.
• partNumber: string
  Title: Part Number

  Part number of the BOM item
• rootBomItemLabel: string
  Title: Root BOM Item Label

  Label of the Root BOM Item of this item's hierarchy
• rootBomItemPartNumber: string
  Title: Root BOM Item Part Number

  Part Number value from the Root BOM Item
• rootVariableName: string
  Title: Root Variable Name

  Variable name of the root BOM item.
• sequenceNumber: integer
  Title: Sequence Number

  BOM item sequence number
• treeHasError: boolean
  Title: Tree Has Error

  Whether the BOM item tree has an item with errors
• treeHasModel: boolean
  Title: Tree Has Model

  Whether the BOM item tree has a model
• variableName: string
  Title: Variable Name

  Variable Name of the BOM item

{
    "type":"object",
    "properties":{
        "bomPrice":{
            "type":"number",
            "description":"BOM Price",
            "title":"BOM Price"
        },
        "configurableFlag":{
            "type":"boolean",
            "description":"Whether the BOM item tree is configurable",
            "title":"Configurable Flag"
        },
        "defaultQuantity":{
            "type":"number",
            "description":"Default quantity for the BOM item",
            "title":"Default Quantity"
        },
        "effectiveFrom":{
            "type":"string",
            "description":"The effective from date for the BOM item",
            "title":"Effective From"
        },
        "effectiveTo":{
            "type":"string",
            "description":"The effective to date for the BOM item",
            "title":"Effective To"
        },
        "isIncludedInBasePrice":{
            "type":"boolean",
            "description":"Whether the BOM item is included in the base price",
            "title":"Is Included In Base Price"
        },
        "isManufacturingItem":{
            "type":"boolean",
            "description":"Whether the BOM item is a manufacturing item",
            "title":"Is Manufacturing Item"
        },
        "isModel":{
            "type":"boolean",
            "description":"Whether the BOM item is a model",
            "title":"Is Model"
        },
        "isOptional":{
            "type":"boolean",
            "description":"Whether the BOM item is optional",
            "title":"Is Optional"
        },
        "isRootModel":{
            "type":"boolean",
            "description":"Whether the BOM item is the root model",
            "title":"Is Root Model"
        },
        "isSalesItem":{
            "type":"boolean",
            "description":"Whether the BOM item is a sales item",
            "title":"Is Sales Item"
        },
        "itemIdentifier":{
            "type":"string",
            "description":"BOM item identifier",
            "title":"Item Identifier"
        },
        "itemType":{
            "type":"string",
            "description":"BOM item type",
            "title":"Item Type"
        },
        "label":{
            "type":"string",
            "description":"BOM item label",
            "title":"Label"
        },
        "modelPath":{
            "type":"string",
            "description":"The path to a model in the BOM hierarchy",
            "title":"Model Path"
        },
        "parentVariableName":{
            "type":"string",
            "description":"Variable name of the parent BOM item.",
            "title":"Parent Variable Name"
        },
        "partNumber":{
            "type":"string",
            "description":"Part number of the BOM item",
            "title":"Part Number"
        },
        "rootBomItemLabel":{
            "type":"string",
            "description":"Label of the Root BOM Item of this item's hierarchy",
            "title":"Root BOM Item Label"
        },
        "rootBomItemPartNumber":{
            "type":"string",
            "description":"Part Number value from the Root BOM Item",
            "title":"Root BOM Item Part Number"
        },
        "rootVariableName":{
            "type":"string",
            "description":"Variable name of the root BOM item.",
            "title":"Root Variable Name"
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"BOM item sequence number",
            "title":"Sequence Number"
        },
        "treeHasError":{
            "type":"boolean",
            "description":"Whether the BOM item tree has an item with errors",
            "title":"Tree Has Error"
        },
        "treeHasModel":{
            "type":"boolean",
            "description":"Whether the BOM item tree has a model",
            "title":"Tree Has Model"
        },
        "variableName":{
            "type":"string",
            "description":"Variable Name of the BOM item",
            "title":"Variable Name"
        }
    },
    "title":"BOM Item Setup Instance Definitions"
}

Back to Top

Examples

The following example shows how to retrieve a list of BOM Item Definitions 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 "Accept: application/json"
https://sitename.oracle.com/rest/v16/bomItemSetups

Response Body Sample

{
  "offset": 0,
  "limit": 5,
  "count": 5,
  "hasMore": true,
  "links": [{
      "rel": "canonical",
      "href": "https://sitename.oracle.com/rest/v16/bomItemSetups"
    }, {
      "rel": "next",
      "href": "https://sitename.oracle.com/rest/v16/bomItemSetups?limit=5&offset=5"
    }, {
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/bomItemSetups?limit=5&offset=0"
    }
  ],
  "items": [{
      "isManufacturingItem": true,
      "parentVariableName": null,
      "sequenceNumber": 0,
      "isIncludedInBasePrice": false,
      "itemType": "Standard Item",
      "variableName": "VEHICLE",
      "modelPath": null,
      "bomPrice": 0.0,
      "isSalesItem": true,
      "isOptional": false,
      "label": "Consumer Vehicle",
      "rootBomItemPartNumber": "VEHICLE",
      "defaultQuantity": 1.0,
      "isRootModel": true,
      "effectiveTo": null,
      "rootBomItemLabel": "Consumer Vehicle",
      "rootVariableName": "VEHICLE",
      "partNumber": "VEHICLE",
      "itemIdentifier": "0",
      "effectiveFrom": null,
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/bomItemSetups/VEHICLE"
        }, {
          "kind": "",
          "rel": "child",
          "name": "bomItemMappings",
          "href": "https://sitename.oracle.com/rest/v16/bomItemSetups/VEHICLE/bomItemMappings"
        }, {
          "kind": "",
          "rel": "child",
          "name": "children",
          "href": "https://sitename.oracle.com/rest/v16/bomItemSetups/VEHICLE/children"
        }
      ]
    }, {
      "isManufacturingItem": true,
      "parentVariableName": "VEHICLE",
      "sequenceNumber": 1,
      "isIncludedInBasePrice": false,
      "itemType": "Standard Item",
      "variableName": "SUB1",
      "modelPath": null,
      "bomPrice": 999.0,
      "isSalesItem": true,
      "isOptional": false,
      "label": "Crossover SUV Subscription",
      "rootBomItemPartNumber": "VEHICLE",
      "defaultQuantity": 1.0,
      "isRootModel": false,
      "effectiveTo": null,
      "rootBomItemLabel": "Consumer Vehicle",
      "rootVariableName": "VEHICLE",
      "partNumber": "Crossover SUV Subscription",
      "itemIdentifier": "1",
      "effectiveFrom": null,
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/bomItemSetups/SUB1"
        }, {
          "kind": "",
          "rel": "child",
          "name": "bomItemMappings",
          "href": "https://sitename.oracle.com/rest/v16/bomItemSetups/SUB1/bomItemMappings"
        }, {
          "kind": "",
          "rel": "child",
          "name": "children",
          "href": "https://sitename.oracle.com/rest/v16/bomItemSetups/SUB1/children"
        }
      ]
    }, {
      "isManufacturingItem": false,
      "parentVariableName": "VEHICLE",
      "sequenceNumber": 2,
      "isIncludedInBasePrice": false,
      "itemType": "Standard Item",
      "variableName": "SUB2",
      "modelPath": null,
      "bomPrice": 0.0,
      "isSalesItem": true,
      "isOptional": false,
      "label": "Sports SUV Subscription",
      "rootBomItemPartNumber": "VEHICLE",
      "defaultQuantity": 1.0,
      "isRootModel": false,
      "effectiveTo": null,
      "rootBomItemLabel": "Consumer Vehicle",
      "rootVariableName": "VEHICLE",
      "partNumber": "Sports SUV Subscription",
      "itemIdentifier": "2",
      "effectiveFrom": null,
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/bomItemSetups/SUB2"
        }, {
          "kind": "",
          "rel": "child",
          "name": "bomItemMappings",
          "href": "https://sitename.oracle.com/rest/v16/bomItemSetups/SUB2/bomItemMappings"
        }, {
          "kind": "",
          "rel": "child",
          "name": "children",
          "href": "https://sitename.oracle.com/rest/v16/bomItemSetups/SUB2/children"
        }
      ]
    }, {
      "isManufacturingItem": false,
      "parentVariableName": "VEHICLE",
      "sequenceNumber": 3,
      "isIncludedInBasePrice": false,
      "itemType": "Standard Item",
      "variableName": "SUB3",
      "modelPath": null,
      "bomPrice": 0.0,
      "isSalesItem": true,
      "isOptional": false,
      "label": "Luxury SUV Subscription",
      "rootBomItemPartNumber": "VEHICLE",
      "defaultQuantity": 1.0,
      "isRootModel": false,
      "effectiveTo": null,
      "rootBomItemLabel": "Consumer Vehicle",
      "rootVariableName": "VEHICLE",
      "partNumber": "Luxury SUV Subscription",
      "itemIdentifier": "3",
      "effectiveFrom": null,
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/bomItemSetups/SUB3"
        }, {
          "kind": "",
          "rel": "child",
          "name": "bomItemMappings",
          "href": "https://sitename.oracle.com/rest/v16/bomItemSetups/SUB3/bomItemMappings"
        }, {
          "kind": "",
          "rel": "child",
          "name": "children",
          "href": "https://sitename.oracle.com/rest/v16/bomItemSetups/SUB3/children"
        }
      ]
    }, {
      "isManufacturingItem": false,
      "parentVariableName": "VEHICLE",
      "sequenceNumber": 8,
      "isIncludedInBasePrice": false,
      "itemType": "Standard Item",
      "variableName": "SVC1",
      "modelPath": null,
      "bomPrice": 0.0,
      "isSalesItem": true,
      "isOptional": false,
      "label": "Sirius XM Radio",
      "rootBomItemPartNumber": "VEHICLE",
      "defaultQuantity": 1.0,
      "isRootModel": false,
      "effectiveTo": null,
      "rootBomItemLabel": "Consumer Vehicle",
      "rootVariableName": "VEHICLE",
      "partNumber": "Sirius XM Radio",
      "itemIdentifier": "8",
      "effectiveFrom": null,
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/bomItemSetups/SVC1"
        }, {
          "kind": "",
          "rel": "child",
          "name": "bomItemMappings",
          "href": "https://sitename.oracle.com/rest/v16/bomItemSetups/SVC1/bomItemMappings"
        }, {
          "kind": "",
          "rel": "child",
          "name": "children",
          "href": "https://sitename.oracle.com/rest/v16/bomItemSetups/SVC1/children"
        }
      ]
    }
  ]
}

Back to Top