Edit

Share via

qna resource type

  • Article

Namespace: microsoft.graph.search

Represents a question and answer (Q&A) in Microsoft Search. Q&As are administrative answer results in the search results page that 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 that allow administrators to make common resources more accessible in their organization.

Inherits from searchAnswer.

Methods

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

Properties

Property Type Description
availabilityEndDateTime DateTimeOffset Date and time when the QnA stops appearing as a search result. Set as null for always available. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
availabilityStartDateTime DateTimeOffset Date and time when the QnA starts to appear as a search result. Set as null for always available. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
description String Answer that is displayed in search results. Inherited from searchAnswer.
displayName String Question that is displayed in search results. Inherited from searchAnswer.
groupIds String collection The list of security groups that are able to view this QnA.
id String The unique identifier (GUID) for the QnA. Inherited from searchAnswer.
isSuggested Boolean True if a user or Microsoft suggested this QnA to the admin. Read-only.
keywords microsoft.graph.search.answerKeyword Keywords that trigger this QnA to appear in search results.
languageTags String collection A list of geographically specific language names in which this QnA can be viewed. Each language tag value follows the pattern {language}-{region}. For example, en-us is English as used in the United States. For the list of possible values, see Supported language tags.
lastModifiedBy microsoft.graph.identitySet Details of the user who created or last modified the QnA. Inherited from searchAnswer. Read-only.
lastModifiedDateTime DateTimeOffset Date and time when the QnA was created or last edited. Inherited from searchAnswer. Read-only.
platforms microsoft.graph.devicePlatformType collection List of devices and operating systems that are able to view this QnA. Possible values are: android, androidForWork, ios, macOS, windowsPhone81, windowsPhone81AndLater, windows10AndLater, androidWorkProfile, unknown, androidASOP, androidMobileApplicationManagement, iOSMobileApplicationManagement, unknownFutureValue.
state microsoft.graph.search.answerState State of the QnA. Possible values are: published, draft, excluded, unknownFutureValue.
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 apply to all variations.
webUrl String The URL link for the QnA. When users select this QnA from the search results, they're directed to the specified URL. Inherited from searchAnswer.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

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