REST API Services for Oracle CPQ

Get Commerce Integration Types

get

/rest/v19/commerceProcessSetups/integrationTypes

Use this endpoint to retrieve Commerce Integration types.

Request

There are no request parameters for this operation.

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : AdminCollectionResponseModel_AdminIntegrationTypesModel

Type: object

Show Source

items: array items

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

Nested Schema : items

Type: array

Show Source

Array of: object AdminIntegrationTypesModel

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

Nested Schema : AdminIntegrationTypesModel

Type: object

Show Source

displayLabel: string()

Title: Display label

Language Translated display label for the type
enabled: boolean()

Title: Enabled

Indicates whether type is enabled or not
label: string()

Title: Label

Label for the type
type: string()

Title: Type

Variable name or key value of the Type

{
    "properties":{
        "label":{
            "type":"string",
            "format":"",
            "description":"Label for the type",
            "title":"Label"
        },
        "displayLabel":{
            "type":"string",
            "format":"",
            "description":"Language Translated display label for the type",
            "title":"Display label"
        },
        "type":{
            "type":"string",
            "format":"",
            "description":"Variable name or key value of the Type",
            "title":"Type"
        },
        "enabled":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether type is enabled or not",
            "title":"Enabled"
        }
    }
}

Examples

The following example shows how to retrieve integration types for the specified Commerce Process 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/commerceProcessSetups/oraclecpqo/integrationTypes

Response Body Sample

{
  "items":
  [{
      "label": "Integration Cloud Service",
      "displayLabel": "Integration Cloud Service",
      "type": "MIDDLEWARE_IMPORT",
      "enabled": true
    }, {
      "name": "BML",
      "displayLabel": "[BML]",
      "type": "BML",
      "enabled": true
    }
  ]
}