Jump to

• Request
• Response
• Examples

Update an Integration in a Project

post

/ic/api/integration/v1/projects/{projectId}/integrations/{id}

Activates or deactivates an integration in a project. 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.

Updates integration property of an integration in a project.

Request

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.
• projectId(required): string
  Project identifier

Query Parameters

• deleteEventSubscriptionFlag: string
  Delete Event Subscription Flag
• 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.
• integrationInstance(required): string
  This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.

Header Parameters

• X-HTTP-Method-Override:
  X-HTTP-Method-Override request header

Supported Media Types

• application/json;charset=utf-8

Request Body - application/json;charset=utf-8 ()

Root Schema : schema

Type: object

Show Source

• apip-id: string
  Application Identifier
• event-subscription-flag: boolean
  Event Subscription Flag
• locked-by: string
  Locked By
• locked-date: string (date-time)
  Locked Date
• project-model-version: string
  Project Model Version
• publish-flag: boolean
  Publish Flag
• schedule-params: object schedule-params
  Additional Properties Allowed: additionalProperties

  Schedule Parameters
• scope: string
  Scope of the integration
• security-policy: string
  Security Policy
• skip-event-subscription: boolean
  Skip Event Subscription
• submit-now-uri: string
  SubmitNow URI
• tracking-instance-name: string
  Tracking Instance Name
• warning-msg: string
  Warning Message

{
    "type":"object",
    "properties":{
        "scope":{
            "type":"string",
            "description":"Scope of the integration"
        },
        "locked-by":{
            "type":"string",
            "description":"Locked By"
        },
        "locked-date":{
            "type":"string",
            "description":"Locked Date",
            "format":"date-time"
        },
        "submit-now-uri":{
            "type":"string",
            "description":"SubmitNow URI"
        },
        "tracking-instance-name":{
            "type":"string",
            "description":"Tracking Instance Name"
        },
        "schedule-params":{
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            },
            "description":"Schedule Parameters"
        },
        "project-model-version":{
            "type":"string",
            "description":"Project Model Version"
        },
        "security-policy":{
            "type":"string",
            "description":"Security Policy"
        },
        "apip-id":{
            "type":"string",
            "description":"Application Identifier"
        },
        "warning-msg":{
            "type":"string",
            "description":"Warning Message"
        },
        "publish-flag":{
            "type":"boolean",
            "description":"Publish Flag"
        },
        "event-subscription-flag":{
            "type":"boolean",
            "description":"Event Subscription Flag"
        },
        "skip-event-subscription":{
            "type":"boolean",
            "description":"Skip Event Subscription"
        }
    }
}

Nested Schema : schedule-params

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    },
    "description":"Schedule Parameters"
}

Schedule Parameters

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json; charset=utf-8

200 Response

Successful operation

Body ()

Root Schema : IntegrationListRs

Type: object

Show Source

• activation-status: string
• barta-built-by: string
  BA (Business Accelerator) | R (Recipe) | TA (Technical Accelerator) builtBy
• compatible: boolean
  Compatible
• created: string (date-time)
  Created Date
• created-by: string
  Created By
• dependencies: object IntegrationDependencyRs
• description: string
  Integration Description
• doc-url: string
  Documentation URL
• end-point-uri: string
  Integration Endpoint URI
• end-points: array end-points
  Endpoints
• filmstrip: array filmstrip
  Filmstrip
• is-clone-allowed: boolean
  Flag to Check if Clone Allowed
• is-view-allowed: boolean
  Flag to Check if View Allowed
• keywords: string
  Keywords
• last-updated: string (date-time)
  Last Updated Date
• last-updated-by: string
  Last Updated By
• locked-by: string
  Locked By
• locked-date: string (date-time)
  Locked Date
• locked-flag: boolean
  Locked Flag
• mep-type: string
  MEP Type
• original-integration-code: string
  Original Integration Code
• package-name: string
  Package Name
• pattern: string
  Pattern
• pattern-description: string
  Pattern Description
• payload-tracing-enabled-flag: boolean
  Payload Tracing Enabled Flag
• percentage-complete: number
  Percentage Complete
• project-id: string
• project-type: string
  Project Type
• properties: array properties
  Integration Properties List
• proxy-wsdl: string
  Proxy WSDL
• reactivation-status: string
  Reactivation Status
• record-enabled-flag: boolean
  Record Enabled Flag
• schedule-applicable-flag: boolean
  Schedule Applicable Flag
• schedule-defined-flag: boolean
  Schedule Defined Flag
• scope: string
• smart-tags: string
  Smart Tags
• style: string
  Style
• style-description: string
  Style Description
• temp-copy-exists: boolean
  Temp Copy Exists Flag
• total-end-points: integer (int32)
• tracing-enabled-flag: boolean
  Tracing Enabled Flag
