Retrieve Custom Object Field

Retrieves a single field from a specific custom object.

Endpoint

https://api.neoncrm.com/neonws/services/api/customObject/retrieveCustomObjectField

Request

https://api.neoncrm.com/neonws/services/api/customObject/retrieveCustomObjectField?userSessionId=[session id]&objectApiName=Test_Custom_Object_c&objectFieldApiName=Related_Account_c

Response

{
  "retrieveCustomObjectFieldResponse": {
    "operationResult": "SUCCESS",
    "responseDateTime": "2017-05-23T17:29:20.847+0000",
    "customObjectField": {
      "fieldLabel": "Related Account",
      "fieldApiName": "Related_Account_c",
      "fieldDescription": "The Account to which my object is related.",
      "fieldHelpText": "Search for accounts.",
      "fieldDataType": "MASTER_DETAIL",
      "isInternal": false,
      "masterDetailFieldAttributes": {
        "relatedObjectApiName": "account_user",
        "reparentAllow": false,
        "deleteAction": "BLOCK",
        "relationFilter": {
          "errorMessage": "This is my error message.",
          "lookupWindowText": "lookup text",
          "relationFilterJsonString": "[{\"groupId\":\"1\",\"searchField\":\"\",\"criteriaField\":\"organizationType\",\"type\":\"2\",\"searchValue\":\"Association, Commercial Business, Corporate Sponsor, Government, Media, Not-for-profit, Religious Institution, School\",\"operator\":\"In Range Of\"},{\"groupId\":\"1\",\"searchField\":\"\",\"criteriaField\":\"id\",\"searchValue\":\"\",\"operator\":\"Not Blank\"},{\"groupId\":\"1\",\"searchField\":\"\",\"criteriaField\":\"email1\",\"searchValue\":\"\",\"operator\":\"Containing\"},{\"groupId\":\"1\",\"searchField\":\"lastName\",\"criteriaField\":\"companyName\",\"type\":\"1\",\"searchValue\":\"\",\"operator\":\"Equal\"}]"
        }
      }
    }
  }
}

Request Parameters

Parameter Required Description
objectApiName Required This is the token used to identify the Custom Object when accessing it from the API.
objectFieldApiName Required This is the API-specific name for the field being retrieved.

Response Parameters

