GET api/entity/customfield/GetFieldDefs

Gets the requested custom field definitions.

Request Information

URI Parameters

Name	Description	Type	Additional information
FieldIDs	Gets or sets the field identifiers.	Collection of integer	None.
Since	The timestamp to use. This should always be UTC.	date	None.

Body Parameters

None.

Response Information

Resource Description

WebMethodResultOfListOfFieldDef

Name	Type	Additional information
Result	Collection of FieldDef	None.
Success	boolean	None.
ErrorText	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Result": [
    {
      "ID": 1,
      "Name": "sample string 2",
      "Partition": 0,
      "EntityType": 0,
      "DataType": 1,
      "DefaultValue": "sample string 3",
      "IsSeasonal": true,
      "IsArray": true,
      "IsActive": true,
      "Version": 7,
      "Options": [
        "sample string 1",
        "sample string 2"
      ],
      "TimeStamp": {
        "Created": {
          "PersonID": 1,
          "DateTime": "sample string 1"
        },
        "Modified": {
          "PersonID": 1,
          "DateTime": "sample string 1"
        },
        "Archived": {
          "PersonID": 1,
          "DateTime": "sample string 1"
        }
      }
    },
    {
      "ID": 1,
      "Name": "sample string 2",
      "Partition": 0,
      "EntityType": 0,
      "DataType": 1,
      "DefaultValue": "sample string 3",
      "IsSeasonal": true,
      "IsArray": true,
      "IsActive": true,
      "Version": 7,
      "Options": [
        "sample string 1",
        "sample string 2"
      ],
      "TimeStamp": {
        "Created": {
          "PersonID": 1,
          "DateTime": "sample string 1"
        },
        "Modified": {
          "PersonID": 1,
          "DateTime": "sample string 1"
        },
        "Archived": {
          "PersonID": 1,
          "DateTime": "sample string 1"
        }
      }
    }
  ],
  "Success": true,
  "ErrorText": "sample string 2"
}

application/javascript

Sample:

{"Result":[{"ID":1,"Name":"sample string 2","Partition":0,"EntityType":0,"DataType":1,"DefaultValue":"sample string 3","IsSeasonal":true,"IsArray":true,"IsActive":true,"Version":7,"Options":["sample string 1","sample string 2"],"TimeStamp":{"Created":{"PersonID":1,"DateTime":"sample string 1"},"Modified":{"PersonID":1,"DateTime":"sample string 1"},"Archived":{"PersonID":1,"DateTime":"sample string 1"}}},{"ID":1,"Name":"sample string 2","Partition":0,"EntityType":0,"DataType":1,"DefaultValue":"sample string 3","IsSeasonal":true,"IsArray":true,"IsActive":true,"Version":7,"Options":["sample string 1","sample string 2"],"TimeStamp":{"Created":{"PersonID":1,"DateTime":"sample string 1"},"Modified":{"PersonID":1,"DateTime":"sample string 1"},"Archived":{"PersonID":1,"DateTime":"sample string 1"}}}],"Success":true,"ErrorText":"sample string 2"}

application/xml, text/xml

Sample:

<WebMethodResultOfListOfFieldDef xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Success>true</Success>
  <ErrorText>sample string 2</ErrorText>
  <Result>
    <FieldDef>
      <ID>1</ID>
      <Name>sample string 2</Name>
      <Partition>Undefined</Partition>
      <EntityType>Undefined</EntityType>
      <DataType>String</DataType>
      <DefaultValue>sample string 3</DefaultValue>
      <IsSeasonal>true</IsSeasonal>
      <IsArray>true</IsArray>
      <IsActive>true</IsActive>
      <Version>7</Version>
      <Options>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </Options>
      <TimeStamp>
        <Created>
          <PersonID>1</PersonID>
          <DateTime>sample string 1</DateTime>
        </Created>
        <Modified>
          <PersonID>1</PersonID>
          <DateTime>sample string 1</DateTime>
        </Modified>
        <Archived>
          <PersonID>1</PersonID>
          <DateTime>sample string 1</DateTime>
        </Archived>
      </TimeStamp>
    </FieldDef>
    <FieldDef>
      <ID>1</ID>
      <Name>sample string 2</Name>
      <Partition>Undefined</Partition>
      <EntityType>Undefined</EntityType>
      <DataType>String</DataType>
      <DefaultValue>sample string 3</DefaultValue>
      <IsSeasonal>true</IsSeasonal>
      <IsArray>true</IsArray>
      <IsActive>true</IsActive>
      <Version>7</Version>
      <Options>
        <string>sample string 1</string>
        <string>sample string 2</string>
      </Options>
      <TimeStamp>
        <Created>
          <PersonID>1</PersonID>
          <DateTime>sample string 1</DateTime>
        </Created>
        <Modified>
          <PersonID>1</PersonID>
          <DateTime>sample string 1</DateTime>
        </Modified>
        <Archived>
          <PersonID>1</PersonID>
          <DateTime>sample string 1</DateTime>
        </Archived>
      </TimeStamp>
    </FieldDef>
  </Result>
</WebMethodResultOfListOfFieldDef>