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

Retrieve Packages

get

/ic/api/integration/v1/packages

Retrieves information about all packages ordered by the last updated time.

Request

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 packages 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 packages starting at the 4th item, and the list will contain 16 items.

  • Returns a filtered list of packages based on the specified parameters.

    Valid parameters:

    • name: Name of the package. Supports exact matches or contains. For example:
      • To retrieve packages that are an exact match in the package name, specify: 
        q={name:'PackageName'}
        .
      • To retrieve all packages that contain the specified string in the package name, specify: 
        q={name: /pack/}
    • type: type of package. Valid values: PREBUILT, DEVELOPED.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation
Body ()
Root Schema : PackagesRs
Type: object
Show Source
Nested Schema : items
Type: array
List of Packages
Show Source
Nested Schema : PackageRs
Type: object
Show Source
Nested Schema : integrations
Type: array
Integration List
Show Source
Nested Schema : IntegrationBaseResource
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 : IntegrationBaseResource-allOf[2]
Type: object
Show Source
Nested Schema : IntegrationDependencyRs
Type: object
Show Source
Nested Schema : filmstrip
Type: array
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 : FilmstripRs
Type: object
Show Source

400 Response

Malformed parameters

500 Response

Server error
Back to Top

Examples

The following examples show how to get details about packages 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 all packages

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

Example: Get only packages that contain myPack in the package name in any case

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

Example: Paginate through returned packages

Pagination is done with limit and offset. In this example, we list packages 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/packages?integrationInstance=service-instance

Example: Combine parameters to retrieve packages that contain a string, and paginate through the results

To combine query parameters, use q with the --data-urlencode option. The other parameters can be added after the -d option.

In this example, we are retrieving packages that contain myPack in uppercase or lowercase, and have the type DEVELOPED. 

curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" --data-urlencode "q={name: /myPack/, type:'DEVELOPED'}" -d "offset=3&limit=16" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/packages?integrationInstance=service-instance
Back to Top