GET api/SystemFields?include={include}

Request Information

URI Parameters

Name	Description	Type	Additional information
include		string	Default value is

Body Parameters

None.

Response Information

Resource Description

Collection of SystemField

Name	Type	Additional information
Id	integer	None.
Name	string	None.
DefaultValue	string	None.
IsNullable	boolean	None.
IsMatchingField	boolean	None.
IsPrimaryKey	boolean	None.
IsForeignKey	boolean	None.
FieldTypeId	integer	None.
FieldType	FieldType	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "Name": "sample string 2",
    "DefaultValue": "sample string 3",
    "IsNullable": true,
    "IsMatchingField": true,
    "IsPrimaryKey": true,
    "IsForeignKey": true,
    "FieldTypeId": 8,
    "FieldType": {
      "Id": 1,
      "FriendlyDataType": "sample string 2",
      "SQLDataType": "sample string 3",
      "FieldTypeKey": "sample string 4"
    }
  },
  {
    "Id": 1,
    "Name": "sample string 2",
    "DefaultValue": "sample string 3",
    "IsNullable": true,
    "IsMatchingField": true,
    "IsPrimaryKey": true,
    "IsForeignKey": true,
    "FieldTypeId": 8,
    "FieldType": {
      "Id": 1,
      "FriendlyDataType": "sample string 2",
      "SQLDataType": "sample string 3",
      "FieldTypeKey": "sample string 4"
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfSystemField xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DataOrbis.WebApi.Models">
  <SystemField>
    <DefaultValue>sample string 3</DefaultValue>
    <FieldType>
      <FieldTypeKey>sample string 4</FieldTypeKey>
      <FriendlyDataType>sample string 2</FriendlyDataType>
      <Id>1</Id>
      <SQLDataType>sample string 3</SQLDataType>
    </FieldType>
    <FieldTypeId>8</FieldTypeId>
    <Id>1</Id>
    <IsForeignKey>true</IsForeignKey>
    <IsMatchingField>true</IsMatchingField>
    <IsNullable>true</IsNullable>
    <IsPrimaryKey>true</IsPrimaryKey>
    <Name>sample string 2</Name>
  </SystemField>
  <SystemField>
    <DefaultValue>sample string 3</DefaultValue>
    <FieldType>
      <FieldTypeKey>sample string 4</FieldTypeKey>
      <FriendlyDataType>sample string 2</FriendlyDataType>
      <Id>1</Id>
      <SQLDataType>sample string 3</SQLDataType>
    </FieldType>
    <FieldTypeId>8</FieldTypeId>
    <Id>1</Id>
    <IsForeignKey>true</IsForeignKey>
    <IsMatchingField>true</IsMatchingField>
    <IsNullable>true</IsNullable>
    <IsPrimaryKey>true</IsPrimaryKey>
    <Name>sample string 2</Name>
  </SystemField>
</ArrayOfSystemField>