ProReport - Get all report instances

API Url

Use it for loading all report instances that were saved in the repository.

GET
http://localhost:16010/ProMarkREST/rest/ProReport/repository

Permissions: user

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data.

    savedReportsObject[]

Object with all saved report instances.

      canEditBoolean

True = Logged in user can change the report.

      descString

Description of the report instance.

      expiryDate

Date when report will stop being available in the repository.

      fileIdString

Unique identifier of the report files. Needed when opening reports.

      idString

Unique identifier of the report instance.

      ownerString

Report creator's user id.

      parentIdString

Unique identifier of the report used when running this instance.

      privateBoolean

Report's security status.

      recurrentBoolean

true=Report is part of a recurrence series.

      reportTypeString

Report type (0=Classic report, 1=Excel report, 2=Host report).

      runTimeDatetime

Date and time when report was executed. If 'null', the report was not yet executed (delayed execution).

      sharedWithoptionalString

Available only for ownder. A list of users ids of users that have access to the report.

  messageoptionalObject

Object containing response messages.

    codeNumber

Message code.

    textString

Message text.

    typeString

Type of message.

Allowed values:"warning""info"

Success example:

HTTP/1.1 200 OK
{
"response": {
"data": {
"savedReports": [
{
"id": "Rep10000",
"desc": "Account balance on employee",
"runTime": "2016-11-01T08:00:00.000",
"expiry": "2016-11-30",
"fileId": "13243546",
"recurrent": false,
"parentId": "AccBalance02",
"reportType": 0,
"owner": "MGR",
"canEdit": true,
"private": true
}
]
},
"errorCode": 0,
"errorMessage": ""
}
}

Error 4xx

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data (empty).

  errorCodeNumber

Error code.

  errorMessageString

Error description.