Create an integration instance
post
/api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationInstances/integrationInstances
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Nested Schema : oraCxSalesCommonIntegration.IntegrationInstance_post-item
Match All
Show Source
-
object
Integration Instance
Title:
Integration Instance
Integration instances represent the details of specific records integrated between Sales and other Oracle applications, such as routine identifier, status, integration payload, and integration map identifier. -
object
oraCxSalesCommonIntegration.IntegrationInstance_post-item-allOf[1]
Nested Schema : Integration Instance
Type:
object
Title:
Integration Instance
Integration instances represent the details of specific records integrated between Sales and other Oracle applications, such as routine identifier, status, integration payload, and integration map identifier.
Show Source
-
activeFlag: boolean
Title:
Active Flag
Default Value:true
Indicates whether the integration instance is active. -
createdBy: string
Title:
Created By
Read Only:true
The user who created the integration instance record. -
description: string
Title:
Integration Description
The description of the integration instance. -
integrationInstanceId: string
(big-integer)
Title:
Integration Instance Identifier
The unique identifier of the integration instance. -
integrationInstanceNumber: string
Title:
Integration Instance Number
The public unique identifier of the integration instance. -
integrationMap:
integrationMap
-
integrationPayload: string
(long-text)
Title:
Integration Payload
The payload for the integration. -
name: string
Title:
Integration Name
The name of the integration instance. -
routineExecutionId: string
(big-integer)
Title:
Routine Execution Identifier
The execution identifier of the routine that created the integration instance. -
status:
status
-
timeCreated: string
(date-time)
Title:
Time Created
Read Only:true
The date and time when the integration instance was created. -
timeUpdated: string
(date-time)
Title:
Time Updated
Read Only:true
The date and time when the integration instance record was updated. -
updatedBy: string
Title:
Updated By
Read Only:true
The user who updated the integration instance record.
Nested Schema : oraCxSalesCommonIntegration.IntegrationInstance_post-item-allOf[1]
Type:
Show Source
object
Nested Schema : integrationMap
Match All
Show Source
-
object
Integration Map
Title:
Integration Map
An integration map stores the attribute mapping between an object in Sales and an object in other Oracle applications. The integration process uses the mapping to determine the attributes that need to be synchronized from Sales to the other application. -
object
__busObj_context
Nested Schema : Integration Map
Type:
object
Title:
Integration Map
An integration map stores the attribute mapping between an object in Sales and an object in other Oracle applications. The integration process uses the mapping to determine the attributes that need to be synchronized from Sales to the other application.
Show Source
-
activeFlag: boolean
Title:
Active Flag
Indicates that the integration map is active. -
createdBy: string
Title:
Created By
Read Only:true
The user who created the integration map record. -
description: string
Title:
Map Description
The description of the integration map. -
integrationMapId: string
(big-integer)
Title:
Integration Map Identifier
The unique identifier of the integration map. -
integrationMapNumber: string
Title:
Integration Map Number
The public unique identifier of the integration map. -
integrationSpec: string
(long-text)
Title:
Map Transform Specification
The transform specifications for the integration map. -
lockedFlag: boolean
Title:
Locked Flag
Indicates that the integration map is locked and can't be edited or cloned by a user. -
name: string
Title:
Map Name
The name of the integration map. -
seededFlag: boolean
Title:
Seeded Flag
Indicates whether the integration map was seeded by Oracle. -
sourceApplication: string
Title:
Source Application
Read Only:true
The source application for the integration. -
sourceObject: string
Title:
Source Object
The source object of the integration. -
timeCreated: string
(date-time)
Title:
Time Created
Read Only:true
The date and time when the integration map was created. -
timeUpdated: string
(date-time)
Title:
Time Updated
Read Only:true
The date and time when the integration map was last updated. -
updatedBy: string
Title:
Updated By
Read Only:true
The user who last updated the integration map record.
Nested Schema : integrationMap-oneOf[0]
Type:
Show Source
object
-
integrationMapId: string
(big-integer)
Title:
Integration Map Identifier
The unique identifier of the integration map.
Nested Schema : integrationMap-oneOf[1]
Type:
Show Source
object
-
integrationMapNumber: string
Title:
Integration Map Number
The public unique identifier of the integration map.
Response
Default Response
no content
Examples
The following example shows how to create an integration instance by submitting a POST request on the REST resource.
cURL Command
curl -X POST --location 'https://servername.fa.us2.oraclecloud.com/api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationInstances/integrationInstances' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--data '{
"routineExecutionId": "309100564624402",
"integrationPayload": "{\"Product\": {\"Name\": \"1N09BX2_309100564613358\",\"InventoryItemId\": \"300100572055725\",\"OrganizationId\": \"204\",\"DefaultPeriodicityCode\": \"MONTHLY\",\"DefaultPeriods\": \"10\",\"DefaultPriceTypeCode\": \"Recurring\",\"ItemNumber\": \"1N09BX2_309100564613358\",\"DefaultUOMCode\": \"Ea\",\"ProductTypeCode\": \"INCLUDED_WARRANTY\",\"EligibleToSell\": \"Yes\",\"CSSEnabled\":\"N\",\"EligibleForService\":\"N\",\"ProcessingDays\":\"100\"}}",
"integrationMap": {
"integrationMapNumber": "DATAINTG-101"
}
}'
Example of Request Body
The following example shows the contents of the request body in JSON format.
{ "routineExecutionId": "309100564624402", "integrationPayload": "{\"Product\": {\"Name\": \"1N09BX2_309100564613358\",\"InventoryItemId\": \"300100572055725\",\"OrganizationId\": \"204\",\"DefaultPeriodicityCode\": \"MONTHLY\",\"DefaultPeriods\": \"10\",\"DefaultPriceTypeCode\": \"Recurring\",\"ItemNumber\": \"1N09BX2_309100564613358\",\"DefaultUOMCode\": \"Ea\",\"ProductTypeCode\": \"INCLUDED_WARRANTY\",\"EligibleToSell\": \"Yes\",\"CSSEnabled\":\"N\",\"EligibleForService\":\"N\",\"ProcessingDays\":\"100\"}}", "integrationMap": { "integrationMapNumber": "DATAINTG-101" } }
Response: 201 Created