Contact UsGet started

Getting auto action parameters

Written by
Improved by
Updated at February 19, 2024

Use this request to get information about an auto action.

Request format

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

To get auto action parameters, use an HTTP GET request:

GET /v2/queues/<queue_ID_or_key>/autoactions/<autoaction_ID>
Host: https://api.tracker.yandex.net
Authorization: OAuth <OAuth_token>
X-Org-ID: <organization ID>
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
<queue_ID_or_key> Queue ID or key. The queue key is case-sensitive. String or number
<autoaction_ID> Auto action ID Number

Response format

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

The request body contains information about the auto action in JSON format.

{
  "id": 9,
  "self": "https://https://api.tracker.yandex.net/v2/queues/DESIGN/autoactions/9",
  "queue": {
      "self": "https://https://api.tracker.yandex.net/v2/queues/DESIGN",
      "id": "26",
      "key": "DESIGN",
      "display": "Design"
  },
  "name": "autoaction_name",
  "version": 4,
  "active": true,
  "created": "2021-04-15T04:49:44.802+0000",
  "updated": "2022-01-26T16:29:05.356+0000",
  "filter": {
      "priority": [
          "critical"
      ]
  },
  "actions": [
      {
          "type": "Transition",
          "id": 1,
          "status": {
              "self": "https://https://api.tracker.yandex.net/v2/statuses/2",
              "id": "2",
              "key": "needInfo",
              "display": "Need info"
          }
      }
  ],
  "enableNotifications": false,
  "lastLaunch": "2022-02-01T14:09:48.216+0000",
  "totalIssuesProcessed": 0,
  "intervalMillis": 3600000,
  "calendar": {
          "id": 2
      }    
}
Response parameters
Parameter Description Data type
id Auto action ID String
self Link to the auto action String
queue Queue where the auto action was created. Can be set as an object, a string (if the queue key is provided), or a number (if the queue ID is provided).
name Auto action name String
version Auto action version. Each change to the auto action increases the version number. Number
active Auto action status. Acceptable values include:
  • true: Active
  • false: Inactive
 Logical
created Auto action creation date and time in YYYY-MM-DDThh:mm:ss.sss±hhmm format String
updated Date and time of the auto action's last update in YYYY-MM-DDThh:mm:ss.sss±hhmm format String
filter Array with the issue field filtering conditions that will trigger the auto action Array of objects
query Query string for filtering issues String
actions Array of actions on issues Array of objects
enableNotifications Notification sending statuses. Acceptable values include:
  • true: Send.
  • false: Do not send.
 Logical
lastLaunch Date and time when the auto action was last triggered, in YYYY-MM-DDThh:mm:ss.sss±hhmm format String
totalIssuesProcessed Number of issues checked by the auto action when triggered last time Number
intervalMillis Auto action start frequency in milliseconds. The default value is 3600000 (once an hour). Number
calendar Period for which the auto action is active. It has the id parameter specifying the work schedule ID. Object

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

filter array object fields

Parameter Description Data type
filter Array with filtering conditions for issue fields.
Use the request to get the ID of the global or local field.		 Array of objects

actions array object fields

Parameter Description Data type
type Action type. Acceptable values include:
  • Transition: Change the issue status.
  • Update: Change a field value.
  • Event.comment-create: Add a comment.
  • Webhook: Send an HTTP request.
  • CalculateFormula: Calculate a value.
 String
id Action ID String
status Issue status String

status array object fields

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

If the request is processed incorrectly, the API returns a message with error details:

400
One or more request parameters have an invalid value.
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.
404
The requested object was not found. You may have specified an invalid object ID or key.
422
JSON validation error, the request is rejected.
500
Internal service error. Try resending your request in a few minutes.
503
The API service is temporarily unavailable.
Previous
Creating an auto action
Next
Creating triggers