Get started
Yandex Tracker

Get a macro

Written by

Use this request to get macro parameters.

Request format

To get macro parameters, use an HTTP GET request:

GET /v2/queues/<queue-id>/macros/<macros-id>
Host: https://api.tracker.yandex.net
Authorization: OAuth <token>
X-Org-ID: <organization ID>

Resource

  • <queue-id>
    Queue ID or key. Queue key is case-sensitive.

  • <macros-id>
    Macro ID.

Headers

  • Host
    Address of the node that provides the API:

    https://api.tracker.yandex.net

  • Authorization
    OAuth token in OAuth <token value> format, such as:

    OAuth 0c4181a7c2cf4521964a72ff57a34a07

  • X-Org-ID
    Organization ID.

Response format

If the request is successful, the API returns a response with code 200. The response body contains a JSON object with macro parameters.

{
    "self": "https://api.tracker.yandex.net/v2/queues/TEST/macros/3",
    "id": 3,
    "queue": {
      "self": "https://api.tracker.yandex.net/v2/queues/TEST", 
      "id": "1",
      "key": "TEST",
      "display": "Test queue"
       },
    "name": "Test macro",
    "body": "Test comment\n{{currentDateTime}}\n{{issue.author}}",
    "fieldChanges": [
      {
        "field": {
           "self": "https://api.tracker.yandex.net/v2/fields/tags", 
           "id": "tags",
           "display": "Tags"
          },
        "value": [
                "tag1", "tag2"
                 ]
      },
       ...
    ]
  }

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. Object
name Macro name. String
body Message to be created when executing the macro. Format: <Message text>\n<variable>
where:
  • <Message text>: Text to be created in the Comment field when executing the macro.
  • \n: Line break symbol.
  • Variable that may contain:
    {{currentUser}}: Name of the user who ran the macro.
    {{currentDateTime.date}}: Macro execution date.
    {{currentDateTime}}: Macro execution date and time.
    {{issue.<field_key>}}: Key of the issue field whose value will be displayed in the message. Full list of issue fields: https://tracker.yandex.ru/admin/fields
To delete the message, use the construction "body": {"unset":1}		 String
fieldChanges Array with information about the issue fields that the macro will trigger changes to. Array of objects

Object fields queue

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

Array objects fieldChanges

Parameter Description Data type
field Object with information about the issue field. Object
value Array with issue field values. Array of objects

Object fields field

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 response contains error details:

HTTP error code Error description
400 Bad Request One of the request parameters has an invalid value or data format.
403 Forbidden The user or application has no access rights to the resource, the request is rejected.
404 Not Found The requested resource was not found.
500 Internal Server Error Internal service error. Try again later.
503 Service Unavailable The API service is temporarily unavailable.
In this article: