Jump to

• Request
• Response
• Examples

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

Request Body - application/json ()

Root Schema : schema

Match All

Show Source

• allOf oraCxSalesCommonIntegration.IntegrationInstance_post-item
• object __busObj_context

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxSalesCommonIntegration.IntegrationInstance_post-item"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        }
    ]
}

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]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxSalesCommonIntegration.IntegrationInstance_item"
        },
        {
            "type":"object",
            "properties":{
                "integrationMap":{
                    "oneOf":[
                        {
                            "type":"object",
                            "properties":{
                                "integrationMapId":{
                                    "$ref":"#/components/schemas/oraCxSalesCommonIntegration.IntegrationMapping_item/properties/integrationMapId"
                                }
                            }
                        },
                        {
                            "type":"object",
                            "properties":{
                                "integrationMapNumber":{
                                    "$ref":"#/components/schemas/oraCxSalesCommonIntegration.IntegrationMapping_item/properties/integrationMapNumber"
                                }
                            }
                        },
                        {
                            "$ref":"#/components/schemas/__busObj_context"
                        }
                    ]
                }
            }
        }
    ],
    "required":[
        "name",
        "integrationInstanceNumber",
        "routineExecutionId"
    ]
}

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.

{
    "type":"object",
    "properties":{
        "integrationInstanceId":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "title":"Integration Instance Identifier",
            "description":"The unique identifier of the integration instance."
        },
        "name":{
            "type":"string",
            "x-searchable":true,
            "title":"Integration Name",
            "description":"The name of the integration instance."
        },
        "description":{
            "type":"string",
            "nullable":true,
            "title":"Integration Description",
            "description":"The description of the integration instance."
        },
        "integrationInstanceNumber":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "title":"Integration Instance Number",
            "description":"The public unique identifier of the integration instance."
        },
        "routineExecutionId":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "title":"Routine Execution Identifier",
            "description":"The execution identifier of the routine that created the integration instance."
        },
        "activeFlag":{
            "type":"boolean",
            "default":true,
            "nullable":true,
            "title":"Active Flag",
            "description":"Indicates whether the integration instance is active."
        },
        "status":{
            "allOf":[
                {
                    "type":"string",
                    "default":"DRAFT",
                    "nullable":true,
                    "x-searchable":true,
                    "title":"Status",
                    "description":"The status of the integration instance."
                },
                {
                    "$ref":"#/components/schemas/oraCxSalesCommonIntegration.integrationStatus_enum"
                }
            ]
        },
        "integrationPayload":{
            "type":"string",
            "format":"long-text",
            "nullable":true,
            "title":"Integration Payload",
            "description":"The payload for the integration."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "title":"Created By",
            "description":"The user who created the integration instance record."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "readOnly":true,
            "title":"Time Created",
            "description":"The date and time when the integration instance was created."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "title":"Updated By",
            "description":"The user who updated the integration instance record."
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "x-sortable":true,
            "readOnly":true,
            "title":"Time Updated",
            "description":"The date and time when the integration instance record was updated."
        },
        "integrationMap":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/oraCxSalesCommonIntegration.IntegrationMapping_item"
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                }
            ]
        }
    },
    "x-primaryKey":[
        "integrationInstanceId"
    ],
    "x-alternateKeys":{
        "altKey":[
            "integrationInstanceNumber"
        ]
    },
    "title":"Integration Instance",
    "x-hints":{
        "titlePlural":"Integration Instances"
    },
    "description":"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."
}

Nested Schema : oraCxSalesCommonIntegration.IntegrationInstance_post-item-allOf[1]

Type: object

Show Source

• integrationMap: integrationMap

{
    "type":"object",
    "properties":{
        "integrationMap":{
            "oneOf":[
                {
                    "type":"object",
                    "properties":{
                        "integrationMapId":{
                            "$ref":"#/components/schemas/oraCxSalesCommonIntegration.IntegrationMapping_item/properties/integrationMapId"
                        }
                    }
                },
                {
                    "type":"object",
                    "properties":{
                        "integrationMapNumber":{
                            "$ref":"#/components/schemas/oraCxSalesCommonIntegration.IntegrationMapping_item/properties/integrationMapNumber"
                        }
                    }
                },
                {
                    "$ref":"#/components/schemas/__busObj_context"
                }
            ]
        }
    }
}

Nested Schema : __busObj_context

Type: object

Show Source

• $context: object $context
• $id: string

{
    "type":"object",
    "properties":{
        "$id":{
            "type":"string"
        },
        "$context":{
            "type":"object",
            "properties":{
                "etag":{
                    "type":"string"
                },
                "links":{
                    "type":"object",
                    "properties":{
                        "$self":{
                            "type":"object",
                            "properties":{
                                "href":{
                                    "type":"string"
                                }
                            }
                        }
                    },
                    "readOnly":true
                }
            }
        }
    }
}

Nested Schema : integrationMap

Match All

Show Source

• object Integration Map
  Title: Integration Map

  Integration maps describe the attribute mappings between objects in Sales and objects in other Oracle applications. The integration process uses these mappings to determine the attributes that need to be synchronized from Sales to the other applications.
• object __busObj_context

{
    "allOf":[
        {
            "$ref":"#/components/schemas/oraCxSalesCommonIntegration.IntegrationMapping_item"
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        }
    ]
}

Nested Schema : status

Match All

The status of the integration instance.

Show Source

• string
  Title: Status

  Default Value: DRAFT

  The status of the integration instance.
