Skip to content

Latest commit

 

History

History
70 lines (49 loc) · 1.52 KB

create_update.md

File metadata and controls

70 lines (49 loc) · 1.52 KB
Raw

Creating or updating one field

Use this API to create a new field -- or update an existing field.

Requirement: OpenSearchServer v1.5

Call parameters

URL: /services/rest/index/{index_name}/field/{field_name}

Method: PUT

Header:

  • Content-Type (required): application/json
  • Accept (optional returned type): application/json
  • Accept (optional returned type): application/xml

URL parameters:

  • index_name (required): The name of the index.
  • field_name (required): The name of the field.

Raw data (PUT):

{
  "name": "autocomplete",
  "analyzer": "AutoCompletionAnalyzer",
  "indexed": "YES",
  "stored": "NO",
  "termVector": "NO",
  "copyOf": [
    "content",
    "title"
  ]
}
  • name: The name of the field.
  • analyzer: The name of the analyzer.
  • indexed: YES or NO.
  • stored: YES, NO or COMPRESS.
  • termVector: YES, NO or POSITIONS_OFFSETS.
  • copyOf: An array of fields.

Success response

The field has been created or updated.

HTTP code: 200

Content (application/json):

{
    "successful": true,
    "info": "Added Field autocomplete"
}

Error response

The creation/update failed. The reason is provided in the content.

HTTP code: 500

Sample call

Using CURL:

curl -XPUT -H "Content-Type: application/json" \
    -d '{"name":"my_field","analyzer":"TextAnalyzer", "indexed":"YES"}' \
    http://localhost:8080/services/rest/index/my_index/field/autocomplete