Retrieve Packages
/ic/api/integration/v1/packages
Request
- application/json; charset=utf-8
-
limit: integer(int32)
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.
-
offset: integer(int32)
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.
-
q: string
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/}
- To retrieve packages that are an exact match in the package name, specify:
- type: type of package. Valid values: PREBUILT, DEVELOPED.
- name: Name of the package. Supports exact matches or contains. For example:
Response
- application/json; charset=utf-8
- application/vnd.oracle.resource+json;type=collection
200 Response
object
-
hasMore:
boolean
Default Value:
false
-
items:
array items
-
limit:
integer(int32)
-
links:
array links
-
totalResults:
integer(int32)
object
-
bartaBuiltBy:
string
-
bartaType:
string
-
countOfIntegrations:
integer(int32)
-
id:
string
-
integrations:
array integrations
-
isCloneAllowed:
boolean
Default Value:
false
-
isViewAllowed:
boolean
Default Value:
false
-
links:
array links
-
name:
string
-
type:
string
object
-
code:
string
-
dependencies:
object IntegrationDependencyRs
-
id:
string
-
links:
array links
-
lockedFlag:
boolean
Default Value:
false
-
name:
string
-
pattern:
string
-
patternDescription:
string
-
scheduleApplicable:
boolean
Default Value:
false
-
scheduleDefined:
boolean
Default Value:
false
-
status:
string
-
style:
string
-
styleDescription:
string
-
version:
string
400 Response
500 Response
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://integration.us.oraclecloud.com/ic/api/integration/v1/packages
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://integration.us.oraclecloud.com/ic/api/integration/v1/packages
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://integration.us.oraclecloud.com/ic/api/integration/v1/packages
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://integration.us.oraclecloud.com/ic/api/integration/v1/packages