Get an assessment
get
/crmRestApi/resources/11.13.18.05/opportunities/{OptyNumber}/child/Assessments/{AssessmentId}
Request
Path Parameters
-
AssessmentId(required): integer(int64)
The unique identifier of an assessment.
-
OptyNumber(required): string
The unique alternate identifier for the opportunity.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : opportunities-Assessments-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 : opportunities-Assessments-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 : opportunities-Assessments-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 assessment answer.
-
AssessmentId: integer
(int64)
The unique identifier of the assessments associated with 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
- OptyNumber:
$request.path.OptyNumber
The assessment answer groups resource is used to view and update the question groups in an assessment. - AssessmentId:
- AssessmentTemplateVA
-
Parameters:
- finder:
AssessmentTemplateByBUIdFinder%3BAssessObjType%3D{AssessedObjTypeCode}%2CRelatedObjType%3D{RelatedObjTypeCode}%2CBindBUId%3D{BusinessUnit}
The assessment templates resource is used to view the assessment templates. It stores the templates associated with assessments. - finder:
- LookupPVO1
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMOW_ASSESSMENT_STATUS_CODE%2CBindLookupCode%3D{StatusCode}
The lookups resource is used to view standard lookup codes. - finder:
Examples
The following example shows how to get an assessment by submitting a GET request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X POST -d
@example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/opportunities/300100090218733/child/Assessments/300100090190738
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "items" : [ { "AssessmentId" : 300100090201738, "BusinessUnit" : 1, "AssessTemplateId" : 100000012061095, "Name" : "Rest -121", "AssessedLanguage" : "US", "StatusCode" : "INCOMPLETE", "AssessmentScore" : 0, "AssessedObjectId" : 300100070256132, "RelatedObjectId" : null, "RelatedObjTypeCode" : "OPPORTUNITY", "AssessedObjTypeCode" : "OPPORTUNITY", "LastUpdateDate" : "2016-11-04T05:11:25-07:00", "CreatedBy" : "SALES_ADMIN", "LastUpdatedBy" : "SALES_ADMIN", "TemplateName" : "Customer Discount Eligibility", "TemplateType" : "OPPORTUNITY", "NumberOfGroups" : 0, "TotalQuestions" : 0, "TotalAnswered" : 0, "StatusFuse" : "FUSE_STATUS_NOT_STARTED", "links" : [ { ... } ] }