Update a control
patch
/fscmRestApi/resources/11.13.18.05/frcControls/{ControlId}
Request
Path Parameters
-
ControlId(required): integer(int64)
The unique identifier of a control.
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
-
AssessmentFlag: string
Title:
Assessment Testing
Maximum Length:1
Default Value:N
Whether the control is to be assessed. -
AuditTestingFlag: string
Title:
Audit Testing
Maximum Length:1
Default Value:N
Whether the control is to be included in audit testing. -
ControlCost: number
Title:
Cost
The estimated cost of implementing the control. -
ControlFrequency: string
Title:
Frequency
Maximum Length:30
How often the control is to be run. -
ControlMethod: string
Title:
Method
Maximum Length:40
Default Value:MANUAL
Whether the control is automated or manually enforced. -
ControlType: string
Title:
Type
Maximum Length:30
One in a set of user-defined values that may be selected for the control. -
EnforcementType: string
Title:
Enforcement Type
Maximum Length:50
Whether the control detects a risk, corrects it, or prevents if from occurring. -
Name: string
Title:
Name
Maximum Length:150
The name of the control. -
Status: string
Title:
Status
Maximum Length:30
Default Value:ACTIVE
The status of the control. ACTIVE or INACTIVE
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 : frcControls-item-response
Type:
Show Source
object
-
additionalInformation: array
Flexfields
Title:
Flexfields
The flexfields resource is used to view or modify information added to control definitions in flexfields. -
ApprovedBy: string
Read Only:
true
Maximum Length:64
The user who approved the control. -
ApprovedDate: string
(date-time)
Title:
Approved Date
Read Only:true
The date and time when the control was approved. -
assertions: array
Assertions
Title:
Assertions
The assertions resource is used to view or modify types of assertion. An assertion is a statement of presumed facts about a business process regulated by a control. -
AssessmentFlag: string
Title:
Assessment Testing
Maximum Length:1
Default Value:N
Whether the control is to be assessed. -
AuditTestingFlag: string
Title:
Audit Testing
Maximum Length:1
Default Value:N
Whether the control is to be included in audit testing. -
comments: array
Comments
Title:
Comments
The comments resource is used to view or modify comments written about controls. -
ControlCost: number
Title:
Cost
The estimated cost of implementing the control. -
ControlFrequency: string
Title:
Frequency
Maximum Length:30
How often the control is to be run. -
ControlId: integer
(int64)
Title:
Record ID
Read Only:true
The unique identifier of a control. -
ControlMethod: string
Title:
Method
Maximum Length:40
Default Value:MANUAL
Whether the control is automated or manually enforced. -
ControlType: string
Title:
Type
Maximum Length:30
One in a set of user-defined values that may be selected for the control. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the control was created. -
DetailedDescription: string
(byte)
Title:
Description
The detailed description of the control. -
EnforcementType: string
Title:
Enforcement Type
Maximum Length:50
Whether the control detects a risk, corrects it, or prevents if from occurring. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time of the last update of the control. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who most recently updated the control. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:150
The name of the control. -
perspectives: array
Perspectives
Title:
Perspectives
The perspectives resource is used to view perspective values assigned to controls or to modify those assignments. - relatedRisks: array Related Risks
-
ReviewedBy: string
Read Only:
true
Maximum Length:64
The user who reviewed the control. -
ReviewedDate: string
(date-time)
Title:
Reviewed Date
Read Only:true
The date and time when the control was reviewed. -
ReviewStartDate: string
(date-time)
Read Only:
true
The date and time when the control review was started. -
RevisionDate: string
(date-time)
Title:
Revision Date
Read Only:true
The date and time when the control was most recently revised. -
StartDate: string
(date-time)
Read Only:
true
The effective start date of the control. -
StateCode: string
Title:
State
Read Only:true
Maximum Length:30
Default Value:N
The state code of the control. -
Status: string
Title:
Status
Maximum Length:30
Default Value:ACTIVE
The status of the control. ACTIVE or INACTIVE -
testPlans: array
Test Plans
Title:
Test Plans
The test plans resource is used to view or modify procedures carried out during control assessments to determine whether controls are effective. -
TotalRevisions: integer
(int32)
Title:
Revision Number
Read Only:true
The number of control revisions.
Nested Schema : Flexfields
Type:
array
Title:
Flexfields
The flexfields resource is used to view or modify information added to control definitions in flexfields.
Show Source
Nested Schema : Assertions
Type:
array
Title:
Assertions
The assertions resource is used to view or modify types of assertion. An assertion is a statement of presumed facts about a business process regulated by a control.
Show Source
Nested Schema : Comments
Type:
array
Title:
Comments
The comments resource is used to view or modify comments written about controls.
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 controls or to modify those assignments.
Show Source
Nested Schema : Test Plans
Type:
array
Title:
Test Plans
The test plans resource is used to view or modify procedures carried out during control assessments to determine whether controls are effective.
Show Source
Nested Schema : frcControls-additionalInformation-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
The context of the flexfields associated to the control. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
ControlId: integer
(int64)
Title:
Record ID
The unique identifier of the descriptive flexfield for the control. -
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.
Nested Schema : frcControls-assertions-item-response
Type:
Show Source
object
-
AssertionCode: string
Maximum Length:
30
The code for a control assertion. -
ControlId: integer
(int64)
Read Only:
true
The unique identifier of the control an assertion is related to. -
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 : frcControls-comments-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the comment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time the comment was created. -
Id: integer
The unique identifier of the comment on the control.
-
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 control.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : frcControls-perspectives-item-response
Type:
Show Source
object
-
ControlId: integer
(int64)
The unique identifier of the control to which a perspective is assigned.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PerspItemId: integer
(int64)
The identifier for a perspective value assigned to the control.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : frcControls-testPlans-item-response
Type:
Show Source
object
-
ControlId: integer
(int64)
The unique identifier for the control the plan is created to test.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the test plan. -
CreationDate: string
(date-time)
Read Only:
true
the date and time the test plan was created. -
DetailedDescription: string
(byte)
Title:
Description
The detailed description of the test plan. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time the test plan was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The last user who updated the test plan. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Test Plan Name
Maximum Length:150
The name of the test plan. -
planActivity: array
Test Plan Activity Type
Title:
Test Plan Activity Type
The test plan activity type resource is used to correlate each test plan with an assessment activity. The plan is completed only during an assessment of that type. -
RevisionDate: string
(date-time)
Read Only:
true
The date when the test plan was most recently revised. -
SampleSize: integer
(int32)
Title:
Sample Size
The number of control-enforcement instances to be examined for the plan to be completed. -
steps: array
Steps
Title:
Steps
The steps resource is used to view or modify individual steps within test plans. -
TestPlanFrequency: string
Title:
Test Frequency
Maximum Length:30
Whether the test plan is to be run daily, weekly, monthly, or annually. -
TestPlanId: integer
(int64)
Title:
Record ID
Unique identifier of the test plan.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Test Plan Activity Type
Type:
array
Title:
Test Plan Activity Type
The test plan activity type resource is used to correlate each test plan with an assessment activity. The plan is completed only during an assessment of that type.
Show Source
Nested Schema : Steps
Type:
array
Title:
Steps
The steps resource is used to view or modify individual steps within test plans.
Show Source
Nested Schema : frcControls-testPlans-planActivity-item-response
Type:
Show Source
object
-
ActivityCode: string
Maximum Length:
30
A code for the assessment activity in support of which the test plan is carried out. -
ControlId: integer
(int64)
The unique identifier of the control to which this test plan activity is related.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TestPlanId: integer
(int64)
The unique identifier of the test plan.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : frcControls-testPlans-steps-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the test step. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the test step was created. -
DetailedDescription: string
(byte)
The detailed description of the test step.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the test step was most recently updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who updated the test step most recently. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
StepId: integer
(int64)
The unique identifier for the test step.
-
StepOrder: integer
(int32)
Default Value:
1
The logical order of the test step. -
TestPlanId: integer
(int64)
The unique identifier for the test plan the step is a part of.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- additionalInformation
-
Parameters:
- ControlId:
$request.path.ControlId
The flexfields resource is used to view or modify information added to control definitions in flexfields. - ControlId:
- assertions
-
Parameters:
- ControlId:
$request.path.ControlId
The assertions resource is used to view or modify types of assertion. An assertion is a statement of presumed facts about a business process regulated by a control. - ControlId:
- comments
-
Parameters:
- ControlId:
$request.path.ControlId
The comments resource is used to view or modify comments written about controls. - ControlId:
- perspectives
-
Parameters:
- ControlId:
$request.path.ControlId
The perspectives resource is used to view perspective values assigned to controls or to modify those assignments. - ControlId:
- relatedRisks
-
Parameters:
- ControlId:
$request.path.ControlId
The related risks resource is used to view records of risks that are related to the control. - ControlId:
- testPlans
-
Parameters:
- ControlId:
$request.path.ControlId
The test plans resource is used to view or modify procedures carried out during control assessments to determine whether controls are effective. - ControlId:
Examples
The following example shows how to update a control by submitting a PATCH request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038
Example Request Payload
The following example shows the contents of the request body in JSON format:
{ "Name": "Auto Risk Control1 patch" }
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "Name": "Auto Risk Control1 patch", "StateCode": "EDIT", "Status": "ACTIVE", "ControlMethod": "MANUAL", "ControlFrequency": "DAILY", "AuditTestingFlag": "Y", "AssessmentFlag": "Y", "EnforcementType": "CORRECTIVE", "ControlAudit": "N", "ControlCost": null, "ControlId": 10038, "ControlType": null, "CreationDate": "2019-04-19T06:46:48+00:00", "LastUpdateDate": "2019-07-15T06:24:34.035+00:00", "LastUpdatedBy": "frc_wsuser", "ReviewedBy": "FRC_ADMIN", "ApprovedBy": "FRC_ADMIN", "ApprovedDate": "2019-04-19T06:50:58.511+00:00", "ReviewStartDate": null, "ReviewedDate": "2019-04-19T06:49:36.118+00:00", "RevisionDate": "2019-07-15T06:24:53.211+00:00", "StartDate": "2019-04-19T06:46:48+00:00", "TotalRevisions": 3, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038", "name": "frcControls", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000478" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038", "name": "frcControls", "kind": "item" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038/lov/FRCLookupsAM_YesOrNo", "name": "FRCLookupsAM_YesOrNo", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038/lov/FRCLookupsAM_ControlEnforcementType", "name": "FRCLookupsAM_ControlEnforcementType", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038/lov/FRCLookupsAM_ControlMethod", "name": "FRCLookupsAM_ControlMethod", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038/lov/FRCLookupsAM_ControlState", "name": "FRCLookupsAM_ControlState", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038/lov/FRCLookupsAM_ControlType", "name": "FRCLookupsAM_ControlType", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038/lov/FRCLookupsAM_BusinessEntityStatus", "name": "FRCLookupsAM_BusinessEntityStatus", "kind": "collection" }, { "rel": "lov", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038/lov/FRCLookupsAM_ControlFrequency", "name": "FRCLookupsAM_ControlFrequency", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038/child/additionalInformation", "name": "additionalInformation", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038/child/assertions", "name": "assertions", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038/child/comments", "name": "comments", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038/child/perspectives", "name": "perspectives", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038/child/relatedRisks", "name": "relatedRisks", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038/child/testPlans", "name": "testPlans", "kind": "collection" }, { "rel": "enclosure", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/frcControls/10038/enclosure/DetailedDescription", "name": "DetailedDescription", "kind": "other" } ] }