GET api/Dictionary?systemName={systemName}&username={username}&password={password}&loginType={loginType}&language={language}

Gets dictionary of available tables and fields

Request Information

URI Parameters

NameDescriptionTypeAdditional information
systemName

string

Required

username

string

Required

password

string

Required

loginType

string

None.

language

string

Default value is English

Body Parameters

None.

Response Information

Resource Description

APIReportDictionary
NameDescriptionTypeAdditional information
DictionaryTable

List of APIReportDictionaryTable

Collection of APIReportDictionaryTable

None.

StandardField

List of APIReportDictionaryFieldDisplay

Collection of APIReportDictionaryField

None.

ComparativeField

List of APIReportDictionaryFieldDisplay

Collection of APIReportDictionaryField

None.

Response Formats

application/json, text/json

Sample:
{
  "dictionaryTable": [
    {
      "name": "sample string 1",
      "displayName": "sample string 2",
      "popular": true,
      "field": [
        {
          "name": "sample string 1",
          "displayName": "sample string 2",
          "popular": true,
          "folderName": "sample string 4",
          "displayFolderName": "sample string 5",
          "fieldType": "sample string 6"
        },
        {
          "name": "sample string 1",
          "displayName": "sample string 2",
          "popular": true,
          "folderName": "sample string 4",
          "displayFolderName": "sample string 5",
          "fieldType": "sample string 6"
        }
      ]
    },
    {
      "name": "sample string 1",
      "displayName": "sample string 2",
      "popular": true,
      "field": [
        {
          "name": "sample string 1",
          "displayName": "sample string 2",
          "popular": true,
          "folderName": "sample string 4",
          "displayFolderName": "sample string 5",
          "fieldType": "sample string 6"
        },
        {
          "name": "sample string 1",
          "displayName": "sample string 2",
          "popular": true,
          "folderName": "sample string 4",
          "displayFolderName": "sample string 5",
          "fieldType": "sample string 6"
        }
      ]
    }
  ],
  "standardField": [
    {
      "name": "sample string 1",
      "displayName": "sample string 2",
      "popular": true,
      "folderName": "sample string 4",
      "displayFolderName": "sample string 5",
      "fieldType": "sample string 6"
    },
    {
      "name": "sample string 1",
      "displayName": "sample string 2",
      "popular": true,
      "folderName": "sample string 4",
      "displayFolderName": "sample string 5",
      "fieldType": "sample string 6"
    }
  ],
  "comparativeField": [
    {
      "name": "sample string 1",
      "displayName": "sample string 2",
      "popular": true,
      "folderName": "sample string 4",
      "displayFolderName": "sample string 5",
      "fieldType": "sample string 6"
    },
    {
      "name": "sample string 1",
      "displayName": "sample string 2",
      "popular": true,
      "folderName": "sample string 4",
      "displayFolderName": "sample string 5",
      "fieldType": "sample string 6"
    }
  ]
}

application/xml, text/xml

Sample:
<APIReportDictionary xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Rochester.Models">
  <ComparativeField>
    <APIReportDictionaryField>
      <DisplayFolderName>sample string 5</DisplayFolderName>
      <DisplayName>sample string 2</DisplayName>
      <FieldType>sample string 6</FieldType>
      <FolderName>sample string 4</FolderName>
      <Name>sample string 1</Name>
      <Popular>true</Popular>
    </APIReportDictionaryField>
    <APIReportDictionaryField>
      <DisplayFolderName>sample string 5</DisplayFolderName>
      <DisplayName>sample string 2</DisplayName>
      <FieldType>sample string 6</FieldType>
      <FolderName>sample string 4</FolderName>
      <Name>sample string 1</Name>
      <Popular>true</Popular>
    </APIReportDictionaryField>
  </ComparativeField>
  <DictionaryTable>
    <APIReportDictionaryTable>
      <DisplayName>sample string 2</DisplayName>
      <Field>
        <APIReportDictionaryField>
          <DisplayFolderName>sample string 5</DisplayFolderName>
          <DisplayName>sample string 2</DisplayName>
          <FieldType>sample string 6</FieldType>
          <FolderName>sample string 4</FolderName>
          <Name>sample string 1</Name>
          <Popular>true</Popular>
        </APIReportDictionaryField>
        <APIReportDictionaryField>
          <DisplayFolderName>sample string 5</DisplayFolderName>
          <DisplayName>sample string 2</DisplayName>
          <FieldType>sample string 6</FieldType>
          <FolderName>sample string 4</FolderName>
          <Name>sample string 1</Name>
          <Popular>true</Popular>
        </APIReportDictionaryField>
      </Field>
      <Name>sample string 1</Name>
      <Popular>true</Popular>
    </APIReportDictionaryTable>
    <APIReportDictionaryTable>
      <DisplayName>sample string 2</DisplayName>
      <Field>
        <APIReportDictionaryField>
          <DisplayFolderName>sample string 5</DisplayFolderName>
          <DisplayName>sample string 2</DisplayName>
          <FieldType>sample string 6</FieldType>
          <FolderName>sample string 4</FolderName>
          <Name>sample string 1</Name>
          <Popular>true</Popular>
        </APIReportDictionaryField>
        <APIReportDictionaryField>
          <DisplayFolderName>sample string 5</DisplayFolderName>
          <DisplayName>sample string 2</DisplayName>
          <FieldType>sample string 6</FieldType>
          <FolderName>sample string 4</FolderName>
          <Name>sample string 1</Name>
          <Popular>true</Popular>
        </APIReportDictionaryField>
      </Field>
      <Name>sample string 1</Name>
      <Popular>true</Popular>
    </APIReportDictionaryTable>
  </DictionaryTable>
  <StandardField>
    <APIReportDictionaryField>
      <DisplayFolderName>sample string 5</DisplayFolderName>
      <DisplayName>sample string 2</DisplayName>
      <FieldType>sample string 6</FieldType>
      <FolderName>sample string 4</FolderName>
      <Name>sample string 1</Name>
      <Popular>true</Popular>
    </APIReportDictionaryField>
    <APIReportDictionaryField>
      <DisplayFolderName>sample string 5</DisplayFolderName>
      <DisplayName>sample string 2</DisplayName>
      <FieldType>sample string 6</FieldType>
      <FolderName>sample string 4</FolderName>
      <Name>sample string 1</Name>
      <Popular>true</Popular>
    </APIReportDictionaryField>
  </StandardField>
</APIReportDictionary>