Jump to

• Request
• Response
• Examples

Create a Commerce Integration

post

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

Use this endpoint to create a commerce integration for the specified process.

Request

Supported Media Types

• multipart/form-data

Path Parameters

• processVarName(required): string

Form Parameters

• payload: string
  payload as JSON String .Ref:AdminIntegrationRequestModel
• queryFile: file
  Query file as Xsl
• resultFile: file
  Result file as Xsl

Back to Top

Response

Supported Media Types

• application/json

201 Response

Success

Body ()

Root Schema : AdminIntegrationRequestModel

Type: object

Show Source

• batchSize: integer()
  Title: Batch Size

  Quote lines to be integrated in a single invocation for the Integration
• childEntity: string()
  Title: Child Entity

  Name of the child resource from metadata for mapping attributes.
• description: string()
  Title: Description

  Description of the Integration
• documentSelection: integer()
  Title: Document Selection

  Document Selection of the Integration
• documentSelectionEnum: string
  Allowed Values: [ "MAIN_DOCUMENT", "SUB_DOCUMENT" ]
• endpoint: string()
  Title: Endpoint

  ICS Endpoint for the Integration.
• enumType: string
  Allowed Values: [ "SOAP_EXPORT", "SOAP_IMPORT", "MIDDLEWARE_IMPORT", "MIDDLEWARE_EXPORT", "SOAP_QUERY", "DELETE", "EXPORT_ATTACHMENT", "CONTRACT_MANAGEMENT", "BML", "REST_EXPORT_LINES", "REST_EXPORT", "REST_IMPORT" ]
• filterField: string()
  Title: Filter Field

  Filter Field used for the Integration if Custom Line Type Filter is selected
• headers: string()
  Title: Headers

  This field takes the headers to be passed in the request to the integration endpoint
• id: integer()
  Title: Id

  Id of the Integration item
• instanceTypeEnum: string
  Allowed Values: [ "NO_ACTION", "GENERIC", "DYNAMICS" ]
• integrationVendorVarName: string()
  Title: Integration Vendor Variable Name

  Integration Vendor Variable Name of the Integration
• isPreview: boolean()
  Title: Preview Contract

  Indicates whether preview contract is enabled for the Integration
• lineSelectionEnum: string
  Allowed Values: [ "ROOT_LINES", "PART_LINES", "ALL_LINES", "CUSTOM" ]
• lineTypeFilter: integer()
  Title: Line Type Filter

  Line Type Filter of the Integration
• metadataURL: string()
  Title: Metadata URL

  The endpoint to retrieve the metadata about CRM attributes available for mapping for this integration.
• name: string()
  Title: Name

  Name of the Integration
• partnerAttachmentField: string()
  Title: Partner Attachment Field

  Partner Attachment Field of the Integration
• partnerIdField: string()
  Title: Id Field

  This 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 Name

  Process Variable Name of the Integration
• queryParams: array Query Params
  Title: Query Params

  This field takes the query params to be passed in the request to the above integration endpoint.
• ruleMetaId: integer()
  Title: Rule Meta Id

  Rule Meta Id of BML function used for the Integration
• runType: integer()
  Title: Instance Type

  Specifies when the BML function is run
• serviceName: string()
  Title: Service Name

  Service Name of the Integration
• serviceVarName: string()
  Title: Service Variable Name

  Service Variable Name of the Integration
• timeout: integer()
  Title: Timeout

  Timeout of the Integration
• type: integer()
  Title: Type

  Type of the Integration
• variableName: string()
  Title: Variable Name

  Variable Name of the Integration

