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 |
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 |
POST rpt/definition/myReport/sched Run a minimal report taking all report defaults
{}
{"Status", "OK", "GUID":"E0235B40-0221-102E-B805-001641E6949B"}
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" }] }
{"Status", "OK", "GUID":"E0235B40-0221-102E-B805-001641E6949C"}
POST rpt/definition/myComplexReport/sched Run a report not supplying sufficent parameters
{ "Parameters":[ { "InternalName":"REPORT_LOCALE" , "Value":"fr"} { "InternalName":"SORT_ORDER", "Value":"DESC" }] }
{"Fault": {"Code": {"Value":"Sender", "Subcode": {"Value":"InvalidInput"} }, "Reason": {"Text":"The report definition "myComplexReport" requires the following parameter(s) to be specified: ReportType."} } }