Deploy a library

Use this resource to deploy a library file (plugin or driver) to the INUBIT system.

Request

To deploy a library, send a PUT request to the endpoint defined below.

URL: /libraries

Method: PUT

Authorization: required (user with role System Administrator)

PUT /ibis/rest/libraries HTTP/1.1
Accept: multipart/form-data
Host: localhost:8080

Request Parameters

The following table lists the parameters for this request.

Name Description Required Allowed values

Name	Description	Required	Allowed values
`libraryFile`	Upload the library file.	yes	Any attachment
`libraryType`	Specify the type of the library.	yes	`Driver` or `Plugin`
`libraryFileName`	Enter the name of the library file.	yes	Any string

libraryFile

Upload the library file.

yes

Any attachment

libraryType

Specify the type of the library.

yes

Driver or Plugin

libraryFileName

Enter the name of the library file.

yes

Any string

Response

The response returns the result of the deployment operation.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "responsedata": "Successfully deployed : {Library filename}."
}

Errors

This request might return one of the following error codes:

Authorization Failed (401): Authorization with the given username and password failed. Please revisit both values and provide valid credentials.

<html>

    <head>
        <title>Status page</title>
    </head>

    <body style="font-family: sans-serif;">
        <p style="font-size: 1.2em;font-weight: bold;margin: 1em 0px;">Unauthorized</p>
        <p>The request requires user authentication</p>
        <p>You can get technical details <a
                href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2">here</a>.<br>
            Please continue your visit at our <a href="/">home page</a>.
        </p>
    </body>
</html>

Server Error (500): Execution on the INUBIT server failed. Have a look into the response message, otherwise access to the INUBIT log is required to retrieve further information.
Service Unavailable (503): In maintenance mode the INUBIT server endpoint will not respond to incoming requests but return this error response. Once the maintenance mode is switched off the endpoint will respond normally.