Jump to

• Request
• Response

Update an access group

patch

/crmRestApi/resources/11.13.18.05/accessGroups/{AccessGroupNumber}

Request

Path Parameters

• AccessGroupNumber(required): string
  The alternate key identifier for the access group. It is a unique system generated sequence 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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AccessGroupMembers: array Access Group Members
  Title: Access Group Members

  The access group members resource is used to view, create, and delete members of a group. Group members are resources that are part of the group.
• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: false

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

  Maximum Length: 4000

  The description of the access group.
• Name: string
  Title: Name

  Maximum Length: 4000

  The name of the access group.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":"4000",
            "type":"string",
            "description":"The description of the access group.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the access group is active or not.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>"
                ]
            }
        },
        "AccessGroupMembers":{
            "title":"Access Group Members",
            "type":"array",
            "description":"The access group members resource is used to view, create, and delete members of a group. Group members are resources that are part of the group.",
            "items":{
                "$ref":"#/components/schemas/accessGroups-AccessGroupMembers-item-patch-request"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":"4000",
            "type":"string",
            "description":"The name of the access group.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        }
    }
}

Nested Schema : Access Group Members

Type: array

Title: Access Group Members

The access group members resource is used to view, create, and delete members of a group. Group members are resources that are part of the group.

Show Source

• Array of: object accessGroups-AccessGroupMembers-item-patch-request

{
    "title":"Access Group Members",
    "type":"array",
    "description":"The access group members resource is used to view, create, and delete members of a group. Group members are resources that are part of the group.",
    "items":{
        "$ref":"#/components/schemas/accessGroups-AccessGroupMembers-item-patch-request"
    }
}

Nested Schema : accessGroups-AccessGroupMembers-item-patch-request

Type: object

Show Source

• AccessGroupId: integer (int64)
  Title: Access Group ID

  The unique identifier of the access group.
• AccessGroupMemberId: integer (int64)
  Title: Access Group Member ID

  The unique identifier of the access group member.
• PartyId: integer (int64)
  Title: Party ID

  The unique identifier of the access group member.

{
    "type":"object",
    "properties":{
        "AccessGroupId":{
            "title":"Access Group ID",
            "type":"integer",
            "description":"The unique identifier of the access group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the access group member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AccessGroupMemberId":{
            "title":"Access Group Member ID",
            "type":"integer",
            "description":"The unique identifier of the access group member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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 : accessGroups-item-response

Type: object

Show Source

• AccessGroupId: integer (int64)
  Title: Access Group ID

  The unique identifier of the access group.
• AccessGroupMembers: array Access Group Members
  Title: Access Group Members

  The access group members resource is used to view, create, and delete members of a group. Group members are resources that are part of the group.
• AccessGroupNumber: string
  Title: Number

  Maximum Length: 4000

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

  Maximum Length: 1

  Default Value: false

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date on which the access group was created.
• DeleteFlag: boolean
  Title: Delete

  Read Only: true

  Default Value: true

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

  Maximum Length: 4000

  The description of the access group.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date on which the access group was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Maximum Length: 32

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

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

  Maximum Length: 4000

  The name of the access group.
• TypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: ORA_ZCA_CUSTOM

  The code indicating the type of the access group.
• TypeCodeMeaning: string
  Title: Type

  Read Only: true

  Maximum Length: 80

  The type of the access group.
• UpdateFlag: boolean
  Title: Update

  Read Only: true

  Default Value: 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 group.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date on which the access group was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the access group.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"4000",
            "type":"string",
            "description":"The description of the access group.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "TypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the type of the access group.",
            "nullable":false,
            "default":"ORA_ZCA_CUSTOM",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AccessGroupMembers":{
            "title":"Access Group Members",
            "type":"array",
            "description":"The access group members resource is used to view, create, and delete members of a group. Group members are resources that are part of the group.",
            "items":{
                "$ref":"#/components/schemas/accessGroups-AccessGroupMembers-item-response"
            }
        },
        "AccessGroupId":{
            "title":"Access Group ID",
            "type":"integer",
            "description":"The unique identifier of the access group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the access group is active or not.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>"
                ]
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete",
            "type":"boolean",
            "description":"Indicates whether the record can be deleted.",
            "nullable":true,
            "readOnly":true,
            "default":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":"4000",
            "type":"string",
            "description":"The name of the access group.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update",
            "type":"boolean",
            "description":"Indicates whether the record can be updated.",
            "nullable":true,
            "readOnly":true,
            "default":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "ATTR_INTERNAL_USE":"Y"
            }
        },
        "TypeCodeMeaning":{
            "title":"Type",
            "maxLength":"80",
            "type":"string",
            "description":"The type of the access group.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "AccessGroupNumber":{
            "title":"Number",
            "maxLength":"4000",
            "type":"string",
            "description":"The alternate key identifier for the access group. It is a unique system generated sequence number.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date on which the access group 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 group.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Access Group Members

Type: array

Title: Access Group Members

The access group members resource is used to view, create, and delete members of a group. Group members are resources that are part of the group.

Show Source

• Array of: object accessGroups-AccessGroupMembers-item-response

{
    "title":"Access Group Members",
    "type":"array",
    "description":"The access group members resource is used to view, create, and delete members of a group. Group members are resources that are part of the group.",
    "items":{
        "$ref":"#/components/schemas/accessGroups-AccessGroupMembers-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 : accessGroups-AccessGroupMembers-item-response

Type: object

Show Source

• AccessGroupId: integer (int64)
  Title: Access Group ID

  The unique identifier of the access group.
• AccessGroupMemberId: integer (int64)
  Title: Access Group Member ID

  The unique identifier of the access group member.
• AccessGroupNumber: string
  Title: Group Number

  Read Only: true

  Maximum Length: 4000

  The alternate key identifier of the access group to which the access group member belongs.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date when the access group member was created.
• EmailAddress: string
  Title: E-Mail

  Read Only: true

  Maximum Length: 320

  The email address of the access group member.
• FormattedPhoneNumber: string
  Title: Phone

  Read Only: true

  The phone number of the resource associated with the access group member.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• ManualAssignFlag: boolean
  Title: Member Type

  Maximum Length: 1

  Default Value: true

  Indicates whether a member has been added to the group manually.
• Name: string
  Title: Group Name

  Read Only: true

  Maximum Length: 4000

  The name of the access group to which the access group member belongs.
• PartyId: integer (int64)
  Title: Party ID

  The unique identifier of the access group member.
• PartyName: string
  Title: Resource Name

  Read Only: true

  Maximum Length: 255

  The name of the access group member.
• PartyNumber: string
  Title: Resource Registry ID

  Read Only: true

  Maximum Length: 30

  The alternate key identifier for the resource.
• RoleName: string
  Title: Resource Role

  Read Only: true

  The role of the resource associated with the access group member.
• TypeCode: string
  Title: Type Code

  Maximum Length: 30

  Default Value: ORA_ZCA_CUSTOM

  The code indicating the parent access group type of the access group member.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the access group member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the access group member 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 access group member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeCode":{
            "title":"Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the parent access group type of the access group member.",
            "nullable":false,
            "default":"ORA_ZCA_CUSTOM",
            "x-queryable":true
        },
        "ManualAssignFlag":{
            "title":"Member Type",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a member has been added to the group manually.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Resource Name",
            "maxLength":"255",
            "type":"string",
            "description":"The name of the access group member.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "AccessGroupId":{
            "title":"Access Group ID",
            "type":"integer",
            "description":"The unique identifier of the access group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"E-Mail",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the access group member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "AccessGroupMemberId":{
            "title":"Access Group Member ID",
            "type":"integer",
            "description":"The unique identifier of the access group member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Group Name",
            "maxLength":"4000",
            "type":"string",
            "description":"The name of the access group to which the access group member belongs.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Resource Registry ID",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier for the resource.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "RoleName":{
            "title":"Resource Role",
            "type":"string",
            "description":"The role of the resource associated with the access group member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the access group member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AccessGroupNumber":{
            "title":"Group Number",
            "maxLength":"4000",
            "type":"string",
            "description":"The alternate key identifier of the access group to which the access group member belongs.",
            "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"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The phone number of the resource associated with the access group member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the access group member 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 group member.",
            "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

AccessGroupMembers

Operation: /crmRestApi/resources/11.13.18.05/accessGroups/{AccessGroupNumber}/child/AccessGroupMembers

Parameters:

• AccessGroupNumber: $request.path.AccessGroupNumber

The access group members resource is used to view, create, and delete members of a group. Group members are resources that are part of the group.

Back to Top