Request Feedback

This synchronous Integration Point (IP) allows a user to raise a feedback request on a work item.

Request

This API supports the following POST operation:

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

Payload

{
  "assigneeUserId": "",
  "noteText": ""
}
id

Unique identifier of the work item on which feedback is being requested. Required.

assigneeUserId

User ID of the OHI user to whom the feedback request is directed. Required. Long.

noteText

The query text to be sent to the feedback recipient. Required. String.

Details

A feedback request cannot be raised under any of the following conditions:

  • The work item is in any status other than In Progress or Open.

  • The requesting user is not the assignee or does not hold Queue Admin access role for the work item’s queue.

  • The assigneeUserId does not resolve to a known active OHI user.

  • The assigneeUserId is the same as the requesting user. Feedback cannot be directed to oneself.

After successful validation:

Work Item Record and History

  • The work item status is updated to Awaiting Feedback.

  • The Feedback Assignee field on the work item record is set to the assigneeUserId supplied in the request.

  • A new work item history entry is created. For more information, see Work Item History.

Note Creation

  • The noteText supplied in the request is added against the work item’s parent record authorization with note type set to Feedback Request Remark.

  • For more information, see Note Creation.

Notification

  • On successful feedback request, a notification is generated and delivered to the configured endpoint.

  • Endpoint resolution and notification mechanics follow the pattern described in Work Item Notification.

Response

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

Authorization

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

Response Messages

Failure

Code Description

OHI-IP-WTSK-001

Work item {workitemId} is unknown.

OHI-IP-WTSK-014

Assignee is missing or unknown.

OHI-IP-WTSK-024

User {userId} is not authorized to request feedback on work item {workitemId}.

OHI-IP-WTSK-023

Feedback cannot be directed to the same requesting user.

OHI-IP-WTSK-019

The note is missing.

OHI-IP-WTSK-020

Feedback can only be requested on work items in In Progress or Open status.

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