records

Archive Company Field Definition

Archive one definition of this company and return it. Superadmin only.

DELETE

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

curl --request DELETE \
  --url '/api/records/{company_name}/field-definitions/{field_id}?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>",
  "label": {},
  "last_updated": "2023-11-07T05:31:56Z",
  "order": 123,
  "owner_name": "<string>",
  "regex": "<string>",
  "required": true,
  "searchable": true,
  "storage": "column",
  "type": "text"
}

Machine values stay stored and machine reads still return them; the company read leaves the archived definition out and machine writes refuse new values for it. Archiving an archived definition returns it unchanged. An unknown company, or an unknown or malformed field_id, answers 404. Bring it back with the create request and restore: true (see the create route) or with an update body carrying archived: false.

Authorizations

Authorizationstringheaderrequired

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

Path Parameters

company_namestringrequired

field_idstringrequired

Query Parameters

entity_typeenum<string>queryrequired

Available options: machine, routine

Response

Successful Response

Show child attributes