Update an access group candidate
patch
/crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}/child/AccessGroupCandidate/{RuleCandidateNumber}
Request
Path Parameters
-
RuleCandidateNumber(required): string
The internal number for Access Group Rule Candidate.
-
RuleNumber(required): string
The rule number of the rule. The user can either provide this value or the system generated number.
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
-
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.
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-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.
Links
- deleteCandidateAndPublishRule
-
Parameters:
- RuleCandidateNumber:
$request.path.RuleCandidateNumber
- RuleNumber:
$request.path.RuleNumber
Based on profile option, association between rule and access group candidate will be deleted and subsequently published to MRA or OBR engine. - RuleCandidateNumber: