Jump to

• Request
• Response

Create an access group extension rule

post

/crmRestApi/resources/11.13.18.05/accessGroupExtensionRules

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• accessGroupExtensionRuleDetails: array Access Group Extension Rule Details
  Title: Access Group Extension Rule Details

  The access extension rule details resource is used to view, create, update, and delete details of access extension rules. Access extension rule details are used to extend the access defined for an object in an object sharing rule to a related object.
• AccExtRuleId: integer (int64)
  Title: Access Extension Rule ID

  The unique identifier of the access extension rule.
• AccExtRuleNumber: string
  Title: Access Extension Rule Number

  Maximum Length: 30

  The alternate key identifier for the access extension rule. It is a unique system generated sequence number.
• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true

  Indicates whether the access extension rule is active or not.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the access extension rule.
• ExtendAllRulesFlag: boolean
  Title: Extend All Rules Indicator

  Maximum Length: 1

  Default Value: true

  Indicates the method used to identify which rules from the source object should be extended to the target object.
• Name(required): string
  Title: Name

  Maximum Length: 200

  The name of the access extension rule.
• RelationshipId(required): integer (int64)
  Title: Related Object

  The unique identifier of the relationship between the source and target objects.
• RelationshipName: string
  Title: Relationship Name

  The name of the relationship between the source and target objects.
• RelationshipTypeCode: string
  Title: Relationship Type Code

  The type of the relationship between the source and target objects.

{
    "required":[
        "Name",
        "RelationshipId"
    ],
    "type":"object",
    "properties":{
        "RelationshipTypeCode":{
            "title":"Relationship Type Code",
            "type":"string",
            "description":"The type of the relationship between the source and target objects.",
            "nullable":true
        },
        "accessGroupExtensionRuleDetails":{
            "title":"Access Group Extension Rule Details",
            "type":"array",
            "description":"The access extension rule details resource is used to view, create, update, and delete details of access extension rules. Access extension rule details are used to extend the access defined for an object in an object sharing rule to a related object.",
            "items":{
                "$ref":"#/components/schemas/accessGroupExtensionRules-accessGroupExtensionRuleDetails-item-post-request"
            }
        },
        "AccExtRuleId":{
            "title":"Access Extension Rule ID",
            "type":"integer",
            "description":"The unique identifier of the access extension rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "ExtendAllRulesFlag":{
            "title":"Extend All Rules Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the method used to identify which rules from the source object should be extended to the target object.",
            "nullable":false,
            "default":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the access extension rule.",
            "nullable":true
        },
        "RelationshipName":{
            "title":"Relationship Name",
            "type":"string",
            "description":"The name of the relationship between the source and target objects.",
            "nullable":true
        },
        "RelationshipId":{
            "title":"Related Object",
            "type":"integer",
            "description":"The unique identifier of the relationship between the source and target objects.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "AccExtRuleNumber":{
            "title":"Access Extension Rule Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier for the access extension rule. It is a unique system generated sequence number.",
            "nullable":false
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the access extension rule is active or not.",
            "nullable":false,
            "default":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"200",
            "type":"string",
            "description":"The name of the access extension rule.",
            "nullable":false
        }
    }
}

Nested Schema : Access Group Extension Rule Details

Type: array

Title: Access Group Extension Rule Details

The access extension rule details resource is used to view, create, update, and delete details of access extension rules. Access extension rule details are used to extend the access defined for an object in an object sharing rule to a related object.

Show Source

• Array of: object accessGroupExtensionRules-accessGroupExtensionRuleDetails-item-post-request

{
    "title":"Access Group Extension Rule Details",
    "type":"array",
    "description":"The access extension rule details resource is used to view, create, update, and delete details of access extension rules. Access extension rule details are used to extend the access defined for an object in an object sharing rule to a related object.",
    "items":{
        "$ref":"#/components/schemas/accessGroupExtensionRules-accessGroupExtensionRuleDetails-item-post-request"
    }
}

Nested Schema : accessGroupExtensionRules-accessGroupExtensionRuleDetails-item-post-request

Type: object

Show Source

• AccessGroupNumber: string
  Title: Group Number

  The alternate key identifier of the access group associated to the rule on the source object.
• AccExtRuleDetailId: integer (int64)
  Title: Access Extension Rule Detail ID

  The unique identifier of the access extension rule details.
