4allportalconnector v1 | OneTeg Documentation

Version 1

Connector Overview: This page documents all 145 actions for the 4allportalconnector v1.

Active (3)

GET Get ordered list of the active applications

/api/system/apps/active

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Embed`	Embed some additional objects
`Accept`	N/A
`Response Type`	N/A

DELETE Remove ordered list of the applications

/api/system/apps/active

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

PUT Set ordered list of the applications

/api/system/apps/active

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

Admin-structure

GET Get admin structure

/api/system/admin-structure

get admin structure

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Audit

GET get audit entries

/api/modules/{module}/objects/{id}/audit

get audit entries

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Offset`	N/A
`Count`	N/A
`Query`	N/A
`Module`	(Required) name of the module
`Id`	(Required) id of the recored
`Accept`	N/A
`Response Type`	N/A

Backups

POST /system/installation/backups

/api/system/installation/backups

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Inf`	N/A

Base-configuration (2)

GET /system/base-configuration

/api/system/base-configuration

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

PUT /system/base-configuration

/api/system/base-configuration

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Change-password-by-code

POST change password by code

/api/auth/change-password-by-code

change password by code

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Userid`	N/A
`Code`	N/A
`Newpassword`	N/A

Change-password

POST change password

/api/auth/change-password

change password

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Oldpassword`	N/A
`Newpassword`	N/A

Compare

POST /system/installation/compare

/api/system/installation/compare

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Connectors

GET Get a list of the PAP connectors

/api/connectors

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Create-package

POST /system/installation/create-package

/api/system/installation/create-package

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Database (2)

GET Get database config

/api/system/configs/database

Get database configs

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

PUT Update/Create database config

/api/system/configs/database

Update/Create database config

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (17)

Option Name	Description
`Databasename`	N/A
`Maxidletime`	N/A
`Type`	N/A
`Valid`	N/A
`Password`	N/A
`Minpoolsize`	N/A
`Balancertype`	N/A
`Port`	N/A
`Integratedsecurity`	N/A
`Host`	N/A
`Jdbcurl`	N/A
`Name`	N/A
`Maxpoolsize`	N/A
`User`	N/A
`Slowqueryloggingenabled`	N/A
`Slowqueryloggingthresholdmilliseconds`	N/A
`Slowqueryloggingstatementexclusionregexes`	N/A

Files (4)

DELETE Delete all files (for this module snapin)

/api/modules/{module}/configs/{snapin}/objects/{id}/files

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Module`	(Required) module name
`Snapin`	(Required) snapIn name
`Id`	(Required) module snapIn id, if single module snapin then id=default_single
`Accept`	N/A
`Response Type`	N/A

DELETE Delete all files (for this snapin)

/api/system/configs/{snapin}/objects/{id}/files

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Snapin`	(Required) snapIn name
`Id`	(Required) snapIn id, if single snapin then id=default_single
`Accept`	N/A
`Response Type`	N/A

GET Get files (for this module snapin)

/api/modules/{module}/configs/{snapin}/objects/{id}/files

get files (for this module snapin)

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Module`	(Required) module name
`Snapin`	(Required) snapIn name
`Id`	(Required) module snapIn id, if single module snapin then id=default_single
`Accept`	N/A
`Response Type`	N/A

GET Get files (for this snapin)

/api/system/configs/{snapin}/objects/{id}/files

get files (for this snapin)

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Snapin`	(Required) snapIn name
`Id`	(Required) snapIn id, if single snapin then id=default_single
`Accept`	N/A
`Response Type`	N/A

Icon

GET Get icon of the given version of the given artifact

/api/system/apps/repository/{artifactId}/{version}/icon

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Artifactid`	(Required) The id of the application artifact
`Version`	(Required) The version of the application artifact
`Accept`	N/A
`Response Type`	N/A

Icons

GET Returns a list of all icons

/api/system/icons

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Isproxy`	Set to true to search for icons proxies, that redirect to another icon from icon library.
`Type`	Non proxy icons have one of this type.
`Accept`	N/A
`Response Type`	N/A

Info

GET /system/installation/info

/api/system/installation/info

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Install-package

POST /system/installation/install-package

/api/system/installation/install-package

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Content-type`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`File`	N/A
`Description`	N/A
`Reload`	N/A

Layouts

GET Get all layouts of module or just the requested ids

