bookmark 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.

A bookmark is an administrative answer in Microsoft Search results for common search queries in an organization. A bookmark has many properties which allow administrators to make common resources more accessible in their organization.

Inherits from searchAnswer.

Methods

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

Properties

Property	Type	Description
id	String	The unique identifier (GUID) for the bookmark. Inherited from entity.
displayName	String	Bookmark name displayed in search results. Inherited from searchAnswer.
description	String	Bookmark description shown on search results page. Inherited from searchAnswer.
webUrl	String	Bookmark URL link. When users click this bookmark 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 bookmark. Inherited from searchAnswer. Read-only.
lastModifiedDateTime	DateTimeOffset	Timestamp of when the bookmark is created or edited. Inherited from searchAnswer. Read-only.
categories	String collection	Categories commonly used to describe this bookmark. For example, IT and HR.
availabilityStartDateTime	DateTimeOffset	Timestamp of when the bookmark will start to appear as a search result. Set as null for always available.
availabilityEndDateTime	DateTimeOffset	Timestamp of when the bookmark 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 bookmark 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 bookmark. Possible values are: unknown, android, androidForWork, ios, macOS, windowsPhone81, windowsPhone81AndLater, windows10AndLater, androidWorkProfile, androidASOP.
targetedVariations	microsoft.graph.search.answerVariant collection	Variations of a bookmark 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.
powerAppIds	String collection	List of Power Apps associated with this bookmark. If users add existing Power Apps to a bookmark, they can complete tasks, such as to enter vacation time or to report expenses on the search results page.
keywords	microsoft.graph.search.answerKeyword	Keywords that trigger this bookmark to appear in search results.
state	microsoft.graph.search.answerState	State of the bookmark. Possible values are: published, draft, excluded, or unknownFutureValue.
isSuggested	Boolean	True if this bookmark 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 bookmark.

Relationships

None.

JSON representation

The following is a JSON representation of the resource.

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