Reporting - Run Report

URI

https://164.99.19.131:8443/SentinelRESTServices/rpt/definitions/{reportDefinitionID}/sched

Supported Methods

POST

This API runs the chosen report. One can specify minimal input parameters, with either no parameters or just time period, but be aware that all required input parameters must have default values or else an error will be returned. Additionally, for more complex reports, one can specify values for all input parameters. The call is asynchronous, as it starts the report run job on a separate thread and returns the report run job ID. Note the format of the JSON String required when specifing the report parameters in the examples below.

Authentication

Authentication Types

X-SAML

Sentinel Permissions Needed

Supported Formats

Request

application/json
application/xml

URL Parameters

None.

Success Codes

200 OK

Fault Codes

400 Bad Request
404 Not Found
500 Internal Server Error
400 with NCAC Fault Data
- Code ValueSender
- Subcode Value: InvalidInput
- Reason Text: Bad parameter, various input problems.
400 with NCAC Fault Data
- Code ValueSender
- Subcode Value: ReportMissingRequiredParam
- Reason Text: The report definition 'myComplexReport' requires the following parameter(s) to be specified: REQUEST_ITEM.
404 with NCAC Fault Data
- Code ValueSender
- Subcode Value: ReportDefinitionDoesNotExist
- Reason Text: The report definition 'notAValidReport' does not exist.
400 with NCAC Fault Data
- Code ValueSender
- Subcode Value: ReportRunFailedUserRights
- Reason Text: Unable to determine report runner user's rights
500 with NCAC Fault Data
- Code ValueSender
- Subcode Value: InternalError
- Reason Text: Internal processing error

Request Data

Object type: Run Parameters
Optional POST data to specify when running a report<BR /> Example 1: {}<BR /> Example 2: { 'DisplayName':'Identity Report', 'Email':{'To': 'test@novell.com'}, 'Parameters': [{'InternalName':'SortOrder', 'Value':'Description'}, {'InternalName':'REPORT_LOCALE' , 'Value':'en'}] }
Field	Required	Description
DisplayName	false	The display name of the report result, used to override the report name
Email	false	One or more email addresses to send report to.
Parameters	true	One or more parameter name/value fields to pass to the report being run

Sample Request

POST rpt/definition/myReport/sched
Run a minimal report taking all report defaults

{}

Sample Response for application/json

Status: 201

{"Status", "OK", "GUID":"E0235B40-0221-102E-B805-001641E6949B"}&#10;

Sample Request

POST rpt/definition/myComplexReport/sched
Run a report passing additional parameters

{ "DisplayName":"my report run", "Parameters":[ { "InternalName":"ReportType", "Value":"D" } { "InternalName":"REPORT_LOCALE", "Value":"fr" } { "InternalName":"SORT_ORDER", "Value":"DESC" }] }&#10;

Sample Response for application/json

Status: 201

{"Status", "OK", "GUID":"E0235B40-0221-102E-B805-001641E6949C"}&#10;

Sample Request

POST rpt/definition/myComplexReport/sched
Run a report not supplying sufficent parameters

{ "Parameters":[ { "InternalName":"REPORT_LOCALE" , "Value":"fr"} { "InternalName":"SORT_ORDER", "Value":"DESC" }] }

Sample Response for application/json

Status: 400

{"Fault": {"Code": {"Value":"Sender", "Subcode": {"Value":"InvalidInput"} }, "Reason": {"Text":"The report definition "myComplexReport" requires the following parameter(s) to be specified: ReportType."} } }

Back to main API page