Jump to

• Request
• Response
• Examples

Get All BOM Item Mappings for a Parent BOM Item

get

/rest/v16/bomItemSetups/{bomItemVarName}/bomItemMappings

Use this endpoint to retrieve a list of BOM item mappings for a parent BOM item.

Request

Supported Media Types

• application/json

Path Parameters

• bomItemVarName(required): string
  Variable Name of the BOM item

Query Parameters

• 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 Mapping Setup Collection Definitions

Type: object

Title: BOM Item Mapping 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/bomItemMappingSetups"
            }
        }
    },
    "title":"BOM Item Mapping Setup Collection Definitions"
}

Nested Schema : items

Type: array

Show Source

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

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

Nested Schema : BOM Item Mapping Setup Instance Definitions

Type: object

Title: BOM Item Mapping Setup Instance Definitions

Show Source

• additionalConfigurationAttributeValue1: string
  Title: Additional Configuration Attribute Value 1

  The value of the first additional configurable attribute in multiple attribute mapping
• additionalConfigurationAttributeValue10: string
  Title: Additional Configuration Attribute Value 10

  The value of the tenth additional configurable attribute in multiple attribute mapping
• additionalConfigurationAttributeValue2: string
  Title: Additional Configuration Attribute Value 2

  The value of the second additional configurable attribute in multiple attribute mapping
• additionalConfigurationAttributeValue3: string
  Title: Additional Configuration Attribute Value 3

  The value of the third additional configurable attribute in multiple attribute mapping
• additionalConfigurationAttributeValue4: string
  Title: Additional Configuration Attribute Value 4

  The value of the fourth additional configurable attribute in multiple attribute mapping
• additionalConfigurationAttributeValue5: string
  Title: Additional Configuration Attribute Value 5

  The value of the fifth additional configurable attribute in multiple attribute mapping
• additionalConfigurationAttributeValue6: string
  Title: Additional Configuration Attribute Value 6

  The value of the sixth additional configurable attribute in multiple attribute mapping
• additionalConfigurationAttributeValue7: string
  Title: Additional Configuration Attribute Value 7

  The value of the seventh additional configurable attribute in multiple attribute mapping
• additionalConfigurationAttributeValue8: string
  Title: Additional Configuration Attribute Value 8

  The value of the eighth additional configurable attribute in multiple attribute mapping
• additionalConfigurationAttributeValue9: string
  Title: Additional Configuration Attribute Value 9

  The value of the ninth additional configurable attribute in multiple attribute mapping
• additionalConfigurationAttributeVariableName1: string
  Title: Additional Configuration Attribute Variable Name 1

  The variable name of the first additional configurable attribute in multiple attribute mapping
• additionalConfigurationAttributeVariableName10: string
  Title: Additional Configuration Attribute Variable Name 10

  The variable name of the tenth additional configurable attribute in multiple attribute mapping
• additionalConfigurationAttributeVariableName2: string
  Title: Additional Configuration Attribute Variable Name 2

  The variable name of the second additional configurable attribute in multiple attribute mapping
• additionalConfigurationAttributeVariableName3: string
  Title: Additional Configuration Attribute Variable Name 3

  The variable name of the third additional configurable attribute in multiple attribute mapping
• additionalConfigurationAttributeVariableName4: string
  Title: Additional Configuration Attribute Variable Name 4

  The variable name of the fourth additional configurable attribute in multiple attribute mapping
• additionalConfigurationAttributeVariableName5: string
  Title: Additional Configuration Attribute Variable Name 5

  The variable name of the fifth additional configurable attribute in multiple attribute mapping
• additionalConfigurationAttributeVariableName6: string
  Title: Additional Configuration Attribute Variable Name 6

  The variable name of the sixth additional configurable attribute in multiple attribute mapping
• additionalConfigurationAttributeVariableName7: string
  Title: Additional Configuration Attribute Variable Name 7

  The variable name of the seventh additional configurable attribute in multiple attribute mapping
• additionalConfigurationAttributeVariableName8: string
  Title: Additional Configuration Attribute Variable Name 8

  The variable name of the eighth additional configurable attribute in multiple attribute mapping
• additionalConfigurationAttributeVariableName9: string
  Title: Additional Configuration Attribute Variable Name 9

  The variable name of the ninth additional configurable attribute in multiple attribute mapping
• bomItemVariableName: string
  Title: BOM Item Variable Name

  The variable name of the BOM item
• configurationAttributeValue: string
  Title: Configuration Attribute Value

  The value of the configurable attribute
• configurationAttributeVariableName: string
  Title: Configuration Attribute Variable Name

  The variable name of the configurable attribute
