Get All Custom Forms for Record

Returns an array of custom forms associated with the specified record. Each custom form consists of custom field name-and-value pairs.

Resource Information

Scoperecords

Deprecated scope name:   get_record_customforms

App TypeAll
Authorization TypeNo authorization required
URI /v4/records/{recordId}/customForms?lang={lang}
HTTP MethodGET
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
fieldsstringNo Comma-delimited names of fields to be returned in the response. Note: Field names are case-sensitive and only first-level fields are supported. Invalid field names are ignored.7.3.2
langStringNo Indicates the language applied.7.3.2
recordIdstringYes Get All Records Search Records Get My Records The unique ID associated with a record.7.3.2

Example

Sample Request Head

GET https://apis.accela.com/v4/records/12CAP-00000-00003/customForms

Notes

The following sample request uses the ISLANDTON agency in the TEST environment on the Accela Developer Sandbox. Click the "Send to Hurl.It" link below to submit the sample request. Replace YOUR-ACCESS-TOKEN before submitting the request.

curl
   -H 'Content-type: application/json'
   -H 'Accept: application/json'
   -H 'Authorization: YOUR-ACCESS-TOKEN'
   -X GET https://apis.accela.com/v4/records/12CAP-00000-00003/customForms

Response Information

FieldTypeDescriptionAutomation Version
result[]result{} 7.3.2
result.<customType>stringA custom field name and value pair. For example in JSON, "My Custom Field": "My Custom Value". The custom field name and its data type are defined in Automation custom forms or custom tables. For a Text field, the maximum length is 256. For a Number field, any numeric form is allowed, including negative numbers. For a Date field, the format is MM/dd/yyyy. For a Time field, the format is hh:mm. For a TextArea field, the maximum length is 4000 characters, and allows line return characters. For a DropdownList field, the dropdown list values are in the options[] array. For a CheckBox field, the (case-sensitive) valid values are "UNCHECKED" and "CHECKED". For a Radio(Y/N) field, the(case-sensitive) valid values are "Yes" and "No". 7.3.2
statusintegerThe record status.7.3.3

Example

Sample Response Body

{
  "status": 200,
  "result": [
    {
      "id": "BLD_COMM-SITE",
      "Flood Zone": "NAVD A - No Base Flood Elev. Determined",
      "Base Flood Elevation": null,
      "Disturbed Acreage": null,
      "Not in Flood Zone": "CHECKED",
      "Total Acreage": "789"
    },
    {
      "Type of Construction": "I Non-Combustible",
      "Proposed Use": "1 & 2 Family Residence",
      "Irrigation Meter Size": null,
      "Number of Stories": "123",
      "Water Meter Size": null,
      "Existing Use": "1 & 2 Family Residence",
      "Occupancy Classification": "R-1 Hotel/Motel/Boarding House/Transient",
      "Occupant Load": "99",
      "Fire Sprinkler": null,
      "Fire Sprinkler Type": "FM200",
      "id": "BLD_COMM-GENERAL",
      "Building Height": "465",
      "Park District": null,
      "Ground Floor Area": "132",
      "Backflow Device": null,
      "Total Floor Area": "456"
    },
    {
      "id": "BLD_COMM-ZONING",
      "Planning Case Required": "Yes",
      "Parking Spaces Required": null,
      "Parking Spaces Provided": null,
      "Zoning 1": "001",
      "Land Use 1": null,
      "Zoning 2": "002",
      "Land Use 2": null,
      "Zoning 3": null,
      "Required Planning Case Type": "use7",
      "Land Use 3": "use3"
    }
  ]
}