Get all advanced controls
get
/fscmRestApi/resources/11.13.18.05/advancedControls
Request
Query Parameters
-
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds the advanced control assigned a specified primary key.
Finder Variables:- Id; integer; The unique identifier of the advanced control.
- PrimaryKey: Finds the advanced control assigned a specified primary key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- CreatedBy; string; The user who created the advanced control.
- CreationDate; string; The date and time when the advanced control was created.
- Description; string; The description of the advanced control.
- EnforcementType; number; Whether a control identifies role assignments or transaction risk that should be monitored, approved, or prevented.
- Id; integer; The unique identifier of the advanced control.
- LastRunDate; string; The date and time when the advanced control was most recently run.
- LastUpdateDate; string; The date and time when the advanced control was most recently updated.
- LastUpdatedBy; string; The user who updated the advanced control most recently.
- LatestJobId; integer; The job identifier generated when the advanced control was most recently run.
- Name; string; The name of the advanced control.
- ScheduledBy; string; The user who scheduled the advanced control to run.
- StateCode; string; The state of the advanced control.
- Status; string; Whether the advanced control status is Active or Inactive.
- StatusId; number; The identifier for the status of the advanced control.
- Type; number; The type of risk the advanced control analyzes, access or transaction.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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(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 : advancedControls
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : advancedControls-item-response
Type:
Show Source
object
-
additionalInformations: array
Advanced Control Flexfields
Title:
Advanced Control Flexfields
The advanced control flexfields resource is used to view or modify information added to controls in flexfields. -
comments: array
Comments
Title:
Comments
The comments resource is used to view or modify comments written about advanced controls. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the advanced control. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the advanced control was created. -
Description: string
Title:
Control Description
Maximum Length:2000
The description of the advanced control. -
EnforcementType: number
Title:
Enforcement Type
Whether a control identifies role assignments or transaction risk that should be monitored, approved, or prevented. -
Id: integer
(int64)
The unique identifier of the advanced control.
-
incidents: array
Incidents
Title:
Incidents
The incidents resource is used to view or modify records of advanced-control violations. -
LastRunDate: string
(date-time)
Title:
Last Run Date
The date and time when the advanced control was most recently run. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the advanced control was most recently updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who updated the advanced control most recently. -
LatestJobId: integer
(int64)
Title:
Latest Analysis Job ID
The job identifier generated when the advanced control was most recently run. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:256
The name of the advanced control. -
perspectives: array
Perspectives
Title:
Perspectives
The perspectives resource is used to view root node perspective values assigned to advanced controls or to modify those assignments. -
ScheduledBy: string
Read Only:
true
Maximum Length:400
The user who scheduled the advanced control to run. -
StateCode: string
Title:
State
Maximum Length:30
The state of the advanced control. -
Status: string
Title:
Status
Maximum Length:30
Whether the advanced control status is Active or Inactive. -
StatusId: number
Title:
Run Status
The identifier for the status of the advanced control. -
Type: number
Title:
Type
The type of risk the advanced control analyzes, access or transaction.
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 : 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 root node perspective values assigned to advanced controls or to modify those assignments.
Show Source
Nested Schema : advancedControls-additionalInformations-item-response
Type:
Show Source
object
-
__FLEX_Context: string
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. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
The segment that appears in a flexfield associated to the advanced control only in a defined context. -
Id: integer
(int64)
The unique identifier of a flexfield associated to the advanced 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 : advancedControls-comments-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the advanced-control comment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time the advanced-control comment was created. -
Id: integer
The unique identifier of the advanced-control comment.
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time the advanced-control comment was most recently updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who updated the advanced-control comment most recently. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
UserComment: string
Title:
Comment
Maximum Length:2000
The text of the advanced-control comment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : advancedControls-incidents-item-response
Type:
Show Source
object
-
AccessPointName: string
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. -
AccessPointType: string
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. -
additionalInformations: array
Flexfields
Title:
Flexfields
The advanced control incident flexfields resource is used to view or modify information added to incidents in flexfields. -
ClosedBy: string
Read Only:
true
Maximum Length:64
The user who closed the advanced-control incident. -
ClosedDate: string
(date)
Read Only:
true
The date and time when the advanced-control incident was closed. -
comments: array
Comments
Title:
Comments
The comments resource is used to view or modify comments written about advanced control incidents. -
ConflictingAccPointName: string
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. -
ConflictingRoles: string
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. -
ControlId: integer
(int64)
Read Only:
true
The unique identifier of the advanced control that generated the incident. -
ControlName: string
The name of the advanced control that generated the incident.
-
ControlType: integer
(int64)
Read Only:
true
The type of advanced control that generated the incident, access or transaction. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the advanced-control incident. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the advanced-control incident was created. -
DataSource: string
Read Only:
true
Maximum Length:256
The data source in which the incident occurred. -
Entitlement: string
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. -
GlobalUserId: integer
(int64)
Read Only:
true
The unique identifier of the global user. -
GlobalUserName: string
Read Only:
true
Maximum Length:256
The unique global user name. -
GroupingValue: string
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. -
Id: string
Read Only:
true
Maximum Length:256
The unique identifier of the advanced-control incident. -
IncidentInformation: string
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. -
IncidentInformationCodes: string
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. -
IncidentVersion: integer
Read Only:
true
The version of the incident. -
IsIntraRoleViol: string
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. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the advanced-control incident was updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who updated the advanced-control incident most recently. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
perspectives: array
Perspectives
Title:
Perspectives
The perspectives resource is used to view root node perspective values assigned to advanced control incidents or to modify those assignments. -
Priority: integer
(int64)
Read Only:
true
The priority of the advanced-control incident. -
ResultGroup: string
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. -
ResultInvestigator: string
Maximum Length:
255
The investigator assigned to the advanced-control incident. -
RevisionDate: string
(date-time)
The date and time the advanced-control incident was revised.
-
Role: string
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. -
State: string
Read Only:
true
Maximum Length:30
The state of the advanced-control incident. Values include In Investigation, Approved, and Closed. -
Status: string
Maximum Length:
30
The status of the advanced-control incident. Values include Assigned, Accepted, Remediate, and Resolved. -
UserFirstName: string
Read Only:
true
Maximum Length:256
The first name of the user involved in the incident result. -
UserLastName: string
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 : 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 root node perspective values assigned to advanced control incidents or to modify those assignments.
Show Source
Nested Schema : advancedControls-incidents-additionalInformations-item-response
Type:
Show Source
object
-
__FLEX_Context: string
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. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
The segment that appears in a flexfield associated to the advanced control only in a defined context. -
Id: string
Maximum Length:
255
The unique identifier of a flexfield associated to the advanced 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 : advancedControls-incidents-comments-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the advanced-control comment. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time the advanced-control comment was created. -
Delegated: string
Default Value:
N
The flag indicating that the advanced-control comment was delegated. -
Id: integer
The unique identifier of the advanced-control comment.
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time the advanced-control comment was most recently updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who updated the advanced-control comment most recently. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
UserComment: string
Title:
Comment
Maximum Length:2000
The text of the advanced-control comment.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : advancedControls-incidents-perspectives-item-response
Type:
Show Source
object
-
IncidentId: string
The unique identifier of the advanced control incident the perspective value is assigned to.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Maximum Length:
150
The name of the perspective value assigned to the advanced control. -
perspectives: array
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. -
TreeId: integer
The unique identifier of the perspective hierarchy.
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 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:
Show Source
object
-
IncidentId: string
The unique identifier of the advanced control incident the perspective value is assigned to.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Maximum Length:
150
The name of the perspective value assigned to the advanced control. -
PerspItemId: integer
The unique identifier of the perspective value assigned to the advanced control.
-
TreeId: integer
The unique identifier of the perspective hierarchy.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : advancedControls-perspectives-item-response
Type:
Show Source
object
-
ControlId: integer
(int64)
Read Only:
true
The unique identifier of the advanced control the perspective value is assigned to. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Read Only:
true
Maximum Length:150
The name of the perspective value assigned to the advanced control. -
perspectives: array
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. -
TreeId: integer
Read Only:
true
The unique identifier of the perspective hierarchy.
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 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:
Show Source
object
-
ControlId: integer
(int64)
The unique identifier of the advanced control the perspective value is assigned to.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Read Only:
true
Maximum Length:150
The name of the perspective value assigned to the advanced control. -
PerspItemId: integer
(int64)
The unique identifier of the perspective value assigned to the advanced control.
-
TreeId: integer
(int64)
Read Only:
true
The unique identifier of the perspective hierarchy.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
The following example shows how to retrieve all the advanced controls by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/advancedControls
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "Id": 10439, "Name": "sko model1", "Description": null, "EnforcementType": 1, "StatusId": 31, "StateCode": "APPROVED", "Type": 173, "LastRunDate": "2019-04-18T00:12:12+00:00", "LastUpdateDate": "2019-04-18T00:14:01.025+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": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78" } }, { "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" } ] }, ... ], "count": 25, "hasMore": true, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/advancedControls", "name": "advancedControls", "kind": "collection" } ] }