GET /rest/bpm/htm/v1/task/{tkiid}/escalationInfoNone
None
The default content-type is application/json.
{ "description": "Escalation Info",
"type": "object",
"properties":
{ "escalationInfo":
[
{ "activationState": {"type": "string",
"description": "The task state when this escalation chain was activated.",
"enum":
[
"ACTIVATION_STATE_READY",
"ACTIVATION_STATE_RUNNING",
"ACTIVATION_STATE_CLAIMED",
"ACTIVATION_STATE_WAITING_FOR_SUBTASK"
]
},
"escalationChains":
[
{ "escalationChain":
[
{ "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."
},
"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."
},
"escalationTemplateID": {"type": "string",
"description": "ID of the escalation template this instance is derived from."
},
"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."
},
"name": {"type": "string",
"description": "Name of the escalation instance."
},
"nextEscalationID": {"type": "string",
"description": "ID of the next escalation in this escalation chain."
},
"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."
},
"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."
}
}
]
}
]
}
]
},
"tkiid": {"type": "string",
"description": "Task instance ID."
}
}
The default content-type is application/json.
{ "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."
}
}
}
| Code | Description |
|---|---|
| 200 OK | Success completion. |
| 400 Bad Request | The parameters are not valid or they are missing. |
| 401 Unauthorized | The caller is not authorized for this request. |
| 404 Not Found | Task escalation information does not exist.
|
| 406 Not Acceptable | The requested content type or content encoding is not supported. |
| 500 Internal Server Error | A severe problem has occurred. Programmer's details are provided. |
7.0
Parent topic: Task Escalation Info Resource