POST Api/Reports/GetReport

Request Information

URI Parameters

None.

Body Parameters

ReportForm
NameDescriptionTypeAdditional information
CustomReportId

integer

None.

ReportLocation

ReportLocationEnum

None.

Title

string

None.

Description

string

None.

ReportType

ReportTypeEnum

None.

Roles

string

None.

Params

Collection of FormParam

None.

Request Formats

application/json, text/json

Sample:
{
  "customReportId": 1,
  "reportLocation": 0,
  "title": "sample string 2",
  "description": "sample string 3",
  "reportType": 0,
  "roles": "sample string 4",
  "params": [
    {
      "name": "sample string 1",
      "label": "sample string 2",
      "value": {},
      "required": true,
      "hidden": true,
      "typeOfField": 1
    },
    {
      "name": "sample string 1",
      "label": "sample string 2",
      "value": {},
      "required": true,
      "hidden": true,
      "typeOfField": 1
    }
  ]
}

multipart/form-data

Sample:
{"customReportId":1,"reportLocation":0,"title":"sample string 2","description":"sample string 3","reportType":0,"roles":"sample string 4","params":[{"name":"sample string 1","label":"sample string 2","value":{},"required":true,"hidden":true,"typeOfField":1},{"name":"sample string 1","label":"sample string 2","value":{},"required":true,"hidden":true,"typeOfField":1}]}

application/xml, text/xml

Sample:
<ReportForm xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <CustomReportId>1</CustomReportId>
  <ReportLocation>CustomReportTab</ReportLocation>
  <Title>sample string 2</Title>
  <Description>sample string 3</Description>
  <ReportType>CSV</ReportType>
  <Roles>sample string 4</Roles>
  <Params>
    <FormParam>
      <Name>sample string 1</Name>
      <Label>sample string 2</Label>
      <Value />
      <Required>true</Required>
      <Hidden>true</Hidden>
      <TypeOfField>1</TypeOfField>
    </FormParam>
    <FormParam>
      <Name>sample string 1</Name>
      <Label>sample string 2</Label>
      <Value />
      <Required>true</Required>
      <Hidden>true</Hidden>
      <TypeOfField>1</TypeOfField>
    </FormParam>
  </Params>
</ReportForm>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.