Retrieve an Integration
get
/ic/api/integration/v1/integrations/{id}
Retrieves detailed information about the integration with the specified ID.
Request
Supported Media Types
- application/json; charset=utf-8
Path Parameters
-
id(required): string
Integration composite identifier. The ID consists of the code and the version separated by the | (vertical line) character. Format: code%7Cversion. Example: SC2RN%7C01.00.0000. When using cURL, substitute the %7C code for the vertical line.
Query Parameters
-
expand: string
Includes additional details in the response about connections in the integration or about the adapters for the connections. Valid values: connection, connection.adapter.
Response
Supported Media Types
- application/json; charset=utf-8
- application/vnd.oracle.resource+json;type=singular
200 Response
Successful operation
Root Schema : integration
Type:
Show Source
object
-
apipId:
string
-
bartaBuiltBy:
string
-
code:
string
-
compatible:
boolean
Default Value:
false
-
created:
string(date-time)
-
createdBy:
string
-
dependencies:
object IntegrationDependencyRs
-
description:
string
-
docUrl:
string
-
endPoints:
array endPoints
-
endPointURI:
string
-
eventSubscriptionFlag:
boolean
Default Value:
false
-
filmstrip:
array filmstrip
-
id:
string
-
isCloneAllowed:
boolean
Default Value:
false
-
isViewAllowed:
boolean
Default Value:
false
-
keywords:
string
-
lastUpdated:
string(date-time)
-
lastUpdatedBy:
string
-
links:
array links
-
lockedBy:
string
-
lockedDate:
string(date-time)
-
lockedFlag:
boolean
Default Value:
false
-
mepType:
string
-
name:
string
-
originalIntegrationCode:
string
-
packageName:
string
-
pattern:
string
-
patternDescription:
string
-
payloadTracingEnabledFlag:
boolean
Default Value:
false
-
percentageComplete:
number
-
projectModelVersion:
string
-
projectType:
string
-
properties:
array properties
-
proxyWSDL:
string
-
publishFlag:
boolean
Default Value:
false
-
recordEnabledFlag:
boolean
Default Value:
false
-
scheduleApplicableFlag:
boolean
Default Value:
false
-
scheduleDefinedFlag:
boolean
Default Value:
false
-
scheduleParams:
object scheduleParams
Additional Properties Allowed: additionalProperties
-
securityPolicy:
string
-
smartTags:
string
-
status:
string
-
stopScheduleForDeactivation:
boolean
Default Value:
false
-
style:
string
-
styleDescription:
string
-
submitNowURI:
string
-
totalEndPoints:
integer(int32)
-
tracingEnabledFlag:
boolean
Default Value:
false
-
trackingInstanceName:
string
-
trackingVariables:
array trackingVariables
-
version:
string
-
warningMsg:
string
Nested Schema : scheduleParams
Type:
object
Additional Properties Allowed
Show Source
-
object additionalProperties
Additional Properties Allowed: additionalProperties
Nested Schema : TrackingVariableType
Type:
Show Source
object
-
description:
string
-
id:
string
-
messageContextRef(required):
object ReferenceType
-
name(required):
string
-
output(required):
object WirepointType
-
primary:
boolean
Default Value:
false
-
property:
array property
-
refUri:
string
-
role:
string
-
subRole:
string
-
type:
string
Allowed Values:
[ "ORCHESTRATION", "RECEIVE", "ROUTER", "ROUTER_ROUTE", "TRANSFORMER", "TRY", "TRY_CATCH", "INVOKE", "REPLY", "LABEL", "ASSIGNMENT", "FOR", "STOP", "SCHEDULERECEIVE", "STAGEFILE", "FAULTREPLY", "CALLOUT", "WHILE", "WAIT", "NOTE", "GLOBAL_VARIABLE", "GLOBAL_TRY", "GLOBAL_CATCH_ALL", "CATCH_ALL", "EHSTOP", "NOTIFICATION", "ACTIVITY_STREAM_LOGGER", "STITCH", "THROW", "PICK", "PICKRECEIVE", "TRACKING_VARIABLE", "REJECT", "INTEGRATION_METADATA", "INTEGRATION_PROPERTIES" ]
-
xpath(required):
string
Nested Schema : WirepointType
Type:
Show Source
object
-
messageContextRef:
object ReferenceType
-
name:
string
-
property:
array property
-
resourceGroup:
array resourceGroup
-
role:
string
Allowed Values:
[ "REQUEST", "RESPONSE", "FAULT", "VARIABLE" ]
-
subRole:
string
Nested Schema : ResourceType
Type:
Show Source
object
-
externalLocation:
string
-
location:
string
-
name:
string
-
property:
array property
-
resourceDescription:
string
-
resourceName:
string
-
role:
string
-
subRole:
string
-
type:
string
Allowed Values:
[ "XSD", "XSLT", "JCA", "WSDL", "WADL", "PROPERTIES", "UNDEFINED" ]
404 Response
Not found
412 Response
Precondition failed
500 Response
Server error
Examples
The following examples show how to get details about an integration by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL. For more information about endpoint URL structure, see Send Requests.
Example: Get details about the integration HELLO_WORLD|01.02.0000
The id is in the form: code%7Cversion
. The %7C is the encoded | (vertical line).
curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" https://integration.us.oraclecloud.com/ic/api/integration/v1/integrations/HELLO_WORLD%7C01.02.0000
Example: Get details about the integration HELLO_WORLD|01.02.0000 with additional details about connections
The id is in the form: code%7Cversion
. The %7C is the encoded | (vertical line).
curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "expand=connection" https://integration.us.oraclecloud.com/ic/api/integration/v1/integrations/HELLO_WORLD%7C01.02.0000