GET api/Reports/Definition?reportName={reportName}

Request Information

URI Parameters

Name	Description	Type	Additional information
reportName		string	Required

Body Parameters

None.

Response Information

Resource Description

ServiceExecutionResultOfReportDefinition

Name	Type	Additional information
Result	ReportDefinition	None.
Success	boolean	None.
ChangesFound	boolean	None.
Errors	Collection of ServiceErrorItem	None.

Response Formats

application/json, text/json

Sample:

{
  "Errors": [
    {
      "Name": "sample string 1",
      "Code": 2,
      "Value": "sample string 3"
    },
    {
      "Name": "sample string 1",
      "Code": 2,
      "Value": "sample string 3"
    }
  ],
  "Result": {
    "Inputs": [
      {
        "DisplayName": "sample string 1",
        "Dependents": [
          "sample string 1",
          "sample string 2"
        ],
        "MultiSelect": true,
        "DataSource": "sample string 3",
        "Name": "sample string 4",
        "Optional": true,
        "Type": 0,
        "IsCollection": true,
        "RequiredForQuery": true,
        "CanBeEmpty": true
      },
      {
        "DisplayName": "sample string 1",
        "Dependents": [
          "sample string 1",
          "sample string 2"
        ],
        "MultiSelect": true,
        "DataSource": "sample string 3",
        "Name": "sample string 4",
        "Optional": true,
        "Type": 0,
        "IsCollection": true,
        "RequiredForQuery": true,
        "CanBeEmpty": true
      }
    ],
    "Output": [
      {
        "Name": "sample string 1",
        "DisplayName": "sample string 2",
        "CsvName": "sample string 3",
        "Type": 0,
        "Visible": true,
        "InnerTally": true,
        "TallyFooter": true,
        "IsHyperlink": true,
        "HyperlinkTemplate": "sample string 8",
        "SingleQuoteCSVOutput": true
      },
      {
        "Name": "sample string 1",
        "DisplayName": "sample string 2",
        "CsvName": "sample string 3",
        "Type": 0,
        "Visible": true,
        "InnerTally": true,
        "TallyFooter": true,
        "IsHyperlink": true,
        "HyperlinkTemplate": "sample string 8",
        "SingleQuoteCSVOutput": true
      }
    ],
    "UmbrellaColumns": [
      {
        "Text": "sample string 1",
        "ColSpan": 2
      },
      {
        "Text": "sample string 1",
        "ColSpan": 2
      }
    ],
    "Grouping": [
      "sample string 1",
      "sample string 2"
    ],
    "Sorting": "sample string 1",
    "Version": "sample string 2",
    "DisplayName": "sample string 3",
    "Name": "sample string 4",
    "Description": "sample string 5",
    "RoleFunction": "sample string 6",
    "DenyRoles": "sample string 7"
  },
  "Success": true,
  "ChangesFound": true
}

application/xml, text/xml

Sample:

