records

Read Field Definitions

Field definitions of one entity type: the company's own and the global ones, archived ones left out, sorted by order within each group. key names the column for column-backed fields and the field id for map-backed ones.

GET

/api/records/{company_name}/field-definitions

curl --request GET \
  --url '/api/records/{company_name}/field-definitions?entity_type=machine' \
  --header 'Authorization: Bearer <token>'

[
  {
    "archived": true,
    "editable_by": "superadmin",
    "entity_type": "machine",
    "field_id": "<string>",
    "filterable": true,
    "group": "<string>",
    "id": "5eb7cf5a86d9755df3a6c593",
    "key": "<string>",
    "last_updated": "2023-11-07T05:31:56Z",
    "order": 123,
    "owner_name": "<string>",
    "regex": "<string>",
    "required": true,
    "searchable": true,
    "storage": "column",
    "type": "text"
  }
]

filterable and searchable are declared only and have no behavior yet. Archived definitions are left out here and refuse values on machine writes (HTTP 422, type field_archived); required and regex are enforced for map-backed values on machine create and update (types field_required and field_regex) and describe column-backed fields without being enforced here.

Show child attributes

Read Field Definitions

Authorizations

Path Parameters

Query Parameters

Response