Get All Custom Forms for Record Type

Gets the predefined custom forms for a specified record type.

Resource Information

Scope	records Deprecated scope name: get_settings_record_type_customform
App Type	All
Authorization Type	No authorization required
URI	/v4/settings/records/types/{id}/customForms?lang={lang}
HTTP Method	GET
Automation Version(s)	7.3.2

Request Information

Field or Parameter	Type	Required	Values	Description	Automation Version
fields	string	No	�	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
id	string	Yes	�	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
lang	String	No	�	Indicates the language applied.	7.3.2

Response Information

Field	Type	Description	Automation Version
result[]	result{}	�	7.3.2
result.displayOrder	long	The order of the item in comparison to the other items.	7.3.2
result.fields[]	result.fields{}	Contains fields and their attributes.	7.3.2
result.fields.displayOrder	long	The order of the item in comparison to the other items.	7.3.2
result.fields.drillDown	result.fields.drillDown{}	The drilldown information containing children records.	7.3.2
result.fields.drillDown.children[]	result.fields.drillDown.children{}	The drilldown records for application-specific information (ASI) tables	7.3.2
result.fields.drillDown.children.drillId	long	A number identifying a drilldown child record.	7.3.2
result.fields.drillDown.children.id	string	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
result.fields.drillDown.isRoot	boolean	Indicates whether or not the drilldown information is at the root.	7.3.2
result.fields.fieldType	string	The type of field.	7.3.2
result.fields.id	string	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
result.fields.isReadonly	string	Indicates whether or not the information is read-only.	7.3.2
result.fields.isRequired	string	Indicates whether or not the information is required.	7.3.2
result.fields.maxLength	long	Indicates the maximum number of characters for a custom field or the maximum number of fields in a custom drop-down list.	7.3.2
result.fields.options[]	result.fields.options{}	Contains the fields that define additional data options.	7.3.2
result.fields.options.text	string	The localized display text.	7.3.2
result.fields.options.value	string	The value for the specified parameter.	7.3.2
result.fields.text	string	The localized display text.	7.3.2
result.fields.value	string	The value for the specified parameter.	7.3.2
result.id	string	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
result.text	string	The localized display text.	7.3.2
status	integer	The record status.	7.3.3

Example

Sample Response Body

{
  "status": 200,
  "result": [
    {
      "id": "SR_STANDARD-COMPLAINT.cINFORMATION",
      "text": "COMPLAINT INFORMATION",
      "fields": [
        {
          "id": "Source of Complaint",
          "text": "Source of Complaint",
          "value": "Citizen",
          "readonly": "N",
          "fieldType": "DropdownList",
          "maxLength": 0,
          "isRequired": "N",
          "options": [
            {
              "value": "Citizen",
              "text": "Citizen"
            },
            {
              "value": "Staff",
              "text": "Staff"
            },
            {
              "value": "Government Official",
              "text": "Government Official"
            },
            {
              "value": "Law Enforcement Officer",
              "text": "Law Enforcement Officer"
            },
            {
              "value": "Unknown",
              "text": "Unknown"
            }
          ]
        },
        {
          "id": "Type of Submittal",
          "text": "Type of Submittal",
          "value": "Online Service Request",
          "readonly": "N",
          "fieldType": "DropdownList",
          "maxLength": 0,
          "isRequired": "N",
          "options": [
            {
              "value": "Online",
              "text": "Online"
            },
            {
              "value": "E-Mail",
              "text": "E-Mail"
            },
            {
              "value": "FAX",
              "text": "FAX"
            },
            {
              "value": "In Person",
              "text": "In Person"
            },
            {
              "value": "Phone",
              "text": "Phone"
            },
            {
              "value": "Postal Mail",
              "text": "Postal Mail"
            },
            {
              "value": "Unknown",
              "text": "Unknown"
            }
          ]
        },
        {
          "id": "Location",
          "text": "Location",
          "readonly": "N",
          "fieldType": "TextArea",
          "maxLength": 0,
          "isRequired": "N"
        },
        {
          "id": "Notify Complainant",
          "text": "Notify Complainant",
          "readonly": "N",
          "fieldType": "Radio(Y/N)",
          "maxLength": 0,
          "isRequired": "N"
        }
      ]
    }
  ]
}