Jump to

• Request
• Response
• Examples

Retrieve Libraries

get

/ic/api/integration/v1/libraries

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

Request

Supported Media Types

• application/json; charset=utf-8

Query Parameters

• 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/}

  • 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'}

Back to Top

Response

Supported Media Types

• application/json; charset=utf-8
• application/vnd.oracle.resource+json;type=collection

200 Response

Successful operation

Body ()

Root Schema : library

Type: object

Show Source

• hasMore: boolean
  Default Value: false
• id: string
• items: array items
• limit: integer(int32)
• links: array links
• totalResults: integer(int32)

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "id":{
            "type":"string"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LibraryTypeRs"
            }
        },
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "hasMore":{
            "type":"boolean",
            "default":false
        },
        "limit":{
            "type":"integer",
            "format":"int32"
        }
    },
    "xml":{
        "name":"library"
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object library

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LibraryTypeRs"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SuiteLink"
    }
}

Nested Schema : library

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "displayName":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "id":{
            "type":"string"
        },
        "lastUpdatedDate":{
            "type":"string",
            "format":"date-time"
        },
        "lastUpdatedBy":{
            "type":"string"
        },
        "createdDate":{
            "type":"string",
            "format":"date-time"
        },
        "createdBy":{
            "type":"string"
        },
        "libraryType":{
            "type":"string"
        },
        "calloutType":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "usage":{
            "type":"integer",
            "format":"int32"
        },
        "lockedFlag":{
            "type":"boolean",
            "default":false
        },
        "lockedBy":{
            "type":"string"
        },
        "lockedDate":{
            "type":"string",
            "format":"date-time"
        }
    },
    "xml":{
        "name":"library"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SuiteLink"
    }
}

Nested Schema : SuiteLink

Type: object

Show Source

• href: string
• mediaType: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

400 Response

Malformed parameters

500 Response

Server error

Back to Top

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

Back to Top