Create an access group rule
post
/crmRestApi/resources/11.13.18.05/accessGroupRules
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
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. -
Description: string
Title:
Rule Description
Maximum Length:255
The description of the rule. -
MatchingType: string
Title:
Matching Type
Maximum Length:30
The matching type for the conditions (OR/AND). -
Object(required): string
Title:
Object
Maximum Length:75
The object name 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(required): 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.
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 : accessGroupRules-AccessGroupCandidate-item-post-request
Type:
Show Source
object
-
AccessLevel: string
Title:
Access Level
Maximum Length:255
Default Value:READ
The access level associated with the rule. -
EnableFlag: boolean
Title:
Enable
Maximum Length:1
Indicates whether the Access Group candidate is enabled for this rule. -
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.
Nested Schema : schema
Type:
Show Source
object
-
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. -
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. -
Value: string
Title:
Value
Maximum Length:255
The value of condition.
Response
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-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
- AccessGroupCandidate
-
Operation: /crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}/child/AccessGroupCandidateParameters:
- RuleNumber:
$request.path.RuleNumber
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. - RuleNumber:
- AccessGroupCondition
-
Operation: /crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}/child/AccessGroupConditionParameters:
- RuleNumber:
$request.path.RuleNumber
The access group conditions resource is used to view, create, update, and delete the group rule conditions. These are conditions associated with a rule. - RuleNumber:
- deleteAndPublishRule
-
Operation: /crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}/action/deleteAndPublishRuleParameters:
- RuleNumber:
$request.path.RuleNumber
Based on profile option, a given rule will be deleted and subsequently published to MRA or OBR engine. - RuleNumber:
- isRulePublished
-
Parameters:
- RuleNumber:
$request.path.RuleNumber
Based on Rule PUID, the action will return if a rule is published. - RuleNumber:
- publishRule
-
Parameters:
- RuleNumber:
$request.path.RuleNumber
Based on profile option, a given rule will be published to MRA or OBR engine. - RuleNumber: