1. REST API for Oracle Fusion Cloud Risk Management
  2. Tasks
  3. Advanced Controls

Update an advanced control

patch

/fscmRestApi/resources/11.13.18.05/advancedControls/{Id}

Request

Path Parameters
Header Parameters
  • 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".
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Advanced Control Flexfields
Type: array
Title: Advanced Control Flexfields
The advanced control flexfields resource is used to view or modify information added to controls in flexfields.
Show Source
Nested Schema : Comments
Type: array
Title: Comments
The comments resource is used to view or modify comments written about advanced controls.
Show Source
Nested Schema : Incidents
Type: array
Title: Incidents
The incidents resource is used to view or modify records of advanced-control violations.
Show Source
Nested Schema : Perspectives
Type: array
Title: Perspectives
The perspectives resource is used to view root node perspective values assigned to advanced controls or to modify those assignments.
Show Source
Nested Schema : advancedControls-additionalInformations-item-patch-request
Type: object
Show Source
  • Title: Context Segment
    Maximum Length: 150
    The context value that prompts a context-sensitive segment to appear in a flexfield associated to the advanced control.
  • Title: Context Segment
    The segment that appears in a flexfield associated to the advanced control only in a defined context.
  • The unique identifier of a flexfield associated to the advanced control.
Nested Schema : advancedControls-comments-item-patch-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : Flexfields
Type: array
Title: Flexfields
The advanced control incident flexfields resource is used to view or modify information added to incidents in flexfields.
Show Source
Nested Schema : Comments
Type: array
Title: Comments
The comments resource is used to view or modify comments written about advanced control incidents.
Show Source
Nested Schema : Dynamic Attributes
Type: array
Title: Dynamic Attributes
The dynamic attributes resource is used to view the system generated attributes of advanced transaction control incidents.
Show Source
Nested Schema : Perspectives
Type: array
Title: Perspectives
The perspectives resource is used to view root node perspective values assigned to advanced control incidents or to modify those assignments.
Show Source
Nested Schema : schema
Type: object
Show Source
  • Title: Context Segment
    Maximum Length: 150
    The context value that prompts a context-sensitive segment to appear in a flexfield associated to the advanced control.
  • Title: Context Segment
    The segment that appears in a flexfield associated to the advanced control only in a defined context.
  • Maximum Length: 255
    The unique identifier of a flexfield associated to the advanced control.
Nested Schema : advancedControls-incidents-comments-item-patch-request
Type: object
Show Source
  • Default Value: N
    The flag indicating that the advanced-control comment was delegated.
  • Title: Comment
    Maximum Length: 2000
    The text of the advanced-control comment.
Nested Schema : advancedControls-incidents-dynamicAttributes-item-patch-request
Type: object
Show Source
Nested Schema : advancedControls-incidents-perspectives-item-patch-request
Type: object
Show Source
  • The unique identifier of the advanced control incident the perspective value is assigned to.
  • Maximum Length: 150
    The name of the perspective value assigned to the advanced control.
  • Perspective Items
    Title: Perspective Items
    The perspectives resource is used to view root node perspective values assigned to advanced control incidents or to modify those assignments.
  • The unique identifier of the perspective hierarchy.
Nested Schema : Perspective Items
Type: array
Title: Perspective Items
The perspectives resource is used to view root node perspective values assigned to advanced control incidents or to modify those assignments.
Show Source
Nested Schema : advancedControls-incidents-perspectives-perspectives-item-patch-request
Type: object
Show Source
  • The unique identifier of the advanced control incident the perspective value is assigned to.
  • Maximum Length: 150
    The name of the perspective value assigned to the advanced control.
  • The unique identifier of the perspective value assigned to the advanced control.
  • The unique identifier of the perspective hierarchy.
Nested Schema : advancedControls-perspectives-item-patch-request
Type: object
Show Source
  • Perspective Items
    Title: Perspective Items
    The perspectives resource is used to view root node perspective values assigned to advanced control incidents or to modify those assignments.
