Getting a macro

Use this request to get macro parameters.

GET

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

Query format

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

To get macro parameters, use an HTTP GET request:

GET /v3/queues/<queue_ID>/macros/<macro_ID>
Host: api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID or X-Cloud-Org-ID: <organization_ID>
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
<macro_ID> Macro ID. String

Response format

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

The response body contains a JSON object with macro parameters.

{
    "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}}",
    "fieldChanges": [
      {
        "field": {
           "self": "https://api.tracker.yandex.net/v3/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. Map item
name Macro name. String
body Message to be created when the macro runs. in <message_text>\n<variable> format.
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

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

fieldChanges array objects

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

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.
500
Internal service error. Try again later.
503
The API service is temporarily unavailable.
Previous
Getting queue macros
Next
Creating a macro