REST API Services for Oracle CPQ

Get Product Family Setups

get

/rest/v19/allProductFamilySetups/{allProdFamsVarName}/productFamilies

Use this endpoint to retrieve Product Family setups.

Request

Supported Media Types

application/json

Path Parameters

allProdFamsVarName(required): string

Variable Name

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

Nested Schema : items

Type: array

Show Source

Array of: object Product Family

Title: Product Family

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

Nested Schema : Product Family

Type: object

Title: Product Family

Show Source

activeLayoutType: string

Title: Active Layout Type

Current Active Layout Type
companyId: integer

Title: Company Id

Company Id
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
label: string

Title: Label

Product Family Label
lastDeployedDate: string

Title: Last Deployed Date

The date of the last successful product family deployment.
name: string

Title: Name

Product Family Name
segmentId: integer

Title: Segment Id

Segment Id
variableName: string

Title: Variable Name

Variable Name

{
    "type":"object",
    "properties":{
        "activeLayoutType":{
            "type":"string",
            "description":"Current Active Layout Type",
            "title":"Active Layout Type"
        },
        "companyId":{
            "type":"integer",
            "description":"Company Id",
            "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"
        },
        "id":{
            "type":"integer",
            "description":"Identifier for the resource",
            "title":"Id"
        },
        "label":{
            "type":"string",
            "description":"Product Family Label",
            "title":"Label"
        },
        "lastDeployedDate":{
            "type":"string",
            "description":"The date of the last successful product family deployment.",
            "title":"Last Deployed Date"
        },
        "name":{
            "type":"string",
            "description":"Product Family Name",
            "title":"Name"
        },
        "segmentId":{
            "type":"integer",
            "description":"Segment Id",
            "title":"Segment Id"
        },
        "variableName":{
            "type":"string",
            "description":"Variable Name",
            "title":"Variable Name"
        }
    },
    "title":"Product Family"
}

Examples

The following example shows how to retrieve a list of catalog definitions for Product Families 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

Response Body Sample

{
  "hasMore": false,
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies"
    }
  ],
  "items": [{
      "companyId": 4118171,
      "variableName": "unityINC",
      "segmentId": 13,
      "name": "Unity INC",
      "dateModified": "2021-02-03T17:40:33Z",
      "id": 36732579,
      "dateAdded": "2018-11-09T17:24:51Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC"
        }, {
          "kind": "",
          "rel": "child",
          "name": "attributes",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/attributes"
        }, {
          "kind": "",
          "rel": "child",
          "name": "productLines",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/unityINC/productLines"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies"
        }
      ]
    }, {
      "companyId": 4118171,
      "variableName": "varioTablets",
      "segmentId": 10,
      "name": "Vario Tablets",
      "dateModified": "2021-02-03T17:40:33Z",
      "id": 36592821,
      "dateAdded": "2017-11-09T13:47:13Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/varioTablets"
        }, {
          "kind": "",
          "rel": "child",
          "name": "attributes",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/varioTablets/attributes"
        }, {
          "kind": "",
          "rel": "child",
          "name": "productLines",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/varioTablets/productLines"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies"
        }
      ]
    }, {
      "companyId": 4118171,
      "variableName": "visionServices",
      "segmentId": 11,
      "name": "Vision Services",
      "dateModified": "2021-02-03T17:40:33Z",
      "id": 36592830,
      "dateAdded": "2017-11-09T13:47:21Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/visionServices"
        }, {
          "kind": "",
          "rel": "child",
          "name": "attributes",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/visionServices/attributes"
        }, {
          "kind": "",
          "rel": "child",
          "name": "productLines",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/visionServices/productLines"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies"
        }
      ]
    }, {
      "companyId": 4118171,
      "variableName": "visionVehicles",
      "segmentId": 29,
      "name": "Vision Vehicles",
      "dateModified": "2021-09-17T12:29:43Z",
      "id": 38644483,
      "dateAdded": "2021-09-17T12:28:09Z",
      "links": [{
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/visionVehicles"
        }, {
          "kind": "",
          "rel": "child",
          "name": "attributes",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/visionVehicles/attributes"
        }, {
          "kind": "",
          "rel": "child",
          "name": "productLines",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies/productFamilies/visionVehicles/productLines"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v19/allProductFamilySetups/_allProductFamilies"
        }
      ]
    }
  ]
}