admin

Read Global Field Definitions

Global field definitions of one entity type for management, sorted by group, order and field_id. Superadmin only.

GET

/api/admin/field-definitions

curl --request GET \
  --url '/api/admin/field-definitions?entity_type=machine&include_archived=false' \
  --header 'Authorization: Bearer <token>'

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

Archived definitions are listed only with include_archived=true. Unlike the company read, this never answers 404 for a disabled flag, because the flag belongs to a company.

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

entity_typeenum<string>queryrequired

Available options: machine, routine

include_archivedbooleanquerydefault:false

Response

Successful Response

itemsobject[]

Show child attributes