Jump to

• Request
• Response

Create an access group candidate

post

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

Request

Path Parameters

• 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: string
  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: string
  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: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "AccessLevel":{
            "title":"Access Level",
            "maxLength":255,
            "type":"string",
            "description":"The access level associated with the rule.",
            "nullable":true,
            "default":"READ"
        },
        "EnableFlag":{
            "title":"Enable",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the Access Group candidate is enabled for this rule.",
            "nullable":true
        },
        "RuleCandidateId":{
            "title":"Rule Candidate ID",
            "type":"integer",
            "description":"The unique identifier of the rule candidate.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RuleCandidateNumber":{
            "title":"Rule Candidate Number",
            "maxLength":30,
            "type":"string",
            "description":"The internal number for Access Group Rule Candidate.",
            "nullable":true
        }
    }
}

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-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":{
        "AccessGroupName":{
            "title":"Access Group Name",
            "maxLength":4000,
            "type":"string",
            "description":"The name of the Access Group candidate.",
            "nullable":false,
            "readOnly":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
        },
        "AccessLevel":{
            "title":"Access Level",
            "maxLength":255,
            "type":"string",
            "description":"The access level associated with the rule.",
            "nullable":true,
            "default":"READ",
            "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
        },
        "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
        },
        "DeleteFlag":{
            "title":"Delete",
            "type":"boolean",
            "description":"Indicates whether the candidate can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EnableFlag":{
            "title":"Enable",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the Access Group candidate is enabled for this rule.",
            "nullable":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
        },
        "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
        },
        "PredefinedFlag":{
            "title":"Predefined",
            "type":"boolean",
            "description":"Indicates whether the Access Group Candidate is seeded or not.",
            "nullable":true,
            "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
        },
        "RuleCandidateNumber":{
            "title":"Rule Candidate Number",
            "maxLength":30,
            "type":"string",
            "description":"The internal number for Access Group Rule Candidate.",
            "nullable":true,
            "x-queryable":true
        },
        "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
        },
        "UpdateFlag":{
            "title":"Update",
            "type":"boolean",
            "description":"Indicates whether the candidate can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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."
        }
    }
}

Links

deleteCandidateAndPublishRule

Operation: /crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}/child/AccessGroupCandidate/{RuleCandidateNumber}/action/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.

Back to Top