• tracking-variables: array tracking-variables
  Tracking Variables List

{
    "type":"object",
    "properties":{
        "scope":{
            "type":"string"
        },
        "description":{
            "type":"string",
            "description":"Integration Description"
        },
        "created-by":{
            "type":"string",
            "description":"Created By"
        },
        "created":{
            "type":"string",
            "description":"Created Date",
            "format":"date-time"
        },
        "last-updated-by":{
            "type":"string",
            "description":"Last Updated By"
        },
        "last-updated":{
            "type":"string",
            "description":"Last Updated Date",
            "format":"date-time"
        },
        "end-point-uri":{
            "type":"string",
            "description":"Integration Endpoint URI"
        },
        "pattern":{
            "type":"string",
            "description":"Pattern"
        },
        "project-type":{
            "type":"string",
            "description":"Project Type"
        },
        "compatible":{
            "type":"boolean",
            "description":"Compatible"
        },
        "package-name":{
            "type":"string",
            "description":"Package Name"
        },
        "locked-flag":{
            "type":"boolean",
            "description":"Locked Flag"
        },
        "style":{
            "type":"string",
            "description":"Style"
        },
        "style-description":{
            "type":"string",
            "description":"Style Description"
        },
        "pattern-description":{
            "type":"string",
            "description":"Pattern Description"
        },
        "tracing-enabled-flag":{
            "type":"boolean",
            "description":"Tracing Enabled Flag"
        },
        "payload-tracing-enabled-flag":{
            "type":"boolean",
            "description":"Payload Tracing Enabled Flag"
        },
        "percentage-complete":{
            "type":"number",
            "description":"Percentage Complete"
        },
        "schedule-applicable-flag":{
            "type":"boolean",
            "description":"Schedule Applicable Flag"
        },
        "schedule-defined-flag":{
            "type":"boolean",
            "description":"Schedule Defined Flag"
        },
        "end-points":{
            "type":"array",
            "description":"Endpoints",
            "items":{
                "$ref":"#/components/schemas/EndPointRs"
            }
        },
        "filmstrip":{
            "type":"array",
            "description":"Filmstrip",
            "items":{
                "$ref":"#/components/schemas/FilmstripRs"
            }
        },
        "total-end-points":{
            "type":"integer",
            "format":"int32"
        },
        "record-enabled-flag":{
            "type":"boolean",
            "description":"Record Enabled Flag"
        },
        "tracking-variables":{
            "type":"array",
            "description":"Tracking Variables List",
            "items":{
                "$ref":"#/components/schemas/TrackingVariableTypeRs"
            }
        },
        "mep-type":{
            "type":"string",
            "description":"MEP Type"
        },
        "locked-by":{
            "type":"string",
            "description":"Locked By"
        },
        "locked-date":{
            "type":"string",
            "description":"Locked Date",
            "format":"date-time"
        },
        "dependencies":{
            "$ref":"#/components/schemas/IntegrationDependencyRs"
        },
        "proxy-wsdl":{
            "type":"string",
            "description":"Proxy WSDL"
        },
        "keywords":{
            "type":"string",
            "description":"Keywords"
        },
        "doc-url":{
            "type":"string",
            "description":"Documentation URL"
        },
        "smart-tags":{
            "type":"string",
            "description":"Smart Tags"
        },
        "properties":{
            "type":"array",
            "description":"Integration Properties List",
            "items":{
                "$ref":"#/components/schemas/IntegrationPropRs"
            }
        },
        "barta-built-by":{
            "type":"string",
            "description":"BA (Business Accelerator) | R (Recipe) | TA (Technical Accelerator) builtBy"
        },
        "is-view-allowed":{
            "type":"boolean",
            "description":"Flag to Check if View Allowed"
        },
        "is-clone-allowed":{
            "type":"boolean",
            "description":"Flag to Check if Clone Allowed"
        },
        "original-integration-code":{
            "type":"string",
            "description":"Original Integration Code"
        },
        "temp-copy-exists":{
            "type":"boolean",
            "description":"Temp Copy Exists Flag"
        },
        "reactivation-status":{
            "type":"string",
            "description":"Reactivation Status"
        },
        "project-id":{
            "type":"string"
        },
        "activation-status":{
            "type":"string"
        }
    }
}

Nested Schema : IntegrationDependencyRs

Type: object

Show Source

• certificates: array certificates
• connections: array connections
• libraries: array libraries
• lookups: array lookups

{
    "type":"object",
    "properties":{
        "connections":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IntegrationDependencyRs.ConnectionDependencyRs"
            }
        },
        "lookups":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IntegrationDependencyRs.LookupDependencyRs"
            }
        },
        "libraries":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IntegrationDependencyRs.LibraryDependencyRs"
            }
        },
        "certificates":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/IntegrationDependencyRs.CertificateDependencyRs"
            }
        }
    }
}

Nested Schema : end-points

Type: array

Endpoints

Show Source

• Array of: object EndPointRs

{
    "type":"array",
    "description":"Endpoints",
    "items":{
        "$ref":"#/components/schemas/EndPointRs"
    }
}

Nested Schema : filmstrip

Type: array

Filmstrip

Show Source

• Array of: object FilmstripRs

{
    "type":"array",
    "description":"Filmstrip",
    "items":{
        "$ref":"#/components/schemas/FilmstripRs"
    }
}

Nested Schema : properties

Type: array

Integration Properties List

Show Source

• Array of: object IntegrationPropRs

{
    "type":"array",
    "description":"Integration Properties List",
    "items":{
        "$ref":"#/components/schemas/IntegrationPropRs"
    }
}

Nested Schema : tracking-variables

Type: array

Tracking Variables List

Show Source

• Array of: object TrackingVariableTypeRs

{
    "type":"array",
    "description":"Tracking Variables List",
    "items":{
        "$ref":"#/components/schemas/TrackingVariableTypeRs"
    }
}

Nested Schema : certificates

Type: array

Show Source

• Array of: object IntegrationDependencyRs.CertificateDependencyRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/IntegrationDependencyRs.CertificateDependencyRs"
    }
}

Nested Schema : connections

Type: array

Show Source

• Array of: object IntegrationDependencyRs.ConnectionDependencyRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/IntegrationDependencyRs.ConnectionDependencyRs"
    }
}

Nested Schema : libraries

Type: array

Show Source

• Array of: object IntegrationDependencyRs.LibraryDependencyRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/IntegrationDependencyRs.LibraryDependencyRs"
    }
}

Nested Schema : lookups

Type: array

Show Source

• Array of: object IntegrationDependencyRs.LookupDependencyRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/IntegrationDependencyRs.LookupDependencyRs"
    }
}

Nested Schema : IntegrationDependencyRs.CertificateDependencyRs

Type: object

Show Source

• id(required): string
• name(required): string
• status(required): string
• usage(required): integer (int32)

{
    "required":[
        "id",
        "name",
        "status",
        "usage"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "usage":{
            "type":"integer",
            "format":"int32"
        },
        "status":{
            "type":"string"
        }
    }
}

Nested Schema : IntegrationDependencyRs.ConnectionDependencyRs

Type: object

Show Source

• display-name: string
• id(required): string
• locked-by: string
• locked-date: string (date-time)
• locked-flag: boolean
• name: string
• role: string
• status: string
• type: string
• usage: integer (int32)

{
    "required":[
        "id"
    ],
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "display-name":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "role":{
            "type":"string"
        },
        "usage":{
            "type":"integer",
            "format":"int32"
        },
        "locked-flag":{
            "type":"boolean"
        },
        "locked-by":{
            "type":"string"
        },
        "locked-date":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : IntegrationDependencyRs.LibraryDependencyRs

Type: object

Show Source

• code: string
• description: string
• display-name: string
• last-updated-date: string (date-time)
• locked-by: string
• locked-date: string (date-time)
• locked-flag: boolean
• status: string
• usage: integer (int32)
• version: string

{
    "type":"object",
    "properties":{
        "display-name":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "last-updated-date":{
            "type":"string",
            "format":"date-time"
        },
        "status":{
            "type":"string"
        },
        "usage":{
            "type":"integer",
            "format":"int32"
        },
        "locked-flag":{
            "type":"boolean"
        },
        "locked-by":{
            "type":"string"
        },
        "locked-date":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : IntegrationDependencyRs.LookupDependencyRs

Type: object

Show Source

• description(required): string
• locked-by: string
• locked-date: string (date-time)
• locked-flag: boolean
• name(required): string
• status(required): string
• usage(required): integer (int32)

{
    "required":[
        "description",
        "name",
        "status",
        "usage"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "usage":{
            "type":"integer",
            "format":"int32"
        },
        "status":{
            "type":"string"
        },
        "locked-flag":{
            "type":"boolean"
        },
        "locked-by":{
            "type":"string"
        },
        "locked-date":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : EndPointRs

Type: object

Show Source

• connection: object ConnectionBaseRs
• name(required): string
• role: string

{
    "required":[
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "connection":{
            "$ref":"#/components/schemas/ConnectionBaseRs"
        },
        "role":{
            "type":"string"
        }
    }
}

Nested Schema : ConnectionBaseRs

Type: object

Match All

Show Source

• allOf IdResource
• object GenericRestResource

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/components/schemas/IdResource"
        },
        {
            "$ref":"#/components/schemas/GenericRestResource"
        }
    ]
}

Nested Schema : IdResource

Match All

Show Source

• object GenericRestResource
• object IdResource-allOf[1]

{
    "allOf":[
        {
            "$ref":"#/components/schemas/GenericRestResource"
        },
        {
            "type":"object",
            "properties":{
                "projectId":{
                    "type":"string"
                },
                "projectName":{
                    "type":"string"
                },
                "id":{
                    "type":"string"
                }
            }
        }
    ]
}

Nested Schema : GenericRestResource

Type: object

Show Source

• links: array links
• processing-time: number (float)

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Link"
            }
        },
        "processing-time":{
            "type":"number",
            "format":"float"
        }
    }
}