• string
  Allowed Values: [ "DRAFT", "IN_PROGRESS", "COMPLETE", "ERROR", "RETRY" ]

{
    "allOf":[
        {
            "type":"string",
            "default":"DRAFT",
            "nullable":true,
            "x-searchable":true,
            "title":"Status",
            "description":"The status of the integration instance."
        },
        {
            "$ref":"#/components/schemas/oraCxSalesCommonIntegration.integrationStatus_enum"
        }
    ]
}

Nested Schema : Integration Map

Type: object

Title: Integration Map

Integration maps describe the attribute mappings between objects in Sales and objects in other Oracle applications. The integration process uses these mappings to determine the attributes that need to be synchronized from Sales to the other applications.

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.

{
    "type":"object",
    "properties":{
        "integrationMapId":{
            "type":"string",
            "format":"big-integer",
            "x-searchable":true,
            "x-sortable":true,
            "title":"Integration Map Identifier",
            "description":"The unique identifier of the integration map."
        },
        "name":{
            "type":"string",
            "title":"Map Name",
            "description":"The name of the integration map."
        },
        "description":{
            "type":"string",
            "nullable":true,
            "title":"Map Description",
            "description":"The description of the integration map."
        },
        "integrationMapNumber":{
            "type":"string",
            "x-searchable":true,
            "x-sortable":true,
            "title":"Integration Map Number",
            "description":"The public unique identifier of the integration map."
        },
        "sourceApplication":{
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "title":"Source Application",
            "description":"The source application for the integration."
        },
        "sourceObject":{
            "type":"string",
            "x-searchable":true,
            "title":"Source Object",
            "description":"The source object of the integration."
        },
        "seededFlag":{
            "type":"boolean",
            "x-searchable":true,
            "title":"Seeded Flag",
            "description":"Indicates whether the integration map was seeded by Oracle."
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "readOnly":true,
            "title":"Time Created",
            "description":"The date and time when the integration map was created."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "title":"Created By",
            "description":"The user who created the integration map record."
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "x-sortable":true,
            "readOnly":true,
            "title":"Time Updated",
            "description":"The date and time when the integration map was last updated."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "title":"Updated By",
            "description":"The user who last updated the integration map record."
        },
        "integrationSpec":{
            "type":"string",
            "format":"long-text",
            "nullable":true,
            "title":"Map Transform Specification",
            "description":"The transform specifications for the integration map."
        },
        "activeFlag":{
            "type":"boolean",
            "title":"Active Flag",
            "description":"Indicates that the integration map is active."
        },
        "lockedFlag":{
            "type":"boolean",
            "title":"Locked Flag",
            "description":"Indicates that the integration map is locked and can't be edited or cloned by a user."
        }
    },
    "x-primaryKey":[
        "integrationMapId"
    ],
    "x-alternateKeys":{
        "altKey":[
            "integrationMapNumber"
        ]
    },
    "title":"Integration Map",
    "x-hints":{
        "titlePlural":"Integration Maps"
    },
    "description":"Integration maps describe the attribute mappings between objects in Sales and objects in other Oracle applications. The integration process uses these mappings to determine the attributes that need to be synchronized from Sales to the other applications."
}

Nested Schema : $context

Type: object

Show Source

• etag: string
• links: object links
  Read Only: true

{
    "type":"object",
    "properties":{
        "etag":{
            "type":"string"
        },
        "links":{
            "type":"object",
            "properties":{
                "$self":{
                    "type":"object",
                    "properties":{
                        "href":{
                            "type":"string"
                        }
                    }
                }
            },
            "readOnly":true
        }
    }
}

Nested Schema : links

Type: object

Read Only: true

Show Source

• $self: object $self

{
    "type":"object",
    "properties":{
        "$self":{
            "type":"object",
            "properties":{
                "href":{
                    "type":"string"
                }
            }
        }
    },
    "readOnly":true
}

Nested Schema : $self

Type: object

Show Source

• href: string

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : integrationMap

Match One Schema

Show Source

• object integrationMap-oneOf[0]
• object integrationMap-oneOf[1]
• object __busObj_context

{
    "oneOf":[
        {
            "type":"object",
            "properties":{
                "integrationMapId":{
                    "$ref":"#/components/schemas/oraCxSalesCommonIntegration.IntegrationMapping_item/properties/integrationMapId"
                }
            }
        },
        {
            "type":"object",
            "properties":{
                "integrationMapNumber":{
                    "$ref":"#/components/schemas/oraCxSalesCommonIntegration.IntegrationMapping_item/properties/integrationMapNumber"
                }
            }
        },
        {
            "$ref":"#/components/schemas/__busObj_context"
        }
    ]
}

Nested Schema : integrationMap-oneOf[0]

Type: object

Show Source

• integrationMapId: string (big-integer)
  Title: Integration Map Identifier

  The unique identifier of the integration map.

{
    "type":"object",
    "properties":{
        "integrationMapId":{
            "$ref":"#/components/schemas/oraCxSalesCommonIntegration.IntegrationMapping_item/properties/integrationMapId"
        }
    }
}

Nested Schema : integrationMap-oneOf[1]

Type: object

Show Source

• integrationMapNumber: string
  Title: Integration Map Number

  The public unique identifier of the integration map.

{
    "type":"object",
    "properties":{
        "integrationMapNumber":{
            "$ref":"#/components/schemas/oraCxSalesCommonIntegration.IntegrationMapping_item/properties/integrationMapNumber"
        }
    }
}

Back to Top

Response

Default Response

no content

Back to Top

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

Back to Top