Jump to

• Request
• Response

Update a Library

post

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

Replace the existing jar/js file.

Request

Supported Media Types

• multipart/form-data

Path Parameters

• id(required): string

Form Parameters

• file(required): file
  Library artifact file content

Back to Top

Response

Supported Media Types

• application/json; charset=utf-8

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

204 Response

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

400 Response

Malformed request parameters

409 Response

Library already exists

500 Response

Server error

Back to Top