Get Record Custom Table

Gets the specified custom table for the specified record.

Resource Information

Scoperecords

Deprecated scope name:   get_record_customtable

App TypeAll
Authorization TypeNo authorization required
URI /v4/records/{recordId}/customTables/{tableId}?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
tableIdstringYes The name of a custom table that contains data for a record or checklist item. 7.3.2

Response Information

FieldTypeDescriptionAutomation Version
result[]result{} 7.3.2
result.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.rows[]result.rows{}Contains the table rows.7.3.2
result.rows.actionstringAudit trail action type like 'payment allocation'7.3.2
result.rows.fieldsresult.rows.fields{}Contains fields and their attributes.7.3.2
result.rows.fields.<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
result.rows.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
statusintegerThe record status.7.3.3