REST API Services for Oracle CPQ

Get List of Model Catalog Definitions

get

/rest/v19/allProductFamilySetups/{allProdFamsVarName}/productFamilies/{prodFamVarName}/productLines/{prodLineVarName}/models

Use this endpoint to retrieve a list of catalog definitions for Models.

Request

Supported Media Types

application/json

Path Parameters

allProdFamsVarName(required): string

Variable Name of All Product Families '_allProductFamilies'
prodFamVarName(required): string

Variable Name of the Product Family.
prodLineVarName(required): string

Variable Name of the Product Line

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 : modelSetups-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/modelSetups"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

Array of: object Models

Title: Models

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

Nested Schema : Models

Type: object

Title: Models

Show Source

companyId: integer

Title: Company Id

Id Of Company
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.
description: string

Title: Description

Description of the Product Line
id: integer

Title: Id

Primary Key Of The Resource
label: string

Title: Model Name

Name of the Model
parentId: integer

Title: Parent Id

Id of immediate parent
variableName: string

Title: Variable Name

Variable Name of the Product Line

{
    "type":"object",
    "properties":{
        "companyId":{
            "type":"integer",
            "description":"Id Of Company",
            "title":"Company Id"
        },
        "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"
        },
        "description":{
            "type":"string",
            "description":"Description of the Product Line",
            "title":"Description"
        },
        "id":{
            "type":"integer",
            "description":"Primary Key Of The Resource",
            "title":"Id"
        },
        "label":{
            "type":"string",
            "description":"Name of the Model",
            "title":"Model Name"
        },
        "parentId":{
            "type":"integer",
            "description":"Id of immediate parent",
            "title":"Parent Id"
        },
        "variableName":{
            "type":"string",
            "description":"Variable Name of the Product Line",
            "title":"Variable Name"
        }
    },
    "title":"Models"
}

Examples

The following example shows how to retrieve a list of catalog definitions for Models 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 "Accept: application/json"
https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices/models

Response Body Sample

{
  "hasMore": false,
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices/models"
    }
  ],
  "items": [{
      "companyId": 4118171,
      "variableName": "mobility",
      "description": "<img src=\"$BASE_PATH$/images/Mobility.png \" alt=\"Mobility\" /></br>\nSelect the Mobile Services that are right for you",
      "dateModified": "2020-05-04T16:32:27.000Z",
      "id": 36732594,
      "label": "Unity Mobility",
      "dateAdded": "2018-11-09T17:31:43.000Z",
      "parentId": 36732586,
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices/models/mobility"
        }, {
          "kind": "",
          "rel": "child",
          "name": "attributes",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices/models/mobility/attributes"
        }, {
          "kind": "",
          "rel": "child",
          "name": "bomMappingRules",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices/models/mobility/bomMappingRules"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices"
        }
      ]
    }, {
      "companyId": 4118171,
      "variableName": "home",
      "description": "<img src=\"$BASE_PATH$/images/Home_Security.png \" alt=\"Home\" /></br>\nSmart Home offerings to keep your family secure",
      "dateModified": "2020-05-04T16:32:27.000Z",
      "id": 38073910,
      "label": "Unity Home",
      "dateAdded": "2019-07-30T12:42:41.000Z",
      "parentId": 36732586,
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices/models/home"
        }, {
          "kind": "",
          "rel": "child",
          "name": "attributes",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices/models/home/attributes"
        }, {
          "kind": "",
          "rel": "child",
          "name": "bomMappingRules",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices/models/home/bomMappingRules"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices"
        }
      ]
    }, {
      "companyId": 4118171,
      "variableName": "entertainment",
      "description": "<img src=\"$BASE_PATH$/images/Entertainment.png \" alt=\"Entertainment\" /></br>\nMovies, Streaming Services, Television, Games and More",
      "dateModified": "2020-05-04T16:32:27.000Z",
      "id": 38073911,
      "label": "Unity Entertainment",
      "dateAdded": "2019-07-30T12:42:41.000Z",
      "parentId": 36732586,
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices/models/entertainment"
        }, {
          "kind": "",
          "rel": "child",
          "name": "attributes",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices/models/entertainment/attributes"
        }, {
          "kind": "",
          "rel": "child",
          "name": "bomMappingRules",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices/models/entertainment/bomMappingRules"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices"
        }
      ]
    }, {
      "companyId": 4118171,
      "variableName": "internet",
      "description": "<img src=\"$BASE_PATH$/images/Internet.png \" alt=\"Internet\" /></br>\nStay connected with unbelievable download speeds",
      "dateModified": "2020-05-04T16:32:27.000Z",
      "id": 38073912,
      "label": "Unity Internet",
      "dateAdded": "2019-07-30T12:42:41.000Z",
      "parentId": 36732586,
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices/models/internet"
        }, {
          "kind": "",
          "rel": "child",
          "name": "attributes",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices/models/internet/attributes"
        }, {
          "kind": "",
          "rel": "child",
          "name": "bomMappingRules",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices/models/internet/bomMappingRules"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines/standAloneServices"
        }
      ]
    }
  ]
}