For the most up-to-date documentation, please consult `/swagger-ui.html` (or `/v2/api-docs`) on your own server. The following has been auto-generated by swaggerdown.io ## Corvus API The corvus (Content ORchestration, Validation and Unification System) REST API ## Endpoints ## api/v1/entry/clone/{id}/{mainChannel} ## PUT ### cloneEntryUsingPUT clone an existing entry ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ----------- | ----- | ----------- | --------- | ------- | | id | path | id | true | integer | | mainChannel | path | mainChannel | true | integer | | version | query | version | false | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/entry/list/{template} ## GET ### getListUsingGET retrieve all entries of a given template ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | -------- | ----- | ----------------------------------------------------------------------------------- | --------- | ------- | | page | query | Result page to retrieve (0..n) | false | integer | | size | query | Number of recods per page | true | integer | | template | path | template | false | string | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/entry/lock/{id} ## PUT ### lockEntryUsingPUT pseudo-lock an entry Mark an entry as locked by some user to indicate that it's currently being edited. This lock is currently NOT enforced when storing! ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | ---- | ----------- | --------- | ------- | | id | path | id | true | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/entry/my/{template} ## GET ### getMineUsingGET retrieve the current users entries of a given template ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | -------- | ----- | ----------------------------------------------------------------------------------- | --------- | ------- | | page | query | Result page to retrieve (0..n) | false | integer | | size | query | Number of recods per page | true | integer | | template | path | template | false | string | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/entry/unlock/{id} ## PUT ### unlockEntryUsingPUT unlock an entry ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | ---- | ----------- | --------- | ------- | | id | path | id | true | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/entry/versions/{id} ## GET ### getEntryVersionsUsingGET retrieve all versions of an entry ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | ----- | ----------------------------------------------------------------------------------- | --------- | ------- | | page | query | Result page to retrieve (0..n) | false | integer | | size | query | Number of recods per page | true | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/entry/{id} ## GET ### getEntryUsingGET_1 retrieve a specific entry ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | ---- | ----------- | --------- | ------- | | id | path | id | true | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## PUT ### updateEntryUsingPUT update an existing entry ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ------------ | ----- | ------------ | --------- | ----------------------------------------------------- | | id | path | id | true | integer | | update | body | update | true | :link | | asNewVersion | query | asNewVersion | false | {:text "EntryUpdate", :url "#entryupdate-definition"} | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/entry/{id}/{version} ## GET ### getEntryUsingGET retrieve a specific version of an entry ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ------- | ---- | ----------- | --------- | ------- | | id | path | id | true | integer | | version | path | version | true | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/entry/{template} ## POST ### createEntryUsingPOST create a new entry or return an unsaved one of that template ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | -------- | ----- | ----------- | --------- | ------- | | template | path | template | true | string | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/files/public/{uuid} ## GET ### getPublicFileUsingGET_1 retrieve a public file from the server without authentication (binary type: original) ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | -------- | ----- | ----------- | --------- | ------- | | uuid | path | uuid | true | string | ### Content Types Produced | Produces | | ------------------------ | | application/octet-stream | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/files/public/{uuid}/{type} ## GET ### getPublicFileUsingGET retrieve a public file from the server without authentication type denotes the binary type, default is 'original' but may include 'preview' and 'thumbnail' ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | -------- | ----- | ----------- | --------- | ------- | | uuid | path | uuid | true | string | | type | path | type | true | string | | download | query | download | false | boolean | ### Content Types Produced | Produces | | ------------------------ | | application/octet-stream | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/files/upload ## POST ### uploadFileUsingPOST upload a file to the server ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | -------- | ----------- | --------- | ---- | | file | formData | file | true | file | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ------------------- | | multipart/form-data | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/files/{uuid} ## GET ### getFileUsingGET_1 retrieve a file from the server (binary type: original) ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | -------- | ----- | ----------- | --------- | ------- | | uuid | path | uuid | true | string | ### Content Types Produced | Produces | | ------------------------ | | application/octet-stream | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## DELETE ### deleteFileUsingDELETE delete a file from the server ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | ---- | ----------- | --------- | ------ | | uuid | path | uuid | true | string | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/files/{uuid}/{type} ## GET ### getFileUsingGET retrieve a file from the server type denotes the binary type, default is 'original' but may include 'preview' and 'thumbnail' ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | -------- | ----- | ----------- | --------- | ------- | | uuid | path | uuid | true | string | | type | path | type | true | string | | download | query | download | false | boolean | ### Content Types Produced | Produces | | ------------------------ | | application/octet-stream | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/messages/inbox ## GET ### getInboxUsingGET get mails sent to the user ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ------ | ----- | ----------------------------------------------------------------------------------- | --------- | ------- | | page | query | Result page to retrieve (0..n) | false | integer | | size | query | Number of recods per page | false | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/messages/outbox ## GET ### getOutboxUsingGET get mails sent by the user ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ------ | ----- | ----------------------------------------------------------------------------------- | --------- | ------- | | page | query | Result page to retrieve (0..n) | false | integer | | size | query | Number of recods per page | false | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/outputchannels ## POST ### addUsingPOST add a new output channels ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ------------- | ---- | ------------- | --------- | ------------------------------------------------------ | | channelUpdate | body | channelUpdate | true | [OutputChannelUpdate](#outputchannelupdate-definition) | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/outputchannels/groups ## GET ### getGroupsUsingGET get all output channel groups ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | -------------- | ----- | -------------- | --------- | ------- | | fullNames | query | fullNames | false | boolean | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## POST ### addGroupUsingPOST add an output channel group ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ------ | ---- | ----------- | --------- | ---------------------------------------------------------------- | | update | body | update | true | [OutputChannelGroupUpdate](#outputchannelgroupupdate-definition) | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/outputchannels/groups/{id} ## PUT ### updateGroupUsingPUT update an output channel group ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ------ | ---- | ----------- | --------- | ------------------------------------------------------------------------------- | | id | path | id | true | integer | | update | body | update | true | :link | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## DELETE ### deleteGroupUsingDELETE delete an output channel group ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | ---- | ----------- | --------- | ------- | | id | path | id | true | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/outputchannels/list ## GET ### getChildrenUsingGET_1 get the root output channels ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---------- | ----- | ----------------------------------------------------------------------------------- | --------- | ------- | | page | query | Result page to retrieve (0..n) | false | integer | | size | query | Number of recods per page | false | integer | | recursive | query | recursive | false | boolean | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/outputchannels/list/{id} ## GET ### getChildrenUsingGET get the children of an output channel ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---------- | ----- | ----------------------------------------------------------------------------------- | --------- | ------- | | page | query | Result page to retrieve (0..n) | false | integer | | size | query | Number of recods per page | true | integer | | id | path | id | false | integer | | recursive | query | recursive | false | boolean | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/outputchannels/map ## GET ### getMapUsingGET get a map of all output channels ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | --------- | ----- | ----------- | --------- | ------- | | fullNames | query | fullNames | false | boolean | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/outputchannels/tree/{id} ## GET ### getChildrenUsingGET_2 get a nested tree of output channels (id=0 for root) ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | --------- | ----- | ----------- | --------- | ------- | | id | path | id | true | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/outputchannels/{id} ## GET ### getUsingGET get a specific output channel ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---------- | ----- | ----------- | --------- | ------- | | id | path | id | true | integer | | childCount | query | childCount | false | boolean | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## PUT ### updateUsingPUT update a specific output channel pass parentId = 0 validTo put it on the root level ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ------------- | ---- | ------------- | --------- | --------------------------------------------------------------------- | | id | path | id | true | integer | | channelUpdate | body | channelUpdate | true | :link | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## DELETE ### deleteUsingDELETE delete a specific output channel ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | ---- | ----------- | --------- | ------- | | id | path | id | true | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/outputintents/entry/{id} ## GET ### getByEntryUsingGET get output intents of a specific entry ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | ---- | ----------- | --------- | ------- | | id | path | id | true | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## POST ### addToEntryUsingPOST create a new output intent for an entry If one like it already exists, it is returned instead. If it has been marked as removed, it's status is set to created again. ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | --------------- | ---- | --------------- | --------- | ------- | | id | path | id | true | integer | | outputChannelId | body | outputChannelId | true | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## DELETE ### removeForEntryUsingDELETE mark an output intent as removable if the output intent has just been created, it gets deleted instead ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | -------------- | ---- | -------------- | --------- | ------- | | id | path | id | true | integer | | outputIntentId | body | outputIntentId | true | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/roles ## GET ### getRolesUsingGET get all available role names ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | -- | ----------- | --------- | ---- | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## POST ### addRoleUsingPOST add a new role assignment ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ------- | ---- | ----------- | --------- | ------------------------------------ | | newRole | body | newRole | true | [RoleUpdate](#roleupdate-definition) | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## DELETE ### deleteRoleUsingDELETE_1 delete a role assignment ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | -------- | ---- | ----------- | --------- | ------------------------------------ | | template | body | template | true | [RoleUpdate](#roleupdate-definition) | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/roles/has ## POST ### hasRoleUsingPOST test if a user (0 = current) has any of these (inherited) roles on an (optional) output channel ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ----------- | ---- | ----------- | --------- | -------------------------------------- | | roleRequest | body | roleRequest | true | [RoleRequest](#rolerequest-definition) | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/roles/mine ## GET ### getMyRolesUsingGET get all roles of the current user ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | -- | ----------- | --------- | ---- | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/roles/outputchannel/{id} ## GET ### getRolesForChannelUsingGET get all (inherited) roles for a specific output channel ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | ---- | ----------- | --------- | ------- | | id | path | id | true | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/roles/outputchannelmap/{id} ## GET ### getRoleMapForChannelUsingGET get a map by userId of all (inherited) roles for a specific output channel ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | ---- | ----------- | --------- | ------- | | id | path | id | true | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/roles/user/{id} ## GET ### getRolesOfUserUsingGET get all roles of a specific user ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | ---- | ----------- | --------- | ------- | | id | path | id | true | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/roles/{id} ## DELETE ### deleteRoleUsingDELETE delete a role assignment ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | ---- | ----------- | --------- | ------- | | id | path | id | true | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/settings/celumconfig ## GET ### getCelumSettingsUsingGET get the celum configuration ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | -- | ----------- | --------- | ---- | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/settings/general ## GET ### getGeneralInfoUsingGET get general information about server settings ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | -- | ----------- | --------- | ---- | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/settings/userstate ## GET ### getStatesUsingGET get all user states for the current user ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | -- | ----------- | --------- | ---- | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## DELETE ### deleteStatesUsingDELETE delete all user states for the current user ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | -- | ----------- | --------- | ---- | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/settings/userstate/{key} ## GET ### getStateUsingGET get a specific user state for the current user ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | ---- | ----------- | --------- | ------ | | key | path | key | true | string | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## PUT ### setStateUsingPUT set a specific user state for the current user ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ----- | ---- | ----------- | --------- | ------ | | key | path | key | true | string | | value | body | value | true | string | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## DELETE ### deleteStateUsingDELETE delete a specific user state for the current user ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | ---- | ----------- | --------- | ------ | | key | path | key | true | string | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/spellcheck/dictionary ## GET ### getDictionaryEntriesUsingGET get the current user's dictionary words ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | -- | ----------- | --------- | ---- | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## PUT ### addDictionaryWordUsingPUT add a word to the current user's dictionary ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | ----- | ----------- | --------- | ------ | | text | query | text | true | string | | lang | query | lang | true | string | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## DELETE ### getDictionaryEntriesUsingDELETE delete a dictionary word ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | ----- | ----------- | --------- | ------- | | id | query | id | true | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/spellcheck/languages ## GET ### getLanguagesUsingGET get all available spellcheck languages ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | -- | ----------- | --------- | ---- | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/spellcheck/suggest ## PUT ### getSuggestionsUsingPUT get suggestions for spelling mistakes ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | ----- | ----------- | --------- | ------ | | text | query | text | true | string | | lang | query | lang | true | string | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/subscription ## POST ### addSubscriptionUsingPOST add a new subscription an empty userId implies the current user ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ------------------ | ---- | ------------------ | --------- | ---------------------------------------------------- | | subscriptionUpdate | body | subscriptionUpdate | true | [SubscriptionUpdate](#subscriptionupdate-definition) | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/subscription/mine ## GET ### getMySubscriptionsUsingGET get all subscriptions of the current user ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | -- | ----------- | --------- | ---- | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/subscription/outputchannel/{id} ## GET ### getSubscriptionsForChannelUsingGET get all subscriptions roles for a specific output channel (admins only) ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | ---- | ----------- | --------- | ------- | | id | path | id | true | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/subscription/user/{id} ## GET ### getSubscriptionsOfUserUsingGET get all subscriptions of a specific user (admins only) ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | ---- | ----------- | --------- | ------- | | id | path | id | true | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/subscription/{id} ## GET ### getSubscriptionUsingGET get a specific subscription (owner and admins only) ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | ---- | ----------- | --------- | ------- | | id | path | id | true | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/subscription/{subscriptionId} ## DELETE ### deleteSubscriptionUsingDELETE delete a subscription ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | -------------- | ---- | -------------- | --------- | ------- | | subscriptionId | path | subscriptionId | true | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/templates/get/{key} ## GET ### getTemplateUsingGET get a specific template definitions by its key ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | ---- | ----------- | --------- | ------ | | key | path | key | true | string | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/templates/keys ## GET ### getKeysUsingGET get all template keys ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ------ | ----- | ----------- | --------- | ------- | | reload | query | reload | false | boolean | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/templates/list ## GET ### getListUsingGET_1 get all available template definitions ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ------ | ----- | ----------- | --------- | ------- | | reload | query | reload | false | boolean | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/test ## GET ### testUsingGET test ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | -- | ----------- | --------- | ---- | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/translation/request/{id}/{locale} ## PUT ### requestTranslationUsingPUT request a new translation to be created for an entry ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ------ | ---- | ----------- | --------- | ------- | | id | path | id | true | integer | | locale | path | locale | true | string | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/translation/{id} ## GET ### getTranslationsUsingGET get all translations for an entry ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | ---- | ----------- | --------- | ------- | | id | path | id | true | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## POST ### updateEntryUsingPOST update an existing translation ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ------------ | ----- | ------------ | --------- | ----------------------------------------------------- | | id | path | id | true | integer | | update | body | update | true | :link | | asNewVersion | query | asNewVersion | false | {:text "ValueUpdate", :url "#valueupdate-definition"} | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/translation/{id}/{locale} ## GET ### getTranslationUsingGET get a specific translation for an entry ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ------ | ---- | ----------- | --------- | ------- | | id | path | id | true | integer | | locale | path | locale | true | string | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/users ## POST ### addUserUsingPOST create a new user ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | ---- | ----------- | --------- | ------------------------------------ | | user | body | user | true | [UserUpdate](#userupdate-definition) | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/users/list ## GET ### getListUsingGET_2 get all users ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ------ | ----- | ----------------------------------------------------------------------------------- | --------- | ------- | | page | query | Result page to retrieve (0..n) | false | integer | | size | query | Number of recods per page | false | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/users/me ## GET ### getMeUsingGET get the current user ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | -- | ----------- | --------- | ---- | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/users/password ## PUT ### setPasswordUsingPUT_1 change the users password ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | --------------- | ---- | --------------- | --------- | ---------------------------------------------- | | passwordRequest | body | passwordRequest | true | [PasswordRequest](#passwordrequest-definition) | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/users/password/policy ## GET ### getPasswordPolicyUsingGET get the password policy for the internal authentication ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | -- | ----------- | --------- | ---- | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/users/password/{id} ## PUT ### setPasswordUsingPUT change the password of any user (superadmins only) ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | -------- | ---- | ----------- | --------- | ------- | | id | path | id | true | integer | | password | body | password | true | string | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/users/scoped ## GET ### getScopedUsingGET get users in the admin's scope (channels where he has permission) ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ------ | ----- | ----------------------------------------------------------------- | --------- | ----- | | filter | query | Filter criteria in the format 'field:value', e.g. 'disabled:true' | false | array | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/users/su/{id} ## PUT ### switchUserUsingPUT switch user, aka 'login as' (superadmins only) ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | ---- | -------------------------------------------------- | --------- | ------- | | id | path | ID of the user to switch to or zero to switch back | false | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/users/{id} ## GET ### getUserUsingGET get a specific user ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | ---- | ----------- | --------- | ------- | | id | path | id | true | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## PUT ### updateUserUsingPUT update a specific user ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---------- | ---- | ----------- | --------- | --------------------------------------------------- | | id | path | id | true | integer | | userUpdate | body | userUpdate | true | :link | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## DELETE ### deleteUserUsingDELETE delete (disable) a specific user ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | ---- | ----------- | --------- | ------- | | id | path | id | true | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/workflows/assign/{taskId}/{userId} ## PUT ### assignTaskUsingPUT assign a task to a user ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ------ | ---- | ----------- | --------- | ------- | | taskId | path | taskId | true | string | | userId | path | userId | true | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/workflows/claim/{taskId} ## PUT ### claimTaskUsingPUT claim a task (assign to current user) ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ------ | ---- | ----------- | --------- | ------ | | taskId | path | taskId | true | string | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/workflows/complete/{taskId} ## PUT ### completeTaskUsingPUT mark a task as completed ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ----------------- | ---- | ----------------- | --------- | ------------------------------------------------------------------------- | | taskId | path | taskId | true | string | | completionRequest | body | completionRequest | true | :link | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/workflows/completed/all ## GET ### getAllCompletionsUsingGET get all completed tasks (superadmin only) ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ------ | ----- | ----------------------------------------------------------------------------------- | --------- | ------- | | page | query | Result page to retrieve (0..n) | false | integer | | size | query | Number of recods per page | false | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/workflows/completed/entry/{id} ## GET ### ofEntryUsingGET get open tasks for a specified entry ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ------ | ----- | ----------------------------------------------------------------------------------- | --------- | ------- | | page | query | Result page to retrieve (0..n) | false | integer | | size | query | Number of recods per page | true | integer | | id | path | id | false | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/workflows/completed/inbox ## GET ### getAssignableCompletionsUsingGET get completed tasks assigned to or available to the user ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ------ | ----- | ----------------------------------------------------------------------------------- | --------- | ------- | | page | query | Result page to retrieve (0..n) | false | integer | | size | query | Number of recods per page | false | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/workflows/completed/initiated ## GET ### getInitiatedCompletionsUsingGET get completed tasks that the user has initiated ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ------ | ----- | ----------------------------------------------------------------------------------- | --------- | ------- | | page | query | Result page to retrieve (0..n) | false | integer | | size | query | Number of recods per page | false | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/workflows/completed/others ## GET ### getVisibleCompletionsUsingGET get completed tasks that are visible through other channels ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ------ | ----- | ----------------------------------------------------------------------------------- | --------- | ------- | | page | query | Result page to retrieve (0..n) | false | integer | | size | query | Number of recods per page | false | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/workflows/delegate/{taskId}/{userId} ## PUT ### delegateTaskUsingPUT delegate a task to a user ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ------ | ---- | ----------- | --------- | ------- | | taskId | path | taskId | true | string | | userId | path | userId | true | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/workflows/lectorate/{entryId} ## POST ### lectorateUsingPOST start a independent lectorate workflow for this entry ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ------- | ---- | ----------- | --------- | ------- | | entryId | path | entryId | true | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/workflows/processkeys ## GET ### getListUsingGET_3 get all available process definition keys ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | -- | ----------- | --------- | ---- | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/workflows/tasks/all ## GET ### getAllTasksUsingGET get all running tasks (superadmin only) ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ------ | ----- | ----------------------------------------------------------------------------------- | --------- | ------- | | page | query | Result page to retrieve (0..n) | false | integer | | size | query | Number of recods per page | false | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/workflows/tasks/entry/{id} ## GET ### getEntryUsingGET_2 get open tasks for a specified entry ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | ----- | ----------------------------------------------------------------------------------- | --------- | ------- | | page | query | Result page to retrieve (0..n) | false | integer | | size | query | Number of recods per page | true | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/workflows/tasks/inbox ## GET ### getAssignableTasksUsingGET get tasks assigned to or available to the user ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ------ | ----- | ----------------------------------------------------------------------------------- | --------- | ------- | | page | query | Result page to retrieve (0..n) | false | integer | | size | query | Number of recods per page | false | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/workflows/tasks/initiated ## GET ### getInitiatedTasksUsingGET get tasks that the user has initiated ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ------ | ----- | ----------------------------------------------------------------------------------- | --------- | ------- | | page | query | Result page to retrieve (0..n) | false | integer | | size | query | Number of recods per page | false | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/workflows/tasks/others ## GET ### getVisibleTasksUsingGET get tasks that are visible through other channels ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ------ | ----- | ----------------------------------------------------------------------------------- | --------- | ------- | | page | query | Result page to retrieve (0..n) | false | integer | | size | query | Number of recods per page | false | integer | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/workflows/tasks/{id} ## GET ### getTaskUsingGET get a specific task ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ---- | ---- | ----------- | --------- | ------ | | id | path | id | true | string | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## api/v1/workflows/undelegate/{taskId} ## PUT ### delegateTaskUsingPUT_1 resolve the delegation of a task ### Expected Response Types | Response | Reason | | -------- | -------------------- | | 0 | generic server error | | 200 | OK | ### Parameters | Name | In | Description | Required? | Type | | ------ | ---- | ----------- | --------- | ------ | | taskId | path | taskId | true | string | ### Content Types Produced | Produces | | ------------------------------ | | application/json;charset=UTF-8 | ### Content Types Consumed | Consumes | | ---------------- | | application/json | ### Security | Id | Scopes | | ---- | ------ | | None | None | ## Security Definitions | Id | Type | Flow | Authorization Url | Name | In | Scopes | | ----- | ----- | ---- | ----------------- | ---- | -- | ------ | | | | | | | | | | Basic | basic | | | | | | | Scope | Description | | ----- | ----------- | | | | ## Definitions ### AuthenticationMethod Definition | Property | Type | Format | | ----------------- | ------- | ------ | | authenticatorName | string | | | canSetPassword | boolean | | ### BooleanResponse Definition | Property | Type | Format | | -------- | ------- | ------ | | | | | | value | boolean | | ### CelumSettingsResponse Definition | Property | Type | Format | | ------------- | ------- | ------ | | | | | | anuraEndpoint | string | | | baseUrl | string | | | originalDlf | integer | int64 | | treeRootId | integer | int64 | | treeRootKind | integer | int64 | ### Comment Definition | Property | Type | Format | | ---------- | --------------------------------------- | ------ | | comment | | | | createDate | string | int64 | | createdBy | integer | | | id | :link | int64 | ### DictionaryWord Definition | Property | Type | Format | | -------- | --------------------------------------- | ------ | | id | | int64 | | locale | integer | | | user | string | | | word | :link | | ### Entry Definition | Property | Type | Format | | -------------- | --------------------------------------------------------- | ------ | | | [User](#user-definition) | | | createdBy | array | | | comments | integer | | | lockDate | string | int64 | | template | string | | | state | integer | | | createDate | string | int64 | | title | [OutputChannel](#outputchannel-definition) | | | mainChannel | string | | | latestComment | integer | | | id | object | int64 | | latestValues | integer | | | latestVersion | [User](#user-definition) | int64 | | lockedBy | [Entry](#entry-definition) | | | clonedFrom | array | | | versions | string | | | originalLocale | array | | | outputIntents | :link | | | validity | {:text "EntryValidity", :url "#entryvalidity-definition"} | | | translations | array | | ### EntryField Definition | Property | Type | Format | | -------- | ------ | ------ | | name | string | | | type | string | | ### EntryFile Definition | Property | Type | Format | | ---------------- | --------------------------------------- | ------ | | contentType | | | | createDate | string | int64 | | createdBy | integer | | | externalId | :link | int64 | | fileCategory | {:text "User", :url "#user-definition"} | | | fileSize | integer | int64 | | originalFilename | string | | | uuid | integer | | ### EntryResponse Definition | Property | Type | Format | | -------------- | ------------------------------------------------------------------------- | ------ | | | | | | createdBy | :link | | | comments | {:text "UserResponse", :url "#userresponse-definition"} | | | lockDate | array | int64 | | template | integer | | | state | string | | | createDate | string | int64 | | title | integer | | | mainChannel | string | | | id | :link | int64 | | values | {:text "OutputChannelResponse", :url "#outputchannelresponse-definition"} | | | latestVersion | integer | int64 | | lockedBy | object | | | clonedFrom | integer | int64 | | originalLocale | [UserResponse](#userresponse-definition) | | | outputIntents | integer | | | validity | string | | | translations | array | | ### EntryShortResponse Definition | Property | Type | Format | | -------------- | ----------------------------------------------------------------------------------- | ------ | | createdBy | [UserShortResponse](#usershortresponse-definition) | | | lockDate | integer | int64 | | template | string | | | state | string | | | createDate | integer | int64 | | title | string | | | mainChannel | :link | | | id | {:text "OutputChannelShortResponse", :url "#outputchannelshortresponse-definition"} | int64 | | values | integer | | | latestVersion | object | int64 | | lockedBy | integer | | | clonedFrom | [UserShortResponse](#usershortresponse-definition) | int64 | | originalLocale | integer | | | outputIntents | string | | | validity | array | | | translations | :link | | ### EntryUpdate Definition | Property | Type | Format | | -------------- | ---------------------------------------------- | ------ | | originalLocale | string | | | values | object | | | workflow | [WorkflowRequest](#workflowrequest-definition) | | | title | string | | | comment | string | | | validity | [EntryValidity](#entryvalidity-definition) | | | mainChannel | integer | int64 | | outputChannels | array | | ### EntryUpdateResultResponse Definition | Property | Type | Format | | -------- | --------------------------------------------------------- | ------ | | entry | | | | updates | :link | | ### EntryValidity Definition | Property | Type | Format | | --------- | ------- | ------ | | | | | | status | string | | | validFrom | integer | int64 | | validTo | integer | int64 | ### EntryValue Definition | Property | Type | Format | | ------------- | ------- | ------ | | asObject | object | | | discriminator | string | | | entryModel | string | | | id | integer | int64 | ### EntryVersion Definition | Property | Type | Format | | ----------- | ----------------------------------------- | ------ | | createDate | integer | int64 | | createdBy | :link | | | entry | {:text "User", :url "#user-definition"} | | | entryValues | :link | | | id | {:text "Entry", :url "#entry-definition"} | int64 | | version | array | int64 | ### ErrorResponse Definition | Property | Type | Format | | --------- | ------- | ------ | | error | string | | | message | string | | | path | string | | | status | integer | int32 | | timestamp | integer | int64 | | trace | array | | ### File Definition | Property | Type | Format | | ------------- | ------- | ------ | | | | | | path | string | | | freeSpace | integer | int64 | | parent | string | | | directory | boolean | | | parentFile | file | | | name | string | | | file | boolean | | | canonicalFile | file | | | absolute | boolean | | | absoluteFile | file | | | hidden | boolean | | | canonicalPath | string | | | usableSpace | integer | int64 | | totalSpace | integer | int64 | | absolutePath | string | | ### HistoricTaskResponse Definition | Property | Type | Format | | ----------------- | -------------------------------------------------- | ------ | | started | integer | int64 | | executionId | string | | | formKey | string | | | completed | integer | int64 | | duration | integer | int64 | | processVariables | object | | | priority | integer | int32 | | taskVariables | object | | | processInstanceId | string | | | taskId | string | | | owner | [UserShortResponse](#usershortresponse-definition) | | | assignee | [UserShortResponse](#usershortresponse-definition) | | ### InputElement Definition | Property | Type | Format | | ------------ | ------- | ------ | | | | | | features | array | | | min | integer | int32 | | key | string | | | name | object | | | value | object | | | width | string | | | hideLabel | boolean | | | translatable | boolean | | | max | integer | int32 | | options | array | | | inputType | string | | | tooltip | object | | | required | boolean | | | range | string | | | lectorable | boolean | | ### InputStream Definition | Property | Type | Format | | -------- | ---- | ------ | ### LocalizedString Definition | Property | Type | Format | | -------- | ---- | ------ | ### Notification Definition | Property | Type | Format | | --------- | --------------------------------------- | ------ | | date | integer | int64 | | id | integer | int64 | | message | string | | | recipient | :link | | | sender | {:text "User", :url "#user-definition"} | | | sent | :link | | | subject | {:text "User", :url "#user-definition"} | | | unread | boolean | | ### Option Definition | Property | Type | Format | | -------- | ------ | ------ | | | | | | children | array | | | key | string | | | name | object | | ### OutputChannel Definition | Property | Type | Format | | ------------------- | --------------------------------------------------------- | ------ | | | array | | | children | :link | | | parent | {:text "OutputChannel", :url "#outputchannel-definition"} | | | workflowKey | string | | | publicationSettings | array | | | name | object | | | childCount | integer | int32 | | entryCount | integer | int32 | | locales | array | | | externalId | string | | | id | integer | int64 | | parentPath | string | | ### OutputChannelGroupResponse Definition | Property | Type | Format | | -------------------- | ------- | ------ | | global | boolean | | | id | integer | int64 | | name | string | | | names | object | | | outputChannelDetails | array | | | outputChannels | array | | ### OutputChannelGroupUpdate Definition | Property | Type | Format | | -------------- | ------- | ------ | | | | | | global | boolean | | | names | object | | | outputChannels | array | | ### OutputChannelResponse Definition | Property | Type | Format | | ------------------- | ------------------------------------------ | ------ | | children | | | | parent | array | | | workflowKey | [OutputChannel](#outputchannel-definition) | | | publicationSettings | string | | | workflowOptional | array | | | name | boolean | | | hasChildren | string | | | hasEntries | boolean | | | externalId | boolean | | | id | string | int64 | | parentPath | integer | | | names | string | | ### OutputChannelShortResponse Definition | Property | Type | Format | | ---------- | ------- | ------ | | id | integer | int64 | | name | string | | | parent | integer | int64 | | parentPath | string | | ### OutputChannelUpdate Definition | Property | Type | Format | | ---------------- | ------- | ------ | | | | | | names | object | | | parentId | integer | int64 | | urls | object | | | workflowKey | string | | | workflowOptional | boolean | | ### OutputIntent Definition | Property | Type | Format | | ------------- | ------------------------------------------ | ------ | | externalId | | | | outputChannel | string | | | priority | [OutputChannel](#outputchannel-definition) | int32 | | status | integer | | ### OutputIntentShortResponse Definition | Property | Type | Format | | ------------- | ------- | ------ | | | | | | outputChannel | integer | int64 | | priority | integer | int32 | | status | string | | ### Page«EntryShortResponse» Definition | Property | Type | Format | | ---------------- | ------------------------ | ------ | | | integer | | | number | array | int32 | | content | integer | | | totalElements | integer | int64 | | size | integer | int32 | | totalPages | boolean | int32 | | first | boolean | | | last | integer | | | numberOfElements | [Sort](#sort-definition) | int32 | ### Page«HistoricTaskResponse» Definition | Property | Type | Format | | ---------------- | ------------------------ | ------ | | | integer | | | number | array | int32 | | content | integer | | | totalElements | integer | int64 | | size | integer | int32 | | totalPages | boolean | int32 | | first | boolean | | | last | integer | | | numberOfElements | [Sort](#sort-definition) | int32 | ### Page«Notification» Definition | Property | Type | Format | | ---------------- | ------------------------ | ------ | | | integer | | | number | array | int32 | | content | integer | | | totalElements | integer | int64 | | size | integer | int32 | | totalPages | boolean | int32 | | first | boolean | | | last | integer | | | numberOfElements | [Sort](#sort-definition) | int32 | ### Page«OutputChannelResponse» Definition | Property | Type | Format | | ---------------- | ------------------------ | ------ | | | integer | | | number | array | int32 | | content | integer | | | totalElements | integer | int64 | | size | integer | int32 | | totalPages | boolean | int32 | | first | boolean | | | last | integer | | | numberOfElements | [Sort](#sort-definition) | int32 | ### Page«TaskResponse» Definition | Property | Type | Format | | ---------------- | ------------------------ | ------ | | | integer | | | number | array | int32 | | content | integer | | | totalElements | integer | int64 | | size | integer | int32 | | totalPages | boolean | int32 | | first | boolean | | | last | integer | | | numberOfElements | [Sort](#sort-definition) | int32 | ### Page«UserResponse» Definition | Property | Type | Format | | ---------------- | ------------------------ | ------ | | | integer | | | number | array | int32 | | content | integer | | | totalElements | integer | int64 | | size | integer | int32 | | totalPages | boolean | int32 | | first | boolean | | | last | integer | | | numberOfElements | [Sort](#sort-definition) | int32 | ### PasswordPolicyResponse Definition | Property | Type | Format | | ------------------- | ------- | ------ | | | | | | cantContainUsername | boolean | | | minLength | integer | int32 | | requireNumber | boolean | | | requireSpecialChar | boolean | | | requireUppercase | boolean | | ### PasswordRequest Definition | Property | Type | Format | | ----------- | ------ | ------ | | newPassword | string | | | oldPassword | string | | ### ProcessInstanceResponse Definition | Property | Type | Format | | -------- | ------ | ------ | | id | string | | | key | string | | ### PublicationSetting Definition | Property | Type | Format | | -------- | ------- | ------ | | id | integer | int64 | | strategy | string | | ### Resource Definition | Property | Type | Format | | ----------- | -------------------------------------- | ------ | | description | | | | file | string | | | filename | file | | | inputStream | string | | | open | [InputStream](#inputstream-definition) | | | readable | boolean | | | uri | boolean | | | url | [URI](#uri-definition) | | ### ResponseEntity Definition | Property | Type | Format | | ---------- | ------ | ------ | | body | object | | | statusCode | string | | ### RoleAssignment Definition | Property | Type | Format | | ---------- | ------------------------------------------ | ------ | | createDate | | int64 | | createdBy | integer | | | id | [User](#user-definition) | int64 | | role | integer | | | target | string | | | user | [OutputChannel](#outputchannel-definition) | | ### RoleMapResponse Definition | Property | Type | Format | | ----------------- | ---------------------------------------- | ------ | | roleAssignmentMap | | | | user | object | | ### RoleRequest Definition | Property | Type | Format | | --------------- | ------- | ------ | | | | | | outputChannelId | integer | int64 | | roles | array | | | userId | integer | int64 | ### RoleUpdate Definition | Property | Type | Format | | ------------- | ------- | ------ | | | | | | outputChannel | integer | int64 | | role | string | | | userId | integer | int64 | ### Sort Definition | Property | Type | Format | | -------- | ---- | ------ | ### SpellCheckResponse Definition | Property | Type | Format | | -------- | ------ | ------ | | error | string | | | words | object | | ### StringResponse Definition | Property | Type | Format | | -------- | ------ | ------ | | | | | | value | string | | ### Subscription Definition | Property | Type | Format | | -------- | ------------------------------------------ | ------ | | | | | | id | integer | int64 | | target | [OutputChannel](#outputchannel-definition) | | | user | [User](#user-definition) | | ### SubscriptionResponse Definition | Property | Type | Format | | ------------- | -------------------------------------------------------------------- | ------ | | | | | | id | integer | int64 | | outputChannel | [OutputChannelShortResponse](#outputchannelshortresponse-definition) | | | user | [UserShortResponse](#usershortresponse-definition) | | ### SubscriptionUpdate Definition | Property | Type | Format | | --------------- | ------- | ------ | | outputChannelId | integer | int64 | | userId | integer | int64 | ### SubscriptionsResponse Definition | Property | Type | Format | | ----------- | ------ | ------ | | involuntary | array | | | voluntary | object | | ### TaskCompletionRequest Definition | Property | Type | Format | | --------- | ------ | ------ | | comment | string | | | variables | object | | ### TaskResponse Definition | Property | Type | Format | | ----------------- | -------------------------------------------------- | ------ | | executionId | string | | | formKey | string | | | processVariables | object | | | priority | integer | int32 | | taskVariables | object | | | dueDate | integer | int64 | | processInstanceId | string | | | taskId | string | | | owner | [UserShortResponse](#usershortresponse-definition) | | | assignee | [UserShortResponse](#usershortresponse-definition) | | ### Template Definition | Property | Type | Format | | --------------- | ------- | ------ | | form | array | | | key | string | | | name | object | | | sortOrder | integer | int32 | | titleKey | string | | | visibleColumns | array | | | visibleStatuses | array | | | workflow | boolean | | ### Translation Definition | Property | Type | Format | | ------------- | ----------------------------------------- | ------ | | createDate | integer | int64 | | createdBy | :link | | | entry | {:text "User", :url "#user-definition"} | | | id | :link | int64 | | latestValues | {:text "Entry", :url "#entry-definition"} | | | latestVersion | integer | int64 | | locale | object | | | versions | integer | | ### TranslationCapability Definition | Property | Type | Format | | ---------- | ------- | ------ | | | | | | fromLocale | string | | | id | integer | int64 | | toLocale | string | | ### TranslationResponse Definition | Property | Type | Format | | ------------- | ---------------------------------------------------- | ------ | | | | | | createDate | integer | int64 | | createdBy | [UserShortResponse](#usershortresponse-definition) | | | entry | [EntryShortResponse](#entryshortresponse-definition) | | | id | integer | int64 | | latestVersion | integer | int64 | | locale | string | | | values | object | | ### TranslationUpdateResultResponse Definition | Property | Type | Format | | ----------- | --------------------------------------------------------------------- | ------ | | translation | | | | updates | :link | | ### TranslationVersion Definition | Property | Type | Format | | ------------ | ----------------------------------------------------- | ------ | | createDate | | int64 | | createdBy | integer | | | entry | [User](#user-definition) | | | entryValues | [Entry](#entry-definition) | | | entryVersion | array | int64 | | id | integer | int64 | | translation | integer | | | version | :link | int64 | ### URI Definition | Property | Type | Format | | --------------------- | ------- | ------ | | | | | | path | string | | | rawQuery | string | | | fragment | string | | | authority | string | | | rawAuthority | string | | | port | integer | int32 | | absolute | boolean | | | host | string | | | rawPath | string | | | opaque | boolean | | | rawSchemeSpecificPart | string | | | rawUserInfo | string | | | query | string | | | rawFragment | string | | | scheme | string | | | userInfo | string | | | schemeSpecificPart | string | | ### URL Definition | Property | Type | Format | | ----------- | ------- | ------ | | | | | | path | string | | | protocol | string | | | ref | string | | | content | object | | | authority | string | | | file | string | | | port | integer | int32 | | host | string | | | query | string | | | defaultPort | integer | int32 | | userInfo | string | | ### UiConfigResponse Definition | Property | Type | Format | | ------------- | ------------------------------------------------------- | ------ | | uiLocales | array | | | userStates | object | | | loginUser | [UserResponse](#userresponse-definition) | | | entryFields | array | | | currentUser | :link | | | defaultLocale | {:text "UserResponse", :url "#userresponse-definition"} | | | otherTabs | string | | | entryLocales | array | | | templates | array | | | userRoles | object | | ### User Definition | Property | Type | Format | | ----------------------- | -------------------------------------------------------- | ------ | | email | | | | disabled | string | | | locale | boolean | | | superadmin | string | | | displayName | boolean | | | roles | string | | | username | array | | | authenticationMethod | string | | | firstName | [AuthenticationMethod](#authenticationmethod-definition) | | | translationCapabilities | string | | | expires | array | int64 | | subscriptions | integer | | | active | array | | | id | boolean | int64 | | lastName | integer | | | lastLogin | string | int64 | ### UserResponse Definition | Property | Type | Format | | ----------------------- | ----------------------------------------------------------------------- | ------ | | | string | | | email | boolean | | | disabled | string | | | locale | boolean | | | superadmin | string | | | displayName | object | | | roles | string | | | username | :link | | | authenticationMethod | {:text "AuthenticationMethod", :url "#authenticationmethod-definition"} | | | firstName | string | | | translationCapabilities | array | | | expires | integer | int64 | | active | boolean | | | id | integer | int64 | | lastName | string | | | lastLogin | integer | int64 | ### UserShortResponse Definition | Property | Type | Format | | ----------- | ------- | ------ | | displayName | string | | | email | string | | | id | integer | int64 | | username | string | | ### UserUpdate Definition | Property | Type | Format | | ----------------------- | ------- | ------ | | email | string | | | disabled | boolean | | | locale | string | | | superadmin | boolean | | | username | string | | | authenticationMethod | string | | | firstName | string | | | translationCapabilities | array | | | expires | integer | int64 | | lastName | string | | ### ValueUpdate Definition | Property | Type | Format | | -------- | ---------------------------------------------- | ------ | | values | | | | workflow | object | | ### ValueUpdateResponse Definition | Property | Type | Format | | -------- | ------- | ------ | | hasError | boolean | | | inputKey | string | | | message | string | | | updated | boolean | | ### WorkflowRequest Definition | Property | Type | Format | | ----------------- | ------- | ------ | | | | | | completesTaskId | string | | | variables | object | | | startMainWorkflow | boolean | | ## Additional Resources []( "External Documentation")