4allportalconnector v1.0 | OneTeg Documentation

Version 1.0

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

Active (3)

GET Get ordered list of the active applications

/api/system/apps/active

Retrieve the ordered list of currently active applications in the system.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Embed`	Embed some additional objects
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Remove ordered list of the applications

/api/system/apps/active

Remove the configured ordered list of applications.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Set ordered list of the applications

/api/system/apps/active

Set or update the ordered list of applications.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	An array of configuration options representing the list of applications to set.

Admin-structure

GET Get admin structure

/api/system/admin-structure

get admin structure

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Audit

GET get audit entries

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

get audit entries

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Offset`	The index of the first audit entry to retrieve, used for pagination.
`Count`	The maximum number of audit entries to return in the list.
`Query`	A search query string to filter the list of audit entries.
`Module`	(Required) name of the module
`Id`	(Required) id of the recored
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Backups

POST /system/installation/backups

/api/system/installation/backups

Create or manage system installation backups.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Inf`	Configuration parameters or metadata for the backup process.

Base-configuration (2)

GET /system/base-configuration

/api/system/base-configuration

Retrieve the current system base configuration settings.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT /system/base-configuration

/api/system/base-configuration

Update the base configuration settings of the system.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

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`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Userid`	The unique identifier of the user account.
`Code`	The authorization code received for updating the password.
`Newpassword`	The new password to set for the user.

Change-password

POST change password

/api/auth/change-password

change password

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Oldpassword`	The current password of the user.
`Newpassword`	The new password to be configured for the user.

Compare

POST /system/installation/compare

/api/system/installation/compare

Compare installation components or states to identify differences.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Connectors

GET Get a list of the PAP connectors

/api/connectors

Retrieve a list of available PAP connectors.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Create-package

POST /system/installation/create-package

/api/system/installation/create-package

Create a new system installation package.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Database (2)

GET Get database config

/api/system/configs/database

Get database configs

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update/Create database config

/api/system/configs/database

Update/Create database config

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (17)

Option Name	Description
`Databasename`	The name of the target database.
`Maxidletime`	The maximum idle time for connections in the database pool.
`Type`	The database type or dialect.
`Valid`	A validation flag representing the connection state or status.
`Password`	The password used for database authentication.
`Minpoolsize`	The minimum number of active connections to maintain in the database pool.
`Balancertype`	The type of load balancer utilized for database connections.
`Port`	The network port on which the database server is listening.
`Integratedsecurity`	Specifies whether to use integrated operating system security for authentication.
`Host`	The hostname or IP address of the database server.
`Jdbcurl`	The full JDBC connection URL for the database.
`Name`	A unique descriptive name for the database configuration.
`Maxpoolsize`	The maximum number of active connections allowed in the database pool.
`User`	The username used for database authentication.
`Slowqueryloggingenabled`	Determines whether to log database queries that exceed the slow query threshold.
`Slowqueryloggingthresholdmilliseconds`	The execution threshold in milliseconds above which a query is flagged as slow and logged.
`Slowqueryloggingstatementexclusionregexes`	An array of regular expression patterns to exclude matching SQL statements from slow query logging.

Files (4)

DELETE Delete all files (for this module snapin)

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

Permanently delete all files associated with a specific module snapin object.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Module`	(Required) module name
`Snapin`	(Required) snapIn name
`Id`	(Required) module snapIn id, if single module snapin then id=default_single
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete all files (for this snapin)

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

Permanently delete all files associated with a specific system snapin object.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Snapin`	(Required) snapIn name
`Id`	(Required) snapIn id, if single snapin then id=default_single
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`Module`	(Required) module name
`Snapin`	(Required) snapIn name
`Id`	(Required) module snapIn id, if single module snapin then id=default_single
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get files (for this snapin)

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

get files (for this snapin)

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Snapin`	(Required) snapIn name
`Id`	(Required) snapIn id, if single snapin then id=default_single
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Icon

GET Get icon of the given version of the given artifact

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

Retrieve the icon image for a specific version of a repository artifact.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Artifactid`	(Required) The id of the application artifact
`Version`	(Required) The version of the application artifact
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Icons

GET Returns a list of all icons

/api/system/icons

Retrieve a list of all icons available in the system.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`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`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Info

GET /system/installation/info

/api/system/installation/info

