GET Report/{reportId}/Parameters?culture={culture}

Returns the ReportParameters for a report identified with reportId. If no parameters can be found for the given reportId, HttpStatusCode.NotFound is returned.

Request Information

URI Parameters

Name	Description	Type	Additional information
reportId	The identifier of the report, can be either the ReportName, or the ReportTemplateId	string	Required
culture		string	Required

Body Parameters

None.

Response Information

Resource Description

Returns a ReportParametersRestResult indicating all the Parameters for the report with

ReportParametersRestResult

Name	Description	Type	Additional information
ReportParametersResultItems	The parameters	Collection of ReportParametersResultItem	None.

Response Formats

application/json, text/json

Sample:

{
  "ReportParametersResultItems": [
    {
      "IsPredefined": true,
      "ReportParameterName": "sample string 2",
      "ReportParameterId": "sample string 3",
      "ValidValues": [
        {
          "Text": "sample string 1",
          "Value": 2
        },
        {
          "Text": "sample string 1",
          "Value": 2
        }
      ],
      "SelectedValues": [
        1,
        2
      ],
      "Value": {}
    },
    {
      "IsPredefined": true,
      "ReportParameterName": "sample string 2",
      "ReportParameterId": "sample string 3",
      "ValidValues": [
        {
          "Text": "sample string 1",
          "Value": 2
        },
        {
          "Text": "sample string 1",
          "Value": 2
        }
      ],
      "SelectedValues": [
        1,
        2
      ],
      "Value": {}
    }
  ]
}

application/xml, text/xml

Sample:

<ReportParametersRestResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api360.Models">
  <ReportParametersResultItems>
    <ReportParametersResultItem>
      <IsPredefined>true</IsPredefined>
      <ReportParameterId>sample string 3</ReportParameterId>
      <ReportParameterName>sample string 2</ReportParameterName>
      <SelectedValues xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </SelectedValues>
      <ValidValues>
        <TextValuePair>
          <Text>sample string 1</Text>
          <Value>2</Value>
        </TextValuePair>
        <TextValuePair>
          <Text>sample string 1</Text>
          <Value>2</Value>
        </TextValuePair>
      </ValidValues>
      <Value />
    </ReportParametersResultItem>
    <ReportParametersResultItem>
      <IsPredefined>true</IsPredefined>
      <ReportParameterId>sample string 3</ReportParameterId>
      <ReportParameterName>sample string 2</ReportParameterName>
      <SelectedValues xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </SelectedValues>
      <ValidValues>
        <TextValuePair>
          <Text>sample string 1</Text>
          <Value>2</Value>
        </TextValuePair>
        <TextValuePair>
          <Text>sample string 1</Text>
          <Value>2</Value>
        </TextValuePair>
      </ValidValues>
      <Value />
    </ReportParametersResultItem>
  </ReportParametersResultItems>
</ReportParametersRestResult>