Get a risk
get
/fscmRestApi/resources/11.13.18.05/frcRisks/{RiskId}
Request
Path Parameters
-
RiskId(required): integer(int64)
The unique identifier of the risk.
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(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:
Examples
The following example shows how to retrieve a risk by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcRisks/10000
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "ApprovedBy": "ENTERPRISE_RISK_AND_CONTROL_MANAGER", "ApprovedDate": "2017-07-27T09:05:45.715+00:00", "RiskId": 10000, "RevisionDate": "2017-07-27T09:05:10.855+00:00", "ReviewedDate": "2017-07-27T09:05:32.364+00:00", "Type": null, "LastUpdateDate": "2017-07-27T09:05:45.715+00:00", "CreationDate": "2017-07-27T07:31:31.070+00:00", "LastUpdatedBy": "ENTERPRISE_RISK_AND_CONTROL_MANAGER", "Name": "Risk1", "ReviewedBy": "ENTERPRISE_RISK_AND_CONTROL_MANAGER", "CreatedBy": "ENTERPRISE_RISK_AND_CONTROL_MANAGER", "CurrencyCode": "INR", "Status": "ACTIVE", "StateCode": "APPROVED", "RiskContextModelId": 1, "RiskAnalysisModelId": 1, "ReviewStartDate": "2017-07-27T09:05:10.855+00:00", "TotalRevisions": 2, "IsRestful": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcRisks/10000", "name": "frcRisks", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcRisks/10000", "name": "frcRisks", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcRisks/10000/child/additionalInformation", "name": "additionalInformation", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcRisks/10000/child/comments", "name": "comments", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcRisks/10000/child/perspectives", "name": "perspectives", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcRisks/10000/child/relatedControls", "name": "relatedControls", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcRisks/10000/child/relatedProcesses", "name": "relatedProcesses", "kind": "collection" }, { "rel": "enclosure", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcRisks/10000/enclosure/DetailedDescription", "name": "DetailedDescription", "kind": "other" }, { "rel": "enclosure", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcRisks/10000/enclosure/Description", "name": "Description", "kind": "other" } ] }