• AccExtRuleId: integer (int64)
  Title: Access Extension Rule ID

  The unique identifier of the access extension rule.
• DeleteAccessPermissionFlag: boolean
  Title: Delete Access Permission Indicator

  Maximum Length: 1

  Default Value: false

  Indicates whether delete access is granted.
• ReadAccessPermissionFlag: boolean
  Title: Read Access Permission Indicator

  Maximum Length: 1

  Default Value: false

  Indicates whether read access is granted.
• SrcObjAccessGroupId: integer (int64)
  Title: Source Object Access Group ID

  The unique identifier of the access group associated to the rule on the source object.
• SrcObjectRuleGuid: string
  Title: Source Object Rule GUID

  Maximum Length: 64

  The unique identifier of the rule on the source object.
• SrcObjectRuleNumber: string
  Title: Source Object Rule Number

  The alternate key identifier of the rule on the source object.
• UpdateAccessPermissionFlag: boolean
  Title: Update Access Permission Indicator

  Maximum Length: 1

  Default Value: false

  Indicates whether update access is granted.

{
    "type":"object",
    "properties":{
        "AccExtRuleId":{
            "title":"Access Extension Rule ID",
            "type":"integer",
            "description":"The unique identifier of the access extension rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ReadAccessPermissionFlag":{
            "title":"Read Access Permission Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether read access is granted.",
            "nullable":true,
            "default":false
        },
        "UpdateAccessPermissionFlag":{
            "title":"Update Access Permission Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether update access is granted.",
            "nullable":true,
            "default":false
        },
        "DeleteAccessPermissionFlag":{
            "title":"Delete Access Permission Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether delete access is granted.",
            "nullable":true,
            "default":false
        },
        "SrcObjAccessGroupId":{
            "title":"Source Object Access Group ID",
            "type":"integer",
            "description":"The unique identifier of the access group associated to the rule on the source object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SrcObjectRuleNumber":{
            "title":"Source Object Rule Number",
            "type":"string",
            "description":"The alternate key identifier of the rule on the source object.",
            "nullable":true
        },
        "AccessGroupNumber":{
            "title":"Group Number",
            "type":"string",
            "description":"The alternate key identifier of the access group associated to the rule on the source object.",
            "nullable":true
        },
        "SrcObjectRuleGuid":{
            "title":"Source Object Rule GUID",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the rule on the source object.",
            "nullable":false
        },
        "AccExtRuleDetailId":{
            "title":"Access Extension Rule Detail ID",
            "type":"integer",
            "description":"The unique identifier of the access extension rule details.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"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 : accessGroupExtensionRules-item-response

Type: object

Show Source

• accessGroupExtensionRuleDetails: array Access Group Extension Rule Details
  Title: Access Group Extension Rule Details

  The access extension rule details resource is used to view, create, update, and delete details of access extension rules. Access extension rule details are used to extend the access defined for an object in an object sharing rule to a related object.
• AccExtRuleId: integer (int64)
  Title: Access Extension Rule ID

  The unique identifier of the access extension rule.
• AccExtRuleNumber: string
  Title: Access Extension Rule Number

  Maximum Length: 30

  The alternate key identifier for the access extension rule. It is a unique system generated sequence number.
• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true

  Indicates whether the access extension rule is active or not.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the access extension rule.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the access extension rule was created.
• DeleteFlag: boolean
  Title: Delete

  Read Only: true

  Indicates whether the record can be deleted.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the access extension rule.
• ExtendAllRulesFlag: boolean
  Title: Extend All Rules Indicator

  Maximum Length: 1

  Default Value: true

  Indicates the method used to identify which rules from the source object should be extended to the target object.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the access extension rule was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the access extension rule.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user who last updated the access extension rule.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Name

  Maximum Length: 200

  The name of the access extension rule.
• PredefinedFlag: boolean
  Title: Predefined Indicator

  Read Only: true

  Maximum Length: 255

  Indicates whether the access extension rule is predefined.
• RelationshipDisplayName: string
  Title: Relationship Display Name

  Read Only: true

  The display name of the relationship between the source and target objects.
• RelationshipId: integer (int64)
  Title: Related Object

  The unique identifier of the relationship between the source and target objects.
• RelationshipName: string
  Title: Relationship Name

  The name of the relationship between the source and target objects.
• RelationshipTypeCode: string
  Title: Relationship Type Code

  The type of the relationship between the source and target objects.
• SourceObjectCode: string
  Title: Source Object Code

  Read Only: true

  The code of the source object used in the access extension rule.
• SourceObjectName: string
  Title: Source Object Name

  Read Only: true

  The name of the source object used in the access extension rule.
• TargetObjectCode: string
  Title: Target Object Code

  Read Only: true

  The code of the target object used in the access extension rule.
• TargetObjectName: string
  Title: Target Object Name

  Read Only: true

  The name of the target object used in the access extension rule.
• UpdateFlag: boolean
  Title: Update

  Read Only: true

  Indicates whether the record can be updated.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the access extension rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the access extension rule was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipDisplayName":{
            "title":"Relationship Display Name",
            "type":"string",
            "description":"The display name of the relationship between the source and target objects.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccExtRuleId":{
            "title":"Access Extension Rule ID",
            "type":"integer",
            "description":"The unique identifier of the access extension rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the access extension rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetObjectName":{
            "title":"Target Object Name",
            "type":"string",
            "description":"The name of the target object used in the access extension rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the access extension rule.",
            "nullable":true,
            "x-queryable":true
        },
        "PredefinedFlag":{
            "title":"Predefined Indicator",
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates whether the access extension rule is predefined.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the access extension rule is active or not.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "TargetObjectCode":{
            "title":"Target Object Code",
            "type":"string",
            "description":"The code of the target object used in the access extension rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete",
            "type":"boolean",
            "description":"Indicates whether the record can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"200",
            "type":"string",
            "description":"The name of the access extension rule.",
            "nullable":false,
            "x-queryable":true
        },
        "RelationshipTypeCode":{
            "title":"Relationship Type Code",
            "type":"string",
            "description":"The type of the relationship between the source and target objects.",
            "nullable":true,
            "x-queryable":true
        },
        "accessGroupExtensionRuleDetails":{
            "title":"Access Group Extension Rule Details",
            "type":"array",
            "description":"The access extension rule details resource is used to view, create, update, and delete details of access extension rules. Access extension rule details are used to extend the access defined for an object in an object sharing rule to a related object.",
            "items":{
                "$ref":"#/components/schemas/accessGroupExtensionRules-accessGroupExtensionRuleDetails-item-response"
            }
        },
        "UpdateFlag":{
            "title":"Update",
            "type":"boolean",
            "description":"Indicates whether the record can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "SourceObjectName":{
            "title":"Source Object Name",
            "type":"string",
            "description":"The name of the source object used in the access extension rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExtendAllRulesFlag":{
            "title":"Extend All Rules Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the method used to identify which rules from the source object should be extended to the target object.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "RelationshipName":{
            "title":"Relationship Name",
            "type":"string",
            "description":"The name of the relationship between the source and target objects.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Source Object Code",
            "type":"string",
            "description":"The code of the source object used in the access extension rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RelationshipId":{
            "title":"Related Object",
            "type":"integer",
            "description":"The unique identifier of the relationship between the source and target objects.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AccExtRuleNumber":{
            "title":"Access Extension Rule Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier for the access extension rule. It is a unique system generated sequence number.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the access extension rule was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login details of the user who last updated the access extension rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Access Group Extension Rule Details

Type: array

Title: Access Group Extension Rule Details

The access extension rule details resource is used to view, create, update, and delete details of access extension rules. Access extension rule details are used to extend the access defined for an object in an object sharing rule to a related object.

Show Source

• Array of: object accessGroupExtensionRules-accessGroupExtensionRuleDetails-item-response

{
    "title":"Access Group Extension Rule Details",
    "type":"array",
    "description":"The access extension rule details resource is used to view, create, update, and delete details of access extension rules. Access extension rule details are used to extend the access defined for an object in an object sharing rule to a related object.",
    "items":{
        "$ref":"#/components/schemas/accessGroupExtensionRules-accessGroupExtensionRuleDetails-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 : accessGroupExtensionRules-accessGroupExtensionRuleDetails-item-response

Type: object

Show Source

• AccessGroupNumber: string
  Title: Group Number

  The alternate key identifier of the access group associated to the rule on the source object.
• AccExtRuleDetailId: integer (int64)
  Title: Access Extension Rule Detail ID

  The unique identifier of the access extension rule details.
• AccExtRuleId: integer (int64)
  Title: Access Extension Rule ID

  The unique identifier of the access extension rule.
• AccExtRuleNumber: string
  Title: Access Extension Rule Number

  Read Only: true

  Maximum Length: 30

  The alternate key identifier for the access extension rule. It is a unique system generated sequence number.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the access extension rule.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the access extension rule was created.
• DeleteAccessPermissionFlag: boolean
  Title: Delete Access Permission Indicator

  Maximum Length: 1

  Default Value: false

  Indicates whether delete access is granted.
• DeleteFlag: boolean
  Title: Delete

  Read Only: true

  Indicates whether the record can be deleted.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the access extension rule was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the access extension rule.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login details of the user who last updated the access extension rule.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ReadAccessPermissionFlag: boolean
  Title: Read Access Permission Indicator

  Maximum Length: 1

  Default Value: false

  Indicates whether read access is granted.
• SrcObjAccessGroupId: integer (int64)
  Title: Source Object Access Group ID

  The unique identifier of the access group associated to the rule on the source object.
• SrcObjectRuleGuid: string
  Title: Source Object Rule GUID

  Maximum Length: 64

  The unique identifier of the rule on the source object.
• SrcObjectRuleNumber: string
  Title: Source Object Rule Number

  The alternate key identifier of the rule on the source object.
• UpdateAccessPermissionFlag: boolean
  Title: Update Access Permission Indicator

  Maximum Length: 1

  Default Value: false

  Indicates whether update access is granted.
• UpdateFlag: boolean
  Title: Update

  Read Only: true

  Indicates whether the record can be updated.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the access extension rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the access extension rule was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccExtRuleId":{
            "title":"Access Extension Rule ID",
            "type":"integer",
            "description":"The unique identifier of the access extension rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the access extension rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UpdateAccessPermissionFlag":{
            "title":"Update Access Permission Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether update access is granted.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "SrcObjectRuleNumber":{
            "title":"Source Object Rule Number",
            "type":"string",
            "description":"The alternate key identifier of the rule on the source object.",
            "nullable":true,
            "x-queryable":true
        },
        "SrcObjectRuleGuid":{
            "title":"Source Object Rule GUID",
            "maxLength":"64",
            "type":"string",
            "description":"The unique identifier of the rule on the source object.",
            "nullable":false,
            "x-queryable":true
        },
        "AccExtRuleDetailId":{
            "title":"Access Extension Rule Detail ID",
            "type":"integer",
            "description":"The unique identifier of the access extension rule details.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete",
            "type":"boolean",
            "description":"Indicates whether the record can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update",
            "type":"boolean",
            "description":"Indicates whether the record can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            },
            "x-queryable":true
        },
        "ReadAccessPermissionFlag":{
            "title":"Read Access Permission Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether read access is granted.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "DeleteAccessPermissionFlag":{
            "title":"Delete Access Permission Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether delete access is granted.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "SrcObjAccessGroupId":{
            "title":"Source Object Access Group ID",
            "type":"integer",
            "description":"The unique identifier of the access group associated to the rule on the source object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AccessGroupNumber":{
            "title":"Group Number",
            "type":"string",
            "description":"The alternate key identifier of the access group associated to the rule on the source object.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AccExtRuleNumber":{
            "title":"Access Extension Rule Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier for the access extension rule. It is a unique system generated sequence number.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the access extension rule was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login details of the user who last updated the access extension rule.",
            "nullable":true,
            "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."
        }
    }
}

Links

AccessGroupRelationshipsVO

Operation: /crmRestApi/resources/11.13.18.05/accessGroupRelationships

The list of relationships between source and target objects.

The following properties are defined on the LOV link relation:

• Source Attribute: RelationshipId; Target Attribute: RelationshipId
• Display Attribute: RelationshipDisplayCalcName

accessGroupExtensionRuleDetails

Operation: /crmRestApi/resources/11.13.18.05/accessGroupExtensionRules/{AccExtRuleNumber}/child/accessGroupExtensionRuleDetails

Parameters:

• AccExtRuleNumber: $request.path.AccExtRuleNumber

The access extension rule details resource is used to view, create, update, and delete details of access extension rules. Access extension rule details are used to extend the access defined for an object in an object sharing rule to a related object.

Back to Top