1. REST API for Oracle Integration 3
  2. Tasks
  3. Integrations
  4. Integrations

Update(Activate/Deactivate) an Integration

post

/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

Path Parameters
  • 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
Header Parameters
Supported Media Types
Request Body - application/json;charset=utf-8 ()
Root Schema : schema
Type: object
Show Source
Nested Schema : schedule-params
Type: object
Additional Properties Allowed
Show Source
Schedule Parameters
Nested Schema : additionalProperties
Type: object
Additional Properties Allowed
Show Source
Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : IntegrationListRs
Type: object
Show Source
Nested Schema : IntegrationDependencyRs
Type: object
Show Source
Nested Schema : end-points
Type: array
Endpoints
Show Source
Nested Schema : filmstrip
Type: array
Filmstrip
Show Source
Nested Schema : properties
Type: array
Integration Properties List
Show Source
Nested Schema : tracking-variables
Type: array
Tracking Variables List
Show Source
Nested Schema : certificates
Type: array
Show Source
Nested Schema : connections
Type: array
Show Source
Nested Schema : libraries
Type: array
Show Source
Nested Schema : lookups
Type: array
Show Source
Nested Schema : IntegrationDependencyRs.CertificateDependencyRs
Type: object
Show Source
Nested Schema : IntegrationDependencyRs.ConnectionDependencyRs
Type: object
Show Source
Nested Schema : IntegrationDependencyRs.LibraryDependencyRs
Type: object
Show Source
Nested Schema : IntegrationDependencyRs.LookupDependencyRs
Type: object
Show Source
Nested Schema : EndPointRs
Type: object
Show Source
Nested Schema : ConnectionBaseRs
Type: object
Match All
Show Source
Nested Schema : IdResource
Match All
Show Source
Nested Schema : GenericRestResource
Type: object
Show Source
Nested Schema : IdResource-allOf[1]
Type: object
Show Source
Nested Schema : FilmstripRs
Type: object
Show Source
Nested Schema : IntegrationPropRs
Type: object
Show Source
Nested Schema : TrackingVariableTypeRs
Type: object
Show Source
Nested Schema : TrackingVariableTypeRs.ReferenceTypeRs
Type: object
Show Source
Nested Schema : TrackingVariableTypeRs.OutputWirepointTypeRs
Type: object
Show Source
Nested Schema : property
Type: array
Show Source
Nested Schema : property
Type: array
Show Source
Nested Schema : TrackingVariableTypeRs.PropertyTypeRs
Type: object
Show Source

404 Response

Integration not found

412 Response

Already activated/deactivated or can't be activated/deactivated

500 Response

Server error
Back to Top

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://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/integrations/HELLO_WORLD%7C01.02.0000?integrationInstance=service-instance

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://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/integrations/HELLO_WORLD%7C01.02.0000?integrationInstance=service-instance
Request Body:
{"status":"CONFIGURED"}

To stop an integration's schedule and deactivate the integration, use stopScheduleForDeactivation in the Request Body: 

{ 
  "status":"CONFIGURED", 
  "stopScheduleForDeactivation":"true"
}

Response Body:

The following example shows the contents of the response body in JSON format.

{  
          "compatible": false,
          "links": [],
          "lockedFlag": false, 
          "payloadTracingEnabledFlag": false,
          "recordEnabledFlag": false,
          "scheduleApplicableFlag": false,
          "scheduleDefinedFlag": false,
          "status": "ACTIVATED",
          "tempCopyExists": false,
          "totalEndPoints": 0,
          "tracingEnabledFlag": false
         }
Back to Top