Entity - Response Errors

Page version: 22, last updated:



Note for API version 8.0

As of API version 8.0Tachyon implements changes in the accessibility of instructions and their responses with the goal of enabling delegation of administration. The delegated user is supposed to only manage a subset of endpoints, which are specified by means of Management Groups. The delegated administrator should only be able to see information related to his or her Management Groups, and not anything else in the organization. From the point of view of the Responses or Response Error APIs, this implies that the user is not allowed to see the responses for any instructions whose set of results might potentially contain responses from endpoints that should be invisible to the user. This is done transparently by the APIs unless otherwise noted, i.e., the API is called in the normal way as in previous versions, but an error will be returned if the specified instruction is not accessible to the invoking user. Emphasis is done on "potentially", meaning that the system does not check whether the set of responses actually contains any response coming from a "forbidden" device, since this would be too costly at runtime. Instead, the system checks which management groups are accessible to the user who sent the instruction, and if this list contains any management group not accessible to the user who queries the responses, then the request is rejected (even if no response was actually received from devices in the forbidden management groups or if the Scope of the instruction prevented such devices from responding).

For this purpose, the system uses the current Management Groups assigned to each user, not the Management Groups that the users could access back at the time when the instruction was submitted.


These are most often returned when there are no responses from an agent.  There may be other scenarios if an agent is an error state.

VerbRequestNotesPermissions required
POST/Consumer/ResponseErrors/{instructionId}

Allows fetching error responses.

Example Request
{ 
   "Filter":null,
   "PageSize":20,
   "Start":"0;0"
}
  • Filter - filter expression. If null then no filter is applied.To learn about how to define filter check Using scope and filter expressions page.
  • Start - starting index to support pagination. For the first page it has to be 0;0 and for the subsequent page it has to be the value returned as Range property from previous page request. Please check the example response below.
  • Pagesize - number of results to fetch
Example Response
{
  "Range": "MTsy",
  "Responses": [
    {
      ...
    }
  ]
}
  • Viewer
  • Questioner
  • Actioner
  • Approver

Instruction's owner can also view responses.

Returns Unauthorized (401) if user does not have the required permissions at global level or on the parent InstructionDefinition's product pack or is not the owner.

POST/Consumer/ResponseErrors/{instructionId}/Aggregate

Allows fetching error responses.

Example Request
{ 
   "Filter":null,
   "PageSize":20
}
  • Filter - filter expression. If null then no filter is applied.To learn about how to define filter check Using scope and filter expressions page.
  • Pagesize - number of results to fetch
  • Viewer
  • Questioner
  • Actioner
  • Approver

Instruction's owner can also view responses.

Returns Unauthorized (401) if user does not have the required permissions at global level or on the parent InstructionDefinition's product pack or is not the owner.

POST/Consumer/ResponseErrors/{instructionId}/UniqueFQDNs

Returns the list of distinct FQDNs that are present in the Errors table for the specified instruction.

It is invoked with the same parameters as the "Aggregate" API above.

Returns an array of strings containing the FQDNs.

  • Viewer
  • Questioner
  • Actioner
  • Approver

Instruction's owner can also view responses.

Returns Unauthorized (401) if user does not have the required permissions at global level or on the parent InstructionDefinition's product pack or is not the owner.