Nested Schema : Perspective Items
Type: array
Title: Perspective Items
The perspectives resource is used to view root node perspective values assigned to advanced control incidents or to modify those assignments.
Show Source
Nested Schema : advancedControls-perspectives-perspectives-item-patch-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : advancedControls-item-response
Type: object
Show Source
Nested Schema : Advanced Control Flexfields
Type: array
Title: Advanced Control Flexfields
The advanced control flexfields resource is used to view or modify information added to controls in flexfields.
Show Source
Nested Schema : Comments
Type: array
Title: Comments
The comments resource is used to view or modify comments written about advanced controls.
Show Source
Nested Schema : Incidents
Type: array
Title: Incidents
The incidents resource is used to view or modify records of advanced-control violations.
Show Source
Nested Schema : Perspectives
Type: array
Title: Perspectives
The perspectives resource is used to view root node perspective values assigned to advanced controls or to modify those assignments.
Show Source
Nested Schema : advancedControls-additionalInformations-item-response
Type: object
Show Source
  • Title: Context Segment
    Maximum Length: 150
    The context value that prompts a context-sensitive segment to appear in a flexfield associated to the advanced control.
  • Title: Context Segment
    The segment that appears in a flexfield associated to the advanced control only in a defined context.
  • The unique identifier of a flexfield associated to the advanced control.
  • Links
Nested Schema : advancedControls-comments-item-response
Type: object
Show Source
Nested Schema : advancedControls-incidents-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 256
    The terminal access point in the path that is the focus of an access incident. This does not apply to incidents returned by transaction controls.
  • Read Only: true
    Maximum Length: 256
    Whether the focal access point of an access incident is a privilege or a role. This does not apply to transaction incidents.
  • Flexfields
    Title: Flexfields
    The advanced control incident flexfields resource is used to view or modify information added to incidents in flexfields.
  • Read Only: true
    Maximum Length: 64
    The user who closed the advanced-control incident.
  • Read Only: true
    The date and time when the advanced-control incident was closed.
  • Comments
    Title: Comments
    The comments resource is used to view or modify comments written about advanced control incidents.
  • Read Only: true
    Maximum Length: 256
    The name of an access point that is in conflict with the access point identified by the AccessPointName attribute.
  • Read Only: true
    Maximum Length: 4000
    For an access incident, access paths that conflict with the access path that is the focus of the incident. This does not apply to transaction incidents.
  • Read Only: true
    The unique identifier of the advanced control that generated the incident.
  • The name of the advanced control that generated the incident.
  • Read Only: true
    The type of advanced control that generated the incident, access or transaction.
  • Read Only: true
    Maximum Length: 64
    The user who created the advanced-control incident.
  • Read Only: true
    The date and time when the advanced-control incident was created.
  • Read Only: true
    Maximum Length: 256
    The data source in which the incident occurred.
  • Dynamic Attributes
    Title: Dynamic Attributes
    The dynamic attributes resource is used to view the system generated attributes of advanced transaction control incidents.
  • Read Only: true
    Maximum Length: 4000
    The entitlement, if any, to which the focal access point of an access incident belongs. This does not apply to transaction incidents.
  • Read Only: true
    The unique identifier of the global user.
  • Read Only: true
    Maximum Length: 256
    The unique global user name.
  • Read Only: true
    Maximum Length: 4000
    For a transaction incident, Grouping Value reports the value that grouped result records have in common. For an access incident, Grouping Value is not used.
  • Read Only: true
    Maximum Length: 256
    The unique identifier of the advanced-control incident.
  • Read Only: true
    Maximum Length: 4000
    For a transaction incident, Incident Information is the value returned for the first attribute selected as a result attribute for the control. For an access incident, Incident Information is the path by which a user reaches an access point that is the focus of the incident.
  • Read Only: true
    Maximum Length: 4000
    The unique codes that correlate to the incident information path value. These codes represent the job, duty, and privilege codes.
  • Read Only: true
    The version of the incident.
  • Read Only: true
    Maximum Length: 1
    Whether the incident is an "intra-role" conflict, which is defined as involving access points available within a single role.
  • Read Only: true
    The date and time when the advanced-control incident was updated.
  • Read Only: true
    Maximum Length: 64
    The user who updated the advanced-control incident most recently.
  • Links
  • Perspectives
    Title: Perspectives
    The perspectives resource is used to view root node perspective values assigned to advanced control incidents or to modify those assignments.
  • Read Only: true
    The priority of the advanced-control incident.
  • Read Only: true
    Maximum Length: 4000
    For a transaction incident, Group is a descriptor that indicates what grouped return values have in common. For example, a filter that uses the Equals condition groups records in which values are equal, and Group reports the business object and attribute whose values are equal. For an access incident, Group is one or more access paths that conflict with the Incident Information path.
  • Maximum Length: 255
    The investigator assigned to the advanced-control incident.
  • The date and time the advanced-control incident was revised.
  • Read Only: true
    Maximum Length: 4000
    The parent role in the path that is the focus of an access incident. This does not apply to incidents returned by transaction controls.
  • Read Only: true
    Maximum Length: 30
    The state of the advanced-control incident. Values include In Investigation, Approved, and Closed.
  • Maximum Length: 30
    The status of the advanced-control incident. Values include Assigned, Accepted, Remediate, and Resolved.
  • Read Only: true
    Maximum Length: 256
    The first name of the user involved in the incident result.
  • Read Only: true
    Maximum Length: 256
    The last name of the user involved in the incident result.
