Work Item Hold

This synchronous Integration Point (IP) allows a user to place a work item on hold.

Request

This API supports the following POST operation:

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

Payload

{
  "holdTypeCode": "",
  "noteText": ""
}
id

Unique identifier of the work item to be placed on hold. Required.

holdTypeCode

Code identifying the hold type. Required. String.

noteText

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

Details

A work item cannot be placed on 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 currently on hold (IND_HOLD = Y).

After successful validation, the IP performs the following updates.

Work Item Record and History

  • IND_HOLD is set to Y. HOLD_TYPE is set to the supplied holdTypeCode on the work item record.

  • A new entry is created in the Work Item Hold History with start time, held-by user, hold type, and a reference to the work item history entry written at the point the hold was placed.

  • 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 Hold 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.hold 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-016

User {userId} is not authorized to place this work item on hold.

OHI-IP-WTSK-017

Work item {workitemId} is already on hold.

OHI-IP-WTSK-018

Hold Type {holdTypeCode} is unknown

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