API V3 Documentation – MTG

PQFORCE 4.26.6 Preview

Diese Dokumentation gibt es nur auf Englisch.

Vorschau: Diese Dokumentation beschreibt PQFORCE 4.26.6, das noch nicht veröffentlicht ist.

Endpoints

GET /API/V3/MTG/Meeting/:meetingId

Get a meeting

HTTP syntax

GET /API/V3/MTG/Meeting/:meetingId
<- application/json : Meeting

JavaScript syntax

Pqf.mtg.getMeeting(meetingId) // returns Meeting

Other endpoints for objects of type meeting

This endpoint is part of a group of endpoints manipulating objects of type meeting. The following endpoints belong to the same group:

Required permission

Requires permission READ on object of type Meeting and ID specified in parameter meetingId.

Parameters

Name Type Description Required Assertion
meetingId UUID The meeting's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)

Result

This endpoint returns the following data: Meeting

PUT /API/V3/MTG/Meeting/:meetingId

Create or update a meeting

HTTP syntax

PUT /API/V3/MTG/Meeting/:meetingId
-> application/json : Meeting

JavaScript syntax

Pqf.mtg.putMeeting(meetingId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Other endpoints for objects of type meeting

This endpoint is part of a group of endpoints manipulating objects of type meeting. The following endpoints belong to the same group:

Required permission

Requires permission UPDATE or CREATE on object of type Meeting and ID specified in parameter meetingId.

Parameters

Name Type Description Required Assertion
meetingId UUID The meeting's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
requestJson Meeting JSON object of type Meeting ✔️

DELETE /API/V3/MTG/Meeting/:meetingId

Delete a meeting

HTTP syntax

DELETE /API/V3/MTG/Meeting/:meetingId

JavaScript syntax

Pqf.mtg.delMeeting(meetingId) // returns Number - the return code (HTTP 2xx code) of the call

Other endpoints for objects of type meeting

This endpoint is part of a group of endpoints manipulating objects of type meeting. The following endpoints belong to the same group:

Required permission

Requires permission DELETE on object of type Meeting and ID specified in parameter meetingId.

Parameters

Name Type Description Required Assertion
meetingId UUID The meeting's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)

GET /API/V3/MTG/Meeting/:meetingId/Identification

Get a meeting identification

HTTP syntax

GET /API/V3/MTG/Meeting/:meetingId/Identification?deleted=...
<- application/json : PF.IdentificationExtended

JavaScript syntax

Pqf.mtg.getMeetingIdentification(meetingId, deleted) // returns PF.IdentificationExtended

// Overloads for optional parameters
Pqf.mtg.getMeetingIdentification(meetingId) // returns PF.IdentificationExtended

Other endpoints for objects of type meeting

This endpoint is part of a group of endpoints manipulating objects of type meeting. The following endpoints belong to the same group:

Required permission

Requires permission IDENTIFY on object of type Meeting and ID specified in parameter meetingId.

Parameters

Name Type Description Required Assertion Default, if omitted
meetingId UUID The meeting's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
deleted boolean Allow deleted objects to be returned false

Result

This endpoint returns the following data: PF.IdentificationExtended

POST /API/V3/MTG/Meeting/:meetingId/Move

Moves a meeting to another meeting group

HTTP syntax

POST /API/V3/MTG/Meeting/:meetingId/Move?destGroupId=...

JavaScript syntax

Pqf.mtg.moveMeeting(meetingId, destGroupId) // returns Number - the return code (HTTP 2xx code) of the call

Required permission

Requires permission UPDATE on object of type Meeting and ID specified in parameter meetingId.

Requires permission UPDATE on object of type MeetingGroup and ID specified in parameter destGroupId.

Parameters

Name Type Description Required Assertion
meetingId UUID The meeting ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
destGroupId UUID Parent meeting group ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)

GET /API/V3/MTG/Meeting/:meetingId/Timeline

Get a meeting's version timeline

HTTP syntax

GET /API/V3/MTG/Meeting/:meetingId/Timeline?limit=...&until=...&from=...&granularity=...
<- application/json : PF.VersionTimeline

JavaScript syntax

Pqf.mtg.getMeetingTimeline(meetingId, limit, until, from, granularity) // returns PF.VersionTimeline

// Overloads for optional parameters
Pqf.mtg.getMeetingTimeline(meetingId, limit, until, from) // returns PF.VersionTimeline
Pqf.mtg.getMeetingTimeline(meetingId, limit, until) // returns PF.VersionTimeline
Pqf.mtg.getMeetingTimeline(meetingId, limit) // returns PF.VersionTimeline
Pqf.mtg.getMeetingTimeline(meetingId) // returns PF.VersionTimeline

Other endpoints for objects of type meeting

This endpoint is part of a group of endpoints manipulating objects of type meeting. The following endpoints belong to the same group:

Required permission

Requires permission READ on object of type Meeting and ID specified in parameter meetingId.

Parameters

Name Type Description Required Assertion
meetingId UUID The meeting's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
limit int? Limits the number of slots i > 0 (The value, if present, must be greater than 0.)
until datetime Latest date of the timeline
from datetime Earliest date of the timeline
granularity PF.CalendarGranularity The granularity of the timeline

Result

This endpoint returns the following data: PF.VersionTimeline

GET /API/V3/MTG/Meeting/:meetingId/Version/:versionId

Get a meeting's specific (historic) version

HTTP syntax

GET /API/V3/MTG/Meeting/:meetingId/Version/:versionId
<- application/json : Meeting

JavaScript syntax

Pqf.mtg.getMeetingVersion(meetingId, versionId) // returns Meeting

Other endpoints for objects of type meeting

This endpoint is part of a group of endpoints manipulating objects of type meeting. The following endpoints belong to the same group:

Required permission

Requires permission READ on object of type Meeting and ID specified in parameter meetingId.

Parameters

Name Type Description Required Assertion
meetingId UUID The meeting's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
versionId UUID the version to retrieve ✔️ matches '[0-9A-F]{32}' (The value must be a UUID written as 32 upper-case hexadecimal digits.)

Result

This endpoint returns the following data: Meeting

GET /API/V3/MTG/MeetingGroup/:groupId/Meetings

Get meetings belonging to group with given ID

HTTP syntax

GET /API/V3/MTG/MeetingGroup/:groupId/Meetings?sort=...
<- application/json

JavaScript syntax

Pqf.mtg.getMeetingsOfGroup(groupId, sort) // returns PF.ReferenceWithParent[]

// Overloads for optional parameters
Pqf.mtg.getMeetingsOfGroup(groupId) // returns PF.ReferenceWithParent[]

Required permission

Requires permission READ on object of type MeetingGroup and ID specified in parameter groupId.

The returned array is filtered and contains only objects with permission IDENTIFY.

Parameters

Name Type Description Required Assertion
groupId UUID Meeting group ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
sort array of string Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, start, end, location and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color) pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

This endpoint returns the following data: array of PF.ReferenceWithParent

POST /API/V3/MTG/MeetingGroup/:groupId/Meetings/Add

Add meeting to group with given ID

HTTP syntax

POST /API/V3/MTG/MeetingGroup/:groupId/Meetings/Add?copy=...&copyRelations=...&name=...&code=...&description=...&color=...&iconRef=...
<- application/json : PF.Reference

JavaScript syntax

Pqf.mtg.addMeeting(groupId, copy, copyRelations, name, code, description, color, iconRef) // returns PF.Reference

// Overloads for optional parameters
Pqf.mtg.addMeeting(groupId, copy, copyRelations, name, code, description, color) // returns PF.Reference
Pqf.mtg.addMeeting(groupId, copy, copyRelations, name, code, description) // returns PF.Reference
Pqf.mtg.addMeeting(groupId, copy, copyRelations, name, code) // returns PF.Reference
Pqf.mtg.addMeeting(groupId, copy, copyRelations, name) // returns PF.Reference
Pqf.mtg.addMeeting(groupId, copy, copyRelations) // returns PF.Reference
Pqf.mtg.addMeeting(groupId, copy) // returns PF.Reference
Pqf.mtg.addMeeting(groupId) // returns PF.Reference

Required permission

Requires permission CREATE on object of type Meeting.

Requires permission READ on object of type Meeting and ID specified in parameter copy if it is set.

Parameters

