GET api/{context}/customdata/ID/{text}

Retrieve a custom data field by its ID (Name).

Request Information

ParameterDescriptionAdditional information
text 
The Name of the custom data field

Define this parameter in the request URI.

Special Field Notes

Field NameNotes
AccessLevel 
Maps to a User Role in Aegis CRM.
DataType 
Valid choices are limited to 'currency', 'date', 'decimal' (double/float), 'number' (integer), 'picklist', 'text', or 'yesno'.
MaxLength 
The max length for the value (can be null/empty).

Response Information

Response body formats

application/json, text/json

Sample: 
{
  "Name": "sample string 1",
  "Description": "sample string 2",
  "DataType": "sample string 3",
  "AccessLevel": "sample string 4",
  "Active": true,
  "MaxLength": 1
}

application/xml, text/xml

Sample: 
<CustomDataModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDS.Web.WebApi.Models">
  <AccessLevel>sample string 4</AccessLevel>
  <Active>true</Active>
  <DataType>sample string 3</DataType>
  <Description>sample string 2</Description>
  <MaxLength>1</MaxLength>
  <Name>sample string 1</Name>
</CustomDataModel>