Edit

Use the Microsoft Search API to search acronyms

  • Article

You can use the Microsoft Search API in Microsoft Graph to search acronyms in your organization. Administrators can create acronyms in the Microsoft 365 admin center or via the Create acronym API.

Caution

The search API schema has changed in the beta version. Some properties in a search request and response have been renamed or removed. For details, see Schema change deprecation warning. The examples in this topic show the up-to-date schema.

After acronyms are created, to search for them, in the searchRequest, in the entityTypes property, specify acronym as the value.

Example 1: Search acronyms

Request

POST https://graph.microsoft.com/beta/search/query
Content-Type: application/json

{
  "requests": [
    {
      "entityTypes": [
        "acronym"
      ],
      "query": {
        "queryString":"what is KQL"
      }
    }
  ]
}

Response

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#search",
  "value": [
  {
   "@odata.type": "#microsoft.graph.searchResponse",
   "hitsContainers": [
    {
     "@odata.type": "#microsoft.graph.searchHitsContainer",
     "hits": [
      {
       "@odata.type": "#microsoft.graph.searchHit",
       "hitId": "a9f59c69-f4a1-42ac-820e-0f35114300f8",
       "rank": 1,
       "resource": {
          "@odata.type": "#microsoft.graph.search.acronym",
          "id": "a9f59c69-f4a1-42ac-820e-0f35114300f8",
          "displayName": "KQL",
          "description": "Kusto Query Language is a powerful tool to explore your data and discover patterns, identify anomalies and outliers, create statistical modeling, and more.",
          "webUrl": "https://docs.microsoft.com/en-us/azure/data-explorer/kusto/query",
          "standsFor": "Kusto Query Language"
        }
       }
      }
     ],
     "total": 1,
     "moreResultsAvailable": false
    }
   ]
  }
 ]
}

Known issues

  • Sorting, aggregation, and pagination are not supported for acronym searches.
  • Combination searches with non-answer entity types (for example, driveItem, list) are not supported.

Next steps