Creating a macro

Use this request to create a macro.

POST

https://api.tracker.yandex.net/v3/queues/<queue_ID>/macros

Query format

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

To create a macro, use an HTTP POST request:

POST /v3/queues/<queue_ID>/macros
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>

{
  "name": "<macro_name>",
  "body": "<comment_text>\n{{currentDateTime}}\n{{issue.author}}",
  "issueUpdate": {
       "description": "New issue",
       "tags": { "add": "New tag" },
       "resolution": null
   }
}
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 Administration → Organizations and copy the value from the ID field.

Resource
Parameter Description Data type
<queue_ID> Queue ID or key. The queue key is case-sensitive. String
Request body parameters

Required parameters

Parameter Value Data type
name Macro name. String

Additional parameters

Parameter Description Data type
body Message to be created when executing the macro. Use the formatting rules for the message text.
To delete a message, use "body": {"unset":1}		 String
issueUpdate Object with a list of issue fields that you want to change. Full list of issue fields

To clear the field, specify the null value.
You can also use the set, add, and remove operators (see Editing parameters)		 Object

Response format

If the request is successful, the API returns a response with code 201 Created.

The response body contains a JSON object with the parameters of the created macro.

  {
    "self": "https://api.tracker.yandex.net/v3/queues/TEST/macros/3",
    "id": 3,
    "queue": {
      "self": "https://api.tracker.yandex.net/v3/queues/TEST",
      "id": "1",
      "key": "TEST",
      "display": "Test queue"
       },
    "name": "Test macro",
    "body": "Test comment\n{{currentDateTime}}\n{{issue.author}}",
    "issueUpdate": [
      {
        "field": {
           "self": "https://api.tracker.yandex.net/v3/fields/tags",
           "id": "tags",
           "display": "Tags"
          },
        "update": {
            "add": ["tag 1", "tag 2"]
        }
      },
       ...
    ]
  }
Response parameters
Parameter Description Data type
self Address of the API resource with macro parameters. String
id Macro ID. Number
queue Object with information about the queue whose issues that the macro is applied to. Map item
name Macro name. String
body Message to be created when executing the macro. String
issueUpdate Array with information about the issue fields that the macro will trigger changes to. Array of objects

queue object fields

Parameter Description Data type
self Address of the API resource with information about the queue. String
id Queue ID. String
key Queue key. String
display Queue name displayed. String

issueUpdate array objects

Parameter Description Data type
field Object with information about the issue field. Map item
update Object with information about the issue field update. Object

field object fields

Parameter Description Data type
self Address of the API resource with information about the issue field. String
id Issue field ID. String
display Issue field name displayed. 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.
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.
404
The requested object was not found. You may have specified an invalid object ID or key.
409
There was a conflict when editing the object. The error may be due to an invalid update version.
500
Internal service error. Try again later.
503
The API service is temporarily unavailable.
Previous
Getting a macro
Next
Editing a macro