Retrieve installation details and diagnostic information about the current system deployment.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Install-package

POST /system/installation/install-package

/api/system/installation/install-package

Install a software package into the system installation environment.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content-type`	The content type of the request payload, such as multipart/form-data.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`File`	The file path or name of the package to be installed.
`Description`	An optional description or notes explaining the package installation.
`Reload`	Indicates whether to reload system configurations or services after the installation is complete.

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`	Additional HTTP header name/value pairs to include in the request.
`Ids`	(Required)
`Objecttype`	(Required)
`Module`	(Required)
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Locales

GET Returns all languages supported in system

/api/system/locales

Retrieve a list of all locale languages currently supported by the system.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

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`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`Type`	The severity level or classification of the log event.
`Thread`	The name of the execution thread that generated the log event.
`Classpath`	The Java class path or component source where the log event occurred.
`Message`	The detailed message or explanation of the logged event.
`Stacktrace`	The error stack trace details, useful when recording exceptions.

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`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (9)

Option Name	Description
`Username`	The username or login identifier of the user authenticating.
`Password`	The password used for database authentication.
`Language`	The primary interface language code to establish for the session.
`Fallbacklanguage`	The backup language code to use if the primary language is not available.
`Authenticationprovider`	The specific authentication provider or service to use for verification.
`Clienttype`	The type of client application initiating the login request.
`Token`	A security or multi-factor authentication token required for logging in.
`Embed`	A list of related resources to embed in the response.
`Modulerequestgroups`	A list of module request groups to associate with the session.

Logout

POST Logs out and removes session cookies

/api/auth/logout

Logs out from 4ALLPORTAL and delete session cookies

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Mail (2)

GET Get mail config

/api/system/configs/mail

Get mail configs

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Update/Create mail config

/api/system/configs/mail

Update/Create mail config

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (14)

Option Name	Description
`Valid`	A validation flag representing the connection state or status.
`Enabled`	Specifies whether the system's outgoing email functionality is enabled.
`Host`	The hostname or IP address of the database server.
`User`	The username used for database authentication.
`Password`	The password used for database authentication.
`Useauthentication`	Indicates whether the mail server requires username and password authentication.
`Usereplyto`	Determines whether a custom reply-to header should be appended to outgoing emails.
`Systemfromemail`	The default sender email address used for system notifications.
`Systemfromname`	The display name associated with the default sender email address.
`Systemreplytoemail`	The email address where replies to system emails will be delivered.
`Systemmailsender`	The identity of the mail sender agent or transport mechanism used.
`Security`	The security protocol, such as TLS or SSL, used to secure connection to the mail server.
`Port`	The network port on which the database server is listening.
`Name`	A unique descriptive name for the database configuration.

Media (4)

DELETE Delete the preview image and all image reference

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

Permanently delete the preview image and all corresponding image references for a specific module object.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Client Type`	The client type (optional)
`Module`	(Required) The name of the module
`Id`	(Required) UUID of the data entry
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get the types of the image representation of this object

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

Retrieve the available image representation types and formats configured for a specific module object.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Client Type`	The client type (optional)
`Module`	(Required) The name of the module
`Id`	(Required) UUID of the data entry
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

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

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

Assign the preview image of another object as a reference for the specified object.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Client Type`	The client type (optional)
`Module`	(Required) The name of the module
`Id`	(Required) UUID of the data entry
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Id`	The unique identifier of the target object being referenced.
`Module`	The name of the module containing the target object.
`Mode`	The operation mode determining how the media reference is established.

PUT Upload of the preview image

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

Upload a new preview image for a specific module object.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Client Type`	The client type (optional)
`Module`	(Required) The name of the module
`Id`	(Required) UUID of the data entry
`Content-type`	The content type of the request payload, such as multipart/form-data.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	The file path or name of the package to be installed.

Metrics

GET Returns all or requested metrics

/api/system/metrics

Retrieve operational and system performance metrics, optionally filtered by name.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Names`	A comma-separated list of specific metric names to retrieve.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

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`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (2)

Option Name	Description
`Labelkey`	The unique identifier key of the missing label.
`Lang`	The language code for which the translation is missing.

Modules

GET Returns the definition of all modules

/api/modules

Retrieve structural definitions and metadata for all available modules in the system.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Groups`	Filter the module definitions by specific group identifiers.
`Modules`	Filter the results to include only the specified module names.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

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`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Module`	(Required)
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Id`	The unique identifier of the resource to create or update.
`Module`	The name of the target module.
`Type`	The type classification of the resource.
`Mod Time`	The modification timestamp of the resource.

DELETE Delete given view profiles

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

Permanently delete the specified view profiles from the system configuration.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Names`	A comma-separated list of specific metric names to retrieve.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

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