<ServiceExecutionResultOfReportDefinitionHH1MaigK xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/POLi.CodeInfrastructure.Services">
  <ChangesFound>true</ChangesFound>
  <Errors>
    <ServiceErrorItem>
      <Code>2</Code>
      <Name>sample string 1</Name>
      <Value>sample string 3</Value>
    </ServiceErrorItem>
    <ServiceErrorItem>
      <Code>2</Code>
      <Name>sample string 1</Name>
      <Value>sample string 3</Value>
    </ServiceErrorItem>
  </Errors>
  <Success>true</Success>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/ReportAPI.Internal.Models.Engine">
    <d2p1:DenyRoles>sample string 7</d2p1:DenyRoles>
    <d2p1:Description>sample string 5</d2p1:Description>
    <d2p1:DisplayName>sample string 3</d2p1:DisplayName>
    <d2p1:Name>sample string 4</d2p1:Name>
    <d2p1:RoleFunction>sample string 6</d2p1:RoleFunction>
    <d2p1:Version>sample string 2</d2p1:Version>
    <d2p1:Grouping xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </d2p1:Grouping>
    <d2p1:Inputs>
      <d2p1:ReportInputParameterDefinition>
        <d2p1:CanBeEmpty>true</d2p1:CanBeEmpty>
        <d2p1:IsCollection>true</d2p1:IsCollection>
        <d2p1:Name>sample string 4</d2p1:Name>
        <d2p1:Optional>true</d2p1:Optional>
        <d2p1:RequiredForQuery>true</d2p1:RequiredForQuery>
        <d2p1:Type>String</d2p1:Type>
        <d2p1:DataSource>sample string 3</d2p1:DataSource>
        <d2p1:Dependents xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d2p1:Dependents>
        <d2p1:DisplayName>sample string 1</d2p1:DisplayName>
        <d2p1:MultiSelect>true</d2p1:MultiSelect>
      </d2p1:ReportInputParameterDefinition>
      <d2p1:ReportInputParameterDefinition>
        <d2p1:CanBeEmpty>true</d2p1:CanBeEmpty>
        <d2p1:IsCollection>true</d2p1:IsCollection>
        <d2p1:Name>sample string 4</d2p1:Name>
        <d2p1:Optional>true</d2p1:Optional>
        <d2p1:RequiredForQuery>true</d2p1:RequiredForQuery>
        <d2p1:Type>String</d2p1:Type>
        <d2p1:DataSource>sample string 3</d2p1:DataSource>
        <d2p1:Dependents xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:string>sample string 1</d5p1:string>
          <d5p1:string>sample string 2</d5p1:string>
        </d2p1:Dependents>
        <d2p1:DisplayName>sample string 1</d2p1:DisplayName>
        <d2p1:MultiSelect>true</d2p1:MultiSelect>
      </d2p1:ReportInputParameterDefinition>
    </d2p1:Inputs>
    <d2p1:Output>
      <d2p1:OutputColumnDefinition>
        <d2p1:CsvName>sample string 3</d2p1:CsvName>
        <d2p1:DisplayName>sample string 2</d2p1:DisplayName>
        <d2p1:HyperlinkTemplate>sample string 8</d2p1:HyperlinkTemplate>
        <d2p1:InnerTally>true</d2p1:InnerTally>
        <d2p1:IsHyperlink>true</d2p1:IsHyperlink>
        <d2p1:Name>sample string 1</d2p1:Name>
        <d2p1:SingleQuoteCSVOutput>true</d2p1:SingleQuoteCSVOutput>
        <d2p1:TallyFooter>true</d2p1:TallyFooter>
        <d2p1:Type>String</d2p1:Type>
        <d2p1:Visible>true</d2p1:Visible>
      </d2p1:OutputColumnDefinition>
      <d2p1:OutputColumnDefinition>
        <d2p1:CsvName>sample string 3</d2p1:CsvName>
        <d2p1:DisplayName>sample string 2</d2p1:DisplayName>
        <d2p1:HyperlinkTemplate>sample string 8</d2p1:HyperlinkTemplate>
        <d2p1:InnerTally>true</d2p1:InnerTally>
        <d2p1:IsHyperlink>true</d2p1:IsHyperlink>
        <d2p1:Name>sample string 1</d2p1:Name>
        <d2p1:SingleQuoteCSVOutput>true</d2p1:SingleQuoteCSVOutput>
        <d2p1:TallyFooter>true</d2p1:TallyFooter>
        <d2p1:Type>String</d2p1:Type>
        <d2p1:Visible>true</d2p1:Visible>
      </d2p1:OutputColumnDefinition>
    </d2p1:Output>
    <d2p1:Sorting>sample string 1</d2p1:Sorting>
    <d2p1:UmbrellaColumns>
      <d2p1:OutputColumnUmbrella>
        <d2p1:ColSpan>2</d2p1:ColSpan>
        <d2p1:Text>sample string 1</d2p1:Text>
      </d2p1:OutputColumnUmbrella>
      <d2p1:OutputColumnUmbrella>
        <d2p1:ColSpan>2</d2p1:ColSpan>
        <d2p1:Text>sample string 1</d2p1:Text>
      </d2p1:OutputColumnUmbrella>
    </d2p1:UmbrellaColumns>
  </Result>
</ServiceExecutionResultOfReportDefinitionHH1MaigK>