Update a control assessment
patch
/fscmRestApi/resources/11.13.18.05/frcControlAssessmentResults/{ResultId}
Request
Path Parameters
-
ResultId(required): integer(int64)
The unique identifier of the result for the control assessment.
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
Root Schema : schema
Type:
Show Source
object
-
additionalInformation: array
Flexfields
Title:
Flexfields
The control assessment flexfields resource is used to view or modify information added to control assessments in flexfields. -
ObjectVersionNumber: integer
(int32)
The version number of the control when the assessment was created.
-
ResponseCode: string
Maximum Length:
30
One in a set of values indicating what the assessor has determined about a control, typically whether it has passed or failed its assessment: PASS, PASS_WITH_EXCEPTION, FAIL,NO_OPINION. -
ResultSummary: string
(byte)
The detailed explanation for the assessment response. This is a CLOB attribute.
Nested Schema : Flexfields
Type:
array
Title:
Flexfields
The control assessment flexfields resource is used to view or modify information added to control assessments in flexfields.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
The context for the flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
ResultId: integer
(int64)
Title:
Record ID
The unique identifier of the control assessment result associated to the flexfield.
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 : frcControlAssessmentResults-item-response
Type:
Show Source
object
-
ActivityCode: string
Read Only:
true
Maximum Length:30
A code that identifies the assessment's type, which specifies an activity the assessor is to complete. -
additionalInformation: array
Flexfields
Title:
Flexfields
The control assessment flexfields resource is used to view or modify information added to control assessments in flexfields. -
ApprovedBy: string
Read Only:
true
Maximum Length:64
The user who approved the assessment, if any. -
ApprovedDate: string
(date-time)
Read Only:
true
The date and time the assessment was approved. -
AssessedBy: string
Read Only:
true
Maximum Length:64
The user who performed the assessment. -
AssessedDate: string
(date-time)
Read Only:
true
The date and time the control assessment was performed. -
AssessmentId: integer
(int64)
Read Only:
true
The unique identifier of the control assessment. -
CompletionDate: string
(date-time)
Read Only:
true
The date and time when the control assessment was completed. -
ControlId: integer
(int64)
Title:
Assessed Record ID
Read Only:true
The unique identifier of the control associated to the assessment. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the control assessment. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the control assessment was created. -
DueDate: string
(date-time)
Read Only:
true
The date when the control assessment is due. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time the control assessment was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who most recently updated the control assessment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The version number of the control when the assessment was created.
-
ResponseCode: string
Maximum Length:
30
One in a set of values indicating what the assessor has determined about a control, typically whether it has passed or failed its assessment: PASS, PASS_WITH_EXCEPTION, FAIL,NO_OPINION. -
ResultId: integer
(int64)
Title:
Record ID
Read Only:true
The unique identifier of the result for the control assessment. -
ResultSummary: string
(byte)
The detailed explanation for the assessment response. This is a CLOB attribute.
-
ReviewedBy: string
Read Only:
true
Maximum Length:64
The user who reviewed the control assessment, if any. -
ReviewedDate: string
(date-time)
Read Only:
true
The date and time when the control assessment was reviewed. -
StateCode: string
Read Only:
true
Maximum Length:30
The state of the control assessment. -
SurveyId: integer
(int64)
Read Only:
true
The unique identifier of the survey related to the control assessment.
Nested Schema : Flexfields
Type:
array
Title:
Flexfields
The control assessment flexfields resource is used to view or modify information added to control assessments in flexfields.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : frcControlAssessmentResults-additionalInformation-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
The context for the flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ResultId: integer
(int64)
Title:
Record ID
The unique identifier of the control assessment result associated to the flexfield.
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
- additionalInformation
-
Parameters:
- ResultId:
$request.path.ResultId
The control assessment flexfields resource is used to view or modify information added to control assessments in flexfields. - ResultId: