Jump to

• Request
• Response
• Examples

Set Searchable Metadata Fields

post

/documents/api/1.2/metadata/searchFields

Turn search on for a list of metadata fields. Only metadata fields from the same global collection can be processed in the same request.

Currently, there is a limit of 200 searchable metadata fields, and after that point no extra fields can be indexed. These metadata fields and metadata collections will be removed from the search index if an administrator deletes them. This action will lower the number of indexed metadata fields allowing users to index new ones.

You must log in as an administrator. Searchable metadata fields can be used by all tenant users.

Request

Supported Media Types

• application/json
• application/xml

Body ()

The request body defines the details of setting searchable metadata fields.

Root Schema : SetSearchableMetadataRequestBody

Type: object

Description of fields available to set searchable metadata fields.

Show Source

• collection: string
  Metadata collection name.
• fields: string
  Comma-separated list of metadata fields to be set as searchable.

{
    "description":"Description of fields available to set searchable metadata fields.",
    "properties":{
        "collection":{
            "type":"string",
            "description":"Metadata collection name."
        },
        "fields":{
            "type":"string",
            "description":"Comma-separated list of metadata fields to be set as searchable."
        }
    },
    "required":[
        "collection",
        "fields"
    ]
}

Example Request (application/json)

{
    "collection":"SearchableCollection",
    "fields":"searchField1,searchField2,searchField3"
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

The request was fulfilled.

Body ()

Root Schema : SetSearchableMetadataResponse

Type: object

The response body confirms if the request was successful.

Show Source

• errorCode(optional): number
  An error code of zero (0) indicates no errors.

{
    "description":"The response body confirms if the request was successful.",
    "properties":{
        "errorCode":{
            "type":"number",
            "description":"An error code of zero (0) indicates no errors."
        }
    }
}

400 Response

Request parameters are not formatted correctly.

403 Response

Exceeded number of allowed searchable metadata fields.

404 Response

Collection or field does not exist.

Back to Top

Examples

The following example makes a few metadata fields available for search purposes.

POST .../metadata/searchFields

Request Header

None.

Request Body

{
  "collection":"SearchableCollection",
  "fields":"searchField1,searchField2,searchField3"
}

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "errorCode": "0"
}

Back to Top