POST api/UserReports/{id}/Execute

Executes the specified custom user report and retrieves its output.

Request

Parameters

Name Description Default
id Unique report ID.

Body

Content Type: application/xml or application/json
Values for the parameters of the report.

XML JSON
<Request>                    <!--Array of 'Item'--> 
  <Item>                     
    <Name>string</Name>      
    <Value>object</Value>    
  </Item>                    
</Request>                   
[{                      
   "Name": "string",    
   "Value": "object"    
}]                      
                        

Response

Body

Content Type: application/xml or application/json
Data set containing the output of the report or an error message.

XML JSON
<Response>                         
  <Result>                         <!--Array of 'Item'--> 
    <Item>                         
      <Column1>object</Column1>    <!--Substitute with actual column name--> 
      <Column2>object</Column2>    
      <Column3>object</Column3>    
    </Item>                        
  </Result>                        
  <Message>string</Message>        <!--Error message--> 
</Response>                        
{                             
   "Result": [{               
      "Column1": "object",    // Substitute with actual column name
      "Column2": "object",    
      "Column3": "object"     
   }],                        
   "Message": "string"        // Error message
}                             
                              

Status Codes

Code Condition
200 OK The operation completed successfully.
400 Bad RequestInvalid report ID.
401 Unauthorized Access token is invalid, expired or not specified.
404 Not FoundReport not found.
406 Not Acceptable Content type specified in the Accept header isn't supported.
500 Internal Server Error An internal error occurred.

Remarks

When executing a custom report non-interactively, only the values of the parameters are required. Any parameters that have a default value specified in the report definition are optional.

Column values are returned without formatting. Heading text is ignored.