Name Type Description Required Assertion Default, if omitted
groupId UUID Meeting group ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
copy UUID Meeting to copy matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
copyRelations boolean When copying (copy is set), also copy relations false
name string The name of the new meeting, a localized default name if omitted
code string A short code which may be unique over all objects of the same type matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.)
description string A descriptive text about the new meeting, may contain HTML
color color The color of the new meeting
iconRef URI The icon of the new meeting, value for HTML attribute image/@src, either "/images/.../....png" for an image on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/png;base64,[base64data]" for inline data or "mdi:[name]" for a Material Design icon matches '(?:/\|\.\./)images/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\.(?:png\|jpg\|svg)\|(?:/\|\.\./)API/V3/PF/Icon/(?:[0-9A-Z]{52}\|[0-9a-zA-Z]{43})\|data:image/(?:png\|jpeg\|jpg\|gif);base64,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=\|[A-Za-z0-9+/]{4})\|mdi:[a-z0-9-]+' (The value, if present, must match the regular expression shown.)

Result

This endpoint returns the following data: PF.Reference

POST /API/V3/MTG/MeetingGroup/:groupId/Move

Move group with given ID to another group

HTTP syntax

POST /API/V3/MTG/MeetingGroup/:groupId/Move?destGroupId=...

JavaScript syntax

Pqf.mtg.moveGroup(groupId, destGroupId) // returns Number - the return code (HTTP 2xx code) of the call

Required permission

Requires permission UPDATE on object of type MeetingGroup and ID specified in parameter groupId.

Requires permission UPDATE on object of type MeetingGroup and ID specified in parameter destGroupId.

Parameters

Name Type Description Required Assertion
groupId UUID Meeting group ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
destGroupId UUID Parent meeting group ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)

POST /API/V3/MTG/MeetingGroup/:groupId/MoveToTop

Move group with given ID to the top level

HTTP syntax

POST /API/V3/MTG/MeetingGroup/:groupId/MoveToTop

JavaScript syntax

Pqf.mtg.moveGroupToTop(groupId) // returns Number - the return code (HTTP 2xx code) of the call

Required permission

Requires permission UPDATE on object of type MeetingGroup and ID specified in parameter groupId.

Parameters

Name Type Description Required Assertion
groupId UUID Meeting group ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)

GET /API/V3/MTG/MeetingGroup/:groupId/SubGroups

Get sub groups belonging to group with given ID

HTTP syntax

GET /API/V3/MTG/MeetingGroup/:groupId/SubGroups?sort=...
<- application/json

JavaScript syntax

Pqf.mtg.getSubGroupsOfMeetingGroup(groupId, sort) // returns PF.ReferenceWithParent[]

// Overloads for optional parameters
Pqf.mtg.getSubGroupsOfMeetingGroup(groupId) // returns PF.ReferenceWithParent[]

Required permission

Requires permission READ on object of type MeetingGroup and ID specified in parameter groupId.

The returned array is filtered and contains only objects with permission IDENTIFY.

Parameters

Name Type Description Required Assertion
groupId UUID Meeting group ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
sort array of string Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color) pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

This endpoint returns the following data: array of PF.ReferenceWithParent

POST /API/V3/MTG/MeetingGroup/:groupId/SubGroups/Add

Add a sub group to an existing meeting group

HTTP syntax

POST /API/V3/MTG/MeetingGroup/:groupId/SubGroups/Add?copy=...&copyRelations=...&name=...&code=...&description=...&color=...&iconRef=...
<- application/json : PF.Reference

JavaScript syntax

Pqf.mtg.addMeetingGroupSubGroup(groupId, copy, copyRelations, name, code, description, color, iconRef) // returns PF.Reference

// Overloads for optional parameters
Pqf.mtg.addMeetingGroupSubGroup(groupId, copy, copyRelations, name, code, description, color) // returns PF.Reference
Pqf.mtg.addMeetingGroupSubGroup(groupId, copy, copyRelations, name, code, description) // returns PF.Reference
Pqf.mtg.addMeetingGroupSubGroup(groupId, copy, copyRelations, name, code) // returns PF.Reference
Pqf.mtg.addMeetingGroupSubGroup(groupId, copy, copyRelations, name) // returns PF.Reference
Pqf.mtg.addMeetingGroupSubGroup(groupId, copy, copyRelations) // returns PF.Reference
Pqf.mtg.addMeetingGroupSubGroup(groupId, copy) // returns PF.Reference
Pqf.mtg.addMeetingGroupSubGroup(groupId) // returns PF.Reference

