Report Controller

get
Authorizations
Path parameters
reportIdstringRequired
Responses
200
OK
*/*
get
GET /api/reports/{reportId} HTTP/1.1
Host: inscada.cloud
Accept: */*

{
  "creationDate": "2025-07-05T18:28:25.405Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T18:28:25.405Z",
  "id": "text",
  "minutes": 1,
  "reportDay": 1,
  "dsc": "text",
  "printDay": 1,
  "lang": "text",
  "no": "text",
  "logoFlag": true,
  "name": "text",
  "mailDay": 1,
  "period": "Hourly",
  "mailTo": "text",
  "projectId": "text",
  "printTime": "2025-07-05T18:28:25.405Z",
  "printFlag": true,
  "reportTime": "2025-07-05T18:28:25.405Z",
  "mailFlag": true,
  "mailTime": "2025-07-05T18:28:25.405Z",
  "owner": "text"
}
put
Authorizations
Path parameters
reportIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
minutesinteger · int32 · min: 1Optional
reportDayinteger · int32 · min: 1 · max: 31Optional
dscstring · max: 255Optional
printDayinteger · int32 · min: 1 · max: 31Optional
langstringOptional
nostring · max: 50Optional
logoFlagbooleanRequired
namestring · max: 100Required
mailDayinteger · int32 · min: 1 · max: 31Optional
periodstring · enumRequiredPossible values:
mailTostringOptional
projectIdstringOptional
printTimestring · date-timeOptional
printFlagbooleanRequired
reportTimestring · date-timeOptional
mailFlagbooleanRequired
mailTimestring · date-timeOptional
ownerstringOptional
Responses
204
No Content
put
PUT /api/reports/{reportId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 351

{
  "id": "text",
  "minutes": 1,
  "reportDay": 1,
  "dsc": "text",
  "printDay": 1,
  "lang": "text",
  "no": "text",
  "logoFlag": true,
  "name": "text",
  "mailDay": 1,
  "period": "Hourly",
  "mailTo": "text",
  "projectId": "text",
  "printTime": "2025-07-05T18:28:25.405Z",
  "printFlag": true,
  "reportTime": "2025-07-05T18:28:25.405Z",
  "mailFlag": true,
  "mailTime": "2025-07-05T18:28:25.405Z",
  "owner": "text"
}
No content
delete
Authorizations
Path parameters
reportIdstringRequired
Responses
204
No Content
delete
DELETE /api/reports/{reportId} HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
get
Authorizations
Path parameters
reportIdstringRequired
groupIdstringRequired
Responses
200
OK
*/*
get
GET /api/reports/{reportId}/groups/{groupId} HTTP/1.1
Host: inscada.cloud
Accept: */*

{
  "creationDate": "2025-07-05T18:28:25.405Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T18:28:25.405Z",
  "id": "text",
  "groupOrder": 1,
  "reportId": "text",
  "name": "text",
  "dsc": "text"
}
put
Authorizations
Path parameters
reportIdstringRequired
groupIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
groupOrderinteger · int32 · min: 1Required
reportIdstringOptional
namestring · max: 100Required
dscstring · max: 255Optional
Responses
204
No Content
put
PUT /api/reports/{reportId}/groups/{groupId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "id": "text",
  "groupOrder": 1,
  "reportId": "text",
  "name": "text",
  "dsc": "text"
}
No content
delete
Authorizations
Path parameters
reportIdstringRequired
groupIdstringRequired
Responses
204
No Content
delete
DELETE /api/reports/{reportId}/groups/{groupId} HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
get
Authorizations
Path parameters
reportIdstringRequired
groupIdstringRequired
subgroupIdstringRequired
Responses
200
OK
*/*
get
GET /api/reports/{reportId}/groups/{groupId}/subgroups/{subgroupId} HTTP/1.1
Host: inscada.cloud
Accept: */*

{
  "creationDate": "2025-07-05T18:28:25.405Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T18:28:25.405Z",
  "id": "text",
  "subgroupOrder": 1,
  "name": "text",
  "dsc": "text",
  "groupId": "text"
}
put
Authorizations
Path parameters
reportIdstringRequired
groupIdstringRequired
subgroupIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
subgroupOrderinteger · int32 · min: 1Required
namestring · max: 100Required
dscstring · max: 255Optional
groupIdstringOptional
Responses
204
No Content
put
PUT /api/reports/{reportId}/groups/{groupId}/subgroups/{subgroupId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "id": "text",
  "subgroupOrder": 1,
  "name": "text",
  "dsc": "text",
  "groupId": "text"
}
No content
delete
Authorizations
Path parameters
reportIdstringRequired
groupIdstringRequired
subgroupIdstringRequired
Responses
204
No Content
delete
DELETE /api/reports/{reportId}/groups/{groupId}/subgroups/{subgroupId} HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
get
Authorizations
Path parameters
reportIdstringRequired
groupIdstringRequired
subgroupIdstringRequired
variableIdstringRequired
Responses
200
OK
*/*
get
GET /api/reports/{reportId}/groups/{groupId}/subgroups/{subgroupId}/variables/{variableId} HTTP/1.1
Host: inscada.cloud
Accept: */*

{
  "creationDate": "2025-07-05T18:28:25.405Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T18:28:25.405Z",
  "id": "text",
  "name": "text",
  "calcType": "Min",
  "variableOrder": 1,
  "totalCalcType": "Min",
  "subgroupId": "text",
  "pattern": "text",
  "variableId": "text",
  "totalVariableId": "text",
  "deviationCalcReportVariableId": "text",
  "dsc": "text",
  "deviationVariableId": "text"
}
put
Authorizations
Path parameters
reportIdstringRequired
groupIdstringRequired
subgroupIdstringRequired
variableIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
namestring · max: 100Required
calcTypestring · enumRequiredPossible values:
variableOrderinteger · int32 · min: 1Required
totalCalcTypestring · enumOptionalPossible values:
subgroupIdstringOptional
patternstring · max: 50Optional
variableIdstringOptional
totalVariableIdstringOptional
deviationCalcReportVariableIdstringOptional
dscstring · max: 255Optional
deviationVariableIdstringOptional
Responses
204
No Content
put
PUT /api/reports/{reportId}/groups/{groupId}/subgroups/{subgroupId}/variables/{variableId} HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 247

{
  "id": "text",
  "name": "text",
  "calcType": "Min",
  "variableOrder": 1,
  "totalCalcType": "Min",
  "subgroupId": "text",
  "pattern": "text",
  "variableId": "text",
  "totalVariableId": "text",
  "deviationCalcReportVariableId": "text",
  "dsc": "text",
  "deviationVariableId": "text"
}
No content
delete
Authorizations
Path parameters
reportIdstringRequired
groupIdstringRequired
subgroupIdstringRequired
variableIdstringRequired
Responses
204
No Content
delete
DELETE /api/reports/{reportId}/groups/{groupId}/subgroups/{subgroupId}/variables/{variableId} HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
get
Authorizations
Responses
200
OK
*/*
get
GET /api/reports HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-05T18:28:25.405Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T18:28:25.405Z",
    "id": "text",
    "minutes": 1,
    "reportDay": 1,
    "dsc": "text",
    "printDay": 1,
    "lang": "text",
    "no": "text",
    "logoFlag": true,
    "name": "text",
    "mailDay": 1,
    "period": "Hourly",
    "mailTo": "text",
    "projectId": "text",
    "printTime": "2025-07-05T18:28:25.405Z",
    "printFlag": true,
    "reportTime": "2025-07-05T18:28:25.405Z",
    "mailFlag": true,
    "mailTime": "2025-07-05T18:28:25.405Z",
    "owner": "text"
  }
]
post
Authorizations
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
minutesinteger · int32 · min: 1Optional
reportDayinteger · int32 · min: 1 · max: 31Optional
dscstring · max: 255Optional
printDayinteger · int32 · min: 1 · max: 31Optional
langstringOptional
nostring · max: 50Optional
logoFlagbooleanRequired
namestring · max: 100Required
mailDayinteger · int32 · min: 1 · max: 31Optional
periodstring · enumRequiredPossible values:
mailTostringOptional
projectIdstringOptional
printTimestring · date-timeOptional
printFlagbooleanRequired
reportTimestring · date-timeOptional
mailFlagbooleanRequired
mailTimestring · date-timeOptional
ownerstringOptional
Responses
200
OK
*/*
post
POST /api/reports HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 351

{
  "id": "text",
  "minutes": 1,
  "reportDay": 1,
  "dsc": "text",
  "printDay": 1,
  "lang": "text",
  "no": "text",
  "logoFlag": true,
  "name": "text",
  "mailDay": 1,
  "period": "Hourly",
  "mailTo": "text",
  "projectId": "text",
  "printTime": "2025-07-05T18:28:25.405Z",
  "printFlag": true,
  "reportTime": "2025-07-05T18:28:25.405Z",
  "mailFlag": true,
  "mailTime": "2025-07-05T18:28:25.405Z",
  "owner": "text"
}
{
  "creationDate": "2025-07-05T18:28:25.405Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T18:28:25.405Z",
  "id": "text",
  "minutes": 1,
  "reportDay": 1,
  "dsc": "text",
  "printDay": 1,
  "lang": "text",
  "no": "text",
  "logoFlag": true,
  "name": "text",
  "mailDay": 1,
  "period": "Hourly",
  "mailTo": "text",
  "projectId": "text",
  "printTime": "2025-07-05T18:28:25.405Z",
  "printFlag": true,
  "reportTime": "2025-07-05T18:28:25.405Z",
  "mailFlag": true,
  "mailTime": "2025-07-05T18:28:25.405Z",
  "owner": "text"
}
post
Authorizations
Path parameters
reportIdstringRequired
Responses
204
No Content
post
POST /api/reports/{reportId}/schedule HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
post
Authorizations
Path parameters
reportIdstringRequired
Query parameters
startDatestring · date-timeRequired
endDatestring · date-timeRequired
langstringRequired
Responses
204
No Content
post
POST /api/reports/{reportId}/print HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
post
Authorizations
Path parameters
reportIdstringRequired
Query parameters
startDatestring · date-timeRequired
endDatestring · date-timeRequired
langstringRequired
Responses
204
No Content
post
POST /api/reports/{reportId}/mail HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
get
Authorizations
Path parameters
reportIdstringRequired
Responses
200
OK
*/*
get
GET /api/reports/{reportId}/groups HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-05T18:28:25.405Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T18:28:25.405Z",
    "id": "text",
    "groupOrder": 1,
    "reportId": "text",
    "name": "text",
    "dsc": "text"
  }
]
post
Authorizations
Path parameters
reportIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
groupOrderinteger · int32 · min: 1Required
reportIdstringOptional
namestring · max: 100Required
dscstring · max: 255Optional
Responses
200
OK
*/*
post
POST /api/reports/{reportId}/groups HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "id": "text",
  "groupOrder": 1,
  "reportId": "text",
  "name": "text",
  "dsc": "text"
}
{
  "creationDate": "2025-07-05T18:28:25.405Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T18:28:25.405Z",
  "id": "text",
  "groupOrder": 1,
  "reportId": "text",
  "name": "text",
  "dsc": "text"
}
get
Authorizations
Path parameters
reportIdstringRequired
groupIdstringRequired
Responses
200
OK
*/*
get
GET /api/reports/{reportId}/groups/{groupId}/subgroups HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-05T18:28:25.405Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T18:28:25.405Z",
    "id": "text",
    "subgroupOrder": 1,
    "name": "text",
    "dsc": "text",
    "groupId": "text"
  }
]
post
Authorizations
Path parameters
reportIdstringRequired
groupIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
subgroupOrderinteger · int32 · min: 1Required
namestring · max: 100Required
dscstring · max: 255Optional
groupIdstringOptional
Responses
200
OK
*/*
post
POST /api/reports/{reportId}/groups/{groupId}/subgroups HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "id": "text",
  "subgroupOrder": 1,
  "name": "text",
  "dsc": "text",
  "groupId": "text"
}
{
  "creationDate": "2025-07-05T18:28:25.405Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T18:28:25.405Z",
  "id": "text",
  "subgroupOrder": 1,
  "name": "text",
  "dsc": "text",
  "groupId": "text"
}
get
Authorizations
Path parameters
reportIdstringRequired
groupIdstringRequired
subgroupIdstringRequired
Responses
200
OK
*/*
get
GET /api/reports/{reportId}/groups/{groupId}/subgroups/{subgroupId}/variables HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-05T18:28:25.405Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T18:28:25.405Z",
    "id": "text",
    "name": "text",
    "calcType": "Min",
    "variableOrder": 1,
    "totalCalcType": "Min",
    "subgroupId": "text",
    "pattern": "text",
    "variableId": "text",
    "totalVariableId": "text",
    "deviationCalcReportVariableId": "text",
    "dsc": "text",
    "deviationVariableId": "text"
  }
]
post
Authorizations
Path parameters
reportIdstringRequired
groupIdstringRequired
subgroupIdstringRequired
Body
creationDatestring · date-timeRead-onlyOptional
lastModifiedBystringRead-onlyOptional
createdBystringRead-onlyOptional
lastModifiedDatestring · date-timeRead-onlyOptional
idstringOptional
namestring · max: 100Required
calcTypestring · enumRequiredPossible values:
variableOrderinteger · int32 · min: 1Required
totalCalcTypestring · enumOptionalPossible values:
subgroupIdstringOptional
patternstring · max: 50Optional
variableIdstringOptional
totalVariableIdstringOptional
deviationCalcReportVariableIdstringOptional
dscstring · max: 255Optional
deviationVariableIdstringOptional
Responses
200
OK
*/*
post
POST /api/reports/{reportId}/groups/{groupId}/subgroups/{subgroupId}/variables HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 247

