Получение списка задач в пространстве с фильтрацией и пагинацией
Возвращает список задач в пространстве, соответствующих параметрам запроса. В модели задачи возвращаются только заполненные атрибуты.
GET /cwm/public/api/v1/workspaces/{workspace}/workitems
Параметры и описание запроса
workspace
(обязательный)
Ключ или идентификатор пространства
/cwm/public/api/v1/workspaces/KEY/workitems
/cwm/public/api/v1/workspaces/f5ce1753-ced5-4992-beb9-7408c1a56cf8/workitems
type
Название или идентификатор типа (точное соответствие)
?type=User%20Story
?type=f5ce1753-ced5-4992-beb9-7408c1a56cf8
parent
Ключ или идентификатор родительского элемента (задача или папка)
?parent=f5ce1753-ced5-4992-beb9-7408c1a56cf8
?parent=TS-15
sprintId
Идентификатор спринта
?sprintId=f5ce1753-ced5-4992-beb9-7408c1a56cf8
portfolioElementId
Идентификатор элемента портфеля
?portfolioElementId=f5ce1753-ced5-4992-beb9-7408c1a56cf8
name
Имя задачи (поиск по вхождению подстроки)
?name={string:255}
assignee
Логин или идентификатор ответственного
?assignee=ivan.ivanov
?assignee=f5ce1753-ced5-4992-beb9-7408c1a56cf8
author
Логин или идентификатор создателя
?author=ivan.ivanov
?author=f5ce1753-ced5-4992-beb9-7408c1a56cf8
status
Название или идентификатор статуса
?status=REQ%20TEST
?status=f5ce1753-ced5-4992-beb9-7408c1a56cf8
statusCategory
?statusCategory=В работе
?statusCategory=f5ce1753-ced5-4992-beb9-7408c1a56cf8
fromToken
Токен запрашиваемой страницы
?fromToken=f5ce1753
maxItemsCount
Максимальное кол-во задач на странице (по умолчанию: 50)
?maxItemsCount=200
Возможно комбинирование нескольких параметров фильтрации.
Ошибки запроса
400
Bad Request
Неправильный (несуществующий) параметр запроса Неправильное значение параметра запроса, неправильный формат значения Дублирование параметра запроса
401
Unauthorized
Неавторизованный запрос
403
Forbidden
Отказ доступа к объекту
500
Server Error
Внутренняя ошибка сервиса
Тело успешного ответа 200
Нажмите, чтобы увидеть пример
{
"fromToken": "string",
"maxItemsCount": 0,
"nextToken": "string",
"items": [
{
"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-01-29T12:07:40.404Z",
"endDate": "2023-12-27T09:49:35.712Z",
"createdDate": "2023-12-27T09:49:35.712Z",
"dueDate": "2023-12-27T09:49:35.712Z",
"assignee": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"displayName": "string",
"username": "string",
"email": "string"
},
"author": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"displayName": "string",
"username": "string",
"email": "string"
},
"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"
},
"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": "2023-12-27T09:49:35.713Z"
},
{
"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"
}
},
{
"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"
}
}
}
]
}
Параметры и описание возвращаемой модели
fromToken
Токен текущей страницы результатов
maxItemsCount
Количество запрошенных элементов на странице результатов
nextToken
Токен следующей страницы результатов
items
Список задач. Модель задачи описана в подразделе Получение задачи