Get All Custom Forms Metadata for Contact

Gets the metadata associated with all custom forms for the contact.

Resource Information

Scopecontacts

Deprecated scope name:   get_contacts_customforms_meta

App TypeAgency
Authorization TypeAccess token
URI /v4/contacts/{id}/customForms/meta?fields={fields}&lang={lang}
HTTP MethodGET
Automation Version(s)7.3.3.4

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.3.4
idstringYes�The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3.4
langStringNo�Indicates the language applied.7.3.3.4

Response Information

FieldTypeDescriptionAutomation Version
result[]result{}�7.3.3.4
result.displayOrderlongThe order of the item in comparison to the other items.7.3.3.4
result.fields[]result.fields{}Contains fields and their attributes.7.3.3.4
result.fields.displayOrderlongThe order of the item in comparison to the other items.7.3.3.4
result.fields.drillDownresult.fields.drillDown{}The drilldown information containing children records.7.3.3.4
result.fields.drillDown.children[]result.fields.drillDown.children{}The drilldown records for application-specific information (ASI) tables7.3.3.4
result.fields.drillDown.children.drillIdlongA number identifying a drilldown child record.7.3.3.4
result.fields.drillDown.children.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3.4
result.fields.drillDown.isRootbooleanIndicates whether or not the drilldown information is at the root. 7.3.3.4
result.fields.fieldTypestringThe type of field.7.3.3.4
result.fields.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3.4
result.fields.isReadonlystringIndicates whether or not the information is read-only. 7.3.3.4
result.fields.isRequiredstringIndicates whether or not the information is required. 7.3.3.4
result.fields.maxLengthlongIndicates the maximum number of characters for a custom field or the maximum number of fields in a custom drop-down list.7.3.3.4
result.fields.options[]result.fields.options{}Contains the fields that define additional data options.7.3.3.4
result.fields.options.textstringThe localized display text.7.3.3.4
result.fields.options.valuestringThe value for the specified parameter.7.3.3.4
result.fields.textstringThe localized display text.7.3.3.4
result.fields.valuestringThe value for the specified parameter.7.3.3.4
result.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3.4
result.textstringThe localized display text.7.3.3.4
statusintegerThe record status.7.3.3.4