Nested Schema : Flexfields
Type: array
Title: Flexfields
The advanced control incident flexfields resource is used to view or modify information added to incidents in flexfields.
Show Source
Nested Schema : Comments
Type: array
Title: Comments
The comments resource is used to view or modify comments written about advanced control incidents.
Show Source
Nested Schema : Dynamic Attributes
Type: array
Title: Dynamic Attributes
The dynamic attributes resource is used to view the system generated attributes of advanced transaction control incidents.
Show Source
Nested Schema : Perspectives
Type: array
Title: Perspectives
The perspectives resource is used to view root node perspective values assigned to advanced control incidents or to modify those assignments.
Show Source
Nested Schema : advancedControls-incidents-additionalInformations-item-response
Type: object
Show Source
  • Title: Context Segment
    Maximum Length: 150
    The context value that prompts a context-sensitive segment to appear in a flexfield associated to the advanced control.
  • Title: Context Segment
    The segment that appears in a flexfield associated to the advanced control only in a defined context.
  • Maximum Length: 255
    The unique identifier of a flexfield associated to the advanced control.
  • Links
Nested Schema : advancedControls-incidents-comments-item-response
Type: object
Show Source
Nested Schema : advancedControls-incidents-dynamicAttributes-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 4000
    The name for the dynamic attribute of the advanced control incident.
  • Read Only: true
    Maximum Length: 4000
    The value for the dynamic attribute of the advanced control incident.
  • Read Only: true
    The unique identifier of the advanced control incident the dynamic attribute belongs to.
  • Links
Nested Schema : advancedControls-incidents-perspectives-item-response
Type: object
Show Source
  • The unique identifier of the advanced control incident the perspective value is assigned to.
  • Links
  • Maximum Length: 150
    The name of the perspective value assigned to the advanced control.
  • Perspectives
    Title: Perspectives
    The perspectives resource is used to view perspective item values in a flat structure assigned to the root node of advanced controls or to modify those assignments.
  • The unique identifier of the perspective hierarchy.
Nested Schema : Perspectives
Type: array
Title: Perspectives
The perspectives resource is used to view perspective item values in a flat structure assigned to the root node of advanced controls or to modify those assignments.
Show Source
Nested Schema : advancedControls-incidents-perspectives-perspectives-item-response
Type: object
Show Source
  • The unique identifier of the advanced control incident the perspective value is assigned to.
  • Links
  • Maximum Length: 150
    The name of the perspective value assigned to the advanced control.
  • The unique identifier of the perspective value assigned to the advanced control.
  • The unique identifier of the perspective hierarchy.
Nested Schema : advancedControls-perspectives-item-response
Type: object
Show Source
  • Read Only: true
    The unique identifier of the advanced control the perspective value is assigned to.
  • Links
  • Read Only: true
    Maximum Length: 150
    The name of the perspective value assigned to the advanced control.
  • Perspectives
    Title: Perspectives
    The perspectives resource is used to view perspective item values in a flat structure assigned to the root node of advanced controls or to modify those assignments.
  • Read Only: true
    The unique identifier of the perspective hierarchy.
Nested Schema : Perspectives
Type: array
Title: Perspectives
The perspectives resource is used to view perspective item values in a flat structure assigned to the root node of advanced controls or to modify those assignments.
Show Source
Nested Schema : advancedControls-perspectives-perspectives-item-response
Type: object
Show Source
Links
additionalInformations
Parameters:
  • Id: $request.path.Id
The advanced control flexfields resource is used to view or modify information added to controls in flexfields.
comments
Parameters:
  • Id: $request.path.Id
The comments resource is used to view or modify comments written about advanced controls.
incidents
Parameters:
  • Id: $request.path.Id
