Description
The request body for the endpoint /quality/conversations/{conversationId}/evaluations is being changed.
This list details all of the changes to the request body parameters:
Parameters
- Name:
name, Change: Removed - Name:
conversation, Change: Class change, now only includes the “id” parameter. e.g."conversation": { "id": "" } - Name:
evaluationForm, Change: Class change, now only includes the “id” parameter. e.g."evaluationForm": { "id": "" } - Name:
evaluator, Change: Class change, now only includes the “id” parameter. e.g.
"evaluator": { "id": "" } - Name:
agent, Change: Class change, now only includes the “id” parameter. e.g.
"agent": { "id": "" } - Name:
calibration, Change: Class change, now only includes the “id” parameter. e.g.
"calibration": { "id": "" } - Name:
status, Change: Unchanged - Name:
answers, Change: Unchanged - Name:
agentHasRead, Change: Unchanged - Name:
assignee, Change: Class change, now only includes the “id” parameter. e.g.
"assignee": { "id": "" } - Name:
assigneeApplicable, Change: Removed - Name:
releaseDate, Change: Unchanged - Name:
assignedDate, Change: Removed - Name:
changedDate, Change: Removed - Name:
revisionCreatedDate, Change: Removed - Name:
queue, Change: Class change, now only includes the “id” parameter. e.g.
"queue": { "id": "" } - Name:
mediaType, Change: Removed - Name:
rescore, Change: Unchanged - Name:
conversationDate, Change: Removed - Name:
conversationEndDate, Change: Removed - Name:
neverRelease, Change: Unchanged - Name:
assigned, Change: Removed - Name:
dateAssigneeChanged, Change: Unchanged - Name:
resourceId, Change: Removed - Name:
resourceType, Change: Unchanged - Name:
redacted, Change: Removed - Name:
agentTeam, Change: Removed - Name:
isScoringIndex, Change: Removed - Name:
authorizedActions, Change: Removed - Name:
hasAssistanceFailed, Change: Removed - Name:
declinedReview, Change: Removed - Name:
evaluationContextId, Change: Unchanged - Name:
retractedEvaluation, Change: Removed
In summary, the removed parameters are:
name, assigneeApplicable, assignedDate, changedDate, revisionCreatedDate, mediaType, conversationDate, assigned, resourceId, redacted, agentTeam, isScoringIndex, authorizedActions, hasAssistanceFailed, declinedReview, and retractedEvaluation.
And the changed parameters, reduced to just contain an id are:
conversation, evaluationForm, evaluator, agent, calibration, assignee, and queue
The removed parameters are not being used in the Quality backend, and all classes have been marked with @JsonIgnoreProperties(ignoreUnknown = true) so customers still sending these parameters should not notice the difference.
Change Category
API
Change Context
The documentation and schema for this endpoint seem to be copied from another endpoint, and it is not correct. We received a SERVOPS ticket regarding the correctness of the schema, and this is the update
Change Impact
Functionally, customers should notice no difference. All parameters of the request body that are being used in the Quality backend are the remaining parameters, and all extra parameters have been set to be ignored silently.
Date of Change
Feb 05, 2024
Impacted APIs
Request body schema changing: /quality/conversations/{conversationId}/evaluations
References
[QM-17149]