Update an assessment answer
patch
/crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/Assessment/{AssessmentId}/child/AssessAnswerGroups/{AssessAnswerGroupId}/child/AssessmentAnswer/{AnswerId}
Request
Path Parameters
-
AnswerId(required): integer(int64)
The unique identifier of the assessments associated with answer.
-
AssessAnswerGroupId(required): integer(int64)
The unique identifier of the answer group.
-
AssessmentId(required): integer(int64)
The unique identifier of an assessment.
-
CompanyNumber(required): string
The alternate key identifier of the partner's company.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : schema
Type:
Show Source
object
-
Answered: string
Indicates if the question is answered or not.
-
AnswerId: integer
(int64)
The unique identifier of the assessments associated with answer.
-
AttributeValueId: integer
(int64)
Title:
Response
The unique identifier of the response. -
Comments: string
Title:
Comments
Maximum Length:1500
The assessment runtime comments entered by end user. -
HasComments: string
Indicates if the comments are present or not.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : partners-Assessment-AssessAnswerGroups-AssessmentAnswer-item-response
Type:
Show Source
object
-
Answered: string
Indicates if the question is answered or not.
-
AnswerId: integer
(int64)
The unique identifier of the assessments associated with answer.
-
AssessmentId: integer
(int64)
The unique identifier of the assessment answer.
-
AttributeGroupId: integer
(int64)
Title:
Question Group
The unique identifier of the question group associated with assessment answer. -
AttributeId: integer
(int64)
Title:
Question
The unique identifier of the question associated with assessment answer. -
AttributeName: string
Read Only:
true
Maximum Length:500
The name of the question. -
AttributeValueId: integer
(int64)
Title:
Response
The unique identifier of the response. -
Comments: string
Title:
Comments
Maximum Length:1500
The assessment runtime comments entered by end user. -
HasComments: string
Indicates if the comments are present or not.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ResponseValue: string
Title:
Response
Read Only:true
The response to the question.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.