Parameter Description
customObjectField.fieldLabel This is the unique name used to identify the field in the custom object. It will also be used in the data entry and data list pages.
customObjectField.fieldApiName This is the API-specific name for the field being retrieved.
customObjectField.fieldDescription On the data entry screen, this message shows up as the header content of the popup window when you click the magnifying glass to search this field.
customObjectField.fieldHelpText This message shows up when you move the mouse over the corresponding question mark on the data entry form and listing page.
customObjectField.fieldDataType Possible values: AUTO_NUMBER, TEXT, FORMULA, NUMBER, EMAIL, PHONE, URL, PERCENT, TEXTAREA_SHORT, TEXTAREA, DATE, DATETIME, BOOLEAN, CHECKBOX, DROPDOWN, RADIO, MASTER_DETAIL, LOOKUP. The type of data this field accepts.
customObjectField.isInternal Possible values: TRUE, FALSE. Enable this if you want to make this field available only to system users and hide it from any public-facing web pages.
AUTO_NUMBER Fields
customObjectField.autoNumberFieldAttributes.startingNumber Required Must be an integer. Specify which number should be used as the starting point for your Auto-Number field.
customObjectField.autoNumberFieldAttributes.displayFormat Required Please refer to our guide: Custom Object Number Formats
FORMULA Fields
customObjectField.formulaFieldAttributes.formulaFieldReturnDataType Required Possible values: BOOLEAN, NUMBER, PERCENT, TEXT, DATETIME, DATE. The data type that should be returned and displayed.
customObjectField.formulaFieldAttributes.formulaExpression Required The formula to be used to calculate the value for this field. Use the formula building tool in NeonCRM’s custom objects interface to generate this formula.
MASTER/DETAIL Fields
customObjectField.masterDetailFieldAttributes.relatedObjectApiName If this object is related to another object, that relationship will be shown here.
customObjectField.masterDetailFieldAttributes.reparentAllow Possible values: TRUE, FALSE. Determines whether or not this child object record can be reassigned to a different parent object record after it has been created. (Example: Donations cannot be assigned to a different account after they have been created.)
customObjectField.masterDetailFieldAttributes.deleteAction Possible Values: CASCADE, BLOCK. Cascade Delete allows deletion of this object’s records when its parent object record is deleted. Block requires that all of this object’s records be deleted before it’s parent object record can be deleted.
customObjectField.masterDetailFieldAttributes.relationFilter.errorMessage Used if a lookup filter is defined. This message will display if the existing data on a Custom Object record no longer matches the defined search filter.
customObjectField.masterDetailFieldAttributes.relationFilter.lookupWindowText Used if a lookup filter is defined. Use this field to define the header content of the Lookup Window. The text in this field will only display when the search filter captures 300 or more options.
customObjectField.masterDetailFieldAttributes.relationFilter.relationFilterJsonString You can create a filter to limit the records available to users in the lookup field. This string is generated in NeonCRM’s user interface.
LOOKUP Fields
customObjectField.lookupFieldAttributes.relatedObjectApiName Retrieve possible values from the List Objects API method. This is the object to which this object should become related.
customObjectField.lookupFieldAttributes.reparentAllow Possible values: TRUE, FALSE. Determines whether or not this child object record can be reassigned to a different parent object record after it has been created. (Example: Donations cannot be assigned to a different account after they have been created.)
customObjectField.lookupFieldAttributes.relationFilter.relationFilterJsonString You can create a filter to limit the records available to users in the lookup field.To do this, use NeonCRM’s lookup filter builder in the system user interface and provide the resulting JSON string here.
customObjectField.lookupFieldAttributes.relationFilter.errorMessage Used if a lookup filter is defined. This message will display if the existing data on a Custom Object record no longer matches the defined search filter.
customObjectField.lookupFieldAttributes.relationFilter.lookupWindowText Used if a lookup filter is defined. Use this field to define the header content of the Lookup Window. The text in this field will only display when the search filter captures 300 or more options.
TEXT Fields
customObjectField.textFieldAttributes.length The maximum length of the field.
customObjectField.textFieldAttributes.defaultValue A default value shows up automatically on the data entry form.
customObjectField.textFieldAttributes.isUnique Possible values: TRUE, FALSE. When this is enabled, the field value must be unique in the entire custom object. A validation error will be thrown if duplicate values are detected.
customObjectField.textFieldAttributes.isRequired Possible values: TRUE, FALSE. Make this field required on the data entry form.
NUMBER Fields
customObjectField.numberFieldAttributes.defaultValue A default value shows up automatically on the data entry form.
customObjectField.numberFieldAttributes.length If your number is an integer, leave Decimal Places to 0. If it’s a decimal, populate the limit for both Integer Part and Decimal Places. Possible values: 0-15.
customObjectField.numberFieldAttributes.decimalLength The number of digits to the right of the decimal point. The combined length of the integer part and decimal places should be less than or equal to 15.
customObjectField.numberFieldAttributes.isUnique Possible values: TRUE, FALSE. When this is enabled, the field value must be unique in the entire custom object. A validation error will be thrown if duplicate values are detected.
customObjectField.numberFieldAttributes.isRequired Possible values: TRUE, FALSE. Make this field required on the data entry form.
customObjectField.numberFieldAttributes.displayFormat Please refer to our guide: Custom Object Number Formats
EMAIL Fields
customObjectField.emailFieldAttributes.defaultValue A default value shows up automatically on the data entry form.
customObjectField.emailFieldAttributes.isRequired Possible values: TRUE, FALSE. Make this field required on the data entry form.
PHONE Fields
customObjectField.phoneFieldAttributes.defaultValue A default value shows up automatically on the data entry form.
customObjectField.phoneFieldAttributes.isRequired Possible values: TRUE, FALSE. Make this field required on the data entry form.
URL Fields
customObjectField.urlFieldAttributes.defaultValue A default value shows up automatically on the data entry form.
customObjectField.urlFieldAttributes.isRequired Possible values: TRUE, FALSE. Make this field required on the data entry form.
PERCENT Fields
customObjectField.percentFieldAttributes.defaultValue A default value shows up automatically on the data entry form.
customObjectField.percentFieldAttributes.isRequired Possible values: TRUE, FALSE. Make this field required on the data entry form.
customObjectField.percentFieldAttributes.length Character limit of the integer part. Possible values: 1-15.
customObjectField.percentFieldAttributes.decimalLength The number of digits to the right of the decimal point. The combined length of the integer part and decimal places should be less than or equal to 15.
TEXTAREA_SHORT Fields
customObjectField.textareaShortFieldAttributes.isRequired Possible values: TRUE, FALSE. Make this field required on the data entry form.
customObjectField.textareaShortFieldAttributes.length Must be less than or equal to 1024.
TEXTAREA Fields
customObjectField.textareaFieldAttributes.defaultValue A default value shows up automatically on the data entry form.
customObjectField.textareaFieldAttributes.isRequired Possible values: TRUE, FALSE. Make this field required on the data entry form.
customObjectField.textareaFieldAttributes.length Must be less than or equal to 131072.
DATE Fields
customObjectField.dateFieldAttributes.defaultValue A default value shows up automatically on the data entry form.
customObjectField.dateFieldAttributes.isRequired Possible values: TRUE, FALSE. Make this field required on the data entry form.
customObjectField.dateFieldAttributes.displayFormat Display format for this date. Example: {MM}/{DD}/{YYYY} results in 05/20/2017.
DATETIME Fields
customObjectField.datetimeFieldAttributes.defaultValue A default value shows up automatically on the data entry form.
customObjectField.datetimeFieldAttributes.isRequired Possible values: TRUE, FALSE. Make this field required on the data entry form.
customObjectField.datetimeFieldAttributes.displayFormat Display format for this date. Example: {MM}/{DD}/{YYYY} {HH}:{mm}:{ss} for 05/20/2017 14:02:20.
CHECKBOX Fields
customObjectField.checkboxFieldAttributes.fieldOptionValues.fieldOptionValue.optionValue The name of the option to be displayed and used internally.
customObjectField.checkboxFieldAttributes.fieldOptionValues.fieldOptionValue.sequence Must be an integer. Determines the order in which the options will display.
customObjectField.checkboxFieldAttributes.fieldOptionValues.fieldOptionValue.isActive Possible values: TRUE, FALSE. Determines whether this value shows up on the data entry form.
customObjectField.checkboxFieldAttributes.fieldOptionValues.fieldOptionValue.isDefault Possible values: TRUE, FALSE. Determines whether this option is checked by default on the data entry form.
DROPDOWN (DROPDOWN) Fields
customObjectField.dropdownFieldAttributes.fieldOptionValues.fieldOptionValue.optionValue The name of the option to be displayed and used internally.
customObjectField.dropdownFieldAttributes.fieldOptionValues.fieldOptionValue.sequence Must be an integer. Determines the order in which the options will display.
customObjectField.dropdownFieldAttributes.fieldOptionValues.fieldOptionValue.isActive Possible values: TRUE, FALSE. Determines whether this value shows up on the data entry form.
customObjectField.dropdownFieldAttributes.fieldOptionValues.fieldOptionValue.isDefault Possible values: TRUE, FALSE. Determines whether this option is checked by default on the data entry form. Only one option may be specified as the default.
RADIO Fields
customObjectField.radioFieldAttributes.fieldOptionValues.fieldOptionValue.optionValue The name of the option to be displayed and used internally.
customObjectField.radioFieldAttributes.fieldOptionValues.fieldOptionValue.sequence Must be an integer. Determines the order in which the options will display.
customObjectField.radioFieldAttributes.fieldOptionValues.fieldOptionValue.isActive Possible values: TRUE, FALSE. Determines whether this value shows up on the data entry form.
customObjectField.radioFieldAttributes.fieldOptionValues.fieldOptionValue.isDefault Possible values: TRUE, FALSE. Determines whether this option is checked by default on the data entry form. Only one option may be specified as the default.

Error Codes

Code Text Description