Jump to

• Request
• Response
• Examples

Get All Prices for Part

get

/rest/v16/partSetups/{id}/prices

Use this endpoint to retrieve all prices for the specified CPQ part.

Request

Supported Media Types

• application/json

Path Parameters

• id(required): integer
  The unique identifier for the part.

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 : Part Price Collection Definitions

Type: object

Title: Part Price 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/partSetupPrices"
            }
        }
    },
    "title":"Part Price Collection Definitions"
}

Nested Schema : items

Type: array

Show Source

• Array of: object Part Price Setup Children Instance Definitions
  Title: Part Price Setup Children Instance Definitions

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

Nested Schema : Part Price Setup Children Instance Definitions

Type: object

Title: Part Price Setup Children Instance Definitions

Show Source

• 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.
• id: integer
  Title: Id

  Primary Key of the Resource
• price: object Price
  Title: Price

  Price of the part.

{
    "type":"object",
    "properties":{
        "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"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key of the Resource",
            "title":"Id"
        },
        "price":{
            "type":"object",
            "description":"Price of the part.",
            "title":"Price",
            "properties":{
                "value":{
                    "type":"number",
                    "title":"value"
                },
                "currency":{
                    "type":"string",
                    "title":"currency"
                }
            }
        }
    },
    "title":"Part Price Setup Children Instance Definitions"
}

Nested Schema : Price

Type: object

Title: Price

Price of the part.

Show Source

• currency: string
  Title: currency
• value: number
  Title: value

{
    "type":"object",
    "description":"Price of the part.",
    "title":"Price",
    "properties":{
        "value":{
            "type":"number",
            "title":"value"
        },
        "currency":{
            "type":"string",
            "title":"currency"
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve all prices for the specified CPQ 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"
http://sitename.oracle.com/rest/v16/partSetups/38644116/prices

Response Body

{
  "hasMore": false,
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/partSetups/38644116/prices"
    }
  ],
  "items": [{
      "price": {
        "value": 125.0,
        "currency": "USD"
      },
      "dateModified": "2023-03-07T18:21:22.000Z",
      "id": 38852302,
      "dateAdded": "2023-03-07T18:21:22.000Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/partSetups/38644116/prices/38852302"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/partSetups/38644116"
        }
      ]
    }, {
      "price": {
        "value": 11800.0,
        "currency": "EUR"
      },
      "dateModified": "2023-03-07T18:21:22.000Z",
      "id": 38852300,
      "dateAdded": "2023-03-07T18:21:22.000Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/partSetups/38644116/prices/38852300"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/partSetups/38644116"
        }
      ]
    }, {
      "price": {
        "value": 105.0,
        "currency": "GBP"
      },
      "dateModified": "2023-03-07T18:21:22.000Z",
      "id": 38852301,
      "dateAdded": "2023-03-07T18:21:22.000Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v16/partSetups/38644116/prices/38852301"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/partSetups/38644116"
        }
      ]
    }
  ]
}

Back to Top