Jump to

• Request
• Response
• Examples

Get an access group rule

get

/crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}

Request

Path Parameters

• RuleNumber(required): string
  The rule number of the rule. The user can either provide this value or the system generated number.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 Top

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.

Body ()

Root Schema : accessGroupRules-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date on which rule was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Rule Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the rule.",
            "nullable":true,
            "x-queryable":true
        },
        "PredefinedFlag":{
            "title":"Predefined",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the rule is seeded or user defined.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "AccessGroupCondition":{
            "title":"Access Group Rule Conditions",
            "type":"array",
            "description":"The access group conditions resource is used to view, create, update, and delete the group rule conditions. These are conditions associated with a rule.",
            "items":{
                "$ref":"#/components/schemas/accessGroupRules-AccessGroupCondition-item-response"
            }
        },
        "RuleId":{
            "title":"Rule ID",
            "type":"integer",
            "description":"The unique identifier of the rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AccessGroupCandidate":{
            "title":"Access Group Rule Candidates",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/accessGroupRules-AccessGroupCandidate-item-response"
            }
        },
        "ObjectCode":{
            "title":"Object Code",
            "maxLength":"75",
            "type":"string",
            "description":"The object code for which this rule needs to be created.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConditionName":{
            "title":"Condition",
            "maxLength":"1000",
            "type":"string",
            "description":"The condition name for the predefined rules. It is applicable only for Hybrid rules.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the access group rule is active.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete",
            "type":"boolean",
            "description":"Indicates whether the rule can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ConditionCode":{
            "title":"Condition Code",
            "maxLength":"240",
            "type":"string",
            "description":"The code for predefined rules. It is applicable only for Hybrid rules.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update",
            "type":"boolean",
            "description":"Indicates whether the rule can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MatchingType":{
            "title":"Matching Type",
            "maxLength":"30",
            "type":"string",
            "description":"The matching type for the conditions (OR/AND).",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RuleNumber":{
            "title":"Rule Number",
            "maxLength":"30",
            "type":"string",
            "description":"The rule number of the rule. The user can either provide this value or the system generated number.",
            "nullable":true,
            "x-queryable":true
        },
        "Object":{
            "title":"Object",
            "maxLength":"75",
            "type":"string",
            "description":"The object name for which this rule needs to be created.",
            "nullable":false,
            "x-queryable":true
        },
        "RuleName":{
            "title":"Rule Name",
            "maxLength":"200",
            "type":"string",
            "description":"The display name of the rule.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date on which the rule was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object accessGroupRules-AccessGroupCandidate-item-response

{
    "title":"Access Group Rule Candidates",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/accessGroupRules-AccessGroupCandidate-item-response"
    }
}

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

• Array of: object accessGroupRules-AccessGroupCondition-item-response

{
    "title":"Access Group Rule Conditions",
    "type":"array",
    "description":"The access group conditions resource is used to view, create, update, and delete the group rule conditions. These are conditions associated with a rule.",
    "items":{
        "$ref":"#/components/schemas/accessGroupRules-AccessGroupCondition-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : accessGroupRules-AccessGroupCandidate-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the group candidate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date on which the group candidate was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the group candidate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PredefinedFlag":{
            "title":"Predefined",
            "type":"boolean",
            "description":"Indicates whether the Access Group Candidate is seeded or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccessGroupName":{
            "title":"Access Group Name",
            "maxLength":"4000",
            "type":"string",
            "description":"The name of the Access Group candidate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleCandidateId":{
            "title":"Rule Candidate ID",
            "type":"integer",
            "description":"The unique identifier of the rule candidate.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EnableFlag":{
            "title":"Enable",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the Access Group candidate is enabled for this rule.",
            "nullable":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete",
            "type":"boolean",
            "description":"Indicates whether the candidate can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AccessLevel":{
            "title":"Access Level",
            "maxLength":"255",
            "type":"string",
            "description":"The access level associated with the rule.",
            "nullable":true,
            "default":"READ",
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update",
            "type":"boolean",
            "description":"Indicates whether the candidate can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RuleCandidateNumber":{
            "title":"Rule Candidate Number",
            "maxLength":"30",
            "type":"string",
            "description":"The internal number for Access Group Rule Candidate.",
            "nullable":true,
            "x-queryable":true
        },
        "AccessGroupNumber":{
            "title":"Access Group Number",
            "maxLength":"4000",
            "type":"string",
            "description":"The access group number associated with this rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RuleNumber":{
            "title":"Rule Number",
            "maxLength":"30",
            "type":"string",
            "description":"The rule number for which this Access Group candidate belongs to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date on which the group candidate was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : accessGroupRules-AccessGroupCondition-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the group condition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Operator":{
            "title":"Operator",
            "maxLength":"20",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date on which the group condition was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the group condition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectAttributeCode":{
            "title":"Object Attribute Code",
            "maxLength":"80",
            "type":"string",
            "description":"The attribute for which rule condition needs to be created.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectCode":{
            "title":"Object Code",
            "maxLength":"75",
            "type":"string",
            "description":"The object code for which rule condition needs to be created.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectAttributeName":{
            "title":"Object Attribute Name",
            "type":"string",
            "description":"The object attribute display name for which condition needs to be created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete",
            "type":"boolean",
            "description":"Indicates whether the group condition can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UpdateFlag":{
            "title":"Update",
            "type":"boolean",
            "description":"Indicates whether the group condition can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Value":{
            "title":"Value",
            "maxLength":"255",
            "type":"string",
            "description":"The value of condition.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RuleNumber":{
            "title":"Rule Number",
            "maxLength":"30",
            "type":"string",
            "description":"The rule number for which condition needs to be created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleConditionNumber":{
            "title":"Rule Condition Number",
            "maxLength":"30",
            "type":"string",
            "description":"The rule condition number.",
            "nullable":true,
            "x-queryable":true
        },
        "Object":{
            "title":"Object",
            "maxLength":"64",
            "type":"string",
            "description":"The object for which rule condition needs to be created.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date on which the group condition was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

AccessGroupCandidate

Operation: /crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}/child/AccessGroupCandidate

Parameters:

• 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.

AccessGroupCondition

Operation: /crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}/child/AccessGroupCondition

Parameters:

• 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.

deleteAndPublishRule

Operation: /crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}/action/deleteAndPublishRule

Parameters:

• RuleNumber: $request.path.RuleNumber

Based on profile option, a given rule will be deleted and subsequently published to MRA or OBR engine.

isRulePublished

Operation: /crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}/action/isRulePublished

Parameters:

• RuleNumber: $request.path.RuleNumber

Based on Rule PUID, the action will return if a rule is published.

publishRule

Operation: /crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}/action/publishRule

Parameters:

• RuleNumber: $request.path.RuleNumber

Based on profile option, a given rule will be published to MRA or OBR engine.

Back to Top

Examples

The following example shows how to get an access group rule by submitting a get request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "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://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroupRules/OpportunityPR13",
            "name": "accessGroupRules",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroupRules/OpportunityPR13",
            "name": "accessGroupRules",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroupRules/OpportunityPR13/child/AccessGroupCandidate",
            "name": "AccessGroupCandidate",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroupRules/OpportunityPR13/child/AccessGroupCondition",
            "name": "AccessGroupCondition",
            "kind": "collection"
        },
        {
            "rel": "action",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroupRules/OpportunityPR13/action/isRulePublished",
            "name": "isRulePublished",
            "kind": "other"
        },
        {
            "rel": "action",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroupRules/OpportunityPR13/action/publishRule",
            "name": "publishRule",
            "kind": "other"
        },
        {
            "rel": "action",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accessGroupRules/OpportunityPR13/action/deleteAndPublishRule",
            "name": "deleteAndPublishRule",
            "kind": "other"
        }
    ]
}

Back to Top