SEAL Operator REST API

Base URL: /v1, Version: 0.5

This is the REST API of the SEAL Operator System. It is used by the graphical front and may also be used for integration purposes.

Default request content-types: application/json

Default response content-types: application/json

Schemes: https

Summary

Tag: Services

Operation	Description
GET /services	Get list of available services
GET /services/{sid}	Retrieve service metadata

Tag: Documents

Operation	Description
GET /services/{sid}/repo	Access the document repository within a service
POST /services/{sid}/repo	Create new entry in the root collection of the repository.
POST /services/{sid}/repo/command	Create new command resource.
GET /services/{sid}/repo/command/{cid}	Access a command resource within a service
GET /services/{sid}/repo/{uuid}	Retrieve metadata of a specific entry (document or collection).
PUT /services/{sid}/repo/{uuid}	Update entry metadata (complete, replace)
PATCH /services/{sid}/repo/{uuid}	Update entry metadata (partial, merge)
DELETE /services/{sid}/repo/{uuid}	Delete the current entry.
GET /services/{sid}/repo/{uuid}/content	Retrieve binary content (documents only)
PUT /services/{sid}/repo/{uuid}/content	Create or update document binary content (documents only)
DELETE /services/{sid}/repo/{uuid}/content	Delete document binary content (documents only)
GET /services/{sid}/repo/{uuid}/preview	Retrieve preview of binary content (documents only)

Tag: Collections

Operation	Description
GET /services/{sid}/repo	Access the document repository within a service
POST /services/{sid}/repo	Create new entry in the root collection of the repository.
POST /services/{sid}/repo/command	Create new command resource.
GET /services/{sid}/repo/command/{cid}	Access a command resource within a service
GET /services/{sid}/repo/{uuid}	Retrieve metadata of a specific entry (document or collection).
PUT /services/{sid}/repo/{uuid}	Update entry metadata (complete, replace)
PATCH /services/{sid}/repo/{uuid}	Update entry metadata (partial, merge)
POST /services/{sid}/repo/{uuid}	Create a new entry in the current collection (collections only).
DELETE /services/{sid}/repo/{uuid}	Delete the current entry.
GET /services/{sid}/repo/{uuid}/children	Access a collections children.

Tag: Tasks

Operation	Description
GET /tasks	Retrieve collection of tasks managed by all services.
GET /services/{sid}/tasks	Retrieve collection of tasks managed by the service.
POST /services/{sid}/tasks	Create new task.
GET /services/{sid}/tasks/{tid}	Retrieve metadata of current task.
PUT /services/{sid}/tasks/{tid}	Update task metadata (complete, replace)
PATCH /services/{sid}/tasks/{tid}	Update Task metadata (partial, merge)
DELETE /services/{sid}/tasks/{tid}	Delete a Task.
POST /services/{sid}/tasks/{tid}/action	Trigger an action
GET /services/{sid}/tasks/{tid}/input	Retrieve list of task input items
PUT /services/{sid}/tasks/{tid}/input	Update input list metadata (complete, replace)
PATCH /services/{sid}/tasks/{tid}/input	Update input list metadata (partial, merge)
POST /services/{sid}/tasks/{tid}/input	Append a new item to the input list of the task.
GET /services/{sid}/tasks/{tid}/input/{id}	Retrieve task item details
PUT /services/{sid}/tasks/{tid}/input/{id}	Update the current task input list item (complete, replace)
PATCH /services/{sid}/tasks/{tid}/input/{id}	Update a task input list item (partial, merge)
DELETE /services/{sid}/tasks/{tid}/input/{id}	Delete a task input list item
GET /services/{sid}/tasks/{tid}/output	Retrieve list of task output items
GET /services/{sid}/tasks/{tid}/output/{id}	Retrieve task output list item details

Tag: Lists

Operation	Description
GET /lists	Get collection of available Lists.
POST /lists	Create new List
GET /lists/{lid}	Retrieve metadata for the current List.
PUT /lists/{lid}	Update List metadata (complete, replace)
PATCH /lists/{lid}	Update List metadata (partial, merge)
DELETE /lists/{lid}	Delete the current list
GET /lists/{lid}/items	Get List items.
POST /lists/{lid}/items	Appended and item to the list.
GET /lists/{lid}/items/{id}	Retrieve item data of the current list element
PUT /lists/{lid}/items/{id}	Update current list item (complete, replace)
PATCH /lists/{lid}/items/{id}	Update current list item (partial, merge)
DELETE /lists/{lid}/items/{id}	Remove the current element from the list

Tag: Panels

Operation	Description
GET /ui	Retrieve list of default UI panels available to the user.
GET /ui/{pid}	Retrieve the default configuration of a UI panel.
GET /panels	Retrieve list of UI panels available to the user.
POST /panels	Save a (user-specific) panel configuration.
GET /panels/{pid}	Retrieve a specific panel configuration
PUT /panels/{pid}	Updates a saved panel configuration
DELETE /panels/{pid}	Delete a stored panel configuration

Tag: Configuration

Operation	Description
GET /config	Access a configuration item or path
PUT /config	Store a configuration item
DELETE /config	Delete a configuration item

Tag: Messages

Operation	Description
GET /messages	Access the users messages
POST /messages	Create new message entry.
PATCH /messages/{uuid}	Update a message entry.

Tag: Functions

Operation	Description
GET /services/{sid}/function	List connector specific functions
POST /services/{sid}/function/{fid}	Access a connector specific function

Tag: Sessions

Operation	Description
GET /sessions	Get session information

Security

oauth

Type: oauth2

Flow:: accessCode
AuthorizationUrl:: https://your.auth.host/your/auth/path
TokenUrl:: https://your.auth.host/your/token/path
Scopes:: authN: User is authenticated

Paths

Delete a configuration item

DELETE /config

Tags: Configuration

Deletes a single ConfigItem at the given path or all ConfigItems in the whole tree below if path does not point to an actual item.


