/api/usersandgroups/groups/{groupId}/fields/{fieldKey}

Exposes groups through the annotation-based WebAPI.

The collection operation deliberately returns compact summaries. A model operation returns only fields whose registered GroupFieldDefinition grants access to the current caller. All mutations are staged on this request-local object and are validated before the first manager write.

For an existing group, both PUT and PATCH use partial-update semantics: only properties supplied by the request are changed, while omitted properties retain their current values. PUT is not a full replacement.

Returns one registered field value. This dynamic property is also used by PATCH bodies containing a field key directly.

# Request
GET /api/usersandgroups/groups/<groupId>/fields/<fieldKey> HTTP/1.1
Accept: application/json
Authorization: Bearer <access-token>

# Response
HTTP/1.1 200 OK
Content-Type: application/json

{
    
}

Stages one registered group field value. Conversion and validation are delegated to the installed GroupFieldDefinition.

# Request
PUT /api/usersandgroups/groups/<groupId>/fields/<fieldKey> HTTP/1.1
Accept: application/json
Authorization: Bearer <access-token>
Content-Type: application/json

{
    
}

# Response
HTTP/1.1 200 OK
Content-Type: application/json

{
    
}

The status codes 400, 403, 404, 405, 406, 409, 413, 415, and 500 use the same ApiError JSON error format:

{
    "status": 404,
    "code": "route_not_found",
    "message": "The requested API route does not exist.",
    "details": []
}

Request and response schemas used on this page.

Type: object