SLnet.WebExtApi

<back to all web services

DashboardMetadata

Generic API

The following routes are available for this service:
GET/api/{DomainName}/dashboards/{DashboardName}/metadataReturns metadata of the specified dashboard

To override the Content-type in your clients HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/DashboardMetadata HTTP/1.1 
Host: drt-racing.gr 
Content-Type: application/xml
Content-Length: length

<DashboardMetadata xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SLnet.WebExtApi.ServiceInterface.WebAPI.Api">
  <DomainName xmlns="http://schemas.datacontract.org/2004/07/SLnet.WebExtApi.WebAPI.Api">String</DomainName>
  <DashboardName xmlns="http://schemas.datacontract.org/2004/07/SLnet.WebExtApi.WebAPI.Api">String</DashboardName>
  <IncludeDesign>false</IncludeDesign>
</DashboardMetadata>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DashboardResource xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SLnet.WebExtApi.Common">
  <Name>String</Name>
  <Uri>String</Uri>
  <Description>String</Description>
  <Title>String</Title>
  <Category>String</Category>
  <GroupName>String</GroupName>
  <DashboardDesign>String</DashboardDesign>
  <DataSourceName>String</DataSourceName>
  <DataSourceType>0</DataSourceType>
  <Filters>
    <SchemaFilter>
      <AcceptedValues>
        <AcceptedValuesList>String</AcceptedValuesList>
        <DisplayField1>String</DisplayField1>
        <DisplayField2>String</DisplayField2>
        <DisplayInfo>
          <AutoSizeColumns>false</AutoSizeColumns>
          <Columns>
            <LookupColumn>
              <Description>String</Description>
              <Name>String</Name>
              <Width>0</Width>
            </LookupColumn>
          </Columns>
        </DisplayInfo>
        <IndexField>String</IndexField>
        <KeyField>String</KeyField>
        <LookupData xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:ArrayOfKeyValueOfstringanyType>
            <d5p1:KeyValueOfstringanyType>
              <d5p1:Key>String</d5p1:Key>
              <d5p1:Value />
            </d5p1:KeyValueOfstringanyType>
          </d5p1:ArrayOfKeyValueOfstringanyType>
        </LookupData>
        <ParentField>String</ParentField>
        <SortFields>
          <SortByField>
            <Direction>String</Direction>
            <Name>String</Name>
          </SortByField>
        </SortFields>
      </AcceptedValues>
      <AllowNullState>false</AllowNullState>
      <AllowedOperators xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </AllowedOperators>
      <Behaviour>String</Behaviour>
      <DataType>String</DataType>
      <Description>String</Description>
      <DisplayAs>String</DisplayAs>
      <Enable>false</Enable>
      <FieldName>String</FieldName>
      <Hidden>false</Hidden>
      <Kind>String</Kind>
      <LinkName>String</LinkName>
      <Name>String</Name>
      <Operators>
        <From>String</From>
        <To>String</To>
        <Value>String</Value>
      </Operators>
      <PredefinedValues>
        <From />
        <To />
        <Value />
      </PredefinedValues>
      <Required>false</Required>
      <UseRange>false</UseRange>
      <Visible>false</Visible>
    </SchemaFilter>
  </Filters>
  <Views>
    <DashboardView>
      <Name>String</Name>
      <Uri>String</Uri>
      <Description>String</Description>
      <Title>String</Title>
      <DashboardDesign>String</DashboardDesign>
    </DashboardView>
  </Views>
</DashboardResource>