Advanced query an integration instance
post
/api/boss/data/objects/ora/cxSalesCommon/integration/v1/$en/integrationInstances/integrationInstances/{integrationInstances_id}/$query
Request
Path Parameters
-
integrationInstances_id(required): string
This path parameter maps to the following field defined in the Integration Instances REST resource:
- integrationInstanceId: The unique identifier of the integration instance.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
accessors: object
accessors
Maps accessor names to query objects specific to corresponding accessors. Query object for each accessor supports query capabilities similar to the base.
-
fields: array
fields
Restricts the resource fields. Only the specified fields and mandatory system fields are returned.
-
subTypes: object
subTypes
Maps discriminator values (as defined in subtypes) to query objects specific to corresponding subtypes. Subtype-specific query objects support a subset(fields,accessors,filter) of the query capabilities when compared to the base.
Nested Schema : accessors
Type:
object
Maps accessor names to query objects specific to corresponding accessors. Query object for each accessor supports query capabilities similar to the base.
Nested Schema : fields
Type:
array
Restricts the resource fields. Only the specified fields and mandatory system fields are returned.
Show Source
Nested Schema : subTypes
Type:
object
Maps discriminator values (as defined in subtypes) to query objects specific to corresponding subtypes. Subtype-specific query objects support a subset(fields,accessors,filter) of the query capabilities when compared to the base.
Response
Default Response
A single item response
Root Schema : integrationInstances_item-response
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
__busObj_context
-
object
integrationInstances_item-response-allOf[2]
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 : 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 : integrationInstances-integrationDetails_item-response
Match All
Show Source
-
object
Instance Detail
Title:
Instance Detail
An integration instance details stores the various stages of an integration instance and their statuses. -
object
__busObj_context
Nested Schema : Instance Detail
Type:
object
Title:
Instance Detail
An integration instance details stores the various stages of an integration instance and their statuses.
Show Source
-
childIntegrationDetails:
childIntegrationDetails
-
createdBy: string
Title:
Created By
Read Only:true
The user who created the integration instance detail record. -
inboundPayload: string
(long-text)
Title:
Inbound Payload
The inbound payload for the integration instance detail. -
instanceDetailId: string
(big-integer)
Title:
Request Detail Identifier
The unique identifier of the detail record within an integration instance. -
integration:
integration
-
integrationInstanceId: string
(big-integer)
Title:
Integration Instance Identifier
The unique identifier of the integration instance. -
integrationLevel: integer
(int32)
Title:
Integration Level
The level of the integration instance detail. This applies to integrations with substeps. -
outboundPayload: string
(long-text)
Title:
Outbound Payload
The outbound payload for the integration instance detail. -
stage:
stage
-
status:
status
-
step: string
Title:
Substep
The name of the substep. -
timeCreated: string
(date-time)
Title:
Time Created
Read Only:true
The date and time of the creation of the integration instance detail record. -
timeUpdated: string
(date-time)
Title:
Time Updated
Read Only:true
The date and time when the integration instance detail record was updated. -
updatedBy: string
Title:
Updated By
Read Only:true
The user who last updated the integration instance detail record.
Nested Schema : childIntegrationDetails
Match All
Show Source
-
object
Instance Detail
Title:
Instance Detail
An integration instance details stores the various stages of an integration instance and their statuses. -
object
__busObj_context
Nested Schema : integration
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
__busObj_context
Links
- $self
-
Parameters:
- integrationInstances_id:
$request.path.integrationInstances_id
- integrationInstances_id:
- integrationMap
-
Parameters:
- integrationMaps_id:
$response.body#/integrationMap/$id
- integrationMaps_id: