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.

Code Sample
curl -X GET -H "Accept: application/json"  
-H "Authorization: Bearer <token>"
-H "Content-Type: application/json"
-d "{}" https://<base_url>/api/v2/fields/<field_id>/metadata
metadata, _ = zdai.fields.get_metadata(field_id=’fieldID’)
Response Codes
  • 200 OK
    Request was successful.
  • 400 Bad Request
    The field_id is invalid.
  • 403 Forbidden
    Invalid or missing authentication token.
  • 404 Not Found
    The field_id does not exist or has been cleaned up.
  • 500 Internal Server Error
    Something 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.

Response
{
    "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 us at support@zuva.ai