Required permission

Requires permission CREATE on object of type MeetingGroup.

Requires permission READ on object of type MeetingGroup and ID specified in parameter copy if it is set.

Parameters

Name Type Description Required Assertion Default, if omitted
groupId UUID Meeting group ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
copy UUID Meeting group to copy to the sub group matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
copyRelations boolean When copying (copy is set), also copy relations false
name string The name of the new meeting group, a localized default name if omitted
code string A short code which may be unique over all objects of the same type matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.)
description string A descriptive text about the new meeting group, may contain HTML
color color The color of the new meeting group
iconRef URI The icon of the new meeting group, value for HTML attribute image/@src, either "/images/.../....png" for an image on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/png;base64,[base64data]" for inline data or "mdi:[name]" for a Material Design icon matches '(?:/\|\.\./)images/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\.(?:png\|jpg\|svg)\|(?:/\|\.\./)API/V3/PF/Icon/(?:[0-9A-Z]{52}\|[0-9a-zA-Z]{43})\|data:image/(?:png\|jpeg\|jpg\|gif);base64,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=\|[A-Za-z0-9+/]{4})\|mdi:[a-z0-9-]+' (The value, if present, must match the regular expression shown.)

Result

This endpoint returns the following data: PF.Reference

GET /API/V3/MTG/MeetingGroup/:meetingGroupId

Get a meeting group

HTTP syntax

GET /API/V3/MTG/MeetingGroup/:meetingGroupId
<- application/json : MeetingGroup

JavaScript syntax

Pqf.mtg.getMeetingGroup(meetingGroupId) // returns MeetingGroup

Other endpoints for objects of type meeting group

This endpoint is part of a group of endpoints manipulating objects of type meeting group. The following endpoints belong to the same group:

Required permission

Requires permission READ on object of type MeetingGroup and ID specified in parameter meetingGroupId.

Parameters

Name Type Description Required Assertion
meetingGroupId UUID The meeting group's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)

Result

This endpoint returns the following data: MeetingGroup

PUT /API/V3/MTG/MeetingGroup/:meetingGroupId

Update an existing meeting group

HTTP syntax

PUT /API/V3/MTG/MeetingGroup/:meetingGroupId
-> application/json : MeetingGroup

JavaScript syntax

Pqf.mtg.putMeetingGroup(meetingGroupId, requestJson) // returns Number - the return code (HTTP 2xx code) of the call

Other endpoints for objects of type meeting group

This endpoint is part of a group of endpoints manipulating objects of type meeting group. The following endpoints belong to the same group:

Required permission

Requires permission UPDATE or CREATE on object of type MeetingGroup and ID specified in parameter meetingGroupId.

Parameters

Name Type Description Required Assertion
meetingGroupId UUID The meeting group's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
requestJson MeetingGroup JSON object of type MeetingGroup ✔️

DELETE /API/V3/MTG/MeetingGroup/:meetingGroupId

Delete a meeting group

HTTP syntax

DELETE /API/V3/MTG/MeetingGroup/:meetingGroupId

JavaScript syntax

Pqf.mtg.delMeetingGroup(meetingGroupId) // returns Number - the return code (HTTP 2xx code) of the call

Other endpoints for objects of type meeting group

This endpoint is part of a group of endpoints manipulating objects of type meeting group. The following endpoints belong to the same group:

Required permission

Requires permission DELETE on object of type MeetingGroup and ID specified in parameter meetingGroupId.

Parameters

Name Type Description Required Assertion
meetingGroupId UUID The meeting group's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)

GET /API/V3/MTG/MeetingGroup/:meetingGroupId/Identification

Get a meeting group identification

HTTP syntax

GET /API/V3/MTG/MeetingGroup/:meetingGroupId/Identification?deleted=...
<- application/json : PF.IdentificationExtended

JavaScript syntax

Pqf.mtg.getMeetingGroupIdentification(meetingGroupId, deleted) // returns PF.IdentificationExtended

// Overloads for optional parameters
Pqf.mtg.getMeetingGroupIdentification(meetingGroupId) // returns PF.IdentificationExtended

Other endpoints for objects of type meeting group

This endpoint is part of a group of endpoints manipulating objects of type meeting group. The following endpoints belong to the same group:

Required permission

Requires permission IDENTIFY on object of type MeetingGroup and ID specified in parameter meetingGroupId.

Parameters

Name Type Description Required Assertion Default, if omitted
meetingGroupId UUID The meeting group's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
deleted boolean Allow deleted objects to be returned false

Result

This endpoint returns the following data: PF.IdentificationExtended

GET /API/V3/MTG/MeetingGroup/:meetingGroupId/Timeline

Get a meeting group's version timeline

HTTP syntax

GET /API/V3/MTG/MeetingGroup/:meetingGroupId/Timeline?limit=...&until=...&from=...&granularity=...
<- application/json : PF.VersionTimeline

JavaScript syntax

Pqf.mtg.getMeetingGroupTimeline(meetingGroupId, limit, until, from, granularity) // returns PF.VersionTimeline

// Overloads for optional parameters
Pqf.mtg.getMeetingGroupTimeline(meetingGroupId, limit, until, from) // returns PF.VersionTimeline
Pqf.mtg.getMeetingGroupTimeline(meetingGroupId, limit, until) // returns PF.VersionTimeline
Pqf.mtg.getMeetingGroupTimeline(meetingGroupId, limit) // returns PF.VersionTimeline
Pqf.mtg.getMeetingGroupTimeline(meetingGroupId) // returns PF.VersionTimeline

Other endpoints for objects of type meeting group

This endpoint is part of a group of endpoints manipulating objects of type meeting group. The following endpoints belong to the same group:

Required permission

Requires permission READ on object of type MeetingGroup and ID specified in parameter meetingGroupId.

Parameters

Name Type Description Required Assertion
meetingGroupId UUID The meeting group's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
limit int? Limits the number of slots i > 0 (The value, if present, must be greater than 0.)
until datetime Latest date of the timeline
from datetime Earliest date of the timeline
granularity PF.CalendarGranularity The granularity of the timeline

Result

This endpoint returns the following data: PF.VersionTimeline

GET /API/V3/MTG/MeetingGroup/:meetingGroupId/Version/:versionId

Get a meeting group's specific (historic) version

HTTP syntax

GET /API/V3/MTG/MeetingGroup/:meetingGroupId/Version/:versionId
<- application/json : MeetingGroup

JavaScript syntax

Pqf.mtg.getMeetingGroupVersion(meetingGroupId, versionId) // returns MeetingGroup

Other endpoints for objects of type meeting group

This endpoint is part of a group of endpoints manipulating objects of type meeting group. The following endpoints belong to the same group:

Required permission

Requires permission READ on object of type MeetingGroup and ID specified in parameter meetingGroupId.

Parameters

Name Type Description Required Assertion
meetingGroupId UUID The meeting group's ID ✔️ matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
versionId UUID the version to retrieve ✔️ matches '[0-9A-F]{32}' (The value must be a UUID written as 32 upper-case hexadecimal digits.)

Result

This endpoint returns the following data: MeetingGroup

GET /API/V3/MTG/MeetingGroups

Get references for all meeting groups.

HTTP syntax

GET /API/V3/MTG/MeetingGroups?sort=...
<- application/json

JavaScript syntax

Pqf.mtg.getAllMeetingGroups(sort) // returns PF.ReferenceWithParent[]

// Overloads for optional parameters
Pqf.mtg.getAllMeetingGroups() // returns PF.ReferenceWithParent[]

Required permission

The returned array is filtered and contains only objects with permission IDENTIFY.

Parameters

Name Type Description Required Assertion
sort array of string Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color) pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

This endpoint returns the following data: array of PF.ReferenceWithParent

GET /API/V3/MTG/MeetingGroups/:meetingGroupIds

Get multiple meeting groups

HTTP syntax

GET /API/V3/MTG/MeetingGroups/:meetingGroupIds
<- application/json

JavaScript syntax

Pqf.mtg.getMeetingGroups(meetingGroupIds) // returns MeetingGroup[]

Other endpoints for objects of type meeting group

This endpoint is part of a group of endpoints manipulating objects of type meeting group. The following endpoints belong to the same group:

Required permission

Requires permission READ on object of type MeetingGroup and ID in specified in parameter meetingGroupIds.

Parameters

Name Type Description Required Assertion
meetingGroupIds array of UUID The meeting group IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)

Result

This endpoint returns the following data: array of MeetingGroup

GET /API/V3/MTG/MeetingGroups/:meetingGroupIds/Identification

Get multiple meeting group identifications

HTTP syntax

GET /API/V3/MTG/MeetingGroups/:meetingGroupIds/Identification?deleted=...
<- application/json

JavaScript syntax

Pqf.mtg.getMeetingGroupIdentifications(meetingGroupIds, deleted) // returns PF.IdentificationExtended[]

// Overloads for optional parameters
Pqf.mtg.getMeetingGroupIdentifications(meetingGroupIds) // returns PF.IdentificationExtended[]

Other endpoints for objects of type meeting group

This endpoint is part of a group of endpoints manipulating objects of type meeting group. The following endpoints belong to the same group:

Required permission

Requires permission IDENTIFY on object of type MeetingGroup and ID in specified in parameter meetingGroupIds.

Parameters

Name Type Description Required Assertion Default, if omitted
meetingGroupIds array of UUID The meeting group IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
deleted boolean Allow deleted objects to be returned false

Result

This endpoint returns the following data: array of PF.IdentificationExtended

POST /API/V3/MTG/MeetingGroups/Add

Add a meeting group

HTTP syntax

POST /API/V3/MTG/MeetingGroups/Add?copy=...&copyRelations=...&name=...&code=...&description=...&color=...&iconRef=...
<- application/json : PF.Reference

JavaScript syntax

Pqf.mtg.addMeetingGroup(copy, copyRelations, name, code, description, color, iconRef) // returns PF.Reference

// Overloads for optional parameters
Pqf.mtg.addMeetingGroup(copy, copyRelations, name, code, description, color) // returns PF.Reference
Pqf.mtg.addMeetingGroup(copy, copyRelations, name, code, description) // returns PF.Reference
Pqf.mtg.addMeetingGroup(copy, copyRelations, name, code) // returns PF.Reference
Pqf.mtg.addMeetingGroup(copy, copyRelations, name) // returns PF.Reference
Pqf.mtg.addMeetingGroup(copy, copyRelations) // returns PF.Reference
Pqf.mtg.addMeetingGroup(copy) // returns PF.Reference
Pqf.mtg.addMeetingGroup() // returns PF.Reference

Required permission

Requires permission CREATE on object of type MeetingGroup.

Requires permission READ on object of type MeetingGroup and ID specified in parameter copy if it is set.

Parameters

Name Type Description Required Assertion Default, if omitted
copy UUID Meeting group to copy matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
copyRelations boolean When copying (copy is set), also copy relations false
name string The name of the new meeting group, a localized default name if omitted
code string A short code which may be unique over all objects of the same type matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.)
description string A descriptive text about the new meeting group, may contain HTML
color color The color of the new meeting group
iconRef URI The icon of the new meeting group, value for HTML attribute image/@src, either "/images/.../....png" for an image on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/png;base64,[base64data]" for inline data or "mdi:[name]" for a Material Design icon matches '(?:/\|\.\./)images/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\.(?:png\|jpg\|svg)\|(?:/\|\.\./)API/V3/PF/Icon/(?:[0-9A-Z]{52}\|[0-9a-zA-Z]{43})\|data:image/(?:png\|jpeg\|jpg\|gif);base64,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=\|[A-Za-z0-9+/]{4})\|mdi:[a-z0-9-]+' (The value, if present, must match the regular expression shown.)

Result

This endpoint returns the following data: PF.Reference

GET /API/V3/MTG/Meetings

Get references for all meetings.

HTTP syntax

GET /API/V3/MTG/Meetings?sort=...
<- application/json

JavaScript syntax

Pqf.mtg.getAllMeetings(sort) // returns PF.ReferenceWithParent[]

// Overloads for optional parameters
Pqf.mtg.getAllMeetings() // returns PF.ReferenceWithParent[]

Required permission

The returned array is filtered and contains only objects with permission IDENTIFY.

Parameters

Name Type Description Required Assertion
sort array of string Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt, start, end, location and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color) pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

This endpoint returns the following data: array of PF.ReferenceWithParent

GET /API/V3/MTG/Meetings/:meetingIds

Get multiple meetings

HTTP syntax

GET /API/V3/MTG/Meetings/:meetingIds
<- application/json

JavaScript syntax

Pqf.mtg.getMeetings(meetingIds) // returns Meeting[]

Other endpoints for objects of type meeting

This endpoint is part of a group of endpoints manipulating objects of type meeting. The following endpoints belong to the same group:

Required permission

Requires permission READ on object of type Meeting and ID in specified in parameter meetingIds.

Parameters

Name Type Description Required Assertion
meetingIds array of UUID The meeting IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)

Result

This endpoint returns the following data: array of Meeting

GET /API/V3/MTG/Meetings/:meetingIds/Identification

Get multiple meeting identifications

HTTP syntax

GET /API/V3/MTG/Meetings/:meetingIds/Identification?deleted=...
<- application/json

JavaScript syntax

Pqf.mtg.getMeetingIdentifications(meetingIds, deleted) // returns PF.IdentificationExtended[]

// Overloads for optional parameters
Pqf.mtg.getMeetingIdentifications(meetingIds) // returns PF.IdentificationExtended[]

Other endpoints for objects of type meeting

This endpoint is part of a group of endpoints manipulating objects of type meeting. The following endpoints belong to the same group:

Required permission

Requires permission IDENTIFY on object of type Meeting and ID in specified in parameter meetingIds.

Parameters

Name Type Description Required Assertion Default, if omitted
meetingIds array of UUID The meeting IDs ✔️ pqforce.performance.bulk.max >= length > 0;non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The array must contain at least one element and at most the configured "pqforce.performance.bulk.max" elements. Each element must not be null and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
deleted boolean Allow deleted objects to be returned false

Result

This endpoint returns the following data: array of PF.IdentificationExtended

GET /API/V3/MTG/Root/MeetingGroups

Get references for all root-level meeting groups.

HTTP syntax

GET /API/V3/MTG/Root/MeetingGroups?sort=...
<- application/json

JavaScript syntax

Pqf.mtg.getRootMeetingGroups(sort) // returns PF.Reference[]

// Overloads for optional parameters
Pqf.mtg.getRootMeetingGroups() // returns PF.Reference[]

Required permission

The returned array is filtered and contains only objects with permission IDENTIFY.

Parameters

Name Type Description Required Assertion
sort array of string Array which defines ordering. Syntax of an element: propertyname, propertyname:asc or propertyname:desc. Possible properties: type, id, name, code, description, color, createdAt, modifiedAt and dynamic properties with sortable semantics (String, UUID, Integer, Long, Double, Boolean, Duration, PointInTime, Day, CurrencyAmount, URI, Color) pqforce.performance.sort.max >= length > 0;non-null & matches '[\x21-\x7F\p{IsLatin}](?:[\x20-\x7F\p{IsLatin}]{0,30}?[\x21-\x7F\p{IsLatin}])??(?::(?:asc\|desc))?' (The array, if present, must contain at least one element and at most the configured "pqforce.performance.sort.max" elements. Each element must not be null and must be a property name of at most 32 characters, optionally followed by ":asc" or ":desc".)

Result

This endpoint returns the following data: array of PF.Reference

Data types

MTG.Meeting

This is a structure data contract.

Describe a meeting

Based on

Members

Name Type Inherited Description Assertion
type UUID ✔️ The type of the object (used for change notifications) non-null & matches '[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?(?:/[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?)?' (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.)
id UUID ✔️ The ID of the object (often a UUID, but not necessarily) non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
versionId UUID ✔️ A unique identifier for the version, a UUID matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.)
historic boolean ✔️ true, if there is a more recent version of this object; false, if this is the most recent version of this object
createdAt datetime ✔️ The point in time when the object was created
createdBy PF.Reference ✔️ Reference to the user that created this object
modifiedAt datetime ✔️ The point in time when the object was modified
modifiedBy PF.Reference ✔️ Reference to the user that modified this object
name string ✔️ The name of the object (in the user's language, if translations are available)
code string ✔️ A short code which may be unique over all objects of the same type matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.)
description string ✔️ A descriptive text about the object, may contain HTML
color color ✔️ A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)
iconRef URI ✔️ value for HTML attribute image/@src, Examples: "/images/....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/png;base64,[base64data]" for inline data, "mdi:[name]" for a Material Design icon matches '(?:/\|\.\./)images/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\.(?:png\|jpg\|svg)\|(?:/\|\.\./)API/V3/PF/Icon/(?:[0-9A-Z]{52}\|[0-9a-zA-Z]{43})\|data:image/(?:png\|jpeg\|jpg\|gif);base64,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=\|[A-Za-z0-9+/]{4})\|mdi:[a-z0-9-]+' (The value, if present, must match the regular expression shown.)
properties array of PF.Property ✔️ A collection of dynamic properties belonging to the object non-null;non-null (The array is required. Each element must not be null.)
groupId UUID The ID of the meeting group the meeting belongs to matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
location string Location of the meeting
start datetime Start time of the meeting
end datetime End time of the meeting

