IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Query suggestion API Search API »
Elastic Docs › ›API Reference

Schema API

edit

Schema API

edit

Want to start with the core concepts? Give our Indexing Documents guide a read.

Alter the schema fields of your Engine.

Before you begin, familiarize yourself with the schema design principles within the API Overview.

Authentication

edit

For authentication, the Schema endpoint requires...

  1. The name of your Engine: [ENGINE]
  2. A Private API Key: [PRIVATE_API_KEY] 
curl -X GET '<ENTERPRISE_SEARCH_BASE_URL>/api/as/v1/engines/[ENGINE]/schema' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer [PRIVATE_API_KEY]'

List Schema

edit
GET <ENTERPRISE_SEARCH_BASE_URL>/api/as/v1/engines/{ENGINE_NAME}/schema

Example - A GET request to return the whole schema.

curl -X GET '<ENTERPRISE_SEARCH_BASE_URL>/api/as/v1/engines/national-parks-demo/schema' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer private-xxxxxxxxxxxxxxxxxxxx'

Example Response

{
  "description": "text",
  "nps_link": "text",
  "states": "text",
  "title": "text",
  "visitors": "number",
  "world_heritage_site": "text",
  "location": "geolocation",
  "acres": "number",
  "date_established": "date",
  "square_km": "number"
}

Update Schema

edit

When updating a Schema, you can either...

Updates an Existing Schema

edit
POST <ENTERPRISE_SEARCH_BASE_URL>/api/as/v1/engines/{ENGINE_NAME}/schema

Example - A POST request that changes the square_km field from number to text.

curl -X POST '<ENTERPRISE_SEARCH_BASE_URL>/api/as/v1/engines/national-parks-demo/schema' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer private-xxxxxxxxxxxxxxxx' \
-d '{
  "square_km": "text"
}'

Example Response

{
  "description": "text",
  "nps_link": "text",
  "states": "text",
  "title": "text",
  "visitors": "number",
  "world_heritage_site": "text",
  "location": "geolocation",
  "acres": "number",
  "date_established": "date",
  "square_km": "text"
}

Creates a new Schema Field

edit

You may have up to 64 fields.

Fields cannot be named: engine_id, highlight, or, and, not, any, all, none.

Example - A POST request to add a new number field, square_mi.

curl -X POST '<ENTERPRISE_SEARCH_BASE_URL>/api/as/v1/engines/national-parks-demo/schema' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer private-xxxxxxxxxxxxxxxx' \
-d '{
  "square_mi": "number"
}
'

Example Response

{
  "description": "text",
  "nps_link": "text",
  "states": "text",
  "title": "text",
  "visitors": "number",
  "world_heritage_site": "text",
  "location": "geolocation",
  "acres": "number",
  "date_established": "date",
  "square_km": "number",
  "square_mi": "number"
}

Errors

edit

If one field fails validation then the entire set will fail.

Name indicates the name of the field. Type indicates the type of the field.

400 Error Message

Solution

"Type is not included in the list"

The allowed types are: text, number, date, geolocation". Ensure that no spaces are included and only one of the four types is present. Watch out for integer, which will not work - expects number.

"Name cannot contain whitespace"

Can not contain any whitespace characters like 'my field'

"Name cannot have a leading underscore"

Can not start with a leading underscore like '_myfield'.

"Name cannot contain more than 64 characters"

Very long field names are not allowed.

"Name cannot be a reserved field (engine_id, highlight, or, and, not, any, all, none)"

These field names are reserved for your safety :). For example, trying to define an 'all' filter for a field called 'all' would be very difficult to understand. The following fields are reserved: _boost, _explanation, _id, _index, _score, _type, _version, all, and, any, engine_id, external_id, highlight, none, not, or

"Name can only contain lowercase letters, numbers, and underscores"

No dashes, capitals, strange characters or other such silliness!

"Name must contain a lowercase letter"

You can not have a field with only capital letters.

"Name must be unique"

Each field name must be unique.

What’s Next?

edit

The Schema endpoint is how you adjust your foundational data model. Now that you know how to make Schema changes via the API, you may be interested in exploring deeper into Indexing Documents. Alternatively, you may be into some of the deeper analytics presented by Curations and Clickthrough.

« Query suggestion API Search API »