Respond to Feedback

This synchronous Integration Point (IP) allows the designated feedback assignee to provide a response to a feedback request raised on a work item.

Request

This API supports the following POST operation:

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

Payload

{
  "noteText": ""
}
id

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

noteText

The response text to be sent back to the user who raised the feedback request. Required. String.

Details

A feedback response cannot be submitted under any of the following conditions:

  • The work item is not in Awaiting Feedback status.

  • The responding user is not the feedback assignee recorded on the work item.

After successful validation, the IP performs the following updates.

Work Item Record and History

  • The Feedback Assignee field on the work item record is cleared, or set to null.

  • 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 source set to Respond Feedback Remark.

  • For more information, see Note Creation.

Notification

  • On successful feedback response, 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.respondfeedback IP.

Response Messages

Failure

Code Description

OHI-IP-WTSK-001

Work item {workitemId} is unknown.

OHI-IP-WTSK-019

The note is missing.

OHI-IP-WTSK-021

The responding user is not the feedback assignee recorded on work item {workitemId}.

OHI-IP-WTSK-022

Work item {workitemId} is not in Awaiting Feedback status.

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