path	Path/to/config/item	query	string

Uses default content-types: application/json

200 OK: OK, configuration deleted.

ConfigItem
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. User lacks access rights to change configuration. schema: $ref: '#/definitions/Error'
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error

Access a configuration item or path

GET /config

Tags: Configuration

Use this route to browse the configuration. Configuration is structured unix file-system like, in a path/to/item way. Use path/to/item as 'path' parameter to access a specific item or together with 'keys' parameter for retrieving only keys.

path

Path/to/config/item

query

string

keys

Return an array of strings containing all recursively fetched keys below the given 'path'. Without or an empty 'path' all available keys are returned.

Example response:

[
"key1",
"path/to/key2",
"some/other/path/to/key3"
]

query

boolean

Uses default content-types: application/json

200 OK

OK, configuration items returned.

string

Valid configuration key

401 Unauthorized

Unauthorized (Auth token invalid)

Error

403 Forbidden

Forbidden. The user lacks rights to access the data.

Error

404 Not Found

The given ConfigItem was not found.

Error

500 Internal Server Error

Application Error

Error

default

Unexpected error

Error

Store a configuration item

PUT /config

Tags: Configuration

Stores the ConfigItem in the request body at the given path.

Uses default content-types: application/json

ConfigItem


path	Path/to/config/item	query	string

Uses default content-types: application/json

200 OK: OK, configuration stored.

ConfigItem
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. User lacks access rights to change configuration. schema: $ref: '#/definitions/Error'
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error

Get collection of available Lists.

GET /lists

Tags: Lists

This is the list of Lists of the authenticated user. Use metadata property names and regular expressions in URL query string to search for entries and the offset and limit parameters to control the number of results returned.


offset	Index of first result to return.	query	integer
limit	Number of results to return. Maximum is 500.	query	integer 50
sort	Sort query results. Comma separated list of property names, prefixed with '-' for descending sort order. Example: 'sort=date,-name'	query	string
embed	Include information about collection members. "items": Include item data "permissions": User access rights on each List "metadata": Return list of lists metadata. Example: `{ exportTypes: [{ name: 'csv', description: 'Export a CSV file', mimeType: 'text/csv' }], importTypes: [{ name: 'csv', description: 'Import a CSV file', mimeType: 'text/csv' }] }`	query	string

Uses default content-types: application/json

200 OK: OK, collection of lists is returned.

List
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: No lists available

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Create new List

POST /lists

Tags: Lists

Creates a new entry in the list of Lists. The Content-Type HTTP header defines the format of the import data. Default is JSON. If a URL is given in query as parameter href the list to import is retrieved from that URL.

Uses default content-types: application/json

metadata of the document list to create.

List


href	URL of the list to add. Example: `http://somehost:3456/path/to/mylist.csv`	query	string

Uses default content-types: application/json

200 OK: OK, list created. List metadata returned.

List
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
409 Conflict: Conflict, resource could not be created. See error message for details.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Delete the current list

DELETE /lists/{lid}

Tags: Lists

Deletes the current list inclusive all it's items, but not the documents.


lid	ID of the current list.	path	string

Uses default content-types: application/json

204 No Content: OK, list removed.
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: Not found

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Retrieve metadata for the current List.

GET /lists/{lid}

Tags: Lists

This is the root record for a given list. It contains List-level metadata. Use the 'embed' parameter to include information about sub-ressource like items or access rights. The client controls the exported data format with the Accept HTTP header field. Default is JSON.

lid

ID of the current list.

path

string

embed

Include information about collection members or sub-ressources.

"items": Include item data
"permissions": Include user access rights for the current user.

query

string

Uses default content-types: application/json

200 OK: OK, metadata is returned.

List
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: Not found

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Update List metadata (partial, merge)

PATCH /lists/{lid}

Tags: Lists

Updates or adds part of the List metadata. Only given metadata will be replaced or added, no metadata will be removed. Note that only List metadata can be updated; internal auto-generated metadata (links, embedded), if present, are ignored.

Uses default content-types: application/json

New Metadata for the list

List


lid	ID of the current list.	path	string

Uses default content-types: application/json

200 OK: OK, document list updated. New metadata returned.

List
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: Not found

Error
409 Conflict: Conflict, resource could not be updated. See error message for details.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Update List metadata (complete, replace)

PUT /lists/{lid}

Tags: Lists

This will completely replace the existing List metadata (if any) by the given metadata. Note that only List metadata itself can be updated. Internal auto-generated metadata (links; embedded), if present, are ignored.

Uses default content-types: application/json

New Metadata for the list

List


lid	ID of the current list.	path	string

Uses default content-types: application/json

200 OK: OK, document list updated. New metadata returned.

List
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: Not found

Error
409 Conflict: Conflict, resource could not be updated. See error message for details.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Get List items.

GET /lists/{lid}/items

Tags: Lists

This is the collection of items currently in the List. For performance reasons, only references are returned by default. Use metadata property names and regular expressions in URL query string to search for entries and the offset and limit parameters to control the number of results returned.


lid	ID of the current list.	path	string
offset	Index of first result to return.	query	integer
limit	Number of results to return. Maximum is 500.	query	integer 50
sort	Sort query results. Comma separated list of property names, prefixed with '-' for descending sort order. Example: 'sort=href,-index'	query	string
embed	Sub-ressources to include in the response. "items": Include metadata for each List "permissions": Include user access rights	query	string

Uses default content-types: application/json

200 OK: OK, collection of list items is returned.

ListItem
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: Not found

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Appended and item to the list.

POST /lists/{lid}/items

Tags: Lists

Lists are are ordered sets, items have consecutive indices (0..n). Posting this route will append a new item to the List.

Uses default content-types: application/json

Use EITHER href OR item. If both are present, item is used.

ListItem


lid	ID of the current list.	path	string
href	Relative URL of the document instance to add to the list	query	string

Uses default content-types: application/json

200 OK: OK, document reference has been added to the list.

ListItem
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: Not found

Error
409 Conflict: Conflict, resource could not be created. See error message for details.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Remove the current element from the list

DELETE /lists/{lid}/items/{id}

Tags: Lists

Deletes an entry from a list. Only the list entry is removed, not the document. Note that id is NOT the index of an item in the List. The index is part of item metadata.


lid	ID of the current list.	path	string
id	ID of the current element.	path	string

Uses default content-types: application/json

204 No Content: OK, list element removed.
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: Not found

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Retrieve item data of the current list element

GET /lists/{lid}/items/{id}

Tags: Lists

Get metadata record of a list item. Note that the 'id' is NOT the index, which is part of item metadata.


lid	ID of the current list.	path	string
id	ID of the current element.	path	string

Uses default content-types: application/json

200 OK: OK, List item data is returned

ListItem
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: Not found

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Update current list item (partial, merge)

PATCH /lists/{lid}/items/{id}

Tags: Lists

Update the metadata record of the current list item, adding missing entries but removing nothing. Note that the ID is NOT the index of the item in the list. The index is part of item metadata.

Uses default content-types: application/json

New link data to replace existing entry. Use EITHER item OR href; if both are present, item is used.

ListItem


lid	ID of the current list.	path	string
id	ID of the current element.	path	string
href	Relative URL of document to link. This is a convenient way of just updating the href property of the existing List item.	query	string

Uses default content-types: application/json

200 OK: OK, List item is updated, item data returned

ListItem
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: Not found

Error
409 Conflict: Conflict, resource could not be updated. See error message for details.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Update current list item (complete, replace)

PUT /lists/{lid}/items/{id}

Tags: Lists

Update and replace the entire metadata record of the current list item. Note that the ID is NOT the index of the item in the List. The index is part of item metadata.

Uses default content-types: application/json

New item data to replace existing entry

ListItem


lid	ID of the current list.	path	string
id	ID of the current element.	path	string

Uses default content-types: application/json

200 OK: OK, List item is updated, item data returned

ListItem
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: Not found

Error
409 Conflict: Conflict, resource could not be updated. See error message for details.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Access the users messages

GET /messages

Tags: Messages

Every user has his own list of messages containing info, warning and error messages of various panels and actions. The messages are stored on server until they expire. This route provides access to the messages. Use property names and regular expressions in URL query string to search for entries and the offset and limit parameters to control the number of results returned.


offset	Index of first result to return.	query	integer
limit	Number of results to return. Maximum is 500.	query	integer 25
sort	Sort query results. Comma separated list of property names, prefixed with '-' for descending sort order. Example: 'sort=date,-type'	query	string

Uses default content-types: application/json

200 OK: OK, list of entries is returned.

Message
401 Unauthorized: Unauthorized (Auth token invalid)

Error
404 Not Found: The service does not provide messages

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Create new message entry.

POST /messages

Tags: Messages

Creates a new record in the message list and assigns the posted data. The server adds a uuid and a creation date to each entry if not already present.

Uses default content-types: application/json

metadata of the entry to be created

PostMessage

Uses default content-types: application/json

200 OK: OK, entry created. Entry metadata returned.

Message
401 Unauthorized: Unauthorized (Auth token invalid)

Error
404 Not Found: The service does not provide messages

Error
409 Conflict: Conflict, ressource could not be created. See error message for details.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Update a message entry.

PATCH /messages/{uuid}

Tags: Messages

Update a message entry. Only data given with the patch will be changed/added; no entries removed. Updating uuid and creation date is prohibited.

Uses default content-types: application/json

metadata of the entry to be created

Message


uuid	ID of the message entry	path	string

Uses default content-types: application/json

200 OK: OK, message entry updated, new message returned.

Message
401 Unauthorized: Unauthorized (Auth token invalid)

Error
404 Not Found: The service does not provide messages

Error
409 Conflict: Conflict, ressource could not be created. See error message for details.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Retrieve list of UI panels available to the user.

GET /panels

Tags: Panels

The SEAL Operator user interface provides the user with a set of panels to use. A GET call to this route returns a list of user defined panels available to the current user. User-defined configurations can be stored using a POST request; these can also be edited and deleted later.

Uses default content-types: application/json

200 OK: OK, list of UI panel configurations returned.

ConfigItem
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Save a (user-specific) panel configuration.

POST /panels

Tags: Panels

Users can save panel configurations they intend to (re-)use in later sessions under a name. If the ConfigItem does not contain a "name" key, a name for the configuration will be auto-generated.

Uses default content-types: application/json

ConfigItem containing the configuration to store.

ConfigItem

Uses default content-types: application/json

200 OK: OK, configuration was saved. The returned configItem contains the generated ID.

ConfigItem
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
409 Conflict: Conflict. A panel configuration under the "name" given in the ConfigItem already exists.
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Delete a stored panel configuration

DELETE /panels/{pid}

Tags: Panels

User-defined panel configurations can be delete by a DELETE request to this route.


pid	ID of the panel configuration to remove.	path	string

Uses default content-types: application/json

200 OK: OK, panel configuration was deleted, return deleted configuration.

ConfigItem
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The current user lacks access rights, or is trying to delete a read-only default configuration. schema: $ref: '#/definitions/Error'
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Retrieve a specific panel configuration

GET /panels/{pid}

Tags: Panels

Returns a ConfigItem containing configuration for a stored panel.


pid	ID of the panel	path	string

Uses default content-types: application/json

200 OK: OK, configuration returned.

ConfigItem
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: Not found. The given pid is unknown.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Updates a saved panel configuration

PUT /panels/{pid}

Tags: Panels

A PUT request to a panel configuration will replace the entire stored configuration with the one contained in the request body. It's possible to use a different value for the "name" key in order to rename the saved configuration; however, the new name must not be in use. Note that only user-defined panel configurations can be updated.

