Archive a field definition
DELETE /fields/{id}
Retires a field definition without deleting anything. Requires the
fields.admin or system.admin capability, granted globally. The
definition, its code, and the values and history already stored for
it are all kept.
An archived field is left out of GET /fields unless you ask for
status=archived. The server also tries to re-index assets so the
field’s values stop counting in full-text search; if that fails, the
response is still 204 and the old searchable text can remain. GET /fields/{id} still returns it. Its code stays taken, so to bring
the field back, set its status to active with PATCH /fields/{id} instead of creating a new field with the same code.
Archiving doesn’t stop metadata extraction. If the field has an
extraction source, extraction can still fill it until you clear the
source with PUT /fields/{id}/extraction. Extraction reads its
settings just before it writes a file’s values, so clearing the
source also reaches a job that is already running but hasn’t read
them yet; a job that has already read them can still fill the field.
Archiving a field that is already archived changes nothing and still returns 204.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The field definition’s id.
Responses
Section titled “ Responses ”The field is archived. Also returned when it already was.
Authentication required, missing, or invalid
object
Human-readable error summary
Example
the request could not be completedExample
{ "error": "authentication required: sign in and retry with a valid session or API token"}Authenticated but missing required capabilities
object
Human-readable error summary
Example
the request could not be completedResource not found
object
Human-readable error summary
Example
the request could not be completed