{
    "properties":{
        "id":{
            "type":"integer",
            "format":"",
            "description":"Id of the Integration item",
            "title":"Id"
        },
        "processId":{
            "type":"integer",
            "format":"int64"
        },
        "processVarName":{
            "type":"string",
            "format":"",
            "description":"Process Variable Name of the Integration",
            "title":"Process Variable Name"
        },
        "variableName":{
            "type":"string",
            "format":"",
            "description":"Variable Name of the Integration",
            "title":"Variable Name"
        },
        "name":{
            "type":"string",
            "format":"",
            "description":"Name of the Integration",
            "title":"Name"
        },
        "description":{
            "type":"string",
            "format":"",
            "description":"Description of the Integration",
            "title":"Description"
        },
        "type":{
            "type":"integer",
            "format":"",
            "description":"Type of the Integration",
            "title":"Type"
        },
        "partnerIdField":{
            "type":"string",
            "format":"",
            "description":"This field indicates which Commerce attribute stores the external ID of the object being updated by the integration",
            "title":"Id Field"
        },
        "endpoint":{
            "type":"string",
            "format":"",
            "description":"ICS Endpoint for the Integration.",
            "title":"Endpoint"
        },
        "serviceName":{
            "type":"string",
            "format":"",
            "description":"Service Name of the Integration",
            "title":"Service Name"
        },
        "serviceVarName":{
            "type":"string",
            "format":"",
            "description":"Service Variable Name of the Integration",
            "title":"Service Variable Name"
        },
        "integrationVendorVarName":{
            "type":"string",
            "format":"",
            "description":"Integration Vendor Variable Name of the Integration",
            "title":"Integration Vendor Variable Name"
        },
        "ruleMetaId":{
            "type":"integer",
            "format":"",
            "description":"Rule Meta Id of BML function used for the Integration",
            "title":"Rule Meta Id"
        },
        "timeout":{
            "type":"integer",
            "format":"",
            "description":"Timeout of the Integration",
            "title":"Timeout"
        },
        "isPreview":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether preview contract is enabled for the Integration",
            "title":"Preview Contract"
        },
        "partnerAttachmentField":{
            "type":"string",
            "format":"",
            "description":"Partner Attachment Field of the Integration",
            "title":"Partner Attachment Field"
        },
        "batchSize":{
            "type":"integer",
            "format":"",
            "description":"Quote lines to be integrated in a single invocation for the Integration",
            "title":"Batch Size"
        },
        "documentSelection":{
            "type":"integer",
            "format":"",
            "description":"Document Selection of the Integration",
            "title":"Document Selection"
        },
        "childEntity":{
            "type":"string",
            "format":"",
            "description":"Name of the child resource from metadata for mapping attributes.",
            "title":"Child Entity"
        },
        "metadataURL":{
            "type":"string",
            "format":"",
            "description":"The endpoint to retrieve the metadata about CRM attributes available for mapping for this integration.",
            "title":"Metadata URL"
        },
        "filterField":{
            "type":"string",
            "format":"",
            "description":"Filter Field used for the Integration if Custom Line Type Filter is selected",
            "title":"Filter Field"
        },
        "headers":{
            "type":"string",
            "format":"",
            "description":"This field takes the headers to be passed in the request to the integration endpoint",
            "title":"Headers"
        },
        "queryParams":{
            "type":"array",
            "format":"",
            "description":"This field takes the query params to be passed in the request to the above integration endpoint.",
            "title":"Query Params",
            "items":{
                "$ref":"#/definitions/KeyValueRequestModel"
            }
        },
        "instanceTypeEnum":{
            "type":"string",
            "enum":[
                "NO_ACTION",
                "GENERIC",
                "DYNAMICS"
            ]
        },
        "documentSelectionEnum":{
            "type":"string",
            "enum":[
                "MAIN_DOCUMENT",
                "SUB_DOCUMENT"
            ]
        },
        "lineSelectionEnum":{
            "type":"string",
            "enum":[
                "ROOT_LINES",
                "PART_LINES",
                "ALL_LINES",
                "CUSTOM"
            ]
        },
        "enumType":{
            "type":"string",
            "enum":[
                "SOAP_EXPORT",
                "SOAP_IMPORT",
                "MIDDLEWARE_IMPORT",
                "MIDDLEWARE_EXPORT",
                "SOAP_QUERY",
                "DELETE",
                "EXPORT_ATTACHMENT",
                "CONTRACT_MANAGEMENT",
                "BML",
                "REST_EXPORT_LINES",
                "REST_EXPORT",
                "REST_IMPORT"
            ]
        },
        "runType":{
            "type":"integer",
            "format":"",
            "description":"Specifies when the BML function is run",
            "title":"Instance Type"
        },
        "lineTypeFilter":{
            "type":"integer",
            "format":"",
            "description":"Line Type Filter of the Integration",
            "title":"Line Type Filter"
        }
    }
}

Nested Schema : Query Params

Type: array

Title: Query Params

This field takes the query params to be passed in the request to the above integration endpoint.

Show Source

• Array of: object KeyValueRequestModel

{
    "type":"array",
    "format":"",
    "description":"This field takes the query params to be passed in the request to the above integration endpoint.",
    "title":"Query Params",
    "items":{
        "$ref":"#/definitions/KeyValueRequestModel"
    }
}

Nested Schema : KeyValueRequestModel

Type: object

Show Source

• key: string
• value: string

{
    "properties":{
        "key":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

Back to Top

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
}

Back to Top