Перейти к содержанию

Получение записей трудозатрат с фильтрацией и пагинацией

Возвращает записи о трудозатратах.

GET /cwm/public/api/v1/workspaces/time-tracking-entries

Параметры и описание запроса

startDate (обязательный)"

Дата начала периода отчета 2022-03-03

endDate

Дата окончания периода отчета 2022-04-03

users

Список логинов авторов списаний. Для пустого списка пользователей не возвращаются результаты ivan.ivanov,petr.petrov

WithDeleted

Включая удаления boolean true / false

fromToken

Токен запрашиваемой страницы ?fromToken=f5ce1753

maxItemsCount"

Максимальное кол-во задач на странице (по умолчанию: 50) ?maxItemsCount=200

Тело успешного ответа 200

{
  "fromToken": "string",
  "maxItemsCount": 0,
  "nextToken": "string",
  "items": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "date": "2024-10-28T10:21:16.536Z",
      "spentTime": 0,
      "description": "string",
      "createdAt": "2024-10-28T10:21:16.536Z",
      "updatedAt": "2024-10-28T10:21:16.536Z",
      "deletedAt": "2024-10-28T10:21:16.536Z",
      "deleteUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "deleteUser": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "displayName": "string",
        "username": "string",
        "email": "string",
        "providerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      },
      "workitem": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "key": "string",
        "name": "string",
        "description": "string",
        "type": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string"
        },
        "workflow": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string"
        },
        "status": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string",
          "category": {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "name": "string"
          }
        },
        "startDate": "2024-10-28T10:21:16.536Z",
        "endDate": "2024-10-28T10:21:16.536Z",
        "createdDate": "2024-10-28T10:21:16.536Z",
        "dueDate": "2024-10-28T10:21:16.536Z",
        "assignee": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "displayName": "string",
          "username": "string",
          "email": "string",
          "providerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        },
        "author": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "displayName": "string",
          "username": "string",
          "email": "string",
          "providerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        },
        "sprint": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string"
        },
        "folder": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string"
        },
        "originalEstimate": 0,
        "timeSpent": 0,
        "remainingEstimate": 0,
        "storyPoints": 0,
        "changedBy": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "displayName": "string",
          "username": "string",
          "email": "string",
          "providerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        },
        "changeDate": "2024-10-28T10:21:16.536Z",
        "parent": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "nodeType": "Folder"
        },
        "attributes": [
          {
            "type": "UniString",
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "name": "string",
            "description": "string",
            "value": "string"
          },
          {
            "type": "Number",
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "name": "string",
            "description": "string",
            "value": 0
          },
          {
            "type": "Date",
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "name": "string",
            "description": "string",
            "value": "2024-10-28T10:21:16.536Z"
          },
          {
            "type": "UniSelect",
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "name": "string",
            "description": "string",
            "value": {
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "name": "string"
            }
          },
          {
            "type": "Tag",
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "name": "string",
            "description": "string",
            "value": [
              {
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "name": "string"
              }
            ]
          },
          {
            "type": "User",
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "name": "string",
            "description": "string",
            "value": {
              "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
              "displayName": "string",
              "username": "string",
              "email": "string",
              "providerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
            }
          },
          {
            "type": "TimeDuration",
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "name": "string",
            "description": "string",
            "value": 0
          }
        ],
        "portfolios": [
          {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "name": "string",
            "elements": [
              {
                "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
                "name": "string"
              }
            ]
          }
        ],
        "workspace": {
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "key": "string",
          "name": "string",
          "description": "string",
          "author": {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "displayName": "string",
            "username": "string",
            "email": "string",
            "providerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
          }
        }
      },
      "author": {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "displayName": "string",
        "username": "string",
        "email": "string",
        "providerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      }
    }
  ]
}

Описание возвращаемой модели

fromToken

Токен текущей страницы результатов

maxItemsCount

Количество запрошенных элементов на странице результатов

nextToken

Токен следующей страницы результатов

items

Список записей трудозатрат.

Модель записи трудозатрат приведена ниже.

Описание модели записи трудозатрат

id

Идентификатор записи трудозатрат

date

Дата, в которую было затрачено время записи

spentTime

Затраченное время в секундах

description

Описание затраченного времени

createdAt

Дата создания записи трудозатрат

updatedAt

Дата обновления записи трудозатрат

deleteUserId

Идентификатор пользователя, удалившего запись

deletedAT

Дата удаления записи трудозатрат

deleteUser

Данные пользователя, удалившего запись Соответствуют описанию возвращаемой модели пользователя

workitem

Задача, по которой добавлена запись трудозатрат. Соответствует модели задачи, описанной в описании возвращаемой модели задачи.

author

Автор записи. Идентификатор, отображаемое имя, логин и почта пользователя.

Ошибки

401 (Unauthorized)

Неавторизованный запрос

400 (Bad Request)

Неправильный (несуществующий) параметр запроса

403 (Forbidden)

Отказ доступа к объекту

500 (Server Error)

Внутренняя ошибка сервиса