Groups

patch

https://app.financekey.com/OData/Groups({key})

The Group table serves as a central repository for organizing and managing collections of related entities within the Group package. Each entry in the table represents a distinct group, characterized by attributes such as unique group identifiers, names, descriptions, and membership details. This table facilitates the categorization of entities for better collaboration, management, and access control, allowing for seamless interaction among members and effective oversight of group activities.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

key

string

required

Body Params

displayName

string

required

length between 1 and 256

The DisplayName field is an nvarchar type designed to store user-friendly names or titles for groups within the Group table. It accommodates a maximum length of 256 characters, allowing for a wide range of descriptive names while ensuring flexibility and clarity in the representation of group identities.

mail

string | null

The 'Mail' field in the 'Group' table is of data type nvarchar, which allows for the storage of variable-length Unicode character strings. This field is designed to hold email addresses associated with the group, accommodating diverse character sets and enabling support for internationalization. The maximum length for this field can be defined based on specific requirements, ensuring it can contain standard and potentially longer email formats.

mailEnabled

boolean

The MailEnabled field indicates whether the group is configured to receive email. If set to true (1), the group can receive email messages, while a false (0) value indicates that the group is not enabled for email communication. This field is essential for managing email distribution and ensuring that the group can participate in email-based collaboration.

description

string | null

The 'Description' field in the 'Group' table, defined as an nvarchar data type, is intended to store textual information that provides additional details or context about the group. This field can accommodate variable-length Unicode characters, allowing for a comprehensive and multilingual description of the group's purpose, activities, or characteristics, with a maximum size that can be specified according to the database design requirements.

mailNickname

string

required

length between 1 and 128

The MailNickname field is a nvarchar data type with a maximum length of 128 characters, designed to store a unique and user-friendly alias for email communication within the Group table. This field serves as an alternative identifier for the group, facilitating efficient email routing and ensuring consistency in group identification across various applications and services. It should be unique within the same directory and is often used as part of the email address format for the group.

securityEnabled

boolean

The SecurityEnabled field indicates whether the group has security-related features enabled. This field uses a bit data type, where a value of 1 (true) signifies that the group is security-enabled, allowing for permissions and roles to be assigned, while a value of 0 (false) indicates that the group does not have security features activated.

groupPermissionId

int32 | null

GroupPermissionId (int): A unique identifier that associates each group with specific permissions, determining the level of access and rights granted to the members of the group within the system.

groupId

uuid

required

The GroupId field is a primary key of type uniqueidentifier in the Group table. It serves as a unique identifier for each group record, ensuring that each group can be distinctly referenced and retrieved. This field is crucial for maintaining data integrity and enables efficient referencing and relationships with other tables within the database. The uniqueidentifier type allows for a globally unique value, reducing the likelihood of duplication and enhancing the scalability of the database.

Headers

content-type

string

enum

Defaults to application/json;odata.metadata=minimal;odata.streaming=true

Generated from available request content types

Response

200

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here!