plannerTask: delta
Пространство имен: microsoft.graph
Важно!
API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.
Получение только что созданных, обновленных или удаленных задач в Планировщик плане или назначенных пользователю, выполнившим вход, без необходимости выполнять полное чтение всей коллекции ресурсов. Дополнительные сведения см . в статье Использование разностного запроса для отслеживания изменений в данных Microsoft Graph.
Этот API доступен в следующих национальных облачных развертываниях.
| Глобальная служба | Правительство США L4 | Правительство США L5 (DOD) | Китай управляется 21Vianet |
|---|---|---|---|
| ✅ | ✅ | ✅ | ❌ |
Разрешения
Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.
| Тип разрешения | Разрешения с наименьшими привилегиями | Более высокие привилегированные разрешения |
|---|---|---|
| Делегированные (рабочая или учебная учетная запись) | Tasks.Read | Недоступно. |
| Делегированные (личная учетная запись Майкрософт) | Не поддерживается. | Не поддерживается. |
| Приложение | Tasks.Read.All | Недоступно. |
HTTP-запрос
GET /planner/tasks/delta
GET /me/planner/tasks/delta
Параметры запроса
При отслеживании изменений выполняется цикл из одного или нескольких вызовов разностных функций. Если вы используете параметры запроса, отличные от $deltaToken и $skipToken, их необходимо указать в начальном запросе delta. Microsoft Graph автоматически кодирует указанные параметры в маркере, входящем в состав URL-адреса @odata.nextLink или @odata.deltaLink, включенного в отклик. Параметры запроса нужно указать только один раз в первом запросе. В последующих запросах скопируйте и примените @odata.nextLink URL-адрес или @odata.deltaLink из предыдущего ответа. Этот URL-адрес уже включает закодированные параметры.
| Параметр запроса | Тип | Описание |
|---|---|---|
| $deltaToken | string |
Маркер состояния, возвращенный в @odata.deltaLink URL-адресе предыдущего вызова разностной функции для той же коллекции ресурсов, что указывает на завершение этого цикла отслеживания изменений. Сохраните и примените весь @odata.deltaLink URL-адрес, включая этот маркер, в первом запросе следующего раунда отслеживания изменений для этой коллекции. |
| $skipToken | string |
Маркер состояния, возвращенный в @odata.nextLink URL-адресе предыдущего вызова разностной функции, указывающий, что в той же коллекции ресурсов необходимо отслеживать дальнейшие изменения. |
Заголовки запросов
| Имя | Описание |
|---|---|
| Авторизация | Bearer {token}. Обязательно. Дополнительные сведения о проверке подлинности и авторизации. |
| Content-Type | application/json |
Текст запроса
Не указывайте текст запроса для этого метода.
Отклик
В случае успешного выполнения эта функция возвращает код отклика 200 OK и коллекцию plannerTask в тексте отклика.
Примеры
Пример 1. Получение разностных сведений о задачах в plannerPlan
В следующем примере показан запрос разностного объекта plannerTask в plannerPlan.
Запрос
Ниже показан пример запроса.
GET https://graph.microsoft.com/beta/planner/tasks/delta
Отклик
Ниже показан пример отклика.
Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#plannerTask",
"@odata.deltaLink": "https://graph.microsoft.com/beta/planner/plans('-W4K7hIak0WlAwgJCn1sEWQABgjH')/tasks?%24expand=details&%24deltatoken=0%257eaa6c4c81-656f-40e8-a2c5-60f4116fa9a4",
"value": [
{
"@odata.etag": "W/\"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBASCc=\"",
"createdBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
"createdByApp": "09abbdfd-ed23-44ee-a2d9-a627aa1c90f3",
"createdByAsIdentitySet": {
"user": {
"@odata.type": "#microsoft.taskServices.identity",
"displayName": null,
"id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
},
"application": {
"@odata.type": "#microsoft.taskServices.identity",
"displayName": null,
"id": "09abbdfd-ed23-44ee-a2d9-a627aa1c90f3"
}
},
"userContentLastModifiedBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
"userContentLastModifiedByApp": null,
"userContentLastModifiedByAsIdentitySet": {
"user": {
"@odata.type": "#microsoft.taskServices.identity",
"displayName": null,
"id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
}
},
"planId": "-W4K7hIak0WlAwgJCn1sEWQABgjH",
"bucketId": "iz1mmIxX7EK0Yj7DmRsMs2QAEDXH",
"title": "Testing",
"orderHint": "8585371316800245114P\\",
"assigneePriority": "8585371316123370883",
"focusDateTime": null,
"percentComplete": 0,
"startDateTime": null,
"createdDateTime": "2022-09-29T18:14:25.6091874Z",
"userContentLastModifiedDate": "2022-09-29T18:14:33.1404924Z",
"dueDateTime": null,
"recurrence": null,
"hasDescription": false,
"previewType": "automatic",
"completedDateTime": null,
"completedBy": null,
"completedByApp": null,
"completedByAsIdentitySet": null,
"referenceCount": 0,
"checklistItemCount": 0,
"activeChecklistItemCount": 0,
"appliedCategories": {},
"assignments": {
"b40c85a0-1a66-4fa3-932f-cc9249ce8c29": {
"@odata.type": "#microsoft.taskServices.assignment",
"assignedBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
"assignedByAppId": null,
"assignedByAsIdentitySet": {
"user": {
"@odata.type": "#microsoft.taskServices.identity",
"displayName": null,
"id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
}
},
"assignedDateTime": "2022-09-29T18:14:33.1404924Z",
"orderHint": "8585371316723527019PX",
"createdBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
"createdByAppId": null,
"createdByAsIdentitySet": {
"user": {
"@odata.type": "#microsoft.taskServices.identity",
"displayName": null,
"id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
}
}
}
},
"conversationThreadId": null,
"priority": 5,
"creationSource": {
"publication": null,
"externalSource": null
},
"creationSourceInfo": null,
"id": "aSOQ0mveu06bTSkfnJQay2QAIn_l",
"version": "1-Task @@@@@@@@@@@@@@@H",
"details@odata.context": "https://tasks.officeppe.com/taskApi/V3.0/$metadata#plans('-W4K7hIak0WlAwgJCn1sEWQABgjH')/tasks('aSOQ0mveu06bTSkfnJQay2QAIn_l')/details/$entity",
"details": {
"@odata.etag": "W/\"JzEtVGFza0RldGFpbHMgQEBAQEBAQEBAQEBAQEBARCc=\"",
"description": "",
"notes": null,
"previewType": "automatic",
"references": {},
"checklist": {},
"id": "aSOQ0mveu06bTSkfnJQay2QAIn_l",
"version": "1-TaskDetails @@@@@@@@@@@@@@@D"
}
}
]
}
Пример 2. Получение разностных сведений о задачах, назначенных пользователю
В следующем примере показан запрос на разностное значение объектов plannerTask , назначенных пользователю.
Запрос
Ниже показан пример запроса.
GET https://graph.microsoft.com/beta/me/planner/tasks/delta
Отклик
Ниже показан пример отклика.
Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context":"https://graph.microsoft.com/beta/$metadata#plannerTask",
"@odata.deltaLink": "https://graph.microsoft.com/beta/me/planner/tasks/delta?%24expand=details&%24deltatoken=0%257eaa6c4c81-656f-40e8-a2c5-60f4116fa9a4",
"value": [
{
"@odata.etag": "W/\"JzEtVGFzayAgQEBAQEBAQEBAQEBAQEBASCc=\"",
"createdBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
"createdByApp": "09abbdfd-ed23-44ee-a2d9-a627aa1c90f3",
"createdByAsIdentitySet": {
"user": {
"@odata.type": "#microsoft.taskServices.identity",
"displayName": null,
"id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
},
"application": {
"@odata.type": "#microsoft.taskServices.identity",
"displayName": null,
"id": "09abbdfd-ed23-44ee-a2d9-a627aa1c90f3"
}
},
"userContentLastModifiedBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
"userContentLastModifiedByApp": null,
"userContentLastModifiedByAsIdentitySet": {
"user": {
"@odata.type": "#microsoft.taskServices.identity",
"displayName": null,
"id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
}
},
"planId": "-W4K7hIak0WlAwgJCn1sEWQABgjH",
"bucketId": "iz1mmIxX7EK0Yj7DmRsMs2QAEDXH",
"title": "Testing",
"orderHint": "8585371316800245114P\\",
"assigneePriority": "8585371316123370883",
"focusDateTime": null,
"percentComplete": 0,
"startDateTime": null,
"createdDateTime": "2022-09-29T18:14:25.6091874Z",
"userContentLastModifiedDate": "2022-09-29T18:14:33.1404924Z",
"dueDateTime": null,
"recurrence": null,
"hasDescription": false,
"previewType": "automatic",
"completedDateTime": null,
"completedBy": null,
"completedByApp": null,
"completedByAsIdentitySet": null,
"referenceCount": 0,
"checklistItemCount": 0,
"activeChecklistItemCount": 0,
"appliedCategories": {},
"assignments": {
"b40c85a0-1a66-4fa3-932f-cc9249ce8c29": {
"@odata.type": "#microsoft.taskServices.assignment",
"assignedBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
"assignedByAppId": null,
"assignedByAsIdentitySet": {
"user": {
"@odata.type": "#microsoft.taskServices.identity",
"displayName": null,
"id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
}
},
"assignedDateTime": "2022-09-29T18:14:33.1404924Z",
"orderHint": "8585371316723527019PX",
"createdBy": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29",
"createdByAppId": null,
"createdByAsIdentitySet": {
"user": {
"@odata.type": "#microsoft.taskServices.identity",
"displayName": null,
"id": "b40c85a0-1a66-4fa3-932f-cc9249ce8c29"
}
}
}
},
"conversationThreadId": null,
"priority": 5,
"creationSource": {
"publication": null,
"externalSource": null
},
"creationSourceInfo": null,
"id": "aSOQ0mveu06bTSkfnJQay2QAIn_l",
"version": "1-Task @@@@@@@@@@@@@@@H",
"details@odata.context": "https://tasks.officeppe.com/taskApi/V3.0/$metadata#plans('-W4K7hIak0WlAwgJCn1sEWQABgjH')/tasks('aSOQ0mveu06bTSkfnJQay2QAIn_l')/details/$entity",
"details": {
"@odata.etag": "W/\"JzEtVGFza0RldGFpbHMgQEBAQEBAQEBAQEBAQEBARCc=\"",
"description": "",
"notes": null,
"previewType": "automatic",
"references": {},
"checklist": {},
"id": "aSOQ0mveu06bTSkfnJQay2QAIn_l",
"version": "1-TaskDetails @@@@@@@@@@@@@@@D"
}
},
]
}