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

Retrieve an Integration

get

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

Retrieves detailed information about the integration with the specified ID.

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
  • Includes additional details in the response about connections in the integration or about the adapters for the connections. Valid values: connection, connection.adapter.
  • 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.

There's no request body for this operation.

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

Precondition failed

500 Response

Server error
Back to Top

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

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

Response Body:

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

{ 
          "apipId": "", 
          "code": "HELLO_WORLD", 
          "compatible": true, 
          "created": "2022-08-08T09:31:30.469+0000", 
          "createdBy": "exampleuser1@example.com", 
          "dependencies": {   
          "certificates": [   
               
          ],   
          "connections": [   
            {   
              "id": "MY_REST_ENDPOINT_INTERFAC",   
              "lockedFlag": false,   
              "name": "Sample REST Endpoint Interface",   
              "role": "SOURCE",   
              "status": "CONFIGURED",   
              "type": "rest",   
              "usage": 23   
            }   
          ],   
          "libraries": [   
               
          ],   
          "lookups": [   
               
          ] 
          }, 
          "description": "Example describing simple log and notification actions. Call the
          endpoint as,
          https://<host>:port>/ic/api/integration/v1/flows/rest/HELLO_WORLD/1.0/names/{name} OR
          https://<host>:<port>/ic/api/integration/v1/flows/rest/HELLO_WORLD/1.0/names/{name}?email={email.address}", 
          "endPoints": [   
          {   
            "connection": {   
              "agentRequired": false,   
              "agentSupported": false,   
              "id": "MY_REST_ENDPOINT_INTERFAC",   
              "links": [   
                {   
                  "href": "https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/connections/MY_REST_ENDPOINT_INTERFAC?integrationInstance=ins01-automation-l1-dt-dev-oicdevqa-px-pp",   
                  "rel": "self"   
                },   
                {   
                  "href": "https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/connections/MY_REST_ENDPOINT_INTERFAC?integrationInstance=ins01-automation-l1-dt-dev-oicdevqa-px-pp",   
                  "rel": "canonical"   
                }   
              ],   
              "metadataDownloadSupportedFlag": false,   
              "testStatus": false   
            },   
            "name": "helloWorld",   
            "role": "SOURCE"   
          } 
          ], 
          "id": "HELLO_WORLD|01.02.0000", 
          "isCloneAllowed": false, 
          "isViewAllowed": false, 
          "keywords": "", 
          "lastUpdated": "2022-08-08T09:31:30.971+0000", 
          "lastUpdatedBy": "exampleuser1@example.com", 
          "links": [   
          {   
            "href": "https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/integrations/HELLO_WORLD%7C01.02.0000?integrationInstance=ins01-automation-l1-dt-dev-oicdevqa-px-pp",   
            "rel": "self"   
          },   
          {   
            "href": "https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/integrations/HELLO_WORLD%7C01.02.0000?integrationInstance=ins01-automation-l1-dt-dev-oicdevqa-px-pp",   
            "rel": "canonical"   
          } 
          ], 
          "lockedFlag": false, 
          "name": "Hello World", 
          "packageName": "samples.oracle.helloworld", 
          "pattern": "Orchestration", 
          "patternDescription": "Map Data", 
          "payloadTracingEnabledFlag": false, 
          "percentageComplete": 100, 
          "projectType": "DEVELOPED", 
          "recordEnabledFlag": false, 
          "scheduleApplicableFlag": false, 
          "scheduleDefinedFlag": false, 
          "smartTags": "app:rest,style:app driven orchestration", 
          "status": "CONFIGURED", 
          "style": "FREEFORM", 
          "styleDescription": "Orchestration", 
          "tempCopyExists": false, 
          "totalEndPoints": 0, 
          "tracingEnabledFlag": false, 
          "trackingInstanceName": "name", 
          "trackingVariables": [   
          {   
            "role": "tracking_var_1",   
            "primary": true,   
            "name": "name",   
            "xpath": "/execute/TemplateParameters/name",   
            "messageContextRef": {   
              "property": [   
                   
              ],   
              "refUri": "messagecontext_15"   
            },   
            "property": [   
                 
            ],   
            "output": {   
              "messageContextRef": {   
                "property": [   
                     
                ],   
                "refUri": "messagecontext_1050"   
              },   
              "name": "output_1051"   
            }   
          },   
          {   
            "role": "tracking_var_2",   
            "primary": false,   
            "name": "tracking_var_2",   
            "xpath": "",   
            "messageContextRef": {   
              "property": [   
                   
              ],   
              "refUri": "messagecontext_15"   
            },   
            "property": [   
                 
            ],   
            "output": {   
              "messageContextRef": {   
                "property": [   
                     
                ],   
                "refUri": "messagecontext_1052"   
              },   
              "name": "output_1053"   
            }   
          },   
          {   
            "role": "tracking_var_3",   
            "primary": false,   
            "name": "tracking_var_3",   
            "xpath": "",   
            "messageContextRef": {   
              "property": [   
                   
              ],   
              "refUri": "messagecontext_15"   
            },   
            "property": [   
                 
            ],   
            "output": {   
              "messageContextRef": {   
                "property": [   
                     
                ],   
                "refUri": "messagecontext_1054"   
              },   
              "name": "output_1055"   
            }   
          } 
          ], 
          "version": "01.02.0000"}
Back to Top