REST Interface for BPEL-related Task Resources - Escalation Resource - GET Method

Use this method to retrieve an escalation of a human task instance.

Sample method invocation

GET /rest/bpm/htm/v1/escalation/{esiid}

Parameters

None

Request Content

None

Response Content

Escalation instance.

The default content-type is application/json.

MIME Type: application/json


Schema
{  "description": "Escalation", 
   "type": "object",
   "properties":
   {  "action": {"type": "string",
         "description": "Name of the action that is executed when the escalation occurs or that is executed when the escalation is repeated.",
         "enum":
         [ 
            "ACTION_CREATE_WORK_ITEM", 
            "ACTION_SEND_EMAIL", 
            "ACTION_CREATE_EVENT"
         ]  
      },
      "activationState": {"type": "string",
         "description": "The task state when this escalation was activated.",
         "enum":
         [ 
            "ACTIVATION_STATE_READY",
            "ACTIVATION_STATE_RUNNING",
            "ACTIVATION_STATE_CLAIMED", 
            "ACTIVATION_STATE_WAITING_FOR_SUBTASK"
         ]           
      },
      "activationTime": {"type": "string","format": "date-time",
         "description": "Time the escalation was activated."
      },
      "atLeastExpectedState": {"type": "string",
         "description": "The state of the associated task, that, if not reached when the escalation period runs out, triggers the escalation of this escalation instance."
      },
      "containmentContextID": {"type": "string",
         "description": "ID of the context the escalation belongs to."
      },
      "customProperties": {"type": "object", "additionalProperties": {"type": "string"},
         "description": "List of custom property names and values."
      },
      "description": {"type": "string",
         "description": "Description of the escalation."
      },
      "displayName": {"type": "string",
         "description": "Display name of the escalation."
      },
      "durationUntilEscalated": {"type": "string",
         "description": "Duration until this escalation is escalated or had been escalated."
      },
      "durationUntilRepeated": {"type": "string",
         "description": "Duration that is spent until the escalation is repeated provided that the at least expected task state is still not reached."
      },
      "escalationTime": {"type": "string", "format": "date-time",
         "description": "The time when this escalation is going to fire."
      },
      "esiid": {"type": "string",
         "description": "Escalation instance ID."
      },
      "firstEscalationID": {"type": "string",
         "description": "ID of the first escalation in this escalation chain."
      },
      "isDurationUntilEscalatedUpdateable": {"type": "boolean",
         "description": "Signals whether the duration until escalation property can be changed for the kind and current state of the object."
      },   
      "isDurationUntilRepeatedUpdateable": {"type": "boolean",
         "description": "Signals whether the duration until repeats property can be changed for the kind and current state of the object."
      },
      "isEscalationTimeUpdateable": {"type": "boolean",
         "description": "Signals whether the escalation time property can be changed for the kind and current state of the object."
      },   
      "isNameUpdateable": {"type": "boolean",
         "description": "Signals whether the name property can be changed for the kind and current state of the object."
      },      
      "nextEscalationID": {"type": "string",
         "description": "ID of the next escalation in this escalation chain."
      },
      "name": {"type": "string",
         "description": "Name of the escalation instance."
      },
      "previousEscalationID": {"type": "string",
         "description": "ID of the previous escalation in this escalation chain."
      },
      "priorityIncrease": {"type": "string",
         "description": "States how this escalation increases the priority of the associated task."
      },
      "escalationTemplateID": {"type": "string",
         "description": "ID of the escalation template this instance is derived from."
      },
      "state": {"type": "string",
         "description": "State of the escalation instance.",
         "enum":
         [
            "STATE_INACTIVE", 
            "STATE_WAITING", 
            "STATE_ESCALATED", 
            "STATE_SUPERFLUOUS"
         ]         
      },
      "taskInstanceID": {"type": "string",
         "description": "ID of the associated task instance."
      }
   }
}

Error Response Content

Detailed error information.

The default content-type is application/json.

MIME Type: application/json


Schema
{  "description": "Error Response", 
   "type": "object",
   "properties":
   {  "errorNumber": {"type": "string",
         "description": "Message ID of the exception."
      },
      "errorMessage": {"type": "string",
         "description": "Message text of the exception."
      },
      "errorMessageParameters": {"type": ["string"], "optional": true,
         "description":"Message text parameters of the exception."
      },
      "programmersDetails": {"type": "object", "optional": true,
         "description":"Additional, exception details, for example, a stack trace."
      }
   }
} 

Status codes

The method returns one of the following status codes:
CodeDescription
200 OKSuccess completion.
400 Bad RequestThe parameters are not valid or they are missing.
401 UnauthorizedThe caller is not authorized for this request.
404 Not Found
The escalation does not exist.
406 Not AcceptableThe requested content type or content encoding is not supported.
500 Internal Server ErrorA severe problem has occurred. Programmer's details are provided.

Available since

7.0

Parent topic: Escalation Resource