Contact UsGet started
© 2024 Iron Hive LLC Belgrade

Updating an entity

Written by
Updated at May 6, 2024

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

The request is a unified method for updating project and portfolio information, more flexible and functional than the update project information API.

Request format

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

To update an entity, use an HTTP PATCH request. Request parameters are provided in the request body in JSON format.

PATCH /v2/entities/<entity_type>/<entity_ID>
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>

{
   "fields":
   {
      "summary": "<new_name>",
      "teamAcceess": true
   },
   "comment": "<comment>",
   "links":
   [
      {
         "relationship": "<link>",
         "entity": "<linked_entity_ID>"
      }
   ],
   "attachmentIds":
   [
      "<ID_of_temporary_file_1>",
      "<ID_of_temporary_file_2>",
      ...
   ],
   "descriptionAttachmentIds":
   [
      "<ID_of_temporary_file_3>",
      "<ID_of_temporary_file_4>",
      ...
   ]
}
Headers

  • Host

    Address of the node that provides the API:

    https://api.tracker.yandex.net

  • Authorization

    OAuth token in OAuth <OAuth_token> format, e.g.:

    OAuth 0c4181a7c2cf4521964a72ff********

  • X-Org-ID or X-Cloud-Org-ID

    Organization ID. You can find it out on the Tracker organizations page.

    • If a Yandex 360 for Business organization is the only one linked to Tracker, the X-Org-ID header is used.
    • If a Yandex Cloud Organization organization is the only one linked to Tracker, the X-Cloud-Org-ID header is used.
    • If both Yandex 360 for Business and Yandex Cloud Organization organizations are linked to Tracker at the same time, the X-Org-ID header and the Yandex 360 for Business organization ID are used.
Resource
Parameter Description Data type
<entity_type> Entity type:
  • Project for a project
  • Portfolio for a portfolio
 String
<entity_ID> Entity ID. To get the ID, see the entity list. String
<project_or_portfolio_ID> Project or portfolio ID (the shortId value). You can use it instead of the entity ID in the request. String

Warning

Entity ID is not the same as project or portfolio ID.

Request parameters

Additional parameters

Parameter Description Data type
fields Additional entity fields to include in the response String
expand Additional information to include in the response:
  • attachments: Attached files
 String
Request body parameters

Additional parameters

Parameter Description Data type
fields Object with entity settings Object
comment Comment String
links Array of objects with settings of links to other entities Array of objects
attachmentIds Array of IDs of temporary files preloaded into Tracker. The listed files will be attached to the entity and displayed in the Attachments tab. Array of strings
descriptionAttachmentIds Array of IDs of temporary files preloaded into Tracker. The listed files will be attached to the entity and displayed in the About project or About portfolio tab. Array of strings

fields object fields

Parameter Description Data type
summary Name (required field) String
queues Queue (required for projects if the teamAccess field is not set) String
teamAccess Access (required for projects if the queues field is not set) Boolean
description Description String
author Author (user ID) Number
lead Responsible person (user ID) Number
teamUsers Participants (array of user IDs) Array of numbers
clients Customers (array of user IDs) Array of numbers
followers Followers (array of user IDs) Array of numbers
start Start date in YYYY-MM-DDThh:mm:ss.sss±hhmm format Date
end Deadline in YYYY-MM-DDThh:mm:ss.sss±hhmm format Date
tags Tags Array of strings
parentEntity Parent entity (portfolio) ID Number
entityStatus Status:
  • draft: Draft
  • in_progress: In progress
  • launched: New
  • postponed: Postponed
  • at_risk: At risk
  • blocked: Blocked
  • according_to_plan: According to plan
 String

links array object fields

Parameter Description Data type
relationship Link type, e.g.:
  • relates
  • is dependent by
  • depends on
.		 String
entity Linked entity's ID String

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 /v2/entities/project/655f8cc523db213********?expand=attachments HTTP/1.1
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>

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

Example 2: Attaching files to a project description

  • An HTTP PATCH method is used.
  • First, upload the temporary files and specify their IDs.
  • Temporary files will be attached to the project description.
PATCH /v2/entities/project/655f8cc523db213********?expand=attachments HTTP/1.1
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>

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

Response format

If the request is successful, the API returns a response with code 200 OK.

The response body contains information about the updated entity in JSON format.

{
   "self": "https://https://api.tracker.yandex.net/v2/entities/project/655f328da834c763********",
   "id": "655f328da834c763********",
   "version": 3,
   "shortId": 2,
   "entityType": "project",
   "createdBy": { "self": "https://https://api.tracker.yandex.net/v2/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://https://api.tracker.yandex.net/v2/attachments/8",
         "id": "8",
         "name": "file1.docx",
         "content": "https://api.tracker.yandex.net/v2/attachments/8/file1.docx",
         "createdBy": { "self": "https://https://api.tracker.yandex.net/v2/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://https://api.tracker.yandex.net/v2/attachments/9",
         "id": "9",
         "name": "file2.pdf",
         "content": "https://api.tracker.yandex.net/v2/attachments/9/file2.pdf",
         "createdBy": { "self": "https://https://api.tracker.yandex.net/v2/users/11********", "id": "11********", "display": "Full Name", "cloudUid": "ajevuhegoggf********", "passportUid": 11******** },
         "createdAt": "2023-11-23T15:46:25.932+0000",
         "mimetype": "application/pdf",
         "size": 175656
      }
   ]
}
Response parameters
Parameter Description Data type
self Address of the API resource with information about the project String
id Entity ID String
version Project version. Each change of the parameters increases the version number. Number
shortId Project or portfolio ID String
entityType Entity type String
createdBy Block with information about the entity creator Object
createdAt Entity creation date in YYYY-MM-DDThh:mm:ss.sss±hhmm format String
updatedAt Date when the entity was last updated, in YYYY-MM-DDThh:mm:ss.sss±hhmm format String
attachments Array of objects with information about the attachment Array of objects

createdBy object fields

Parameter Description Data type
self Address of the API resource with information about the entity creator String
id User ID Number
display Displayed user name String
cloudUid Unique user ID in Yandex Cloud Organization String
passportUid Unique ID of the user account in the Yandex 360 for Business organization and Yandex ID String

If the request is processed incorrectly, the API returns a response with an error code:

400
One or more request parameters have an invalid value.
401
The user isn't authorized. Make sure to perform the actions described in API access.
403
Insufficient rights to perform this action. You can check what rights you have in the Tracker interface. The same rights are required to perform an action via the API and interface.
412
There was a conflict when editing the object. The error may be due to an invalid update version.
428
Access to the resource is denied. Make sure all required conditions for the request are specified.
Previous
Getting entity parameters
Next
Deleting an entity