GET api/DirectoryColumn/{id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

string

None.

Body Parameters

None.

Response Information

Resource Description

DirectoryQueryViewModel
NameDescriptionTypeAdditional information
ViewName

string

None.

AvailableColumns

Collection of DirectoryColumnGroupViewModel

None.

AllGroupColumns

Collection of DirectoryColumnGroupViewModel

None.

SelectedColumns

Collection of DirectoryColumnViewModel

None.

AllColumns

Collection of DirectoryColumnViewModel

None.

GroupColumns

Collection of DirectoryColumnViewModel

None.

AvailableColumnsUngroup

Collection of DirectoryColumnViewModel

None.

SelectedAvailableColumns

Collection of DirectoryColumnViewModel

None.

SelectedChosenColumns

Collection of DirectoryColumnViewModel

None.

RelativeDateFilter

DirectoryDateFilterViewModel

None.

Response Formats

application/json, text/json

Sample:
{
  "viewName": "sample string 1",
  "availableColumns": [
    {
      "categoryName": "sample string 1",
      "columns": [
        {
          "tableName": "sample string 1",
          "fieldName": "sample string 2",
          "columnName": "sample string 3",
          "dataType": 0,
          "sorted": 4,
          "width": "sample string 5"
        },
        {
          "tableName": "sample string 1",
          "fieldName": "sample string 2",
          "columnName": "sample string 3",
          "dataType": 0,
          "sorted": 4,
          "width": "sample string 5"
        }
      ],
      "className": "sample string 2"
    },
    {
      "categoryName": "sample string 1",
      "columns": [
        {
          "tableName": "sample string 1",
          "fieldName": "sample string 2",
          "columnName": "sample string 3",
          "dataType": 0,
          "sorted": 4,
          "width": "sample string 5"
        },
        {
          "tableName": "sample string 1",
          "fieldName": "sample string 2",
          "columnName": "sample string 3",
          "dataType": 0,
          "sorted": 4,
          "width": "sample string 5"
        }
      ],
      "className": "sample string 2"
    }
  ],
  "allGroupColumns": [
    {
      "categoryName": "sample string 1",
      "columns": [
        {
          "tableName": "sample string 1",
          "fieldName": "sample string 2",
          "columnName": "sample string 3",
          "dataType": 0,
          "sorted": 4,
          "width": "sample string 5"
        },
        {
          "tableName": "sample string 1",
          "fieldName": "sample string 2",
          "columnName": "sample string 3",
          "dataType": 0,
          "sorted": 4,
          "width": "sample string 5"
        }
      ],
      "className": "sample string 2"
    },
    {
      "categoryName": "sample string 1",
      "columns": [
        {
          "tableName": "sample string 1",
          "fieldName": "sample string 2",
          "columnName": "sample string 3",
          "dataType": 0,
          "sorted": 4,
          "width": "sample string 5"
        },
        {
          "tableName": "sample string 1",
          "fieldName": "sample string 2",
          "columnName": "sample string 3",
          "dataType": 0,
          "sorted": 4,
          "width": "sample string 5"
        }
      ],
      "className": "sample string 2"
    }
  ],
  "selectedColumns": [
    {
      "tableName": "sample string 1",
      "fieldName": "sample string 2",
      "columnName": "sample string 3",
      "dataType": 0,
      "sorted": 4,
      "width": "sample string 5"
    },
    {
      "tableName": "sample string 1",
      "fieldName": "sample string 2",
      "columnName": "sample string 3",
      "dataType": 0,
      "sorted": 4,
      "width": "sample string 5"
    }
  ],
  "allColumns": [
    {
      "tableName": "sample string 1",
      "fieldName": "sample string 2",
      "columnName": "sample string 3",
      "dataType": 0,
      "sorted": 4,
      "width": "sample string 5"
    },
    {
      "tableName": "sample string 1",
      "fieldName": "sample string 2",
      "columnName": "sample string 3",
      "dataType": 0,
      "sorted": 4,
      "width": "sample string 5"
    }
  ],
  "groupColumns": [
    {
      "tableName": "sample string 1",
      "fieldName": "sample string 2",
      "columnName": "sample string 3",
      "dataType": 0,
      "sorted": 4,
      "width": "sample string 5"
    },
    {
      "tableName": "sample string 1",
      "fieldName": "sample string 2",
      "columnName": "sample string 3",
      "dataType": 0,
      "sorted": 4,
      "width": "sample string 5"
    }
  ],
  "availableColumnsUngroup": [
    {
      "tableName": "sample string 1",
      "fieldName": "sample string 2",
      "columnName": "sample string 3",
      "dataType": 0,
      "sorted": 4,
      "width": "sample string 5"
    },
    {
      "tableName": "sample string 1",
      "fieldName": "sample string 2",
      "columnName": "sample string 3",
      "dataType": 0,
      "sorted": 4,
      "width": "sample string 5"
    }
  ],
  "selectedAvailableColumns": [
    {
      "tableName": "sample string 1",
      "fieldName": "sample string 2",
      "columnName": "sample string 3",
      "dataType": 0,
      "sorted": 4,
      "width": "sample string 5"
    },
    {
      "tableName": "sample string 1",
      "fieldName": "sample string 2",
      "columnName": "sample string 3",
      "dataType": 0,
      "sorted": 4,
      "width": "sample string 5"
    }
  ],
  "selectedChosenColumns": [
    {
      "tableName": "sample string 1",
      "fieldName": "sample string 2",
      "columnName": "sample string 3",
      "dataType": 0,
      "sorted": 4,
      "width": "sample string 5"
    },
    {
      "tableName": "sample string 1",
      "fieldName": "sample string 2",
      "columnName": "sample string 3",
      "dataType": 0,
      "sorted": 4,
      "width": "sample string 5"
    }
  ],
  "relativeDateFilter": {
    "dateFields": [
      {
        "id": 1,
        "idString": "sample string 2",
        "name": "sample string 3",
        "parentId": "sample string 4",
        "description": "sample string 5",
        "selected": true,
        "sortIndex": 7,
        "uniqueId": "d8a635fe-2c23-431d-a801-2005ce266692",
        "parentUid": "267b134f-974e-4ff8-acde-c154167d5378"
      },
      {
        "id": 1,
        "idString": "sample string 2",
        "name": "sample string 3",
        "parentId": "sample string 4",
        "description": "sample string 5",
        "selected": true,
        "sortIndex": 7,
        "uniqueId": "d8a635fe-2c23-431d-a801-2005ce266692",
        "parentUid": "267b134f-974e-4ff8-acde-c154167d5378"
      }
    ],
    "units": [
      {
        "id": 1,
        "idString": "sample string 2",
        "name": "sample string 3",
        "parentId": "sample string 4",
        "description": "sample string 5",
        "selected": true,
        "sortIndex": 7,
        "uniqueId": "d8a635fe-2c23-431d-a801-2005ce266692",
        "parentUid": "267b134f-974e-4ff8-acde-c154167d5378"
      },
      {
        "id": 1,
        "idString": "sample string 2",
        "name": "sample string 3",
        "parentId": "sample string 4",
        "description": "sample string 5",
        "selected": true,
        "sortIndex": 7,
        "uniqueId": "d8a635fe-2c23-431d-a801-2005ce266692",
        "parentUid": "267b134f-974e-4ff8-acde-c154167d5378"
      }
    ],
    "dateField": 1,
    "dateFieldText": "sample string 2",
    "dateUnit": 3,
    "dateRangeFrom": 4,
    "dateRangeTo": 5,
    "dateEnabled": true,
    "dateFilterJson": "sample string 7",
    "dateRangeFromValue": "sample string 8",
    "dateRangeToValue": "sample string 9"
  }
}

application/xml, text/xml

Sample:
<DirectoryQueryViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <AllColumns>
    <DirectoryColumnViewModel>
      <ColumnName>sample string 3</ColumnName>
      <DataType>TextEdit</DataType>
      <FieldName>sample string 2</FieldName>
      <Sorted>4</Sorted>
      <TableName>sample string 1</TableName>
      <Width>sample string 5</Width>
    </DirectoryColumnViewModel>
    <DirectoryColumnViewModel>
      <ColumnName>sample string 3</ColumnName>
      <DataType>TextEdit</DataType>
      <FieldName>sample string 2</FieldName>
      <Sorted>4</Sorted>
      <TableName>sample string 1</TableName>
      <Width>sample string 5</Width>
    </DirectoryColumnViewModel>
  </AllColumns>
  <AllGroupColumns>
    <DirectoryColumnGroupViewModel>
      <CategoryName>sample string 1</CategoryName>
      <ClassName>sample string 2</ClassName>
      <Columns>
        <DirectoryColumnViewModel>
          <ColumnName>sample string 3</ColumnName>
          <DataType>TextEdit</DataType>
          <FieldName>sample string 2</FieldName>
          <Sorted>4</Sorted>
          <TableName>sample string 1</TableName>
          <Width>sample string 5</Width>
        </DirectoryColumnViewModel>
        <DirectoryColumnViewModel>
          <ColumnName>sample string 3</ColumnName>
          <DataType>TextEdit</DataType>
          <FieldName>sample string 2</FieldName>
          <Sorted>4</Sorted>
          <TableName>sample string 1</TableName>
          <Width>sample string 5</Width>
        </DirectoryColumnViewModel>
      </Columns>
    </DirectoryColumnGroupViewModel>
    <DirectoryColumnGroupViewModel>
      <CategoryName>sample string 1</CategoryName>
      <ClassName>sample string 2</ClassName>
      <Columns>
        <DirectoryColumnViewModel>
          <ColumnName>sample string 3</ColumnName>
          <DataType>TextEdit</DataType>
          <FieldName>sample string 2</FieldName>
          <Sorted>4</Sorted>
          <TableName>sample string 1</TableName>
          <Width>sample string 5</Width>
        </DirectoryColumnViewModel>
        <DirectoryColumnViewModel>
          <ColumnName>sample string 3</ColumnName>
          <DataType>TextEdit</DataType>
          <FieldName>sample string 2</FieldName>
          <Sorted>4</Sorted>
          <TableName>sample string 1</TableName>
          <Width>sample string 5</Width>
        </DirectoryColumnViewModel>
      </Columns>
    </DirectoryColumnGroupViewModel>
  </AllGroupColumns>
  <AvailableColumns>
    <DirectoryColumnGroupViewModel>
      <CategoryName>sample string 1</CategoryName>
      <ClassName>sample string 2</ClassName>
      <Columns>
        <DirectoryColumnViewModel>
          <ColumnName>sample string 3</ColumnName>
          <DataType>TextEdit</DataType>
          <FieldName>sample string 2</FieldName>
          <Sorted>4</Sorted>
          <TableName>sample string 1</TableName>
          <Width>sample string 5</Width>
        </DirectoryColumnViewModel>
        <DirectoryColumnViewModel>
          <ColumnName>sample string 3</ColumnName>
          <DataType>TextEdit</DataType>
          <FieldName>sample string 2</FieldName>
          <Sorted>4</Sorted>
          <TableName>sample string 1</TableName>
          <Width>sample string 5</Width>
        </DirectoryColumnViewModel>
      </Columns>
    </DirectoryColumnGroupViewModel>
    <DirectoryColumnGroupViewModel>
      <CategoryName>sample string 1</CategoryName>
      <ClassName>sample string 2</ClassName>
      <Columns>
        <DirectoryColumnViewModel>
          <ColumnName>sample string 3</ColumnName>
          <DataType>TextEdit</DataType>
          <FieldName>sample string 2</FieldName>
          <Sorted>4</Sorted>
          <TableName>sample string 1</TableName>
          <Width>sample string 5</Width>
        </DirectoryColumnViewModel>
        <DirectoryColumnViewModel>
          <ColumnName>sample string 3</ColumnName>
          <DataType>TextEdit</DataType>
          <FieldName>sample string 2</FieldName>
          <Sorted>4</Sorted>
          <TableName>sample string 1</TableName>
          <Width>sample string 5</Width>
        </DirectoryColumnViewModel>
      </Columns>
    </DirectoryColumnGroupViewModel>
  </AvailableColumns>
  <AvailableColumnsUngroup>
    <DirectoryColumnViewModel>
      <ColumnName>sample string 3</ColumnName>
      <DataType>TextEdit</DataType>
      <FieldName>sample string 2</FieldName>
      <Sorted>4</Sorted>
      <TableName>sample string 1</TableName>
      <Width>sample string 5</Width>
    </DirectoryColumnViewModel>
    <DirectoryColumnViewModel>
      <ColumnName>sample string 3</ColumnName>
      <DataType>TextEdit</DataType>
      <FieldName>sample string 2</FieldName>
      <Sorted>4</Sorted>
      <TableName>sample string 1</TableName>
      <Width>sample string 5</Width>
    </DirectoryColumnViewModel>
  </AvailableColumnsUngroup>
  <GroupColumns>
    <DirectoryColumnViewModel>
      <ColumnName>sample string 3</ColumnName>
      <DataType>TextEdit</DataType>
      <FieldName>sample string 2</FieldName>
      <Sorted>4</Sorted>
      <TableName>sample string 1</TableName>
      <Width>sample string 5</Width>
    </DirectoryColumnViewModel>
    <DirectoryColumnViewModel>
      <ColumnName>sample string 3</ColumnName>
      <DataType>TextEdit</DataType>
      <FieldName>sample string 2</FieldName>
      <Sorted>4</Sorted>
      <TableName>sample string 1</TableName>
      <Width>sample string 5</Width>
    </DirectoryColumnViewModel>
  </GroupColumns>
  <RelativeDateFilter>
    <DateEnabled>true</DateEnabled>
    <DateField>1</DateField>
    <DateFieldText>sample string 2</DateFieldText>
    <DateFields xmlns:d3p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto">
      <d3p1:LookupDto>
        <d3p1:_x003C_Description_x003E_k__BackingField>sample string 5</d3p1:_x003C_Description_x003E_k__BackingField>
        <d3p1:_x003C_IdString_x003E_k__BackingField>sample string 2</d3p1:_x003C_IdString_x003E_k__BackingField>
        <d3p1:_x003C_Id_x003E_k__BackingField>1</d3p1:_x003C_Id_x003E_k__BackingField>
        <d3p1:_x003C_Name_x003E_k__BackingField>sample string 3</d3p1:_x003C_Name_x003E_k__BackingField>
        <d3p1:_x003C_ParentId_x003E_k__BackingField>sample string 4</d3p1:_x003C_ParentId_x003E_k__BackingField>
        <d3p1:_x003C_ParentUid_x003E_k__BackingField>267b134f-974e-4ff8-acde-c154167d5378</d3p1:_x003C_ParentUid_x003E_k__BackingField>
        <d3p1:_x003C_Selected_x003E_k__BackingField>true</d3p1:_x003C_Selected_x003E_k__BackingField>
        <d3p1:_x003C_SortIndex_x003E_k__BackingField>7</d3p1:_x003C_SortIndex_x003E_k__BackingField>
        <d3p1:_x003C_UniqueId_x003E_k__BackingField>d8a635fe-2c23-431d-a801-2005ce266692</d3p1:_x003C_UniqueId_x003E_k__BackingField>
      </d3p1:LookupDto>
      <d3p1:LookupDto>
        <d3p1:_x003C_Description_x003E_k__BackingField>sample string 5</d3p1:_x003C_Description_x003E_k__BackingField>
        <d3p1:_x003C_IdString_x003E_k__BackingField>sample string 2</d3p1:_x003C_IdString_x003E_k__BackingField>
        <d3p1:_x003C_Id_x003E_k__BackingField>1</d3p1:_x003C_Id_x003E_k__BackingField>
        <d3p1:_x003C_Name_x003E_k__BackingField>sample string 3</d3p1:_x003C_Name_x003E_k__BackingField>
        <d3p1:_x003C_ParentId_x003E_k__BackingField>sample string 4</d3p1:_x003C_ParentId_x003E_k__BackingField>
        <d3p1:_x003C_ParentUid_x003E_k__BackingField>267b134f-974e-4ff8-acde-c154167d5378</d3p1:_x003C_ParentUid_x003E_k__BackingField>
        <d3p1:_x003C_Selected_x003E_k__BackingField>true</d3p1:_x003C_Selected_x003E_k__BackingField>
        <d3p1:_x003C_SortIndex_x003E_k__BackingField>7</d3p1:_x003C_SortIndex_x003E_k__BackingField>
        <d3p1:_x003C_UniqueId_x003E_k__BackingField>d8a635fe-2c23-431d-a801-2005ce266692</d3p1:_x003C_UniqueId_x003E_k__BackingField>
      </d3p1:LookupDto>
    </DateFields>
    <DateFilterJson>sample string 7</DateFilterJson>
    <DateRangeFrom>4</DateRangeFrom>
    <DateRangeFromValue>sample string 8</DateRangeFromValue>
    <DateRangeTo>5</DateRangeTo>
    <DateRangeToValue>sample string 9</DateRangeToValue>
    <DateUnit>3</DateUnit>
    <Units xmlns:d3p1="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.Dto">
      <d3p1:LookupDto>
        <d3p1:_x003C_Description_x003E_k__BackingField>sample string 5</d3p1:_x003C_Description_x003E_k__BackingField>
        <d3p1:_x003C_IdString_x003E_k__BackingField>sample string 2</d3p1:_x003C_IdString_x003E_k__BackingField>
        <d3p1:_x003C_Id_x003E_k__BackingField>1</d3p1:_x003C_Id_x003E_k__BackingField>
        <d3p1:_x003C_Name_x003E_k__BackingField>sample string 3</d3p1:_x003C_Name_x003E_k__BackingField>
        <d3p1:_x003C_ParentId_x003E_k__BackingField>sample string 4</d3p1:_x003C_ParentId_x003E_k__BackingField>
        <d3p1:_x003C_ParentUid_x003E_k__BackingField>267b134f-974e-4ff8-acde-c154167d5378</d3p1:_x003C_ParentUid_x003E_k__BackingField>
        <d3p1:_x003C_Selected_x003E_k__BackingField>true</d3p1:_x003C_Selected_x003E_k__BackingField>
        <d3p1:_x003C_SortIndex_x003E_k__BackingField>7</d3p1:_x003C_SortIndex_x003E_k__BackingField>
        <d3p1:_x003C_UniqueId_x003E_k__BackingField>d8a635fe-2c23-431d-a801-2005ce266692</d3p1:_x003C_UniqueId_x003E_k__BackingField>
      </d3p1:LookupDto>
      <d3p1:LookupDto>
        <d3p1:_x003C_Description_x003E_k__BackingField>sample string 5</d3p1:_x003C_Description_x003E_k__BackingField>
        <d3p1:_x003C_IdString_x003E_k__BackingField>sample string 2</d3p1:_x003C_IdString_x003E_k__BackingField>
        <d3p1:_x003C_Id_x003E_k__BackingField>1</d3p1:_x003C_Id_x003E_k__BackingField>
        <d3p1:_x003C_Name_x003E_k__BackingField>sample string 3</d3p1:_x003C_Name_x003E_k__BackingField>
        <d3p1:_x003C_ParentId_x003E_k__BackingField>sample string 4</d3p1:_x003C_ParentId_x003E_k__BackingField>
        <d3p1:_x003C_ParentUid_x003E_k__BackingField>267b134f-974e-4ff8-acde-c154167d5378</d3p1:_x003C_ParentUid_x003E_k__BackingField>
        <d3p1:_x003C_Selected_x003E_k__BackingField>true</d3p1:_x003C_Selected_x003E_k__BackingField>
        <d3p1:_x003C_SortIndex_x003E_k__BackingField>7</d3p1:_x003C_SortIndex_x003E_k__BackingField>
        <d3p1:_x003C_UniqueId_x003E_k__BackingField>d8a635fe-2c23-431d-a801-2005ce266692</d3p1:_x003C_UniqueId_x003E_k__BackingField>
      </d3p1:LookupDto>
    </Units>
  </RelativeDateFilter>
  <SelectedAvailableColumns>
    <DirectoryColumnViewModel>
      <ColumnName>sample string 3</ColumnName>
      <DataType>TextEdit</DataType>
      <FieldName>sample string 2</FieldName>
      <Sorted>4</Sorted>
      <TableName>sample string 1</TableName>
      <Width>sample string 5</Width>
    </DirectoryColumnViewModel>
    <DirectoryColumnViewModel>
      <ColumnName>sample string 3</ColumnName>
      <DataType>TextEdit</DataType>
      <FieldName>sample string 2</FieldName>
      <Sorted>4</Sorted>
      <TableName>sample string 1</TableName>
      <Width>sample string 5</Width>
    </DirectoryColumnViewModel>
  </SelectedAvailableColumns>
  <SelectedChosenColumns>
    <DirectoryColumnViewModel>
      <ColumnName>sample string 3</ColumnName>
      <DataType>TextEdit</DataType>
      <FieldName>sample string 2</FieldName>
      <Sorted>4</Sorted>
      <TableName>sample string 1</TableName>
      <Width>sample string 5</Width>
    </DirectoryColumnViewModel>
    <DirectoryColumnViewModel>
      <ColumnName>sample string 3</ColumnName>
      <DataType>TextEdit</DataType>
      <FieldName>sample string 2</FieldName>
      <Sorted>4</Sorted>
      <TableName>sample string 1</TableName>
      <Width>sample string 5</Width>
    </DirectoryColumnViewModel>
  </SelectedChosenColumns>
  <SelectedColumns>
    <DirectoryColumnViewModel>
      <ColumnName>sample string 3</ColumnName>
      <DataType>TextEdit</DataType>
      <FieldName>sample string 2</FieldName>
      <Sorted>4</Sorted>
      <TableName>sample string 1</TableName>
      <Width>sample string 5</Width>
    </DirectoryColumnViewModel>
    <DirectoryColumnViewModel>
      <ColumnName>sample string 3</ColumnName>
      <DataType>TextEdit</DataType>
      <FieldName>sample string 2</FieldName>
      <Sorted>4</Sorted>
      <TableName>sample string 1</TableName>
      <Width>sample string 5</Width>
    </DirectoryColumnViewModel>
  </SelectedColumns>
  <ViewName>sample string 1</ViewName>
</DirectoryQueryViewModel>