Retrieve Libraries
/ic/api/integration/v1/libraries
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 libraries 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 libraries starting at the 4th item, and the list will contain 16 items.
-
orderBy: string
Lists libraries ordered by name or last updated time.
Valid value:
- name: Order libraries by library name. Example: orderBy=name.
- time: Order libraries by the last updated time. Example: orderBy=time.
-
q: string
Filters libraries by name and type.
Valid parameters:
- name: Name of the the library. Supports contains only. For example:
- To retrieve all libraries that contain the specified string in the library name, specify:
q={name: /library/}
- To retrieve all libraries that contain the specified string in the library name, specify:
- type: Type of the library. Valid values: preinstalled, private.
For example, to retrieve all libraries that contain the string myLibrary and have the status preinstalled, specify:
q={name : /myLibrary/, type : 'preinstalled'}
- name: Name of the the library. Supports contains only. For example:
Response
- application/json; charset=utf-8
- application/vnd.oracle.resource+json;type=collection
200 Response
object
-
hasMore:
boolean
Default Value:
false
-
id:
string
-
items:
array items
-
limit:
integer(int32)
-
links:
array links
-
totalResults:
integer(int32)
object
-
calloutType:
string
-
code:
string
-
createdBy:
string
-
createdDate:
string(date-time)
-
description:
string
-
displayName:
string
-
id:
string
-
lastUpdatedBy:
string
-
lastUpdatedDate:
string(date-time)
-
libraryType:
string
-
links:
array links
-
lockedBy:
string
-
lockedDate:
string(date-time)
-
lockedFlag:
boolean
Default Value:
false
-
status:
string
-
usage:
integer(int32)
-
version:
string
400 Response
500 Response
Examples
The following examples show how to retrieve details about API libraries 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 only JavaScript libraries that contain myLibrary, mylibrary, or MYLIBRARY in the name and have the type preinstalled
curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" --data-urlencode "q={name: /myLibrary/, type: 'preinstalled'}" https://integration.us.oraclecloud.com/ic/api/integration/v1/libraries
Example: Paginate through returned libraries
Pagination is done with limit
and offset
. In this example, we list libraries 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/libraries
Example: Get libraries ordered by the library name in alphabetical order
curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" -d "orderBy=name" https://integration.us.oraclecloud.com/ic/api/integration/v1/libraries
Example: Combine parameters to retrieve libraries containing the text myLibrary in the name 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.
curl -G -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" --data-urlencode "q={name: /myLibrary/, type: 'private'}" -d "orderBy=name&offset=12&limit=5" https://integration.us.oraclecloud.com/ic/api/integration/v1/libraries
Example: Get all JavaScript libraries ordered by the last updated time
curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" https://integration.us.oraclecloud.com/ic/api/integration/v1/libraries