Uses default content-types: application/json

ConfigItem containing the configuration to store.

ConfigItem


pid	ID of the panel	path	string

Uses default content-types: application/json

200 OK: OK, configuration updated.

ConfigItem
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The current user lacks access rights, or is trying to update a read-only default configuration. schema: $ref: '#/definitions/Error'
409 Conflict: Conflict. A panel configuration under the "name" given in the ConfigItem already exists.
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Get list of available services

GET /services

Tags: Services

A GET call to this route will return a list of active services currently available through the API.

Uses default content-types: application/json

200 OK: OK, collection of services is returned.

Service
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks acces rights to access the service list.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Retrieve service metadata

GET /services/{sid}

Tags: Services

FIXME


sid	ID of the current service.	path	string

Uses default content-types: application/json

200 OK: OK, service metadata is returned

Service
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks acces rights to access the service metadata.

Error
404 Not Found: The requested Service was not found.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

List connector specific functions

GET /services/{sid}/function

Tags: Functions

For panels static configuration data is sometimes not sufficient, dynamically retrieved data from the backend system is needed. The function routes allows the connector to make dynamic data and functionality available to the client. The function routes are synchronous calls in contrary to the asynchronous commands. This route returns all supported functions.


sid	ID of the current repository.	path	string

Uses default content-types: application/json

200 OK: OK, list of entries is returned.

Functions
401 Unauthorized: Unauthorized (Auth token invalid)

Error
404 Not Found: The service does not provide functions

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Access a connector specific function

POST /services/{sid}/function/{fid}

Tags: Functions

This route triggers a connector specific function and returns the result. The function routes are synchronous calls in contrary to the asynchronous commands.

sid

ID of the current repository.

path

string

fid

Name of the function to calls

path

string

params

String with a list of function specific parameter as key value pairs. Syntax:

params="key::value[;key::value]*"

query

string

Uses default content-types: application/json

200 OK: OK, function result is returned.
401 Unauthorized: Unauthorized (Auth token invalid)

Error
404 Not Found: The service does not provide this function

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Access the document repository within a service

GET /services/{sid}/repo

Tags: Documents, Collections

Some services (not all) expose access to documents. All documents available through a Service are accessible via the 'repo' route. This route provides access to the repository root collection, containing documents and/or child collections. Use metadata property names and regular expressions in URL query string to search for entries (documents or collections) and the offset and limit parameters to control the number of results returned.


sid	ID of the current repository.	path	string
offset	Index of first result to return.	query	integer
limit	Number of results to return. Maximum is 500.	query	integer 50
sort	Sort query results. Comma separated list of property names, prefixed with '-' for descending sort order. Example: 'sort=date,-name'	query	string
scope	Set the scope when searching for documents. Possible values are `root` and `all`, default is `all`.	query	string all
embed	Include sub-ressource or sub-collection data in response. "permissions": include access rights records for each entry. "thumb": include base64 encoded thumbnail image for each entry, e.g. `"embedded": { "content-type": "image/png" "thumb": "A9cX0..." }`	query	string

Uses default content-types: application/json

200 OK: OK, collection of entries is returned.

RepoEntry
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: The service does not provide a repository

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Create new entry in the root collection of the repository.

POST /services/{sid}/repo

Tags: Documents, Collections

Creates a new record in the current Repository, inside the root collection, and assigns the posted metadata.

Uses default content-types: application/json

metadata of the entry to be created

BaseRepoEntry


sid	ID of the current service.	path	string

Uses default content-types: application/json

200 OK: OK, entry created. Entry metadata returned.

RepoEntry
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: The service does not provide a repository

Error
409 Conflict: Conflict, ressource could not be created. See error message for details.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Create new command resource.

POST /services/{sid}/repo/command

Tags: Documents, Collections

Creates a new record in the command resource. It returns a JSON object containing a command id for tracking status of asynchronous commands.

Uses default content-types: application/json

The command entry and it's parameter to be created. Currently supported commands are copy and move. The parameters for both commands:

{
  "action": "copy|move",
  "parameter": {
    "source": "source href",
    "parent": "uuid of target parent"
  }
}

The source may be a remote repository in later implementations, so an href is needed here.

Command


sid	ID of the current service.	path	string

Uses default content-types: application/json

200 OK: OK, entry created. Command id will be returned.

CommandStatus
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: The service does not provide commands

Error
409 Conflict: Conflict, ressource could not be created. See error message for details.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Access a command resource within a service

GET /services/{sid}/repo/command/{cid}

Tags: Documents, Collections

Returns a JSON object containing the status of the command. Command resources are automatically deleted after a final state (success or failure) was delivered once to the client or it's expired.


sid	ID of the current service.	path	string
cid	ID of the command.	path	string

Uses default content-types: application/json

200 OK: OK, status of command resource is returned

CommandStatus
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: The service does not provide the given resource.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Delete the current entry.

DELETE /services/{sid}/repo/{uuid}

Tags: Documents, Collections

Removes the current entry from the repository. This will not only remove the reference within Operator, but the actual record and content in the target system.


sid	ID of the current Service.	path	string
uuid	UUID of the entry to delete	path	string
force	Delete document even if it's still in use by one or more tasks.	query	boolean

Uses default content-types: application/json

204 No Content: OK, entry was deleted.
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden (deletion refused by target system)

Error
404 Not Found: Entry under 'uuid' was not found.

Error
409 Conflict: Conflict, resource could not be deleted. Returns collection of tasks using the current document.

Task
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Retrieve metadata of a specific entry (document or collection).

GET /services/{sid}/repo/{uuid}

Tags: Documents, Collections

Given a 'uuid' parameter, this route retrieves an entry's metadata. The entry may be either a document or a collection.


sid	ID of the current service.	path	string
uuid	ID of the repository entry	path	string

Uses default content-types: application/json

