Back to main API page

Reporting - Get Report Status Detail

URI

https://164.99.19.131:8443/SentinelRESTServices/rpt/definitions/{reportDefinitionID}/reports/{reportJobId}

Supported Methods

GET

Given a report definition ID and a report job ID, return the status of that job. Included will be information on when the report was run, by whom, completion status, and error messages generated during the run. It also returns the parameters used when generating the report.

Authentication

Authentication Types
Sentinel Permissions Needed

URL Parameters

None.

Success Codes

Fault Codes

Sample Request

GET /rpt/definitions/91702BA0-EE9A-102B-BBAC-00218502569D/reports/E0235B40-0221-102E-B805-001641E6949B
Sample Response for application/json
Status: 200
{"ReportID":"E0235B40-0221-102E-B805-001641E6949B","DisplayName":"sleepy john","RunDate":1295020320098,
"InProgress":false,"Failed":false,"RunBy":{"Value":"admin","Roles":["Administrator"]},
"Parameters": [{"InternalName":"REPORT_LOCALE","DisplayName":"Language","Type":"String","Value":"pt","IsForPrompting":"1","Required":"0","OptionMultivalue":"0"},
{"InternalName":"SEARCH_TARGETS","DisplayName":"Targets","Type":"String","Value":"[Local](--LOCALHOST--)","IsForPrompting":"1","Required":"0","OptionMultivalue":"0"},
{"InternalName":"SortOrder","DisplayName":"Sort Order","Type":"String","Value":"Tag","IsForPrompting":"1","Required":"0","OptionMultivalue":"0"}]}


Sample Request

GET /rpt/definitions/notAValidReport
Sample Response for application/json
Status: 404
{"Fault":{"Code":{"Value":"Sender","Subcode":{"Value":"ReportDefinitionDoesNotExist"}},"Reason":{"Text":"The report definition "notAValidReport" does not exist."}}}


Sample Request

GET /rpt/definitions/notAValidReport
Sample Response for application/json
Status: 404
{"Fault":{"Code":{"Value":"Sender","Subcode":{"Value":"ReportIdDoesNotExist"}},"Reason":{"Text":"The report result "E0235B40-0221-102E-B805-001641E6YYY" does not exist."}}}

Back to main API page