Create a Commence Proccess Integration
post
/rest/v19/commerceProcessSetups/{processVarName}/integrations
Use this endpoint to create an integration for the specified Commerce Process.
Request
Supported Media Types
- multipart/form-data
Path Parameters
Back to Top
Response
Supported Media Types
- application/json
201 Response
Success
Root Schema : AdminIntegrationRequestModel
Type:
Show Source
object-
batchSize:
integer()
Title:
Batch SizeQuote lines to be integrated in a single invocation for the Integration -
childEntity:
string()
Title:
Child EntityName of the child resource from metadata for mapping attributes. -
description:
string()
Title:
DescriptionDescription of the Integration -
documentSelection:
integer()
Title:
Document SelectionDocument Selection of the Integration -
documentSelectionEnum:
string
Allowed Values:
[ "MAIN_DOCUMENT", "SUB_DOCUMENT" ] -
endpoint:
string()
Title:
EndpointICS Endpoint for the Integration. -
enumType:
string
Allowed Values:
[ "SOAP_EXPORT", "SOAP_IMPORT", "MIDDLEWARE_IMPORT", "MIDDLEWARE_EXPORT", "CONTRACT_MANAGEMENT", "BML", "REST_EXPORT_LINES", "REST_EXPORT", "REST_IMPORT" ] -
filterField:
string()
Title:
Filter FieldFilter Field used for the Integration if Custom Line Type Filter is selected -
headers:
string()
Title:
HeadersThis field takes the headers to be passed in the request to the integration endpoint -
id:
integer()
Title:
IdId of the Integration item -
instanceTypeEnum:
string
Allowed Values:
[ "GENERIC", "DYNAMICS" ] -
integrationVendorVarName:
string()
Title:
Integration Vendor Variable NameIntegration Vendor Variable Name of the Integration -
isPreview:
boolean()
Title:
Preview ContractIndicates whether preview contract is enabled for the Integration -
lineSelectionEnum:
string
Allowed Values:
[ "ROOT_LINES", "PART_LINES", "ALL_LINES", "CUSTOM" ] -
lineTypeFilter:
integer()
Title:
Line Type FilterLine Type Filter of the Integration -
metadataURL:
string()
Title:
Metadata URLThe endpoint to retrieve the metadata about CRM attributes available for mapping for this integration. -
name:
string()
Title:
NameName of the Integration -
partnerAttachmentField:
string()
Title:
Partner Attachment FieldPartner Attachment Field of the Integration -
partnerIdField:
string()
Title:
Id FieldThis field indicates which Commerce attribute stores the external ID of the object being updated by the integration -
processId:
integer(int64)
-
processVarName:
string()
Title:
Process Variable NameProcess Variable Name of the Integration -
promptName:
string()
Title:
Prompt NamePrompt Name used for Quote Summary Integration -
queryParams:
array Query Params
Title:
Query ParamsThis field takes the query params to be passed in the request to the above integration endpoint. -
ruleMetaId:
integer()
Title:
Rule Meta IdRule Meta Id of BML function used for the Integration -
runType:
integer()
Title:
Instance TypeSpecifies when the BML function is run -
serviceName:
string()
Title:
Service NameService Name of the Integration -
serviceVarName:
string()
Title:
Service Variable NameService Variable Name of the Integration -
timeout:
integer()
Title:
TimeoutTimeout of the Integration -
type:
integer()
Title:
TypeType of the Integration -
variableName:
string()
Title:
Variable NameVariable Name of the Integration
Nested Schema : Query Params
Type:
arrayTitle:
Query ParamsThis field takes the query params to be passed in the request to the above integration endpoint.
Show Source
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, lineTypeFilter, filterField
- REST Import: id, variableName, name, description, type, timeout, endpoint , partnerIdField, metadataURL, headers, childEntity, batchSize, queryParams.value, queryParams.key, documentSelection
- SOAP Export: id, variableName, name, description, type, timeout, endpoint, partnerIdField, resultFile, queryFile
- SOAP Import: id, variableName, name, description, type, timeout, endpoint, partnerIdField, resultFile, queryFile
The following example shows how to create an integration for the specified Commerce Process by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl - X PATCH -H "Authorization: Bearer <token>" - H "Content-type: application/json" https://sitename.oracle.com/rest/v19/commerceProcessSetups/oraclecpqo/integrations
Request Body Samples
SOAP Import Sample
payload: // JSON as text
{
"variableName": "testVar6_c",
"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": "testVar2_c",
"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"
}
]
}
Response Body Sample
{
"id": 3023626061
}