Project Parameter Management

This adapter contains an API for reading and changing project parameters at runtime so that they can be adapted to the system environment.

Properties

Operation

Operation executed by the adapter

Possible values:

Get Project Parameter IDs: Returns the IDs of the projects containing parameters with workspaces and project names
Get Project Parameter Structure: Returns the XML structure of the project parameters with groups
List Project Parameters: Returns the XML structure of the project parameters
Patch Project Parameters: Updates one or more project parameters for the specified project ID

Parameters

Adapter

Main adapter class (do not change!)

Possible values: de.softproject.x4.core.parameter.runtime.ProjectParametrizationAdapter: Main class (Default)

withSystemPrivileges

Possible values: Boolean (true/false)

False: Restricts the access to read and edit parameters depending on access rights (roles).

True: No restriction to read and edit parameters depending on access rights (roles). This setting must be used if a process is called outside of a user's context.

Status values

`1 (successful)`	The operation was executed successfully.
`0 (empty)`	The operation was performed successfully, but no parameter was found or changed.
`-1 (failed)`	The operation failed due to a technical error.

The documentation of the ReST interface can be found at http://localhost:8080/X4/X4Api/.