GET /fields/{field_id}/metadata
Retrieve metadata about a field. This allows you to review information about a field, such as name, description, read only status, whether it has been trained and the file_ids it has been trained on.
Headers
Authorization (required) - Requires the standard authentication header used in the system.
Parameters
-
field_id Path Required
the field identifier for the metadata to be reviewed.
-
200 OKRequest was successful.
-
400 Bad RequestThe field_id is invalid.
-
403 ForbiddenInvalid or missing authentication token.
-
404 Not FoundThe field_id does not exist or has been cleaned up.
-
500 Internal Server ErrorSomething went wrong unrelated to the users request.
Response Data
-
field_id
the field identifier.
-
name
the name of the field.
-
description
the description given to this field.
-
read_only
whether or not this field is read only.
-
is_trained
whether or not this field has been trained.
-
file_ids
an array of file_ids this field has been trained on.
{
"field_id": "ffceg474-f28d-4633-9425-f95f6dea2805",
"name": "Custom Field",
"description": "This field was created as part of a API call",
"read_only": false,
"is_trained": false,
"file_ids": []
}
Need Help?
Couldn’t find the information you were looking for or need more assistance?
Contact Support