/api/modules/{module}/objects

Delete all specified record IDs from the designated module.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`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`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get all Configs (for this module snapin)

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

get {module}->{snapin} configs

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Module`	(Required) module name
`Snapin`	(Required) snapIn name
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get all Configs (for this snapin)

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

get {snapin} configs

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Snapin`	(Required) snapIn name
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`Module`	(Required) module name
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`Module`	(Required) module name
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get all view profile configs

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

Get view profile configs

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Restore all defaults (for this module snapin)

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

Reset all configuration defaults for a specific snapin within the designated module.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Names`	A comma-separated list of specific metric names to retrieve.
`Module`	(Required) module name
`Snapin`	(Required) snapIn name
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Restore all defaults (for this snapin)

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

Reset all configuration defaults for a specific system-level snapin.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Names`	A comma-separated list of specific metric names to retrieve.
`Snapin`	(Required) snapIn name
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

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

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

Restore the default layout set for a module by deleting custom layout sets from the runtime folder.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Names`	A comma-separated list of specific metric names to retrieve.
`Module`	(Required) module name
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

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

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

Restore the default object renderer set for a module, removing custom renderers so that only app-provided renderer sets remain.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Names`	A comma-separated list of specific metric names to retrieve.
`Module`	(Required) module name
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Returns objects of {connector}

/api/connectors/{connector}/objects

Retrieve objects associated with a specific connector.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Ids`	A comma-separated list of object identifiers to filter the results.
`Connector`	(Required)
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Returns records from {module}

/api/modules/{module}/objects

Retrieve a list of records from the specified module.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fields`	A comma-separated list of specific fields to return in the response.
`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`	The number of records to skip before starting to return results.
`Limit`	The maximum number of records to return in a single response.
`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`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Save all Configs (for this snapin)

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

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

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Module`	(Required) module name
`Snapin`	(Required) snapIn name
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	An array of configuration options representing the list of applications to set.

PUT Save all Configs (for this snapin)

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

Update/Create {snapin} config

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Snapin`	(Required) snapIn name
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	An array of configuration options representing the list of applications to set.

PUT Save all layout configs

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

Update/Create layout configs

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Module`	(Required) module name
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	An array of configuration options representing the list of applications to set.

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`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Module`	(Required) module name
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	An array of configuration options representing the list of applications to set.

PUT Save all view profile configs

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

Update/Create view profile config

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	An array of configuration options representing the list of applications to set.

POST Updates records of {module}

/api/modules/{module}/objects

Update or create records within the specified module.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Query`	(Required)
`Module`	(Required)
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Id`	The unique identifier of the target object being referenced.
`Module`	The name of the module containing the target object.
`Type`	The severity level or classification of the log event.
`Mod Time`	The modification timestamp used to synchronize or filter the records being updated.

Operations

GET /modules/:module/operations

/api/modules/{module}/operations

Retrieve a list of available operations for a specific module, with optional filters for type, relation, and view.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Ids`	List of object ids to apply the configured conditions to.
`Groups`	Filter the module definitions by specific group identifiers.
`Names`	A comma-separated list of specific metric names to retrieve.
`Type`	Filter the operations by a specific type name.
`Relationname`	Filter the operations by the name of an associated relation.
`View`	Filter the operations by a specific user interface view.
`Relatedbeanid`	Filter the operations by the unique identifier of a related bean.
`Module`	(Required)
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Password-policy

GET Returns password policy

/api/system/password-policy

Retrieve the current password policy configuration defined in the system.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Permissions

GET get user feature permissions

/api/session/permissions

get user feature permissions

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Presets (3)

PATCH change presets

/api/session/presets

Modify the active session preset values.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (3)

Option Name	Description
`Eua1`	An optional configuration value used to update the session presets.
`Sint1`	An optional setting used to update the session presets.
`Ut 8be`	An optional encoding or identifier setting used to update the session presets.

DELETE delete presets