• 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
• parentBOMMappingRuleVariableName: string
  Title: Parent BOM Mapping Rule Variable Name

  The variable name of the BOM Map configuration rule
• variableName: string
  Title: Variable Name

  Variable Name of the BOM item mapping

{
    "type":"object",
    "properties":{
        "additionalConfigurationAttributeValue1":{
            "type":"string",
            "description":"The value of the first additional configurable attribute in multiple attribute mapping",
            "title":"Additional Configuration Attribute Value 1"
        },
        "additionalConfigurationAttributeValue10":{
            "type":"string",
            "description":"The value of the tenth additional configurable attribute in multiple attribute mapping",
            "title":"Additional Configuration Attribute Value 10"
        },
        "additionalConfigurationAttributeValue2":{
            "type":"string",
            "description":"The value of the second additional configurable attribute in multiple attribute mapping",
            "title":"Additional Configuration Attribute Value 2"
        },
        "additionalConfigurationAttributeValue3":{
            "type":"string",
            "description":"The value of the third additional configurable attribute in multiple attribute mapping",
            "title":"Additional Configuration Attribute Value 3"
        },
        "additionalConfigurationAttributeValue4":{
            "type":"string",
            "description":"The value of the fourth additional configurable attribute in multiple attribute mapping",
            "title":"Additional Configuration Attribute Value 4"
        },
        "additionalConfigurationAttributeValue5":{
            "type":"string",
            "description":"The value of the fifth additional configurable attribute in multiple attribute mapping",
            "title":"Additional Configuration Attribute Value 5"
        },
        "additionalConfigurationAttributeValue6":{
            "type":"string",
            "description":"The value of the sixth additional configurable attribute in multiple attribute mapping",
            "title":"Additional Configuration Attribute Value 6"
        },
        "additionalConfigurationAttributeValue7":{
            "type":"string",
            "description":"The value of the seventh additional configurable attribute in multiple attribute mapping",
            "title":"Additional Configuration Attribute Value 7"
        },
        "additionalConfigurationAttributeValue8":{
            "type":"string",
            "description":"The value of the eighth additional configurable attribute in multiple attribute mapping",
            "title":"Additional Configuration Attribute Value 8"
        },
        "additionalConfigurationAttributeValue9":{
            "type":"string",
            "description":"The value of the ninth additional configurable attribute in multiple attribute mapping",
            "title":"Additional Configuration Attribute Value 9"
        },
        "additionalConfigurationAttributeVariableName1":{
            "type":"string",
            "description":"The variable name of the first additional configurable attribute in multiple attribute mapping",
            "title":"Additional Configuration Attribute Variable Name 1"
        },
        "additionalConfigurationAttributeVariableName10":{
            "type":"string",
            "description":"The variable name of the tenth additional configurable attribute in multiple attribute mapping",
            "title":"Additional Configuration Attribute Variable Name 10"
        },
        "additionalConfigurationAttributeVariableName2":{
            "type":"string",
            "description":"The variable name of the second additional configurable attribute in multiple attribute mapping",
            "title":"Additional Configuration Attribute Variable Name 2"
        },
        "additionalConfigurationAttributeVariableName3":{
            "type":"string",
            "description":"The variable name of the third additional configurable attribute in multiple attribute mapping",
            "title":"Additional Configuration Attribute Variable Name 3"
        },
        "additionalConfigurationAttributeVariableName4":{
            "type":"string",
            "description":"The variable name of the fourth additional configurable attribute in multiple attribute mapping",
            "title":"Additional Configuration Attribute Variable Name 4"
        },
        "additionalConfigurationAttributeVariableName5":{
            "type":"string",
            "description":"The variable name of the fifth additional configurable attribute in multiple attribute mapping",
            "title":"Additional Configuration Attribute Variable Name 5"
        },
        "additionalConfigurationAttributeVariableName6":{
            "type":"string",
            "description":"The variable name of the sixth additional configurable attribute in multiple attribute mapping",
            "title":"Additional Configuration Attribute Variable Name 6"
        },
        "additionalConfigurationAttributeVariableName7":{
            "type":"string",
            "description":"The variable name of the seventh additional configurable attribute in multiple attribute mapping",
            "title":"Additional Configuration Attribute Variable Name 7"
        },
        "additionalConfigurationAttributeVariableName8":{
            "type":"string",
            "description":"The variable name of the eighth additional configurable attribute in multiple attribute mapping",
            "title":"Additional Configuration Attribute Variable Name 8"
        },
        "additionalConfigurationAttributeVariableName9":{
            "type":"string",
            "description":"The variable name of the ninth additional configurable attribute in multiple attribute mapping",
            "title":"Additional Configuration Attribute Variable Name 9"
        },
        "bomItemVariableName":{
            "type":"string",
            "description":"The variable name of the BOM item",
            "title":"BOM Item Variable Name"
        },
        "configurationAttributeValue":{
            "type":"string",
            "description":"The value of the configurable attribute",
            "title":"Configuration Attribute Value"
        },
        "configurationAttributeVariableName":{
            "type":"string",
            "description":"The variable name of the configurable attribute",
            "title":"Configuration Attribute Variable Name"
        },
        "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"
        },
        "parentBOMMappingRuleVariableName":{
            "type":"string",
            "description":"The variable name of the BOM Map configuration rule",
            "title":"Parent BOM Mapping Rule Variable Name"
        },
        "variableName":{
            "type":"string",
            "description":"Variable Name of the BOM item mapping",
            "title":"Variable Name"
        }
    },
    "title":"BOM Item Mapping Setup Instance Definitions"
}

Back to Top

Examples

The following example shows how to retrieve a list of BOM Item Mappings for a parent BOM Item 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/varioTablet/bomItemMappings

Response Body Sample

{
  "hasMore": false,
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/bomItemSetups/varioTablet/bomItemMappings"
    }
  ],
  "items": [{
      "additionalConfigurationAttributeVariableName2": null,
      "additionalConfigurationAttributeVariableName3": null,
      "additionalConfigurationAttributeVariableName1": null,
      "additionalConfigurationAttributeVariableName10": null,
      "configurationAttributeValue": "Custom",
      "effectiveTo": null,
      "configurationAttributeVariableName": "tabletType",
      "bomItemVariableName": "varioTablet",
      "additionalConfigurationAttributeValue6": null,
      "additionalConfigurationAttributeValue7": null,
      "additionalConfigurationAttributeValue10": null,
      "additionalConfigurationAttributeValue4": null,
      "parentBOMMappingRuleVariableName": "varioTablets:tablets:customTablet:defaultBOMMappingRule",
      "variableName": "varioTablet-custom",
      "additionalConfigurationAttributeValue5": null,
      "additionalConfigurationAttributeValue8": null,
      "additionalConfigurationAttributeValue9": null,
      "additionalConfigurationAttributeVariableName8": null,
      "additionalConfigurationAttributeVariableName9": null,
      "additionalConfigurationAttributeValue2": null,
      "additionalConfigurationAttributeVariableName6": null,
      "additionalConfigurationAttributeValue3": null,
      "additionalConfigurationAttributeVariableName7": null,
      "effectiveFrom": null,
      "additionalConfigurationAttributeVariableName4": null,
      "additionalConfigurationAttributeValue1": null,
      "additionalConfigurationAttributeVariableName5": null,
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/bomItemSetups/varioTablet/bomItemMappings/varioTablet-custom"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com//rest/v16/bomItemSetups/varioTablet"
        }
      ]
    }, {
      "additionalConfigurationAttributeVariableName2": null,
      "additionalConfigurationAttributeVariableName3": null,
      "additionalConfigurationAttributeVariableName1": null,
      "additionalConfigurationAttributeVariableName10": null,
      "configurationAttributeValue": null,
      "effectiveTo": null,
      "configurationAttributeVariableName": null,
      "bomItemVariableName": "varioTablet",
      "additionalConfigurationAttributeValue6": null,
      "additionalConfigurationAttributeValue7": null,
      "additionalConfigurationAttributeValue10": null,
      "additionalConfigurationAttributeValue4": null,
      "parentBOMMappingRuleVariableName": "varioTablets:tablets:customTablet:defaultBOMMappingRule",
      "variableName": "varioTablet-Standard",
      "additionalConfigurationAttributeValue5": null,
      "additionalConfigurationAttributeValue8": null,
      "additionalConfigurationAttributeValue9": null,
      "additionalConfigurationAttributeVariableName8": null,
      "additionalConfigurationAttributeVariableName9": null,
      "additionalConfigurationAttributeValue2": null,
      "additionalConfigurationAttributeVariableName6": null,
      "additionalConfigurationAttributeValue3": null,
      "additionalConfigurationAttributeVariableName7": null,
      "effectiveFrom": null,
      "additionalConfigurationAttributeVariableName4": null,
      "additionalConfigurationAttributeValue1": null,
      "additionalConfigurationAttributeVariableName5": null,
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/bomItemSetups/varioTablet/bomItemMappings/varioTablet-Standard"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/bomItemSetups/varioTablet"
        }
      ]
    }
  ]
}

Back to Top