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

Retrieve Integrations in a Project

get

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

Retrieves information about all integrations in a project ordered by the last updated time.

Request

Path Parameters
Query Parameters
  • 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.
  • Use with the offset parameter for paginating through the returned results. The limit is the maximum number of items to return at one time. For example, offset=3&limit=16 indicates to list integrations starting at the 4th item, and the list will contain 16 items.
  • Use with the limit parameter for paginating through the returned results. The offset is the starting point from which to return records. For example, offset=3&limit=16 indicates to list integrations starting at the 4th item, and the list will contain 16 items.

  • Orders results by integration name or last updated time.

    Valid values:

    • name: Order integrations by integration name. Example: orderBy=name.
    • time: Order integrations by the last updated time. Example: orderBy=time.

  • Filters integrations by integration name, status, type, and integration style.

    Valid parameters:

    • name: Name of the integration. Supports exact matches or contains. For example:
      • To retrieve integrations that are an exact match in the integration name, specify: 
        q={name:'My Integration Name'}
      • To retrieve all integrations that contain the specified string in the integration name, specify: 
        q={name: /Oracle/}
    • status: Status of the integration. Valid values: ACTIVATED, CONFIGURED, INPROGRESS, FAILEDACTIVATION.

      For example, to retrieve all integrations that contain SC2RN and have the status configured, specify:

      {name : /SC2RN/, status : 'CONFIGURED'}
    • type: type of integration.

      Valid values: PREBUILT, CUSTOM, DEVELOPED.

    • style: Style of the integration. Valid values: 
      • freeform_mapmydata
        - Application-Driven Orchestrated Integration
      • freeform_scheduled
        - Scheduled Orchestration Integration
      • template_mapmydata
        - Basic Routing Map My Data Integration
      • template_subscribetooic
        - Subscribe to OIC Integration
      • template_publishtooic
        - Publish to OIC Integration

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : IntegrationsRs
Type: object
Show Source
Nested Schema : items
Type: array
List of Integrations
Show Source
Nested 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

400 Response

Malformed parameters

500 Response

Server error
Back to Top

Examples

The following example shows how to retrieve details about integrations in a project 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 integrations that contain SC2RN or sc2rn in the name and have the status CONFIGURED in the project TEST_PROJECT

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" --data-urlencode "q={name: /SC2RN/, status: 'CONFIGURED'}" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/projects/TEST_PROJECT/integrations?integrationInstance=service-instance

Example: Paginate through returned integrations in the project TEST_PROJECT

Pagination is done with limit and offset. In this example, we list integrations starting at the fourth item. The list contains 16 items.

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "offset=3&limit=16" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/projects/TEST_PROJECT/integrations?integrationInstance=service-instance

Example: Get integrations ordered by the integration name in alphabetical order in the project TEST_PROJECT

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "orderBy=name" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/projects/TEST_PROJECT/integrations?integrationInstance=service-instance

Example: Get all integrations in the project TEST_PROJECT

curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/projects/TEST_PROJECT/integrations?integrationInstance=service-instance
Back to Top