4ALLPORTAL Connector v1.0 Initial Release

Version 1

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

GET

Active: Get ordered list of the active applications

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

Active: Remove ordered list of the applications

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

Active: Set ordered list of the applications

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

GET

Admin-structure: Get 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

GET

Audit: get audit entries

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

POST

Backups: /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

GET

Base-configuration: /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

Base-configuration: /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

POST

Change-password-by-code: 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

POST

Change-password: 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

POST

Compare: /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

GET

Connectors: Get a list of the PAP 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

POST

Create-package: /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

GET

Database: Get database config

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

Database: Update/Create database config

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

DELETE

Files: Delete all 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

DELETE

Files: Delete all 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

GET

Files: Get files (for this module snapin)

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

Files: Get files (for this snapin)

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

GET

Icon: Get icon of the given version of the given artifact

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

Icons: Returns a list of all 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

GET

Info: /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

POST

Install-package: /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

GET

Layouts: Get all layouts of module or just the requested ids

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

GET

Locales: Returns all languages supported in 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

POST

Log-events: Create new logging record

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

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

POST

Logout: Logs out and removes session cookies

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

GET

Mail: Get mail config

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

Mail: Update/Create mail config

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

DELETE

Media: Delete the preview image and all image reference

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

Media: Get the types of the image representation of this object

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

Media: Set the preview image as reference to the preview of the other object

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

Media: Upload of the preview image

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

GET

Metrics: Returns all or requested 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

PUT

Missing-label-translations: Report missing 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

GET

Modules: Returns the definition of all 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

PATCH

Objects: Create a new resource(s) or update existing in {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

Objects: Delete given view profiles

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

Objects: Deletes all records in query parameter ids of {module}

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

Objects: Get all Configs (for this module snapin)

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

Objects: Get all Configs (for this snapin)

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

Objects: Get all layout set configs for {module}

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

Objects: Get all object renderer set configs for {module}

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

Objects: Get all view profile configs

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

Objects: Restore all defaults (for this module snapin)

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

Objects: Restore all defaults (for this snapin)

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

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

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

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

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

Objects: Returns objects of {connector}

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

Objects: Returns records from {module}

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

Objects: Save all Configs (for this snapin)

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

Objects: Save all Configs (for this snapin)

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

Objects: Save all layout configs

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

Objects: Save all object renderer configs

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

Objects: Save all view profile configs

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

Objects: Updates records of {module}

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

GET

Operations: /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

GET

Password-policy: Returns 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

GET

Permissions: get user feature 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

PATCH

Presets: change 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

Presets: delete 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

Presets: get user 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

GET

Providers: get configured authentication 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

POST

Reload: reload the configuration

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

GET

Renderers: Returns all or requested renderder

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

GET

Repository: Get all respository apps

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

POST

Request-password-change-mail: 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

POST

Restart: restart the 4ALLPORTAL

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

POST

Run: /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

GET

Session: check if session exist

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

GET

Stats: Return of deleted and total number of module objects

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

POST

Test: tests an existing webhook event

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

GET

Themes: Returns the configured themes in system

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

GET

Translations-file: Returns a list of TranslationObjects based on query parameter

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

Translations-file: Update translations for multiple ids by 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

GET

Translations: Returns a list of translation objects based on query parameter

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

Translations: Update translations for multiple ids

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

GET

Tutorials: Returns the open tutorials and possible progress for this 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

GET

Typeahead: Returns found ModuleObject

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

Typeahead: Returns found ModuleObject

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

GET

Updates: Get updates for active or all applications

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

POST

Upload: Upload Create session

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: Upload file

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

GET

User: Get current user's object

Parameters

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

GET

Value-options: Returns all or requested ValueOptions

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

POST

Webhooks: Sets a new webhook

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

PUT

{artifactId}: Activate latest version of the given artifact

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

{artifactId}: Deactivate any version of the artifact

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

{artifactId}: Delete the artifact from the local application repository

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

{artifactId}: Get all versions to given artifact

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

{artifactId}: Get specific artifact of the active applications

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

{artifactId}: Get the latest version of the specified artifact from the marketplace

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

{artifactId}: Get updates for specific artifact

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

{artifactId}: Load latest version of the given atrifact and of the same release type

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

{connector}: Returns details of {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

DELETE

{filekey}: Delete specified config file

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

{filekey}: Delete specified module config file

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

{filekey}: Get specified config file

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

{filekey}: Get specified module config file

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

{filekey}: upload specified configs file

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

{filekey}: upload specified module configs file

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

GET

{filename}: Return the image for audit objects

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

POST

{id}: Adds a new locale

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

{id}: Create new objects with a specified 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

{id}: Creates an icon proxy

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

{id}: Deletes all translations for {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

{id}: Deletes record {id} in {module}

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

{id}: Get specified config

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

{id}: Get specified module config

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

{id}: Get the layout for the given 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

{id}: Restore specified defaults

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

{id}: Restore specified module config defaults

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

{id}: Returns ValueOption requested in "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

{id}: Returns a translation object for the requested key including all localized translations

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

{id}: Returns details of {id} in {module}

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

{id}: Returns events of {connector} with event id greater than {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

{id}: Returns objects of {connector}

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

{id}: Returns the requested icon

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

{id}: Returns the requested object renderer set search item

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

{id}: Returns the requested renderer

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

{id}: Returns translations requested in "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

{id}: Save specified configs

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

{id}: Save specified module 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
`Snapin`	(Required) snapIn name
`Id`	(Required) snapIn id
`Accept`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

PATCH

{id}: Update translations for {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

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

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

GET

{locale}: Returns all or translations requested in "ids"

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

GET

{module}: Returns the module definition

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

{module}: get user feature permissions

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

{module}: get user presets

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

GET

{name}: /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

{name}: Returns metric requested in "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

{name}: get user feature permissions

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

{name}: get user presets

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

GET

{theme}: Returns the configured themes in system

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

PATCH

{tutorialId}: Updates the user statistics for a tutorial

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

DELETE

{type}: Delete the preview image

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

{type}: Get the image representation of this object and change the output preview if necessary

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

{type}: Upload of the preview image of the given 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

DELETE

{version}: Delete specific version of the artifact from the local application repository

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

{version}: Get specific version of the artifact

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

{version}: Get the specified version of the specified artifact from the marketplace

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

{version}: Get updates for specific artifact and version with dependecies check

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

{version}: Load and install the specific version of the artifact into the local application repository

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

{version}: Perform install, update, enable, and disable application and resolve depdendencies

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: Get ordered list of the active applications

Active: Remove ordered list of the applications

Active: Set ordered list of the applications

Admin-structure: Get admin structure

Audit: get audit entries

Backups: /system/installation/backups

Base-configuration: /system/base-configuration

Base-configuration: /system/base-configuration

Change-password-by-code: change password by code

Change-password: change password

Compare: /system/installation/compare

Connectors: Get a list of the PAP connectors

Create-package: /system/installation/create-package

Database: Get database config

Database: Update/Create database config

Files: Delete all files (for this module snapin)

Files: Delete all files (for this snapin)

Files: Get files (for this module snapin)

Files: Get files (for this snapin)

Icon: Get icon of the given version of the given artifact

Icons: Returns a list of all icons

Info: /system/installation/info

Install-package: /system/installation/install-package

Layouts: Get all layouts of module or just the requested ids

Locales: Returns all languages supported in system

Log-events: Create new logging record

Login: Logs in and returns the authentication cookie

Logout: Logs out and removes session cookies

Mail: Get mail config

Mail: Update/Create mail config

Media: Delete the preview image and all image reference

Media: Get the types of the image representation of this object

Media: Set the preview image as reference to the preview of the other object

Media: Upload of the preview image

Metrics: Returns all or requested metrics

Missing-label-translations: Report missing translations

Modules: Returns the definition of all modules

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

Objects: Delete given view profiles

Objects: Deletes all records in query parameter ids of {module}

Objects: Get all Configs (for this module snapin)

Objects: Get all Configs (for this snapin)

Objects: Get all layout set configs for {module}

Objects: Get all object renderer set configs for {module}

Objects: Get all view profile configs

Objects: Restore all defaults (for this module snapin)

Objects: Restore all defaults (for this snapin)

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

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

Objects: Returns objects of {connector}

Objects: Returns records from {module}

Objects: Save all Configs (for this snapin)

Objects: Save all Configs (for this snapin)

Objects: Save all layout configs

Objects: Save all object renderer configs

Objects: Save all view profile configs

Objects: Updates records of {module}

Operations: /modules/:module/operations

Password-policy: Returns password policy

Permissions: get user feature permissions

Presets: change presets

Presets: delete presets

Presets: get user presets

Providers: get configured authentication providers

Reload: reload the configuration

Renderers: Returns all or requested renderder

Repository: Get all respository apps

Request-password-change-mail: request password change mail

Restart: restart the 4ALLPORTAL

Run: /modules/:module/operations/:name/run

Session: check if session exist

Stats: Return of deleted and total number of module objects

Test: tests an existing webhook event

Themes: Returns the configured themes in system

Translations-file: Returns a list of TranslationObjects based on query parameter

Translations-file: Update translations for multiple ids by file

Translations: Returns a list of translation objects based on query parameter

Translations: Update translations for multiple ids

Tutorials: Returns the open tutorials and possible progress for this user

Typeahead: Returns found ModuleObject