/api/modules/{module}/layouts

The result is a Map of id => Layout. The layouts are same as requested separately via single layout GET

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Ids`	(Required)
`Objecttype`	(Required)
`Module`	(Required)
`Accept`	N/A
`Response Type`	N/A

Locales

GET Returns all languages supported in system

/api/system/locales

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Log-events

POST Create new logging record

/api/system/log-events

Add a logging event record to the server

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (5)

Option Name	Description
`Type`	N/A
`Thread`	N/A
`Classpath`	N/A
`Message`	N/A
`Stacktrace`	N/A

POST Logs in and returns the authentication cookie

/api/auth/login

Loges in to 4ALLPORTAL and get defined objects

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (9)

Option Name	Description
`Username`	N/A
`Password`	N/A
`Language`	N/A
`Fallbacklanguage`	N/A
`Authenticationprovider`	N/A
`Clienttype`	N/A
`Token`	N/A
`Embed`	N/A
`Modulerequestgroups`	N/A

Logout

POST Logs out and removes session cookies

/api/auth/logout

Logs out from 4ALLPORTAL and delete session cookies

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Mail (2)

GET Get mail config

/api/system/configs/mail

Get mail configs

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

PUT Update/Create mail config

/api/system/configs/mail

Update/Create mail config

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (14)

Option Name	Description
`Valid`	N/A
`Enabled`	N/A
`Host`	N/A
`User`	N/A
`Password`	N/A
`Useauthentication`	N/A
`Usereplyto`	N/A
`Systemfromemail`	N/A
`Systemfromname`	N/A
`Systemreplytoemail`	N/A
`Systemmailsender`	N/A
`Security`	N/A
`Port`	N/A
`Name`	N/A

Media (4)

DELETE Delete the preview image and all image reference

/api/modules/{module}/objects/{id}/media

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Client Type`	The client type (optional)
`Module`	(Required) The name of the module
`Id`	(Required) UUID of the data entry
`Accept`	N/A
`Response Type`	N/A

GET Get the types of the image representation of this object

/api/modules/{module}/objects/{id}/media

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Client Type`	The client type (optional)
`Module`	(Required) The name of the module
`Id`	(Required) UUID of the data entry
`Accept`	N/A
`Response Type`	N/A

POST Set the preview image as reference to the preview of the other object

/api/modules/{module}/objects/{id}/media

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Client Type`	The client type (optional)
`Module`	(Required) The name of the module
`Id`	(Required) UUID of the data entry
`Accept`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Id`	N/A
`Module`	N/A
`Mode`	N/A

PUT Upload of the preview image

/api/modules/{module}/objects/{id}/media

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Client Type`	The client type (optional)
`Module`	(Required) The name of the module
`Id`	(Required) UUID of the data entry
`Content-type`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`File`	N/A

Metrics

GET Returns all or requested metrics

/api/system/metrics

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Names`	N/A
`Accept`	N/A
`Response Type`	N/A

Missing-label-translations

PUT Report missing translations

/api/system/missing-label-translations

Report missing label translations for admin review.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Labelkey`	N/A
`Lang`	N/A

Modules

GET Returns the definition of all modules

/api/modules

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Groups`	N/A
`Modules`	N/A
`Accept`	N/A
`Response Type`	N/A

Objects (20)

PATCH Create a new resource(s) or update existing in {module}/objects

/api/modules/{module}/objects

Add one or more items to the resource or update existing resource(s).

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Module`	(Required)
`Accept`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Id`	N/A
`Module`	N/A
`Type`	N/A
`Mod Time`	N/A

DELETE Delete given view profiles

/api/system/configs/view-profile/objects

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Names`	N/A
`Accept`	N/A
`Response Type`	N/A

DELETE Deletes all records in query parameter ids of {module}

/api/modules/{module}/objects

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Query`	(Required) SQL like where clause. For example: query=price > 15 AND name LIKE 'a%'. It is also possible to use curly braces to create subgroups. Note that the URL needs to be URL encoded.
`Module`	(Required)
`Accept`	N/A
`Response Type`	N/A

GET Get all Configs (for this module snapin)

/api/modules/{module}/configs/{snapin}/objects

get {module}->{snapin} configs

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Module`	(Required) module name
`Snapin`	(Required) snapIn name
`Accept`	N/A
`Response Type`	N/A

GET Get all Configs (for this snapin)

