Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
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.
Create a linkedResource object to associate a specified task with an item in a partner application. For example, you can associate a task with an email item in Outlook that spurred the task, and you can create a linkedResource object to track its association.
You can also create a linkedResource object while creating a todoTask.
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 permissions | Higher privileged permissions |
---|---|---|
Delegated (work or school account) | Tasks.ReadWrite | Not available. |
Delegated (personal Microsoft account) | Tasks.ReadWrite | Not available. |
Application | Not supported. | Not supported. |
HTTP request
POST /me/todo/lists/{todoTaskListId}/tasks/{taskId}/linkedResources
POST /users/{id|userPrincipalName}/todo/lists/{todoTaskListId}/tasks/{taskId}/linkedResources
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Content-Type | application/json. Required. |
Request body
In the request body, supply a JSON representation of the linkedResource object.
The following table lists the properties that are required when you create the linkedResource.
Property | Type | Description |
---|---|---|
id | String | Server generated Id for the linked entity Inherited from entity |
webUrl | String | Deeplink to the linked entity |
applicationName | String | Field indicating app name of the source that is sending the linked entity |
displayName | String | Field indicating title of the linked entity. |
externalId | String | Id of the object that is associated with this task on the third-party/partner system |
Response
If successful, this method returns a 201 Created
response code and a linkedResource object in the response body.
Examples
Request
POST https://graph.microsoft.com/beta/me/todo/lists/dfsdc-f9dfdfs-dcsda9/tasks/e2dc-f9cce2-dce29/linkedResources
Content-Type: application/json
{
"webUrl": "https://microsoft.com",
"applicationName": "Microsoft",
"displayName": "Microsoft",
"externalId": "dk9cddce2-dce2-f9dd-e2dc-cdf9e2dccdf9"
}
Response
Note: The response object shown here might be shortened for readability.
HTTP/1.1 201 Created
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.linkedResource",
"id": "f9cddce2-dce2-f9cd-e2dc-cdf9e2dccdf9",
"webUrl": "http:://microsoft.com",
"applicationName": "Microsoft",
"displayName": "Microsoft",
"externalId": "dk9cddce2-dce2-f9dd-e2dc-cdf9e2dccdf9"
}