Get an issue
get
/fscmRestApi/resources/11.13.18.05/frcIssues/{IssueId}
Request
Path Parameters
-
IssueId(required): integer(int64)
The unique identifier for the issue.
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:
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 retrieve an issue 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/frcIssues/10001
Example Response Body
The following example shows the contents of the response body in JSON format:
{
"IssueId": 10001,
"Name": "sko test issue1",
"Status": "OPEN",
"StateCode": "APPROVE",
"Action": "SUBMIT_ACTION",
"ApprovedDate": null,
"ApprovedBy": null,
"OpenDate": null,
"HoldDate": null,
"Type": null,
"CreationDate": "2019-04-17T20:53:48.001+00:00",
"ReviewedDate": null,
"OriginObjectId": null,
"ValidDate": null,
"ClosedDate": null,
"ValidatedDate": null,
"ValidatedBy": null,
"StartDate": null,
"CreatedBy": "FRC_WSUSER",
"Severity": "SIGNIFICANT_DEFICIENCY",
"StateDate": null,
"ReasonCode": null,
"LastUpdateDate": null,
"RevisionNumber": null,
"LikelihoodCode": null,
"OriginObjectTypeCode": "GRC_CONTROL",
"LastUpdatedBy": "FRC_ADMIN",
"RemediationFlag": null,
"RemedDate": null,
"ReviewedBy": null,
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcIssues/10001",
"name": "frcIssues",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcIssues/10001",
"name": "frcIssues",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcIssues/10001/lov/FRCLookupsAM_BusinessEntityState1",
"name": "FRCLookupsAM_BusinessEntityState1",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcIssues/10001/lov/FRCLookupsAM_IssueSeverity1",
"name": "FRCLookupsAM_IssueSeverity1",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcIssues/10001/lov/FRCLookupsAM_IssueType1",
"name": "FRCLookupsAM_IssueType1",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcIssues/10001/lov/FRCLookupsAM_IssueReason1",
"name": "FRCLookupsAM_IssueReason1",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcIssues/10001/lov/FRCLookupsAM_IssueLikelihood1",
"name": "FRCLookupsAM_IssueLikelihood1",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcIssues/10001/lov/FRCLookupsAM_IssueStatus1",
"name": "FRCLookupsAM_IssueStatus1",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcIssues/10001/child/additionalInformation",
"name": "additionalInformation",
"kind": "collection"
},
{
"rel": "enclosure",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcIssues/10001/enclosure/DetailedDescription",
"name": "DetailedDescription",
"kind": "other"
}
]
}