REST API Services for Oracle CPQ

Update a Commerce Integration

patch

/rest/v19/commerceProcessSetups/{processVarName}/integrations/{integrationVarName}

Use this endpoint to update the specified Commerce Process integration.

Request

Supported Media Types

multipart/form-data

Path Parameters

integrationVarName(required): string
processVarName(required): string

Response

Supported Media Types

application/json

204 Response

Success

Examples

Allowed Request Fields for Integration Types

BML: id, variableName, name, description, type, runType, ruleMetaId
Contact Management: id, variableName, name, description, type, timeout, preview, partnerAttachmentField, resultFile, queryFile
Integration Cloud Service: variableName, name, description, type, timeout, endpoint
REST Export: id, variableName, name, description, type, timeout, endpoint , partnerIdField, metadataURL, headers, childEntity
REST Export Lines: id, variableName, name, description, type, timeout, endpoint , partnerIdField, metadataURL, headers, childEntity, batchSize
REST Import: id, variableName, name, description, type, timeout, endpoint , partnerIdField, metadataURL, headers, childEntity, batchSize, queryParams.value, queryParams.key
SOAP Export: id, variableName, name, description, type, timeout, endpoint, partnerIdField, documentSelection, resultFile, queryFile
SOAP Import: id, variableName, name, description, type, timeout, endpoint, partnerIdField, resultFile, queryFile

The following example shows how to update the specified Commerce Process integration by submitting a PATCH request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X PATCH -H "Authorization: Bearer <token>" -H "Accept: application/json"
https://sitename.oracle.com/rest/v19/https://sitename.oracle.com/rest/v19/commerceProcessSetups/oraclecpqo/integrations/test

Request Body Samples

SOAP Import Sample

payload: // JSON as text
{
  "variableName": "test",
  "name": "testVar3",
  "description": "ics descpr",
  "type": "SOAP_IMPORT",
  "timeout": 100,
  "endpoint": "sitename.oracle.com",
  "partnerIdField": "a.b",
  "metadataURL": "123",
  "documentSelection": "MAIN_DOCUMENT"
},
resultFile: "test.xsl", // File expected
queryFile: "test2.xsl" // File expected

REST Export Sample

payload: {
  "id": -1,
  "variableName": "test",
  "name": "testVar1_c",
  "description": "ics desc",
  "type": "REST_EXPORT",
  "timeout": 100,
  "documentSelection": "MAIN_DOCUMENT",
  "batchSize": 1,
  "runType": "GENERIC",
  "endpoint": "sitename.oracle.com",
  "partnerIdField": "a.b",
  "metadataURL": "123",
  "promptName": "khabce",
  "queryParams": [{
      "key": "a",
      "value": "b"
    }, {
      "key": "c",
      "value": "d"
    }
  ]
}