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. To determine whether an API is available in v1.0, use the Version selector.
Apply a contentModel to SharePoint document libraries. For an existing model that's already trained, this action automatically processes new documents that are added to the SharePoint libraries.
This API is available in the following national cloud deployments.
| Global service |
US Government L4 |
US Government L5 (DOD) |
China operated by 21Vianet |
| ✅ |
✅ |
✅ |
✅ |
Permissions
Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.
| Permission type |
Least privileged permission |
Higher privileged permissions |
| Delegated (work or school account) |
Site.Manage.All |
Site.Manage.All |
| Delegated (personal Microsoft account) |
Not supported. |
Not supported. |
| Application |
Site.Manage.All |
Site.Manage.All |
HTTP request
POST /sites/{sitesId}/contentModels/{contentModelId}/addToDrive
Request body
In the request body, supply a JSON representation of the parameters.
The following table lists the parameters that are required when you call this action.
| Parameter |
Type |
Description |
| driveId |
String |
The model applied to drive ID. |
Response
If successful, this action returns a 200 OK response code and a contentModelUsage object in the response body.
Examples
Request
The following example shows a request.
POST https://graph.microsoft.com/beta/sites/ede4bb84-6c94-4c39-8acf-3d9dbb667fba/contentModels/17139234-22d4-205c-e7bd-1c5bc1ab19e0/addToDrive
Content-Type: application/json
{
"driveId": "b!HEq8Q8ZfAkuMECqSaQFnJVwNMbAGLHhHnXMz1C32pozpolsoEg-MT47fBTiYcbnd"
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Sites.Item.ContentModels.Item.AddToDrive;
var requestBody = new AddToDrivePostRequestBody
{
DriveId = "b!HEq8Q8ZfAkuMECqSaQFnJVwNMbAGLHhHnXMz1C32pozpolsoEg-MT47fBTiYcbnd",
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Sites["{site-id}"].ContentModels["{contentModel-id}"].AddToDrive.PostAsync(requestBody);
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphsites "github.com/microsoftgraph/msgraph-beta-sdk-go/sites"
//other-imports
)
requestBody := graphsites.NewAddToDrivePostRequestBody()
driveId := "b!HEq8Q8ZfAkuMECqSaQFnJVwNMbAGLHhHnXMz1C32pozpolsoEg-MT47fBTiYcbnd"
requestBody.SetDriveId(&driveId)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
addToDrive, err := graphClient.Sites().BySiteId("site-id").ContentModels().ByContentModelId("contentModel-id").AddToDrive().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
com.microsoft.graph.beta.sites.item.contentmodels.item.addtodrive.AddToDrivePostRequestBody addToDrivePostRequestBody = new com.microsoft.graph.beta.sites.item.contentmodels.item.addtodrive.AddToDrivePostRequestBody();
addToDrivePostRequestBody.setDriveId("b!HEq8Q8ZfAkuMECqSaQFnJVwNMbAGLHhHnXMz1C32pozpolsoEg-MT47fBTiYcbnd");
var result = graphClient.sites().bySiteId("{site-id}").contentModels().byContentModelId("{contentModel-id}").addToDrive().post(addToDrivePostRequestBody);
const options = {
authProvider,
};
const client = Client.init(options);
const contentModelUsage = {
driveId: 'b!HEq8Q8ZfAkuMECqSaQFnJVwNMbAGLHhHnXMz1C32pozpolsoEg-MT47fBTiYcbnd'
};
await client.api('/sites/ede4bb84-6c94-4c39-8acf-3d9dbb667fba/contentModels/17139234-22d4-205c-e7bd-1c5bc1ab19e0/addToDrive')
.version('beta')
.post(contentModelUsage);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Sites\Item\ContentModels\Item\AddToDrive\AddToDrivePostRequestBody;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new AddToDrivePostRequestBody();
$requestBody->setDriveId('b!HEq8Q8ZfAkuMECqSaQFnJVwNMbAGLHhHnXMz1C32pozpolsoEg-MT47fBTiYcbnd');
$result = $graphServiceClient->sites()->bySiteId('site-id')->contentModels()->byContentModelId('contentModel-id')->addToDrive()->post($requestBody)->wait();
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.sites.item.contentmodels.item.add_to_drive.add_to_drive_post_request_body import AddToDrivePostRequestBody
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = AddToDrivePostRequestBody(
drive_id = "b!HEq8Q8ZfAkuMECqSaQFnJVwNMbAGLHhHnXMz1C32pozpolsoEg-MT47fBTiYcbnd",
)
result = await graph_client.sites.by_site_id('site-id').content_models.by_content_model_id('contentModel-id').add_to_drive.post(request_body)
Response
The following example shows the response.
Note: The response object shown here might be shortened for readability.
HTTP/1.1 201 Created
Content-Type: application/json
{
"createdBy": {
"user": {
"displayName": "Travis Li",
"email": "travisli@microsoft.com",
"resourceVisualization": {
"acronym": "TL",
"color": "#881798"
}
}
},
"createdDateTime": "2023-04-30T08:32:00Z",
"lastModifiedBy": {
"user": {
"displayName": "Travis Li",
"email": "travisli@microsoft.com",
"resourceVisualization": {
"acronym": "TL",
"color": "#881798"
}
}
},
"lastModifiedDateTime": "2023-05-31T20:31:51Z",
"modelVersion": "1.0",
"driveId": "b!HEq8Q8ZfAkuMECqSaQFnJVwNMbAGLHhHnXMz1C32pozpolsoEg-MT47fBTiYcbnd",
"modelId": "17139234-22d4-205c-e7bd-1c5bc1ab19e0"
}