Bulk changes to entities

Use this request to quickly update multiple entities at once: goals, projects, or project portfolios.

POST

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

Query format

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

Use an HTTP POST request for bulk changes of multiple entities. In the request body, specify the parameters in JSON format.

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

{
   "metaEntities":[ "<entity_1_ID>","<entity_2_ID>", ...],
   "values":
   {
      "fields":
      {
         "<field_key>":"<value>",
         ...
      },
      "comment":"<comment>"
   }
}
Headers
  • Host: Address of the node that provides the API.

  • Authorization: Authorization token about these formats:

    • OAuth <OAuth_token>: For authorization using the OAuth 2.0 protocol. Learn more

    • Bearer <IAM_token>: For authorization using an IAM token, if a Yandex Cloud Organization organization is linked to Tracker. Learn more

  • X-Org-ID or X-Cloud-Org-ID: Organization ID.

    • Use the X-Org-ID header if a Tracker organization is linked to Yandex 360 for Business.

    • Use the X-Cloud-Org-ID header if a Tracker organization is linked to Yandex Cloud Organization.

    To get the organization ID, go to AdministrationOrganizations and copy the value from the ID field.

Resource
Parameter Description Data type
<entity_type> Entity type:
  • project
  • portfolio
  • goal
String
Request body parameters

Required parameters

Parameter Description Data type
metaEntities List of entity IDs. Array of strings
values Object with settings for bulk entity changes. Map item

values object fields

Parameter Description Data type
fields Object with key-value pairs. Map item
comment Comment String
links Array of objects with settings of links to other entities Array of objects

links array object fields

Parameter

Description

Data type

relationship

Link type. For projects and portfolios:

  • depends on: The current entity depends on the linked one.
  • is dependent by: The current entity blocks the linked one.
  • works towards: Project link to a goal.

For goals:

  • parent entity: Parent goal.
  • child entity: Subgoal.
  • depends on: The current goal depends on the linked one.
  • is dependent by: The current goal blocks the linked one.
  • is supported by: Link to a project.

String

entity

ID of the linked entity.

String

Example: Updating a status, assigning a follower, leaving a comment for multiple projects

  • An HTTP POST method is used.
  • The project status changes to At risk.
  • A follower is assigned.
  • A new record is added to project comments.
POST /v3/entities/project/bulkchange/_update HTTP/1.1
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>

{
   "metaEntities":[ "655f3be523db2132********","655f383923db2132********"],
   "values":
   {
      "fields":
      {
         "entityStatus":"at_risk",
         "followers":"agent007",
      },
      "comment":"The project is at risk"
   }
}

Response format

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

The response body contains information about the bulk request in JSON format.

{
   "id": "6560c6f59b0b1e76********",
   "self": "https://api.tracker.yandex.net/v3/bulkchange/6560c6f59b0b1e76********",
   "createdBy": { "self": "https://api.tracker.yandex.net/v3/users/11********", "id": "11********", "display": "Full name", "cloudUid": "ajevuhegoggf********", "passportUid": 11******** },
   "createdAt": "2023-11-24T15:53:25.122+0000",
   "status": "CREATED",
   "statusText": "Bulk change task created.",
   "executionChunkPercent": 0,
   "executionIssuePercent": 0
}
Response parameters
Parameter Description Data type
id Bulk request ID String
self Address of the API resource with information about the bulk request String
createdBy Block with information about the user who created the bulk request Map item
createdAt Entity creation date in YYYY-MM-DDThh:mm:ss.sss±hhmm format String
status Bulk request status String
statusText Interpretation of the bulk request status String

createdBy object fields

Parameter Description Data type
self Address of the API resource with information about the user String
id User ID. String
display Displayed user name String
passportUid Unique ID of the user account in the Yandex 360 for Business organization and Yandex ID. Number
cloudUid Unique user ID in Yandex Cloud Organization 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 is not authorized. Make sure that actions described in the API access section are performed.
403
You are not authorized 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
A conflict occurred while 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.