/api/session/presets

Delete and clear the active preset configurations from the current session.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Keys`	(Required)
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

GET get user presets

/api/session/presets

get user presets

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Providers

GET get configured authentication providers

/api/auth/providers

get list of configured authentication providers

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Reload

POST reload the configuration

/api/system/operations/reload

Reload the 4ALLPORTAL configuration. Needs admin permission.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Renderers

GET Returns all or requested renderder

/api/modules/{module}/renderers

Retrieve all renderers, or a specific renderer, configured for the specified module.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Ids`	A comma-separated list of object identifiers to filter the results.
`Objecttype`	Filter the returned renderers by a specific object type.
`Module`	(Required)
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Repository

GET Get all respository apps

/api/system/apps/repository

Retrieve a list of all applications currently available in the system repository.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Embed`	Embed some additional objects
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

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`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Username`	The username or login identifier of the user authenticating.

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`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Run

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

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

Execute a named operation within a module on a set of targeted objects.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Module`	(Required)
`Name`	(Required)
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Ids`	An array of object identifiers on which to run the specified operation.

Session

GET check if session exist

/api/session

check if session exist and deliver content like login if exist

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`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`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Stats

GET Return of deleted and total number of module objects

/api/modules/{module}/stats

Retrieve statistical counts for the specified module, including the total number of objects and the number of deleted objects.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Module`	(Required)
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Test

POST tests an existing webhook event

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

Test an existing webhook event to verify its delivery and payload configuration.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Webhookid`	(Required) The UUID of the webhook
`Eventid`	(Required) The UUID of the webhook event
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Themes

GET Returns the configured themes in system

/api/system/themes

Retrieve all configured user interface themes currently available in the system.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Names`	A comma-separated list of specific metric names to retrieve.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Translations-file (2)

GET Returns a list of TranslationObjects based on query parameter

/api/system/configs/translations-file

Retrieve a list of translation objects filtered by various query criteria such as context, keys, or missing locales.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Context`	Filter translations by their specific context.
`Contextname`	Filter translations by the name of the context.
`Type`	Filter the operations by a specific type name.
`Object`	Filter translations by the associated object type.
`Translationorkey`	Filter by a specific translation value or translation key.
`Missinginlocale`	Filter translations that are missing in the specified locale.
`Sort`	Field to order including order direction postfixed :desc(descending) or :asc(ascending).
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Update translations for multiple ids by file

/api/system/configs/translations-file

Update translations for multiple identifiers in bulk by uploading a file.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Content-type`	The content type of the request payload, such as multipart/form-data.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	The file path or name of the package to be installed.

Translations (2)

GET Returns a list of translation objects based on query parameter

/api/system/configs/translations

Retrieve a list of translation objects from the system configuration based on query parameters.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`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`	The number of records to skip before starting to return results.
`Limit`	The maximum number of records to return in a single response.
`Sort`	Field to order including order direction postfixed :desc(descending) or :asc(ascending).
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

PATCH Update translations for multiple ids

/api/system/configs/translations

Update translation objects for multiple identifiers simultaneously.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Key`	The specific translation key to be updated.
`Context`	The context associated with the translations.
`Contextname`	The name of the context for the translations.
`Contextidentifier`	The unique identifier of the context for the translations.
`Object`	The object associated with the translations.
`Type`	The type classification of the resource.

Tutorials

GET Returns the open tutorials and possible progress for this user

/api/user/tutorials

Retrieve the open tutorials and the current user's progress details.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Typeahead (2)

GET Returns found ModuleObject

/api/modules/{module}/typeahead

Search and retrieve matching module objects for autocompletion or typeahead suggestions within a specific module.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Value`	Searched value
`Limit`	Maximum number of response values
`Query`	A search query string to filter the list of audit entries.
`Module`	(Required) Module name
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Returns found ModuleObject

/api/multi-module/typeahead

Search and retrieve matching module objects across multiple modules for typeahead or autocompletion suggestions.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Value`	Searched value
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Updates

GET Get updates for active or all applications

/api/system/apps/updates

Retrieve available updates for either all applications or only active applications in the system.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Active Only`	Check for update only for active applications
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Upload (2)

POST Upload Create session

/service/v2/filetran_obj/stage/createUploadSession

Initialize a new upload session to prepare for transferring a file.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Session`	The identifier of the upload session to associate with this request.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`File Name`	The name of the file to be uploaded.
`File Mod Time`	The modification time of the file in milliseconds.
`File Create Time`	The creation time of the file in milliseconds.
`Target Folder`	The target directory where the file will be stored.
`Auto Transfer`	Specifies whether to automatically start transferring the file once staging is complete.
`Collision Action`	The action to take when a file with the same name already exists in the target folder.

PUT Upload file

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

Upload a file chunk or the complete file to an active upload session.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Sessionid`	The unique identifier of the target upload session.
`Session`	The session identifier used to track the upload progress.
`Content-range`	The byte range indicating the chunk of the file being sent.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	The file content or file reference to upload.

User

GET Get current user's object

/api/user

Retrieve the profile and object information for the currently authenticated user.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Value-options

GET Returns all or requested ValueOptions

/api/system/value-options

Retrieve a list of all available or specifically requested ValueOptions.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Ids`	A comma-separated list of object identifiers to filter the results.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Webhooks

POST Sets a new webhook

/api/system/webhooks

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (5)

Option Name	Description
`Url`	The destination URL where webhook event payloads will be sent.
`Id`	The unique identifier of the target object being referenced.
`Active`	Specifies whether the newly created webhook is enabled and active.
`Secret`	A secure token or secret key used to validate and sign webhook requests.
`Eventsjson`	A JSON string containing the list of events that trigger this webhook.

{artifactId} (8)

PUT Activate latest version of the given artifact

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

Activate the most recent version of the specified artifact within the application.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Artifactid`	(Required) The id of the application artifact
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	An array of configuration options representing the list of applications to set.

DELETE Deactivate any version of the artifact

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

Deactivate any active version of the specified artifact.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Artifactid`	(Required) The id of the application artifact
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete the artifact from the local application repository

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

Permanently remove the specified artifact from the local application repository.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Artifactid`	(Required) The id of the application artifact
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get all versions to given artifact

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

Retrieve a list of all available versions for the specified artifact in the local repository.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Artifactid`	(Required) The id of the application artifact
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get specific artifact of the active applications

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

Retrieve details of the specified artifact that is currently active within the applications.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Artifactid`	(Required) The id of the application artifact
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

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

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

Fetch details about the latest available version of the specified artifact from the marketplace.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Type`	Release type of the application
`Artifactid`	(Required) The id of the application artifact
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get updates for specific artifact

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

Check for and retrieve available updates for the specified artifact.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Types`	Release types of the application
`Artifactid`	(Required) The id of the application artifact
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

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

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

Load the latest version of the specified artifact that matches the same release type into the repository.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Artifactid`	(Required) The id of the application artifact
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

{connector}

GET Returns details of {connector}

/api/connectors/{connector}

Retrieve detailed configuration and status information for the specified connector.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Connector`	(Required)
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

{filekey} (6)

DELETE Delete specified config file

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

Delete the specified configuration file associated with a snapin object.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Snapin`	(Required) snapIn name
`Id`	(Required) snapIn id, if single snapin then id=default_single
`Filekey`	(Required) snapIn name
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Delete specified module config file

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

Delete the specified module configuration file associated with a module snapin object.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`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`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get specified config file

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

Retrieve the contents of the specified configuration file for a snapin object.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Snapin`	(Required) snapIn name
`Id`	(Required) snapIn id, if single snapin then id=default_single
`Filekey`	(Required) snapIn name
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get specified module config file

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

Retrieve the contents of the specified module configuration file for a module snapin object.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`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`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT upload specified configs file

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

Upload and save the specified configuration file for a snapin object.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`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`	The content type of the request payload, such as multipart/form-data.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	The file content or file reference to upload.

PUT upload specified module configs file

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

Upload and save the specified module configuration file for a module snapin object.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`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`	The content type of the request payload, such as multipart/form-data.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	The file content or file reference to upload.

{filename}

GET Return the image for audit objects

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

Retrieve the media image associated with a specific audit log entry for an object.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Module`	(Required) module name
`Id`	(Required) Id from module object
`Auditid`	(Required) Id from audit object
`Filename`	(Required) File name from audit object
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

{id} (23)

POST Adds a new locale

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

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	(Required) The id of the locale e.g. en_US
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

POST Create new objects with a specified id

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

