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

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

https://api.tracker.yandex.net/v3/entities/<тип_сущности>/<id_сущности>

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

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

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

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

{
   "fields": 
   {
      "summary": "<новое_название>",
      "teamAccess": true,
      "parentEntity": {
          "primary": "<id_родительской_сущности>"
      }
   },
   "comment":"<комментарий>",
   "links":
   [
      {
         "relationship": "<связь>", 
         "entity": "<id_связанной_сущности>"
      }
   ]
}

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

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

PATCH /v3/entities/project/655f8cc52*****?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.
• В качестве основного портфеля указывается портфель с идентификатором 66e2fa183*****.
• В список дополнительных портфелей добавляется портфель с идентификатором 670e702fd*****.
• В ответе включено отображение родительских сущностей.

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

{
   "fields": {
      "parentEntity": {
         "primary": "66e2fa183*****",
          "secondary": {
            "add": ["670e702fd*****"]
          }
       }
    }
}

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

{
   "self": "https://api.tracker.yandex.net/v3/entities/project/655f328da834c763********",
   "id": "655f328da834c763********",
   "version": 3,
   "shortId": 2,
   "entityType": "project",
   "createdBy": { "self": "https://api.tracker.yandex.net/v3/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/v3/attachments/8",
         "id": "8",
         "name": "file1.docx",
         "content": "api.tracker.yandex.net/v3/attachments/8/file1.docx",
         "createdBy": { "self": "https://api.tracker.yandex.net/v3/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/v3/attachments/9",
         "id": "9",
         "name": "file2.pdf",
         "content": "api.tracker.yandex.net/v3/attachments/9/file2.pdf",
         "createdBy": { "self": "https://api.tracker.yandex.net/v3/users/11********", "id": "11********", "display": "Имя Фамилия", "cloudUid": "ajevuhegoggf********", "passportUid": 11******** },
         "createdAt": "2023-11-23T15:46:25.932+0000",
         "mimetype": "application/pdf",
         "size": 175656
      }
   ],
   "fields":
      {
         "teamAccess": null
      }

}