Jump to

• Request
• Response
• Examples

Retrieve a Library in a Project

get

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

Retrieves detailed information about the library in a project.

Request

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).
• projectId(required): string
  Project identifier

Query Parameters

• integrationInstance(required): string
  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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

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

200 Response

Successful operation

Body ()

Root Schema : LibraryTypeRs

Type: object

Show Source

• callout-type: string
  Callout Type
• code: string
  Library Code
• created-by: string
  Library Created By
• created-date: string (date-time)
  Library Created Date
• description: string
  Library Description
• display-name: string
  Library Name
• id: string
  Library Identifier
• last-updated-by: string
  Library Last Updated By
• last-updated-date: string (date-time)
  Library Last Updated Date
• library-type: string
  Library Type
• locked-by: string
  Locked By
• locked-date: string (date-time)
  Locked Date
• locked-flag: boolean
  Locked Flag
• project-id: string
• status: string
  Library Status
• usage: integer (int32)
  Library Usage
• version: string
  Library Version

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Library Status"
        },
        "last-updated-date":{
            "type":"string",
            "description":"Library Last Updated Date",
            "format":"date-time"
        },
        "last-updated-by":{
            "type":"string",
            "description":"Library Last Updated By"
        },
        "created-date":{
            "type":"string",
            "description":"Library Created Date",
            "format":"date-time"
        },
        "created-by":{
            "type":"string",
            "description":"Library Created By"
        },
        "library-type":{
            "type":"string",
            "description":"Library Type"
        },
        "callout-type":{
            "type":"string",
            "description":"Callout Type"
        },
        "id":{
            "type":"string",
            "description":"Library Identifier"
        },
        "code":{
            "type":"string",
            "description":"Library Code"
        },
        "display-name":{
            "type":"string",
            "description":"Library Name"
        },
        "version":{
            "type":"string",
            "description":"Library Version"
        },
        "description":{
            "type":"string",
            "description":"Library Description"
        },
        "usage":{
            "type":"integer",
            "description":"Library Usage",
            "format":"int32"
        },
        "locked-flag":{
            "type":"boolean",
            "description":"Locked Flag"
        },
        "locked-by":{
            "type":"string",
            "description":"Locked By"
        },
        "locked-date":{
            "type":"string",
            "description":"Locked Date",
            "format":"date-time"
        },
        "project-id":{
            "type":"string"
        }
    }
}

404 Response

Library 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 in a project 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 in the project TEST_PROJECT

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://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/projects/TEST_PROJECT/libraries/JSLIB%7C01.00.0000?integrationInstance=service-instance

Back to Top