/api/system/configs/{snapin}/objects

get {snapin} configs

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Snapin`	(Required) snapIn name
`Accept`	N/A
`Response Type`	N/A

GET Get all layout set configs for {module}

/api/modules/{module}/configs/layout-set/objects

Get all layout set configs for {module}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Module`	(Required) module name
`Accept`	N/A
`Response Type`	N/A

GET Get all object renderer set configs for {module}

/api/modules/{module}/configs/object-renderer-set/objects

Get all object renderer set configs for {module}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Module`	(Required) module name
`Accept`	N/A
`Response Type`	N/A

GET Get all view profile configs

/api/system/configs/view-profile/objects

Get view profile configs

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

DELETE Restore all defaults (for this module snapin)

/api/modules/{module}/configs/{snapin}/objects

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Names`	N/A
`Module`	(Required) module name
`Snapin`	(Required) snapIn name
`Accept`	N/A
`Response Type`	N/A

DELETE Restore all defaults (for this snapin)

/api/system/configs/{snapin}/objects

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Names`	N/A
`Snapin`	(Required) snapIn name
`Accept`	N/A
`Response Type`	N/A

DELETE Restore to default layout set. The given layout sets are deleted from runtime folder.

/api/modules/{module}/configs/layout-set/objects

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Names`	N/A
`Module`	(Required) module name
`Accept`	N/A
`Response Type`	N/A

DELETE Restore to default object renderer set. After this only object renderer sets from apps exist.

/api/modules/{module}/configs/object-renderer-set/objects

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Names`	N/A
`Module`	(Required) module name
`Accept`	N/A
`Response Type`	N/A

GET Returns objects of {connector}

/api/connectors/{connector}/objects

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Ids`	N/A
`Connector`	(Required)
`Accept`	N/A
`Response Type`	N/A

GET Returns records from {module}

/api/modules/{module}/objects

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Fields`	N/A
`Embed`	A list of fields to join and embed as _embedded. To for example embed the created_by user object add created_by to this list. If you would like to define a list of fields to load that object use brackets: created_by[id, firstname, lastname]. The embedded object will then only contain these fields to prevent overfetching.
`Offset`	N/A
`Limit`	N/A
`Sort`	Array of fields to sort by. Each field may be postfixed by :desc(descending) or :asc(ascending). If ommited the sort direction is ascending is used.
`Query`	SQL like where clause. For example: query=price > 15 AND name LIKE 'a%'. It is also possible to use curly braces to create subgroups. Note that the URL needs to be URL encoded.
`Totalcount`	If true, it returns the total number of results for a query. The value appears as total_count in the result object. The server only counts up to a maximum of 15.000 for performance reasons.
`Module`	(Required)
`Accept`	N/A
`Response Type`	N/A

PUT Save all Configs (for this snapin)

/api/modules/{module}/configs/{snapin}/objects

Update/Create {module}->{snapin} config

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Module`	(Required) module name
`Snapin`	(Required) snapIn name
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

PUT Save all Configs (for this snapin)

/api/system/configs/{snapin}/objects

Update/Create {snapin} config

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Snapin`	(Required) snapIn name
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

PUT Save all layout configs

/api/modules/{module}/configs/layout-set/objects

Update/Create layout configs

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Module`	(Required) module name
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

PUT Save all object renderer configs

/api/modules/{module}/configs/object-renderer-set/objects

Update/Create object renderer configs

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Module`	(Required) module name
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

PUT Save all view profile configs

/api/system/configs/view-profile/objects

Update/Create view profile config

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

POST Updates records of {module}

/api/modules/{module}/objects

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Query`	(Required)
`Module`	(Required)
`Accept`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Id`	N/A
`Module`	N/A
`Type`	N/A
`Mod Time`	N/A

Operations

GET /modules/:module/operations

/api/modules/{module}/operations

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Ids`	List of object ids to apply the configured conditions to.
`Groups`	N/A
`Names`	N/A
`Type`	N/A
`Relationname`	N/A
`View`	N/A
`Relatedbeanid`	N/A
`Module`	(Required)
`Accept`	N/A
`Response Type`	N/A

Password-policy

GET Returns password policy

/api/system/password-policy

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Permissions

GET get user feature permissions

/api/session/permissions

get user feature permissions

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Presets (3)

PATCH change presets

