Update an issue
patch
/fscmRestApi/resources/11.13.18.05/frcIssues/{IssueId}
Request
Path Parameters
-
IssueId(required): integer(int64)
The unique identifier for the issue.
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:
FlexfieldsThe issue flexfields resource is used to view or modify information added to issues in flexfields. -
DetailedDescription: string
(byte)
Title:
DescriptionThe detailed description of the issue. -
LikelihoodCode: string
Title:
Likelihood of RecurrenceMaximum Length:30The code indicating the likelihood of the issue recurring: HIGH, LOW, or MEDIUM. -
Name: string
Title:
NameMaximum Length:150The name of the issue. -
ReasonCode: string
Title:
Reason CodeMaximum Length:30The reason for closing the issue. -
RemedDate: string
(date)
Title:
Remediation DateThe date when issue was remediated. -
RemediationFlag: boolean
Title:
Remediation Required IndicatorMaximum Length:1Default Value:falseThe flag to identify if remediation of the issue is required. -
Severity: string
Title:
SeverityMaximum Length:30One in a set of values indicating the impact of the defect recorded by the issue: DEFICIENCY, DOCUMENTATION_ONLY, MINOR_GAP, or SIGNIFICANT_DEFICIENCY. -
Type: string
Title:
TypeMaximum Length:30One in a set of user-defined values that may be selected for the issue.
Nested Schema : Flexfields
Type:
arrayTitle:
FlexfieldsThe issue flexfields resource is used to view or modify information added to issues in flexfields.
Show Source
Nested Schema : frcIssues-additionalInformation-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:150The context for the flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentThe display value of the context of the flexfield. -
IssueId: integer
(int64)
Title:
Record IDThe unique identifier of the issue 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:
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 : frcIssues-item-response
Type:
Show Source
object-
Action: string
Read Only:
trueMaximum Length:30The action for an issue. -
additionalInformation: array
Flexfields
Title:
FlexfieldsThe issue flexfields resource is used to view or modify information added to issues in flexfields. -
ApprovedBy: string
Title:
Approved ByRead Only:trueMaximum Length:64The user who approved the issue, if any. -
ApprovedDate: string
(date-time)
Read Only:
trueThe date and time the issue was approved. -
ClosedDate: string
(date)
Title:
Close DateRead Only:trueThe date and time the issue was closed. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the issue. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time the issue was created. -
DetailedDescription: string
(byte)
Title:
DescriptionThe detailed description of the issue. -
HoldDate: string
(date)
Title:
Hold DateRead Only:trueThe hold date for the issue. -
IssueId: integer
(int64)
Title:
Record IDRead Only:trueThe unique identifier for the issue. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the issue was updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who most recently updated the issue. -
LikelihoodCode: string
Title:
Likelihood of RecurrenceMaximum Length:30The code indicating the likelihood of the issue recurring: HIGH, LOW, or MEDIUM. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
Name: string
Title:
NameMaximum Length:150The name of the issue. -
OpenDate: string
(date)
Title:
Open DateRead Only:trueThe date when the issue was opened. -
OriginObjectId: integer
(int64)
Title:
Record of OriginRead Only:trueDefault Value:0The Financial Reporting Compliance record on which the issue was based. -
OriginObjectTypeCode: string
Read Only:
trueMaximum Length:30The type of Financial Reporting Compliance record on which the issue was based. This could be a process, risk, or control, or an assessment of any of these objects. -
ReasonCode: string
Title:
Reason CodeMaximum Length:30The reason for closing the issue. -
RemedDate: string
(date)
Title:
Remediation DateThe date when issue was remediated. -
RemediationFlag: boolean
Title:
Remediation Required IndicatorMaximum Length:1Default Value:falseThe flag to identify if remediation of the issue is required. -
ReviewedBy: string
Title:
Reviewed ByRead Only:trueMaximum Length:64The user who reviewed the issue. -
ReviewedDate: string
(date-time)
Title:
Reviewed DateRead Only:trueThe date and time the issue was reviewed. -
RevisionNumber: integer
(int32)
Title:
Revision NumberRead Only:trueDefault Value:1The revision number of the issue. -
Severity: string
Title:
SeverityMaximum Length:30One in a set of values indicating the impact of the defect recorded by the issue: DEFICIENCY, DOCUMENTATION_ONLY, MINOR_GAP, or SIGNIFICANT_DEFICIENCY. -
StartDate: string
(date)
Title:
Start DateRead Only:trueThe start date of the issue. -
StateCode: string
Title:
StateRead Only:trueMaximum Length:30Default Value:NEWThe state code of the issue. -
StateDate: string
(date-time)
Read Only:
trueThe date and time when the state of issue was updated. -
Status: string
Title:
StatusRead Only:trueMaximum Length:30Default Value:OPENWhether the issue is open, in remediation, or on hold. -
Type: string
Title:
TypeMaximum Length:30One in a set of user-defined values that may be selected for the issue. -
ValidatedBy: string
Title:
Validated ByRead Only:trueMaximum Length:64The user who validated the issue. -
ValidatedDate: string
(date-time)
Title:
Validation DateRead Only:trueThe date and time when the issue was validated. -
ValidDate: string
(date)
Title:
Validation DateRead Only:trueThe date the issue was identified as valid.
Nested Schema : Flexfields
Type:
arrayTitle:
FlexfieldsThe issue flexfields resource is used to view or modify information added to issues in flexfields.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : frcIssues-additionalInformation-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:150The context for the flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentThe display value of the context of the flexfield. -
IssueId: integer
(int64)
Title:
Record IDThe unique identifier of the issue associated to the flexfield. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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:
- IssueId:
$request.path.IssueId
The issue flexfields resource is used to view or modify information added to issues in flexfields. - IssueId:
Examples
The following example shows how to update an issue by submitting a PATCH request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcIssues/30027
Example Request Body
The following example shows the contents of the request body in JSON format:
{
"Name": "Issue Renamed"
}Example Response Body
The following example shows the contents of the response body in JSON format:
"IssueId": 30027,
"Name": "Issue Renamed",
"Status": "OPEN",
"StateCode": "EDIT",
"Action": "SAVE",
"ApprovedDate": null,
"ApprovedBy": null,
"OpenDate": "2020-03-25",
"HoldDate": null,
"Type": null,
"CreationDate": "2020-03-25T18:04:33.001+00:00",
"ReviewedDate": null,
"OriginObjectId": 46086,
"ValidDate": "2020-03-25",
"ClosedDate": null,
"ValidatedDate": null,
"ValidatedBy": null,
"StartDate": "2020-03-25",
"CreatedBy": "ENTERPRISE_RISK_AND_CONTROL_MANAGER",
"Severity": "DEFICIENCY",
"StateDate": "2020-03-25T18:05:04.416+00:00",
"ReasonCode": null,
"LastUpdateDate": "2021-01-07T05:45:22.059+00:00",
"RevisionNumber": 4,
"LikelihoodCode": "HIGH",
"OriginObjectTypeCode": "GRC_CONTROL",
"LastUpdatedBy": "FRC_WSUSER",
"RemediationFlag": true,
"RemedDate": null,
"ReviewedBy": null,
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcIssues/30027",
"name": "frcIssues",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000578"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcIssues/30027",
"name": "frcIssues",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcIssues/30027/child/additionalInformation",
"name": "additionalInformation",
"kind": "collection"
},
{
"rel": "enclosure",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcIssues/30027/enclosure/DetailedDescription",
"name": "DetailedDescription",
"kind": "other"
}
]
}