DescribeEvaluationForm
Describes an evaluation form in the specified Amazon Connect instance. If the version property is not provided, the latest version of the evaluation form is described.
Request Syntax
GET /evaluation-forms/InstanceId/EvaluationFormId?version=EvaluationFormVersion HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- EvaluationFormId
-
A unique identifier for the contact evaluation.
Length Constraints: Minimum length of 1. Maximum length of 500.
Required: Yes
- EvaluationFormVersion
-
A version of the evaluation form.
Valid Range: Minimum value of 1.
- InstanceId
-
The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"EvaluationForm": {
"CreatedBy": "string",
"CreatedTime": number,
"Description": "string",
"EvaluationFormArn": "string",
"EvaluationFormId": "string",
"EvaluationFormVersion": number,
"Items": [
{ ... }
],
"LastModifiedBy": "string",
"LastModifiedTime": number,
"Locked": boolean,
"ScoringStrategy": {
"Mode": "string",
"Status": "string"
},
"Status": "string",
"Tags": {
"string" : "string"
},
"Title": "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- EvaluationForm
-
Information about the evaluation form.
Type: EvaluationForm object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceException
-
Request processing failed because of an error or failure with the service.
HTTP Status Code: 500
- InvalidParameterException
-
One or more of the specified parameters are not valid.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 404
- ThrottlingException
-
The throttling limit has been exceeded.
HTTP Status Code: 429
Examples
Example
The following example describes version 1 of an evaluation form.
Sample Request
{
"InstanceId": "[instance_id]",
"EvaluationFormId": "[evaluation_form_id]",
"EvaluationFormVersion": 1
}Sample Response
{
"EvaluationForm": {
"EvaluationFormId": "[evaluation_form_id]",
"EvaluationFormVersion": 1,
"Locked": false,
"EvaluationFormArn": "arn:aws:connect:[aws_region_code]:[account_id]:instance/[instance_id]/evaluation-form/[evaluation_form_id]",
"Title": "form-title",
"Description": "form-description",
"Status": "DRAFT",
"Items": [
{
"Section": {
"Title": "section-title-1",
"RefId": "section-1",
"Instructions": "section-instruction-1",
"Items": [
{
"Question": {
"Title": "question-title-11",
"Instructions": "question-instructions",
"RefId": "question-1-111",
"NotApplicableEnabled": false,
"QuestionType": "TEXT"
}
},
{
"Question": {
"Title": "question-title-12",
"RefId": "question-1-222",
"NotApplicableEnabled": false,
"QuestionType": "SINGLESELECT",
"QuestionTypeProperties": {
"SingleSelect": {
"Options": [
{
"RefId": "option-1-2-1",
"Text": "first-option",
"Score": 1,
"AutomaticFail": true
},
{
"RefId": "option-1-2-2",
"Text": "second-option",
"Score": 1,
"AutomaticFail": false
},
{
"RefId": "option-1-2-3",
"Text": "third-option",
"Score": 1,
"AutomaticFail": true
}
],
"DisplayAs": "DROPDOWN",
"Automation": {
"Options": [
{
"RuleCategory": {
"Category": "CATEGORY_LABEL",
"Condition": "PRESENT",
"OptionRefId": "option-1-2-2"
}
}
],
"DefaultOptionRefId": "option-1-2-1"
}
}
}
}
}
],
"Weight": 50
}
},
{
"Section": {
"Title": "section-title-2",
"RefId": "section-2",
"Instructions": "section-instruction-2",
"Items": [
{
"Question": {
"Title": "question-title-21",
"RefId": "question-2-1",
"NotApplicableEnabled": true,
"QuestionType": "TEXT"
}
},
{
"Question": {
"Title": "question-title-2-2",
"RefId": "question-2-222",
"QuestionType": "NUMERIC",
"QuestionTypeProperties": {
"Numeric": {
"MinValue": 0,
"MaxValue": 28800,
"Options": [
{
"MinValue": 0,
"MaxValue": 28800,
"Score": 1,
"AutomaticFail": false
}
],
"Automation": {
"PropertyValue": {
"Label": "AGENT_INTERACTION_DURATION"
}
}
}
}
}
}
],
"Weight": 50
}
}
],
"ScoringStrategy": {
"Mode": "SECTION_ONLY",
"Status": "ENABLED"
},
"CreatedTime": "2023-05-04T00:24:01.490000-07:00",
"CreatedBy": "arn:aws:sts::[account_id]:assumed-role/Admin/username",
"LastModifiedTime": "2023-05-04T00:24:01.490000-07:00",
"LastModifiedBy": "arn:aws:sts::[account_id]:assumed-role/Admin/username",
"Tags": {}
}
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
