Jump to

• Request
• Response
• Examples

Get Mandatory Parts

post

/rest/v19/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_mandatoryParts/actions/getMandatoryParts

This action retrieves the mandatory parts of the configuration. This action does not run recommended items rules.

Request

Supported Media Types

• application/json

Path Parameters

• modelVarName(required): string
  The variable name of a Model
• prodFamVarName(required): string
  The variable name of a Product Family
• prodLineVarName(required): string
  The variable name of a Product Line

Body ()

Root Schema : getMandatoryPartsRequest

Type: object

Show Source

• cacheInstanceId(required): string
  Title: Cache Instance Id

  The unique identifier for the entry of configuration data stored in the cache. This is obtained from actions that launch configuration and passed along in subsequent actions.

{
    "type":"object",
    "required":[
        "cacheInstanceId"
    ],
    "properties":{
        "cacheInstanceId":{
            "type":"string",
            "description":"The unique identifier for the entry of configuration data stored in the cache. This is obtained from actions that launch configuration and passed along in subsequent actions.",
            "title":"Cache Instance Id"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : getMandatoryPartsResponse

Type: object

Show Source

• cacheInstanceId: string
  Title: Cache Instance Id

  The unique identifier for the entry of configuration data stored in the cache. This is obtained from actions that launch configuration and passed along in subsequent actions.
• items: array items

{
    "type":"object",
    "properties":{
        "cacheInstanceId":{
            "type":"string",
            "description":"The unique identifier for the entry of configuration data stored in the cache. This is obtained from actions that launch configuration and passed along in subsequent actions.",
            "title":"Cache Instance Id"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/part"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object part

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

Nested Schema : part

Type: object

Show Source

• _part_custom_field1: string
  Title: Product Group
• _part_custom_field10: object Product type
  Title: Product type
• _part_custom_field3: string
  Title: Max discount %
• _part_custom_field4: object Price Period
  Title: Price Period
• _part_custom_field5: number
  Title: Cost
• _part_custom_field8: object Price Type
  Title: Price Type
• _part_custom_field9: string
  Title: product
• comment: string
  Title: Comment

  Comment
• companyAssociations: string
  Title: Company Associations

  Company Associations
• description: string
  Title: Description

  Description
• directBuy: string
  Title: Direct Buy

  Direct Buy
• extendedDescription1: string
  Title: Extended Description 1

  Extended Description 1
• extendedDescription2: string
  Title: Extended Description 2

  Extended Description 2
• id: string
  Title: Part Identifier

  It uniquely idenitfies the part, used for selection of recommended parts.
• leadTime: integer
  Title: Lead Time

  Lead Time
• partDisplayNumber: string
  Title: Part Display Number

  Part Display Number
• partNumber: string
  Title: Part Number

  Part Number
• price: object Price
  Title: Price

  Price
• quantity: integer
  Title: Quantity

  Quantity
• selected: string
  Title: Selection

  It represents selection of the item. Selection can be 'true', 'false' or 'missing'.
• units: string
  Title: Units

  Units

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"It uniquely idenitfies the part, used for selection of recommended parts.",
            "title":"Part Identifier"
        },
        "selected":{
            "type":"string",
            "description":"It represents selection of the item. Selection can be 'true', 'false' or 'missing'.",
            "title":"Selection"
        },
        "_part_custom_field1":{
            "type":"string",
            "description":"",
            "title":"Product Group"
        },
        "_part_custom_field4":{
            "type":"object",
            "description":"",
            "title":"Price Period",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"Value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"Display Value"
                }
            }
        },
        "_part_custom_field8":{
            "type":"object",
            "description":"",
            "title":"Price Type",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"Value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"Display Value"
                }
            }
        },
        "_part_custom_field5":{
            "type":"number",
            "description":"",
            "title":"Cost"
        },
        "_part_custom_field9":{
            "type":"string",
            "description":"",
            "title":"product"
        },
        "_part_custom_field3":{
            "type":"string",
            "description":"",
            "title":"Max discount %"
        },
        "_part_custom_field10":{
            "type":"object",
            "description":"",
            "title":"Product type",
            "properties":{
                "value":{
                    "type":"string",
                    "title":"Value"
                },
                "displayValue":{
                    "type":"string",
                    "title":"Display Value"
                }
            }
        },
        "partNumber":{
            "type":"string",
            "description":"Part Number",
            "title":"Part Number"
        },
        "quantity":{
            "type":"integer",
            "description":"Quantity",
            "title":"Quantity"
        },
        "price":{
            "type":"object",
            "description":"Price",
            "title":"Price",
            "properties":{
                "value":{
                    "type":"string"
                },
                "currency":{
                    "type":"string"
                }
            }
        },
        "description":{
            "type":"string",
            "description":"Description",
            "title":"Description"
        },
        "partDisplayNumber":{
            "type":"string",
            "description":"Part Display Number",
            "title":"Part Display Number"
        },
        "extendedDescription1":{
            "type":"string",
            "description":"Extended Description 1",
            "title":"Extended Description 1"
        },
        "extendedDescription2":{
            "type":"string",
            "description":"Extended Description 2",
            "title":"Extended Description 2"
        },
        "directBuy":{
            "type":"string",
            "description":"Direct Buy",
            "title":"Direct Buy"
        },
        "comment":{
            "type":"string",
            "description":"Comment",
            "title":"Comment"
        },
        "companyAssociations":{
            "type":"string",
            "description":"Company Associations",
            "title":"Company Associations"
        },
        "units":{
            "type":"string",
            "description":"Units",
            "title":"Units"
        },
        "leadTime":{
            "type":"integer",
            "description":"Lead Time",
            "title":"Lead Time"
        }
    }
}

