Jump to

• Request
• Response
• Examples

Retrieve a Library

get

/ic/api/integration/v1/libraries/{id}

Retrieves detailed information about the library with the specified ID.

Request

Supported Media Types

• application/json; charset=utf-8

Path Parameters

• id(required): string
  Library identifier. The id must be added to the request in the following form: code%7Cversion. For example: JSLIB%7C01.00.0000. The %7C is the encoded | (vertical line).

Back to Top

Response

Supported Media Types

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

200 Response

Successful operation

Body ()

Root 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"
        }
    }
}

404 Response

Not found

412 Response

Precondition failed

500 Response

Server error

Back to Top

Examples

The following example shows how to get details about a JavaScript library 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 details about the library JSLIB|01.00.0000

The id is in the form: code%7Cversion. The %7C is the encoded | (vertical line).

curl -X GET -H 'Authorization: Bearer access_token' -H "Accept:application/json" https://integration.us.oraclecloud.com/ic/api/integration/v1/libraries/JSLIB%7C01.00.0000

Back to Top