GET v1/capps/reports/getall/{id}

returns a list of all result report defintions for capp

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

optional capp.id

string

Default value is

Body Parameters

None.

Response Information

Resource Description

list of report definitions

Collection of ConfidenceApps.Interfaces.Portal.IReport
NameDescriptionTypeAdditional information
ActionCondition

Condition when to execute a report.

string

None.

AppId

The unique identifier of the report.

globally unique identifier

None.

Name

The report´s name.

string

None.

Enabled

Gets or sets if the report is enabled.

boolean

None.

ActionType

Defines what kind of action has to be executed.

ConfidenceApps.Types.ReportActionTypeEnum

None.

ActionFormat

Specifies the report format.

ConfidenceApps.Types.ResultFormat

None.

ActionValue

Specifies the postback-receiver (E-Mail addresses or URL).

string

None.

ActionValueDynamic

Specifies from which formcontrol the receiver is read

string

None.

IsDefault

Defines the report as default

boolean

None.

TemplateId

The unique identifier of the report template.

globally unique identifier

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": "63e55db8-c4f4-46d2-95b2-125949b7b917",
    "appId": "dd4b0b80-5f35-40bf-8dbb-26bc9b528726",
    "name": "Sample Report",
    "enabled": true,
    "actionType": "SendEMail",
    "actionFormat": "PDF",
    "actionValue": "Sample Value",
    "createdAt": "2024-05-07T22:25:04",
    "modifiedAt": "2024-05-07T22:25:04",
    "referenceId": "00000000-0000-0000-0000-000000000000",
    "isDefault": false
  },
  {
    "id": "63e55db8-c4f4-46d2-95b2-125949b7b917",
    "appId": "dd4b0b80-5f35-40bf-8dbb-26bc9b528726",
    "name": "Sample Report",
    "enabled": true,
    "actionType": "SendEMail",
    "actionFormat": "PDF",
    "actionValue": "Sample Value",
    "createdAt": "2024-05-07T22:25:04",
    "modifiedAt": "2024-05-07T22:25:04",
    "referenceId": "00000000-0000-0000-0000-000000000000",
    "isDefault": false
  }
]