/api/session/presets

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Eua1`	N/A
`Sint1`	N/A
`Ut 8be`	N/A

DELETE delete presets

/api/session/presets

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Keys`	(Required)
`Accept`	N/A
`Response Type`	N/A

GET get user presets

/api/session/presets

get user presets

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Providers

GET get configured authentication providers

/api/auth/providers

get list of configured authentication providers

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Reload

POST reload the configuration

/api/system/operations/reload

Reload the 4ALLPORTAL configuration. Needs admin permission.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Renderers

GET Returns all or requested renderder

/api/modules/{module}/renderers

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Ids`	N/A
`Objecttype`	N/A
`Module`	(Required)
`Accept`	N/A
`Response Type`	N/A

Repository

GET Get all respository apps

/api/system/apps/repository

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Embed`	Embed some additional objects
`Accept`	N/A
`Response Type`	N/A

Request-password-change-mail

POST request password change mail

/api/auth/request-password-change-mail

request password change mail for username

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Username`	N/A

Restart

POST restart the 4ALLPORTAL

/api/system/operations/restart

Stops the 4ALLPORTAL. A service process then can restart the system.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Run

POST /modules/:module/operations/:name/run

/api/modules/{module}/operations/{name}/run

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Module`	(Required)
`Name`	(Required)
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Ids`	N/A

Session

GET check if session exist

/api/session

check if session exist and deliver content like login if exist

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Embed`	Additional content to get with session attributes
`Modulerequestgroups`	Name of groups to get with modules. If null dont't get content for groups.
`Accept`	N/A
`Response Type`	N/A

Stats

GET Return of deleted and total number of module objects

/api/modules/{module}/stats

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Module`	(Required)
`Accept`	N/A
`Response Type`	N/A

Test

POST tests an existing webhook event

/api/system/webhooks/{webhookId}/{eventId}/test

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Webhookid`	(Required) The UUID of the webhook
`Eventid`	(Required) The UUID of the webhook event
`Accept`	N/A
`Response Type`	N/A

Themes

GET Returns the configured themes in system

/api/system/themes

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Names`	N/A
`Accept`	N/A
`Response Type`	N/A

Translations-file (2)

GET Returns a list of TranslationObjects based on query parameter

/api/system/configs/translations-file

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Context`	N/A
`Contextname`	N/A
`Type`	N/A
`Object`	N/A
`Translationorkey`	N/A
`Missinginlocale`	N/A
`Sort`	Field to order including order direction postfixed :desc(descending) or :asc(ascending).
`Accept`	N/A
`Response Type`	N/A

POST Update translations for multiple ids by file

/api/system/configs/translations-file

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Content-type`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`File`	N/A

Translations (2)

GET Returns a list of translation objects based on query parameter

/api/system/configs/translations

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Context`	If the label key is automatically created by 4ALLPORTAL, the context tells where the label origins from.
`Contextname`	For automatically created labels keys, the context is filled with the instance name of the context - e.g. salutation if of context field in object contact.
`Type`	For automatically created labels keys, this is label or info.
`Object`	Depending on the context, this can be the name of the module or 'global' for global content
`Translationorkey`	Query for translation in any locale or label key
`Missinginlocale`	Provide a locale like 'en_US' to search for objects with missing translations for that locale.
`Offset`	N/A
`Limit`	N/A
`Sort`	Field to order including order direction postfixed :desc(descending) or :asc(ascending).
`Accept`	N/A
`Response Type`	N/A

PATCH Update translations for multiple ids

/api/system/configs/translations

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (6)

Option Name	Description
`Key`	N/A
`Context`	N/A
`Contextname`	N/A
`Contextidentifier`	N/A
`Object`	N/A
`Type`	N/A

Tutorials

GET Returns the open tutorials and possible progress for this user

/api/user/tutorials

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Typeahead (2)

GET Returns found ModuleObject

/api/modules/{module}/typeahead

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Value`	Searched value
`Limit`	Maximum number of response values
`Query`	N/A
`Module`	(Required) Module name
`Accept`	N/A
`Response Type`	N/A

GET Returns found ModuleObject

/api/multi-module/typeahead

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Value`	Searched value
`Accept`	N/A
`Response Type`	N/A

Updates

GET Get updates for active or all applications

