Jump to

• Request
• Response
• Examples

Get Price Books

post

/rest/v16/config{prodFamVarName}.{prodLineVarName}.{modelVarName}/_priceBooks/actions/getPriceBooks

This action provides the list of values for the Price Books within the configuration.

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 : getPriceBooksRequest

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 : getPriceBooksResponse

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":{
                "type":"object",
                "properties":{
                    "value":{
                        "type":"string",
                        "title":"Value"
                    },
                    "displayValue":{
                        "type":"string",
                        "title":"Display Value"
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "value":{
                "type":"string",
                "title":"Value"
            },
            "displayValue":{
                "type":"string",
                "title":"Display Value"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

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

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

Back to Top

Examples

The following example provides a list of values for the Price Books within the configuration by submitting a POST request to the REST resource using cURL.

curl -X POST -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Accept: application/json"
https://sitename.oracle.com/rest/v16/configvarioTablets.tablets.customTablet/_priceBooks/actions/getPriceBooks

Request Body Sample

{
  "cacheInstanceId": "Hkcv12PiEEKTTl5aGmivM08Scumv12KFhDO7CHJQASzCLNnWisp4SEyXz0vfgKI62P"
}
         

Response Body Sample

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

{
  "cacheInstanceId": "Hkcv12PiEEKTTl5aGmivM08Scumv12KFhDO7CHJQASzCLNnWisp4SEyXz0vfgKI62P",
  "items": [{
      "value": "_default_price_book",
      "displayValue": "Base Price"
    }, {
      "value": "pricebook1",
      "displayValue": "Pricebook 1: Multiplier of Base Price (2.0x)"
    }, {
      "value": "pricebook2",
      "displayValue": "Pricebook 2: Multiplier of Base Price (0.5x)"
    }, {
      "value": "pricebook3",
      "displayValue": "Pricebook 3: Custom, All Currencies"
    }, {
      "value": "pricebook4",
      "displayValue": "Pricebook 4: Custom, Exchange Rates"
    }, {
      "value": "pricebook5",
      "displayValue": "Pricebook 5: Multiplier of Pricebook 3 (10.0x)"
    }
  ],
  "links": [{
      "rel": "related",
      "href": "https://sitename.oracle.com/rest/v16/configvarioTablets.tablets.customTablet/_priceBooks"
    }
  ]
}

Back to Top