REST API Services for CPQ Cloud

Get Array Sets Metadata

get

/rest/v7/commerceProcesses/{processVarName}/documents/{docVarName}/arraySets

This service returns the metadata for all array sets defined for the specified Commerce document.

Request

Path Parameters

docVarName: string

Variable Name of the parent document.
processVarName: string

Variable Name of the parent process.

Response

Default Response

Root Schema : CommerceArraySets-collection

Type: object

Show Source

items(optional): array items

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

Nested Schema : items

Type: array

Show Source

Array of: object CommerceArraySets

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

Nested Schema : CommerceArraySets

Type: object

Show Source

dateModified(optional): string

Title: Date Last Modified

System field indicating the date on which the object was last modified.
description(optional): string

Title: Description

Description
id(optional): integer

Title: Id

Primary Key of Commerce Attributes.
label(optional): string

Title: Display Name

Attribute Name
links(optional): object arraySetLinks
type(optional): object lookup
variableName(optional): string

Title: Variable Name

Variable Name

{
    "properties":{
        "id":{
            "title":"Id",
            "description":"Primary Key of Commerce Attributes.",
            "type":"integer"
        },
        "dateModified":{
            "title":"Date Last Modified",
            "description":"System field indicating the date on which the object was last modified.",
            "type":"string"
        },
        "links":{
            "$ref":"#/definitions/arraySetLinks"
        },
        "label":{
            "title":"Display Name",
            "description":"Attribute Name",
            "type":"string"
        },
        "description":{
            "title":"Description",
            "description":"Description",
            "type":"string"
        },
        "variableName":{
            "title":"Variable Name",
            "description":"Variable Name",
            "type":"string"
        },
        "type":{
            "$ref":"#/definitions/lookup"
        }
    }
}

Nested Schema : arraySetLinks

Type: object

Show Source

parent(optional): string

Links to parent Commerce process document, array set translations, and array set attributes.

{
    "properties":{
        "parent":{
            "description":"Links to parent Commerce process document, array set translations, and array set attributes.",
            "type":"string"
        }
    }
}

Nested Schema : lookup

Type: object

Show Source

displayValue(optional): string

Title: Display Value

Translated display name of the type for which fixed list of values can be defined.
lookupCode(optional): string

Title: Lookup Code

Language independent code of the fixed list of value.

{
    "properties":{
        "lookupCode":{
            "title":"Lookup Code",
            "description":"Language independent code of the fixed list of value.",
            "type":"string"
        },
        "displayValue":{
            "title":"Display Value",
            "description":"Translated display name of the type for which fixed list of values can be defined.",
            "type":"string"
        }
    }
}

Examples

The following example shows how to retrieve metadata for all array sets defined for the specified Commerce document 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"
https://sitename.oracle.com/rest/v7/commerceProcesses/oraclecpqo/documents/transaction/arraySets

Response Body Sample

{
  "items": [{
      "id": 36642830,
      "dateModified": "2019-02-01",
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v7/commerceProcesses/oraclecpqo/documents/transaction"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v7/commerceProcesses/oraclecpqo/documents/transaction/arraySets/financeOptions"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v7/commerceProcesses/oraclecpqo/documents/transaction/arraySets/financeOptions/translations"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v7/commerceProcesses/oraclecpqo/documents/transaction/arraySets/financeOptions/attributes"
        }
      ],
      "label": "Finance Options",
      "description": "",
      "variableName": "financeOptions",
      "type": {
        "lookupCode": "CmArrayAttrSet",
        "displayValue": "Array Set"
      }
    }, {
      "id": 36641143,
      "dateModified": "2019-01-28",
      "links": [{
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v7/commerceProcesses/oraclecpqo/documents/transaction"
        }, {
          "rel": "self",
          "href": "https://sitename.oracle.com/rest/v7/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v7/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices/translations"
        }, {
          "rel": "child",
          "href": "https://sitename.oracle.com/rest/v7/commerceProcesses/oraclecpqo/documents/transaction/arraySets/laborServices/attributes"
        }
      ],
      "label": "Labor Services",
      "description": "",
      "variableName": "laborServices",
      "type": {
        "lookupCode": "CmArrayAttrSet",
        "displayValue": "Array Set"
      }
    }
  ],
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v7/commerceProcesses/oraclecpqo/documents/transaction/arraySets"
    }
  ]
}