Nested Schema : Product type

Type: object

Title: Product type

Show Source

• displayValue: string
  Title: Display Value
• value: string
  Title: Value

{
    "type":"object",
    "description":"",
    "title":"Product type",
    "properties":{
        "value":{
            "type":"string",
            "title":"Value"
        },
        "displayValue":{
            "type":"string",
            "title":"Display Value"
        }
    }
}

Nested Schema : Price Period

Type: object

Title: Price Period

Show Source

• displayValue: string
  Title: Display Value
• value: string
  Title: Value

{
    "type":"object",
    "description":"",
    "title":"Price Period",
    "properties":{
        "value":{
            "type":"string",
            "title":"Value"
        },
        "displayValue":{
            "type":"string",
            "title":"Display Value"
        }
    }
}

Nested Schema : Price Type

Type: object

Title: Price Type

Show Source

• displayValue: string
  Title: Display Value
• value: string
  Title: Value

{
    "type":"object",
    "description":"",
    "title":"Price Type",
    "properties":{
        "value":{
            "type":"string",
            "title":"Value"
        },
        "displayValue":{
            "type":"string",
            "title":"Display Value"
        }
    }
}

Nested Schema : Price

Type: object

Title: Price

Price

Show Source

• currency: string
• value: string

{
    "type":"object",
    "description":"Price",
    "title":"Price",
    "properties":{
        "value":{
            "type":"string"
        },
        "currency":{
            "type":"string"
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve the mandatory parts of a configuration by submitting a POST request to the REST resource using cURL.

curl -X POST -H "Authorization: Bearer <token>" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/configvarioTablets.tablets.customTablet/_mandatoryParts/actions/getMandatoryParts

Request Body Sample

{
  "cacheInstanceId": "gsg21bMZ5kpGUWxDIZeGWQCLKbaad33Un1X8huVuDm0K3gAKMeXPbzeQcFsFBAzJ"
}
         

Response Body Sample

The following example shows the contents of the response body in JSON format:

{
  "cacheInstanceId": "gsg21bMZ5kpGUWxDIZeGWQCLKbaad33Un1X8huVuDm0K3gAKMeXPbzeQcFsFBAzJ",
  "items": [{
      "leadTime": -1,
      "comment": "System recommended item",
      "price": {
        "value": "25.00",
        "currency": "USD"
      },
      "partNumber": "Tablet-CloudBackupService",
      "description": "",
      "units": "",
      "directBuy": "Direct Buy",
      "quantity": 1,
      "_part_custom_field5": 0,
      "partDisplayNumber": "Tablet-CloudBackupService",
      "companyAssociations": ""
    }, {
      "leadTime": -1,
      "comment": "System recommended item",
      "price": {
        "value": "100.00",
        "currency": "USD"
      },
      "partNumber": "Tablet-Warranty-2yrs",
      "description": "",
      "units": "",
      "directBuy": "Direct Buy",
      "quantity": 1,
      "_part_custom_field5": 0,
      "partDisplayNumber": "Tablet-Warranty-2yrs",
      "companyAssociations": ""
    }, {
      "leadTime": -1,
      "comment": "System recommended item",
      "price": {
        "value": "40.00",
        "currency": "USD"
      },
      "partNumber": "MEM-100M-4",
      "description": "4GB Memory",
      "units": "",
      "directBuy": "Direct Buy",
      "quantity": 1,
      "_part_custom_field8": {
        "value": "One Time",
        "displayValue": "One Time"
      },
      "_part_custom_field5": 20,
      "partDisplayNumber": "4GB Memory",
      "companyAssociations": ""
    }
  ]
}

Back to Top