/api/system/apps/updates

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Active Only`	Check for update only for active applications
`Accept`	N/A
`Response Type`	N/A

Upload (2)

POST Upload Create session

/service/v2/filetran_obj/stage/createUploadSession

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Session`	N/A
`Response Type`	N/A

Options (6)

Option Name	Description
`File Name`	N/A
`File Mod Time`	N/A
`File Create Time`	N/A
`Target Folder`	N/A
`Auto Transfer`	N/A
`Collision Action`	N/A

PUT Upload file

/service/v2/filetran_obj/stage/upload/{sessionID}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Sessionid`	N/A
`Session`	N/A
`Content-range`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`File`	N/A

User

GET Get current user's object

/api/user

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Value-options

GET Returns all or requested ValueOptions

/api/system/value-options

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Ids`	N/A
`Accept`	N/A
`Response Type`	N/A

Webhooks

POST Sets a new webhook

/api/system/webhooks

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (5)

Option Name	Description
`Url`	N/A
`Id`	N/A
`Active`	N/A
`Secret`	N/A
`Eventsjson`	N/A

{artifactId} (8)

PUT Activate latest version of the given artifact

/api/system/apps/active/{artifactId}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Artifactid`	(Required) The id of the application artifact
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

DELETE Deactivate any version of the artifact

/api/system/apps/active/{artifactId}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Artifactid`	(Required) The id of the application artifact
`Accept`	N/A
`Response Type`	N/A

DELETE Delete the artifact from the local application repository

/api/system/apps/repository/{artifactId}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Artifactid`	(Required) The id of the application artifact
`Accept`	N/A
`Response Type`	N/A

GET Get all versions to given artifact

/api/system/apps/repository/{artifactId}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Artifactid`	(Required) The id of the application artifact
`Accept`	N/A
`Response Type`	N/A

GET Get specific artifact of the active applications

/api/system/apps/active/{artifactId}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Artifactid`	(Required) The id of the application artifact
`Accept`	N/A
`Response Type`	N/A

GET Get the latest version of the specified artifact from the marketplace

/api/system/apps/marketplace/{artifactId}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Type`	Release type of the application
`Artifactid`	(Required) The id of the application artifact
`Accept`	N/A
`Response Type`	N/A

GET Get updates for specific artifact

/api/system/apps/updates/{artifactId}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Types`	Release types of the application
`Artifactid`	(Required) The id of the application artifact
`Accept`	N/A
`Response Type`	N/A

PUT Load latest version of the given atrifact and of the same release type

/api/system/apps/repository/{artifactId}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Artifactid`	(Required) The id of the application artifact
`Accept`	N/A
`Response Type`	N/A

{connector}

GET Returns details of {connector}

/api/connectors/{connector}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Connector`	(Required)
`Accept`	N/A
`Response Type`	N/A

{filekey} (6)

DELETE Delete specified config file

/api/system/configs/{snapin}/objects/{id}/files/{filekey}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Snapin`	(Required) snapIn name
`Id`	(Required) snapIn id, if single snapin then id=default_single
`Filekey`	(Required) snapIn name
`Accept`	N/A
`Response Type`	N/A

DELETE Delete specified module config file

/api/modules/{module}/configs/{snapin}/objects/{id}/files/{filekey}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Module`	(Required) module name
`Snapin`	(Required) snapIn name
`Id`	(Required) module snapIn id, if single module snapin then id=default_single
`Filekey`	(Required) snapIn name
`Accept`	N/A
`Response Type`	N/A

GET Get specified config file

/api/system/configs/{snapin}/objects/{id}/files/{filekey}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Snapin`	(Required) snapIn name
`Id`	(Required) snapIn id, if single snapin then id=default_single
`Filekey`	(Required) snapIn name
`Accept`	N/A
`Response Type`	N/A

GET Get specified module config file

/api/modules/{module}/configs/{snapin}/objects/{id}/files/{filekey}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Module`	(Required) module name
`Snapin`	(Required) snapIn name
`Id`	(Required) module snapIn id, if single module snapin then id=default_single
`Filekey`	(Required) snapIn name
`Accept`	N/A
`Response Type`	N/A

PUT upload specified configs file

/api/system/configs/{snapin}/objects/{id}/files/{filekey}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Filename`	(Required) file name
`Snapin`	(Required) snapIn name
`Id`	(Required) snapIn id, if single snapin then id=default_single
`Filekey`	(Required) snapIn name
`Content-type`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`File`	N/A

