Get all access group rules
get
/crmRestApi/resources/11.13.18.05/accessGroupRules
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:- AltKey: Finds an access group rule with the alternate key.
Finder Variables:- RuleName; string; The display name of the rule.
- PrimaryKey: Finds an access group with the specified primary key.
Finder Variables:- RuleId; integer; The unique identifier of the rule.
- RowFinder: Finds an access group rule with the rule number.
Finder Variables:- RuleNumber; string; The rule number is an unique alpha numeric string.
- AltKey: Finds an access group rule with the alternate 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:- ActiveFlag; boolean; Indicates whether the access group rule is active.
- ConditionCode; string; The code for predefined rules. It is applicable only for Hybrid rules.
- ConditionName; string; The condition name for the predefined rules. It is applicable only for Hybrid rules.
- CreatedBy; string; The user who created the rule.
- CreationDate; string; The date on which rule was created.
- Description; string; The description of the rule.
- LastUpdateDate; string; The date on which the rule was last updated.
- LastUpdatedBy; string; The user who last updated the rule.
- MatchingType; string; The matching type for the conditions (OR/AND).
- Object; string; The object name for which this rule needs to be created.
- ObjectCode; string; The object code for which this rule needs to be created.
- PredefinedFlag; boolean; Indicates whether the rule is seeded or user defined.
- RuleId; integer; The unique identifier of the rule.
- RuleName; string; The display name of the rule.
- RuleNumber; string; The rule number of the rule. The user can either provide this value or the system generated number.
-
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:
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 : accessGroupRules
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 : accessGroupRules-item-response
Type:
Show Source
object
-
AccessGroupCandidate: array
Access Group Rule Candidates
Title:
Access Group Rule Candidates
The access group rule candidates resource is used to view, create, update, and delete the access group candidates. It provides access group records associated with a rule. -
AccessGroupCondition: array
Access Group Rule Conditions
Title:
Access Group Rule Conditions
The access group conditions resource is used to view, create, update, and delete the group rule conditions. These are conditions associated with a rule. -
ActiveFlag: boolean
Title:
Active
Maximum Length:1
Default Value:false
Indicates whether the access group rule is active. -
ConditionCode: string
Title:
Condition Code
Maximum Length:240
The code for predefined rules. It is applicable only for Hybrid rules. -
ConditionName: string
Title:
Condition
Read Only:true
Maximum Length:1000
The condition name for the predefined rules. It is applicable only for Hybrid rules. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the rule. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date on which rule was created. -
DeleteFlag: boolean
Title:
Delete
Read Only:true
Indicates whether the rule can be deleted. -
Description: string
Title:
Rule Description
Maximum Length:255
The description of the rule. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date on which the rule was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the rule. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MatchingType: string
Title:
Matching Type
Maximum Length:30
The matching type for the conditions (OR/AND). -
Object: string
Title:
Object
Maximum Length:75
The object name for which this rule needs to be created. -
ObjectCode: string
Title:
Object Code
Read Only:true
Maximum Length:75
The object code for which this rule needs to be created. -
PredefinedFlag: boolean
Title:
Predefined
Maximum Length:1
Default Value:false
Indicates whether the rule is seeded or user defined. -
RuleId: integer
(int64)
Title:
Rule ID
The unique identifier of the rule. -
RuleName: string
Title:
Rule Name
Maximum Length:200
The display name of the rule. -
RuleNumber: string
Title:
Rule Number
Maximum Length:30
The rule number of the rule. The user can either provide this value or the system generated number. -
UpdateFlag: boolean
Title:
Update
Read Only:true
Indicates whether the rule can be updated.
Nested Schema : Access Group Rule Candidates
Type:
array
Title:
Access Group Rule Candidates
The access group rule candidates resource is used to view, create, update, and delete the access group candidates. It provides access group records associated with a rule.
Show Source
Nested Schema : Access Group Rule Conditions
Type:
array
Title:
Access Group Rule Conditions
The access group conditions resource is used to view, create, update, and delete the group rule conditions. These are conditions associated with a rule.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : accessGroupRules-AccessGroupCandidate-item-response
Type:
Show Source
object
-
AccessGroupName: string
Title:
Access Group Name
Read Only:true
Maximum Length:4000
The name of the Access Group candidate. -
AccessGroupNumber: string
Title:
Access Group Number
Read Only:true
Maximum Length:4000
The access group number associated with this rule. -
AccessLevel: string
Title:
Access Level
Maximum Length:255
Default Value:READ
The access level associated with the rule. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the group candidate. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date on which the group candidate was created. -
DeleteFlag: boolean
Title:
Delete
Read Only:true
Indicates whether the candidate can be deleted. -
EnableFlag: boolean
Title:
Enable
Maximum Length:1
Indicates whether the Access Group candidate is enabled for this rule. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date on which the group candidate was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the group candidate. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PredefinedFlag: boolean
Title:
Predefined
Read Only:true
Indicates whether the Access Group Candidate is seeded or not. -
RuleCandidateId: integer
(int64)
Title:
Rule Candidate ID
The unique identifier of the rule candidate. -
RuleCandidateNumber: string
Title:
Rule Candidate Number
Maximum Length:30
The internal number for Access Group Rule Candidate. -
RuleNumber: string
Title:
Rule Number
Read Only:true
Maximum Length:30
The rule number for which this Access Group candidate belongs to. -
UpdateFlag: boolean
Title:
Update
Read Only:true
Indicates whether the candidate can be updated.
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 : accessGroupRules-AccessGroupCondition-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the group condition. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date on which the group condition was created. -
DeleteFlag: boolean
Title:
Delete
Read Only:true
Indicates whether the group condition can be deleted. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date on which the group condition was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the group condition. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Object: string
Title:
Object
Maximum Length:64
The object for which rule condition needs to be created. -
ObjectAttributeCode: string
Title:
Object Attribute Code
Maximum Length:80
The attribute for which rule condition needs to be created. -
ObjectAttributeName: string
Title:
Object Attribute Name
Read Only:true
The object attribute display name for which condition needs to be created. -
ObjectCode: string
Title:
Object Code
Read Only:true
Maximum Length:75
The object code for which rule condition needs to be created. -
Operator: string
Title:
Operator
Maximum Length:20
The operator applicable for attribute. Update of IN and NOT IN operators are not allowed. You should delete the existing record and create a new one for IN and NOT IN operator. -
RuleConditionNumber: string
Title:
Rule Condition Number
Maximum Length:30
The rule condition number. -
RuleNumber: string
Title:
Rule Number
Read Only:true
Maximum Length:30
The rule number for which condition needs to be created. -
UpdateFlag: boolean
Title:
Update
Read Only:true
Indicates whether the group condition can be updated. -
Value: string
Title:
Value
Maximum Length:255
The value of condition.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- getGlobalPublishRequestStatus
-
This operation helps admin to check the status of global publish based on ESS Request Id.
- submitGlobalPublishRequest
-
Based on profile option, rules will be published to MRA or OBR engine.
Examples
The following example shows how to get all access group rules by submitting a get request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroupRules/
Example of Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "RuleName": "Opportunity Partner", "RuleNumber": "OpportunityPR13", "Description": "Predefined rule for access to all opportunities associated with a partner organization.", "ActiveFlag": false, "MatchingType": "AND", "CreationDate": "2021-03-11T18:27:30.831+00:00", "CreatedBy": "SEED_DATA_FROM_APPLICATION", "LastUpdateDate": "2021-06-10T09:44:33.181+00:00", "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION", "RuleId": 100100334622303, "ObjectCode": "ORA_Opportunity", "PredefinedFlag": true, "ConditionCode": "OPTYANYPARTNERORG", "ConditionName": "Opportunities associated with a partner organization", "Object": "Opportunity", "UpdateFlag": "true", "DeleteFlag": "false", "links": [ { "rel": "self", "href": "https://faehyp296.fa.dc1.c9dev2.oraclecorp.com:443/crmRestApi/resources/11.13.18.05/accessGroupRules/OpportunityPR13", "name": "accessGroupRules", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://faehyp296.fa.dc1.c9dev2.oraclecorp.com:443/crmRestApi/resources/11.13.18.05/accessGroupRules/OpportunityPR13", "name": "accessGroupRules", "kind": "item" }, { "rel": "child", "href": "https://faehyp296.fa.dc1.c9dev2.oraclecorp.com:443/crmRestApi/resources/11.13.18.05/accessGroupRules/OpportunityPR13/child/AccessGroupCandidate", "name": "AccessGroupCandidate", "kind": "collection" }, { "rel": "child", "href": "https://faehyp296.fa.dc1.c9dev2.oraclecorp.com:443/crmRestApi/resources/11.13.18.05/accessGroupRules/OpportunityPR13/child/AccessGroupCondition", "name": "AccessGroupCondition", "kind": "collection" }, ... }