Query Control

The QueryController interface allows developers to search specific content.

Overview

QueryController is a Web Content API that provides a way for developers to get information or execute requests regarding specific content.

Methods and Response Formats

Table 1. QueryController Interface
Method and response format Remarks
GET ​/{accessType}​/query-by-text Fetches list of content by text from the HCL Portal server.
GET /{accessType}/webcontent/query-by-attribute Fetches list of content by attribute from the HCL Portal server.

Parameters

The request must be a standard HTTP GET, POST, PUT or DELETE command.

Table 2. Additional Parameters
Name Description
Cookie Access token for authentication fetched from Cookie.
virtualportal Virtual portal to which the request needs to be sent to.
authoringTemplate Searches under authoring template name.
accessType Base URL to invoke different contenthandler

Response Codes

Table 3. Response Codes
Code Description
200 OK.
400 Bad request
401 Unauthorized request
404 Request not found
422 Unprocessable entity (WebDAV)
500 Internal server error