PUT upload specified module configs file

/api/modules/{module}/configs/{snapin}/objects/{id}/files/{filekey}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Filename`	(Required) file name
`Module`	(Required) module name
`Snapin`	(Required) snapIn name
`Id`	(Required) module snapIn id, if single module snapin then id=default_single
`Filekey`	(Required) snapIn name
`Content-type`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`File`	N/A

{filename}

GET Return the image for audit objects

/api/modules/{module}/objects/{id}/audit/{auditid}/media/{filename}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Module`	(Required) module name
`Id`	(Required) Id from module object
`Auditid`	(Required) Id from audit object
`Filename`	(Required) File name from audit object
`Accept`	N/A
`Response Type`	N/A

{id} (23)

POST Adds a new locale

/api/system/configs/locale/{id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	(Required) The id of the locale e.g. en_US
`Accept`	N/A
`Response Type`	N/A

POST Create new objects with a specified id

/api/modules/{module}/objects/{id}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Module`	(Required) The name of the module
`Id`	(Required) UUID of the data entry
`Accept`	N/A
`Response Type`	N/A

PUT Creates an icon proxy

/api/system/configs/icons/{id}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	(Required) Icon id
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

DELETE Deletes all translations for {id}

/api/system/configs/translations/{id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Locale`	The name of the locale to delete the translation for. Empty will delete all translations in custom.
`Id`	(Required) The language independent key of the label
`Accept`	N/A
`Response Type`	N/A

DELETE Deletes record {id} in {module}

/api/modules/{module}/objects/{id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Module`	(Required) The name of the module
`Id`	(Required) UUID of the data entry
`Accept`	N/A
`Response Type`	N/A

GET Get specified config

/api/system/configs/{snapin}/objects/{id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Snapin`	(Required) snapIn name
`Id`	(Required) snapIn id
`Accept`	N/A
`Response Type`	N/A

GET Get specified module config

/api/modules/{module}/configs/{snapin}/objects/{id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Module`	(Required) module name
`Snapin`	(Required) snapIn name
`Id`	(Required) snapIn id
`Accept`	N/A
`Response Type`	N/A

GET Get the layout for the given id

/api/modules/{module}/layouts/{id}

The result is a layout defined in this module or in global. The result layout will be computed with a module-global-fallback logic

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Objecttype`	(Required)
`Module`	(Required)
`Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

DELETE Restore specified defaults

/api/system/configs/{snapin}/objects/{id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Snapin`	(Required) snapIn name
`Id`	(Required) snapIn id
`Accept`	N/A
`Response Type`	N/A

DELETE Restore specified module config defaults

/api/modules/{module}/configs/{snapin}/objects/{id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Module`	(Required) module name
`Snapin`	(Required) snapIn name
`Id`	(Required) snapIn id
`Accept`	N/A
`Response Type`	N/A

GET Returns ValueOption requested in "id"

/api/system/value-options/{id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

GET Returns a translation object for the requested key including all localized translations

/api/system/configs/translations/{id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Context`	If the result contains related translations objects from the context
`Id`	(Required) The language independent key of the label
`Accept`	N/A
`Response Type`	N/A

GET Returns details of {id} in {module}

/api/modules/{module}/objects/{id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Fields`	N/A
`Embed`	Retrive related objects via relations, comma separated
`Module`	(Required) The name of the module
`Id`	(Required) UUID of the data entry
`Accept`	N/A
`Response Type`	N/A

GET Returns events of {connector} with event id greater than {id}

/api/connectors/{connector}/events/{id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Hash`	(Required) connector hash
`Connector`	(Required)
`Id`	(Required) last event id
`Accept`	N/A
`Response Type`	N/A

GET Returns objects of {connector}

/api/connectors/{connector}/objects/{id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Connector`	(Required)
`Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

GET Returns the requested icon

/api/system/themes/{theme}/icons/{id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Theme`	(Required) Theme name
`Id`	(Required) Icon id
`Accept`	N/A
`Response Type`	N/A

GET Returns the requested object renderer set search item

/api/modules/{module}/search-config/{id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Module`	(Required)
`Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

GET Returns the requested renderer

/api/modules/{module}/renderers/{id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Objecttype`	N/A
`Module`	(Required)
`Id`	(Required)
`Accept`	N/A
`Response Type`	N/A

GET Returns translations requested in "id"

/api/system/locales/{locale}/{id}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Locale`	(Required) Locale
`Id`	(Required) Id from translation
`Accept`	N/A
`Response Type`	N/A

PUT Save specified configs

/api/system/configs/{snapin}/objects/{id}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Snapin`	(Required) snapIn name
`Id`	(Required) snapIn id
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

PUT Save specified module configs

/api/modules/{module}/configs/{snapin}/objects/{id}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Module`	(Required) module name
`Snapin`	(Required) snapIn name
`Id`	(Required) snapIn id
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

PATCH Update translations for {id}

/api/system/configs/translations/{id}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Id`	(Required) The language independent key of the label
`Accept`	N/A
`Response Type`	N/A

Options (6)

Option Name	Description
`Key`	N/A
`Context`	N/A
`Contextname`	N/A
`Contextidentifier`	N/A
`Object`	N/A
`Type`	N/A

PATCH Updates the record for {id} in {module}

/api/modules/{module}/objects/{id}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Module`	(Required) The name of the module
`Id`	(Required) UUID of the data entry
`Accept`	N/A
`Response Type`	N/A

{locale}

GET Returns all or translations requested in "ids"

/api/system/locales/{locale}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Ids`	N/A
`Locale`	(Required) Locale
`Accept`	N/A
`Response Type`	N/A

{module} (3)

GET Returns the module definition

/api/modules/{module}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Groups`	N/A
`Module`	(Required) The module name
`Accept`	N/A
`Response Type`	N/A

GET get user feature permissions

/api/session/permissions/{module}

get user feature permissions

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Module`	(Required) name of the module
`Accept`	N/A
`Response Type`	N/A

GET get user presets

/api/session/presets/{module}

get user presets

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Module`	(Required) name of the module
`Accept`	N/A
`Response Type`	N/A

{name} (4)

GET /modules/:module/operations/:name

/api/modules/{module}/operations/{name}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Ids`	List of object ids to apply the configured conditions to.
`Groups`	N/A
`Type`	N/A
`Relationname`	N/A
`View`	N/A
`Relatedbeanid`	N/A
`Module`	(Required)
`Name`	(Required)
`Accept`	N/A
`Response Type`	N/A

GET Returns metric requested in "name"

/api/system/metrics/{name}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Name`	(Required)
`Accept`	N/A
`Response Type`	N/A

GET get user feature permissions

/api/session/permissions/{module}/{name}

get user feature permissions

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Module`	(Required) name of the module
`Name`	(Required) get for key
`Accept`	N/A
`Response Type`	N/A

GET get user presets

/api/session/presets/{module}/{name}

get user presets

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Module`	(Required) name of the module
`Name`	(Required) get for key
`Accept`	N/A
`Response Type`	N/A

{theme}

GET Returns the configured themes in system

/api/system/themes/{theme}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Theme`	(Required) Theme name
`Accept`	N/A
`Response Type`	N/A

{tutorialId}

PATCH Updates the user statistics for a tutorial

/api/user/tutorials/{tutorialId}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Tutorialid`	(Required) The name / id of the tutorial available from 4ALLPORTAL Admin Snapin
`Accept`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Status`	N/A
`User`	N/A
`Stepsfinished`	N/A
`Percentfinished`	N/A

{type} (3)

DELETE Delete the preview image

/api/modules/{module}/objects/{id}/media/{type}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Client Type`	The client type (optional)
`Index`	The index of the media (e.g. the index of the page of a document)
`Module`	(Required) The name of the module
`Id`	(Required) UUID of the data entry
`Type`	(Required) The type of the media output
`Accept`	N/A
`Response Type`	N/A

GET Get the image representation of this object and change the output preview if necessary

/api/modules/{module}/objects/{id}/media/{type}

The result can be of type image/jpeg, image/png.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Width`	target width of the image
`Height`	target height of the image
`Resizefit`	Controls how the output image is fit to its target dimensions after resizing. clip - Resize the image so that it fits into the specified width an height without distorting the image. crop - Crops the specified width and height from the middle of the image. scale - Resizes the image by width and height. If height or width is not specified, it is calcuated proportionally.
`Quality`	quality for JPEG downloads
`Cropleft`	lowest relative offset from left to cut out a rectangular region of the image
`Croptop`	lowest relative offset from top to cut out a rectangular region of the image
`Cropright`	highest relative offset from left to cut out a rectangular region of the image
`Cropbottom`	highest relative offset from top to cut out a rectangular region of the image
`Dpi`	resample image to specified horizontal and vertical resolution
`Rotate`	Rotates the image by degrees according to the value specified. The rotation is clockwise with 0 (the default) at the top of the image. The image will be zoomed after rotation so that it covers the entire specified dimensions
`Flip`	Flips the image horizontally, vertically, or both: h - horizontal flip v - vertical flip hv - both
`Orientation`	Changes the cardinal orientation of the image. The image is rotated, but the Exif orientation metadata is not changed. 0 - do not rotate the image (Exif orientation 1) 1 - 90 degree clockwise (Exif orientation 8) 2 - 180 degree clockwise (Exif orientation 3) 3 - 270 degree clockwise (Exif orientation 6)
`Digitalrights`	Some images require a confirmation of the usage rights in order to be able to apply processing parameters. If the usage rights are required but not set, error 403 is returned.
`Frame`	Extract a frame from a video file at a specific position. The position is a time duration in seconds and can be specified as a decimal point (e.g. '2.345' for 2 seconds and 345 milliseconds)
`Client Type`	The client type (optional)
`Index`	The index of the media (e.g. the index of the page of a document)
`Module`	(Required) The name of the module
`Id`	(Required) UUID of the data entry
`Type`	(Required) The type of the media output
`Accept`	N/A
`Response Type`	N/A

PUT Upload of the preview image of the given type

/api/modules/{module}/objects/{id}/media/{type}

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Client Type`	The client type (optional)
`Index`	The index of the media (e.g. the index of the page of a document)
`Module`	(Required) The name of the module
`Id`	(Required) UUID of the data entry
`Type`	(Required) The type of the media output
`Content-type`	N/A
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`File`	N/A

{version} (6)

DELETE Delete specific version of the artifact from the local application repository

/api/system/apps/repository/{artifactId}/{version}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Artifactid`	(Required) The id of the application artifact
`Version`	(Required) The version of the application artifact
`Accept`	N/A
`Response Type`	N/A

GET Get specific version of the artifact

/api/system/apps/repository/{artifactId}/{version}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Artifactid`	(Required) The id of the application artifact
`Version`	(Required) The version of the application artifact
`Accept`	N/A
`Response Type`	N/A

GET Get the specified version of the specified artifact from the marketplace

/api/system/apps/marketplace/{artifactId}/{version}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Artifactid`	(Required) The id of the application artifact
`Version`	(Required) The version of the application artifact
`Accept`	N/A
`Response Type`	N/A

GET Get updates for specific artifact and version with dependecies check

/api/system/apps/updates/{artifactId}/{version}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Types`	Release types of the application
`Artifactid`	(Required) The id of the application artifact
`Version`	(Required) The version of the application artifact
`Accept`	N/A
`Response Type`	N/A

PUT Load and install the specific version of the artifact into the local application repository

/api/system/apps/repository/{artifactId}/{version}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Artifactid`	(Required) The id of the application artifact
`Version`	(Required) The version of the application artifact
`Accept`	N/A
`Response Type`	N/A

PATCH Perform install, update, enable, and disable application and resolve depdendencies

/api/system/apps/active/{artifactId}/{version}

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Types`	Release types of the application
`Artifactid`	(Required) The id of the application artifact
`Version`	(Required) The version of the application artifact
`Accept`	N/A
`Response Type`	N/A

Active (3)

Admin-structure

Audit

Backups

Base-configuration (2)

Change-password-by-code

Change-password

Compare

Connectors

Create-package

Database (2)

Files (4)

Icon

Icons

Info

Install-package

Layouts

Locales

Log-events

Login

Logout

Mail (2)

Media (4)

Metrics

Missing-label-translations

Modules

Objects (20)

Operations

Password-policy

Permissions

Presets (3)

Providers

Reload

Renderers

Repository

Request-password-change-mail

Restart

Run

Session

Stats

Test

Themes

Translations-file (2)

Translations (2)

Tutorials

Typeahead (2)

Updates

Upload (2)

User

Value-options

Webhooks

{artifactId} (8)

{connector}

{filekey} (6)

{filename}

{id} (23)

{locale}

{module} (3)

{name} (4)

{theme}

{tutorialId}

{type} (3)

{version} (6)