Create a new object inside the specified module using the provided identifier.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Module`	(Required) The name of the module
`Id`	(Required) UUID of the data entry
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Creates an icon proxy

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

Create an icon proxy configuration using the specified unique identifier.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	(Required) Icon id
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	An array of configuration options representing the list of applications to set.

DELETE Deletes all translations for {id}

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

Permanently delete all localized translations associated with the specified identifier.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`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`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Deletes record {id} in {module}

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

Delete a specific record from the designated module by its unique identifier.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Module`	(Required) The name of the module
`Id`	(Required) UUID of the data entry
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get specified config

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

Retrieve a specific system configuration object for the designated snap-in using its identifier.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Snapin`	(Required) snapIn name
`Id`	(Required) snapIn id
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get specified module config

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

Retrieve a specific configuration object associated with a particular module and snap-in using its identifier.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Module`	(Required) module name
`Snapin`	(Required) snapIn name
`Id`	(Required) snapIn id
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`Objecttype`	(Required)
`Module`	(Required)
`Id`	(Required)
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Restore specified defaults

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

Revert a specific system configuration object back to its default values for the designated snap-in and identifier.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Snapin`	(Required) snapIn name
`Id`	(Required) snapIn id
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

DELETE Restore specified module config defaults

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

Revert a specific module-level configuration object back to its default values for the designated module, snap-in, and identifier.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Module`	(Required) module name
`Snapin`	(Required) snapIn name
`Id`	(Required) snapIn id
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Returns ValueOption requested in "id"

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

Retrieve the details of a specific value option matching the provided identifier.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	(Required)
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

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

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

Retrieve a translation object by its identifier, containing the requested key and all of its associated localized translations.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Context`	If the result contains related translations objects from the context
`Id`	(Required) The language independent key of the label
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Returns details of {id} in {module}

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

Retrieve the details of a specific record in the designated module using its unique identifier.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Fields`	A comma-separated list of specific fields to return in the response.
`Embed`	Retrive related objects via relations, comma separated
`Module`	(Required) The name of the module
`Id`	(Required) UUID of the data entry
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

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

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

Retrieve connector events that have an event identifier greater than the specified value.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Hash`	(Required) connector hash
`Connector`	(Required)
`Id`	(Required) last event id
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Returns objects of {connector}

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

Retrieve the objects associated with a specific connector matching the provided identifier.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Connector`	(Required)
`Id`	(Required)
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Returns the requested icon

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

Retrieve the requested icon by its unique identifier for the specified theme.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Theme`	(Required) Theme name
`Id`	(Required) Icon id
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Returns the requested object renderer set search item

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

Retrieve a specific search configuration item for an object renderer set in the designated module.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Module`	(Required)
`Id`	(Required)
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Returns the requested renderer

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

Retrieve the details of a specific renderer within the designated module using its unique identifier.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Objecttype`	Filter the returned renderers by a specific object type.
`Module`	(Required)
`Id`	(Required)
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Returns translations requested in "id"

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

Retrieve the translations corresponding to the specified locale and identifier.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Locale`	(Required) Locale
`Id`	(Required) Id from translation
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Save specified configs

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

Save or update the specified configuration object for the designated snap-in and identifier.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Snapin`	(Required) snapIn name
`Id`	(Required) snapIn id
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	An array of configuration options representing the list of applications to set.

PUT Save specified module configs

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

Save or update a specific module configuration object for the designated module, snap-in, and identifier.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Module`	(Required) module name
`Snapin`	(Required) snapIn name
`Id`	(Required) snapIn id
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`Options`	An array of configuration options representing the list of applications to set.

PATCH Update translations for {id}

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

Update specific properties of the translation associated with the provided identifier.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Id`	(Required) The language independent key of the label
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (6)

Option Name	Description
`Key`	The translation key used to reference the text.
`Context`	The translation context grouping this entry.
`Contextname`	The name of the context associated with the translation.
`Contextidentifier`	The identifier of the context to which the translation applies.
`Object`	The translation object structure or localized value representation.
`Type`	The severity level or classification of the log event.

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

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

Update an existing record within a specified module using its unique identifier.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Module`	(Required) The name of the module
`Id`	(Required) UUID of the data entry
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

{locale}

GET Returns all or translations requested in "ids"

/api/system/locales/{locale}

