Updating an entity

Use this request to update information about an entity: a goal, project, or project portfolio.

https://api.tracker.yandex.net/v3/entities/<entity_type>/<entity_ID>

Query format

Before making a request, get permission to access the API.

To update an entity, use an HTTP PATCH request. In the request body, specify the parameters in JSON format.

PATCH /v3/entities/<entity_type>/<entity_ID>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>

{
   "fields":
   {
      "summary": "<new_name>",
      "teamAccess": true,
      "parentEntity": {
          "primary": "<parent_entity_ID>"
      }
   },
   "comment":"<comment>",
   "links":
   [
      {
         "relationship": "<link>",
         "entity": "<linked_entity_ID>"
      }
   ]
}

Example 1: Renaming a project and leaving a comment

• An HTTP PATCH method is used.
• The project is renamed to Test 2.
• A Project renamed record is added to project comments.
• The response will display attachments.

PATCH /v3/entities/project/655f8cc52*****?expand=attachments HTTP/1.1
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>

{
    "fields":
    {
       "summary":"Test 2"
    },
    "comment":"Project renamed"
}

Example 2: Changing the project's main portfolio and adding an additional portfolio

• An HTTP PATCH method is used.
• The portfolio with ID 66e2fa183***** is specified as the main one.
• The portfolio with ID 670e702fd***** is added to the list of additional portfolios.
• The response will display parent entities.

PATCH /v3/entities/project/655f8cc52*****?fields=parentEntity HTTP/1.1
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>

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

Response format

{
   "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": "Full name", "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": "Full name", "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": "Full name", "cloudUid": "ajevuhegoggf********", "passportUid": 11******** },
         "createdAt": "2023-11-23T15:46:25.932+0000",
         "mimetype": "application/pdf",
         "size": 175656
      }
   ],
   "fields":
      {
         "teamAccess": null
      }

}