Create externalItem

Namespace: microsoft.graph.externalConnectors

Create a new externalItem object.

Permissions

One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type	Permissions (from least to most privileged)
Delegated (work or school account)	ExternalItem.ReadWrite.OwnedBy, ExternalItem.ReadWrite.All
Delegated (personal Microsoft account)	Not supported
Application	ExternalItem.ReadWrite.OwnedBy, ExternalItem.ReadWrite.All

HTTP request

PUT /external/connections/{connection-id}/items/{item-id}

Request headers

Name	Description
Authorization	Bearer {token}. Required.
Content-Type	application/json. Required.

Request body

In the request body, supply a JSON representation of the externalItem object.

You can specify the following properties when creating an externalItem.

Property	Type	Description
id	String	The item ID. Required.
properties	microsoft.graph.externalConnectors.properties	The item properties. The properties object must contain at least one property. All DateTime type properties must be in ISO 8601 format. Required.
content	microsoft.graph.externalConnectors.externalItemContent	The external item content. Optional.
acl	microsoft.graph.externalConnectors.acl collection	The access control list. Required.

Properties on an externalItem should use type specifiers in the payload in the following scenarios:

• For String type properties, if the value contains non-ASCII characters.

  "description@odata.type": "String",
  "description": "Kandierte Äpfel"
  

• For all collection types.

  "categories@odata.type": "Collection(String)"
  "categories": [
    "red",
    "blue"
  ]
  

  Important

  When including a property of type Collection(DateTime), you must use the type specifier Collection(DateTimeOffset).

Response

If successful, this method returns 200 OK response code.

Examples

Example: Create a custom item

Request

HTTP

PUT https://graph.microsoft.com/v1.0/external/connections/contosohr/items/TSP228082938
Content-type: application/json

{
  "acl": [
    {
      "type": "user",
      "value": "e811976d-83df-4cbd-8b9b-5215b18aa874",
      "accessType": "grant"
    },
    {
      "type": "externalGroup",
      "value": "14m1b9c38qe647f6a",
      "accessType": "deny"
    }
  ],
  "properties": {
    "title": "Error in the payment gateway",
    "priority": 1,
    "assignee": "john@contoso.com"
  },
  "content": {
    "value": "Error in payment gateway...",
    "type": "text"
  }
}

C#

// Code snippets are only available for the latest version. Current version is 5.x

var graphClient = new GraphServiceClient(requestAdapter);

var requestBody = new Microsoft.Graph.Models.ExternalConnectors.ExternalItem
{
	Acl = new List<Microsoft.Graph.Models.ExternalConnectors.Acl>
	{
		new Microsoft.Graph.Models.ExternalConnectors.Acl
		{
			Type = Microsoft.Graph.Models.ExternalConnectors.AclType.User,
			Value = "e811976d-83df-4cbd-8b9b-5215b18aa874",
			AccessType = Microsoft.Graph.Models.ExternalConnectors.AccessType.Grant,
		},
		new Microsoft.Graph.Models.ExternalConnectors.Acl
		{
			Type = Microsoft.Graph.Models.ExternalConnectors.AclType.ExternalGroup,
			Value = "14m1b9c38qe647f6a",
			AccessType = Microsoft.Graph.Models.ExternalConnectors.AccessType.Deny,
		},
	},
	Properties = new Microsoft.Graph.Models.ExternalConnectors.Properties
	{
		AdditionalData = new Dictionary<string, object>
		{
			{
				"title" , "Error in the payment gateway"
			},
			{
				"priority" , 1
			},
			{
				"assignee" , "john@contoso.com"
			},
		},
	},
	Content = new Microsoft.Graph.Models.ExternalConnectors.ExternalItemContent
	{
		Value = "Error in payment gateway...",
		Type = Microsoft.Graph.Models.ExternalConnectors.ExternalItemContentType.Text,
	},
};
var result = await graphClient.External.Connections["{externalConnection-id}"].Items["{externalItem-id}"].PutAsync(requestBody);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Go

import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-sdk-go/models//externalConnectors"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewExternalItem()


