Изменить сущность

Запрос позволяет обновить информацию о сущности — проекте или портфеле проектов.

Запрос представляет унифицированный метод обновления информации о проектах и портфелях, более гибкий и функциональный, чем API обновления информации о проектах.

Формат запросаФормат запроса

Перед выполнением запроса получите доступ к API.

Чтобы изменить сущность, используйте HTTP-запрос с методом PATCH. Параметры запроса передаются в его теле в формате JSON.

PATCH /v2/entities/<тип_сущности>/<идентификатор_сущности>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
   "fields": 
   {
      "summary": "<новое_название>",
      "teamAcceess": true
   },
   "comment": "<комментарий>",
   "links":
   [
      {
         "relationship": "<связь>", 
         "entity": "<идентификатор_связанной_сущности>"
      }
   ],
   "attachmentIds":
   [
      "<идентификатор_временного_файла_1>",
      "<идентификатор_временного_файла_2>",
      ...
   ],
   "descriptionAttachmentIds":
   [
      "<идентификатор_временного_файла_3>",
      "<идентификатор_временного_файла_4>",
      ...
   ]
}

Пример 1: Изменить название проекта и оставить комментарий

• Используется HTTP-метод PATCH.
• Название проекта меняется на «Test 2».
• В комментарии проекта добавляется запись «Проект переименован».
• В ответе включено отображение вложений.

PATCH /v2/entities/project/655f8cc523db213********?expand=attachments HTTP/1.1
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
    "fields":
    {
       "summary":"Test 2", 
    },
    "comment":"Проект переименован"
}

Пример 2: Прикрепить файлы к описанию проекта

• Используется HTTP-метод PATCH.
• Предварительно следует загрузить временные файлы и указать их идентификаторы.
• Временные файлы прикрепляются к описанию проекта.

PATCH /v2/entities/project/655f8cc523db213********?expand=attachments HTTP/1.1
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth-токен>
X-Org-ID или X-Cloud-Org-ID: <идентификатор_организации>

{
    "descriptionAttachmentIds":[
       4519********,
       4522********
    ]
}

Формат ответаФормат ответа

{
   "self": "https://api.tracker.yandex.net/v2/entities/project/655f328da834c763********",
   "id": "655f328da834c763********",
   "version": 3,
   "shortId": 2,
   "entityType": "project",
   "createdBy": { "self": "https://api.tracker.yandex.net/v2/users/11********", "id": "11********", "display": "Имя Фамилия", "cloudUid": "ajevuhegoggf********", "passportUid": 11******** },
   "createdAt": "2023-11-23T11:07:57.298+0000",
   "updatedAt": "2023-11-23T15:46:26.391+0000",
   "attachments": [
      {
         "self": "https://api.tracker.yandex.net/v2/attachments/8",
         "id": "8",
         "name": "file1.docx",
         "content": "api.tracker.yandex.net/v2/attachments/8/file1.docx",
         "createdBy": { "self": "https://api.tracker.yandex.net/v2/users/11********", "id": "11********", "display": "Имя Фамилия", "cloudUid": "ajevuhegoggf********", "passportUid": 11******** },
         "createdAt": "2023-11-23T15:46:20.617+0000",
         "mimetype": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
         "size": 18585
      },
      {
         "self": "https://api.tracker.yandex.net/v2/attachments/9",
         "id": "9",
         "name": "file2.pdf",
         "content": "api.tracker.yandex.net/v2/attachments/9/file2.pdf",
         "createdBy": { "self": "https://api.tracker.yandex.net/v2/users/11********", "id": "11********", "display": "Имя Фамилия", "cloudUid": "ajevuhegoggf********", "passportUid": 11******** },
         "createdAt": "2023-11-23T15:46:25.932+0000",
         "mimetype": "application/pdf",
         "size": 175656
      }
   ]
}