MTG.MeetingGroup

This is a structure data contract.

Describe a meeting group

Based on

Members

Name Type Inherited Description Assertion
type UUID ✔️ The type of the object (used for change notifications) non-null & matches '[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?(?:/[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x2E\x30-\x3B\x3D\x3F-\x7E\p{IsLatin}])?)?' (The value is required and must be a type: a UUID written as 32 upper-case hexadecimal digits, or a name of 1 to 32 printable ASCII characters or Latin letters other than "/", "&", "<" and ">", neither starting nor ending with a space, optionally followed by "/" and a sub-type of the same form.)
id UUID ✔️ The ID of the object (often a UUID, but not necessarily) non-null & matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value is required and must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
versionId UUID ✔️ A unique identifier for the version, a UUID matches '[0-9A-F]{32}' (The value, if present, must be a UUID written as 32 upper-case hexadecimal digits.)
historic boolean ✔️ true, if there is a more recent version of this object; false, if this is the most recent version of this object
createdAt datetime ✔️ The point in time when the object was created
createdBy PF.Reference ✔️ Reference to the user that created this object
modifiedAt datetime ✔️ The point in time when the object was modified
modifiedBy PF.Reference ✔️ Reference to the user that modified this object
name string ✔️ The name of the object (in the user's language, if translations are available)
code string ✔️ A short code which may be unique over all objects of the same type matches '.{0,32}' (The value, if present, must be a single line of at most 32 characters.)
description string ✔️ A descriptive text about the object, may contain HTML
color color ✔️ A color or any identifier of a color (which does not necessarily correspond to the W3C definitions)
iconRef URI ✔️ value for HTML attribute image/@src, Examples: "/images/....png" for images on the server, "/API/V3/PF/Icon/[id]" for an uploaded icon, "data:image/png;base64,[base64data]" for inline data, "mdi:[name]" for a Material Design icon matches '(?:/\|\.\./)images/(?:[A-Za-z0-9_-]+/)*[A-Za-z0-9_-]+\.(?:png\|jpg\|svg)\|(?:/\|\.\./)API/V3/PF/Icon/(?:[0-9A-Z]{52}\|[0-9a-zA-Z]{43})\|data:image/(?:png\|jpeg\|jpg\|gif);base64,(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=\|[A-Za-z0-9+/]{4})\|mdi:[a-z0-9-]+' (The value, if present, must match the regular expression shown.)
properties array of PF.Property ✔️ A collection of dynamic properties belonging to the object non-null;non-null (The array is required. Each element must not be null.)
parentGroupId UUID The ID of the parent meeting group matches '[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}](?:[\x20-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}]{0,30}[\x21-\x25\x27-\x3B\x3D\x3F-\x7E\p{IsLatin}])?' (The value, if present, must be an ID: a UUID written as 32 upper-case hexadecimal digits, or a key of 1 to 32 printable ASCII characters or Latin letters other than "&", "<" and ">", neither starting nor ending with a space.)
↑

Benachrichtigung

Portal-Tour

Eine geführte Tour zeigt Ihnen die Seite Schritt für Schritt: Sie hebt jeweils ein Bedienelement hervor und erklärt, wofür es da ist. Sie können jederzeit abbrechen und später weitermachen.

    Touren können jederzeit erneut gestartet werden.

    Versionshinweise wurden automatisch ins Deutsche übersetzt.