acl := graphmodels.NewAcl()
type := graphmodels.USER_ACLTYPE 
acl.SetType(&type) 
value := "e811976d-83df-4cbd-8b9b-5215b18aa874"
acl.SetValue(&value) 
accessType := graphmodels.GRANT_ACCESSTYPE 
acl.SetAccessType(&accessType) 
acl1 := graphmodels.NewAcl()
type := graphmodels.EXTERNALGROUP_ACLTYPE 
acl1.SetType(&type) 
value := "14m1b9c38qe647f6a"
acl1.SetValue(&value) 
accessType := graphmodels.DENY_ACCESSTYPE 
acl1.SetAccessType(&accessType) 

acl := []graphmodels.Aclable {
	acl,
	acl1,

}
requestBody.SetAcl(acl)
properties := graphmodels.NewProperties()
additionalData := map[string]interface{}{
	"title" : "Error in the payment gateway", 
	"priority" : int32(1) , 
	"assignee" : "john@contoso.com", 
}
properties.SetAdditionalData(additionalData)
requestBody.SetProperties(properties)
content := graphmodels.NewExternalItemContent()
value := "Error in payment gateway..."
content.SetValue(&value) 
type := graphmodels.TEXT_EXTERNALITEMCONTENTTYPE 
content.SetType(&type) 
requestBody.SetContent(content)

result, err := graphClient.External().Connections().ByConnectionId("externalConnection-id").Items().ByItemId("externalItem-id").Put(context.Background(), requestBody, nil)

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const externalItem = {
  acl: [
    {
      type: 'user',
      value: 'e811976d-83df-4cbd-8b9b-5215b18aa874',
      accessType: 'grant'
    },
    {
      type: 'externalGroup',
      value: '14m1b9c38qe647f6a',
      accessType: 'deny'
    }
  ],
  properties: {
    title: 'Error in the payment gateway',
    priority: 1,
    assignee: 'john@contoso.com'
  },
  content: {
    value: 'Error in payment gateway...',
    type: 'text'
  }
};

await client.api('/external/connections/contosohr/items/TSP228082938')
	.put(externalItem);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PHP

<?php

// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);

$requestBody = new ExternalItem();
$aclAcl1 = new Acl();
$aclAcl1->setType(new AclType('user'));

$aclAcl1->setValue('e811976d-83df-4cbd-8b9b-5215b18aa874');

$aclAcl1->setAccessType(new AccessType('grant'));


$aclArray []= $aclAcl1;
$aclAcl2 = new Acl();
$aclAcl2->setType(new AclType('externalgroup'));

$aclAcl2->setValue('14m1b9c38qe647f6a');

$aclAcl2->setAccessType(new AccessType('deny'));


$aclArray []= $aclAcl2;
$requestBody->setAcl($aclArray);


$properties = new Properties();
$additionalData = [
	'title' => 'Error in the payment gateway', 
	'priority' => 1,
	'assignee' => 'john@contoso.com', 
];
$properties->setAdditionalData($additionalData);



$requestBody->setProperties($properties);
$content = new ExternalItemContent();
$content->setValue('Error in payment gateway...');

$content->setType(new ExternalItemContentType('text'));


$requestBody->setContent($content);


$result = $graphServiceClient->external()->connections()->byConnectionId('externalConnection-id')->items()->byItemId('externalItem-id')->put($requestBody);

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PowerShell

Import-Module Microsoft.Graph.Search

$params = @{
	acl = @(
		@{
			type = "user"
			value = "e811976d-83df-4cbd-8b9b-5215b18aa874"
			accessType = "grant"
		}
		@{
			type = "externalGroup"
			value = "14m1b9c38qe647f6a"
			accessType = "deny"
		}
	)
	properties = @{
		title = "Error in the payment gateway"
		priority = 
		assignee = "john@contoso.com"
	}
	content = @{
		value = "Error in payment gateway..."
		type = "text"
	}
}

Set-MgExternalConnectionItem -ExternalConnectionId $externalConnectionId -ExternalItemId $externalItemId -BodyParameter $params

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following is an example of the response.

HTTP/1.1 200 OK