Update(Activate/Deactivate) an Integration
/ic/api/integration/v1/integrations/{id}
Activates or deactivates an integration. To modify an active integration, you need to deactivate it first.
- Activate: Once you create an integration and it has the status CONFIGURED, you can activate the integration to the runtime environment.
Note that the version number matters when activating integrations:
- If integration XYZ/01.00.0000 is activated and you activate XZY/01.00.0001, XYZ/01.00.0000 will be automatically deactivated before XYZ/01.00.0001 is activated. You will have only one activated integration in this case (XZY/01.00.0001). Automatic deactivation behaves the same as a manual deactivation.
- If integration XYZ/01.00.0000 is currently activated and you activate XYZ/02.00.0000, you will have two activated integrations.
- Deactivate: You can deactivate an integration to stop it from processing any new messages. If there are pending requests unprocessed, they are lost after deactivation.
Request
- application/json; charset=utf-8
-
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.
-
deleteEventSubscriptionFlag: string
-
enableAsyncActivationMode: string
Activates/Deactivates an integration in asynchronous mode. The cURL request does not wait for the update process to finish and returns with success, while the update finishes in the background.
-
oracleRecommendsFlag: boolean
Oracle Recommends Flag
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
object
-
object additionalProperties
Additional Properties Allowed: additionalProperties
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
object
-
messageContextRef:
object ReferenceType
-
name:
string
-
property:
array property
-
resourceGroup:
array resourceGroup
-
role:
string
Allowed Values:
[ "REQUEST", "RESPONSE", "FAULT", "VARIABLE" ]
-
subRole:
string
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" ]
Response
- application/json; charset=utf-8
200 Response
404 Response
412 Response
500 Response
Examples
The following examples show how to activate/deactivate an integration by submitting a POST 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: Activate/Deactivate an Integration
Request:
curl -X POST -H 'Authorization: Bearer access_token' -H "Content-Type:application/json" -H "X-HTTP-Method-Override:PATCH" -d @update.json https://integration.us.oraclecloud.com/ic/api/integration/v1/integrations/HELLO_WORLD%7C01.02.0000
Request Body:
The following example shows the contents of the request body in JSON format. This is the contents of the update.json
file listed in the cURL command. The JSON file must contain one main attribute: status
. In this example, the integration is activated. To deactivate an integration, set the status to CONFIGURED.
{"status":"ACTIVATED"}
Possible statuses are ACTIVATED for an active integration, or CONFIGURED for an inactive integration.
Example: Activate/Deactivate an Integration in Asynchronous Mode
This example deactivates an integration in asynchronous mode. The cURL request does not wait for the update process to finish. The request returns with success while the update finishes in the background.
curl -X POST -H 'Authorization: Bearer access_token' -H "Content-Type:application/json" -H "X-HTTP-Method-Override:PATCH" -d @update.json -d 'enableAsyncActivationMode=true' https://integration.us.oraclecloud.com/ic/api/integration/v1/integrations/HELLO_WORLD%7C01.02.0000
{"status":"CONFIGURED"}
To stop an integration's schedule and deactivate the integration, use stopScheduleForDeactivation in the Request Body:
{
"status":"CONFIGURED",
"stopScheduleForDeactivation":"true"
}