200 OK: OK, entry metadata returned.

RepoEntry
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: The given uuid was not found.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Update entry metadata (partial, merge)

PATCH /services/{sid}/repo/{uuid}

Tags: Documents, Collections

Update the given entry's metadata. Only data given with the patch will be changed/added; no entries removed. Only core metadata can be updated; internal auto-generated metadata (links, embedded), if given, are ignored.

Uses default content-types: application/json

New entry metadata.

BaseRepoEntry


sid	ID of the current service.	path	string
uuid	UUID of the entry	path	string

Uses default content-types: application/json

200 OK: OK, entry metadata replaced, new metadata returned.

RepoEntry
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: No entry found at the given 'uuid'.

Error
409 Conflict: Conflict, resource could not be updated. See error message for details.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Create a new entry in the current collection (collections only).

POST /services/{sid}/repo/{uuid}

Tags: Collections

If the entry under the given uuid is a collection, then a POST request to this route will create a new entry in this collection. Whether the created entry will be a document or another collection depends on the metadata enclosed in the request body. See RepoEntry data model.

Uses default content-types: application/json

Metadata of the entry to create

BaseRepoEntry


sid	ID of the current Service.	path	string
uuid	UUID of the collection	path	string

Uses default content-types: application/json

200 OK: OK, new entry created, metadata of the entry returned.

RepoEntry
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: No entry found at the given 'uuid'.

Error
405 Method Not Allowed: Method not allowed. The entry under 'uuid' is not a collection.

Error
409 Conflict: Conflict, resource could not be updated. See error message for details.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Update entry metadata (complete, replace)

PUT /services/{sid}/repo/{uuid}

Tags: Documents, Collections

Completely replace the metadata record of the given entry. Only record metadata can be replaced; internal auto-generated metadata (links, embedded), if given, are ignored.

Uses default content-types: application/json

New entry metadata. Note that changing the entry type is not possible by updating metadata.

BaseRepoEntry


sid	ID of the current repository.	path	string
uuid	UUID of the entry	path	string

Uses default content-types: application/json

200 OK: OK, entry metadata replaced, new metadata returned.

RepoEntry
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: No entry found under the given 'uuid'.

Error
409 Conflict: Conflict, resource could not be updated. See error message for details.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Access a collections children.

GET /services/{sid}/repo/{uuid}/children

Tags: Collections

Some services (not all) expose access to documents. All documents available through a Service are accessible via the 'repo' route. This route provides access to the children of a collection, containing documents and/or collections. Use metadata property names and regular expressions in URL query string to search for entries (documents or collections) ae offset and limit parameters to control the number of results returned.


sid	ID of the current repository.	path	string
uuid	UUID of the parent collection	path	string
offset	Index of first result to return.	query	integer
limit	Number of results to return. Maximum is 500.	query	integer 50
sort	Sort query results. Comma separated list of property names, prefixed with '-' for descending sort order. Example: 'sort=date,-name'	query	string
embed	Include sub-ressource or sub-collection data in response. "permissions": include access rights records for each entry. "icon": include icon-font and value for each entry, e.g. `"embedded": { "icon": "material:play" }` "thumb": include base64 encoded thumbnail image for each entry, e.g. `"embedded": { "content-type": "image/png" "thumb": "A9cX0..." }`	query	string

Uses default content-types: application/json

200 OK: OK, collection of entries is returned.

RepoEntry
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: The service does not provide a repository

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Delete document binary content (documents only)

DELETE /services/{sid}/repo/{uuid}/content

Tags: Documents

Deletes the binary content of a document, leaving metadata only. Note that some repositories will not allow this operation. To delete binary content from such repositories, you will need to delete the entire document. Deleting binary content is not supported by collection type entries.


sid	ID of the current service.	path	string
uuid	UUID of the document	path	string

Uses default content-types: application/json

204 No Content: OK, content was deleted.
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks acces rights to delete the binary content.

Error
404 Not Found: No binary content found.

Error
405 Method Not Allowed: Method not allowed. Either the entry under 'uuid' is not a document, or it does not support deleting of the binary content. See error message for details.

Error
409 Conflict: Conflict, resource could not be deleted. Returns collection of tasks using the current document.

Task
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Retrieve binary content (documents only)

GET /services/{sid}/repo/{uuid}/content

Tags: Documents

If the entry under 'uuid' is a document, then this route provides access to the binary content (i.e. the actual file).


sid	ID of the current Service.	path	string
uuid	UUID of the document	path	string

application-octed/stream

200 OK: OK, content is returned.
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks acces rights to read the binary content.

Error
404 Not Found: Not found. Either no entry was found under the given 'uuid', or the entry is not a document, or the document has no binary content (yet). See error message for details.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Create or update document binary content (documents only)

PUT /services/{sid}/repo/{uuid}/content

Tags: Documents

Upload binary content of a document. Create if none exists, or replace existing file. Uploading binary content to collection type entries is not supported.

multipart/form-data


sid	ID of the current service.	path	string
uuid	UUID of the document	path	string
content	binary data for upload	formData	file

Uses default content-types: application/json

204 No Content: OK, content was updated.
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks acces rights to update the binary content.

Error
404 Not Found: No entry was found under the given 'uuid'.

Error
406 Not Acceptable: Method not allowed. The entry under 'uuid' is not a document, or the document does not support changing of the bianry content.

Error
409 Conflict: Conflict, resource could not be updated. See error message for details.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Retrieve preview of binary content (documents only)

GET /services/{sid}/repo/{uuid}/preview

Tags: Documents

If the entry under 'uuid' is a document, then this route provides access to the preview content.


sid	ID of the current Service.	path	string
uuid	UUID of the document	path	string

image/jpeg

200 OK: OK, preview is returned.
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks acces rights to read the binary content.

Error
404 Not Found: Not found. Either no entry was found under the given 'uuid', or the entry is not a document, or the document has no binary content, or the preview is not created (so far). See error message for details.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Retrieve collection of tasks managed by the service.

