externalItem: addActivities

Namespace: microsoft.graph.externalConnectors

Append additional instances of externalActivity objects on an externalItem.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	✅	✅	❌

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)	Not supported.
Delegated (personal Microsoft account)	Not supported.
Application	ExternalItem.ReadWrite.OwnedBy, ExternalItem.ReadWrite.All

HTTP request

POST external/connections/{connectionsId}/items/{externalItemId}/addActivities

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

The following table shows the parameters that can be used with this action.

Parameter	Type	Description
activities	microsoft.graph.externalConnectors.externalActivity collection	Collection of activities that involve an externalItem.

Response

If successful, this action returns a 200 OK response code and a collection of microsoft.graph.externalConnectors.externalActivityResult objects in the response body.

A 207 Multi-Status response code indicates that only some of the added externalActivity instances were successfully processed. The caller should inspect the response payload, looking at the error field for each externalActivityResult to determine why the externalActivity instance was not processed and what action can be taken. A null error property indicates a successful externalActivityResult.

Examples

Request

The following is an example of a request.

HTTP

POST https://graph.microsoft.com/v1.0/external/connections/contosohr/items/TSP228082938/addActivities
Content-Type: application/json
Content-length: 190

{
  "activities": [
    {
      "@odata.type": "#microsoft.graph.externalConnectors.externalActivity",
      "type": "created",
      "startDateTime": "2021-04-06T18:04:31.033Z",
      "performedBy": {
        "type": "user",
        "id": "1f0c997e-99f7-43f1-8cca-086f8d42be8d"
      }
    }
  ]
}

C#

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

// Dependencies
using Microsoft.Graph.External.Connections.Item.Items.Item.MicrosoftGraphExternalConnectorsAddActivities;
using Microsoft.Graph.Models.ExternalConnectors;

var requestBody = new AddActivitiesPostRequestBody
{
	Activities = new List<ExternalActivity>
	{
		new ExternalActivity
		{
			OdataType = "#microsoft.graph.externalConnectors.externalActivity",
			Type = ExternalActivityType.Created,
			StartDateTime = DateTimeOffset.Parse("2021-04-06T18:04:31.033Z"),
			PerformedBy = new Identity
			{
				Type = IdentityType.User,
				Id = "1f0c997e-99f7-43f1-8cca-086f8d42be8d",
			},
		},
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.External.Connections["{externalConnection-id}"].Items["{externalItem-id}"].MicrosoftGraphExternalConnectorsAddActivities.PostAsync(requestBody);

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

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc external connections items microsoft-graph-external-connectors-add-activities post --external-connection-id {externalConnection-id} --external-item-id {externalItem-id} --body '{\
  "activities": [\
    {\
      "@odata.type": "#microsoft.graph.externalConnectors.externalActivity",\
      "type": "created",\
      "startDateTime": "2021-04-06T18:04:31.033Z",\
      "performedBy": {\
        "type": "user",\
        "id": "1f0c997e-99f7-43f1-8cca-086f8d42be8d"\
      }\
    }\
  ]\
}\
'

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"
	  graphexternal "github.com/microsoftgraph/msgraph-sdk-go/external"
	  graphmodelsexternalconnectors "github.com/microsoftgraph/msgraph-sdk-go/models/externalconnectors"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphexternal.NewAddActivitiesPostRequestBody()


externalActivity := graphmodelsexternalconnectors.NewExternalActivity()
type := graphmodels.CREATED_EXTERNALACTIVITYTYPE 
externalActivity.SetType(&type) 
startDateTime , err := time.Parse(time.RFC3339, "2021-04-06T18:04:31.033Z")
externalActivity.SetStartDateTime(&startDateTime) 
performedBy := graphmodelsexternalconnectors.NewIdentity()
type := graphmodels.USER_IDENTITYTYPE 
performedBy.SetType(&type) 
id := "1f0c997e-99f7-43f1-8cca-086f8d42be8d"
performedBy.SetId(&id) 
externalActivity.SetPerformedBy(performedBy)

activities := []graphmodelsexternalconnectors.ExternalActivityable {
	externalActivity,
}
requestBody.SetActivities(activities)

microsoftGraphExternalConnectorsAddActivities, err := graphClient.External().Connections().ByExternalConnectionId("externalConnection-id").Items().ByExternalItemId("externalItem-id").MicrosoftGraphExternalConnectorsAddActivities().Post(context.Background(), requestBody, nil)

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

Java

GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

LinkedList<ExternalActivity> activitiesList = new LinkedList<ExternalActivity>();
ExternalActivity activities = new ExternalActivity();
activities.type = ExternalActivityType.CREATED;
activities.startDateTime = OffsetDateTimeSerializer.deserialize("2021-04-06T18:04:31.033Z");
Identity performedBy = new Identity();
performedBy.type = IdentityType.USER;
performedBy.id = "1f0c997e-99f7-43f1-8cca-086f8d42be8d";
activities.performedBy = performedBy;

activitiesList.add(activities);
ExternalActivityCollectionResponse externalActivityCollectionResponse = new ExternalActivityCollectionResponse();
externalActivityCollectionResponse.value = activitiesList;
ExternalActivityCollectionPage externalActivityCollectionPage = new ExternalActivityCollectionPage(externalActivityCollectionResponse, null);

graphClient.external().connections("contosohr").items("TSP228082938")
	.addActivities(ExternalItemAddActivitiesParameterSet
		.newBuilder()
		.withActivities(activitiesList)
		.build())
	.buildRequest()
	.post();

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 externalActivityResult = {
  activities: [
    {
      '@odata.type': '#microsoft.graph.externalConnectors.externalActivity',
      type: 'created',
      startDateTime: '2021-04-06T18:04:31.033Z',
      performedBy: {
        type: 'user',
        id: '1f0c997e-99f7-43f1-8cca-086f8d42be8d'
      }
    }
  ]
};

await client.api('/external/connections/contosohr/items/TSP228082938/addActivities')
	.post(externalActivityResult);

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 VERSION OF THE SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new AddActivitiesPostRequestBody();
$activitiesExternalActivity1 = new ExternalActivity();
$activitiesExternalActivity1->setOdataType('#microsoft.graph.externalConnectors.externalActivity');
$activitiesExternalActivity1->setType(new ExternalActivityType('created'));
$activitiesExternalActivity1->setStartDateTime(new \DateTime('2021-04-06T18:04:31.033Z'));
$activitiesExternalActivity1PerformedBy = new Identity();
$activitiesExternalActivity1PerformedBy->setType(new IdentityType('user'));
$activitiesExternalActivity1PerformedBy->setId('1f0c997e-99f7-43f1-8cca-086f8d42be8d');
$activitiesExternalActivity1->setPerformedBy($activitiesExternalActivity1PerformedBy);
$activitiesArray []= $activitiesExternalActivity1;
$requestBody->setActivities($activitiesArray);


$result = $graphServiceClient->external()->connections()->byExternalConnectionId('externalConnection-id')->items()->byExternalItemId('externalItem-id')->microsoftGraphExternalConnectorsAddActivities()->post($requestBody)->wait();

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 = @{
	activities = @(
		@{
			"@odata.type" = "#microsoft.graph.externalConnectors.externalActivity"
			type = "created"
			startDateTime = [System.DateTime]::Parse("2021-04-06T18:04:31.033Z")
			performedBy = @{
				type = "user"
				id = "1f0c997e-99f7-43f1-8cca-086f8d42be8d"
			}
		}
	)
}

Add-MgExternalConnectionItemActivity -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.

Python

# THE PYTHON SDK IS IN PREVIEW. FOR NON-PRODUCTION USE ONLY

graph_client = GraphServiceClient(credentials, scopes)

request_body = AddActivitiesPostRequestBody(
	activities = [
		ExternalActivity(
			odata_type = "#microsoft.graph.externalConnectors.externalActivity",
			type = ExternalActivityType.Created,
			start_date_time = "2021-04-06T18:04:31.033Z",
			performed_by = Identity(
				type = IdentityType.User,
				id = "1f0c997e-99f7-43f1-8cca-086f8d42be8d",
			),
		),
	],
)

result = await graph_client.external.connections.by_external_connection_id('externalConnection-id').items.by_external_item_id('externalItem-id').microsoft_graph_external_connectors_add_activities.post(request_body)

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

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "value": [
    {
      "@odata.type": "#microsoft.graph.externalConnectors.externalActivityResult",
      "type": "created",
      "startDateTime": "2021-04-06T18:04:31.033Z",
      "error": null
    }
  ]
}