wfm.AdminGetStatisticReportConfigs
This job retrieves configurations for process reports (statistics, etc.).
1. Input Parameters
| Name | Type | Required | Description |
|---|---|---|---|
OrganisationId |
STRING |
Yes |
ID of the organization where the requested report configurations are located. |
[CreatorId] |
STRING |
No |
ID of the creator of a configuration. If set, only configurations with this CreatorId are returned. |
UserId |
STRING |
Yes |
ID of the calling user. Only configurations for which the user has rights are returned. |
[ConfigTypes] |
STRING |
No |
Comma-separated list of configuration types. If set, only configurations of the corresponding type are returned. Possible values: 0 = Process statistics, 1 = Process details. |
[FamilyIds] |
STRING |
No |
Comma-separated list with IDs of workflow families. If set, only configurations assigned to at least one of the specified families are returned. |
RespectRights |
INT |
Yes |
Indicates whether only report configurations are returned whose reports the user is allowed to request and view. 0 = regardless of rights, 1 = according to rights. |
3. Output Parameters
| Name | Type | Dependency | Description |
|---|---|---|---|
|
BASE64 |
— |
Information about the requested report configurations in XML format. |
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?>
<ReportConfigs>
<ReportConfig ConfigId="" ConfigName="" CreationTime="" CreatorId=""
CreatorName="" ConfigType="">
<ConfigData><![CDATA[]]></ConfigData>
</ReportConfig>
</ReportConfigs>
More detailed description of ReportConfig attributes:ConfigId (STRING) — ID of the configuration.ConfigName (STRING) — Name of the configuration.CreationTime (INT) — Timestamp (when the configuration was created).CreatorId (STRING) — User ID of the creator of the configuration.CreatorName (STRING) — Name of the person object corresponding to the user.ConfigType (INT) — Type of the configuration: 0 = Process statistics, 1 = Process details.ConfigData (CDATA) — Configuration as XML description.
|