GET /services/{sid}/tasks

Tags: Tasks

This route provides access to the root collection of known tasks for the current service. Use property names and regular expressions in URL query string to search for tasks and the offset and limit parameters to control the number of results returned. Use the 'embed' parameter to include information about instances and sub-ressources.


sid	ID of the Service managing the tasks	path	string
offset	Index of first result to return.	query	integer
limit	Number of results to return. Maximum is 500.	query	integer 50
sort	Sort query results. Comma separated list of property names, prefixed with '-' for descending sort order. Example: 'sort=date,-name'	query	string
inputDocument	A document UUID queried for in all lists of input documents of all tasks.	query	string
embed	Information about sub-collections and/or sub-ressources to include in the response. "permissions": include user access rights for each Task "metadata": include Task metadata. "input": include input lists (metadata only) "output": include output lists (metadata only) "cstats": connector specific job id's and states	query	string
inlineCount	Return a JSON object containing the number of tasks found, according to the query parameters, instead of an array with tasks.	query	boolean

Uses default content-types: application/json

200 OK

OK, collection of tasks or count is returned. Example for count:

{
  count: 0
}

Task

401 Unauthorized

Unauthorized (Auth token invalid)

Error

403 Forbidden

Forbidden. The user lacks rights to access the data.

Error

404 Not Found

Not found

Error

500 Internal Server Error

Application Error

Error

default

Unexpected error

Error


oauth	authN

Create new task.

POST /services/{sid}/tasks

Tags: Tasks

Adds a new Task to the collection. Given metadata is assigned, input list must be filled after creation.

Uses default content-types: application/json

Task metadata

Task


sid	ID of the Service managing the current Task	path	string

Uses default content-types: application/json

200 OK: OK, task created. Task metadata returned.

Task
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: Not found

Error
409 Conflict: Conflict, resource could not be created. See error message for details.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Delete a Task.

DELETE /services/{sid}/tasks/{tid}

Tags: Tasks

Deletes a Task from the collection. This is only possible if the Task is not currently active and if the user has sufficient access rights.


sid	ID of the Service managing the current Task	path	string
tid	ID of the Task to delete.	path	string

Uses default content-types: application/json

204 No Content: OK. Task deleted.
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: Not found

Error
409 Conflict: Conflict. Task cannot be deleted because it is currently active.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Retrieve metadata of current task.

GET /services/{sid}/tasks/{tid}

Tags: Tasks

This route provides access to a Task's root record. The record contains taks metadata (such as parameters controlling it), details are available via sub-ressources and sub-collections.


sid	ID of the Service managing the current Task	path	string
tid	ID of the current task.	path	string
embed	Embed sub-ressources in the response. "input": include list of input documents "output": include list of output documents	query	string
force	Force status update from backend system.	query	boolean

Uses default content-types: application/json

200 OK: OK. Task metadata returned.

Task
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: Not found

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Update Task metadata (partial, merge)

PATCH /services/{sid}/tasks/{tid}

Tags: Tasks

Does a partial update to the Task metadata. Given metadata replaces existing one, or is added to the record if not yet present. No metadata is deleted.

Uses default content-types: application/json

New metadata for the task

TaskMetadata


sid	ID of the Service managing the current Task	path	string
tid	ID of the Task to update.	path	string

Uses default content-types: application/json

200 OK: OK, task updated and returned.

Task
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: Not found

Error
409 Conflict: Conflict, resource could not be updated. See error message for details.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Update task metadata (complete, replace)

PUT /services/{sid}/tasks/{tid}

Tags: Tasks

A put call to the task root record completely replaces task metadata, but does not affect sub-ressources or sub-collections.

Uses default content-types: application/json

New metadata for the task

TaskMetadata


sid	ID of the Service managing the current Task	path	string
tid	ID of the task to update.	path	string

Uses default content-types: application/json

200 OK: OK, task updated and returned.

Task
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: Not found

Error
409 Conflict: Conflict, resource could not be updated. See error message for details.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Trigger an action

POST /services/{sid}/tasks/{tid}/action

Tags: Tasks

Trigger a new action on the current task. Currently supported actions are start, abort, pause and resume.

Uses default content-types: application/json

The body contains a JSON object with the name of the action.

Action


sid	ID of the current service.	path	string
tid	ID of the current task.	path	string

Uses default content-types: application/json

204 No Content: OK, action started.
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: The service does not provide actions

Error
409 Conflict: Conflict, action could not be triggered. See error message for details.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Retrieve list of task input items

GET /services/{sid}/tasks/{tid}/input

Tags: Tasks

This route provides access to a Task's list of input documents. Input lists of Tasks are structure-wise identical with Lists in general, they differ in that they are Task-internal and hence not available via the /lists route. Input lists can have list-level metadata, and each list item can have metadata as well. A call to this route will provide the list-level metadata and an inventory of the collection. Access input list items via the 'items' sub-collection. Use the 'embed' parameter to include item metadata in the result.

sid

ID of the Service managing the current Task

path

string

tid

ID of the current task.

path

string

embed

Use 'embed' to include sub-collection metadata in the result.

"items": Include list-item metadata.

query

string

Uses default content-types: application/json

200 OK: OK, collection of input list items returned

List
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: Not found

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Update input list metadata (partial, merge)

PATCH /services/{sid}/tasks/{tid}/input

Tags: Tasks

Does a partial update to the input list metadata. Given metadata replaces existing one, or is added to the record if not yet present. No metadata is deleted.

Uses default content-types: application/json

New metadata for the input list.

List

sid

ID of the Service managing the current Task

path

string

tid

ID of the Task to update.

path

string

embed

Use 'embed' to include sub-collection metadata for updating.

"items": Include list-item data including indices for reordering.

query

string

Uses default content-types: application/json

200 OK: OK, input list updated and returned.

