Work Item Hold Release

This synchronous Integration Point (IP) allows a user to release a work item from hold.

Request

This API supports the following POST operation:

POST http://[hostName]:[portNumber]/[api-context-root]/workitems/{id}/release

Payload

{
  "noteText": ""
}

id

Unique identifier of the work item to be released from hold. Required.

noteText

Remark text to record against the work item alongside the release. Optional. String.

Details

A work item cannot be released from hold under any of the following conditions:

• The work item is in done status.

• The requesting user does not hold the Queue Admin role or is not the user currently assigned to the work item.

• The work item is not currently on hold (IND_HOLD = N).

After successful validation, the IP performs the following updates.

Work Item Record and History

• IND_HOLD is set to N and HOLD_TYPE is cleared on the work item record.

• The existing Work Item Hold History entry is updated with the hold end time, the released-by user, and a reference to the work item history entry written at the point the hold was released.

• For more information, see Work Item History.

Note Creation

• If noteText is supplied, a note is created against the work item’s parent record (claim, authorization, or policy) with note type set to Release Remark.

• For more information, see Note Creation.

Response

HTTP 200 (OK) on successful completion of the operation.

Authorization

This IP requires a grant for access restriction workitems.release IP.

Response Messages

Failure

Code	Description
OHI-IP-WTSK-001	Work item {workitemId} is unknown.
OHI-IP-WTSK-002	Work item {workitemId} is in Done status and cannot be updated.
OHI-IP-WTSK-013	User {userId} is not authorized to release this work item from hold.
OHI-IP-WTSK-012	Work item {workitemId} is not currently on hold and cannot be released.

The response can also contain generic error messages not specific to this web service. For more information, see Response Messages.