Entity - Response Errors

Page version: 21, last updated:


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.