Retrieve all translations or a specific subset of requested translations for the specified locale.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Ids`	A comma-separated list of object identifiers to filter the results.
`Locale`	(Required) Locale
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

{module} (3)

GET Returns the module definition

/api/modules/{module}

Retrieve the configuration and structure definition for the specified module.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Groups`	Filter the module definitions by specific group identifiers.
`Module`	(Required) The module name
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

GET get user feature permissions

/api/session/permissions/{module}

get user feature permissions

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Module`	(Required) name of the module
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

GET get user presets

/api/session/presets/{module}

get user presets

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Module`	(Required) name of the module
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

{name} (4)

GET /modules/:module/operations/:name

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

Retrieve the details of a specific operation by name within a specified module.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Ids`	List of object ids to apply the configured conditions to.
`Groups`	Filter the module definitions by specific group identifiers.
`Type`	Filter the operations by a specific type name.
`Relationname`	Filter the operations by the name of an associated relation.
`View`	Filter the operations by a specific user interface view.
`Relatedbeanid`	Filter the operations by the unique identifier of a related bean.
`Module`	(Required)
`Name`	(Required)
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Returns metric requested in "name"

/api/system/metrics/{name}

Retrieve the system metric requested by its specific name.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Name`	(Required)
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

GET get user feature permissions

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

get user feature permissions

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Module`	(Required) name of the module
`Name`	(Required) get for key
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

GET get user presets

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

get user presets

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Module`	(Required) name of the module
`Name`	(Required) get for key
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

{theme}

GET Returns the configured themes in system

/api/system/themes/{theme}

Retrieve the configuration details for a specified system theme.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Theme`	(Required) Theme name
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

{tutorialId}

PATCH Updates the user statistics for a tutorial

/api/user/tutorials/{tutorialId}

Update the progress and completion statistics of a tutorial for the current user.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`Tutorialid`	(Required) The name / id of the tutorial available from 4ALLPORTAL Admin Snapin
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (4)

Option Name	Description
`Status`	The current progress or completion status of the tutorial.
`User`	The username used for database authentication.
`Stepsfinished`	The number or identifier of the tutorial steps that the user has finished.
`Percentfinished`	The overall percentage of the tutorial that has been completed.

{type} (3)

DELETE Delete the preview image

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

Permanently delete the preview image of a specified media type associated with an object.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`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`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

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`	Additional HTTP header name/value pairs to include in the request.
`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`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

PUT Upload of the preview image of the given type

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

Upload or replace the preview image of the specified media type for a given object.

Parameters

Parameter Name	Description
`Content Type`	The content type of the request payload sent to the API (e.g. application/json).
`headers`	Additional HTTP header name/value pairs to include in the request.
`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`	The content type of the request payload, such as multipart/form-data.
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

Options (1)

Option Name	Description
`File`	The file path or name of the package to be installed.

{version} (6)

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

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

Permanently remove a specific version of an artifact from the local application repository.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Artifactid`	(Required) The id of the application artifact
`Version`	(Required) The version of the application artifact
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get specific version of the artifact

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

Retrieve details of a specific version of an artifact from the local application repository.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Artifactid`	(Required) The id of the application artifact
`Version`	(Required) The version of the application artifact
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

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

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

Retrieve details of a specific version of an artifact directly from the marketplace.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Artifactid`	(Required) The id of the application artifact
`Version`	(Required) The version of the application artifact
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

GET Get updates for specific artifact and version with dependecies check

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

Retrieve available updates for a specific artifact and version while performing a dependency check.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Types`	Release types of the application
`Artifactid`	(Required) The id of the application artifact
`Version`	(Required) The version of the application artifact
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

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

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

Load and install a specific version of an artifact into the local application repository.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Artifactid`	(Required) The id of the application artifact
`Version`	(Required) The version of the application artifact
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

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

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

Manage an application's lifecycle by performing installation, update, enablement, or disablement operations, and resolving any associated dependencies. This action targets a specific application version using its artifact ID.

Parameters

Parameter Name	Description
`headers`	Additional HTTP header name/value pairs to include in the request.
`Types`	Release types of the application
`Artifactid`	(Required) The id of the application artifact
`Version`	(Required) The version of the application artifact
`Accept`	The media type requested for the response content, such as application/json.
`Response Type`	The response format expected from the API (e.g. application/json).

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)