externalItem resource type

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported.

An item indexed via a Microsoft Search connection.

Important

Microsoft Graph connectors and Microsoft Search APIs (query and index) are currently in preview status. To use connectors with Microsoft Search or to build connectors, you must sign up for the connectors preview program. To join the preview program, submit the Microsoft Graph connectors preview sign-up form.

Methods

Method Return Type Description
Create externalItem externalItem Create an externalItem.
Get externalItem externalItem Get an externalItem.
Update externalItem externalItem Update an externalItem.
Delete externalItem None Delete an externalItem.

Properties

Property Type Description
acl acl collection An array of access control entries. Each entry specifies the access granted to a user or group. Required.
content externalItemContent A plain-text or HTML representation of the contents of the item. The text in this property is full-text indexed. Optional.
id String Developer-provided unique ID of the item within the containing externalConnection. Must be alphanumeric and a maximum of 128 characters. Required.
properties Object A property bag with the properties of the item. The properties MUST conform to the schema defined for the externalConnection. Required.

Relationships

None.

JSON representation

The following is a JSON representation of the resource.

{
  "acl": [{"@odata.type": "microsoft.graph.acl"}],
  "content": {"@odata.type": "microsoft.graph.externalItemContent"},
  "id": "String (identifier)",
  "properties": "Object"
}