Nested Schema : IdResource-allOf[1]

Type: object

Show Source

• id: string
• projectId: string
• projectName: string

{
    "type":"object",
    "properties":{
        "projectId":{
            "type":"string"
        },
        "projectName":{
            "type":"string"
        },
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• media-type: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "media-type":{
            "type":"string"
        }
    }
}

Nested Schema : FilmstripRs

Type: object

Show Source

• code(required): string
• icon-url: string
• name(required): string
• role(required): string
• status: string

{
    "required":[
        "code",
        "name",
        "role"
    ],
    "type":"object",
    "properties":{
        "icon-url":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "role":{
            "type":"string"
        }
    }
}

Nested Schema : IntegrationPropRs

Type: object

Show Source

• current-value: string
• default-value: string
• name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "default-value":{
            "type":"string"
        },
        "current-value":{
            "type":"string"
        }
    }
}

Nested Schema : TrackingVariableTypeRs

Type: object

Show Source

• description: string
• id: string
• message-context-ref: object TrackingVariableTypeRs.ReferenceTypeRs
• name: string
• output: object TrackingVariableTypeRs.OutputWirepointTypeRs
• primary: boolean
• property: array property
• role: string
• sub-role: string
• xpath: string

{
    "type":"object",
    "properties":{
        "role":{
            "type":"string"
        },
        "sub-role":{
            "type":"string"
        },
        "primary":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "xpath":{
            "type":"string"
        },
        "message-context-ref":{
            "$ref":"#/components/schemas/TrackingVariableTypeRs.ReferenceTypeRs"
        },
        "property":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TrackingVariableTypeRs.PropertyTypeRs"
            }
        },
        "output":{
            "$ref":"#/components/schemas/TrackingVariableTypeRs.OutputWirepointTypeRs"
        },
        "id":{
            "type":"string"
        }
    }
}

Nested Schema : TrackingVariableTypeRs.ReferenceTypeRs

Type: object

Show Source

• property: array property
• ref-uri: string
• role: string
• sub-role: string

{
    "type":"object",
    "properties":{
        "role":{
            "type":"string"
        },
        "sub-role":{
            "type":"string"
        },
        "property":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/TrackingVariableTypeRs.PropertyTypeRs"
            }
        },
        "ref-uri":{
            "type":"string"
        }
    }
}

Nested Schema : TrackingVariableTypeRs.OutputWirepointTypeRs

Type: object

Show Source

• message-context-ref: object TrackingVariableTypeRs.ReferenceTypeRs
• name: string

{
    "type":"object",
    "properties":{
        "message-context-ref":{
            "$ref":"#/components/schemas/TrackingVariableTypeRs.ReferenceTypeRs"
        },
        "name":{
            "type":"string"
        }
    }
}

Nested Schema : property

Type: array

Show Source

• Array of: object TrackingVariableTypeRs.PropertyTypeRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TrackingVariableTypeRs.PropertyTypeRs"
    }
}

Nested Schema : property

Type: array

Show Source

• Array of: object TrackingVariableTypeRs.PropertyTypeRs

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/TrackingVariableTypeRs.PropertyTypeRs"
    }
}

Nested Schema : TrackingVariableTypeRs.PropertyTypeRs

Type: object

Show Source

• name: string
• value: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "value":{
            "type":"string"
        }
    }
}

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 shows how to activate/deactivate an integration in a project 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 integration HELLO_WORLD|01.02.0000 in the project TEST_PROJECT

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/projects/TEST_PROJECT/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: Update Integration property value of integration HELLO_WORLD|01.02.0000 in the project TEST_PROJECT

Updates the integration property of an integration by submitting a POST request on the REST resource.

Request

curl -X POST -H 'Authorization: Bearer access_token' -H "Content-Type:application/json" -H
      "X-HTTP-Method-Override:PATCH" -d @updateproperty.json https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/projects/TEST_PROJECT/integrations/HELLO_WORLD%7C01.02.0000?integrationInstance=service-instance

Request Body

The request body is the contents of the updateproperty.json file listed in the cURL command. The JSON file must contain the integration property name and value that you want to update.

{"properties":[{"name":"integration_property_1","currentValue":"1234"}]}

Back to Top