Reporting - Get Report Definition Detail

URI

https://164.99.19.131:8443/SentinelRESTServices/rpt/definitions/{reportDefinitionId}

Supported Methods

GET

This API brings back details on the passed in report. This data includes the parameters that are accepted when running 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
Sample Response for application/json
Status: 200
{"DisplayName":"Sentinel Core Event Configuration 6.1r1","Description":"This report displays all the Sentinel event fields along with a brief description.",
"ReportFile":"TemplateReport.jrxml","PluginParameterDefinitions":
[{"Type":"String","DisplayName":"Language","InternalName":"REPORT_LOCALE","Description":"Select the language in which the report will be generated.","DefaultValue":"en","IsForPrompting":"1",
"Options":{"Property":[{"Value":"en","Name":"English"},{"Value":"fr","Name":"French"},{"Value":"de","Name":"German"},{"Value":"it","Name":"Italian"},
{"Value":"ja","Name":"Japanese"}, {"Value":"zh_TW","Name":"Traditional Chinese"},{"Value":"zh","Name":"Simplified Chinese"},
{"Value":"es","Name":"Spanish"},
{"Value":"pt","Name":"Portuguese"}]}},
{"Type":"String","DisplayName":"Sort Order","InternalName":"SortOrder","Description":"Select the sort field.","DefaultValue":"Tag","IsForPrompting":"1",
"Options":{"Property":[{"Value":"Tag","Name":"Tag"},{"Value":"Label","Name":"Label"},+
{"Value":"Description","Name":"Description"}]}}],"Format":"PDF","Version":"6.1r1","ReleaseDate":"1241732503000",
"Links":{"Export":"definitions/Sentinel-Core_Event-Configuration_6.1r1/rpz","Scheduling":"definitions/Sentinel-Core_Event-Configuration_6.1r1/sched"}}


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."}}}