PATCH action not supported
patch
/fscmRestApi/resources/11.13.18.05/frcRisks/{RiskId}
Request
Path Parameters
-
RiskId(required): integer(int64)
The unique identifier of the risk.
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 flexfields resource is used to view or modify information added to risk definitions in flexfields. -
comments: array
Comments
Title:
Comments
The comments resource is used to view or modify comments written about risks. -
DetailedDescription: string
(byte)
Title:
Description
The description of the risk. This is a CLOB attribute. -
Name: string
Title:
Name
Maximum Length:150
The name of the risk. -
perspectives: array
Perspectives
Title:
Perspectives
The perspectives resource is used to view perspective values assigned to risks or to modify those assignments. - relatedControls: array Related Controls
- relatedProcesses: array Related Processes
-
RiskAnalysisModelId: integer
(int64)
Title:
Analysis Model
The unique identifier of the analysis model for the risk. -
RiskContextModelId: integer
(int64)
Title:
Context Model
The unique identifier of the context model for the risk. -
Status: string
Title:
Status
Maximum Length:30
Default Value:ACTIVE
The status of the risk: ACTIVE or INACTIVE. -
TotalRevisions: integer
(int32)
The number of revisions that have been performed on the risk.
-
Type: string
Title:
Type
Maximum Length:30
One in a set of user-defined values that may be selected for the risk.
Nested Schema : Flexfields
Type:
array
Title:
Flexfields
The flexfields resource is used to view or modify information added to risk definitions in flexfields.
Show Source
Nested Schema : Comments
Type:
array
Title:
Comments
The comments resource is used to view or modify comments written about risks.
Show Source
Nested Schema : Perspectives
Type:
array
Title:
Perspectives
The perspectives resource is used to view perspective values assigned to risks or to modify those assignments.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
The context of the flexfields associated to the risk. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
RiskId: integer
(int64)
Title:
Record ID
The unique identifier of the descriptive flexfield for the risk.
Nested Schema : frcRisks-comments-item-patch-request
Type:
Show Source
object
-
Id: integer
The unique identifier of the comment on the risk.
-
UserComment: string
Title:
Comment
Maximum Length:2000
The comment made on the risk.
Nested Schema : frcRisks-perspectives-item-patch-request
Type:
Show Source
object
-
PerspItemId: integer
(int64)
The unique identifier of the perspective value assigned to the risk.
-
RiskId: integer
(int64)
The unique identifier of the risk.
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 : frcRisks-item-response
Type:
Show Source
object
-
additionalInformation: array
Flexfields
Title:
Flexfields
The flexfields resource is used to view or modify information added to risk definitions in flexfields. -
ApprovedBy: string
Title:
Approved By
Read Only:true
Maximum Length:64
The user who approved the risk. -
ApprovedDate: string
(date-time)
Title:
Approved Date
Read Only:true
The date and time the risk was approved. -
comments: array
Comments
Title:
Comments
The comments resource is used to view or modify comments written about risks. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the risk. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time the risk was created. -
DetailedDescription: string
(byte)
Title:
Description
The description of the risk. This is a CLOB attribute. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time the risk was most recently updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the risk. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:150
The name of the risk. -
perspectives: array
Perspectives
Title:
Perspectives
The perspectives resource is used to view perspective values assigned to risks or to modify those assignments. - relatedControls: array Related Controls
- relatedProcesses: array Related Processes
-
ReviewedBy: string
Title:
Reviewed By
Read Only:true
Maximum Length:64
The user who reviewed the risk. -
ReviewedDate: string
(date-time)
Title:
Reviewed Date
Read Only:true
The date and time when the risk was reviewed. -
ReviewStartDate: string
(date-time)
Read Only:
true
The date and time when the risk review was started. -
RevisionDate: string
(date-time)
Title:
Revision Date
Read Only:true
The date and time when the risk was revised. -
RiskAnalysisModelId: integer
(int64)
Title:
Analysis Model
The unique identifier of the analysis model for the risk. -
RiskContextModelId: integer
(int64)
Title:
Context Model
The unique identifier of the context model for the risk. -
RiskId: integer
(int64)
Title:
Record ID
Read Only:true
The unique identifier of the risk. -
StateCode: string
Title:
State
Read Only:true
Maximum Length:30
Default Value:NEW
The state of the risk. -
Status: string
Title:
Status
Maximum Length:30
Default Value:ACTIVE
The status of the risk: ACTIVE or INACTIVE. -
TotalRevisions: integer
(int32)
The number of revisions that have been performed on the risk.
-
Type: string
Title:
Type
Maximum Length:30
One in a set of user-defined values that may be selected for the risk.
Nested Schema : Flexfields
Type:
array
Title:
Flexfields
The flexfields resource is used to view or modify information added to risk definitions in flexfields.
Show Source
Nested Schema : Comments
Type:
array
Title:
Comments
The comments resource is used to view or modify comments written about risks.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Perspectives
Type:
array
Title:
Perspectives
The perspectives resource is used to view perspective values assigned to risks or to modify those assignments.
Show Source
Nested Schema : frcRisks-additionalInformation-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
The context of the flexfields associated to the risk. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RiskId: integer
(int64)
Title:
Record ID
The unique identifier of the descriptive flexfield for the risk.
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.
Nested Schema : frcRisks-comments-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the comment on the risk. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the comment was created. -
Id: integer
The unique identifier of the comment on the risk.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
UserComment: string
Title:
Comment
Maximum Length:2000
The comment made on the risk.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : frcRisks-perspectives-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Read Only:
true
Maximum Length:150
The name of a perspective item assigned to the risk. -
PerspItemId: integer
(int64)
The unique identifier of the perspective value assigned to the risk.
-
RiskId: integer
(int64)
The unique identifier of the risk.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- additionalInformation
-
Parameters:
- RiskId:
$request.path.RiskId
The flexfields resource is used to view or modify information added to risk definitions in flexfields. - RiskId:
- comments
-
Parameters:
- RiskId:
$request.path.RiskId
The comments resource is used to view or modify comments written about risks. - RiskId:
- perspectives
-
Parameters:
- RiskId:
$request.path.RiskId
The perspectives resource is used to view perspective values assigned to risks or to modify those assignments. - RiskId:
- relatedControls
-
Parameters:
- RiskId:
$request.path.RiskId
The related controls resource is used to view records of controls that mitigate the risk. - RiskId:
- relatedProcesses
-
Parameters:
- RiskId:
$request.path.RiskId
The related processes resource is used to view records of processes impacted by the risk. - RiskId: