qna resource type

Namespace: microsoft.graph.search

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Q&As are administrative answer results in the search results page which provide answers for specific search keywords. Q&As allow administrators to answer the user's questions directly in search instead of providing a link to a webpage. A Q&A has many properties which allow administrators to make common resources more accessible in their organization.

Inherits from searchAnswer.

Methods

Method Return type Description
List qnas microsoft.graph.search.qna collection Get a list of the qna objects and their properties.
Create qna microsoft.graph.search.qna Create a new qna object.
Get qna microsoft.graph.search.qna Read the properties and relationships of a qna object.
Update qna microsoft.graph.search.qna Update the properties of a qna object.
Delete qna None Deletes a qna object.

Properties

Property Type Description
id String The unique identifier (GUID) for the qna. Inherited from entity.
displayName String Question displayed in search results. Inherited from searchAnswer.
description String Answer displayed in search results. Inherited from searchAnswer.
webUrl String Qna URL link. When users click this qna in search results, they will go to this URL. Inherited from searchAnswer.
lastModifiedBy microsoft.graph.identitySet Details of the user that created or last modified the qna. Inherited from searchAnswer. Read-only.
lastModifiedDateTime DateTimeOffset Timestamp of when the qna is created or edited. Inherited from searchAnswer. Read-only.
availabilityStartDateTime DateTimeOffset Timestamp of when the qna will start to appear as a search result. Set as null for always available.
availabilityEndDateTime DateTimeOffset Timestamp of when the qna will stop to appear as a search result. Set as null for always available.
languageTags String collection A list of language names that are geographically specific and that this QnA can be viewed in. Each language tag value follows the pattern {language}-{region}. As an example, en-us is English as used in the United States. See supported language tags for the list of possible values.
platforms microsoft.graph.devicePlatformType collection List of devices and operating systems able to view this qna. Possible values are: unknown, android, androidForWork, ios, macOS, windowsPhone81, windowsPhone81AndLater, windows10AndLater, androidWorkProfile, androidASOP.
targetedVariations microsoft.graph.search.answerVariant collection Variations of a qna for different countries or devices. Use when you need to show different content to users based on their device, country/region, or both. The date and group settings will apply to all variations.
keywords microsoft.graph.search.answerKeyword Keywords that trigger this qna to appear in search results.
state microsoft.graph.search.answerState State of the qna. Possible values are: published, draft, excluded, or unknownFutureValue.
isSuggested Boolean True if this qna was suggested to the admin by a user or was mined and suggested by Microsoft. Read-only.
groupIds String collection List of security groups able to view this qna.

Relationships

None.

JSON representation

The following is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.search.qna",
  "id": "String (identifier)",
  "displayName": "String",
  "description": "String",
  "webUrl": "String",
  "lastModifiedBy": {
    "@odata.type": "microsoft.graph.identitySet"
  },
  "lastModifiedDateTime": "String (timestamp)",
  "availabilityStartDateTime": "String (timestamp)",
  "availabilityEndDateTime": "String (timestamp)",
  "languageTags": [
    "String"
  ],
  "platforms": [
    "String"
  ],
  "targetedVariations": [
    {
      "@odata.type": "microsoft.graph.search.answerVariant"
    }
  ],
  "keywords": {
    "@odata.type": "microsoft.graph.search.answerKeyword"
  },
  "state": "String",
  "isSuggested": "Boolean",
  "groupIds": [
    "String"
  ]
}