Get Searchable Metadata Fields

get

/documents/api/1.1/metadata/searchFields

Retrieve all metadata fields currently available for searching content. The result list includes all metadata fields prefixed with their respective global metadata collection for that tenant.

• Request
• Response
• Examples

Request

There are no request parameters for this operation.

Response

Supported Media Types

• application/json
• application/xml

200 Response

The request was fulfilled.

Body

The response body includes information about all metadata fields available for search purposes.

Root Schema : GetSearchableMetadataResponse

The response body includes information about all metadata fields available for search purposes.

Properties

errorCode

Type: number

An error code of zero (0) indicates no errors.

fields

Type: string

Comma-separated list of searchable metadata fields prefixed with their respective collection name.

number

Type: number

Number of searchable metadata fields retrieved.

type

Type: string

Item type metadata.

Example application/json

{
    "type":"metadata",
    "errorCode":"0",
    "number":"3",
    "fields":"SearchableCollection.searchField1,SearchableCollection.searchField2,SearchableCollection.searchField3"
}

Examples

The following example retrieves all searchable metadata fields available in this given tenant.

GET .../metadata/searchFields

Request Header

None.

Request Body

None.

HTTP Status Code

HTTP_STATUS = 200

JSON Response

{
    "errorCode": "0",
    "fields": "SearchableCollection.searchField1,SearchableCollection.searchField2,SearchableCollection.searchField3",
    "number": "3",
    "type": "metadata"
}