v1

latestOpenAPI 3.0.02026-07-2638801.8 MB
record

Get record

Retrieve a single record by its ID with options to specify field projections and output format.

get/table/{tableId}/record/{recordId}

Path parameters

tableIdstring required
recordIdstring required

Query parameters

projectionstring[]

If you want to get only some fields, pass in this parameter, otherwise all visible fields will be obtained, The parameter value depends on the specified fieldKeyType to determine whether it is name or id

If you want to get only some fields, pass in this parameter, otherwise all visible fields will be obtained, The parameter value depends on the specified fieldKeyType to determine whether it is name or id

cellFormat'json' | 'text'

Define the return value formate, you can set it to text if you only need simple string value

Define the return value formate, you can set it to text if you only need simple string value

fieldKeyType'id' | 'name' | 'dbFieldName'

Define the key type of record.fields[key], You can click "systemInfo" in the field edit box to get fieldId or enter the table design screen with all the field details

Define the key type of record.fields[key], You can click "systemInfo" in the field edit box to get fieldId or enter the table design screen with all the field details

Response

Success

idstring required

The record id.

namestring

primary field value

fieldsobject required

Objects with a fields key mapping fieldId or field name to value for that field.

autoNumbernumber

Auto number, a unique identifier for each record

createdTimestring

Created time, date ISO string (new Date().toISOString).

lastModifiedTimestring

Last modified time, date ISO string (new Date().toISOString).

createdBystring

Created by, user name

lastModifiedBystring

Last modified by, user name

permissionsobject

Permissions for the record

undeletableboolean

Whether the record is undeletable