ProReport - Search

API Url

Search for reports within ProReport

GET

http://localhost:16010/ProMarkREST/rest/ProReport/search/{text}

Permissions: user

Path parameters

Field	Type	Description
Text	String	to search.

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
results	Object[]	Search results.
desc	String	Description.
id	String	Unique identifier. Can be a report or a report instance.
parentId	Number	Unique identifier of the parent report that was used for creating this custom report. Only when standard = false. Size range: `1-2`
reportType	Number	Report type (0=Classic report, 1=Excel report, 3=Host report). Size range: `1-2`
type	Number	Result type (1=Reports, 2=Report instances). Size range: `1-2`
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Success example when searching for 'efficiency':

HTTP/1.1 200 OK
{
   "response": {
      "data": {
         "results": [
            {
               "id": "Job01",
               "desc": "Department/employee efficiency",
               "type": 1,
               "ReportType": 0,
               "parentId": ""
            },
            {
               "id": "Rep010101",
               "desc": "Department/employee efficiency for September 2016",
               "type": 2,
               "ReportType": 0,
               "parentId": "Job01"
            }
         ]
      },
      "errorCode": 0,
      "errorMessage": ""
   }
}

Error 4xx

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data (empty).
errorCode	Number	Error code.
errorMessage	String	Error description.