List
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: Not found

Error
409 Conflict: Conflict, resource could not be updated. See error message for details.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Append a new item to the input list of the task.

POST /services/{sid}/tasks/{tid}/input

Tags: Tasks

Creates a new entry in the given Task's input list. Given metadata is assigned to the new list item.

Uses default content-types: application/json

Complete list item metadata for the new task input list item. Use EITHER doc OR item parameter; if both are present, item is used.

ListItem


sid	ID of the Service managing the current Task	path	string
tid	ID of the current task.	path	string
href	URL of the document to add. This is a convenient way of adding a document without constructing a list item first.	query	string

Uses default content-types: application/json

200 OK: OK, task input list item created, item data returned.

ListItem
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: Not found

Error
409 Conflict: Conflict, resource could not be updated. See error message for details.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Update input list metadata (complete, replace)

PUT /services/{sid}/tasks/{tid}/input

Tags: Tasks

A put call to the input list root record completely replaces the metadata, but does not affect sub-collections.

Uses default content-types: application/json

New metadata for the task input list

TaskMetadata


sid	ID of the Service managing the current Task	path	string
tid	ID of the task to update.	path	string

Uses default content-types: application/json

200 OK: OK, input list updated and returned.

List
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: Not found

Error
409 Conflict: Conflict, resource could not be updated. See error message for details.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Delete a task input list item

DELETE /services/{sid}/tasks/{tid}/input/{id}

Tags: Tasks

Deletes an item from a Task's input list. The deleted ID is permanently orphaned, other list items keep their IDs.


sid	ID of the Service managing the current Task	path	string
tid	ID of the current task.	path	string
id	ID of the input list item to delete	path	string

Uses default content-types: application/json

204 No Content: OK, input list item deleted.
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: Not found

Error
409 Conflict: Conflict, resource could not be deleted. See error message for details.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Retrieve task item details

GET /services/{sid}/tasks/{tid}/input/{id}

Tags: Tasks

FIXME


sid	ID of the Service managing the current Task	path	string
tid	ID of the current task.	path	string
id	ID of the input list item	path	string

Uses default content-types: application/json

200 OK: OK, input list item data returned.

ListItem
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: Not found

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Update a task input list item (partial, merge)

PATCH /services/{sid}/tasks/{tid}/input/{id}

Tags: Tasks

Updates task input list item metadata, replacing present entries and adding missing ones. No metadata is deleted by the patch.

Uses default content-types: application/json

(Partial) metadata of an input list item.

ListItem


sid	ID of the Service managing the current Task	path	string
tid	ID of the current task.	path	string
id	ID of the task input list item to update	path	string

Uses default content-types: application/json

200 OK: OK, task input list item updated. Item data returned.

ListItem
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: Not found

Error
409 Conflict: Conflict, resource could not be updated. See error message for details.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Update the current task input list item (complete, replace)

PUT /services/{sid}/tasks/{tid}/input/{id}

Tags: Tasks

Replaces the task input list item's metadata, including the document reference.

Uses default content-types: application/json

complete item metadata for the task item.

ListItem


sid	ID of the Service managing the current Task	path	string
tid	ID of the current task.	path	string
id	ID of the input list item	path	string

Uses default content-types: application/json

200 OK: OK, list item updated. Item data returned.

ListItem
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: Not found

Error
409 Conflict: Conflict, resource could not be updated. See error message for details.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Retrieve list of task output items

GET /services/{sid}/tasks/{tid}/output

Tags: Tasks

This route provides access to a Task's list of output documents. Output lists of Tasks are structure-wise identical with Lists in general, they differ in that they are Task-internal and hence not available via the /lists route. Output lists can have list-level metadata, and each list item can have metadata as well. A call to this route will provide the list-level metadata and an inventory of the collection. Access output list items via the 'items' sub-collection. Use the 'embed' parameter to include item metadata in the result.

sid

ID of the Service managing the current Task

path

string

tid

ID of the current task.

path

string

embed

Use 'embed' to include sub-collection metadata in the result.

"items": Include list-item metadata.

query

string

Uses default content-types: application/json

200 OK: OK, collection of output list items returned

List
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: Not found

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Retrieve task output list item details

GET /services/{sid}/tasks/{tid}/output/{id}

Tags: Tasks

This route provides access to individual task output items.


sid	ID of the Service managing the current Task	path	string
tid	ID of the current task.	path	string
id	ID of the output list item	path	string

Uses default content-types: application/json

200 OK: OK, output list item data returned.

ListItem
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
404 Not Found: Not found

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Get session information

GET /sessions

Tags: Sessions

Get number of currently established sessions of user

Uses default content-types: application/json

200 OK: OK, return object with session information

SessionInfo
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks acces rights to access the service list.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Retrieve collection of tasks managed by all services.

GET /tasks

Tags: Tasks

This route provides access to the root collection of known tasks for all services supporting tasks. Use property names and regular expressions in URL query string to search for tasks. Use the 'embed' parameter to include information about instances and sub-ressources. Use the 'inputDocument' parameter to search for a task containing a special document and use 'inlineCount' to get the number of found tasks.

inputDocument

A document UUID queried for in all lists of input documents of all tasks.

query

string

embed

Information about sub-collections and/or sub-ressources to include in the response.

"permissions": include user access rights for each Task
"metadata": include Task metadata.
"input": include input lists (metadata only)
"output": include output lists (metadata only)
"cstats": connector specific job id's and states

query

string

inlineCount

Return a JSON object containing the number of tasks found, according to the query parameters, instead of an array with tasks.

query

boolean

Uses default content-types: application/json

200 OK

OK, collection of tasks or count is returned. Example for count:

{
  count: 0
}

Task

401 Unauthorized

Unauthorized (Auth token invalid)

Error

403 Forbidden

Forbidden. The user lacks rights to access the data.

Error

404 Not Found

Not found

Error

