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:
Flexfields
The issue flexfields resource is used to view or modify information added to issues in flexfields. -
DetailedDescription: string
(byte)
Title:
Description
The detailed description of the issue. -
LikelihoodCode: string
Title:
Likelihood of Recurrence
Maximum Length:30
The code indicating the likelihood of the issue recurring: HIGH, LOW, or MEDIUM. -
Name: string
Title:
Name
Maximum Length:150
The name of the issue. -
ReasonCode: string
Title:
Reason Code
Maximum Length:30
The reason for closing the issue. -
RemedDate: string
(date)
Title:
Remediation Date
The date when issue was remediated. -
RemediationFlag: boolean
Title:
Remediation Required Indicator
Maximum Length:1
Default Value:false
The flag to identify if remediation of the issue is required. -
Severity: string
Title:
Severity
Maximum Length:30
One 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:
Type
Maximum Length:30
One in a set of user-defined values that may be selected for the issue.
Nested Schema : Flexfields
Type:
array
Title:
Flexfields
The 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 Segment
Maximum Length:150
The context for the flexfield. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
The display value of the context of the flexfield. -
IssueId: integer
(int64)
Title:
Record ID
The 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(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 : frcIssues-item-response
Type:
Show Source
object
-
Action: string
Read Only:
true
Maximum Length:30
The action for an issue. -
additionalInformation: array
Flexfields
Title:
Flexfields
The issue flexfields resource is used to view or modify information added to issues in flexfields. -
ApprovedBy: string
Title:
Approved By
Read Only:true
Maximum Length:64
The user who approved the issue, if any. -
ApprovedDate: string
(date-time)
Read Only:
true
The date and time the issue was approved. -
ClosedDate: string
(date)
Title:
Close Date
Read Only:true
The date and time the issue was closed. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the issue. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time the issue was created. -
DetailedDescription: string
(byte)
Title:
Description
The detailed description of the issue. -
HoldDate: string
(date)
Title:
Hold Date
Read Only:true
The hold date for the issue. -
IssueId: integer
(int64)
Title:
Record ID
Read Only:true
The unique identifier for the issue. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the issue was updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who most recently updated the issue. -
LikelihoodCode: string
Title:
Likelihood of Recurrence
Maximum Length:30
The code indicating the likelihood of the issue recurring: HIGH, LOW, or MEDIUM. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:150
The name of the issue. -
OpenDate: string
(date)
Title:
Open Date
Read Only:true
The date when the issue was opened. -
OriginObjectId: integer
(int64)
Title:
Record of Origin
Read Only:true
Default Value:0
The Financial Reporting Compliance record on which the issue was based. -
OriginObjectTypeCode: string
Read Only:
true
Maximum Length:30
The 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 Code
Maximum Length:30
The reason for closing the issue. -
RemedDate: string
(date)
Title:
Remediation Date
The date when issue was remediated. -
RemediationFlag: boolean
Title:
Remediation Required Indicator
Maximum Length:1
Default Value:false
The flag to identify if remediation of the issue is required. -
ReviewedBy: string
Title:
Reviewed By
Read Only:true
Maximum Length:64
The user who reviewed the issue. -
ReviewedDate: string
(date-time)
Title:
Reviewed Date
Read Only:true
The date and time the issue was reviewed. -
RevisionNumber: integer
(int32)
Title:
Revision Number
Read Only:true
Default Value:1
The revision number of the issue. -
Severity: string
Title:
Severity
Maximum Length:30
One 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 Date
Read Only:true
The start date of the issue. -
StateCode: string
Title:
State
Read Only:true
Maximum Length:30
Default Value:NEW
The state code of the issue. -
StateDate: string
(date-time)
Read Only:
true
The date and time when the state of issue was updated. -
Status: string
Title:
Status
Read Only:true
Maximum Length:30
Default Value:OPEN
Whether the issue is open, in remediation, or on hold. -
Type: string
Title:
Type
Maximum Length:30
One in a set of user-defined values that may be selected for the issue. -
ValidatedBy: string
Title:
Validated By
Read Only:true
Maximum Length:64
The user who validated the issue. -
ValidatedDate: string
(date-time)
Title:
Validation Date
Read Only:true
The date and time when the issue was validated. -
ValidDate: string
(date)
Title:
Validation Date
Read Only:true
The date the issue was identified as valid.
Nested Schema : Flexfields
Type:
array
Title:
Flexfields
The issue flexfields resource is used to view or modify information added to issues in flexfields.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : frcIssues-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
The display value of the context of the flexfield. -
IssueId: integer
(int64)
Title:
Record ID
The unique identifier of the issue associated to the flexfield. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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:
- 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" } ] }