Query

Defines a search query.

APIs.ioEngineeringPlatform

Properties

Name Type Description
displayText string The display version of the query term. This version of the query term may contain special characters that highlight the search term found in the query string. The string contains the highlighting char
searchLink string The URL that you use to get the results of the related search. Before using the URL, you must append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header. Use this URL if y
text string The query string. Use this string as the query term in a new search request.
thumbnail object
webSearchUrl string The URL that takes the user to the Bing search results page for the query.Only related search results include this field.
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-query-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Query",
  "title": "Query",
  "required": [
    "text"
  ],
  "type": "object",
  "properties": {
    "displayText": {
      "type": "string",
      "description": "The display version of the query term. This version of the query term may contain special characters that highlight the search term found in the query string. The string contains the highlighting characters only if the query enabled hit highlighting",
      "readOnly": true
    },
    "searchLink": {
      "type": "string",
      "description": "The URL that you use to get the results of the related search. Before using the URL, you must append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header. Use this URL if you're displaying the results in your own user interface. Otherwise, use the webSearchUrl URL.",
      "readOnly": true
    },
    "text": {
      "type": "string",
      "description": "The query string. Use this string as the query term in a new search request."
    },
    "thumbnail": {
      "$ref": "#/components/schemas/ImageObject"
    },
    "webSearchUrl": {
      "type": "string",
      "description": "The URL that takes the user to the Bing search results page for the query.Only related search results include this field.",
      "readOnly": true
    }
  },
  "description": "Defines a search query."
}