Jump to

• Request
• Response
• Examples

Update a Library in a Project

post

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

Replaces the existing jar or js file of a 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.

Supported Media Types

• multipart/form-data

Request Body - multipart/form-data ()

Root Schema : schema

Type: object

Show Source

• file: string (binary)
  Library artifact file content

{
    "type":"object",
    "properties":{
        "file":{
            "type":"string",
            "description":"Library artifact file content",
            "format":"binary"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json; charset=utf-8

200 Response

Successful operation

Body ()

Root Schema : LibraryRs

Type: object

Show Source

• has-more: boolean
  Flag to Check if More Records Exists
• items: array items
  List of Libraries
• limit: integer (int32)
  Limit of Records to be Displayed
• total-results: integer (int32)
  Total Results

{
    "type":"object",
    "properties":{
        "items":{
            "type":"array",
            "description":"List of Libraries",
            "items":{
                "$ref":"#/components/schemas/LibraryTypeRs"
            }
        },
        "total-results":{
            "type":"integer",
            "description":"Total Results",
            "format":"int32"
        },
        "has-more":{
            "type":"boolean",
            "description":"Flag to Check if More Records Exists"
        },
        "limit":{
            "type":"integer",
            "description":"Limit of Records to be Displayed",
            "format":"int32"
        }
    }
}

Nested Schema : items

Type: array

List of Libraries

Show Source

• Array of: object LibraryTypeRs

{
    "type":"array",
    "description":"List of Libraries",
    "items":{
        "$ref":"#/components/schemas/LibraryTypeRs"
    }
}

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

204 Response

Successful operation, no content sent, the Location header provides the newly created library uri

400 Response

Malformed parameters

409 Response

Library already exists

500 Response

Server error

Back to Top

Examples

The following example shows how to replace jar/js file of a library in a project by submitting a POST 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: Update a Library in the project TEST_PROJECT

This example replaces the js file for the library JSLIB|01.00.0000. The id is code%7Cversion and the %7C is the encoded | (vertical line).

curl -X POST -H 'Authorization: Bearer access_token' -H "Content-Type:multipart/form-data" -F "file=@concat.js" https://design.integration.region.ocp.oraclecloud.com/ic/api/integration/v1/projects/TEST_PROJECT/libraries/JSLIB%7C01.00.0000/archive?integrationInstance=service-instance

Back to Top