500 Internal Server Error

Application Error

Error

default

Unexpected error

Error


oauth	authN

Retrieve list of default UI panels available to the user.

GET /ui

Tags: Panels

The SEAL Operator user interface provides the user with a set of default panels to use. A GET call to this route returns a list of panels available to the current user. Default panels cannot be edited or deleted.

Uses default content-types: application/json

200 OK: OK, list of UI panel configurations returned.

PanelItem
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Retrieve the default configuration of a UI panel.

GET /ui/{pid}

Tags: Panels

A GET call to this route returns a JSON object containing the default configuration of the panel.


pid		path	string

Uses default content-types: application/json

200 OK: OK, panel configuration is returned.

ConfigItem
401 Unauthorized: Unauthorized (Auth token invalid)

Error
403 Forbidden: Forbidden. The user lacks rights to access the data.

Error
500 Internal Server Error: Application Error

Error
default: Unexpected error

Error


oauth	authN

Schema definitions

Action: object

A JSON object containing the name of the command to execute and it's paramters.

action: string , x ∈ { start , abort , pause , resume }

BaseRepoEntry: object

A RepoEntry contains user defined metadata with any number of arbitrary properties and two mandatory properties 'name' and 'type'.

name: string: (File) name of the Entry
type: string , x ∈ { document , collection }: Type of RepoEntry.
metadata: object: Metadata assigned to the entry

Command: object

A JSON object containing the name of the command to execute and it's paramters.

action: string , x ∈ { copy , move }
parameter: object: Command specific parameter, e.g. href's of documents

CommandStatus: object

A JSON object containing a command and it's current status

cid: string
status: StatusType
command: Command

ConfigItem: object

A JSON object containing key-value pairs representing the configuration.

Error: object

code: integer (int32)
message: string
metadata: object

Functions: object

Contains for each available function one object with an href to the function. Key of each object is the function name.

List: object

A List is an ordered sequence of documents as list items. Each List can contain arbitrary metadata. List items may also have metadata assigned, which does not replace but complement document metadata. A document may not be unique within a List, i.e. a List can contain several items all pointing to the same document (but most likely with different item metadata).

uuid: string

Unique identifier of the list, generated by SEAL Operator.

name: string

User defined name for the list. Doesn't have to be unique.

created: integer (date-time)

Timestamp of list creation

lastModified: integer (date-time)

Timestamp of list creation

listLength: integer

Number of items in list

links: object

If requested by MIME type, the links section contains hrefs to

"self": the List itself

embedded: object

Embedded sub-ressources or sub-collections, as requested throught the "embed" query parameter

listItems: object[]: ListItem

metadata: object

List metadata. Note that these do not contain item metadata.

ListItem: object

index: integer: This is the index of an item in a List. The index is maintained by the SEAL Operator backend. Setting the index to a value beyond the end of the list will move the item to the end of the list. Setting the index to 0 will move th item to the top of the list. Setting the index to a value in use by another item will replace this item, moving it (and all with higher indices) one space down in the list, by increasing their index values.
href: string: URL location of linked ressource
metadata: object: Additional data to be stored with the link

Message: object

A JSON object containing a message

uuid: string: A server side defined uuid for each new entry
type: string , x ∈ { info , warning , error }: The message type
text: string: The message text
date: integer (int64): The creation time of the message as timestamp
source: string: Name of the panel which created the message
read: boolean: Flag if the message has already been read by user

PanelItem: object

A JSON object containing name and id of a PanelListItem

pid: string: unique id of the PanelListItem
name: string
type: string: the panel type the configuration is for, e.g. scratch, p4,...

PostMessage: object

A JSON object containing a message

type: string , x ∈ { info , warning , error }: The message type
text: string: The message text
source: string: Name of the panel which created the message

RepoEntry: object

A RepoEntry represents a record within the Repository part of a Service. A RepoEntry may be either a document or a collection. All RepoEntries may contain metadata and user permission records. collections may also contain children, while documents may have binary content.

id: string

Local ID of the document within the repository.

uuid: string

Global ID of the document, created by SEAL Operator

name: string

(File) name of the Entry

type: string , x ∈ { document , collection }

Type of RepoEntry.

links: object

If requested by MIME type, the links section contains hrefs to

"self": the document itself
"parent": the collection containing the document
"permissions": an object describing user permissions on the document

embedded: object

Embedded sub-ressources as requested through the "embed" query parameter, e.g. "permissions", "icon", "thumb".

metadata: object

Metadata assigned to the entry

Service: object

A Service represents a target system connected to the SEAL Operator framework. It may be able to process tasks and/or provide access to documents, under its /tasks and /repo routes.

id: string

Identifier of the Service within the SEAL Operator

name: string

Label describing the Service

metadata: object

Metadata of the Service

links: object

If requested by MIME type, the links section contains hrefs to

"self": The Service itself
"permissions": User permissions on the Service

embedded: object

Sub-collections and/or sub-ressources requested through the embed query parameter.

SessionInfo: object

Informations about users sessions

no: integer: number of currently open sessions of this user

StatusType: string , x ∈ { open , processing , completed , paused , aborted , failed }

Definition of allowed status names

Task: object

name: string

sid: string

tid: string

metadata: object

Task metadata. Note that these do not contain item metadata.

created: integer (date-time)

Timestamp of task creation

started: integer (date-time)

Timestamp of task started

finished: integer (date-time)

Timestamp of task finished

inputListLength: integer

Number of items in input list

outputListLength: integer

Number of items in output list

status: StatusType

links: object

If requested, the links section contains hrefs to

"self": the Task itself
"input": input documents
"output": output documents

embedded: object

Embedded sub-ressources or sub-collections, as requested throught the "embed" query parameter

TaskMetadata: object

A task metadata object contains user defined metadata with any number of arbitrary properties and the optional property 'name'.

name: string: Name of the Task
metadata: object: Metadata assigned to the task