команда: getShifts

  • Статья

Пространство имен: microsoft.graph

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Получение всех объектов shift во всех командах, в которых пользователь является непосредственным участником.

Разрешения

Для вызова этого API требуется одно из следующих разрешений. Дополнительные сведения, включая сведения о том, как выбрать разрешения, см. в статье Разрешения.

Тип разрешения Разрешения с наименьшими привилегиями Более высокие привилегированные разрешения
Делегированные (рабочая или учебная учетная запись) Schedule.Read.All Schedule.ReadWrite.All
Делегированные (личная учетная запись Майкрософт) Не поддерживается. Не поддерживается.
Приложение Schedule.Read.All Schedule.ReadWrite.All

HTTP-запрос

GET /me/joinedTeams/getShifts
GET /users/{id | user-principal-name}/joinedTeams/getShifts

Необязательные параметры запросов

Этот метод поддерживает $topпараметры запроса OData и $filter для настройки ответа.

Примечание.

Параметр $filter поддерживает свойства sharedShift/startDateTime, sharedShift/endDateTime, userId и teamInfo/teamId . Он не поддерживает использование одного и того же свойства более одного и того же свойства в запросе. Например, следующий запрос не работает: sharedShift/startDateTime ge 2024-05-09T00:00:00Z and sharedShift/startDateTime le 2024-05-09T23:59:59Z; однако работает следующий запрос: sharedShift/startDateTime ge 2024-05-09T00:00:00Z and sharedShift/endDateTime le 2024-05-09T23:59:59Z.

Заголовки запросов

Имя Описание
Авторизация Bearer {token}. Обязательно.
MS-APP-ACTS-AS Идентификатор пользователя (GUID). Требуется только в том случае, если маркер авторизации является маркером приложения; В противном случае — необязательно.

Текст запроса

Не указывайте текст запроса для этого метода.

Отклик

В случае успешного 200 OK выполнения этот метод возвращает код отклика и коллекцию объектов shift в тексте ответа.

Примеры

Запрос

Ниже показан пример запроса.

GET https://graph.microsoft.com/beta/me/joinedTeams/getShifts

Отклик

Ниже показан пример отклика.

Примечание. Объект отклика, показанный здесь, может быть сокращен для удобочитаемости.

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

{
  "value": [
    {
      "id": "SHFT_577b75d2-a927-48c0-a5d1-dc984894e7b8",
      "createdDateTime": "2019-03-14T04:32:51.451Z",
      "lastModifiedDateTime": "2019-03-14T05:32:51.451Z",
      "userId": "c5d0c76b-80c4-481c-be50-923cd8d680a1",
      "schedulingGroupId": "TAG_228940ed-ff84-4e25-b129-1b395cf78be0",
      "schedulingGroupInfo": {
        "displayName": "Cashiers",
        "schedulingGroupId": "TAG_228940ed-ff84-4e25-b129-1b395cf78be0"
      },
      "teamInfo": {
        "displayName": "Contoso Team",
        "teamId": "172b0cce-e65d-44ce-9a49-91d9f2e8493a"
      },
      "userInfo": {
        "displayName": "John Smith",
        "userId": "c5d0c76b-80c4-481c-be50-923cd8d680a1"
      },
      "lastModifiedBy": {
        "application": null,
        "device": null,
        "conversation": null,
        "user": {
          "id": "366c0b19-49b1-41b5-a03f-9f3887bd0ed8",
          "displayName": "John Doe"
        }
      },
      "sharedShift": {
        "displayName": "Day shift",
        "notes": "Please do inventory as part of your shift.",
        "startDateTime": "2019-03-11T15:00:00Z",
        "endDateTime": "2019-03-12T00:00:00Z",
        "theme": "blue",
        "activities": [
          {
            "isPaid": true,
            "startDateTime": "2019-03-11T15:00:00Z",
            "endDateTime": "2019-03-11T15:15:00Z",
            "code": "",
            "displayName": "Lunch"
          }
        ]
      },
      "draftShift": {
        "displayName": "Day shift",
        "notes": "Please do inventory as part of your shift.",
        "startDateTime": "2019-03-11T15:00:00Z",
        "endDateTime": "2019-03-12T00:00:00Z",
        "theme": "blue",
        "activities": [
          {
            "isPaid": true,
            "startDateTime": "2019-03-11T15:00:00Z",
            "endDateTime": "2019-03-11T15:30:00Z",
            "code": "",
            "displayName": "Lunch"
          }
        ]
      }
    }
  ]
}