Gets the specified custom table for the specified record.
Scope | records Deprecated scope name: get_record_customtable |
App Type | All |
Authorization Type | No authorization required |
URI | /v4/records/{recordId}/customTables/{tableId}?lang={lang} |
HTTP Method | GET |
Automation Version(s) | 7.3.2 |
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 |
lang | String | No | � | Indicates the language applied. | 7.3.2 |
recordId | string | Yes | Get All Records Search Records Get My Records | The unique ID associated with a record. | 7.3.2 |
tableId | string | Yes | � | The name of a custom table that contains data for a record or checklist item. | 7.3.2 |
Field | Type | Description | Automation Version |
---|---|---|---|
result[] | result{} | � | 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.rows[] | result.rows{} | Contains the table rows. | 7.3.2 |
result.rows.action | string | Audit trail action type like 'payment allocation' | 7.3.2 |
result.rows.fields | result.rows.fields{} | Contains fields and their attributes. | 7.3.2 |
result.rows.fields.<customType> | string | A 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.id | string | The unique identifier for the object, assigned by the Civic Platform server and provided in a response. | 7.3.2 |
status | integer | The record status. | 7.3.3 |