Set Search Capability

Enable or disable search capability of a collection. The collection is created if it does not exist. Search capability is enabled only for one field per collection.

post/_fabric/{fabric}/_api/search/collection/{collection-name}

Request

The document declares no server URL.
Auth
- API key in header Authorization
- or HTTP bearer
TypeScript
https://skmtc.dev/macrometa/apis/macrometa-api-reference/docs/_fabric/:fabric/_api/search/collection/:collection-name/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

fabricstring string required

The name of the fabric.

collection-namestring required

Collection for which to set search capability.

Query parameters

enableboolean required

True enables search. False disables search.

fieldstring

The field for which you want to enable search. Required if enable is set to true.

Response

Successfully set search capablitiy.

codeinteger

HTTP response code.

errorboolean

Flag if there is an error in response. False for this response.

resultboolean

Return true flag if operation is successfully completed.

Example response

{
  "code": 200,
  "result": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.