Jump to

• Request
• Response
• Examples

Get Searchable Metadata Fields

get

/documents/api/1.2/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

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

The request was fulfilled.

Body ()

Root Schema : GetSearchableMetadataResponse

Type: object

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

Show Source

• errorCode(optional): number
  An error code of zero (0) indicates no errors.
• fields(optional): string
  Comma-separated list of searchable metadata fields prefixed with their respective collection name.
• number(optional): number
  Number of searchable metadata fields retrieved.
• type(optional): string
  Item type metadata.

{
    "description":"The response body includes information about all metadata fields available for search purposes.",
    "properties":{
        "errorCode":{
            "type":"number",
            "description":"An error code of zero (0) indicates no errors."
        },
        "number":{
            "type":"number",
            "description":"Number of searchable metadata fields retrieved."
        },
        "fields":{
            "type":"string",
            "description":"Comma-separated list of searchable metadata fields prefixed with their respective collection name."
        },
        "type":{
            "type":"string",
            "description":"Item type <code>metadata</code>."
        }
    }
}

Example Response (application/json)

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

Back to Top

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"
}

Back to Top