A collection of help pages for using the API.
URL | /Api/v2/Company/{companyId}/KeyFigurePreset/{keyFigurePresetId} |
Accepted verbs | GET, DELETE, PUT, POST |
Description |
Provides methods to get or manage settings for which key figures that are supposed to be displayed in the presentation view for the company. |
Get all configured key figure presets for a company.
Name | Description | Additional information |
---|---|---|
companyId | Company id. |
URI parameter |
The requested list of KeyFigurePreset.
Get a particular key figure preset by its id.
Name | Description | Additional information |
---|---|---|
companyId | Company id. |
URI parameter |
keyFigurePresetId | Id of the key figure preset to fetch. |
URI parameter |
The requested KeyFigurePreset.
Delete a key figure preset.
Name | Description | Additional information |
---|---|---|
companyId | Company id. |
URI parameter |
keyFigurePresetId | Id of the key figure preset to delete. |
URI parameter |
Update an existing key figure preset.
Name | Description | Additional information |
---|---|---|
companyId | Company id. |
URI parameter |
apiKeyFigurePreset | Updated KeyFigurePreset information. |
Body data |
The KeyFigurePreset with updated information.
Create a new key figure preset.
Name | Description | Additional information |
---|---|---|
companyId | Company id. |
URI parameter |
apiKeyFigurePreset | The new KeyFigurePreset to create. |
Body data |
The newly created KeyFigurePreset.