REST API Services for Oracle CPQ

Get Part Extended Descriptions

get

/rest/v19/partSetups/{id}/extendedDescriptions

Use this endpoint to retrieve extended descriptions for the specified CPQ part.

Request

Supported Media Types

application/json

Path Parameters

id(required): integer

The unique identifier for the part.

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.

Response

Supported Media Types

application/json

Default Response

Root Schema : partSetupExtendedDescriptions-collection

Type: object

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/partSetupExtendedDescriptions"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object Part Extended Descriptions

Title: Part Extended Descriptions

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

Nested Schema : Part Extended Descriptions

Type: object

Title: Part Extended Descriptions

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

Identifier for the resource
partExtendedDescription1: string

Title: Extended Description 1

Part extended description 1
partExtendedDescription2: string

Title: Extended Description 2

Part extended description 2

{
    "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":"Identifier for the resource",
            "title":"Id"
        },
        "partExtendedDescription1":{
            "type":"string",
            "description":"Part extended description 1",
            "title":"Extended Description 1"
        },
        "partExtendedDescription2":{
            "type":"string",
            "description":"Part extended description 2",
            "title":"Extended Description 2"
        }
    },
    "title":"Part Extended Descriptions"
}

Examples

The following example shows how to extended descriptions for a CPQ part by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X GET -H "Authorization: Bearer <token>" - H "Content-type: application/json"
http://sitename.oracle.com/rest/v19/partSetups/38644116/extendedDescriptions

Response Body

{
  "hasMore": false,
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/partSetups/38644116/extendedDescriptions"
    }
  ],
  "items": [{
      "partExtendedDescription1": "<h2>Coverage Includes</h2>Premium Maintenance covers routine inspections, preventive care and replacement of normal \"wear and tear\" items that require periodic attention. Your actual plan will be based on your vehicle’s maintenance needs as indicated in your Owner's Scheduled Maintenance Guide:<br /><ul><li>Engine oil and filter changes</li><li>Multi-point inspections</li><li>Tire rotations</li><li>Brake pads and linings</li><li>Shock absorbers/struts</li><li>Spark plugs</li><li>Clutch discs</li><li>Engine belts</li><li>Engine coolant hoses, clamps and o-ring seals</li><li>Wiper blades</li><li>Diesel exhaust fluid fill at the time scheduled maintenance is performed at dealership</li></ul>",
      "dateModified": "2023-03-02T20:47:12.000Z",
      "id": 38653270,
      "partExtendedDescription2": "<h2>Multi-Point Inspection</h2><p>At each service interval, your vehicle undergoes a comprehensive multi-point inspection as indicated in your Owner’s Scheduled Maintenance Guide:</p><h3>Check Following Systems/Components:</h3><ul><li>Operation of horn, interior lights, exterior lamps, turn signals, and hazard and brake lights</li><li>Windshield washer spray, wiper operation and wiper blades</li><li>Windshield for cracks, chips and pitting</li><li>Radiator, heater and air conditioning lines for leaks and damage</li><li>Engine air filter</li><li>Oil and fluid leaks</li><li>Exhaust system (leaks, damage, loose parts)</li><li>Steering and steering linkages</li><li>Shocks/struts and other suspension components for leaks and/or damage</li><li>Accessory drive belt(s)</li><li>Clutch operation (if equipped)</li><li>Tires for wear and proper air pressure</li></ul><h3>Check Fluid Levels and Fill:</h3><ul><li>Transmission (if equipped with a dipstick)</li><li>Brake reservoir</li><li>Power steering</li><li>Coolant recovery reservoir</li><li>Window washer</li><li>Diesel exhaust fluid (if necessary)</li></ul>",
      "dateAdded": "2021-09-22T09:01:06.000Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/partSetups/38644116/extendedDescriptions/38653270"
        }, {
          "kind": "",
          "rel": "child",
          "name": "translations",
          "href": "https://sitename.oracle.com/rest/v19/partSetups/38644116/extendedDescriptions/38653270/translations"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v19/partSetups/38644116"
        }
      ]
    }
  ]
}