Create an assessment
post
/crmRestApi/resources/11.13.18.05/partners/{CompanyNumber}/child/Assessment
Request
Path Parameters
-
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.
-
Upsert-Mode:
When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.
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
-
AssessAnswerGroups: array
Assessment Answer Groups
Title:
Assessment Answer Groups
The assessment answer groups resource is used to view and update the question groups in an assessment. -
AssessedLanguage: string
Title:
Assessment Language
Maximum Length:4
Default Value:US
The language of the assessment. -
AssessedObjectId(required): integer
(int64)
Title:
Assessed Object ID
The unique identifier of the assessed business object. -
AssessedObjTypeCode(required): string
Title:
Object Type Code
Maximum Length:30
The code indicating the type of the assessed business object. -
AssessmentId: integer
(int64)
Title:
Assessment ID
The unique identifier of an assessment. -
AssessmentScore: integer
(int64)
Title:
Score
Default Value:0
The calculated score of assessment. -
AssessTemplateId(required): integer
(int64)
Title:
Template Name
The unique identifier of the assessment template that served as the source of this assessment. -
BusinessUnit: integer
(int64)
Title:
Business Unit
The name of the business unit passed when creating an assessment, and corresponds to the business unit of the business object. -
ConflictId: integer
(int64)
Title:
Conflict ID
Default Value:0
The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server. -
Name(required): string
Title:
Name
Maximum Length:255
The name of the assessment. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:INCOMPLETE
The code indicating the valid status of the assessment. The valid values are IN_PROGRESS and COMPLETE. -
TemplateName: string
Title:
Template
The name of the assessment template. -
TemplateType: string
Title:
Template Type
The type of the assessment template associated with the assessment. -
TotalAnswered: number
Title:
Total Questions Answered
The number of questions answered in the assessment. -
TotalQuestions: number
Title:
Total Questions
The total number of questions to be answered in the assessment.
Nested Schema : Assessment Answer Groups
Type:
array
Title:
Assessment Answer Groups
The assessment answer groups resource is used to view and update the question groups in an assessment.
Show Source
Nested Schema : partners-Assessment-AssessAnswerGroups-item-post-request
Type:
Show Source
object
-
AssessAnswerGroupId: integer
(int64)
The unique identifier of the answer group.
-
AssessmentAnswer: array
AssessmentAnswer
-
AssessmentId(required): integer
(int64)
The unique identifier of the assessment associated with answer group.
-
AttributeGroupId(required): integer
(int64)
The unique identifier of the question group of the associated template.
Nested Schema : partners-Assessment-AssessAnswerGroups-AssessmentAnswer-item-post-request
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. -
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-item-response
Type:
Show Source
object
-
AssessAnswerGroups: array
Assessment Answer Groups
Title:
Assessment Answer Groups
The assessment answer groups resource is used to view and update the question groups in an assessment. -
AssessedLanguage: string
Title:
Assessment Language
Maximum Length:4
Default Value:US
The language of the assessment. -
AssessedObjectId: integer
(int64)
Title:
Assessed Object ID
The unique identifier of the assessed business object. -
AssessedObjTypeCode: string
Title:
Object Type Code
Maximum Length:30
The code indicating the type of the assessed business object. -
AssessmentId: integer
(int64)
Title:
Assessment ID
The unique identifier of an assessment. -
AssessmentScore: integer
(int64)
Title:
Score
Default Value:0
The calculated score of assessment. -
AssessTemplateId: integer
(int64)
Title:
Template Name
The unique identifier of the assessment template that served as the source of this assessment. -
BusinessUnit: integer
(int64)
Title:
Business Unit
The name of the business unit passed when creating an assessment, and corresponds to the business unit of the business object. -
ConflictId: integer
(int64)
Title:
Conflict ID
Default Value:0
The value used to guarantee the uniqueness of the row when duplicates are created in different databases in case of a disconnected mobile such as mobile databases, or the server. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the assessment record. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the assessment record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the assessment record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:255
The name of the assessment. -
RatingFeedback: string
Title:
Feedback
Read Only:true
The feedback mapped to the rating. -
RatingTerm: string
Title:
Rating
Read Only:true
The overall rating of the assessment as configured in the associated assessment template. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:INCOMPLETE
The code indicating the valid status of the assessment. The valid values are IN_PROGRESS and COMPLETE. -
StatusFuse: string
Title:
Status
Read Only:true
The status of the assessment. -
TemplateName: string
Title:
Template
The name of the assessment template. -
TemplateType: string
Title:
Template Type
The type of the assessment template associated with the assessment. -
TotalAnswered: number
Title:
Total Questions Answered
The number of questions answered in the assessment. -
TotalQuestions: number
Title:
Total Questions
The total number of questions to be answered in the assessment.
Nested Schema : Assessment Answer Groups
Type:
array
Title:
Assessment Answer Groups
The assessment answer groups resource is used to view and update the question groups in an assessment.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : partners-Assessment-AssessAnswerGroups-item-response
Type:
Show Source
object
-
AssessAnswerGroupId: integer
(int64)
The unique identifier of the answer group.
-
AssessmentAnswer: array
Assessment Answers
Title:
Assessment Answers
The assessment answers resource is used to view and update a response to a question in the question group. -
AssessmentId: integer
(int64)
The unique identifier of the assessment associated with answer group.
-
AttributeGroupId: integer
(int64)
The unique identifier of the question group of the associated template.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Read Only:
true
The name of the answer group.
Nested Schema : Assessment Answers
Type:
array
Title:
Assessment Answers
The assessment answers resource is used to view and update a response to a question in the question group.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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.
Links
- AssessAnswerGroups
-
Parameters:
- AssessmentId:
$request.path.AssessmentId
- CompanyNumber:
$request.path.CompanyNumber
- AssessmentId:
- AssessmentTemplateVA
-
Parameters:
- finder:
AssessmentTemplateByBUIdFinder%3BAssessObjType%3D{AssessedObjTypeCode}%2CRelatedObjType%3D{RelatedObjTypeCode}%2CBindBUId%3D{BusinessUnit}
- finder:
- LookupPVO1
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMOW_ASSESSMENT_STATUS_CODE%2CBindLookupCode%3D{StatusCode}
- finder: