REST Interface for BPEL-related Task Resources - Escalation Resource - PUT (Update) Method

Use this method to update the properties of an escalation.

Sample method invocation

PUT /rest/bpm/htm/v1/escalation/{esiid}?action={string}

Parameters

Required Parameters

Name

Value Type

Description

action

string

Action to be performed for the specified escalation.

Value	Description
update	Change escalation properties.

Request Content

Escalation details to be updated.

The default content-type is application/json.

MIME Type: application/json

Schema

{  "description": "Escalation Update", 
   "type": "object",
   "properties":
   {  "customProperties": { "type": "object", "optional": true, "additionalProperties": {"type": "string"},
         "description": "List of custom property names and values."
      },
      "durationUntilEscalated": {"type": "string", "optional": true,
         "description": "Duration until this escalation is escalated or had been escalated."
      },
      "durationUntilRepeated": {"type": "string", "optional": true,
         "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", "optional": true,
         "description": "The time when this escalation is going to fire."
      },
      "name": {"type": "string", "optional": true,
         "description": "Name of the escalation instance."
      }
   }
}

Response Content

None

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:

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.
403 Forbidden	The caller is not allowed to complete this request.
404 Not Found	The escalation does not exist.
409 Conflict	One or more properties of the escalation cannot be updated in this state.
415 Unsupported Media Type	The content type or content encoding of the request is not supported.
500 Internal Server Error	A severe problem has occurred. Programmer's details are provided.

Available since

7.0

Parent topic: Escalation Resource