API

Overview

Use the IBS-API in order to shadow files and other types of entites and to manage storages.

General Parameters

If a UUID is required as parameter, you can submit the uuid via

• url: /api/v1/entity/<uuid>
• parameter: /api/v1/entity?action=update&uuid=<uuid>

The action parameter:

• can be submitted as parameter: /api/entity?action=update
• can be submitted as HTTP-Verb:

method-override

If it is not possible to sent a DELETE-request, you can add "x-http-method-override" or "x-method-override" with the request-method to the header of the request. See also http://fandry.blogspot.com/2012/03/x-http-header-method-override-and-rest.html

authentication

If in "context.xml" of the webapplication the "appuser" and "apppw" are missing, these have to be transferred either

• via http-header "api-username" and "api-password"
• or via parameter "api-username" and "api-password" at each request.

Server-Options

In table "server" the following options can be set: