externalItem: addActivities

Namespace: microsoft.graph.externalConnectors

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.

Append additional instances of externalActivity objects on an externalitem.

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 /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 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 involving an externalItem.

Response

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

If a 207 response is returned, this 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. If the error field is null, that indicates a successful externalActivityResult.

Examples

Request

The following is an example of a request.

HTTP

POST https://graph.microsoft.com/beta/connections/{connectionsId}/items/{externalItemId}/addActivities
Content-Type: application/json
Content-length: 190

{
  "activities": [
    {
      "@odata.type": "#microsoft.graph.externalConnectors.externalActivity",
      "type": "String",
      "startDateTime": "String (timestamp)"
    }
  ]
}

C#

var graphClient = new GraphServiceClient(requestAdapter);

var requestBody = new Microsoft.Graph.Beta.Connections.Item.Items.Item.ExternalConnectorsAddActivities.AddActivitiesPostRequestBody
{
	Activities = new List<Microsoft.Graph.Beta.Models.ExternalConnectors.ExternalActivity>
	{
		new Microsoft.Graph.Beta.Models.ExternalConnectors.ExternalActivity
		{
			OdataType = "#microsoft.graph.externalConnectors.externalActivity",
			Type = Microsoft.Graph.Beta.Models.ExternalConnectors.ExternalActivityType.Viewed,
			StartDateTime = DateTimeOffset.Parse("String (timestamp)"),
		},
	},
};
var result = await graphClient.Connections["{externalConnection-id}"].Items["{externalItem-id}"].ExternalConnectorsAddActivities.PostAsync(requestBody);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

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: 'String',
      startDateTime: 'String (timestamp)'
    }
  ]
};

await client.api('/connections/{connectionsId}/items/{externalItemId}/addActivities')
	.version('beta')
	.post(externalActivityResult);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

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.VIEWED;
activities.startDateTime = OffsetDateTimeSerializer.deserialize("String (timestamp)");

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

graphClient.connections("{connectionsId}").items("{externalItemId}")
	.addActivities(ExternalItemAddActivitiesParameterSet
		.newBuilder()
		.withActivities(activitiesList)
		.build())
	.buildRequest()
	.post();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

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

Go

//THE GO SDK IS IN PREVIEW. NON-PRODUCTION USE ONLY
graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)

requestBody := graphmodels.NewAddActivitiesPostRequestBody()


externalActivity := graphmodels.NewExternalActivity()
type := graphmodels.STRING_EXTERNALACTIVITYTYPE 
externalActivity.SetType(&type) 
startDateTime , err := time.Parse(time.RFC3339, "String (timestamp)")
externalActivity.SetStartDateTime(&startDateTime) 

activities := []graphmodels.ExternalActivityable {
	externalActivity,

}
requestBody.SetActivities(activities)

result, err := graphClient.ConnectionsById("externalConnection-id").ItemsById("externalItem-id").ExternalConnectorsAddActivities().Post(context.Background(), requestBody, nil)

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

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 AddActivitiesPostRequestBody();
$activitiesExternalActivity1 = new ExternalActivity();
$activitiesExternalActivity1->set@odatatype('#microsoft.graph.externalConnectors.externalActivity');

$activitiesExternalActivity1->setType(new ExternalActivityType('string'));

$activitiesExternalActivity1->setStartDateTime(new DateTime('String (timestamp)'));


$activitiesArray []= $activitiesExternalActivity1;
$requestBody->setActivities($activitiesArray);




$requestResult = $graphServiceClient->connectionsById('externalConnection-id')->itemsById('externalItem-id')->externalConnectorsAddActivities()->post($requestBody);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

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": "String",
      "startDateTime": "String (timestamp)",
      "error": {
        "@odata.type": "microsoft.graph.publicError"
      }
    }
  ]
}