POST applications/{app_id}/reports/{report_id}/execute

Runs the specified report with the supplied parameters.

Request Information

URI Parameters

Name	Description	Type	Additional information
app_id	ID of the application instance	string	Required
report_id	ID of the report	string	Required

Body Parameters

Parameters used when executing the report

ReportParameters

Name	Description	Type	Additional information
parameters		Collection of ReportParameter	None.

Request Formats

application/json, text/json

Sample:

{
  "parameters": [
    {
      "name": "sample string 1",
      "value": [
        "sample string 1",
        "sample string 2"
      ]
    },
    {
      "name": "sample string 1",
      "value": [
        "sample string 1",
        "sample string 2"
      ]
    }
  ]
}

multipart/form-data

Sample:

{"parameters":[{"name":"sample string 1","value":["sample string 1","sample string 2"]},{"name":"sample string 1","value":["sample string 1","sample string 2"]}]}

application/xml, text/xml

Sample:

<ReportParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/application_api.Models.Reports">
  <Parameters>
    <ReportParameter>
      <Name>sample string 1</Name>
      <Value xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Value>
    </ReportParameter>
    <ReportParameter>
      <Name>sample string 1</Name>
      <Value xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Value>
    </ReportParameter>
  </Parameters>
</ReportParameters>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Example URI: https://domain.com/iv2/apis/v2/application/applications/:app_id/reports/:report_id/execute

ReportStatus

Name	Description	Type	Additional information
status		ReportState	None.
job_id		globally unique identifier	None.

Response Formats

application/json, text/json

Sample:

{
  "status": "success",
  "job_id": "14d601bc-4cd3-4d7b-80d1-ada0d7706b1f"
}

multipart/form-data

Sample:

{"status":"success","job_id":"14d601bc-4cd3-4d7b-80d1-ada0d7706b1f"}

application/xml, text/xml

Sample:

<ReportStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/application_api.Models.Reports">
  <JobId>14d601bc-4cd3-4d7b-80d1-ada0d7706b1f</JobId>
  <Status>success</Status>
</ReportStatus>