The incidents resource is used to view or modify records of advanced-control violations.
perspectives
Parameters:
  • Id: $request.path.Id
The perspectives resource is used to view root node perspective values assigned to advanced controls or to modify those assignments.
Back to Top

Examples

Example 1

The following example shows how to update an advanced 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/advancedControls/10439

Example Request Body

The following example shows the contents of the request body in JSON format:

{

"Description":"hp test"

}

Example Response Body

The following example shows the contents of the response body in JSON format:

{
    "Id": 10439,
    "Name": "sko model1",
    "Description": "hp test",
    "EnforcementType": 1,
    "StatusId": 31,
    "StateCode": "APPROVED",
    "Type": 173,
    "LastRunDate": "2019-04-18T00:12:12+00:00",
    "LastUpdateDate": "2019-07-15T06:12:40.081+00:00",
    "LatestJobId": 76,
    "CreatedBy": "FRC_WSUSER",
    "CreationDate": "2019-04-18T00:08:13.001+00:00",
    "Status": "INACTIVE",
    "ScheduledBy": "868F90BEA5BC2011E050F50AB646CCC1",
    "LastUpdatedBy": "frc_wsuser",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/advancedControls/10439",
            "name": "advancedControls",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/advancedControls/10439",
            "name": "advancedControls",
            "kind": "item"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/advancedControls/10439/lov/AdvCtrlLookUpsAM_ACControlStatus1",
            "name": "AdvCtrlLookUpsAM_ACControlStatus1",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/advancedControls/10439/lov/AdvCtrlLookUpsAM_ControlStateCode1",
            "name": "AdvCtrlLookUpsAM_ControlStateCode1",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/advancedControls/10439/child/additionalInformations",
            "name": "additionalInformations",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/advancedControls/10439/child/comments",
            "name": "comments",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/advancedControls/10439/child/incidents",
            "name": "incidents",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/advancedControls/10439/child/perspectives",
            "name": "perspectives",
            "kind": "collection"
        }
    ]
}

Example 2

The following example shows how to mass update advanced controls by submitting a PATCH request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.batch+json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05

Example Request Body

The following example shows the contents of the request body in JSON format:

{
	"parts": [
	{
	"id":"part1",
	"path":"/advancedControls/10011",
	"operation":"update",
	"payload":
		{
			"Description": "batch-1"
		}
	},
	{
	"id":"part2",
	"path":"/advancedControls/11009",
	"operation":"update",
	"payload":
		{
			"Description": "batch-2"
		}
    }
  ]
}

Example Response Body

The following example shows the contents of the response body in JSON format:

{
	"parts": [
	{
		"id": "part1",
		"path": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/advancedControls/10011",
		"operation": "update",
		"payload": 
		{
			"Id": 10011,
			"Name": "JUNIT_TEST_CONTROL_DO_NOT_TOUCH",
			"Description": "batch-1",
			"EnforcementType": 1,
			"StatusId": 31,
			"StateCode": "APPROVED",
			"Type": 174,
			"LastRunDate": "2019-12-19T10:17:32-08:00",
			"LastUpdateDate": "2020-02-21T11:50:40.935-08:00",
			"LatestJobId": 12,
			"CreatedBy": "APPLICATION_CONTROL_MANAGER",
			"CreationDate": "2019-12-19T08:12:36.002-08:00",
			"Status": "ACTIVE",
			"ScheduledBy": "13040CEE7E61743FF2A3CE0827BD9B7A",
			"LastUpdatedBy": "APPLICATION_CONTROL_MANAGER",
			"links": [...]
		}
		"id": "part2",
		"path": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/advancedControls/11009",
		"operation": "update",
		"payload": 
			{
			"Id": 11009,
			"Name": "50010: Salary Increases Outside Scheduled Range",
			"Description": "batch-2",
			"EnforcementType": 1,
			"StatusId": 165,
			"StateCode": "APPROVED",
			"Type": 174,
			"LastRunDate": null,
			"LastUpdateDate": "2020-02-19T13:11:45.632-08:00",
			"LatestJobId": 0,
			"CreatedBy": "APPLICATION_CONTROL_MANAGER",
			"CreationDate": "2020-01-08T12:36:43.001-08:00",
			"Status": "ACTIVE",
			"ScheduledBy": null,
			"LastUpdatedBy": "APPLICATION_CONTROL_MANAGER",
			"links": [...]
			}
    }
}
Back to Top