{
  "id": "text",
  "name": "text",
  "calcType": "Min",
  "variableOrder": 1,
  "totalCalcType": "Min",
  "subgroupId": "text",
  "pattern": "text",
  "variableId": "text",
  "totalVariableId": "text",
  "deviationCalcReportVariableId": "text",
  "dsc": "text",
  "deviationVariableId": "text"
}
{
  "creationDate": "2025-07-05T18:28:25.405Z",
  "lastModifiedBy": "text",
  "createdBy": "text",
  "lastModifiedDate": "2025-07-05T18:28:25.405Z",
  "id": "text",
  "name": "text",
  "calcType": "Min",
  "variableOrder": 1,
  "totalCalcType": "Min",
  "subgroupId": "text",
  "pattern": "text",
  "variableId": "text",
  "totalVariableId": "text",
  "deviationCalcReportVariableId": "text",
  "dsc": "text",
  "deviationVariableId": "text"
}
post
Authorizations
Path parameters
reportIdstringRequired
Responses
204
No Content
post
POST /api/reports/{reportId}/cancel HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
post
Authorizations
Query parameters
projectIdstringRequired
Responses
204
No Content
post
POST /api/reports/schedule/by-project HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
post
Authorizations
Query parameters
Body
filestring · binaryRequired
Responses
200
OK
*/*
Responseobject
post
POST /api/reports/import HTTP/1.1
Host: inscada.cloud
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "file": "binary"
}
{}
post
Authorizations
Query parameters
projectIdstringRequired
Responses
204
No Content
post
POST /api/reports/cancel/by-project HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
get
Authorizations
Path parameters
reportIdstringRequired
Responses
200
OK
*/*
Responsestring · enumPossible values:
get
GET /api/reports/{reportId}/status HTTP/1.1
Host: inscada.cloud
Accept: */*

Scheduled
get
Authorizations
Path parameters
reportIdstringRequired
Query parameters
startDatestring · date-timeRequired
endDatestring · date-timeRequired
langstringRequired
Responses
200
OK
*/*
Responsestring · byte
get
GET /api/reports/{reportId}/preview HTTP/1.1
Host: inscada.cloud
Accept: */*

Ynl0ZXM=
get
Authorizations
Path parameters
reportIdstringRequired
Query parameters
startDatestring · date-timeRequired
endDatestring · date-timeRequired
langstringRequired
Responses
200
OK
*/*
Responsestring · byte
get
GET /api/reports/{reportId}/export/excel HTTP/1.1
Host: inscada.cloud
Accept: */*

Ynl0ZXM=
get
Authorizations
Query parameters
reportIdsstring[]Required
Responses
200
OK
*/*
get
GET /api/reports/status/by-ids HTTP/1.1
Host: inscada.cloud
Accept: */*

{
  "ANY_ADDITIONAL_PROPERTY": "Scheduled"
}
get
Authorizations
Query parameters
projectIdstringOptional
includeIdsbooleanOptionalDefault: false
Responses
200
OK
*/*
Responseobject
get
GET /api/reports/export HTTP/1.1
Host: inscada.cloud
Accept: */*

{}
get
Authorizations
Query parameters
projectIdstringRequired
Responses
200
OK
*/*
get
GET /api/reports/by-project HTTP/1.1
Host: inscada.cloud
Accept: */*

[
  {
    "creationDate": "2025-07-05T18:28:25.405Z",
    "lastModifiedBy": "text",
    "createdBy": "text",
    "lastModifiedDate": "2025-07-05T18:28:25.405Z",
    "id": "text",
    "minutes": 1,
    "reportDay": 1,
    "dsc": "text",
    "printDay": 1,
    "lang": "text",
    "no": "text",
    "logoFlag": true,
    "name": "text",
    "mailDay": 1,
    "period": "Hourly",
    "mailTo": "text",
    "projectId": "text",
    "printTime": "2025-07-05T18:28:25.405Z",
    "printFlag": true,
    "reportTime": "2025-07-05T18:28:25.405Z",
    "mailFlag": true,
    "mailTime": "2025-07-05T18:28:25.405Z",
    "owner": "text"
  }
]
delete
Authorizations
Query parameters
reportIdsstring[]Required
Responses
204
No Content
delete
DELETE /api/reports/multi/by-ids HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
delete
Authorizations
Query parameters
variableIdsstring[]Required
Responses
204
No Content
delete
DELETE /api/reports/groups/subgroups/variables/multi/by-ids HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
delete
Authorizations
Query parameters
subgroupIdsstring[]Required
Responses
204
No Content
delete
DELETE /api/reports/groups/subgroups/multi/by-ids HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
delete
Authorizations
Query parameters
groupIdsstring[]Required
Responses
204
No Content
delete
DELETE /api/reports/groups/multi/by-ids HTTP/1.1
Host: inscada.cloud
Accept: */*

No content
PreviousRole ControllerNextS 7 Variable Controller