Appack GraphQL API Reference
Programmierschnittstelle des Appack.de CMS.
Terms of Service
API Endpoints
https://api.appack.de/graphqlQueries
analyseDependencies
Description
analysiert alle Referenzen innerhalb einer Seite
Response
Returns an WSDependencyAnalysis!
Arguments
| Name | Description |
|---|---|
pageId - WSFileId!
|
Example
Query
query analyseDependencies($pageId: WSFileId!) {
analyseDependencies(pageId: $pageId) {
validDependencies {
...WSDependencyFragment
}
invalidDependencies {
...WSDependencyFragment
}
}
}
Variables
{"pageId": WSFileId}
Response
{
"data": {
"analyseDependencies": {
"validDependencies": [WSDependency],
"invalidDependencies": [WSDependency]
}
}
}
calculatePushNotificationMaxReceivers
Description
Berechnet die Anzahl der maximal möglichen Empfänger welche die gegebene Nachricht unter Verwendung der Filter erreichen könnte. deprecated see AppBagroundJob
Response
Returns a PushNotificationReceiverStats
Arguments
| Name | Description |
|---|---|
notification - PushNotificationInput!
|
Example
Query
query calculatePushNotificationMaxReceivers($notification: PushNotificationInput!) {
calculatePushNotificationMaxReceivers(notification: $notification) {
androidUsers
iphoneUsers
total
}
}
Variables
{"notification": PushNotificationInput}
Response
{
"data": {
"calculatePushNotificationMaxReceivers": {
"androidUsers": 123,
"iphoneUsers": 123,
"total": 987
}
}
}
chatComponent
Description
Lesen einer Chat-Komponente
Response
Returns a ChatComponent
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query chatComponent($id: ID!) {
chatComponent(id: $id) {
id
appId
channels {
...ChatChannelFragment
}
lastModified
lastModifiedBy
chatHomeUrl
defaultAvatarUrl
helpPageId
helpPage {
...IWSFileFragment
}
helpPageUrl
rulesPageId
rulesPage {
...IWSFileFragment
}
rulePageUrl
accentColor
version
showContacts
restrictedShowContactRoles
allowDirectCommunication
allowGroups
allowVideo
allowPoll
allowPollForNonAdmin
restrictedDirectCommunicationRoles
restrictDirectCommunicationToSameRole
}
}
Variables
{"id": "4"}
Response
{
"data": {
"chatComponent": {
"id": "4",
"appId": AppID,
"channels": [ChatChannel],
"lastModified": "2007-12-03",
"lastModifiedBy": "abc123",
"chatHomeUrl": "abc123",
"defaultAvatarUrl": "xyz789",
"helpPageId": "xyz789",
"helpPage": IWSFile,
"helpPageUrl": "xyz789",
"rulesPageId": "xyz789",
"rulesPage": IWSFile,
"rulePageUrl": "xyz789",
"accentColor": "xyz789",
"version": 987,
"showContacts": false,
"restrictedShowContactRoles": [
"xyz789"
],
"allowDirectCommunication": false,
"allowGroups": false,
"allowVideo": false,
"allowPoll": false,
"allowPollForNonAdmin": true,
"restrictedDirectCommunicationRoles": [
"xyz789"
],
"restrictDirectCommunicationToSameRole": false
}
}
}
checkCalendarEventRegistrationStatus
Description
Wird verwendet, um den Status von Registrierungen abzufragen. Wenn beispielsweise bei öffentlichen Registrierungen Ids im local storage sind.
Example
Query
query checkCalendarEventRegistrationStatus($registrationIds: [ID]!) {
checkCalendarEventRegistrationStatus(registrationIds: $registrationIds)
}
Variables
{"registrationIds": ["4"]}
Response
{
"data": {
"checkCalendarEventRegistrationStatus": [
"abc123"
]
}
}
countProjectSpecifications
Description
Zählt die Specs, auf welche der Nutzer Zugriff hat
Response
Returns an Int!
Example
Query
query countProjectSpecifications {
countProjectSpecifications
}
Response
{"data": {"countProjectSpecifications": 987}}
couponStatistics
Description
Liefert einen Statistik-Eintrag pro Gutschein-Vorlage
Response
Returns [CouponStatistic]
Example
Query
query couponStatistics {
couponStatistics {
couponSpecificationId
couponUrl
title
dispatchedCoupons
activeCoupons
inactiveCoupons
expiredCoupons
cashedCoupons
}
}
Response
{
"data": {
"couponStatistics": [
{
"couponSpecificationId": "4",
"couponUrl": "abc123",
"title": "xyz789",
"dispatchedCoupons": 987,
"activeCoupons": 987,
"inactiveCoupons": 123,
"expiredCoupons": 987,
"cashedCoupons": 987
}
]
}
}
downloadHistory
Description
liefert eine historische Statistik über die Installationszahlen zum Jahresende der vergangenen Jahre seit going live der App.
Response
Returns a DownloadHistory
Example
Query
query downloadHistory {
downloadHistory {
appId
history {
...DownloadHistoryEntryFragment
}
}
}
Response
{
"data": {
"downloadHistory": {
"appId": AppID,
"history": [DownloadHistoryEntry]
}
}
}
fileStore
Description
lifert den FileStore mit der gegebenen Id, sofern die notwendigen Rechte vorliegen
Example
Query
query fileStore(
$owner: ID!,
$loadFiles: Boolean!
) {
fileStore(
owner: $owner,
loadFiles: $loadFiles
) {
id
files {
...FSFileFragment
}
writeAccess
operationLogAccess
acceptedFileTypes
}
}
Variables
{"owner": "4", "loadFiles": true}
Response
{
"data": {
"fileStore": {
"id": "4",
"files": [FSFile],
"writeAccess": true,
"operationLogAccess": true,
"acceptedFileTypes": ["abc123"]
}
}
}
fileStoreFileExists
Description
Prüft, ob die Datei schon existiert
Response
Returns a Boolean
Example
Query
query fileStoreFileExists(
$storeId: FSFileId!,
$name: String!,
$parent: FSFileId
) {
fileStoreFileExists(
storeId: $storeId,
name: $name,
parent: $parent
)
}
Variables
{
"storeId": FSFileId,
"name": "abc123",
"parent": FSFileId
}
Response
{"data": {"fileStoreFileExists": false}}
fileStoreOperationLogs
Description
Ruft die Logs zum Store ab
Response
Returns [FileStoreOperationLog]
Arguments
| Name | Description |
|---|---|
storeId - FSFileId!
|
Example
Query
query fileStoreOperationLogs($storeId: FSFileId!) {
fileStoreOperationLogs(storeId: $storeId) {
id
created
executor
source
destination
operationType
downloadUrl
}
}
Variables
{"storeId": FSFileId}
Response
{
"data": {
"fileStoreOperationLogs": [
{
"id": "4",
"created": "2007-12-03",
"executor": "abc123",
"source": "xyz789",
"destination": "xyz789",
"operationType": "CREATE_FILE",
"downloadUrl": Url
}
]
}
}
findAdminUsers
Response
Returns a UserPagingResponse
Arguments
| Name | Description |
|---|---|
search - String
|
|
filterTechnicalUser - Boolean
|
|
page - PageRequest
|
Example
Query
query findAdminUsers(
$search: String,
$filterTechnicalUser: Boolean,
$page: PageRequest
) {
findAdminUsers(
search: $search,
filterTechnicalUser: $filterTechnicalUser,
page: $page
) {
content {
...UserFragment
}
totalcount
}
}
Variables
{
"search": "xyz789",
"filterTechnicalUser": false,
"page": PageRequest
}
Response
{
"data": {
"findAdminUsers": {
"content": [User],
"totalcount": 123
}
}
}
findCalendarEvents
Description
listet alle Ereignisse die mit dem gegebenen Kalender verbunden sind. Der Kalender selbst muss sich im gleichen App Kontext befinden wie der anfragende User. Optional kann der Zeitraum noch eingegrenzt werden, was die Performance beim Paging verbessert Optional eine Freitext, der innerhalb der Titel, Untertitel und Kategorien sucht Optional kann die Suche auf bestimmte Locations eingeschränkt werden
Response
Returns [CalendarEvent]
Example
Query
query findCalendarEvents(
$calendarIds: [ID]!,
$range: DateRange,
$locationIds: [ID],
$search: String
) {
findCalendarEvents(
calendarIds: $calendarIds,
range: $range,
locationIds: $locationIds,
search: $search
) {
id
calendarId
seriesId
title
subTitle
description
timeZoneId
timeZoneOffset
dateStart
dateTimeStart
localDateTimeStart
dateEnd
dateTimeEnd
localDateTimeEnd
categories {
...CalendarEventCategoryFragment
}
registrationRequired
publicRegistrationAllowed
allDay
maxSignUps
minSignUps
multiSignUpAllowed
memberListVisibility
maxAdditionalSignUps
registrationCount
deadlineStartOffsetMinutes
startOfRegistrationOffsetMinutes
cancelRegistrationDeadlineOffsetMinutes
requestCount
iconImage {
...MediaReferenceFragment
}
resources {
...MediaReferenceFragment
}
location {
...LocationFragment
}
detailLink
seats
ownRegistrations {
...CalendarEventRegistrationFragment
}
ownerId
owner {
...UserProfileFragment
}
contactId
contact {
...UserProfileFragment
}
contactGroupId
contactGroup {
...GroupFragment
}
canWrite
onlineConference
notifyEventContactPersonOnSignUp
issueTicketsUponRegistration
manageAttendees
reminder {
...CalendarEventReminderFragment
}
paymentDocumentation
registrationFormId
registrationForm {
...CalendarRegistrationFormFragment
}
products {
...ProductDefinitionFragment
}
waitingListEnabled
badgeEnabled
lastModificationDate
}
}
Variables
{
"calendarIds": ["4"],
"range": DateRange,
"locationIds": [4],
"search": "xyz789"
}
Response
{
"data": {
"findCalendarEvents": [
{
"id": "4",
"calendarId": 4,
"seriesId": "4",
"title": "abc123",
"subTitle": "abc123",
"description": "xyz789",
"timeZoneId": "abc123",
"timeZoneOffset": "xyz789",
"dateStart": "2007-12-03",
"dateTimeStart": "xyz789",
"localDateTimeStart": "2020-07-19T08:45:59",
"dateEnd": "2007-12-03",
"dateTimeEnd": "xyz789",
"localDateTimeEnd": "2020-07-19T08:45:59",
"categories": [CalendarEventCategory],
"registrationRequired": false,
"publicRegistrationAllowed": false,
"allDay": true,
"maxSignUps": 123,
"minSignUps": 123,
"multiSignUpAllowed": true,
"memberListVisibility": "ADMIN",
"maxAdditionalSignUps": 123,
"registrationCount": 987,
"deadlineStartOffsetMinutes": 987,
"startOfRegistrationOffsetMinutes": 987,
"cancelRegistrationDeadlineOffsetMinutes": 123,
"requestCount": 987,
"iconImage": MediaReference,
"resources": [MediaReference],
"location": Location,
"detailLink": "xyz789",
"seats": ["xyz789"],
"ownRegistrations": [CalendarEventRegistration],
"ownerId": "xyz789",
"owner": UserProfile,
"contactId": "abc123",
"contact": UserProfile,
"contactGroupId": 4,
"contactGroup": Group,
"canWrite": false,
"onlineConference": true,
"notifyEventContactPersonOnSignUp": true,
"issueTicketsUponRegistration": false,
"manageAttendees": true,
"reminder": CalendarEventReminder,
"paymentDocumentation": false,
"registrationFormId": "4",
"registrationForm": CalendarRegistrationForm,
"products": [ProductDefinition],
"waitingListEnabled": false,
"badgeEnabled": true,
"lastModificationDate": "2007-12-03"
}
]
}
}
findGroupSpace
Description
Lädt ein Group Space
Response
Returns a GroupSpace
Arguments
| Name | Description |
|---|---|
spaceId - ID!
|
Example
Query
query findGroupSpace($spaceId: ID!) {
findGroupSpace(spaceId: $spaceId) {
description
name
headerImageUrl
id
conferenceRoomEnabled
fileStoreEnabled
fileStoreMembersWrite
conferenceRoom {
...ConferenceFragment
}
links {
...GroupSpaceLinkFragment
}
members {
...UserProfileBasicDataFragment
}
leaders {
...UserProfileBasicDataFragment
}
leader
badge
}
}
Variables
{"spaceId": "4"}
Response
{
"data": {
"findGroupSpace": {
"description": "abc123",
"name": "abc123",
"headerImageUrl": "abc123",
"id": 4,
"conferenceRoomEnabled": false,
"fileStoreEnabled": true,
"fileStoreMembersWrite": false,
"conferenceRoom": Conference,
"links": [GroupSpaceLink],
"members": [UserProfileBasicData],
"leaders": [UserProfileBasicData],
"leader": false,
"badge": 987
}
}
}
findOneUserProfile
Description
Lädt einen App-Nutzer
Response
Returns a UserProfile
Arguments
| Name | Description |
|---|---|
profileId - String!
|
Example
Query
query findOneUserProfile($profileId: String!) {
findOneUserProfile(profileId: $profileId) {
salutation {
...CustomEnumValueFragment
}
roles {
...CustomEnumValueFragment
}
requestedRoles {
...CustomEnumValueFragment
}
departments {
...CustomEnumValueFragment
}
groups {
...GroupFragment
}
id
externalId
lastModified
created
appId
appGroup
name
firstname
email
birthday
title
imageId
imageThumbId
deviceIds
membershipNumber
agreedToAds
verificationPending
mailConfirmationPending
locked
mainProfile
familyProfileNumber
locale
country {
...CustomEnumValueFragment
}
degree
nickname
street
postcode
city
state
phone
phoneMobile
phoneMobileRequest
phoneMobileVerificationStatus
identityNumber
personnelNumber
level
sports
companyName
companyDepartment
companyFunction
university
community
maritalStatus
skills
specialization
offers
interests
bankAccountHolder
bankBIC
bankIBAN
bankName
bankSEPARef
bankSEPADate
feeKind
feeAmount
paymentMethod
entryDate
exitDate
coachingLicense
customerNumber
dataPrivacyStatementAccepted
datePrivacyStatementAccepted
dataTermsOfUseAccepted
dateTermsOfUseAccepted
statutesAccepted
chatRulesAccepted
publicProfile
remarks
members {
...UserProfileFragment
}
accountActive
chatAccount
activationCode
clubName
clubNumber
team
playerPosition
playerNumber
playerHeight
licenseNumber
realname
customFields
agreedDisplayName
agreedDisplayPhone
agreedDisplayMail
}
}
Variables
{"profileId": "abc123"}
Response
{
"data": {
"findOneUserProfile": {
"salutation": CustomEnumValue,
"roles": [CustomEnumValue],
"requestedRoles": [CustomEnumValue],
"departments": [CustomEnumValue],
"groups": [Group],
"id": "xyz789",
"externalId": "xyz789",
"lastModified": "2007-12-03",
"created": "2007-12-03",
"appId": "abc123",
"appGroup": "abc123",
"name": "xyz789",
"firstname": "xyz789",
"email": "xyz789",
"birthday": "2007-12-03",
"title": "xyz789",
"imageId": "abc123",
"imageThumbId": "abc123",
"deviceIds": ["abc123"],
"membershipNumber": "xyz789",
"agreedToAds": true,
"verificationPending": true,
"mailConfirmationPending": false,
"locked": false,
"mainProfile": false,
"familyProfileNumber": "abc123",
"locale": "xyz789",
"country": CustomEnumValue,
"degree": "abc123",
"nickname": "xyz789",
"street": "abc123",
"postcode": "xyz789",
"city": "abc123",
"state": "abc123",
"phone": "xyz789",
"phoneMobile": "xyz789",
"phoneMobileRequest": "xyz789",
"phoneMobileVerificationStatus": "REQUIRED",
"identityNumber": "xyz789",
"personnelNumber": "abc123",
"level": "abc123",
"sports": "xyz789",
"companyName": "abc123",
"companyDepartment": "xyz789",
"companyFunction": "xyz789",
"university": "abc123",
"community": "abc123",
"maritalStatus": "abc123",
"skills": "abc123",
"specialization": "abc123",
"offers": "xyz789",
"interests": "abc123",
"bankAccountHolder": "xyz789",
"bankBIC": "xyz789",
"bankIBAN": "xyz789",
"bankName": "xyz789",
"bankSEPARef": "xyz789",
"bankSEPADate": "2007-12-03",
"feeKind": "xyz789",
"feeAmount": "abc123",
"paymentMethod": "xyz789",
"entryDate": "2007-12-03",
"exitDate": "2007-12-03",
"coachingLicense": true,
"customerNumber": "abc123",
"dataPrivacyStatementAccepted": "abc123",
"datePrivacyStatementAccepted": "2007-12-03",
"dataTermsOfUseAccepted": "xyz789",
"dateTermsOfUseAccepted": "2007-12-03",
"statutesAccepted": false,
"chatRulesAccepted": false,
"publicProfile": true,
"remarks": "abc123",
"members": [UserProfile],
"accountActive": true,
"chatAccount": true,
"activationCode": "xyz789",
"clubName": "abc123",
"clubNumber": "abc123",
"team": "abc123",
"playerPosition": "xyz789",
"playerNumber": "xyz789",
"playerHeight": 123,
"licenseNumber": "xyz789",
"realname": "abc123",
"customFields": {},
"agreedDisplayName": true,
"agreedDisplayPhone": true,
"agreedDisplayMail": false
}
}
}
findProjectSpecificationByNameLike
Description
Suche nach einer app
Response
Returns [ProjectSpecification]
Arguments
| Name | Description |
|---|---|
name - String!
|
Example
Query
query findProjectSpecificationByNameLike($name: String!) {
findProjectSpecificationByNameLike(name: $name) {
name
portalAppName
groupId
iosNavigationType
locale
components {
...ComponentReferenceFragment
}
}
}
Variables
{"name": "abc123"}
Response
{
"data": {
"findProjectSpecificationByNameLike": [
{
"name": "abc123",
"portalAppName": "xyz789",
"groupId": "xyz789",
"iosNavigationType": "abc123",
"locale": "xyz789",
"components": [ComponentReference]
}
]
}
}
findPushNotifications
Description
Listet alle Push Nachrichten zu einer App und mit bestimmtem Status
Response
Returns [PushNotification]
Arguments
| Name | Description |
|---|---|
status - PushNotificationStatus!
|
|
sort - Sort
|
|
limit - Int
|
Default = 100 |
Example
Query
query findPushNotifications(
$status: PushNotificationStatus!,
$sort: Sort,
$limit: Int
) {
findPushNotifications(
status: $status,
sort: $sort,
limit: $limit
) {
id
status
message
appId
androidUsers
iphoneUsers
androidUsersMax
iphoneUsersMax
username
badge
sheduleDate
sound
soundId
componentId
imageUrl
pending
componentReference {
...ComponentReferenceFragment
}
url
channelIds
channels {
...PushChannelFragment
}
roleIds
departmentIds
groupIds
dispatchDate
mode
publicPushNotification
}
}
Variables
{"status": "SCHEDULED", "sort": Sort, "limit": 100}
Response
{
"data": {
"findPushNotifications": [
{
"id": 4,
"status": "SCHEDULED",
"message": "xyz789",
"appId": "xyz789",
"androidUsers": 987,
"iphoneUsers": 987,
"androidUsersMax": 123,
"iphoneUsersMax": 987,
"username": "abc123",
"badge": 987,
"sheduleDate": "2007-12-03",
"sound": true,
"soundId": "xyz789",
"componentId": "abc123",
"imageUrl": "xyz789",
"pending": 987,
"componentReference": ComponentReference,
"url": "abc123",
"channelIds": ["abc123"],
"channels": [PushChannel],
"roleIds": ["abc123"],
"departmentIds": ["abc123"],
"groupIds": ["xyz789"],
"dispatchDate": "2007-12-03",
"mode": "NORMAL",
"publicPushNotification": false
}
]
}
}
findResourceByFilename
Example
Query
query findResourceByFilename(
$filename: String!,
$mimeType: String!
) {
findResourceByFilename(
filename: $filename,
mimeType: $mimeType
) {
id
url
notes
previewImageUrl
creationDate
lastModificationDate
mimeType
title
creator
resourceCategoryId
resourceCategory {
...ResourceCategoryFragment
}
width
height
contentLength
status
deviceId
user_comment
user_title
user_contact
user_category
lat
lng
}
}
Variables
{
"filename": "xyz789",
"mimeType": "abc123"
}
Response
{
"data": {
"findResourceByFilename": {
"id": 4,
"url": "xyz789",
"notes": "abc123",
"previewImageUrl": "abc123",
"creationDate": "2007-12-03",
"lastModificationDate": "2007-12-03",
"mimeType": "abc123",
"title": "abc123",
"creator": "xyz789",
"resourceCategoryId": "abc123",
"resourceCategory": ResourceCategory,
"width": 123,
"height": 987,
"contentLength": 123,
"status": "pending",
"deviceId": "abc123",
"user_comment": "abc123",
"user_title": "abc123",
"user_contact": "abc123",
"user_category": "abc123",
"lat": "abc123",
"lng": "abc123"
}
}
}
findResourceByTitle
Example
Query
query findResourceByTitle($title: String!) {
findResourceByTitle(title: $title) {
id
url
notes
previewImageUrl
creationDate
lastModificationDate
mimeType
title
creator
resourceCategoryId
resourceCategory {
...ResourceCategoryFragment
}
width
height
contentLength
status
deviceId
user_comment
user_title
user_contact
user_category
lat
lng
}
}
Variables
{"title": "xyz789"}
Response
{
"data": {
"findResourceByTitle": {
"id": 4,
"url": "abc123",
"notes": "abc123",
"previewImageUrl": "xyz789",
"creationDate": "2007-12-03",
"lastModificationDate": "2007-12-03",
"mimeType": "xyz789",
"title": "abc123",
"creator": "abc123",
"resourceCategoryId": "abc123",
"resourceCategory": ResourceCategory,
"width": 123,
"height": 987,
"contentLength": 123,
"status": "pending",
"deviceId": "abc123",
"user_comment": "xyz789",
"user_title": "abc123",
"user_contact": "abc123",
"user_category": "abc123",
"lat": "xyz789",
"lng": "abc123"
}
}
}
findResourceCategories
Response
Returns [ResourceCategory]
Arguments
| Name | Description |
|---|---|
scope - String!
|
Example
Query
query findResourceCategories($scope: String!) {
findResourceCategories(scope: $scope) {
id
name
scope
color
lastModificationDate
}
}
Variables
{"scope": "xyz789"}
Response
{
"data": {
"findResourceCategories": [
{
"id": 4,
"name": "xyz789",
"scope": "xyz789",
"color": "abc123",
"lastModificationDate": "2007-12-03"
}
]
}
}
findResources
Response
Returns a ResourcePagingResponse
Arguments
| Name | Description |
|---|---|
search - ResourceSearchCriteria!
|
|
page - PageRequest
|
Example
Query
query findResources(
$search: ResourceSearchCriteria!,
$page: PageRequest
) {
findResources(
search: $search,
page: $page
) {
content {
...ResourceFragment
}
totalcount
}
}
Variables
{
"search": ResourceSearchCriteria,
"page": PageRequest
}
Response
{
"data": {
"findResources": {
"content": [Resource],
"totalcount": 987
}
}
}
findResourcesByIds
Response
Returns [Resource]
Arguments
| Name | Description |
|---|---|
ids - [ID]!
|
Example
Query
query findResourcesByIds($ids: [ID]!) {
findResourcesByIds(ids: $ids) {
id
url
notes
previewImageUrl
creationDate
lastModificationDate
mimeType
title
creator
resourceCategoryId
resourceCategory {
...ResourceCategoryFragment
}
width
height
contentLength
status
deviceId
user_comment
user_title
user_contact
user_category
lat
lng
}
}
Variables
{"ids": ["4"]}
Response
{
"data": {
"findResourcesByIds": [
{
"id": 4,
"url": "abc123",
"notes": "abc123",
"previewImageUrl": "xyz789",
"creationDate": "2007-12-03",
"lastModificationDate": "2007-12-03",
"mimeType": "abc123",
"title": "xyz789",
"creator": "abc123",
"resourceCategoryId": "xyz789",
"resourceCategory": ResourceCategory,
"width": 123,
"height": 987,
"contentLength": 987,
"status": "pending",
"deviceId": "xyz789",
"user_comment": "abc123",
"user_title": "abc123",
"user_contact": "abc123",
"user_category": "abc123",
"lat": "abc123",
"lng": "abc123"
}
]
}
}
findResourcesByMimeType
Response
Returns [Resource]
Arguments
| Name | Description |
|---|---|
mimeType - String!
|
Example
Query
query findResourcesByMimeType($mimeType: String!) {
findResourcesByMimeType(mimeType: $mimeType) {
id
url
notes
previewImageUrl
creationDate
lastModificationDate
mimeType
title
creator
resourceCategoryId
resourceCategory {
...ResourceCategoryFragment
}
width
height
contentLength
status
deviceId
user_comment
user_title
user_contact
user_category
lat
lng
}
}
Variables
{"mimeType": "abc123"}
Response
{
"data": {
"findResourcesByMimeType": [
{
"id": 4,
"url": "abc123",
"notes": "xyz789",
"previewImageUrl": "abc123",
"creationDate": "2007-12-03",
"lastModificationDate": "2007-12-03",
"mimeType": "xyz789",
"title": "abc123",
"creator": "abc123",
"resourceCategoryId": "xyz789",
"resourceCategory": ResourceCategory,
"width": 123,
"height": 123,
"contentLength": 987,
"status": "pending",
"deviceId": "abc123",
"user_comment": "abc123",
"user_title": "xyz789",
"user_contact": "abc123",
"user_category": "xyz789",
"lat": "abc123",
"lng": "abc123"
}
]
}
}
findTimeSeriesById
Description
lädt die Timeseries Information zur gegebenen Id, jedoch nicht die Datenpunkte
Response
Returns a TimeSeries
Arguments
| Name | Description |
|---|---|
timeSeriesId - ID!
|
Example
Query
query findTimeSeriesById($timeSeriesId: ID!) {
findTimeSeriesById(timeSeriesId: $timeSeriesId) {
id
name
appId
unit
granularity
latestEntry {
...TimeSeriesDataFragment
}
delta
metaData
roleVisibility {
...CustomEnumValueFragment
}
visible
lastModified
}
}
Variables
{"timeSeriesId": 4}
Response
{
"data": {
"findTimeSeriesById": {
"id": 4,
"name": "xyz789",
"appId": AppID,
"unit": "xyz789",
"granularity": "abc123",
"latestEntry": TimeSeriesData,
"delta": 123.45,
"metaData": {},
"roleVisibility": [CustomEnumValue],
"visible": true,
"lastModified": "2007-12-03"
}
}
}
findUserProfile
Description
Listet alle registrierten App-Nutzer zu einer AppId und dem optional gegebenen Suchfilter.
Response
Returns a UserProfilePagingResponse
Arguments
| Name | Description |
|---|---|
search - String
|
Default = "" |
page - PageRequest
|
Example
Query
query findUserProfile(
$search: String,
$page: PageRequest
) {
findUserProfile(
search: $search,
page: $page
) {
content {
...UserProfileFragment
}
totalcount
}
}
Variables
{"search": "", "page": PageRequest}
Response
{
"data": {
"findUserProfile": {
"content": [UserProfile],
"totalcount": 987
}
}
}
findUserProfilesModifiedSince
Description
Listet alle Benutzerprofile, die seit dem genannten Datum geändert wurden
Response
Returns [UserProfile]
Arguments
| Name | Description |
|---|---|
since - Date
|
Example
Query
query findUserProfilesModifiedSince($since: Date) {
findUserProfilesModifiedSince(since: $since) {
salutation {
...CustomEnumValueFragment
}
roles {
...CustomEnumValueFragment
}
requestedRoles {
...CustomEnumValueFragment
}
departments {
...CustomEnumValueFragment
}
groups {
...GroupFragment
}
id
externalId
lastModified
created
appId
appGroup
name
firstname
email
birthday
title
imageId
imageThumbId
deviceIds
membershipNumber
agreedToAds
verificationPending
mailConfirmationPending
locked
mainProfile
familyProfileNumber
locale
country {
...CustomEnumValueFragment
}
degree
nickname
street
postcode
city
state
phone
phoneMobile
phoneMobileRequest
phoneMobileVerificationStatus
identityNumber
personnelNumber
level
sports
companyName
companyDepartment
companyFunction
university
community
maritalStatus
skills
specialization
offers
interests
bankAccountHolder
bankBIC
bankIBAN
bankName
bankSEPARef
bankSEPADate
feeKind
feeAmount
paymentMethod
entryDate
exitDate
coachingLicense
customerNumber
dataPrivacyStatementAccepted
datePrivacyStatementAccepted
dataTermsOfUseAccepted
dateTermsOfUseAccepted
statutesAccepted
chatRulesAccepted
publicProfile
remarks
members {
...UserProfileFragment
}
accountActive
chatAccount
activationCode
clubName
clubNumber
team
playerPosition
playerNumber
playerHeight
licenseNumber
realname
customFields
agreedDisplayName
agreedDisplayPhone
agreedDisplayMail
}
}
Variables
{"since": "2007-12-03"}
Response
{
"data": {
"findUserProfilesModifiedSince": [
{
"salutation": CustomEnumValue,
"roles": [CustomEnumValue],
"requestedRoles": [CustomEnumValue],
"departments": [CustomEnumValue],
"groups": [Group],
"id": "xyz789",
"externalId": "xyz789",
"lastModified": "2007-12-03",
"created": "2007-12-03",
"appId": "xyz789",
"appGroup": "abc123",
"name": "abc123",
"firstname": "xyz789",
"email": "abc123",
"birthday": "2007-12-03",
"title": "abc123",
"imageId": "abc123",
"imageThumbId": "xyz789",
"deviceIds": ["abc123"],
"membershipNumber": "abc123",
"agreedToAds": true,
"verificationPending": false,
"mailConfirmationPending": false,
"locked": true,
"mainProfile": true,
"familyProfileNumber": "abc123",
"locale": "xyz789",
"country": CustomEnumValue,
"degree": "abc123",
"nickname": "xyz789",
"street": "xyz789",
"postcode": "abc123",
"city": "abc123",
"state": "xyz789",
"phone": "xyz789",
"phoneMobile": "abc123",
"phoneMobileRequest": "abc123",
"phoneMobileVerificationStatus": "REQUIRED",
"identityNumber": "abc123",
"personnelNumber": "abc123",
"level": "abc123",
"sports": "abc123",
"companyName": "abc123",
"companyDepartment": "xyz789",
"companyFunction": "abc123",
"university": "xyz789",
"community": "xyz789",
"maritalStatus": "xyz789",
"skills": "abc123",
"specialization": "xyz789",
"offers": "xyz789",
"interests": "abc123",
"bankAccountHolder": "xyz789",
"bankBIC": "abc123",
"bankIBAN": "abc123",
"bankName": "xyz789",
"bankSEPARef": "xyz789",
"bankSEPADate": "2007-12-03",
"feeKind": "abc123",
"feeAmount": "abc123",
"paymentMethod": "xyz789",
"entryDate": "2007-12-03",
"exitDate": "2007-12-03",
"coachingLicense": true,
"customerNumber": "xyz789",
"dataPrivacyStatementAccepted": "abc123",
"datePrivacyStatementAccepted": "2007-12-03",
"dataTermsOfUseAccepted": "xyz789",
"dateTermsOfUseAccepted": "2007-12-03",
"statutesAccepted": true,
"chatRulesAccepted": false,
"publicProfile": false,
"remarks": "abc123",
"members": [UserProfile],
"accountActive": true,
"chatAccount": false,
"activationCode": "abc123",
"clubName": "abc123",
"clubNumber": "xyz789",
"team": "xyz789",
"playerPosition": "abc123",
"playerNumber": "abc123",
"playerHeight": 123,
"licenseNumber": "abc123",
"realname": "abc123",
"customFields": {},
"agreedDisplayName": false,
"agreedDisplayPhone": true,
"agreedDisplayMail": true
}
]
}
}
findUsers
Response
Returns a UserPagingResponse
Arguments
| Name | Description |
|---|---|
search - String
|
|
page - PageRequest
|
Example
Query
query findUsers(
$search: String,
$page: PageRequest
) {
findUsers(
search: $search,
page: $page
) {
content {
...UserFragment
}
totalcount
}
}
Variables
{
"search": "xyz789",
"page": PageRequest
}
Response
{
"data": {
"findUsers": {"content": [User], "totalcount": 987}
}
}
getAndroidAppStoreSettings
Description
Ruft die Einstellungen für den IOS Store ab
Response
Returns a ProjectMetadata
Example
Query
query getAndroidAppStoreSettings {
getAndroidAppStoreSettings {
ios_appname
ios_subname
ios_app_short_name
ios_description
ios_keywords
ios_support_url
ios_marketing_url
ios_copyright
ios_category_a
ios_category_b
ios_promotext
ios_appicon_76x76_url
ios_appicon_152x152_url
ios_appicon_180x180_url
ios_appicon_167x167_url
ios_splasscreen_1242x2208_url
ios_appicon_big_url
ios_high_resolution_icon_url
ios_askForUpdate
ios_goinglive
ios_lastUpdate
ios_libVersion
ios_developer_Account
ios_dev_comment
ios_appstore_link
aos_appname
aos_adverttext
aos_website
aos_category
aos_short_description
aos_description
aos_appicon_url
aos_splasscreenicon_url
aos_high_resolution_icon_url
aos_function_icon_url
aos_advert_icon_url
advertisingGraphic_url
aos_askForUpdate
aos_goinglive
aos_lastUpdate
aos_libVersion
aos_dev_comment
aos_firebase_project_id
aos_developer_account
aos_appstore_link
portalAppName
facebookPage
projectDescription
portalAppIconUrl
videoQuotaMB
contractGroup
aos_fcm_server_key
projectType
}
}
Response
{
"data": {
"getAndroidAppStoreSettings": {
"ios_appname": "xyz789",
"ios_subname": "xyz789",
"ios_app_short_name": "xyz789",
"ios_description": "xyz789",
"ios_keywords": "abc123",
"ios_support_url": "xyz789",
"ios_marketing_url": "abc123",
"ios_copyright": "abc123",
"ios_category_a": "abc123",
"ios_category_b": "abc123",
"ios_promotext": "xyz789",
"ios_appicon_76x76_url": "abc123",
"ios_appicon_152x152_url": "xyz789",
"ios_appicon_180x180_url": "abc123",
"ios_appicon_167x167_url": "xyz789",
"ios_splasscreen_1242x2208_url": "abc123",
"ios_appicon_big_url": "abc123",
"ios_high_resolution_icon_url": "xyz789",
"ios_askForUpdate": false,
"ios_goinglive": "2007-12-03",
"ios_lastUpdate": "2007-12-03",
"ios_libVersion": 123,
"ios_developer_Account": "abc123",
"ios_dev_comment": "xyz789",
"ios_appstore_link": "xyz789",
"aos_appname": "xyz789",
"aos_adverttext": "abc123",
"aos_website": "xyz789",
"aos_category": "abc123",
"aos_short_description": "abc123",
"aos_description": "xyz789",
"aos_appicon_url": "abc123",
"aos_splasscreenicon_url": "abc123",
"aos_high_resolution_icon_url": "xyz789",
"aos_function_icon_url": "abc123",
"aos_advert_icon_url": "abc123",
"advertisingGraphic_url": "abc123",
"aos_askForUpdate": false,
"aos_goinglive": "2007-12-03",
"aos_lastUpdate": "2007-12-03",
"aos_libVersion": 123,
"aos_dev_comment": "xyz789",
"aos_firebase_project_id": "xyz789",
"aos_developer_account": "abc123",
"aos_appstore_link": "abc123",
"portalAppName": "xyz789",
"facebookPage": "abc123",
"projectDescription": "abc123",
"portalAppIconUrl": "abc123",
"videoQuotaMB": "abc123",
"contractGroup": "xyz789",
"aos_fcm_server_key": "xyz789",
"projectType": "abc123"
}
}
}
getAppAdminQRCode
Description
App-Admin-QR-Code erzeugen
getAppackProject
Description
Liefert den umschließenden Projekt-Container mit allen vorhandenen Versionen.
Response
Returns an AppackProject
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query getAppackProject($id: ID!) {
getAppackProject(id: $id) {
id
languages
structureRootId
versions {
...AppackProjectVersionFragment
}
}
}
Variables
{"id": 4}
Response
{
"data": {
"getAppackProject": {
"id": 4,
"languages": ["zh-cmn-Hans-CN"],
"structureRootId": "4",
"versions": [AppackProjectVersion]
}
}
}
getAppackProjectVersionForLanguage
Description
Liefert gezielt eine Projekt-Sprachversion.
Response
Returns an AppackProjectVersion
Example
Query
query getAppackProjectVersionForLanguage(
$id: ID!,
$language: Locale
) {
getAppackProjectVersionForLanguage(
id: $id,
language: $language
) {
id
label
language
structureRootId
structureNodes {
...StructureNodeFragment
}
navigationList {
...NavigationNodeFragment
}
}
}
Variables
{"id": 4, "language": "zh-cmn-Hans-CN"}
Response
{
"data": {
"getAppackProjectVersionForLanguage": {
"id": "4",
"label": "abc123",
"language": "zh-cmn-Hans-CN",
"structureRootId": 4,
"structureNodes": [StructureNode],
"navigationList": [NavigationNode]
}
}
}
getBadges
Description
Gibt die Komponenten mit einem Badge-Icon zurück
Response
Returns [BadgeResult]
Example
Query
query getBadges {
getBadges {
component
badge
}
}
Response
{
"data": {
"getBadges": [
{"component": "abc123", "badge": 123}
]
}
}
getBonusBooklet
Description
Ruft ein Bonusheft ab
Response
Returns a BonusBooklet
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query getBonusBooklet($id: ID!) {
getBonusBooklet(id: $id) {
id
lastModified
bookletImage {
...ResourceFragment
}
bookletImageUrl
bookletImageId
stampImage {
...ResourceFragment
}
stampImageUrl
stampImageId
backgroundColor
couponId
coupon {
...CouponFragment
}
active
stamps {
...StampFragment
}
expires
}
}
Variables
{"id": "4"}
Response
{
"data": {
"getBonusBooklet": {
"id": 4,
"lastModified": "2007-12-03",
"bookletImage": Resource,
"bookletImageUrl": "xyz789",
"bookletImageId": 4,
"stampImage": Resource,
"stampImageUrl": "xyz789",
"stampImageId": "4",
"backgroundColor": "abc123",
"couponId": 4,
"coupon": Coupon,
"active": true,
"stamps": [Stamp],
"expires": "2007-12-03"
}
}
}
getBookmarks
Description
Lade die Lesezeichen die vom Nutzer in der App gespeichert wurden
Response
Returns a UserBookmarks
Example
Query
query getBookmarks {
getBookmarks {
refs {
...UserBookmarkRefFragment
}
}
}
Response
{"data": {"getBookmarks": {"refs": [UserBookmarkRef]}}}
getCalendarComponentICalFeedURL
Description
Liefert eine verkürzte URL zu einem ICal-Feed, der alle Termine aller öffentlichen Kalender enthält.
getCalendarEmbedUrl
Description
Liefert eine verkürzte URL, welche es ermöglicht alle öffentlichen Kalender der Komponente in der Hompage einzubetten.
getCalendarEventById
Description
Zugriff auf einen einzelnen Event
Response
Returns a CalendarEvent
Arguments
| Name | Description |
|---|---|
calendarEventId - ID!
|
Example
Query
query getCalendarEventById($calendarEventId: ID!) {
getCalendarEventById(calendarEventId: $calendarEventId) {
id
calendarId
seriesId
title
subTitle
description
timeZoneId
timeZoneOffset
dateStart
dateTimeStart
localDateTimeStart
dateEnd
dateTimeEnd
localDateTimeEnd
categories {
...CalendarEventCategoryFragment
}
registrationRequired
publicRegistrationAllowed
allDay
maxSignUps
minSignUps
multiSignUpAllowed
memberListVisibility
maxAdditionalSignUps
registrationCount
deadlineStartOffsetMinutes
startOfRegistrationOffsetMinutes
cancelRegistrationDeadlineOffsetMinutes
requestCount
iconImage {
...MediaReferenceFragment
}
resources {
...MediaReferenceFragment
}
location {
...LocationFragment
}
detailLink
seats
ownRegistrations {
...CalendarEventRegistrationFragment
}
ownerId
owner {
...UserProfileFragment
}
contactId
contact {
...UserProfileFragment
}
contactGroupId
contactGroup {
...GroupFragment
}
canWrite
onlineConference
notifyEventContactPersonOnSignUp
issueTicketsUponRegistration
manageAttendees
reminder {
...CalendarEventReminderFragment
}
paymentDocumentation
registrationFormId
registrationForm {
...CalendarRegistrationFormFragment
}
products {
...ProductDefinitionFragment
}
waitingListEnabled
badgeEnabled
lastModificationDate
}
}
Variables
{"calendarEventId": 4}
Response
{
"data": {
"getCalendarEventById": {
"id": 4,
"calendarId": 4,
"seriesId": "4",
"title": "xyz789",
"subTitle": "abc123",
"description": "abc123",
"timeZoneId": "abc123",
"timeZoneOffset": "xyz789",
"dateStart": "2007-12-03",
"dateTimeStart": "xyz789",
"localDateTimeStart": "2020-07-19T08:45:59",
"dateEnd": "2007-12-03",
"dateTimeEnd": "xyz789",
"localDateTimeEnd": "2020-07-19T08:45:59",
"categories": [CalendarEventCategory],
"registrationRequired": false,
"publicRegistrationAllowed": false,
"allDay": true,
"maxSignUps": 987,
"minSignUps": 123,
"multiSignUpAllowed": true,
"memberListVisibility": "ADMIN",
"maxAdditionalSignUps": 123,
"registrationCount": 123,
"deadlineStartOffsetMinutes": 987,
"startOfRegistrationOffsetMinutes": 123,
"cancelRegistrationDeadlineOffsetMinutes": 123,
"requestCount": 987,
"iconImage": MediaReference,
"resources": [MediaReference],
"location": Location,
"detailLink": "abc123",
"seats": ["abc123"],
"ownRegistrations": [CalendarEventRegistration],
"ownerId": "xyz789",
"owner": UserProfile,
"contactId": "xyz789",
"contact": UserProfile,
"contactGroupId": 4,
"contactGroup": Group,
"canWrite": false,
"onlineConference": false,
"notifyEventContactPersonOnSignUp": false,
"issueTicketsUponRegistration": true,
"manageAttendees": true,
"reminder": CalendarEventReminder,
"paymentDocumentation": true,
"registrationFormId": "4",
"registrationForm": CalendarRegistrationForm,
"products": [ProductDefinition],
"waitingListEnabled": true,
"badgeEnabled": true,
"lastModificationDate": "2007-12-03"
}
}
}
getCalendarICalFeedUrl
Description
Liefert eine verkürzte URL, welche von externen Diensten (z.B Google Kalender) benutzt werden kann, um einen Kalender zu abonnieren, sofern der Kalender dafür freigeschaltet wurde.
getCalendarRegistrationForm
Description
Liefert das Registrierungsformular
Response
Returns a CalendarRegistrationForm
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query getCalendarRegistrationForm($id: ID!) {
getCalendarRegistrationForm(id: $id) {
name
id
header
footer
fields {
...WorksheetColumnMetaDataFragment
}
usedInEventsCount
}
}
Variables
{"id": 4}
Response
{
"data": {
"getCalendarRegistrationForm": {
"name": "abc123",
"id": 4,
"header": "abc123",
"footer": "abc123",
"fields": [WorksheetColumnMetaData],
"usedInEventsCount": {}
}
}
}
getCalendarRegistrationForms
Description
Liefert alle Registrierungsformulare der App
Response
Returns [CalendarRegistrationForm]
Example
Query
query getCalendarRegistrationForms {
getCalendarRegistrationForms {
name
id
header
footer
fields {
...WorksheetColumnMetaDataFragment
}
usedInEventsCount
}
}
Response
{
"data": {
"getCalendarRegistrationForms": [
{
"name": "abc123",
"id": 4,
"header": "abc123",
"footer": "abc123",
"fields": [WorksheetColumnMetaData],
"usedInEventsCount": {}
}
]
}
}
getCalender
Description
Gibt den angeforderten Kalender zurück
Example
Query
query getCalender($calendarId: ID!) {
getCalender(calendarId: $calendarId) {
id
appId
componentIds
title
color
description
readerRoles {
...CustomEnumValueFragment
}
writerRoles {
...CustomEnumValueFragment
}
readerGroupIds
readerGroups {
...GroupFragment
}
writerGroupIds
writerGroups {
...GroupFragment
}
ownedByGroupId
categories {
...CalendarEventCategoryFragment
}
iCalUrl
iCalLastSynced
canRead
canWrite
hints
}
}
Variables
{"calendarId": 4}
Response
{
"data": {
"getCalender": {
"id": 4,
"appId": AppID,
"componentIds": [4],
"title": "xyz789",
"color": Color,
"description": "xyz789",
"readerRoles": [CustomEnumValue],
"writerRoles": [CustomEnumValue],
"readerGroupIds": ["abc123"],
"readerGroups": [Group],
"writerGroupIds": ["xyz789"],
"writerGroups": [Group],
"ownedByGroupId": "abc123",
"categories": [CalendarEventCategory],
"iCalUrl": Url,
"iCalLastSynced": "2007-12-03",
"canRead": true,
"canWrite": false,
"hints": ["abc123"]
}
}
}
getChildrenOfProjectStructureNode
Description
lädt nur die untergeordnete Ebene des gegebenen Nodes.
Response
Returns [ProjectStructureNode]
Arguments
| Name | Description |
|---|---|
parentId - ID!
|
Example
Query
query getChildrenOfProjectStructureNode($parentId: ID!) {
getChildrenOfProjectStructureNode(parentId: $parentId) {
id
parentId
label
component {
...ComponentReferenceFragment
}
categories {
...ProjectStructureNodeCategoryFragment
}
children
}
}
Variables
{"parentId": "4"}
Response
{
"data": {
"getChildrenOfProjectStructureNode": [
{
"id": "4",
"parentId": 4,
"label": "abc123",
"component": ComponentReference,
"categories": [ProjectStructureNodeCategory],
"children": ["abc123"]
}
]
}
}
getDevicePushNotifications
Description
Liefert die Push-Nachrichten für das aktuelle Device. Optional kann eine ModulId mitgegeben werden. Dann werden nur die Push-Nachrichtne zurückgegeben die als Target das Modul haben.
Response
Returns [PushNotification]
Example
Query
query getDevicePushNotifications(
$from: Date!,
$to: Date!,
$componentId: String
) {
getDevicePushNotifications(
from: $from,
to: $to,
componentId: $componentId
) {
id
status
message
appId
androidUsers
iphoneUsers
androidUsersMax
iphoneUsersMax
username
badge
sheduleDate
sound
soundId
componentId
imageUrl
pending
componentReference {
...ComponentReferenceFragment
}
url
channelIds
channels {
...PushChannelFragment
}
roleIds
departmentIds
groupIds
dispatchDate
mode
publicPushNotification
}
}
Variables
{
"from": "2007-12-03",
"to": "2007-12-03",
"componentId": "abc123"
}
Response
{
"data": {
"getDevicePushNotifications": [
{
"id": 4,
"status": "SCHEDULED",
"message": "xyz789",
"appId": "xyz789",
"androidUsers": 987,
"iphoneUsers": 123,
"androidUsersMax": 987,
"iphoneUsersMax": 987,
"username": "xyz789",
"badge": 987,
"sheduleDate": "2007-12-03",
"sound": false,
"soundId": "abc123",
"componentId": "abc123",
"imageUrl": "xyz789",
"pending": 123,
"componentReference": ComponentReference,
"url": "xyz789",
"channelIds": ["xyz789"],
"channels": [PushChannel],
"roleIds": ["xyz789"],
"departmentIds": ["abc123"],
"groupIds": ["abc123"],
"dispatchDate": "2007-12-03",
"mode": "NORMAL",
"publicPushNotification": false
}
]
}
}
getDivisions
Response
Returns [Division]
Example
Query
query getDivisions {
getDivisions {
id
name
description
}
}
Response
{
"data": {
"getDivisions": [
{
"id": 4,
"name": "xyz789",
"description": "xyz789"
}
]
}
}
getEmbedToken
Description
Liefert ein anonymen Token um z.B. Komponenten in die Website einbzubinden.
Response
Returns a String
Example
Query
query getEmbedToken {
getEmbedToken
}
Response
{"data": {"getEmbedToken": "xyz789"}}
getGroup
Description
liefert die Gruppe bei bekannter Id
Example
Query
query getGroup($id: ID!) {
getGroup(id: $id) {
id
appId
name
memberIds
members {
...UserProfileBasicDataFragment
}
leaderIds
leaders {
...UserProfileBasicDataFragment
}
roles
system
numberOfMembers
description
publicGroup
listedGroup
icon {
...ResourceFragment
}
iconId
leader
groupSpaceEnabled
}
}
Variables
{"id": "4"}
Response
{
"data": {
"getGroup": {
"id": "4",
"appId": AppID,
"name": "abc123",
"memberIds": ["abc123"],
"members": [UserProfileBasicData],
"leaderIds": ["xyz789"],
"leaders": [UserProfileBasicData],
"roles": ["xyz789"],
"system": true,
"numberOfMembers": 123,
"description": "xyz789",
"publicGroup": true,
"listedGroup": false,
"icon": Resource,
"iconId": "xyz789",
"leader": true,
"groupSpaceEnabled": false
}
}
}
getIOSAppStoreSettings
Description
Ruft die Einstellungen für den IOS Store ab
Response
Returns a ProjectMetadata
Example
Query
query getIOSAppStoreSettings {
getIOSAppStoreSettings {
ios_appname
ios_subname
ios_app_short_name
ios_description
ios_keywords
ios_support_url
ios_marketing_url
ios_copyright
ios_category_a
ios_category_b
ios_promotext
ios_appicon_76x76_url
ios_appicon_152x152_url
ios_appicon_180x180_url
ios_appicon_167x167_url
ios_splasscreen_1242x2208_url
ios_appicon_big_url
ios_high_resolution_icon_url
ios_askForUpdate
ios_goinglive
ios_lastUpdate
ios_libVersion
ios_developer_Account
ios_dev_comment
ios_appstore_link
aos_appname
aos_adverttext
aos_website
aos_category
aos_short_description
aos_description
aos_appicon_url
aos_splasscreenicon_url
aos_high_resolution_icon_url
aos_function_icon_url
aos_advert_icon_url
advertisingGraphic_url
aos_askForUpdate
aos_goinglive
aos_lastUpdate
aos_libVersion
aos_dev_comment
aos_firebase_project_id
aos_developer_account
aos_appstore_link
portalAppName
facebookPage
projectDescription
portalAppIconUrl
videoQuotaMB
contractGroup
aos_fcm_server_key
projectType
}
}
Response
{
"data": {
"getIOSAppStoreSettings": {
"ios_appname": "xyz789",
"ios_subname": "abc123",
"ios_app_short_name": "abc123",
"ios_description": "abc123",
"ios_keywords": "xyz789",
"ios_support_url": "abc123",
"ios_marketing_url": "xyz789",
"ios_copyright": "xyz789",
"ios_category_a": "xyz789",
"ios_category_b": "xyz789",
"ios_promotext": "abc123",
"ios_appicon_76x76_url": "abc123",
"ios_appicon_152x152_url": "xyz789",
"ios_appicon_180x180_url": "xyz789",
"ios_appicon_167x167_url": "abc123",
"ios_splasscreen_1242x2208_url": "xyz789",
"ios_appicon_big_url": "abc123",
"ios_high_resolution_icon_url": "abc123",
"ios_askForUpdate": false,
"ios_goinglive": "2007-12-03",
"ios_lastUpdate": "2007-12-03",
"ios_libVersion": 987,
"ios_developer_Account": "xyz789",
"ios_dev_comment": "xyz789",
"ios_appstore_link": "xyz789",
"aos_appname": "abc123",
"aos_adverttext": "xyz789",
"aos_website": "xyz789",
"aos_category": "xyz789",
"aos_short_description": "abc123",
"aos_description": "xyz789",
"aos_appicon_url": "abc123",
"aos_splasscreenicon_url": "abc123",
"aos_high_resolution_icon_url": "abc123",
"aos_function_icon_url": "abc123",
"aos_advert_icon_url": "xyz789",
"advertisingGraphic_url": "abc123",
"aos_askForUpdate": true,
"aos_goinglive": "2007-12-03",
"aos_lastUpdate": "2007-12-03",
"aos_libVersion": 987,
"aos_dev_comment": "abc123",
"aos_firebase_project_id": "abc123",
"aos_developer_account": "abc123",
"aos_appstore_link": "abc123",
"portalAppName": "xyz789",
"facebookPage": "xyz789",
"projectDescription": "xyz789",
"portalAppIconUrl": "abc123",
"videoQuotaMB": "abc123",
"contractGroup": "abc123",
"aos_fcm_server_key": "xyz789",
"projectType": "abc123"
}
}
}
getPersonalThreshold
Description
lädt die Grenzwerteinstellungen des aktuellen Users zu der gegebenen TimeSeries
Example
Query
query getPersonalThreshold($timeSeriesId: ID!) {
getPersonalThreshold(timeSeriesId: $timeSeriesId) {
timeSeriesId
upper
lower
profileId
}
}
Variables
{"timeSeriesId": "4"}
Response
{
"data": {
"getPersonalThreshold": {
"timeSeriesId": "4",
"upper": 987.65,
"lower": 123.45,
"profileId": "4"
}
}
}
getProfileValidationStatus
Description
überprüft, ob zu der aktuellen DeviceId ein Profil im Status 'in Prüfung' gibt. Entweder weil die Mailadresse oder eine genehmigungspflichtige Rolle noch bestätigt werden muss.
Response
Returns a ProfileValidationStatus
Example
Query
query getProfileValidationStatus {
getProfileValidationStatus {
emailVerificationPending
roleVerificationPending
phoneVerificationPending
valid
}
}
Response
{
"data": {
"getProfileValidationStatus": {
"emailVerificationPending": true,
"roleVerificationPending": false,
"phoneVerificationPending": true,
"valid": false
}
}
}
getProjectSpecification
Description
Lädt die Spec des angegebenen Projekts
Response
Returns a ProjectSpecification
Example
Query
query getProjectSpecification {
getProjectSpecification {
name
portalAppName
groupId
iosNavigationType
locale
components {
...ComponentReferenceFragment
}
}
}
Response
{
"data": {
"getProjectSpecification": {
"name": "abc123",
"portalAppName": "xyz789",
"groupId": "xyz789",
"iosNavigationType": "abc123",
"locale": "xyz789",
"components": [ComponentReference]
}
}
}
getPushConfiguration
Description
Gibt die Push-Konfiguration zurück
Response
Returns a PushConfiguration
Example
Query
query getPushConfiguration {
getPushConfiguration {
forceSendOverPushChannel
preset {
...PushConfigurationPresetFragment
}
}
}
Response
{
"data": {
"getPushConfiguration": {
"forceSendOverPushChannel": true,
"preset": PushConfigurationPreset
}
}
}
getPushHistoryNotifications
Description
Liefert die Push-Nachrichten für das aktuelle Device. Wenn keine componentId übergeben wird, wird die erste Push-History-Komponente zur Auswertung herangezogen.
Response
Returns [PushNotification]
Arguments
| Name | Description |
|---|---|
componentId - ID
|
Example
Query
query getPushHistoryNotifications($componentId: ID) {
getPushHistoryNotifications(componentId: $componentId) {
id
status
message
appId
androidUsers
iphoneUsers
androidUsersMax
iphoneUsersMax
username
badge
sheduleDate
sound
soundId
componentId
imageUrl
pending
componentReference {
...ComponentReferenceFragment
}
url
channelIds
channels {
...PushChannelFragment
}
roleIds
departmentIds
groupIds
dispatchDate
mode
publicPushNotification
}
}
Variables
{"componentId": 4}
Response
{
"data": {
"getPushHistoryNotifications": [
{
"id": "4",
"status": "SCHEDULED",
"message": "abc123",
"appId": "abc123",
"androidUsers": 123,
"iphoneUsers": 123,
"androidUsersMax": 123,
"iphoneUsersMax": 987,
"username": "abc123",
"badge": 987,
"sheduleDate": "2007-12-03",
"sound": false,
"soundId": "xyz789",
"componentId": "abc123",
"imageUrl": "abc123",
"pending": 123,
"componentReference": ComponentReference,
"url": "xyz789",
"channelIds": ["abc123"],
"channels": [PushChannel],
"roleIds": ["xyz789"],
"departmentIds": ["xyz789"],
"groupIds": ["xyz789"],
"dispatchDate": "2007-12-03",
"mode": "NORMAL",
"publicPushNotification": true
}
]
}
}
getPushNotificationCertificateInfo
Response
Returns a PushCertificateInfo
Example
Query
query getPushNotificationCertificateInfo {
getPushNotificationCertificateInfo {
expireDate
expiresInDays
}
}
Response
{
"data": {
"getPushNotificationCertificateInfo": {
"expireDate": "2007-12-03",
"expiresInDays": 987
}
}
}
getSystemConfig
Response
Returns a SystemConfig
Example
Query
query getSystemConfig {
getSystemConfig {
cdnURL
qrCodeUrl
profile
applicationServerUrl
}
}
Response
{
"data": {
"getSystemConfig": {
"cdnURL": "xyz789",
"qrCodeUrl": "abc123",
"profile": "abc123",
"applicationServerUrl": "xyz789"
}
}
}
getToken
Description
liefert einen JWT token, welcher für nachfolgende API Aufrufe verwendet werden kann. Der Token hat eine Gültigkeit von 1 Stunde und hat die Berechtigungen (claims) welche bei dem API Key konfiguriert sind.
Response
Returns a String
Example
Query
query getToken {
getToken
}
Response
{"data": {"getToken": "abc123"}}
getTokenByMailAndPin
Description
Liefert einen Token mit den Rechten des zu der Mail gehörenden Benutzerprofils
Example
Query
query getTokenByMailAndPin(
$email: String!,
$pin: Int!
) {
getTokenByMailAndPin(
email: $email,
pin: $pin
)
}
Variables
{"email": "xyz789", "pin": 987}
Response
{"data": {"getTokenByMailAndPin": "abc123"}}
getUserDevices
Description
Liefert alle devices, welche mit dem aktuellen CMS-Benutzer ( für die aktuelle App) verbunden sind
Response
Returns [DeviceSummary]
Example
Query
query getUserDevices {
getUserDevices {
deviceId
lastConnect
osVersion
deviceName
deviceModel
deviceSystem
pin
}
}
Response
{
"data": {
"getUserDevices": [
{
"deviceId": "abc123",
"lastConnect": "2007-12-03",
"osVersion": "abc123",
"deviceName": "abc123",
"deviceModel": "xyz789",
"deviceSystem": "abc123",
"pin": "xyz789"
}
]
}
}
getUserProfileConfiguration
Description
Liefert die Einstellungen der Benutzer Profil Komponente
Response
Returns a UserProfileConfiguration!
Example
Query
query getUserProfileConfiguration {
getUserProfileConfiguration {
id
rolesVisibleOnRegistration
profileManagerEMail
registrationAllowed
editingAllowed
notifyOnRegistration
userProfileDeletion
supportFamilyMembership
familyMembershipEditable
autodeleteOnExitDate
allowDirectActivation
codeActivation
notifyOnChange
usedFields
unusedFields
customFields
fields {
...WorksheetColumnMetaDataFragment
}
note
roleKeysToVerify
roleKeysToUse
defaultRoles
dataPrivacyStatementUrl
dataTermsOfUseUrl
idCard
usePrivacyPage
useTermsOfUsePage
useGroups
useOpenIDConnect
phoneNumberVerificationRequired
url
birthdayMessageActive
birthdayMessageText
birthdayMessageTargetComponent
}
}
Response
{
"data": {
"getUserProfileConfiguration": {
"id": AppID,
"rolesVisibleOnRegistration": true,
"profileManagerEMail": "abc123",
"registrationAllowed": false,
"editingAllowed": false,
"notifyOnRegistration": true,
"userProfileDeletion": true,
"supportFamilyMembership": false,
"familyMembershipEditable": true,
"autodeleteOnExitDate": true,
"allowDirectActivation": false,
"codeActivation": false,
"notifyOnChange": true,
"usedFields": ["xyz789"],
"unusedFields": ["abc123"],
"customFields": ["abc123"],
"fields": [WorksheetColumnMetaData],
"note": "abc123",
"roleKeysToVerify": ["abc123"],
"roleKeysToUse": ["abc123"],
"defaultRoles": ["abc123"],
"dataPrivacyStatementUrl": "abc123",
"dataTermsOfUseUrl": "abc123",
"idCard": true,
"usePrivacyPage": true,
"useTermsOfUsePage": true,
"useGroups": false,
"useOpenIDConnect": true,
"phoneNumberVerificationRequired": true,
"url": "xyz789",
"birthdayMessageActive": false,
"birthdayMessageText": "abc123",
"birthdayMessageTargetComponent": "abc123"
}
}
}
groupSpaceDocuments
Description
Liefert den Dokumenten-Container zu einem Gruppen-Space
Example
Query
query groupSpaceDocuments($spaceId: ID!) {
groupSpaceDocuments(spaceId: $spaceId) {
id
files {
...FSFileFragment
}
writeAccess
operationLogAccess
acceptedFileTypes
}
}
Variables
{"spaceId": "4"}
Response
{
"data": {
"groupSpaceDocuments": {
"id": 4,
"files": [FSFile],
"writeAccess": true,
"operationLogAccess": true,
"acceptedFileTypes": ["abc123"]
}
}
}
isAppLive
Description
Prüft, ob die Ap live ist
Response
Returns a Boolean
Example
Query
query isAppLive {
isAppLive
}
Response
{"data": {"isAppLive": true}}
isMyDeviceConnectedToProfile
Description
Überprüft, ob die aktuelle DeviceId einem Profil zugewiesen ist - unabhängig von dem Token
Response
Returns a Boolean
Example
Query
query isMyDeviceConnectedToProfile {
isMyDeviceConnectedToProfile
}
Response
{"data": {"isMyDeviceConnectedToProfile": false}}
joinConference
Description
Fordert die Informationen zu einer bestehenden Konferenz an
Response
Returns a Conference
Arguments
| Name | Description |
|---|---|
input - ConferenceInput!
|
Example
Query
query joinConference($input: ConferenceInput!) {
joinConference(input: $input) {
id
room
url
guestUrl
end
phonePin {
...ConferencePhonePinFragment
}
}
}
Variables
{"input": ConferenceInput}
Response
{
"data": {
"joinConference": {
"id": "4",
"room": "xyz789",
"url": "abc123",
"guestUrl": "xyz789",
"end": "2007-12-03",
"phonePin": ConferencePhonePin
}
}
}
listAllProjectSpecifications
Description
Gibt alle Projekte zurück.
Response
Returns [ProjectSpecification]
Example
Query
query listAllProjectSpecifications {
listAllProjectSpecifications {
name
portalAppName
groupId
iosNavigationType
locale
components {
...ComponentReferenceFragment
}
}
}
Response
{
"data": {
"listAllProjectSpecifications": [
{
"name": "abc123",
"portalAppName": "xyz789",
"groupId": "abc123",
"iosNavigationType": "xyz789",
"locale": "abc123",
"components": [ComponentReference]
}
]
}
}
listCalendarByComponentId
Description
listet alle Kalender innerhalb einer Komponente
Response
Returns [Calendar]
Arguments
| Name | Description |
|---|---|
componentId - ID!
|
Example
Query
query listCalendarByComponentId($componentId: ID!) {
listCalendarByComponentId(componentId: $componentId) {
id
appId
componentIds
title
color
description
readerRoles {
...CustomEnumValueFragment
}
writerRoles {
...CustomEnumValueFragment
}
readerGroupIds
readerGroups {
...GroupFragment
}
writerGroupIds
writerGroups {
...GroupFragment
}
ownedByGroupId
categories {
...CalendarEventCategoryFragment
}
iCalUrl
iCalLastSynced
canRead
canWrite
hints
}
}
Variables
{"componentId": 4}
Response
{
"data": {
"listCalendarByComponentId": [
{
"id": 4,
"appId": AppID,
"componentIds": ["4"],
"title": "xyz789",
"color": Color,
"description": "abc123",
"readerRoles": [CustomEnumValue],
"writerRoles": [CustomEnumValue],
"readerGroupIds": ["xyz789"],
"readerGroups": [Group],
"writerGroupIds": ["xyz789"],
"writerGroups": [Group],
"ownedByGroupId": "xyz789",
"categories": [CalendarEventCategory],
"iCalUrl": Url,
"iCalLastSynced": "2007-12-03",
"canRead": true,
"canWrite": false,
"hints": ["xyz789"]
}
]
}
}
listCalendarEventRegistrations
Description
listet alle Registrierungen zu einer gegebenen Veranstaltung auf. Dieses ist nur durch den Eigentümer der Veranstaltung möglich.
Response
Returns [CalendarEventRegistration]
Arguments
| Name | Description |
|---|---|
calendarEventId - ID
|
Example
Query
query listCalendarEventRegistrations($calendarEventId: ID) {
listCalendarEventRegistrations(calendarEventId: $calendarEventId) {
id
creationDate
calendarEventId
seat {
...SeatFragment
}
comment
deviceId
clientId
client {
...UserProfileBasicDataFragment
}
status
waitingPosition
payed
formData
}
}
Variables
{"calendarEventId": 4}
Response
{
"data": {
"listCalendarEventRegistrations": [
{
"id": 4,
"creationDate": "2007-12-03",
"calendarEventId": 4,
"seat": Seat,
"comment": "xyz789",
"deviceId": "abc123",
"clientId": "xyz789",
"client": UserProfileBasicData,
"status": "xyz789",
"waitingPosition": 123,
"payed": false,
"formData": {}
}
]
}
}
listCalendars
Description
listet alle Kalender, die im aktuellen App Kontext vorhanden sind. (nur für CMS admins)
Response
Returns [Calendar]
Example
Query
query listCalendars {
listCalendars {
id
appId
componentIds
title
color
description
readerRoles {
...CustomEnumValueFragment
}
writerRoles {
...CustomEnumValueFragment
}
readerGroupIds
readerGroups {
...GroupFragment
}
writerGroupIds
writerGroups {
...GroupFragment
}
ownedByGroupId
categories {
...CalendarEventCategoryFragment
}
iCalUrl
iCalLastSynced
canRead
canWrite
hints
}
}
Response
{
"data": {
"listCalendars": [
{
"id": "4",
"appId": AppID,
"componentIds": ["4"],
"title": "abc123",
"color": Color,
"description": "abc123",
"readerRoles": [CustomEnumValue],
"writerRoles": [CustomEnumValue],
"readerGroupIds": ["abc123"],
"readerGroups": [Group],
"writerGroupIds": ["abc123"],
"writerGroups": [Group],
"ownedByGroupId": "xyz789",
"categories": [CalendarEventCategory],
"iCalUrl": Url,
"iCalLastSynced": "2007-12-03",
"canRead": true,
"canWrite": false,
"hints": ["abc123"]
}
]
}
}
listComponent
Description
Diese Abfrage ist zur Verwendung im CMS Kontext gedacht, um alle Konfigurationseinstellungen der Liste und alle Elemente zu laden. Die Sortierung und Filterung der Elemente erfolgt client seitig.
Response
Returns a ListComponent
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query listComponent($id: ID!) {
listComponent(id: $id) {
id
appId
lastModified
lastModifiedBy
entries {
...ListEntryFragment
}
androidWidescreenEnabled
backgroundColor
backgroundImageId
backgroundImageUrl
pinList
componentReference
precache
timeBasedPublication
lastExternalDataSourceUpdate
rssUrl
sectionsEnabled
rssTimerEnabled
rssTargetComponentId
rssTargetComponent {
...ComponentReferenceFragment
}
rssError
rssPushChannels
direction
sortField
newsFeedDatasourceId
}
}
Variables
{"id": "4"}
Response
{
"data": {
"listComponent": {
"id": "4",
"appId": AppID,
"lastModified": "2007-12-03",
"lastModifiedBy": "abc123",
"entries": [ListEntry],
"androidWidescreenEnabled": true,
"backgroundColor": "xyz789",
"backgroundImageId": 4,
"backgroundImageUrl": "xyz789",
"pinList": false,
"componentReference": "abc123",
"precache": true,
"timeBasedPublication": false,
"lastExternalDataSourceUpdate": "2007-12-03",
"rssUrl": "xyz789",
"sectionsEnabled": true,
"rssTimerEnabled": true,
"rssTargetComponentId": 4,
"rssTargetComponent": ComponentReference,
"rssError": "abc123",
"rssPushChannels": ["abc123"],
"direction": "xyz789",
"sortField": "abc123",
"newsFeedDatasourceId": 4
}
}
}
listComponentReferences
Description
Listet die referenzierten Komponenten/Module innerhalb der aktuellen App
Response
Returns [ComponentReference]
Example
Query
query listComponentReferences {
listComponentReferences {
name
ref
icon
iconSet
iconUrl
title
type
typeMetaData
state
badgeEnabled
visibleByProfileRoles
visibleByProfileGroups
}
}
Response
{
"data": {
"listComponentReferences": [
{
"name": "xyz789",
"ref": "abc123",
"icon": "abc123",
"iconSet": "xyz789",
"iconUrl": "xyz789",
"title": "abc123",
"type": "TextImage",
"typeMetaData": "xyz789",
"state": "PUBLIC",
"badgeEnabled": true,
"visibleByProfileRoles": ["xyz789"],
"visibleByProfileGroups": ["xyz789"]
}
]
}
}
listComponentWithFilteredEntries
Description
Hier werden nur aktiven Elemente der Liste geraden, die das anfragende Device sehen darf (Filterung nach Rolle, Publikationsdatum). Die Sortierung erfolgt implizit wie in den Meta Daten eingestellt.
Response
Returns a ListComponent
Arguments
| Name | Description |
|---|---|
componentId - ID!
|
Example
Query
query listComponentWithFilteredEntries($componentId: ID!) {
listComponentWithFilteredEntries(componentId: $componentId) {
id
appId
lastModified
lastModifiedBy
entries {
...ListEntryFragment
}
androidWidescreenEnabled
backgroundColor
backgroundImageId
backgroundImageUrl
pinList
componentReference
precache
timeBasedPublication
lastExternalDataSourceUpdate
rssUrl
sectionsEnabled
rssTimerEnabled
rssTargetComponentId
rssTargetComponent {
...ComponentReferenceFragment
}
rssError
rssPushChannels
direction
sortField
newsFeedDatasourceId
}
}
Variables
{"componentId": "4"}
Response
{
"data": {
"listComponentWithFilteredEntries": {
"id": 4,
"appId": AppID,
"lastModified": "2007-12-03",
"lastModifiedBy": "xyz789",
"entries": [ListEntry],
"androidWidescreenEnabled": true,
"backgroundColor": "abc123",
"backgroundImageId": 4,
"backgroundImageUrl": "xyz789",
"pinList": true,
"componentReference": "abc123",
"precache": true,
"timeBasedPublication": false,
"lastExternalDataSourceUpdate": "2007-12-03",
"rssUrl": "abc123",
"sectionsEnabled": false,
"rssTimerEnabled": false,
"rssTargetComponentId": "4",
"rssTargetComponent": ComponentReference,
"rssError": "xyz789",
"rssPushChannels": ["xyz789"],
"direction": "xyz789",
"sortField": "xyz789",
"newsFeedDatasourceId": 4
}
}
}
listEnumValues
Response
Returns [CustomEnum]
Arguments
| Name | Description |
|---|---|
enumIds - [String!]!
|
|
locale - String
|
Example
Query
query listEnumValues(
$enumIds: [String!]!,
$locale: String
) {
listEnumValues(
enumIds: $enumIds,
locale: $locale
) {
id
keys
locales
translations {
...EnumTranslationFragment
}
}
}
Variables
{
"enumIds": ["xyz789"],
"locale": "abc123"
}
Response
{
"data": {
"listEnumValues": [
{
"id": "4",
"keys": ["xyz789"],
"locales": ["abc123"],
"translations": [EnumTranslation]
}
]
}
}
listFamilyMembers
Description
Listet die Benutzerprofile mit der gleichen Familiennummer wie man selbst
Response
Returns [UserProfile]
Arguments
| Name | Description |
|---|---|
includeSelf - Boolean
|
Default = false |
Example
Query
query listFamilyMembers($includeSelf: Boolean) {
listFamilyMembers(includeSelf: $includeSelf) {
salutation {
...CustomEnumValueFragment
}
roles {
...CustomEnumValueFragment
}
requestedRoles {
...CustomEnumValueFragment
}
departments {
...CustomEnumValueFragment
}
groups {
...GroupFragment
}
id
externalId
lastModified
created
appId
appGroup
name
firstname
email
birthday
title
imageId
imageThumbId
deviceIds
membershipNumber
agreedToAds
verificationPending
mailConfirmationPending
locked
mainProfile
familyProfileNumber
locale
country {
...CustomEnumValueFragment
}
degree
nickname
street
postcode
city
state
phone
phoneMobile
phoneMobileRequest
phoneMobileVerificationStatus
identityNumber
personnelNumber
level
sports
companyName
companyDepartment
companyFunction
university
community
maritalStatus
skills
specialization
offers
interests
bankAccountHolder
bankBIC
bankIBAN
bankName
bankSEPARef
bankSEPADate
feeKind
feeAmount
paymentMethod
entryDate
exitDate
coachingLicense
customerNumber
dataPrivacyStatementAccepted
datePrivacyStatementAccepted
dataTermsOfUseAccepted
dateTermsOfUseAccepted
statutesAccepted
chatRulesAccepted
publicProfile
remarks
members {
...UserProfileFragment
}
accountActive
chatAccount
activationCode
clubName
clubNumber
team
playerPosition
playerNumber
playerHeight
licenseNumber
realname
customFields
agreedDisplayName
agreedDisplayPhone
agreedDisplayMail
}
}
Variables
{"includeSelf": false}
Response
{
"data": {
"listFamilyMembers": [
{
"salutation": CustomEnumValue,
"roles": [CustomEnumValue],
"requestedRoles": [CustomEnumValue],
"departments": [CustomEnumValue],
"groups": [Group],
"id": "abc123",
"externalId": "xyz789",
"lastModified": "2007-12-03",
"created": "2007-12-03",
"appId": "abc123",
"appGroup": "abc123",
"name": "xyz789",
"firstname": "abc123",
"email": "abc123",
"birthday": "2007-12-03",
"title": "xyz789",
"imageId": "abc123",
"imageThumbId": "abc123",
"deviceIds": ["abc123"],
"membershipNumber": "abc123",
"agreedToAds": true,
"verificationPending": false,
"mailConfirmationPending": true,
"locked": false,
"mainProfile": true,
"familyProfileNumber": "xyz789",
"locale": "abc123",
"country": CustomEnumValue,
"degree": "abc123",
"nickname": "xyz789",
"street": "abc123",
"postcode": "abc123",
"city": "xyz789",
"state": "abc123",
"phone": "xyz789",
"phoneMobile": "abc123",
"phoneMobileRequest": "xyz789",
"phoneMobileVerificationStatus": "REQUIRED",
"identityNumber": "abc123",
"personnelNumber": "abc123",
"level": "abc123",
"sports": "xyz789",
"companyName": "xyz789",
"companyDepartment": "abc123",
"companyFunction": "xyz789",
"university": "xyz789",
"community": "abc123",
"maritalStatus": "xyz789",
"skills": "xyz789",
"specialization": "xyz789",
"offers": "xyz789",
"interests": "xyz789",
"bankAccountHolder": "abc123",
"bankBIC": "abc123",
"bankIBAN": "abc123",
"bankName": "abc123",
"bankSEPARef": "abc123",
"bankSEPADate": "2007-12-03",
"feeKind": "abc123",
"feeAmount": "xyz789",
"paymentMethod": "xyz789",
"entryDate": "2007-12-03",
"exitDate": "2007-12-03",
"coachingLicense": false,
"customerNumber": "abc123",
"dataPrivacyStatementAccepted": "abc123",
"datePrivacyStatementAccepted": "2007-12-03",
"dataTermsOfUseAccepted": "abc123",
"dateTermsOfUseAccepted": "2007-12-03",
"statutesAccepted": false,
"chatRulesAccepted": false,
"publicProfile": true,
"remarks": "xyz789",
"members": [UserProfile],
"accountActive": true,
"chatAccount": true,
"activationCode": "xyz789",
"clubName": "xyz789",
"clubNumber": "xyz789",
"team": "abc123",
"playerPosition": "xyz789",
"playerNumber": "abc123",
"playerHeight": 987,
"licenseNumber": "abc123",
"realname": "xyz789",
"customFields": {},
"agreedDisplayName": true,
"agreedDisplayPhone": true,
"agreedDisplayMail": true
}
]
}
}
listFilesByParent
Description
Listet die Files unterhalb des gegebenen Folders
Example
Query
query listFilesByParent($parent: WSFileId!) {
listFilesByParent(parent: $parent) {
id
workspaceId
type
key
readonly
name
lastModified
lastModifiedBy
description
size
parentId
}
}
Variables
{"parent": WSFileId}
Response
{
"data": {
"listFilesByParent": [
{
"id": WSFileId,
"workspaceId": WSFileId,
"type": "ROOT",
"key": "abc123",
"readonly": false,
"name": "xyz789",
"lastModified": "2007-12-03",
"lastModifiedBy": "xyz789",
"description": "xyz789",
"size": 987,
"parentId": "xyz789"
}
]
}
}
listGroupRequests
Description
Listet alle für mich relevanten Mitgliedschaftsanfragen auf. Eingehende Request: Die das aktuelle Profil bestätigen kann Ausgehende Requests: Die das Profil selbst angefragt hat Die lässt sich anhand der inquirerId prüfen
Response
Returns [GroupAccessRequest]
Example
Query
query listGroupRequests {
listGroupRequests {
id
inquirerId
inquirer {
...UserProfileFragment
}
creationDate
groupId
group {
...GroupFragment
}
message
}
}
Response
{
"data": {
"listGroupRequests": [
{
"id": 4,
"inquirerId": 4,
"inquirer": UserProfile,
"creationDate": "2007-12-03",
"groupId": 4,
"group": Group,
"message": "xyz789"
}
]
}
}
listGroupSpaces
Description
Listed alle Gruppen-Spaces in welchen der aktuelle User ist
Response
Returns [GroupSpace]
Example
Query
query listGroupSpaces {
listGroupSpaces {
description
name
headerImageUrl
id
conferenceRoomEnabled
fileStoreEnabled
fileStoreMembersWrite
conferenceRoom {
...ConferenceFragment
}
links {
...GroupSpaceLinkFragment
}
members {
...UserProfileBasicDataFragment
}
leaders {
...UserProfileBasicDataFragment
}
leader
badge
}
}
Response
{
"data": {
"listGroupSpaces": [
{
"description": "xyz789",
"name": "abc123",
"headerImageUrl": "xyz789",
"id": 4,
"conferenceRoomEnabled": true,
"fileStoreEnabled": true,
"fileStoreMembersWrite": true,
"conferenceRoom": Conference,
"links": [GroupSpaceLink],
"members": [UserProfileBasicData],
"leaders": [UserProfileBasicData],
"leader": true,
"badge": 987
}
]
}
}
listGroups
Description
Listet alle Gruppen, die in der App existieren
Example
Query
query listGroups($listedGroupsOnly: Boolean) {
listGroups(listedGroupsOnly: $listedGroupsOnly) {
id
appId
name
memberIds
members {
...UserProfileBasicDataFragment
}
leaderIds
leaders {
...UserProfileBasicDataFragment
}
roles
system
numberOfMembers
description
publicGroup
listedGroup
icon {
...ResourceFragment
}
iconId
leader
groupSpaceEnabled
}
}
Variables
{"listedGroupsOnly": false}
Response
{
"data": {
"listGroups": [
{
"id": "4",
"appId": AppID,
"name": "abc123",
"memberIds": ["abc123"],
"members": [UserProfileBasicData],
"leaderIds": ["abc123"],
"leaders": [UserProfileBasicData],
"roles": ["xyz789"],
"system": false,
"numberOfMembers": 987,
"description": "abc123",
"publicGroup": true,
"listedGroup": true,
"icon": Resource,
"iconId": "xyz789",
"leader": false,
"groupSpaceEnabled": false
}
]
}
}
listIconSets
Description
Gibt alle verfügbaren Icons für das aktuelle Projekt zurück
Response
Returns [ProjectIconSet]
Example
Query
query listIconSets {
listIconSets {
id
name
icons {
...ModuleIconFragment
}
}
}
Response
{
"data": {
"listIconSets": [
{
"id": 4,
"name": "xyz789",
"icons": [ModuleIcon]
}
]
}
}
listInvoices
Description
Rechnungen, die der aktuelle CMS Benutzer einsehen kann
Response
Returns [Invoice]
Example
Query
query listInvoices {
listInvoices {
id
date
appName
gross
net
vat
signedUrl
}
}
Response
{
"data": {
"listInvoices": [
{
"id": "4",
"date": "2007-12-03",
"appName": "xyz789",
"gross": 987.65,
"net": 987.65,
"vat": 987.65,
"signedUrl": Url
}
]
}
}
listLocations
Description
listet alle Locations, die im aktuellen App Kontext vorhanden sind.
Response
Returns [Location]
Example
Query
query listLocations {
listLocations {
id
appId
title
street
postalCode
city
geoLat
geoLng
}
}
Response
{
"data": {
"listLocations": [
{
"id": "4",
"appId": AppID,
"title": "xyz789",
"street": "xyz789",
"postalCode": "xyz789",
"city": "abc123",
"geoLat": 987.65,
"geoLng": 123.45
}
]
}
}
listOwnCalendarEventRegistrations
Description
Listet alle Registrierungen des aktuellen Benutzers zu Terminen in den gegebenen Kalendern im Zeitraum
Response
Returns [CalendarEventRegistration]
Example
Query
query listOwnCalendarEventRegistrations(
$calendarIds: [ID]!,
$range: DateRange
) {
listOwnCalendarEventRegistrations(
calendarIds: $calendarIds,
range: $range
) {
id
creationDate
calendarEventId
seat {
...SeatFragment
}
comment
deviceId
clientId
client {
...UserProfileBasicDataFragment
}
status
waitingPosition
payed
formData
}
}
Variables
{"calendarIds": [4], "range": DateRange}
Response
{
"data": {
"listOwnCalendarEventRegistrations": [
{
"id": 4,
"creationDate": "2007-12-03",
"calendarEventId": 4,
"seat": Seat,
"comment": "abc123",
"deviceId": "xyz789",
"clientId": "abc123",
"client": UserProfileBasicData,
"status": "xyz789",
"waitingPosition": 987,
"payed": true,
"formData": {}
}
]
}
}
listPermissions
Response
Returns [Permission]
Example
Query
query listPermissions {
listPermissions
}
Response
{"data": {"listPermissions": ["MANAGE_COMPONENT"]}}
listPersonalThresholds
Description
listet alle Grenzwert Einstellungen des aktuellen Benutzers
Response
Returns [Threshold]
Example
Query
query listPersonalThresholds {
listPersonalThresholds {
timeSeriesId
upper
lower
profileId
}
}
Response
{
"data": {
"listPersonalThresholds": [
{
"timeSeriesId": 4,
"upper": 987.65,
"lower": 987.65,
"profileId": "4"
}
]
}
}
listProducts
Description
Listet alle Produkte des Produktkatalogs der App.
Response
Returns [ProductDefinition]
Example
Query
query listProducts {
listProducts {
id
name
description
imageId
image {
...ResourceFragment
}
type
unitCount
validMonths
price {
...PriceFragment
}
tax {
...TaxFragment
}
paymentProviderReference {
...PaymentProviderReferenceFragment
}
sellCount
}
}
Response
{
"data": {
"listProducts": [
{
"id": "4",
"name": "xyz789",
"description": "abc123",
"imageId": "4",
"image": Resource,
"type": "SINGLE_TICKET",
"unitCount": 123,
"validMonths": 987,
"price": Price,
"tax": Tax,
"paymentProviderReference": PaymentProviderReference,
"sellCount": 123
}
]
}
}
listProductsByIds
Description
Listet die Produkte mit den gegebenen Ids
Response
Returns [ProductDefinition]
Arguments
| Name | Description |
|---|---|
ids - [ID]
|
Example
Query
query listProductsByIds($ids: [ID]) {
listProductsByIds(ids: $ids) {
id
name
description
imageId
image {
...ResourceFragment
}
type
unitCount
validMonths
price {
...PriceFragment
}
tax {
...TaxFragment
}
paymentProviderReference {
...PaymentProviderReferenceFragment
}
sellCount
}
}
Variables
{"ids": [4]}
Response
{
"data": {
"listProductsByIds": [
{
"id": 4,
"name": "abc123",
"description": "xyz789",
"imageId": "4",
"image": Resource,
"type": "SINGLE_TICKET",
"unitCount": 123,
"validMonths": 123,
"price": Price,
"tax": Tax,
"paymentProviderReference": PaymentProviderReference,
"sellCount": 987
}
]
}
}
listProductsByTypes
Description
listet alle Produkte der genannten Kategorien
Response
Returns [ProductDefinition]
Arguments
| Name | Description |
|---|---|
types - [ProductType]
|
Example
Query
query listProductsByTypes($types: [ProductType]) {
listProductsByTypes(types: $types) {
id
name
description
imageId
image {
...ResourceFragment
}
type
unitCount
validMonths
price {
...PriceFragment
}
tax {
...TaxFragment
}
paymentProviderReference {
...PaymentProviderReferenceFragment
}
sellCount
}
}
Variables
{"types": ["SINGLE_TICKET"]}
Response
{
"data": {
"listProductsByTypes": [
{
"id": 4,
"name": "abc123",
"description": "xyz789",
"imageId": "4",
"image": Resource,
"type": "SINGLE_TICKET",
"unitCount": 123,
"validMonths": 123,
"price": Price,
"tax": Tax,
"paymentProviderReference": PaymentProviderReference,
"sellCount": 123
}
]
}
}
listProjectSpecifications
Description
Gibt alle Specs, auf die der Benutzer Zugriff hat zurück
Response
Returns [ProjectSpecification]
Example
Query
query listProjectSpecifications {
listProjectSpecifications {
name
portalAppName
groupId
iosNavigationType
locale
components {
...ComponentReferenceFragment
}
}
}
Response
{
"data": {
"listProjectSpecifications": [
{
"name": "xyz789",
"portalAppName": "abc123",
"groupId": "xyz789",
"iosNavigationType": "abc123",
"locale": "abc123",
"components": [ComponentReference]
}
]
}
}
listPushChannels
Description
Listet alle in der App vorhandenen Push Kanäle
Response
Returns [PushChannel]
Example
Query
query listPushChannels {
listPushChannels {
appId
id
number
name
description
imageResource {
...ResourceFragment
}
imageResourceId
soundId
autoSubscribe
initialSubscribe
active
subscriptionCount
allowedGroups {
...GroupFragment
}
allowedGroupIds
subscribed
}
}
Response
{
"data": {
"listPushChannels": [
{
"appId": AppID,
"id": 4,
"number": 123,
"name": "xyz789",
"description": "abc123",
"imageResource": Resource,
"imageResourceId": "xyz789",
"soundId": "xyz789",
"autoSubscribe": false,
"initialSubscribe": false,
"active": true,
"subscriptionCount": 123,
"allowedGroups": [Group],
"allowedGroupIds": [4],
"subscribed": false
}
]
}
}
listPushNotificationsCurrentlyProcessed
Description
Listet alle PushNachrichten, die gerade noch aktiv sind.
Response
Returns [PushNotification]
Example
Query
query listPushNotificationsCurrentlyProcessed {
listPushNotificationsCurrentlyProcessed {
id
status
message
appId
androidUsers
iphoneUsers
androidUsersMax
iphoneUsersMax
username
badge
sheduleDate
sound
soundId
componentId
imageUrl
pending
componentReference {
...ComponentReferenceFragment
}
url
channelIds
channels {
...PushChannelFragment
}
roleIds
departmentIds
groupIds
dispatchDate
mode
publicPushNotification
}
}
Response
{
"data": {
"listPushNotificationsCurrentlyProcessed": [
{
"id": "4",
"status": "SCHEDULED",
"message": "abc123",
"appId": "xyz789",
"androidUsers": 987,
"iphoneUsers": 123,
"androidUsersMax": 987,
"iphoneUsersMax": 123,
"username": "abc123",
"badge": 123,
"sheduleDate": "2007-12-03",
"sound": false,
"soundId": "abc123",
"componentId": "abc123",
"imageUrl": "abc123",
"pending": 123,
"componentReference": ComponentReference,
"url": "abc123",
"channelIds": ["xyz789"],
"channels": [PushChannel],
"roleIds": ["xyz789"],
"departmentIds": ["xyz789"],
"groupIds": ["abc123"],
"dispatchDate": "2007-12-03",
"mode": "NORMAL",
"publicPushNotification": false
}
]
}
}
listResources
Response
Returns [Resource]
Example
Query
query listResources {
listResources {
id
url
notes
previewImageUrl
creationDate
lastModificationDate
mimeType
title
creator
resourceCategoryId
resourceCategory {
...ResourceCategoryFragment
}
width
height
contentLength
status
deviceId
user_comment
user_title
user_contact
user_category
lat
lng
}
}
Response
{
"data": {
"listResources": [
{
"id": "4",
"url": "xyz789",
"notes": "xyz789",
"previewImageUrl": "abc123",
"creationDate": "2007-12-03",
"lastModificationDate": "2007-12-03",
"mimeType": "abc123",
"title": "abc123",
"creator": "xyz789",
"resourceCategoryId": "xyz789",
"resourceCategory": ResourceCategory,
"width": 987,
"height": 987,
"contentLength": 123,
"status": "pending",
"deviceId": "xyz789",
"user_comment": "xyz789",
"user_title": "abc123",
"user_contact": "xyz789",
"user_category": "xyz789",
"lat": "abc123",
"lng": "xyz789"
}
]
}
}
listStructureNodeCategories
Description
Liefert alle Kategorien
Response
Returns [ProjectStructureNodeCategory]
Example
Query
query listStructureNodeCategories {
listStructureNodeCategories {
id
name
color
lastModificationDate
}
}
Response
{
"data": {
"listStructureNodeCategories": [
{
"id": "4",
"name": "abc123",
"color": "xyz789",
"lastModificationDate": "2007-12-03"
}
]
}
}
listTemplateCoupons
Description
Listet alle Gutschein Vorlagen im aktuellen App Kontext
Response
Returns [Coupon]
Example
Query
query listTemplateCoupons {
listTemplateCoupons {
id
bonusBookletId
bonusProgramId
couponSpecificationId
description
enabled
expireDate
imageId
image {
...ResourceFragment
}
imageURL
startupCoupon
startupCouponDispatchDate
status
title
used
usedDate
value
lastModified
}
}
Response
{
"data": {
"listTemplateCoupons": [
{
"id": "4",
"bonusBookletId": "4",
"bonusProgramId": "4",
"couponSpecificationId": "4",
"description": "abc123",
"enabled": true,
"expireDate": "2007-12-03",
"imageId": "4",
"image": Resource,
"imageURL": "abc123",
"startupCoupon": true,
"startupCouponDispatchDate": "2007-12-03",
"status": "inactive",
"title": "abc123",
"used": false,
"usedDate": "2007-12-03",
"value": 123,
"lastModified": "2007-12-03"
}
]
}
}
listTimeSeries
Description
listet die im aktuellen App Kontext vorhandenen TimeSeries auf. Per Default werden nur die sichtbar geschalteten Serien geliefert
Response
Returns [TimeSeries]
Arguments
| Name | Description |
|---|---|
visibleOnly - Boolean
|
Default = true |
Example
Query
query listTimeSeries($visibleOnly: Boolean) {
listTimeSeries(visibleOnly: $visibleOnly) {
id
name
appId
unit
granularity
latestEntry {
...TimeSeriesDataFragment
}
delta
metaData
roleVisibility {
...CustomEnumValueFragment
}
visible
lastModified
}
}
Variables
{"visibleOnly": true}
Response
{
"data": {
"listTimeSeries": [
{
"id": "4",
"name": "abc123",
"appId": AppID,
"unit": "xyz789",
"granularity": "abc123",
"latestEntry": TimeSeriesData,
"delta": 123.45,
"metaData": {},
"roleVisibility": [CustomEnumValue],
"visible": true,
"lastModified": "2007-12-03"
}
]
}
}
listUpcomingCalendarEvents
Description
Lädt die bevorstehenden n Termine entwerder aus allen für den aktuellen User sichtbaren Kalendern innerhalb der gegebenen Komponente (componentId = Id eines Kalendermoduls) oder innerhalb des einzelnen Kalenders (componentId = Id eines Kalenders)
Response
Returns [CalendarEvent]
Example
Query
query listUpcomingCalendarEvents(
$componentId: ID!,
$amount: Int!
) {
listUpcomingCalendarEvents(
componentId: $componentId,
amount: $amount
) {
id
calendarId
seriesId
title
subTitle
description
timeZoneId
timeZoneOffset
dateStart
dateTimeStart
localDateTimeStart
dateEnd
dateTimeEnd
localDateTimeEnd
categories {
...CalendarEventCategoryFragment
}
registrationRequired
publicRegistrationAllowed
allDay
maxSignUps
minSignUps
multiSignUpAllowed
memberListVisibility
maxAdditionalSignUps
registrationCount
deadlineStartOffsetMinutes
startOfRegistrationOffsetMinutes
cancelRegistrationDeadlineOffsetMinutes
requestCount
iconImage {
...MediaReferenceFragment
}
resources {
...MediaReferenceFragment
}
location {
...LocationFragment
}
detailLink
seats
ownRegistrations {
...CalendarEventRegistrationFragment
}
ownerId
owner {
...UserProfileFragment
}
contactId
contact {
...UserProfileFragment
}
contactGroupId
contactGroup {
...GroupFragment
}
canWrite
onlineConference
notifyEventContactPersonOnSignUp
issueTicketsUponRegistration
manageAttendees
reminder {
...CalendarEventReminderFragment
}
paymentDocumentation
registrationFormId
registrationForm {
...CalendarRegistrationFormFragment
}
products {
...ProductDefinitionFragment
}
waitingListEnabled
badgeEnabled
lastModificationDate
}
}
Variables
{"componentId": 4, "amount": 987}
Response
{
"data": {
"listUpcomingCalendarEvents": [
{
"id": 4,
"calendarId": 4,
"seriesId": "4",
"title": "abc123",
"subTitle": "xyz789",
"description": "abc123",
"timeZoneId": "abc123",
"timeZoneOffset": "abc123",
"dateStart": "2007-12-03",
"dateTimeStart": "abc123",
"localDateTimeStart": "2020-07-19T08:45:59",
"dateEnd": "2007-12-03",
"dateTimeEnd": "abc123",
"localDateTimeEnd": "2020-07-19T08:45:59",
"categories": [CalendarEventCategory],
"registrationRequired": false,
"publicRegistrationAllowed": false,
"allDay": false,
"maxSignUps": 987,
"minSignUps": 987,
"multiSignUpAllowed": true,
"memberListVisibility": "ADMIN",
"maxAdditionalSignUps": 987,
"registrationCount": 987,
"deadlineStartOffsetMinutes": 123,
"startOfRegistrationOffsetMinutes": 123,
"cancelRegistrationDeadlineOffsetMinutes": 987,
"requestCount": 123,
"iconImage": MediaReference,
"resources": [MediaReference],
"location": Location,
"detailLink": "xyz789",
"seats": ["abc123"],
"ownRegistrations": [CalendarEventRegistration],
"ownerId": "abc123",
"owner": UserProfile,
"contactId": "abc123",
"contact": UserProfile,
"contactGroupId": 4,
"contactGroup": Group,
"canWrite": false,
"onlineConference": true,
"notifyEventContactPersonOnSignUp": false,
"issueTicketsUponRegistration": false,
"manageAttendees": true,
"reminder": CalendarEventReminder,
"paymentDocumentation": false,
"registrationFormId": "4",
"registrationForm": CalendarRegistrationForm,
"products": [ProductDefinition],
"waitingListEnabled": false,
"badgeEnabled": true,
"lastModificationDate": "2007-12-03"
}
]
}
}
listWorkspaceFileUsages
Description
liefert die Verwendungsstellen eines Files
Response
Returns [ComponentReference]
Arguments
| Name | Description |
|---|---|
file - WSFileId!
|
Example
Query
query listWorkspaceFileUsages($file: WSFileId!) {
listWorkspaceFileUsages(file: $file) {
name
ref
icon
iconSet
iconUrl
title
type
typeMetaData
state
badgeEnabled
visibleByProfileRoles
visibleByProfileGroups
}
}
Variables
{"file": WSFileId}
Response
{
"data": {
"listWorkspaceFileUsages": [
{
"name": "xyz789",
"ref": "xyz789",
"icon": "abc123",
"iconSet": "xyz789",
"iconUrl": "abc123",
"title": "xyz789",
"type": "TextImage",
"typeMetaData": "xyz789",
"state": "PUBLIC",
"badgeEnabled": false,
"visibleByProfileRoles": ["abc123"],
"visibleByProfileGroups": ["xyz789"]
}
]
}
}
listWorkspaceFiles
Description
Listet alle Files innerhalb des Workspace Folders
Example
Query
query listWorkspaceFiles($parent: WSFileId!) {
listWorkspaceFiles(parent: $parent) {
id
workspaceId
type
key
readonly
name
lastModified
lastModifiedBy
description
size
parentId
}
}
Variables
{"parent": WSFileId}
Response
{
"data": {
"listWorkspaceFiles": [
{
"id": WSFileId,
"workspaceId": WSFileId,
"type": "ROOT",
"key": "xyz789",
"readonly": true,
"name": "xyz789",
"lastModified": "2007-12-03",
"lastModifiedBy": "xyz789",
"description": "xyz789",
"size": 987,
"parentId": "xyz789"
}
]
}
}
loadDownloadStatsTimeSeries
Description
liefert den Verlauf der Installationen zu der gegebenen AppId in den letzten 30 Tagen (default)
Response
Returns [DownloadStatsData]
Arguments
| Name | Description |
|---|---|
days - Int
|
Default = 30 |
Example
Query
query loadDownloadStatsTimeSeries($days: Int) {
loadDownloadStatsTimeSeries(days: $days) {
id
appId
ts
day
total
android
android_delta
ios_delta
ios
}
}
Variables
{"days": 30}
Response
{
"data": {
"loadDownloadStatsTimeSeries": [
{
"id": "4",
"appId": AppID,
"ts": "2007-12-03",
"day": "abc123",
"total": 123,
"android": 987,
"android_delta": 123,
"ios_delta": 123,
"ios": 987
}
]
}
}
loadProjectStructure
Description
lädt den Strukturbaum des Projekts als Liste. Die Hierarchie wird client-seitig erstellt.
Response
Returns [ProjectStructureNode]
Example
Query
query loadProjectStructure {
loadProjectStructure {
id
parentId
label
component {
...ComponentReferenceFragment
}
categories {
...ProjectStructureNodeCategoryFragment
}
children
}
}
Response
{
"data": {
"loadProjectStructure": [
{
"id": 4,
"parentId": 4,
"label": "abc123",
"component": ComponentReference,
"categories": [ProjectStructureNodeCategory],
"children": ["xyz789"]
}
]
}
}
loadTimeSeriesData
Description
Liefert die aktuellen Werte zu einer SerienId und Periode.
Response
Returns [TimeSeriesData]
Arguments
| Name | Description |
|---|---|
seriesId - ID!
|
|
period - TimePeriod
|
Default = YEAR |
Example
Query
query loadTimeSeriesData(
$seriesId: ID!,
$period: TimePeriod
) {
loadTimeSeriesData(
seriesId: $seriesId,
period: $period
) {
id
timeSeriesId
metaData
timestamp
value
}
}
Variables
{"seriesId": 4, "period": "YEAR"}
Response
{
"data": {
"loadTimeSeriesData": [
{
"id": 4,
"timeSeriesId": 4,
"metaData": {},
"timestamp": "2007-12-03",
"value": 987.65
}
]
}
}
loadWorkbookComponent
Description
lädt ein Workbook der aktuellen App
Response
Returns a WorkbookComponent
Arguments
| Name | Description |
|---|---|
workbookId - ID!
|
Example
Query
query loadWorkbookComponent($workbookId: ID!) {
loadWorkbookComponent(workbookId: $workbookId) {
id
adminMail
worksheetIds
worksheets {
...WorksheetFragment
}
}
}
Variables
{"workbookId": "4"}
Response
{
"data": {
"loadWorkbookComponent": {
"id": "4",
"adminMail": "xyz789",
"worksheetIds": ["xyz789"],
"worksheets": [Worksheet]
}
}
}
loadWorkbookTemplates
Description
Lädt alle Workbook-Vorlagen
Response
Returns [WorkbookTemplate]
Example
Query
query loadWorkbookTemplates {
loadWorkbookTemplates {
id
name
sharedResourceId
}
}
Response
{
"data": {
"loadWorkbookTemplates": [
{
"id": "4",
"name": "abc123",
"sharedResourceId": 987
}
]
}
}
loadWorksheet
Description
lädt die Meta Daten zu einem Arbeitsblatt
Example
Query
query loadWorksheet($worksheetId: ID!) {
loadWorksheet(worksheetId: $worksheetId) {
id
name
adminRoleKeys
columns {
...WorksheetColumnMetaDataFragment
}
readAccess
writeAccess
deleteAccess
}
}
Variables
{"worksheetId": 4}
Response
{
"data": {
"loadWorksheet": {
"id": "4",
"name": "abc123",
"adminRoleKeys": ["xyz789"],
"columns": [WorksheetColumnMetaData],
"readAccess": "ALWAYS_ALLOW",
"writeAccess": "ALWAYS_ALLOW",
"deleteAccess": "ALWAYS_ALLOW"
}
}
}
loadWorksheetData
Description
Lädt die Daten eines Worksheets
Response
Returns a WorksheetPagingResponse
Arguments
| Name | Description |
|---|---|
filter - WorksheetQuery!
|
Example
Query
query loadWorksheetData($filter: WorksheetQuery!) {
loadWorksheetData(filter: $filter) {
content {
...GenericRowFragment
}
totalcount
}
}
Variables
{"filter": WorksheetQuery}
Response
{
"data": {
"loadWorksheetData": {
"content": [GenericRow],
"totalcount": 123
}
}
}
myDevices
Description
Liefert alle mit dem Profil verbundenen Devices
Response
Returns [DeviceSummary]
Example
Query
query myDevices {
myDevices {
deviceId
lastConnect
osVersion
deviceName
deviceModel
deviceSystem
pin
}
}
Response
{
"data": {
"myDevices": [
{
"deviceId": "abc123",
"lastConnect": "2007-12-03",
"osVersion": "xyz789",
"deviceName": "xyz789",
"deviceModel": "abc123",
"deviceSystem": "xyz789",
"pin": "abc123"
}
]
}
}
profileComponentId
Description
liefert die Id der Profil-Komponente innerhalb der App
Response
Returns a String
Example
Query
query profileComponentId {
profileComponentId
}
Response
{"data": {"profileComponentId": "xyz789"}}
projectMetrics
Description
liefert verschiedene Meta Daten zum Stand des Projekts auf dessen Basis bestimmte Widgets auf dem Dashboard angezeigt werden
Response
Returns a ProjectMetrics
Example
Query
query projectMetrics {
projectMetrics {
groupId
name
description
projectType
androidDeviceCount
iosDeviceCount
totalDeviceCount
androidPublicationDate
androidLastUpdate
iosPublicationDate
iosLastUpdate
calendarEventsInNext100days
calendarModuleExists
appIconSet
splashScreenSet
privacyPolicySet
cmsUserCount
lastCmsLoginAt
lastLoginBy
pushNotificationCount
lastPushNotificationSent
phase
pushCertificateExpirationDate
serviceLevel
groupSpacesCount
}
}
Response
{
"data": {
"projectMetrics": {
"groupId": AppID,
"name": "abc123",
"description": "xyz789",
"projectType": "STANDARD",
"androidDeviceCount": 987,
"iosDeviceCount": 987,
"totalDeviceCount": 123,
"androidPublicationDate": "2007-12-03",
"androidLastUpdate": "2007-12-03",
"iosPublicationDate": "2007-12-03",
"iosLastUpdate": "2007-12-03",
"calendarEventsInNext100days": 987,
"calendarModuleExists": false,
"appIconSet": false,
"splashScreenSet": true,
"privacyPolicySet": false,
"cmsUserCount": 123,
"lastCmsLoginAt": "2007-12-03",
"lastLoginBy": "xyz789",
"pushNotificationCount": 987,
"lastPushNotificationSent": "2007-12-03",
"phase": 987,
"pushCertificateExpirationDate": "2007-12-03",
"serviceLevel": "NONE",
"groupSpacesCount": 987
}
}
}
projectSpec_projectSpecification
use getProjectSpecification
Description
Lädt die Spec des angegebenen Projekts
Response
Returns a ProjectSpecification
Arguments
| Name | Description |
|---|---|
appId - AppID!
|
Example
Query
query projectSpec_projectSpecification($appId: AppID!) {
projectSpec_projectSpecification(appId: $appId) {
name
portalAppName
groupId
iosNavigationType
locale
components {
...ComponentReferenceFragment
}
}
}
Variables
{"appId": AppID}
Response
{
"data": {
"projectSpec_projectSpecification": {
"name": "xyz789",
"portalAppName": "abc123",
"groupId": "abc123",
"iosNavigationType": "xyz789",
"locale": "abc123",
"components": [ComponentReference]
}
}
}
pushHistoryComponent
Description
Gibt die Komponente zurück
Response
Returns a PushHistoryComponent
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
query pushHistoryComponent($id: ID!) {
pushHistoryComponent(id: $id) {
headerImageUrl
headerImage {
...ResourceFragment
}
headerImageId
limit
dayLimit
backgroundColor
backgroundColor2
messageTextColor
dateTextColor
}
}
Variables
{"id": 4}
Response
{
"data": {
"pushHistoryComponent": {
"headerImageUrl": "xyz789",
"headerImage": Resource,
"headerImageId": "4",
"limit": 987,
"dayLimit": 987,
"backgroundColor": "abc123",
"backgroundColor2": "xyz789",
"messageTextColor": "abc123",
"dateTextColor": "abc123"
}
}
}
queryProjectContent
Description
Durchsucht das Projekt
Response
Returns a ProjectContentQueryResult
Arguments
| Name | Description |
|---|---|
query - ProjectContentQuery!
|
Example
Query
query queryProjectContent($query: ProjectContentQuery!) {
queryProjectContent(query: $query) {
items {
...ProjectContentQueryResultItemFragment
}
}
}
Variables
{"query": ProjectContentQuery}
Response
{
"data": {
"queryProjectContent": {
"items": [ProjectContentQueryResultItem]
}
}
}
resolveFileHierarchy
Description
Liefert den Pfad bis zum obersten Knoten
Example
Query
query resolveFileHierarchy(
$storeId: FSId,
$id: FSFileId!
) {
resolveFileHierarchy(
storeId: $storeId,
id: $id
) {
fsId
id
parentId
contentType
name
contentLength
directory
status
created
createdBy
lastModified
lastModifiedBy
eTag
uploadUrl
downloadUrl
thumbnailImageUrl
}
}
Variables
{"storeId": FSId, "id": FSFileId}
Response
{
"data": {
"resolveFileHierarchy": [
{
"fsId": FSId,
"id": FSFileId,
"parentId": FSFileId,
"contentType": "xyz789",
"name": "xyz789",
"contentLength": {},
"directory": true,
"status": "READY",
"created": "2007-12-03",
"createdBy": "xyz789",
"lastModified": "2007-12-03",
"lastModifiedBy": "abc123",
"eTag": "xyz789",
"uploadUrl": Url,
"downloadUrl": Url,
"thumbnailImageUrl": Url
}
]
}
}
textWidget
Description
lädt das TextWidget mit bekannter Id
Response
Returns a TextWidget
Example
Query
query textWidget(
$key: String!,
$language: String
) {
textWidget(
key: $key,
language: $language
) {
id
key
title
sections {
...TextWidgetSectionFragment
}
settings {
...WidgetSettingsFragment
}
language
languages
header
footer
}
}
Variables
{
"key": "xyz789",
"language": "xyz789"
}
Response
{
"data": {
"textWidget": {
"id": 4,
"key": "abc123",
"title": "abc123",
"sections": [TextWidgetSection],
"settings": WidgetSettings,
"language": "abc123",
"languages": ["abc123"],
"header": "abc123",
"footer": "xyz789"
}
}
}
textWidgets
Description
Lädt alle Text-Widgets in der aktuelle Sprache
Response
Returns [TextWidget]
Example
Query
query textWidgets {
textWidgets {
id
key
title
sections {
...TextWidgetSectionFragment
}
settings {
...WidgetSettingsFragment
}
language
languages
header
footer
}
}
Response
{
"data": {
"textWidgets": [
{
"id": "4",
"key": "xyz789",
"title": "xyz789",
"sections": [TextWidgetSection],
"settings": WidgetSettings,
"language": "xyz789",
"languages": ["abc123"],
"header": "xyz789",
"footer": "abc123"
}
]
}
}
usageStatistics
Description
Information zu belegtem Speicherplatz nach Dateityp.
Response
Returns a UsageStatistics
Example
Query
query usageStatistics {
usageStatistics {
appId
storageQuota
storageUsedTotal
storageUsedPercentage
storageFreePercentage
images {
...UsageStatisticItemFragment
}
pages {
...UsageStatisticItemFragment
}
videos {
...UsageStatisticItemFragment
}
audios {
...UsageStatisticItemFragment
}
documents {
...UsageStatisticItemFragment
}
}
}
Response
{
"data": {
"usageStatistics": {
"appId": AppID,
"storageQuota": {},
"storageUsedTotal": {},
"storageUsedPercentage": 123.45,
"storageFreePercentage": 123.45,
"images": UsageStatisticItem,
"pages": UsageStatisticItem,
"videos": UsageStatisticItem,
"audios": UsageStatisticItem,
"documents": UsageStatisticItem
}
}
}
user_whoami
use whoami
Response
Returns a User
Example
Query
query user_whoami {
user_whoami {
username
email
currentAppId
permissions
lastLogin
deviceIds
language
technicalAppUser
inactive
appIds
currentAppDivisions
managed
fullName
cnumber
invalidLoginAttemps
password
lastAppLogin
}
}
Response
{
"data": {
"user_whoami": {
"username": "xyz789",
"email": "abc123",
"currentAppId": AppID,
"permissions": ["MANAGE_COMPONENT"],
"lastLogin": "2007-12-03",
"deviceIds": ["xyz789"],
"language": "xyz789",
"technicalAppUser": false,
"inactive": false,
"appIds": ["xyz789"],
"currentAppDivisions": ["abc123"],
"managed": true,
"fullName": "xyz789",
"cnumber": "xyz789",
"invalidLoginAttemps": 987,
"password": "abc123",
"lastAppLogin": "2007-12-03"
}
}
}
whoami
Response
Returns a WhoamiResponse
Example
Query
query whoami {
whoami {
expiresAt
claims
appScope
deviceId
user {
...UserFragment
}
userProfile {
...UserProfileFragment
}
connectToken
}
}
Response
{
"data": {
"whoami": {
"expiresAt": "2007-12-03",
"claims": ["xyz789"],
"appScope": "xyz789",
"deviceId": "abc123",
"user": User,
"userProfile": UserProfile,
"connectToken": "abc123"
}
}
}
workbook_exportSheetData
Response
Returns [GenericRow]
Example
Query
query workbook_exportSheetData(
$appId: AppID!,
$worksheetId: ID!,
$filter: JSON
) {
workbook_exportSheetData(
appId: $appId,
worksheetId: $worksheetId,
filter: $filter
) {
id
autoId
sheet
created
lastModified
user
deviceId
userProfileId
userProfile {
...UserProfileBasicDataFragment
}
data
}
}
Variables
{"appId": AppID, "worksheetId": 4, "filter": {}}
Response
{
"data": {
"workbook_exportSheetData": [
{
"id": 4,
"autoId": 987,
"sheet": "xyz789",
"created": "2007-12-03",
"lastModified": "2007-12-03",
"user": "xyz789",
"deviceId": "abc123",
"userProfileId": "abc123",
"userProfile": UserProfileBasicData,
"data": {}
}
]
}
}
workbook_getSheetData
Description
Deprecated use loadWorksheetData()
Response
Returns [GenericRow]
Example
Query
query workbook_getSheetData(
$worksheetId: ID,
$skip: Int,
$limit: Int,
$options: String!,
$sort: Sort
) {
workbook_getSheetData(
worksheetId: $worksheetId,
skip: $skip,
limit: $limit,
options: $options,
sort: $sort
) {
id
autoId
sheet
created
lastModified
user
deviceId
userProfileId
userProfile {
...UserProfileBasicDataFragment
}
data
}
}
Variables
{
"worksheetId": 4,
"skip": 987,
"limit": 987,
"options": "abc123",
"sort": Sort
}
Response
{
"data": {
"workbook_getSheetData": [
{
"id": 4,
"autoId": 123,
"sheet": "xyz789",
"created": "2007-12-03",
"lastModified": "2007-12-03",
"user": "abc123",
"deviceId": "abc123",
"userProfileId": "xyz789",
"userProfile": UserProfileBasicData,
"data": {}
}
]
}
}
workspaceRoot
Description
Liefert das Workspace Basisverzeichnis der App
Response
Returns an WSRoot
Example
Query
query workspaceRoot {
workspaceRoot {
id
workspaceId
type
key
readonly
name
lastModified
lastModifiedBy
description
size
children
parentId
}
}
Response
{
"data": {
"workspaceRoot": {
"id": WSFileId,
"workspaceId": WSFileId,
"type": "ROOT",
"key": "abc123",
"readonly": true,
"name": "abc123",
"lastModified": "2007-12-03",
"lastModifiedBy": "abc123",
"description": "abc123",
"size": 987,
"children": 987,
"parentId": "xyz789"
}
}
}
Mutations
addGroupMember
Description
Fügt ein Mitglied zur Gruppe hinzu
Example
Query
mutation addGroupMember(
$id: ID!,
$profile: ID!
) {
addGroupMember(
id: $id,
profile: $profile
) {
id
appId
name
memberIds
members {
...UserProfileBasicDataFragment
}
leaderIds
leaders {
...UserProfileBasicDataFragment
}
roles
system
numberOfMembers
description
publicGroup
listedGroup
icon {
...ResourceFragment
}
iconId
leader
groupSpaceEnabled
}
}
Variables
{
"id": "4",
"profile": "4"
}
Response
{
"data": {
"addGroupMember": {
"id": 4,
"appId": AppID,
"name": "xyz789",
"memberIds": ["abc123"],
"members": [UserProfileBasicData],
"leaderIds": ["xyz789"],
"leaders": [UserProfileBasicData],
"roles": ["xyz789"],
"system": false,
"numberOfMembers": 123,
"description": "xyz789",
"publicGroup": false,
"listedGroup": true,
"icon": Resource,
"iconId": "xyz789",
"leader": false,
"groupSpaceEnabled": true
}
}
}
answerGroupAccessRequest
Description
Beantwortet die Frage nach einer Gruppenmitgliedschaft
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
answer - GroupAccessRequestAnswerInput!
|
Example
Query
mutation answerGroupAccessRequest($answer: GroupAccessRequestAnswerInput!) {
answerGroupAccessRequest(answer: $answer)
}
Variables
{"answer": GroupAccessRequestAnswerInput}
Response
{"data": {"answerGroupAccessRequest": true}}
appendDataToTimeSeries
Description
hinzufügen von Werten zu einer Serie
Response
Returns [TimeSeriesData]!
Arguments
| Name | Description |
|---|---|
seriesId - ID!
|
|
data - [TimeSeriesDataInput!]!
|
Example
Query
mutation appendDataToTimeSeries(
$seriesId: ID!,
$data: [TimeSeriesDataInput!]!
) {
appendDataToTimeSeries(
seriesId: $seriesId,
data: $data
) {
id
timeSeriesId
metaData
timestamp
value
}
}
Variables
{"seriesId": 4, "data": [TimeSeriesDataInput]}
Response
{
"data": {
"appendDataToTimeSeries": [
{
"id": "4",
"timeSeriesId": "4",
"metaData": {},
"timestamp": "2007-12-03",
"value": 987.65
}
]
}
}
applyDefaultCategories
Description
Erstellt Standard-Kategorien für das aktuelle Projekt (in der Regel ein Bestandsprojekt). Sofern das Projekt noch keine Kategorien hat.
Response
Returns a Boolean
Example
Query
mutation applyDefaultCategories {
applyDefaultCategories
}
Response
{"data": {"applyDefaultCategories": false}}
assignDeviceToProfileByCode
Description
Der Benutzer scannt einen QR-Code, der in der Datenbank seinem Profil zugeordnet und ihm übergeben wurde, um die Verbindung zu seinem Gerät herzustellen.
Response
Returns a UserProfileRegistrationResult
Arguments
| Name | Description |
|---|---|
code - String!
|
Example
Query
mutation assignDeviceToProfileByCode($code: String!) {
assignDeviceToProfileByCode(code: $code) {
code
message
redirectUrl
}
}
Variables
{"code": "abc123"}
Response
{
"data": {
"assignDeviceToProfileByCode": {
"code": "ALREADY_ASSIGNED",
"message": "abc123",
"redirectUrl": Url
}
}
}
assignDeviceToUserProfile
Description
Der Benutzer möchte sein Gerät über die eingegebene Mail Adresse mit seinem Benutzerprofil verbinden. Sofern die Konfiguration die Verwendung einer verifizierten Mobilnummer erfordert, wird der Verifikationsprozess parallel zum Mail-Versand gestartet.
Response
Returns a UserProfileRegistrationResult
Example
Query
mutation assignDeviceToUserProfile(
$email: String!,
$phoneNumber: String
) {
assignDeviceToUserProfile(
email: $email,
phoneNumber: $phoneNumber
) {
code
message
redirectUrl
}
}
Variables
{
"email": "abc123",
"phoneNumber": "abc123"
}
Response
{
"data": {
"assignDeviceToUserProfile": {
"code": "ALREADY_ASSIGNED",
"message": "abc123",
"redirectUrl": Url
}
}
}
cancelCalendarEventRegistration
Description
Die Reservierung wird storniert. Bei Erfolg wird der aktualisierte Event geliefert - jeweils mit der reduzierten Teilnehmerzahl und Sitzplatzbelegung.
Response
Returns a CalendarEvent
Example
Query
mutation cancelCalendarEventRegistration(
$registrationId: ID!,
$reason: String
) {
cancelCalendarEventRegistration(
registrationId: $registrationId,
reason: $reason
) {
id
calendarId
seriesId
title
subTitle
description
timeZoneId
timeZoneOffset
dateStart
dateTimeStart
localDateTimeStart
dateEnd
dateTimeEnd
localDateTimeEnd
categories {
...CalendarEventCategoryFragment
}
registrationRequired
publicRegistrationAllowed
allDay
maxSignUps
minSignUps
multiSignUpAllowed
memberListVisibility
maxAdditionalSignUps
registrationCount
deadlineStartOffsetMinutes
startOfRegistrationOffsetMinutes
cancelRegistrationDeadlineOffsetMinutes
requestCount
iconImage {
...MediaReferenceFragment
}
resources {
...MediaReferenceFragment
}
location {
...LocationFragment
}
detailLink
seats
ownRegistrations {
...CalendarEventRegistrationFragment
}
ownerId
owner {
...UserProfileFragment
}
contactId
contact {
...UserProfileFragment
}
contactGroupId
contactGroup {
...GroupFragment
}
canWrite
onlineConference
notifyEventContactPersonOnSignUp
issueTicketsUponRegistration
manageAttendees
reminder {
...CalendarEventReminderFragment
}
paymentDocumentation
registrationFormId
registrationForm {
...CalendarRegistrationFormFragment
}
products {
...ProductDefinitionFragment
}
waitingListEnabled
badgeEnabled
lastModificationDate
}
}
Variables
{"registrationId": 4, "reason": "abc123"}
Response
{
"data": {
"cancelCalendarEventRegistration": {
"id": 4,
"calendarId": 4,
"seriesId": 4,
"title": "abc123",
"subTitle": "abc123",
"description": "xyz789",
"timeZoneId": "abc123",
"timeZoneOffset": "abc123",
"dateStart": "2007-12-03",
"dateTimeStart": "xyz789",
"localDateTimeStart": "2020-07-19T08:45:59",
"dateEnd": "2007-12-03",
"dateTimeEnd": "xyz789",
"localDateTimeEnd": "2020-07-19T08:45:59",
"categories": [CalendarEventCategory],
"registrationRequired": false,
"publicRegistrationAllowed": true,
"allDay": true,
"maxSignUps": 987,
"minSignUps": 987,
"multiSignUpAllowed": true,
"memberListVisibility": "ADMIN",
"maxAdditionalSignUps": 123,
"registrationCount": 123,
"deadlineStartOffsetMinutes": 123,
"startOfRegistrationOffsetMinutes": 123,
"cancelRegistrationDeadlineOffsetMinutes": 123,
"requestCount": 987,
"iconImage": MediaReference,
"resources": [MediaReference],
"location": Location,
"detailLink": "abc123",
"seats": ["xyz789"],
"ownRegistrations": [CalendarEventRegistration],
"ownerId": "abc123",
"owner": UserProfile,
"contactId": "xyz789",
"contact": UserProfile,
"contactGroupId": 4,
"contactGroup": Group,
"canWrite": true,
"onlineConference": false,
"notifyEventContactPersonOnSignUp": false,
"issueTicketsUponRegistration": true,
"manageAttendees": true,
"reminder": CalendarEventReminder,
"paymentDocumentation": true,
"registrationFormId": "4",
"registrationForm": CalendarRegistrationForm,
"products": [ProductDefinition],
"waitingListEnabled": true,
"badgeEnabled": false,
"lastModificationDate": "2007-12-03"
}
}
}
cancelGroupAccessRequest
Description
Bricht die Mitgliedschaftsanfrage ab
cancelPendingDeviceAssignment
Description
Bricht den Zuweisungsprozess für ein Gerät zu einem Profil ab
Response
Returns a Boolean
Example
Query
mutation cancelPendingDeviceAssignment {
cancelPendingDeviceAssignment
}
Response
{"data": {"cancelPendingDeviceAssignment": true}}
cancelPhoneNumberChange
Description
Bricht den wechsel einer Telefonnummer ab
Response
Returns a Boolean
Example
Query
mutation cancelPhoneNumberChange {
cancelPhoneNumberChange
}
Response
{"data": {"cancelPhoneNumberChange": true}}
changeUserSettings
Description
Ändert die Benutzereinstellungen
Response
Returns a User
Arguments
| Name | Description |
|---|---|
settings - UserSettingsInput!
|
Example
Query
mutation changeUserSettings($settings: UserSettingsInput!) {
changeUserSettings(settings: $settings) {
username
email
currentAppId
permissions
lastLogin
deviceIds
language
technicalAppUser
inactive
appIds
currentAppDivisions
managed
fullName
cnumber
invalidLoginAttemps
password
lastAppLogin
}
}
Variables
{"settings": UserSettingsInput}
Response
{
"data": {
"changeUserSettings": {
"username": "xyz789",
"email": "abc123",
"currentAppId": AppID,
"permissions": ["MANAGE_COMPONENT"],
"lastLogin": "2007-12-03",
"deviceIds": ["abc123"],
"language": "abc123",
"technicalAppUser": true,
"inactive": true,
"appIds": ["abc123"],
"currentAppDivisions": ["abc123"],
"managed": false,
"fullName": "xyz789",
"cnumber": "xyz789",
"invalidLoginAttemps": 123,
"password": "abc123",
"lastAppLogin": "2007-12-03"
}
}
}
clearCalendar
Description
Löscht alle Einträge im Kalender
cloneListEntries
Description
Dupliziert mehrere Einträge und gibt die neuen Einträge zurück
Response
Returns [ListEntry]
Example
Query
mutation cloneListEntries(
$ids: [ID],
$componentId: ID!
) {
cloneListEntries(
ids: $ids,
componentId: $componentId
) {
id
appId
enabled
componentId
contentUrl
contentId
content {
...IWSFileFragment
}
imageUrl
imageId
previewImageUrl
previewImageId
audioUrl
audioId
audio {
...ResourceFragment
}
extraImageId
extraImageUrl
videoDownloadUrl
videoDownloadId
videoDownload {
...ResourceFragment
}
message
snippet
title
position
pinCode
publicationStart
publicationEnd
description
visibleByProfileRoles
zoomEnabled
facebookEnabled
lastModificationDate
creationDate
link
poiId
backgroundColor
eventStart
eventEnd
address
componentLink {
...ComponentReferenceFragment
}
componentLinkId
}
}
Variables
{"ids": ["4"], "componentId": 4}
Response
{
"data": {
"cloneListEntries": [
{
"id": 4,
"appId": AppID,
"enabled": false,
"componentId": "abc123",
"contentUrl": "abc123",
"contentId": 4,
"content": IWSFile,
"imageUrl": "xyz789",
"imageId": 4,
"previewImageUrl": "abc123",
"previewImageId": "4",
"audioUrl": "abc123",
"audioId": "4",
"audio": Resource,
"extraImageId": "4",
"extraImageUrl": "xyz789",
"videoDownloadUrl": "xyz789",
"videoDownloadId": 4,
"videoDownload": Resource,
"message": "xyz789",
"snippet": "xyz789",
"title": "abc123",
"position": 987,
"pinCode": "abc123",
"publicationStart": "2007-12-03",
"publicationEnd": "2007-12-03",
"description": "xyz789",
"visibleByProfileRoles": ["xyz789"],
"zoomEnabled": false,
"facebookEnabled": true,
"lastModificationDate": "2007-12-03",
"creationDate": "2007-12-03",
"link": "abc123",
"poiId": "xyz789",
"backgroundColor": "xyz789",
"eventStart": "2007-12-03",
"eventEnd": "2007-12-03",
"address": "xyz789",
"componentLink": ComponentReference,
"componentLinkId": "4"
}
]
}
}
cloneWorkbook
Description
fügt alle Arbeitsblätter des Quell-Workbooks an das Ende des Ziel-Workbooks
Response
Returns a WorkbookComponent
Example
Query
mutation cloneWorkbook(
$sourceId: ID!,
$destinationId: ID!,
$copyData: Boolean
) {
cloneWorkbook(
sourceId: $sourceId,
destinationId: $destinationId,
copyData: $copyData
) {
id
adminMail
worksheetIds
worksheets {
...WorksheetFragment
}
}
}
Variables
{
"sourceId": 4,
"destinationId": "4",
"copyData": false
}
Response
{
"data": {
"cloneWorkbook": {
"id": 4,
"adminMail": "xyz789",
"worksheetIds": ["abc123"],
"worksheets": [Worksheet]
}
}
}
confirmEventAttendance
Description
Der Veranstalter/Verantwortliche des Events, bestätigt die Teilnahme. Dies erfolgt entweder durch manuelles "abhaken" oder durch scannen des QR-Codes von der Registierungsbestätigung (Ticket) welches der Teilnehmer vorzeigt. Dies kann nur von einem zuständigen Ansprechpartner des Termins am Tag des Termins durchgeführt werden.
Response
Returns a CalendarEventRegistration
Arguments
| Name | Description |
|---|---|
registrationId - ID!
|
Example
Query
mutation confirmEventAttendance($registrationId: ID!) {
confirmEventAttendance(registrationId: $registrationId) {
id
creationDate
calendarEventId
seat {
...SeatFragment
}
comment
deviceId
clientId
client {
...UserProfileBasicDataFragment
}
status
waitingPosition
payed
formData
}
}
Variables
{"registrationId": "4"}
Response
{
"data": {
"confirmEventAttendance": {
"id": "4",
"creationDate": "2007-12-03",
"calendarEventId": 4,
"seat": Seat,
"comment": "abc123",
"deviceId": "xyz789",
"clientId": "xyz789",
"client": UserProfileBasicData,
"status": "abc123",
"waitingPosition": 987,
"payed": true,
"formData": {}
}
}
}
confirmEventPayment
Description
Die Bezahlung einer ggfs. kostenpflichtigen Termin-Anmeldung wird bestätigt. Dies kann entweder über ein passendes gültiges Ticket geschehen, welches dann entwertet wird oder manuell durch den Veranstalter/Verantwortlichen des Events, durch manuelle Bestätigung
Response
Returns a CalendarEventRegistration
Example
Query
mutation confirmEventPayment(
$registrationId: ID!,
$ticketId: ID
) {
confirmEventPayment(
registrationId: $registrationId,
ticketId: $ticketId
) {
id
creationDate
calendarEventId
seat {
...SeatFragment
}
comment
deviceId
clientId
client {
...UserProfileBasicDataFragment
}
status
waitingPosition
payed
formData
}
}
Variables
{"registrationId": "4", "ticketId": 4}
Response
{
"data": {
"confirmEventPayment": {
"id": "4",
"creationDate": "2007-12-03",
"calendarEventId": 4,
"seat": Seat,
"comment": "abc123",
"deviceId": "xyz789",
"clientId": "xyz789",
"client": UserProfileBasicData,
"status": "abc123",
"waitingPosition": 987,
"payed": true,
"formData": {}
}
}
}
copyWorkspaceFileToApp
Description
Kopiert eine Datei in eine andere App. Gibt die neue Datei zurück
Example
Query
mutation copyWorkspaceFileToApp(
$file: WSFileId!,
$appId: String!
) {
copyWorkspaceFileToApp(
file: $file,
appId: $appId
) {
id
workspaceId
type
key
readonly
name
lastModified
lastModifiedBy
description
size
parentId
}
}
Variables
{
"file": WSFileId,
"appId": "abc123"
}
Response
{
"data": {
"copyWorkspaceFileToApp": {
"id": WSFileId,
"workspaceId": WSFileId,
"type": "ROOT",
"key": "abc123",
"readonly": true,
"name": "xyz789",
"lastModified": "2007-12-03",
"lastModifiedBy": "abc123",
"description": "abc123",
"size": 987,
"parentId": "abc123"
}
}
}
createAdminUser
Description
Erstellt einen Administrator (INTERNAL)
Response
Returns a User
Arguments
| Name | Description |
|---|---|
request - AdminUserInput!
|
|
sendPassword - Boolean
|
Example
Query
mutation createAdminUser(
$request: AdminUserInput!,
$sendPassword: Boolean
) {
createAdminUser(
request: $request,
sendPassword: $sendPassword
) {
username
email
currentAppId
permissions
lastLogin
deviceIds
language
technicalAppUser
inactive
appIds
currentAppDivisions
managed
fullName
cnumber
invalidLoginAttemps
password
lastAppLogin
}
}
Variables
{"request": AdminUserInput, "sendPassword": false}
Response
{
"data": {
"createAdminUser": {
"username": "xyz789",
"email": "xyz789",
"currentAppId": AppID,
"permissions": ["MANAGE_COMPONENT"],
"lastLogin": "2007-12-03",
"deviceIds": ["abc123"],
"language": "abc123",
"technicalAppUser": false,
"inactive": false,
"appIds": ["abc123"],
"currentAppDivisions": ["abc123"],
"managed": false,
"fullName": "xyz789",
"cnumber": "xyz789",
"invalidLoginAttemps": 987,
"password": "xyz789",
"lastAppLogin": "2007-12-03"
}
}
}
createCalendar
Description
Erstellt einen neuen Kalender.
Response
Returns a Calendar
Arguments
| Name | Description |
|---|---|
data - CalendarInput!
|
Example
Query
mutation createCalendar($data: CalendarInput!) {
createCalendar(data: $data) {
id
appId
componentIds
title
color
description
readerRoles {
...CustomEnumValueFragment
}
writerRoles {
...CustomEnumValueFragment
}
readerGroupIds
readerGroups {
...GroupFragment
}
writerGroupIds
writerGroups {
...GroupFragment
}
ownedByGroupId
categories {
...CalendarEventCategoryFragment
}
iCalUrl
iCalLastSynced
canRead
canWrite
hints
}
}
Variables
{"data": CalendarInput}
Response
{
"data": {
"createCalendar": {
"id": 4,
"appId": AppID,
"componentIds": ["4"],
"title": "abc123",
"color": Color,
"description": "xyz789",
"readerRoles": [CustomEnumValue],
"writerRoles": [CustomEnumValue],
"readerGroupIds": ["xyz789"],
"readerGroups": [Group],
"writerGroupIds": ["abc123"],
"writerGroups": [Group],
"ownedByGroupId": "xyz789",
"categories": [CalendarEventCategory],
"iCalUrl": Url,
"iCalLastSynced": "2007-12-03",
"canRead": true,
"canWrite": false,
"hints": ["abc123"]
}
}
}
createCalendarEvents
Description
erzeugt eine einzelne oder eine Serie von Ereignissen innerhalb eines Kalender.
Response
Returns [CalendarEvent]!
Arguments
| Name | Description |
|---|---|
calendarId - ID!
|
Kalender zu dem dieses Ereignis gehören soll |
data - CalendarEventTemplate!
|
Eigenschaften des Events |
Example
Query
mutation createCalendarEvents(
$calendarId: ID!,
$data: CalendarEventTemplate!
) {
createCalendarEvents(
calendarId: $calendarId,
data: $data
) {
id
calendarId
seriesId
title
subTitle
description
timeZoneId
timeZoneOffset
dateStart
dateTimeStart
localDateTimeStart
dateEnd
dateTimeEnd
localDateTimeEnd
categories {
...CalendarEventCategoryFragment
}
registrationRequired
publicRegistrationAllowed
allDay
maxSignUps
minSignUps
multiSignUpAllowed
memberListVisibility
maxAdditionalSignUps
registrationCount
deadlineStartOffsetMinutes
startOfRegistrationOffsetMinutes
cancelRegistrationDeadlineOffsetMinutes
requestCount
iconImage {
...MediaReferenceFragment
}
resources {
...MediaReferenceFragment
}
location {
...LocationFragment
}
detailLink
seats
ownRegistrations {
...CalendarEventRegistrationFragment
}
ownerId
owner {
...UserProfileFragment
}
contactId
contact {
...UserProfileFragment
}
contactGroupId
contactGroup {
...GroupFragment
}
canWrite
onlineConference
notifyEventContactPersonOnSignUp
issueTicketsUponRegistration
manageAttendees
reminder {
...CalendarEventReminderFragment
}
paymentDocumentation
registrationFormId
registrationForm {
...CalendarRegistrationFormFragment
}
products {
...ProductDefinitionFragment
}
waitingListEnabled
badgeEnabled
lastModificationDate
}
}
Variables
{"calendarId": 4, "data": CalendarEventTemplate}
Response
{
"data": {
"createCalendarEvents": [
{
"id": 4,
"calendarId": 4,
"seriesId": "4",
"title": "xyz789",
"subTitle": "xyz789",
"description": "abc123",
"timeZoneId": "xyz789",
"timeZoneOffset": "abc123",
"dateStart": "2007-12-03",
"dateTimeStart": "xyz789",
"localDateTimeStart": "2020-07-19T08:45:59",
"dateEnd": "2007-12-03",
"dateTimeEnd": "abc123",
"localDateTimeEnd": "2020-07-19T08:45:59",
"categories": [CalendarEventCategory],
"registrationRequired": false,
"publicRegistrationAllowed": false,
"allDay": false,
"maxSignUps": 123,
"minSignUps": 987,
"multiSignUpAllowed": false,
"memberListVisibility": "ADMIN",
"maxAdditionalSignUps": 987,
"registrationCount": 123,
"deadlineStartOffsetMinutes": 123,
"startOfRegistrationOffsetMinutes": 123,
"cancelRegistrationDeadlineOffsetMinutes": 123,
"requestCount": 987,
"iconImage": MediaReference,
"resources": [MediaReference],
"location": Location,
"detailLink": "abc123",
"seats": ["abc123"],
"ownRegistrations": [CalendarEventRegistration],
"ownerId": "xyz789",
"owner": UserProfile,
"contactId": "xyz789",
"contact": UserProfile,
"contactGroupId": "4",
"contactGroup": Group,
"canWrite": false,
"onlineConference": true,
"notifyEventContactPersonOnSignUp": false,
"issueTicketsUponRegistration": true,
"manageAttendees": false,
"reminder": CalendarEventReminder,
"paymentDocumentation": true,
"registrationFormId": "4",
"registrationForm": CalendarRegistrationForm,
"products": [ProductDefinition],
"waitingListEnabled": true,
"badgeEnabled": true,
"lastModificationDate": "2007-12-03"
}
]
}
}
createCalendarFromICal
Description
erzeugt einen Kalender aus einem iCal Feed. Ein read-only Kalender kann von niemandem bearbeitet werden, da das führende System extern ist. Die Daten werden regelmäßig im Hintergrund aktualisiert. Sofern der Kalender nachbearbeitet werden oder auch für Reservierungen genutzt werden soll, handelt es sich um eine einmalige Datenübernahme und der Kalender hat in Folge keine Verbindung mehr zu der ursprünglichen Quelle
Response
Returns a Calendar
Arguments
| Name | Description |
|---|---|
data - CalendarInput!
|
|
url - Url!
|
|
readonly - Boolean
|
Default = true |
Example
Query
mutation createCalendarFromICal(
$data: CalendarInput!,
$url: Url!,
$readonly: Boolean
) {
createCalendarFromICal(
data: $data,
url: $url,
readonly: $readonly
) {
id
appId
componentIds
title
color
description
readerRoles {
...CustomEnumValueFragment
}
writerRoles {
...CustomEnumValueFragment
}
readerGroupIds
readerGroups {
...GroupFragment
}
writerGroupIds
writerGroups {
...GroupFragment
}
ownedByGroupId
categories {
...CalendarEventCategoryFragment
}
iCalUrl
iCalLastSynced
canRead
canWrite
hints
}
}
Variables
{
"data": CalendarInput,
"url": Url,
"readonly": true
}
Response
{
"data": {
"createCalendarFromICal": {
"id": "4",
"appId": AppID,
"componentIds": ["4"],
"title": "xyz789",
"color": Color,
"description": "abc123",
"readerRoles": [CustomEnumValue],
"writerRoles": [CustomEnumValue],
"readerGroupIds": ["abc123"],
"readerGroups": [Group],
"writerGroupIds": ["xyz789"],
"writerGroups": [Group],
"ownedByGroupId": "xyz789",
"categories": [CalendarEventCategory],
"iCalUrl": Url,
"iCalLastSynced": "2007-12-03",
"canRead": false,
"canWrite": false,
"hints": ["abc123"]
}
}
}
createCalendarInGroupSpace
Description
Erzeugt einen Kalender, der diesem Gruppenraum/der Gruppe zugeordnet ist
Response
Returns a GroupSpaceLink
Example
Query
mutation createCalendarInGroupSpace(
$spaceId: ID!,
$label: String!,
$color: String
) {
createCalendarInGroupSpace(
spaceId: $spaceId,
label: $label,
color: $color
) {
id
name
linkType
targetComponentId
target
badge
}
}
Variables
{
"spaceId": 4,
"label": "xyz789",
"color": "#0f4072"
}
Response
{
"data": {
"createCalendarInGroupSpace": {
"id": "4",
"name": "abc123",
"linkType": "CHAT_CHANNEL",
"targetComponentId": "xyz789",
"target": "abc123",
"badge": 123
}
}
}
createCalendarRegistrationForm
Description
Erstellt ein Formular
Response
Returns a CalendarRegistrationForm
Arguments
| Name | Description |
|---|---|
input - CalendarRegistrationFormInput!
|
Example
Query
mutation createCalendarRegistrationForm($input: CalendarRegistrationFormInput!) {
createCalendarRegistrationForm(input: $input) {
name
id
header
footer
fields {
...WorksheetColumnMetaDataFragment
}
usedInEventsCount
}
}
Variables
{"input": CalendarRegistrationFormInput}
Response
{
"data": {
"createCalendarRegistrationForm": {
"name": "xyz789",
"id": 4,
"header": "abc123",
"footer": "abc123",
"fields": [WorksheetColumnMetaData],
"usedInEventsCount": {}
}
}
}
createChatChannel
Description
Erwartet das Input Objekt und die ID der Chat-Komponente
Response
Returns a ChatChannel
Arguments
| Name | Description |
|---|---|
input - ChatChannelInput!
|
|
chatComponent - ID!
|
Example
Query
mutation createChatChannel(
$input: ChatChannelInput!,
$chatComponent: ID!
) {
createChatChannel(
input: $input,
chatComponent: $chatComponent
) {
id
active
componentId
icon {
...ResourceFragment
}
iconId
iconUrl
backgroundImageId
backgroundImage {
...ResourceFragment
}
backgroundImageUrl
backgroundColor
label
pinCode
readOnly
allowPseudonyms
visibleByProfileRoles
visibleByDepartments
autoSubscribedRoles
autoSubscribedGroups
subscriptionsCount
directAdminProfilesIds
directAdminProfiles {
...UserProfileFragment
}
adminGroupId
adminGroup {
...GroupFragment
}
}
}
Variables
{
"input": ChatChannelInput,
"chatComponent": "4"
}
Response
{
"data": {
"createChatChannel": {
"id": 4,
"active": false,
"componentId": "abc123",
"icon": Resource,
"iconId": 4,
"iconUrl": "abc123",
"backgroundImageId": "4",
"backgroundImage": Resource,
"backgroundImageUrl": "abc123",
"backgroundColor": "abc123",
"label": "xyz789",
"pinCode": "abc123",
"readOnly": false,
"allowPseudonyms": true,
"visibleByProfileRoles": ["xyz789"],
"visibleByDepartments": ["abc123"],
"autoSubscribedRoles": ["xyz789"],
"autoSubscribedGroups": ["xyz789"],
"subscriptionsCount": {},
"directAdminProfilesIds": ["abc123"],
"directAdminProfiles": [UserProfile],
"adminGroupId": "4",
"adminGroup": Group
}
}
}
createChatChannelInGroupSpace
Description
Erzeugt einen neuen Chat-Kanal, der diesem Gruppenraum/der Gruppe zugeordnet ist
Response
Returns a GroupSpaceLink
Example
Query
mutation createChatChannelInGroupSpace(
$spaceId: ID!,
$label: String!
) {
createChatChannelInGroupSpace(
spaceId: $spaceId,
label: $label
) {
id
name
linkType
targetComponentId
target
badge
}
}
Variables
{
"spaceId": "4",
"label": "abc123"
}
Response
{
"data": {
"createChatChannelInGroupSpace": {
"id": "4",
"name": "xyz789",
"linkType": "CHAT_CHANNEL",
"targetComponentId": "abc123",
"target": "xyz789",
"badge": 987
}
}
}
createCouponTemplate
Description
erzeugt eine Gutschein-Vorlage
Response
Returns a Coupon
Arguments
| Name | Description |
|---|---|
spec - CouponTemplate!
|
Example
Query
mutation createCouponTemplate($spec: CouponTemplate!) {
createCouponTemplate(spec: $spec) {
id
bonusBookletId
bonusProgramId
couponSpecificationId
description
enabled
expireDate
imageId
image {
...ResourceFragment
}
imageURL
startupCoupon
startupCouponDispatchDate
status
title
used
usedDate
value
lastModified
}
}
Variables
{"spec": CouponTemplate}
Response
{
"data": {
"createCouponTemplate": {
"id": "4",
"bonusBookletId": 4,
"bonusProgramId": "4",
"couponSpecificationId": 4,
"description": "abc123",
"enabled": false,
"expireDate": "2007-12-03",
"imageId": "4",
"image": Resource,
"imageURL": "abc123",
"startupCoupon": true,
"startupCouponDispatchDate": "2007-12-03",
"status": "inactive",
"title": "xyz789",
"used": false,
"usedDate": "2007-12-03",
"value": 987,
"lastModified": "2007-12-03"
}
}
}
createCustomEnumValue
Description
Zu einer Aufzählung, z.B Abteilungen oder angepasste Rollen wird ein neuer Key und mindestens eine Sprachversion eingefügt.
Response
Returns a CustomEnum
Arguments
| Name | Description |
|---|---|
entry - CustomEnumKeyInput!
|
Example
Query
mutation createCustomEnumValue($entry: CustomEnumKeyInput!) {
createCustomEnumValue(entry: $entry) {
id
keys
locales
translations {
...EnumTranslationFragment
}
}
}
Variables
{"entry": CustomEnumKeyInput}
Response
{
"data": {
"createCustomEnumValue": {
"id": "4",
"keys": ["xyz789"],
"locales": ["xyz789"],
"translations": [EnumTranslation]
}
}
}
createFamilyMember
Description
Im Kontext des aktuellen Profils soll das Profil eines Familienmitgliedes erzeugt werden
Response
Returns a UserProfile
Arguments
| Name | Description |
|---|---|
userProfile - FamilyMemberInput!
|
Example
Query
mutation createFamilyMember($userProfile: FamilyMemberInput!) {
createFamilyMember(userProfile: $userProfile) {
salutation {
...CustomEnumValueFragment
}
roles {
...CustomEnumValueFragment
}
requestedRoles {
...CustomEnumValueFragment
}
departments {
...CustomEnumValueFragment
}
groups {
...GroupFragment
}
id
externalId
lastModified
created
appId
appGroup
name
firstname
email
birthday
title
imageId
imageThumbId
deviceIds
membershipNumber
agreedToAds
verificationPending
mailConfirmationPending
locked
mainProfile
familyProfileNumber
locale
country {
...CustomEnumValueFragment
}
degree
nickname
street
postcode
city
state
phone
phoneMobile
phoneMobileRequest
phoneMobileVerificationStatus
identityNumber
personnelNumber
level
sports
companyName
companyDepartment
companyFunction
university
community
maritalStatus
skills
specialization
offers
interests
bankAccountHolder
bankBIC
bankIBAN
bankName
bankSEPARef
bankSEPADate
feeKind
feeAmount
paymentMethod
entryDate
exitDate
coachingLicense
customerNumber
dataPrivacyStatementAccepted
datePrivacyStatementAccepted
dataTermsOfUseAccepted
dateTermsOfUseAccepted
statutesAccepted
chatRulesAccepted
publicProfile
remarks
members {
...UserProfileFragment
}
accountActive
chatAccount
activationCode
clubName
clubNumber
team
playerPosition
playerNumber
playerHeight
licenseNumber
realname
customFields
agreedDisplayName
agreedDisplayPhone
agreedDisplayMail
}
}
Variables
{"userProfile": FamilyMemberInput}
Response
{
"data": {
"createFamilyMember": {
"salutation": CustomEnumValue,
"roles": [CustomEnumValue],
"requestedRoles": [CustomEnumValue],
"departments": [CustomEnumValue],
"groups": [Group],
"id": "abc123",
"externalId": "xyz789",
"lastModified": "2007-12-03",
"created": "2007-12-03",
"appId": "xyz789",
"appGroup": "abc123",
"name": "xyz789",
"firstname": "abc123",
"email": "xyz789",
"birthday": "2007-12-03",
"title": "xyz789",
"imageId": "xyz789",
"imageThumbId": "abc123",
"deviceIds": ["xyz789"],
"membershipNumber": "xyz789",
"agreedToAds": true,
"verificationPending": true,
"mailConfirmationPending": false,
"locked": false,
"mainProfile": false,
"familyProfileNumber": "xyz789",
"locale": "abc123",
"country": CustomEnumValue,
"degree": "abc123",
"nickname": "abc123",
"street": "xyz789",
"postcode": "xyz789",
"city": "abc123",
"state": "xyz789",
"phone": "xyz789",
"phoneMobile": "abc123",
"phoneMobileRequest": "xyz789",
"phoneMobileVerificationStatus": "REQUIRED",
"identityNumber": "xyz789",
"personnelNumber": "abc123",
"level": "xyz789",
"sports": "abc123",
"companyName": "abc123",
"companyDepartment": "abc123",
"companyFunction": "xyz789",
"university": "xyz789",
"community": "xyz789",
"maritalStatus": "abc123",
"skills": "xyz789",
"specialization": "abc123",
"offers": "abc123",
"interests": "abc123",
"bankAccountHolder": "xyz789",
"bankBIC": "xyz789",
"bankIBAN": "abc123",
"bankName": "xyz789",
"bankSEPARef": "abc123",
"bankSEPADate": "2007-12-03",
"feeKind": "abc123",
"feeAmount": "abc123",
"paymentMethod": "abc123",
"entryDate": "2007-12-03",
"exitDate": "2007-12-03",
"coachingLicense": false,
"customerNumber": "abc123",
"dataPrivacyStatementAccepted": "xyz789",
"datePrivacyStatementAccepted": "2007-12-03",
"dataTermsOfUseAccepted": "xyz789",
"dateTermsOfUseAccepted": "2007-12-03",
"statutesAccepted": false,
"chatRulesAccepted": false,
"publicProfile": true,
"remarks": "abc123",
"members": [UserProfile],
"accountActive": false,
"chatAccount": true,
"activationCode": "abc123",
"clubName": "abc123",
"clubNumber": "xyz789",
"team": "abc123",
"playerPosition": "xyz789",
"playerNumber": "xyz789",
"playerHeight": 987,
"licenseNumber": "xyz789",
"realname": "xyz789",
"customFields": {},
"agreedDisplayName": true,
"agreedDisplayPhone": true,
"agreedDisplayMail": false
}
}
}
createFileStoreDirectory
Description
Erstellt ein Verzeichnis
Response
Returns an FSFile
Example
Query
mutation createFileStoreDirectory(
$storeId: FSId,
$name: String!,
$parent: FSFileId
) {
createFileStoreDirectory(
storeId: $storeId,
name: $name,
parent: $parent
) {
fsId
id
parentId
contentType
name
contentLength
directory
status
created
createdBy
lastModified
lastModifiedBy
eTag
uploadUrl
downloadUrl
thumbnailImageUrl
}
}
Variables
{
"storeId": FSId,
"name": "xyz789",
"parent": FSFileId
}
Response
{
"data": {
"createFileStoreDirectory": {
"fsId": FSId,
"id": FSFileId,
"parentId": FSFileId,
"contentType": "xyz789",
"name": "abc123",
"contentLength": {},
"directory": false,
"status": "READY",
"created": "2007-12-03",
"createdBy": "xyz789",
"lastModified": "2007-12-03",
"lastModifiedBy": "abc123",
"eTag": "xyz789",
"uploadUrl": Url,
"downloadUrl": Url,
"thumbnailImageUrl": Url
}
}
}
createFileStoreFile
Description
Erstellt eine leere Datei. Bereit zum Upload
Response
Returns an FSFile
Arguments
| Name | Description |
|---|---|
storeId - FSId
|
|
request - FSFileUploadRequest!
|
|
parent - FSFileId
|
Example
Query
mutation createFileStoreFile(
$storeId: FSId,
$request: FSFileUploadRequest!,
$parent: FSFileId
) {
createFileStoreFile(
storeId: $storeId,
request: $request,
parent: $parent
) {
fsId
id
parentId
contentType
name
contentLength
directory
status
created
createdBy
lastModified
lastModifiedBy
eTag
uploadUrl
downloadUrl
thumbnailImageUrl
}
}
Variables
{
"storeId": FSId,
"request": FSFileUploadRequest,
"parent": FSFileId
}
Response
{
"data": {
"createFileStoreFile": {
"fsId": FSId,
"id": FSFileId,
"parentId": FSFileId,
"contentType": "abc123",
"name": "abc123",
"contentLength": {},
"directory": true,
"status": "READY",
"created": "2007-12-03",
"createdBy": "abc123",
"lastModified": "2007-12-03",
"lastModifiedBy": "xyz789",
"eTag": "xyz789",
"uploadUrl": Url,
"downloadUrl": Url,
"thumbnailImageUrl": Url
}
}
}
createGroup
Description
Erzeugt eine neue Gruppe. Der Name darf noch nicht vergeben sein
Response
Returns a Group
Arguments
| Name | Description |
|---|---|
group - GroupInput!
|
Example
Query
mutation createGroup($group: GroupInput!) {
createGroup(group: $group) {
id
appId
name
memberIds
members {
...UserProfileBasicDataFragment
}
leaderIds
leaders {
...UserProfileBasicDataFragment
}
roles
system
numberOfMembers
description
publicGroup
listedGroup
icon {
...ResourceFragment
}
iconId
leader
groupSpaceEnabled
}
}
Variables
{"group": GroupInput}
Response
{
"data": {
"createGroup": {
"id": 4,
"appId": AppID,
"name": "xyz789",
"memberIds": ["abc123"],
"members": [UserProfileBasicData],
"leaderIds": ["abc123"],
"leaders": [UserProfileBasicData],
"roles": ["xyz789"],
"system": true,
"numberOfMembers": 123,
"description": "xyz789",
"publicGroup": false,
"listedGroup": false,
"icon": Resource,
"iconId": "abc123",
"leader": true,
"groupSpaceEnabled": false
}
}
}
createLinkInGroupSpace
Description
Erzeugt einen externen oder App-internen Link, der diesem Gruppenraum/der Gruppe zugeordnet ist
Response
Returns a GroupSpaceLink
Example
Query
mutation createLinkInGroupSpace(
$spaceId: ID!,
$label: String!,
$url: String!
) {
createLinkInGroupSpace(
spaceId: $spaceId,
label: $label,
url: $url
) {
id
name
linkType
targetComponentId
target
badge
}
}
Variables
{
"spaceId": "4",
"label": "xyz789",
"url": "abc123"
}
Response
{
"data": {
"createLinkInGroupSpace": {
"id": 4,
"name": "xyz789",
"linkType": "CHAT_CHANNEL",
"targetComponentId": "xyz789",
"target": "xyz789",
"badge": 123
}
}
}
createListEntry
Description
Anlegen einer neuen Eintrags
Response
Returns a ListEntry
Arguments
| Name | Description |
|---|---|
input - ListEntryInput
|
|
componentId - ID!
|
Example
Query
mutation createListEntry(
$input: ListEntryInput,
$componentId: ID!
) {
createListEntry(
input: $input,
componentId: $componentId
) {
id
appId
enabled
componentId
contentUrl
contentId
content {
...IWSFileFragment
}
imageUrl
imageId
previewImageUrl
previewImageId
audioUrl
audioId
audio {
...ResourceFragment
}
extraImageId
extraImageUrl
videoDownloadUrl
videoDownloadId
videoDownload {
...ResourceFragment
}
message
snippet
title
position
pinCode
publicationStart
publicationEnd
description
visibleByProfileRoles
zoomEnabled
facebookEnabled
lastModificationDate
creationDate
link
poiId
backgroundColor
eventStart
eventEnd
address
componentLink {
...ComponentReferenceFragment
}
componentLinkId
}
}
Variables
{
"input": ListEntryInput,
"componentId": "4"
}
Response
{
"data": {
"createListEntry": {
"id": 4,
"appId": AppID,
"enabled": true,
"componentId": "abc123",
"contentUrl": "xyz789",
"contentId": 4,
"content": IWSFile,
"imageUrl": "abc123",
"imageId": 4,
"previewImageUrl": "abc123",
"previewImageId": 4,
"audioUrl": "abc123",
"audioId": "4",
"audio": Resource,
"extraImageId": 4,
"extraImageUrl": "xyz789",
"videoDownloadUrl": "xyz789",
"videoDownloadId": "4",
"videoDownload": Resource,
"message": "abc123",
"snippet": "xyz789",
"title": "xyz789",
"position": 123,
"pinCode": "xyz789",
"publicationStart": "2007-12-03",
"publicationEnd": "2007-12-03",
"description": "abc123",
"visibleByProfileRoles": ["xyz789"],
"zoomEnabled": true,
"facebookEnabled": true,
"lastModificationDate": "2007-12-03",
"creationDate": "2007-12-03",
"link": "xyz789",
"poiId": "xyz789",
"backgroundColor": "xyz789",
"eventStart": "2007-12-03",
"eventEnd": "2007-12-03",
"address": "abc123",
"componentLink": ComponentReference,
"componentLinkId": 4
}
}
}
createLocation
Description
creates a new location in the current app scope
Response
Returns a Location!
Arguments
| Name | Description |
|---|---|
data - LocationInput
|
Example
Query
mutation createLocation($data: LocationInput) {
createLocation(data: $data) {
id
appId
title
street
postalCode
city
geoLat
geoLng
}
}
Variables
{"data": LocationInput}
Response
{
"data": {
"createLocation": {
"id": 4,
"appId": AppID,
"title": "xyz789",
"street": "abc123",
"postalCode": "abc123",
"city": "xyz789",
"geoLat": 987.65,
"geoLng": 123.45
}
}
}
createOrUpdateCalendarEventCategory
Description
Fügt dem Kalender eine neue Event Kategorie hinzu.
Response
Returns a CalendarEventCategory!
Arguments
| Name | Description |
|---|---|
calendarId - ID!
|
Kalender Kontext |
input - CalendarEventCategoryInput!
|
Category input |
Example
Query
mutation createOrUpdateCalendarEventCategory(
$calendarId: ID!,
$input: CalendarEventCategoryInput!
) {
createOrUpdateCalendarEventCategory(
calendarId: $calendarId,
input: $input
) {
id
title
color
}
}
Variables
{"calendarId": 4, "input": CalendarEventCategoryInput}
Response
{
"data": {
"createOrUpdateCalendarEventCategory": {
"id": "4",
"title": "abc123",
"color": Color
}
}
}
createProduct
Description
Create Product Definition
Response
Returns a ProductDefinition
Arguments
| Name | Description |
|---|---|
input - ProductDefinitionInput!
|
Example
Query
mutation createProduct($input: ProductDefinitionInput!) {
createProduct(input: $input) {
id
name
description
imageId
image {
...ResourceFragment
}
type
unitCount
validMonths
price {
...PriceFragment
}
tax {
...TaxFragment
}
paymentProviderReference {
...PaymentProviderReferenceFragment
}
sellCount
}
}
Variables
{"input": ProductDefinitionInput}
Response
{
"data": {
"createProduct": {
"id": "4",
"name": "abc123",
"description": "xyz789",
"imageId": "4",
"image": Resource,
"type": "SINGLE_TICKET",
"unitCount": 123,
"validMonths": 123,
"price": Price,
"tax": Tax,
"paymentProviderReference": PaymentProviderReference,
"sellCount": 987
}
}
}
createProject
Description
Erzeugt ein neues Projekt optional als Kopie eines anderen
Response
Returns a ProjectSpecification
Example
Query
mutation createProject(
$id: ID!,
$templateId: ID
) {
createProject(
id: $id,
templateId: $templateId
) {
name
portalAppName
groupId
iosNavigationType
locale
components {
...ComponentReferenceFragment
}
}
}
Variables
{"id": "4", "templateId": 4}
Response
{
"data": {
"createProject": {
"name": "xyz789",
"portalAppName": "abc123",
"groupId": "xyz789",
"iosNavigationType": "xyz789",
"locale": "xyz789",
"components": [ComponentReference]
}
}
}
createProjectStructureNodes
Description
fügt mehrere Strukturknoten (Module/Komponenten) zu einem Projekt hinzu
Response
Returns [ProjectStructureNode]
Arguments
| Name | Description |
|---|---|
projectId - ID!
|
|
components - [ProjectStructureNodeCreateInput]!
|
Example
Query
mutation createProjectStructureNodes(
$projectId: ID!,
$components: [ProjectStructureNodeCreateInput]!
) {
createProjectStructureNodes(
projectId: $projectId,
components: $components
) {
id
parentId
label
component {
...ComponentReferenceFragment
}
categories {
...ProjectStructureNodeCategoryFragment
}
children
}
}
Variables
{
"projectId": 4,
"components": [ProjectStructureNodeCreateInput]
}
Response
{
"data": {
"createProjectStructureNodes": [
{
"id": 4,
"parentId": "4",
"label": "xyz789",
"component": ComponentReference,
"categories": [ProjectStructureNodeCategory],
"children": ["xyz789"]
}
]
}
}
createPushChannel
Description
Erstellt einen Pushkanal
Response
Returns a PushChannel
Arguments
| Name | Description |
|---|---|
channel - PushChannelInput!
|
Example
Query
mutation createPushChannel($channel: PushChannelInput!) {
createPushChannel(channel: $channel) {
appId
id
number
name
description
imageResource {
...ResourceFragment
}
imageResourceId
soundId
autoSubscribe
initialSubscribe
active
subscriptionCount
allowedGroups {
...GroupFragment
}
allowedGroupIds
subscribed
}
}
Variables
{"channel": PushChannelInput}
Response
{
"data": {
"createPushChannel": {
"appId": AppID,
"id": "4",
"number": 987,
"name": "xyz789",
"description": "xyz789",
"imageResource": Resource,
"imageResourceId": "xyz789",
"soundId": "xyz789",
"autoSubscribe": false,
"initialSubscribe": true,
"active": false,
"subscriptionCount": 123,
"allowedGroups": [Group],
"allowedGroupIds": ["4"],
"subscribed": true
}
}
}
createResourceCategory
Description
erstellt eine Kategorie. Aktuell valide Scopes sind: IMAGES oder HTML
Response
Returns a ResourceCategory
Arguments
| Name | Description |
|---|---|
input - ResourceCategoryInput!
|
Example
Query
mutation createResourceCategory($input: ResourceCategoryInput!) {
createResourceCategory(input: $input) {
id
name
scope
color
lastModificationDate
}
}
Variables
{"input": ResourceCategoryInput}
Response
{
"data": {
"createResourceCategory": {
"id": 4,
"name": "xyz789",
"scope": "abc123",
"color": "abc123",
"lastModificationDate": "2007-12-03"
}
}
}
createSignedResourceUpload
Description
Generiert Signed Upload URLs. Mit dieser URL kann per Post direkt in das S3 kompatible Storage geladen werden. Die Resourcen werden im Status uploading erstellt und werden später als abgeschlossen markiert.
Response
Returns [ResourceUploadSigningResponse]
Arguments
| Name | Description |
|---|---|
requests - [ResourceUploadSigningRequest]!
|
Example
Query
mutation createSignedResourceUpload($requests: [ResourceUploadSigningRequest]!) {
createSignedResourceUpload(requests: $requests) {
filename
uploadUrl
resource {
...ResourceFragment
}
error
}
}
Variables
{"requests": [ResourceUploadSigningRequest]}
Response
{
"data": {
"createSignedResourceUpload": [
{
"filename": "abc123",
"uploadUrl": "xyz789",
"resource": Resource,
"error": "xyz789"
}
]
}
}
createSignedResourceUploadCompleted
Description
Zeigt dem Server an, dass die Upload abgeschlossen wurde. Es werden dann die notwendigen Post-Upload-Prozesse gestartet.
Response
Returns [Resource]
Arguments
| Name | Description |
|---|---|
resourceIds - [String]!
|
Example
Query
mutation createSignedResourceUploadCompleted($resourceIds: [String]!) {
createSignedResourceUploadCompleted(resourceIds: $resourceIds) {
id
url
notes
previewImageUrl
creationDate
lastModificationDate
mimeType
title
creator
resourceCategoryId
resourceCategory {
...ResourceCategoryFragment
}
width
height
contentLength
status
deviceId
user_comment
user_title
user_contact
user_category
lat
lng
}
}
Variables
{"resourceIds": ["xyz789"]}
Response
{
"data": {
"createSignedResourceUploadCompleted": [
{
"id": "4",
"url": "abc123",
"notes": "xyz789",
"previewImageUrl": "xyz789",
"creationDate": "2007-12-03",
"lastModificationDate": "2007-12-03",
"mimeType": "xyz789",
"title": "xyz789",
"creator": "abc123",
"resourceCategoryId": "abc123",
"resourceCategory": ResourceCategory,
"width": 123,
"height": 987,
"contentLength": 123,
"status": "pending",
"deviceId": "abc123",
"user_comment": "abc123",
"user_title": "abc123",
"user_contact": "xyz789",
"user_category": "abc123",
"lat": "abc123",
"lng": "xyz789"
}
]
}
}
createStructureNodeCategory
Description
Erzeugt eine Kategorie
Response
Returns a ProjectStructureNodeCategory
Arguments
| Name | Description |
|---|---|
category - ProjectStructureNodeCategoryInput!
|
Example
Query
mutation createStructureNodeCategory($category: ProjectStructureNodeCategoryInput!) {
createStructureNodeCategory(category: $category) {
id
name
color
lastModificationDate
}
}
Variables
{"category": ProjectStructureNodeCategoryInput}
Response
{
"data": {
"createStructureNodeCategory": {
"id": "4",
"name": "xyz789",
"color": "xyz789",
"lastModificationDate": "2007-12-03"
}
}
}
createTemporaryTechnicalUser
Description
erzeugt einen neuen temporären technischen Benutzer und gibt die Credentials zurück
Response
Returns a User
Example
Query
mutation createTemporaryTechnicalUser {
createTemporaryTechnicalUser {
username
email
currentAppId
permissions
lastLogin
deviceIds
language
technicalAppUser
inactive
appIds
currentAppDivisions
managed
fullName
cnumber
invalidLoginAttemps
password
lastAppLogin
}
}
Response
{
"data": {
"createTemporaryTechnicalUser": {
"username": "xyz789",
"email": "xyz789",
"currentAppId": AppID,
"permissions": ["MANAGE_COMPONENT"],
"lastLogin": "2007-12-03",
"deviceIds": ["xyz789"],
"language": "abc123",
"technicalAppUser": true,
"inactive": false,
"appIds": ["abc123"],
"currentAppDivisions": ["abc123"],
"managed": true,
"fullName": "abc123",
"cnumber": "xyz789",
"invalidLoginAttemps": 987,
"password": "xyz789",
"lastAppLogin": "2007-12-03"
}
}
}
createTextWidget
Description
Creates a new Text-Widget
Response
Returns a TextWidget
Example
Query
mutation createTextWidget(
$key: String!,
$language: String
) {
createTextWidget(
key: $key,
language: $language
) {
id
key
title
sections {
...TextWidgetSectionFragment
}
settings {
...WidgetSettingsFragment
}
language
languages
header
footer
}
}
Variables
{"key": "xyz789", "language": "de"}
Response
{
"data": {
"createTextWidget": {
"id": 4,
"key": "abc123",
"title": "abc123",
"sections": [TextWidgetSection],
"settings": WidgetSettings,
"language": "abc123",
"languages": ["abc123"],
"header": "xyz789",
"footer": "abc123"
}
}
}
createTimeSeries
Description
erzeugt eine neue Serie mit Namen und Einheit zu der dann Werte eingetragen werden können
Response
Returns a TimeSeries!
Arguments
| Name | Description |
|---|---|
input - TimeSeriesInput
|
Example
Query
mutation createTimeSeries($input: TimeSeriesInput) {
createTimeSeries(input: $input) {
id
name
appId
unit
granularity
latestEntry {
...TimeSeriesDataFragment
}
delta
metaData
roleVisibility {
...CustomEnumValueFragment
}
visible
lastModified
}
}
Variables
{"input": TimeSeriesInput}
Response
{
"data": {
"createTimeSeries": {
"id": "4",
"name": "abc123",
"appId": AppID,
"unit": "abc123",
"granularity": "abc123",
"latestEntry": TimeSeriesData,
"delta": 987.65,
"metaData": {},
"roleVisibility": [CustomEnumValue],
"visible": true,
"lastModified": "2007-12-03"
}
}
}
createUser
Description
Erstellt einen App-Administrator
Response
Returns a User
Arguments
| Name | Description |
|---|---|
request - UserInput!
|
|
sendPassword - Boolean
|
Example
Query
mutation createUser(
$request: UserInput!,
$sendPassword: Boolean
) {
createUser(
request: $request,
sendPassword: $sendPassword
) {
username
email
currentAppId
permissions
lastLogin
deviceIds
language
technicalAppUser
inactive
appIds
currentAppDivisions
managed
fullName
cnumber
invalidLoginAttemps
password
lastAppLogin
}
}
Variables
{"request": UserInput, "sendPassword": true}
Response
{
"data": {
"createUser": {
"username": "xyz789",
"email": "xyz789",
"currentAppId": AppID,
"permissions": ["MANAGE_COMPONENT"],
"lastLogin": "2007-12-03",
"deviceIds": ["abc123"],
"language": "abc123",
"technicalAppUser": true,
"inactive": false,
"appIds": ["abc123"],
"currentAppDivisions": ["xyz789"],
"managed": true,
"fullName": "abc123",
"cnumber": "abc123",
"invalidLoginAttemps": 987,
"password": "abc123",
"lastAppLogin": "2007-12-03"
}
}
}
createUserProfile
Description
Erstellen eines Benutzerprofils aus dem CMS Kontext, d.h mit erweiterten Rechten
Response
Returns a UserProfile
Arguments
| Name | Description |
|---|---|
userProfile - UserProfileInput!
|
Example
Query
mutation createUserProfile($userProfile: UserProfileInput!) {
createUserProfile(userProfile: $userProfile) {
salutation {
...CustomEnumValueFragment
}
roles {
...CustomEnumValueFragment
}
requestedRoles {
...CustomEnumValueFragment
}
departments {
...CustomEnumValueFragment
}
groups {
...GroupFragment
}
id
externalId
lastModified
created
appId
appGroup
name
firstname
email
birthday
title
imageId
imageThumbId
deviceIds
membershipNumber
agreedToAds
verificationPending
mailConfirmationPending
locked
mainProfile
familyProfileNumber
locale
country {
...CustomEnumValueFragment
}
degree
nickname
street
postcode
city
state
phone
phoneMobile
phoneMobileRequest
phoneMobileVerificationStatus
identityNumber
personnelNumber
level
sports
companyName
companyDepartment
companyFunction
university
community
maritalStatus
skills
specialization
offers
interests
bankAccountHolder
bankBIC
bankIBAN
bankName
bankSEPARef
bankSEPADate
feeKind
feeAmount
paymentMethod
entryDate
exitDate
coachingLicense
customerNumber
dataPrivacyStatementAccepted
datePrivacyStatementAccepted
dataTermsOfUseAccepted
dateTermsOfUseAccepted
statutesAccepted
chatRulesAccepted
publicProfile
remarks
members {
...UserProfileFragment
}
accountActive
chatAccount
activationCode
clubName
clubNumber
team
playerPosition
playerNumber
playerHeight
licenseNumber
realname
customFields
agreedDisplayName
agreedDisplayPhone
agreedDisplayMail
}
}
Variables
{"userProfile": UserProfileInput}
Response
{
"data": {
"createUserProfile": {
"salutation": CustomEnumValue,
"roles": [CustomEnumValue],
"requestedRoles": [CustomEnumValue],
"departments": [CustomEnumValue],
"groups": [Group],
"id": "abc123",
"externalId": "xyz789",
"lastModified": "2007-12-03",
"created": "2007-12-03",
"appId": "xyz789",
"appGroup": "abc123",
"name": "xyz789",
"firstname": "abc123",
"email": "abc123",
"birthday": "2007-12-03",
"title": "abc123",
"imageId": "abc123",
"imageThumbId": "abc123",
"deviceIds": ["xyz789"],
"membershipNumber": "xyz789",
"agreedToAds": true,
"verificationPending": true,
"mailConfirmationPending": false,
"locked": true,
"mainProfile": true,
"familyProfileNumber": "xyz789",
"locale": "abc123",
"country": CustomEnumValue,
"degree": "xyz789",
"nickname": "xyz789",
"street": "xyz789",
"postcode": "abc123",
"city": "abc123",
"state": "xyz789",
"phone": "xyz789",
"phoneMobile": "abc123",
"phoneMobileRequest": "abc123",
"phoneMobileVerificationStatus": "REQUIRED",
"identityNumber": "abc123",
"personnelNumber": "xyz789",
"level": "abc123",
"sports": "abc123",
"companyName": "abc123",
"companyDepartment": "abc123",
"companyFunction": "abc123",
"university": "xyz789",
"community": "xyz789",
"maritalStatus": "abc123",
"skills": "abc123",
"specialization": "xyz789",
"offers": "abc123",
"interests": "xyz789",
"bankAccountHolder": "xyz789",
"bankBIC": "xyz789",
"bankIBAN": "abc123",
"bankName": "xyz789",
"bankSEPARef": "abc123",
"bankSEPADate": "2007-12-03",
"feeKind": "abc123",
"feeAmount": "xyz789",
"paymentMethod": "abc123",
"entryDate": "2007-12-03",
"exitDate": "2007-12-03",
"coachingLicense": false,
"customerNumber": "xyz789",
"dataPrivacyStatementAccepted": "xyz789",
"datePrivacyStatementAccepted": "2007-12-03",
"dataTermsOfUseAccepted": "xyz789",
"dateTermsOfUseAccepted": "2007-12-03",
"statutesAccepted": true,
"chatRulesAccepted": false,
"publicProfile": false,
"remarks": "xyz789",
"members": [UserProfile],
"accountActive": true,
"chatAccount": true,
"activationCode": "xyz789",
"clubName": "abc123",
"clubNumber": "xyz789",
"team": "abc123",
"playerPosition": "abc123",
"playerNumber": "abc123",
"playerHeight": 987,
"licenseNumber": "abc123",
"realname": "xyz789",
"customFields": {},
"agreedDisplayName": true,
"agreedDisplayPhone": false,
"agreedDisplayMail": false
}
}
}
createUserProfileActivationCode
Description
Generiert ein neuen Aktivierungscode
createUserProfileFromDevice
Description
Erstellt ein Benutzerprofil von einem Gerät
Response
Returns a UserProfile
Arguments
| Name | Description |
|---|---|
userProfile - UserProfileInput!
|
Example
Query
mutation createUserProfileFromDevice($userProfile: UserProfileInput!) {
createUserProfileFromDevice(userProfile: $userProfile) {
salutation {
...CustomEnumValueFragment
}
roles {
...CustomEnumValueFragment
}
requestedRoles {
...CustomEnumValueFragment
}
departments {
...CustomEnumValueFragment
}
groups {
...GroupFragment
}
id
externalId
lastModified
created
appId
appGroup
name
firstname
email
birthday
title
imageId
imageThumbId
deviceIds
membershipNumber
agreedToAds
verificationPending
mailConfirmationPending
locked
mainProfile
familyProfileNumber
locale
country {
...CustomEnumValueFragment
}
degree
nickname
street
postcode
city
state
phone
phoneMobile
phoneMobileRequest
phoneMobileVerificationStatus
identityNumber
personnelNumber
level
sports
companyName
companyDepartment
companyFunction
university
community
maritalStatus
skills
specialization
offers
interests
bankAccountHolder
bankBIC
bankIBAN
bankName
bankSEPARef
bankSEPADate
feeKind
feeAmount
paymentMethod
entryDate
exitDate
coachingLicense
customerNumber
dataPrivacyStatementAccepted
datePrivacyStatementAccepted
dataTermsOfUseAccepted
dateTermsOfUseAccepted
statutesAccepted
chatRulesAccepted
publicProfile
remarks
members {
...UserProfileFragment
}
accountActive
chatAccount
activationCode
clubName
clubNumber
team
playerPosition
playerNumber
playerHeight
licenseNumber
realname
customFields
agreedDisplayName
agreedDisplayPhone
agreedDisplayMail
}
}
Variables
{"userProfile": UserProfileInput}
Response
{
"data": {
"createUserProfileFromDevice": {
"salutation": CustomEnumValue,
"roles": [CustomEnumValue],
"requestedRoles": [CustomEnumValue],
"departments": [CustomEnumValue],
"groups": [Group],
"id": "abc123",
"externalId": "xyz789",
"lastModified": "2007-12-03",
"created": "2007-12-03",
"appId": "abc123",
"appGroup": "xyz789",
"name": "xyz789",
"firstname": "xyz789",
"email": "xyz789",
"birthday": "2007-12-03",
"title": "xyz789",
"imageId": "xyz789",
"imageThumbId": "xyz789",
"deviceIds": ["abc123"],
"membershipNumber": "abc123",
"agreedToAds": true,
"verificationPending": false,
"mailConfirmationPending": true,
"locked": false,
"mainProfile": false,
"familyProfileNumber": "abc123",
"locale": "abc123",
"country": CustomEnumValue,
"degree": "xyz789",
"nickname": "xyz789",
"street": "abc123",
"postcode": "xyz789",
"city": "abc123",
"state": "xyz789",
"phone": "xyz789",
"phoneMobile": "abc123",
"phoneMobileRequest": "xyz789",
"phoneMobileVerificationStatus": "REQUIRED",
"identityNumber": "abc123",
"personnelNumber": "xyz789",
"level": "abc123",
"sports": "xyz789",
"companyName": "xyz789",
"companyDepartment": "abc123",
"companyFunction": "abc123",
"university": "xyz789",
"community": "xyz789",
"maritalStatus": "xyz789",
"skills": "abc123",
"specialization": "xyz789",
"offers": "xyz789",
"interests": "abc123",
"bankAccountHolder": "xyz789",
"bankBIC": "xyz789",
"bankIBAN": "xyz789",
"bankName": "xyz789",
"bankSEPARef": "xyz789",
"bankSEPADate": "2007-12-03",
"feeKind": "abc123",
"feeAmount": "abc123",
"paymentMethod": "xyz789",
"entryDate": "2007-12-03",
"exitDate": "2007-12-03",
"coachingLicense": true,
"customerNumber": "abc123",
"dataPrivacyStatementAccepted": "abc123",
"datePrivacyStatementAccepted": "2007-12-03",
"dataTermsOfUseAccepted": "abc123",
"dateTermsOfUseAccepted": "2007-12-03",
"statutesAccepted": true,
"chatRulesAccepted": true,
"publicProfile": true,
"remarks": "abc123",
"members": [UserProfile],
"accountActive": false,
"chatAccount": false,
"activationCode": "xyz789",
"clubName": "xyz789",
"clubNumber": "abc123",
"team": "abc123",
"playerPosition": "xyz789",
"playerNumber": "xyz789",
"playerHeight": 123,
"licenseNumber": "xyz789",
"realname": "abc123",
"customFields": {},
"agreedDisplayName": false,
"agreedDisplayPhone": true,
"agreedDisplayMail": true
}
}
}
createWorksheet
Description
Erstellt ein neues Worksheet
Response
Returns a Worksheet
Arguments
| Name | Description |
|---|---|
workbookId - ID!
|
|
input - WorksheetInput!
|
Example
Query
mutation createWorksheet(
$workbookId: ID!,
$input: WorksheetInput!
) {
createWorksheet(
workbookId: $workbookId,
input: $input
) {
id
name
adminRoleKeys
columns {
...WorksheetColumnMetaDataFragment
}
readAccess
writeAccess
deleteAccess
}
}
Variables
{
"workbookId": "4",
"input": WorksheetInput
}
Response
{
"data": {
"createWorksheet": {
"id": 4,
"name": "abc123",
"adminRoleKeys": ["abc123"],
"columns": [WorksheetColumnMetaData],
"readAccess": "ALWAYS_ALLOW",
"writeAccess": "ALWAYS_ALLOW",
"deleteAccess": "ALWAYS_ALLOW"
}
}
}
createWorksheetRow
Description
Erzeugt einen neuen Eintrag
Response
Returns a GenericRow
Example
Query
mutation createWorksheetRow(
$worksheetId: ID!,
$data: JSON!
) {
createWorksheetRow(
worksheetId: $worksheetId,
data: $data
) {
id
autoId
sheet
created
lastModified
user
deviceId
userProfileId
userProfile {
...UserProfileBasicDataFragment
}
data
}
}
Variables
{"worksheetId": 4, "data": {}}
Response
{
"data": {
"createWorksheetRow": {
"id": "4",
"autoId": 987,
"sheet": "abc123",
"created": "2007-12-03",
"lastModified": "2007-12-03",
"user": "xyz789",
"deviceId": "abc123",
"userProfileId": "xyz789",
"userProfile": UserProfileBasicData,
"data": {}
}
}
}
createWorkspaceContentWithText
Description
Erzeugt eine neue HTML Seite mit gegebenem Inhalt.
Response
Returns an WSTextContent
Arguments
| Name | Description |
|---|---|
parent - WSFileId!
|
|
filename - String!
|
|
text - String!
|
|
fileType - WSFileType!
|
Example
Query
mutation createWorkspaceContentWithText(
$parent: WSFileId!,
$filename: String!,
$text: String!,
$fileType: WSFileType!
) {
createWorkspaceContentWithText(
parent: $parent,
filename: $filename,
text: $text,
fileType: $fileType
) {
... on WSCss {
...WSCssFragment
}
... on WSJavaScript {
...WSJavaScriptFragment
}
... on WSPage {
...WSPageFragment
}
... on WSJson {
...WSJsonFragment
}
... on WSDynamicPage {
...WSDynamicPageFragment
}
... on WSMailTemplate {
...WSMailTemplateFragment
}
}
}
Variables
{
"parent": WSFileId,
"filename": "xyz789",
"text": "xyz789",
"fileType": "ROOT"
}
Response
{"data": {"createWorkspaceContentWithText": WSCss}}
createWorkspaceFileWithUpload
Description
Erzeugt ein neues File per Upload.
Response
Returns an WSBinary
Example
Query
mutation createWorkspaceFileWithUpload(
$parent: WSFileId!,
$file: UploadId!,
$contentType: String
) {
createWorkspaceFileWithUpload(
parent: $parent,
file: $file,
contentType: $contentType
) {
id
workspaceId
type
key
readonly
name
lastModified
lastModifiedBy
description
size
contentType
url
signedURL
parentId
}
}
Variables
{
"parent": WSFileId,
"file": UploadId,
"contentType": "abc123"
}
Response
{
"data": {
"createWorkspaceFileWithUpload": {
"id": WSFileId,
"workspaceId": WSFileId,
"type": "ROOT",
"key": "xyz789",
"readonly": true,
"name": "xyz789",
"lastModified": "2007-12-03",
"lastModifiedBy": "abc123",
"description": "abc123",
"size": 123,
"contentType": "xyz789",
"url": "xyz789",
"signedURL": Url,
"parentId": "xyz789"
}
}
}
createWorkspaceFolder
Description
Erzeugt ein Verzeichnis.
Example
Query
mutation createWorkspaceFolder(
$parent: WSFileId!,
$filename: String!
) {
createWorkspaceFolder(
parent: $parent,
filename: $filename
) {
id
workspaceId
type
key
readonly
name
lastModified
lastModifiedBy
description
size
children
parentId
}
}
Variables
{
"parent": WSFileId,
"filename": "xyz789"
}
Response
{
"data": {
"createWorkspaceFolder": {
"id": WSFileId,
"workspaceId": WSFileId,
"type": "ROOT",
"key": "abc123",
"readonly": true,
"name": "xyz789",
"lastModified": "2007-12-03",
"lastModifiedBy": "abc123",
"description": "abc123",
"size": 987,
"children": 987,
"parentId": "abc123"
}
}
}
createWorkspaceLink
Description
Erzeugt eine neuen Seitenverweis.
Response
Returns an WSLink
Example
Query
mutation createWorkspaceLink(
$parent: WSFileId!,
$url: String!,
$name: String!
) {
createWorkspaceLink(
parent: $parent,
url: $url,
name: $name
) {
id
workspaceId
type
key
readonly
name
lastModified
lastModifiedBy
description
size
contentType
url
parentId
}
}
Variables
{
"parent": WSFileId,
"url": "abc123",
"name": "abc123"
}
Response
{
"data": {
"createWorkspaceLink": {
"id": WSFileId,
"workspaceId": WSFileId,
"type": "ROOT",
"key": "abc123",
"readonly": true,
"name": "xyz789",
"lastModified": "2007-12-03",
"lastModifiedBy": "abc123",
"description": "xyz789",
"size": 123,
"contentType": "xyz789",
"url": "xyz789",
"parentId": "xyz789"
}
}
}
deleteAdminUser
Description
Löscht einen Administrator (INTERNAL)
deleteCalendar
Description
Löscht einen Kalender und alle Ereingnisse darin.
deleteCalendarEvent
Description
löscht das Ereignis aus dem Kalender, sofern der Benutzer Zugriff auf dieses Ereignis hat. Es wird je nach scope nur das Ereignis gelöscht oder zusätzlich alle nachfolgenden bzw. alle der gleichen Serie.
Response
Returns an Int
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
scope - ModificationScope!
|
Example
Query
mutation deleteCalendarEvent(
$id: ID!,
$scope: ModificationScope!
) {
deleteCalendarEvent(
id: $id,
scope: $scope
)
}
Variables
{"id": "4", "scope": "SELECTED"}
Response
{"data": {"deleteCalendarEvent": 987}}
deleteCalendarEventCategory
Description
löscht eine Kategorie aus dem zugehörigen Kalender, sofern diese Kategorie nicht verwendet wird
Example
Query
mutation deleteCalendarEventCategory(
$calendarId: ID!,
$categoryId: ID!
) {
deleteCalendarEventCategory(
calendarId: $calendarId,
categoryId: $categoryId
) {
id
appId
componentIds
title
color
description
readerRoles {
...CustomEnumValueFragment
}
writerRoles {
...CustomEnumValueFragment
}
readerGroupIds
readerGroups {
...GroupFragment
}
writerGroupIds
writerGroups {
...GroupFragment
}
ownedByGroupId
categories {
...CalendarEventCategoryFragment
}
iCalUrl
iCalLastSynced
canRead
canWrite
hints
}
}
Variables
{"calendarId": 4, "categoryId": 4}
Response
{
"data": {
"deleteCalendarEventCategory": {
"id": "4",
"appId": AppID,
"componentIds": ["4"],
"title": "xyz789",
"color": Color,
"description": "xyz789",
"readerRoles": [CustomEnumValue],
"writerRoles": [CustomEnumValue],
"readerGroupIds": ["xyz789"],
"readerGroups": [Group],
"writerGroupIds": ["abc123"],
"writerGroups": [Group],
"ownedByGroupId": "abc123",
"categories": [CalendarEventCategory],
"iCalUrl": Url,
"iCalLastSynced": "2007-12-03",
"canRead": true,
"canWrite": true,
"hints": ["xyz789"]
}
}
}
deleteCalendarRegistrationForm
Description
Löscht ein Formular
deleteCouponsBySpecificationId
Description
Löscht die Gutschein Vorlage und zugehörigen Instanzen.
Example
Query
mutation deleteCouponsBySpecificationId($couponSpecificationId: ID!) {
deleteCouponsBySpecificationId(couponSpecificationId: $couponSpecificationId)
}
Variables
{"couponSpecificationId": "4"}
Response
{"data": {"deleteCouponsBySpecificationId": 123}}
deleteCustomEnumValue
Description
Löscht ein Key von einem Enum
Response
Returns a CustomEnum
Example
Query
mutation deleteCustomEnumValue(
$enumId: ID!,
$enumKey: ID!
) {
deleteCustomEnumValue(
enumId: $enumId,
enumKey: $enumKey
) {
id
keys
locales
translations {
...EnumTranslationFragment
}
}
}
Variables
{"enumId": 4, "enumKey": "4"}
Response
{
"data": {
"deleteCustomEnumValue": {
"id": 4,
"keys": ["abc123"],
"locales": ["abc123"],
"translations": [EnumTranslation]
}
}
}
deleteFileStoreFiles
Description
Löscht eine Datei oder ein Verzeichnis. Dieses Funktion löscht rekursiv!
Response
Returns an Int
Arguments
| Name | Description |
|---|---|
storeId - FSId
|
|
files - [FSFileId]!
|
Example
Query
mutation deleteFileStoreFiles(
$storeId: FSId,
$files: [FSFileId]!
) {
deleteFileStoreFiles(
storeId: $storeId,
files: $files
)
}
Variables
{
"storeId": FSId,
"files": [FSFileId]
}
Response
{"data": {"deleteFileStoreFiles": 123}}
deleteGroup
Description
Löschen eine Gruppe
Example
Query
mutation deleteGroup($id: ID!) {
deleteGroup(id: $id) {
id
appId
name
memberIds
members {
...UserProfileBasicDataFragment
}
leaderIds
leaders {
...UserProfileBasicDataFragment
}
roles
system
numberOfMembers
description
publicGroup
listedGroup
icon {
...ResourceFragment
}
iconId
leader
groupSpaceEnabled
}
}
Variables
{"id": 4}
Response
{
"data": {
"deleteGroup": {
"id": "4",
"appId": AppID,
"name": "xyz789",
"memberIds": ["abc123"],
"members": [UserProfileBasicData],
"leaderIds": ["xyz789"],
"leaders": [UserProfileBasicData],
"roles": ["abc123"],
"system": true,
"numberOfMembers": 123,
"description": "xyz789",
"publicGroup": true,
"listedGroup": false,
"icon": Resource,
"iconId": "abc123",
"leader": true,
"groupSpaceEnabled": true
}
}
}
deleteGroupMember
Description
Entfernt ein Mitglied aus einer Gruppe
Example
Query
mutation deleteGroupMember(
$id: ID!,
$profile: ID!
) {
deleteGroupMember(
id: $id,
profile: $profile
) {
id
appId
name
memberIds
members {
...UserProfileBasicDataFragment
}
leaderIds
leaders {
...UserProfileBasicDataFragment
}
roles
system
numberOfMembers
description
publicGroup
listedGroup
icon {
...ResourceFragment
}
iconId
leader
groupSpaceEnabled
}
}
Variables
{"id": 4, "profile": 4}
Response
{
"data": {
"deleteGroupMember": {
"id": "4",
"appId": AppID,
"name": "xyz789",
"memberIds": ["xyz789"],
"members": [UserProfileBasicData],
"leaderIds": ["abc123"],
"leaders": [UserProfileBasicData],
"roles": ["abc123"],
"system": true,
"numberOfMembers": 123,
"description": "abc123",
"publicGroup": false,
"listedGroup": false,
"icon": Resource,
"iconId": "xyz789",
"leader": false,
"groupSpaceEnabled": true
}
}
}
deleteLinkInGroupSpace
Description
Löscht einen Link innerhalb eines Gruppenraums. Aktuell werden nur externe Links unterstützt.
Example
Query
mutation deleteLinkInGroupSpace(
$spaceId: ID!,
$linkId: ID!
) {
deleteLinkInGroupSpace(
spaceId: $spaceId,
linkId: $linkId
)
}
Variables
{
"spaceId": "4",
"linkId": "4"
}
Response
{"data": {"deleteLinkInGroupSpace": false}}
deleteListEntries
Description
Löschen mehrerer Einträge
Example
Query
mutation deleteListEntries(
$ids: [ID],
$componentId: ID!
) {
deleteListEntries(
ids: $ids,
componentId: $componentId
)
}
Variables
{"ids": [4], "componentId": "4"}
Response
{"data": {"deleteListEntries": 123}}
deleteLocation
Description
delete location
deleteProduct
Description
Löscht ein Produkt
deleteProject
Description
Achtung: Löscht das komplette Project mit allen Inhalten
deleteProjectStructureNode
Description
Löscht eine Strukturknoten aus dem Projekt
deletePushChannel
Description
löscht ein Kanal aus dem System
deletePushNotification
Description
löscht eine Nachricht aus dem System
deleteResource
Description
löscht eine Resource
Example
Query
mutation deleteResource($id: ID!) {
deleteResource(id: $id) {
id
url
notes
previewImageUrl
creationDate
lastModificationDate
mimeType
title
creator
resourceCategoryId
resourceCategory {
...ResourceCategoryFragment
}
width
height
contentLength
status
deviceId
user_comment
user_title
user_contact
user_category
lat
lng
}
}
Variables
{"id": 4}
Response
{
"data": {
"deleteResource": {
"id": "4",
"url": "abc123",
"notes": "abc123",
"previewImageUrl": "xyz789",
"creationDate": "2007-12-03",
"lastModificationDate": "2007-12-03",
"mimeType": "abc123",
"title": "abc123",
"creator": "abc123",
"resourceCategoryId": "xyz789",
"resourceCategory": ResourceCategory,
"width": 987,
"height": 987,
"contentLength": 123,
"status": "pending",
"deviceId": "xyz789",
"user_comment": "xyz789",
"user_title": "abc123",
"user_contact": "abc123",
"user_category": "abc123",
"lat": "xyz789",
"lng": "abc123"
}
}
}
deleteResourceCategory
Description
Löscht die Kategorie aus dem System. Alle Verweise auf die Kategorie werden zurücksetzt.
Response
Returns a ResourceCategory
Arguments
| Name | Description |
|---|---|
id - ID!
|
Example
Query
mutation deleteResourceCategory($id: ID!) {
deleteResourceCategory(id: $id) {
id
name
scope
color
lastModificationDate
}
}
Variables
{"id": 4}
Response
{
"data": {
"deleteResourceCategory": {
"id": 4,
"name": "xyz789",
"scope": "xyz789",
"color": "xyz789",
"lastModificationDate": "2007-12-03"
}
}
}
deleteResources
Description
löscht mehrere Resourcen
Response
Returns [Resource]
Arguments
| Name | Description |
|---|---|
ids - [ID]!
|
Example
Query
mutation deleteResources($ids: [ID]!) {
deleteResources(ids: $ids) {
id
url
notes
previewImageUrl
creationDate
lastModificationDate
mimeType
title
creator
resourceCategoryId
resourceCategory {
...ResourceCategoryFragment
}
width
height
contentLength
status
deviceId
user_comment
user_title
user_contact
user_category
lat
lng
}
}
Variables
{"ids": ["4"]}
Response
{
"data": {
"deleteResources": [
{
"id": "4",
"url": "xyz789",
"notes": "abc123",
"previewImageUrl": "abc123",
"creationDate": "2007-12-03",
"lastModificationDate": "2007-12-03",
"mimeType": "xyz789",
"title": "abc123",
"creator": "abc123",
"resourceCategoryId": "xyz789",
"resourceCategory": ResourceCategory,
"width": 987,
"height": 987,
"contentLength": 987,
"status": "pending",
"deviceId": "abc123",
"user_comment": "abc123",
"user_title": "abc123",
"user_contact": "xyz789",
"user_category": "xyz789",
"lat": "xyz789",
"lng": "xyz789"
}
]
}
}
deleteStructureNodeCategory
Description
Löscht eine Kategorie
deleteTimeSeries
Description
löscht die Serie und alle Werte
deleteUser
Description
Löscht einen App-Administrator
deleteUserProfile
Description
Löscht ein Benutzerprofil
deleteUserProfileImage
Description
Löscht das aktuelle Benutzerprofilbild
deleteWorksheet
Description
Deletes the worksheet
Example
Query
mutation deleteWorksheet(
$workbookId: ID!,
$worksheetId: ID!
) {
deleteWorksheet(
workbookId: $workbookId,
worksheetId: $worksheetId
)
}
Variables
{
"workbookId": "4",
"worksheetId": "4"
}
Response
{"data": {"deleteWorksheet": 123}}
deleteWorksheetRows
Description
Löscht mehrere Einträge
Example
Query
mutation deleteWorksheetRows(
$worksheetId: ID!,
$ids: [ID]!
) {
deleteWorksheetRows(
worksheetId: $worksheetId,
ids: $ids
)
}
Variables
{
"worksheetId": "4",
"ids": ["4"]
}
Response
{"data": {"deleteWorksheetRows": 123}}
deleteWorkspaceFile
Description
Löscht ein File und ggfs. alle untergeordneten Verzeichnisse!
demoteToGroupMember
Description
Degradiert ein Gruppenleiter zu einem Mitglied
Example
Query
mutation demoteToGroupMember(
$id: ID!,
$profile: ID!
) {
demoteToGroupMember(
id: $id,
profile: $profile
) {
id
appId
name
memberIds
members {
...UserProfileBasicDataFragment
}
leaderIds
leaders {
...UserProfileBasicDataFragment
}
roles
system
numberOfMembers
description
publicGroup
listedGroup
icon {
...ResourceFragment
}
iconId
leader
groupSpaceEnabled
}
}
Variables
{
"id": "4",
"profile": "4"
}
Response
{
"data": {
"demoteToGroupMember": {
"id": 4,
"appId": AppID,
"name": "xyz789",
"memberIds": ["abc123"],
"members": [UserProfileBasicData],
"leaderIds": ["xyz789"],
"leaders": [UserProfileBasicData],
"roles": ["xyz789"],
"system": false,
"numberOfMembers": 123,
"description": "abc123",
"publicGroup": true,
"listedGroup": true,
"icon": Resource,
"iconId": "abc123",
"leader": true,
"groupSpaceEnabled": false
}
}
}
dequeueCalendarEventRegistration
Description
Nimmt eine Registration aus der Warteschlange und fügt Sie als Teilnehmer ein.
Response
Returns a CalendarEvent
Arguments
| Name | Description |
|---|---|
registrationId - ID!
|
Example
Query
mutation dequeueCalendarEventRegistration($registrationId: ID!) {
dequeueCalendarEventRegistration(registrationId: $registrationId) {
id
calendarId
seriesId
title
subTitle
description
timeZoneId
timeZoneOffset
dateStart
dateTimeStart
localDateTimeStart
dateEnd
dateTimeEnd
localDateTimeEnd
categories {
...CalendarEventCategoryFragment
}
registrationRequired
publicRegistrationAllowed
allDay
maxSignUps
minSignUps
multiSignUpAllowed
memberListVisibility
maxAdditionalSignUps
registrationCount
deadlineStartOffsetMinutes
startOfRegistrationOffsetMinutes
cancelRegistrationDeadlineOffsetMinutes
requestCount
iconImage {
...MediaReferenceFragment
}
resources {
...MediaReferenceFragment
}
location {
...LocationFragment
}
detailLink
seats
ownRegistrations {
...CalendarEventRegistrationFragment
}
ownerId
owner {
...UserProfileFragment
}
contactId
contact {
...UserProfileFragment
}
contactGroupId
contactGroup {
...GroupFragment
}
canWrite
onlineConference
notifyEventContactPersonOnSignUp
issueTicketsUponRegistration
manageAttendees
reminder {
...CalendarEventReminderFragment
}
paymentDocumentation
registrationFormId
registrationForm {
...CalendarRegistrationFormFragment
}
products {
...ProductDefinitionFragment
}
waitingListEnabled
badgeEnabled
lastModificationDate
}
}
Variables
{"registrationId": 4}
Response
{
"data": {
"dequeueCalendarEventRegistration": {
"id": 4,
"calendarId": "4",
"seriesId": "4",
"title": "abc123",
"subTitle": "abc123",
"description": "xyz789",
"timeZoneId": "abc123",
"timeZoneOffset": "abc123",
"dateStart": "2007-12-03",
"dateTimeStart": "xyz789",
"localDateTimeStart": "2020-07-19T08:45:59",
"dateEnd": "2007-12-03",
"dateTimeEnd": "abc123",
"localDateTimeEnd": "2020-07-19T08:45:59",
"categories": [CalendarEventCategory],
"registrationRequired": false,
"publicRegistrationAllowed": false,
"allDay": false,
"maxSignUps": 987,
"minSignUps": 123,
"multiSignUpAllowed": false,
"memberListVisibility": "ADMIN",
"maxAdditionalSignUps": 123,
"registrationCount": 987,
"deadlineStartOffsetMinutes": 123,
"startOfRegistrationOffsetMinutes": 123,
"cancelRegistrationDeadlineOffsetMinutes": 987,
"requestCount": 123,
"iconImage": MediaReference,
"resources": [MediaReference],
"location": Location,
"detailLink": "xyz789",
"seats": ["xyz789"],
"ownRegistrations": [CalendarEventRegistration],
"ownerId": "xyz789",
"owner": UserProfile,
"contactId": "xyz789",
"contact": UserProfile,
"contactGroupId": 4,
"contactGroup": Group,
"canWrite": true,
"onlineConference": false,
"notifyEventContactPersonOnSignUp": true,
"issueTicketsUponRegistration": true,
"manageAttendees": false,
"reminder": CalendarEventReminder,
"paymentDocumentation": true,
"registrationFormId": 4,
"registrationForm": CalendarRegistrationForm,
"products": [ProductDefinition],
"waitingListEnabled": true,
"badgeEnabled": false,
"lastModificationDate": "2007-12-03"
}
}
}
dispatchCoupon
Description
Gibt den Gutschein gemäß dem Ausgabemodus aus. Über den zurückgegebenen Handle kann der Fortschritt dann periodisch abgefragt werden. Optional kann eine Push Nachricht gesendet werden. Optional eine Menge von IDs, die entweder ein Rollen-Key oder Gruppen-ID sind
Response
Returns an ID!
Arguments
| Name | Description |
|---|---|
couponId - ID!
|
|
mode - DispatchMode!
|
|
message - String
|
|
targets - [String]
|
Example
Query
mutation dispatchCoupon(
$couponId: ID!,
$mode: DispatchMode!,
$message: String,
$targets: [String]
) {
dispatchCoupon(
couponId: $couponId,
mode: $mode,
message: $message,
targets: $targets
)
}
Variables
{
"couponId": 4,
"mode": "adminDevices",
"message": "xyz789",
"targets": ["abc123"]
}
Response
{"data": {"dispatchCoupon": "4"}}
duplicateWorksheetRow
Description
Dupliziert eine bestehende Row
Response
Returns a GenericRow
Example
Query
mutation duplicateWorksheetRow(
$worksheetId: ID!,
$id: ID!
) {
duplicateWorksheetRow(
worksheetId: $worksheetId,
id: $id
) {
id
autoId
sheet
created
lastModified
user
deviceId
userProfileId
userProfile {
...UserProfileBasicDataFragment
}
data
}
}
Variables
{"worksheetId": 4, "id": "4"}
Response
{
"data": {
"duplicateWorksheetRow": {
"id": "4",
"autoId": 123,
"sheet": "xyz789",
"created": "2007-12-03",
"lastModified": "2007-12-03",
"user": "abc123",
"deviceId": "abc123",
"userProfileId": "xyz789",
"userProfile": UserProfileBasicData,
"data": {}
}
}
}
duplicateWorkspaceFile
Description
Dupliziert ein File innerhalb des gleichen Verzeichnisses
Example
Query
mutation duplicateWorkspaceFile($file: WSFileId!) {
duplicateWorkspaceFile(file: $file) {
id
workspaceId
type
key
readonly
name
lastModified
lastModifiedBy
description
size
parentId
}
}
Variables
{"file": WSFileId}
Response
{
"data": {
"duplicateWorkspaceFile": {
"id": WSFileId,
"workspaceId": WSFileId,
"type": "ROOT",
"key": "abc123",
"readonly": false,
"name": "xyz789",
"lastModified": "2007-12-03",
"lastModifiedBy": "xyz789",
"description": "xyz789",
"size": 123,
"parentId": "abc123"
}
}
}
endPhoneNumberVerification
Description
Verifiziert ein Nummernwechsel. Gibt die verifizierte Telefonnummer zurück
enforceCalendarEventRegistration
Description
Spezielle Version der "requestCalendarEventRegistration" für Administratoren, wobei verschiedene Prüfungen auf Teilnehmerbegrenzung und Zeitpunkt ausser Kraft gesetzt werden.
Response
Returns [CalendarEventRegistration]!
Arguments
| Name | Description |
|---|---|
request - CalendarEventRegistrationRequest
|
Example
Query
mutation enforceCalendarEventRegistration($request: CalendarEventRegistrationRequest) {
enforceCalendarEventRegistration(request: $request) {
id
creationDate
calendarEventId
seat {
...SeatFragment
}
comment
deviceId
clientId
client {
...UserProfileBasicDataFragment
}
status
waitingPosition
payed
formData
}
}
Variables
{"request": CalendarEventRegistrationRequest}
Response
{
"data": {
"enforceCalendarEventRegistration": [
{
"id": "4",
"creationDate": "2007-12-03",
"calendarEventId": "4",
"seat": Seat,
"comment": "xyz789",
"deviceId": "abc123",
"clientId": "abc123",
"client": UserProfileBasicData,
"status": "xyz789",
"waitingPosition": 987,
"payed": true,
"formData": {}
}
]
}
}
ensureDirectCommunicationExists
Description
Stellt sicher, dass es eine Direktkommunikation zwischen den Teilnehmern gibt
Response
Returns a ChatChannel
Arguments
| Name | Description |
|---|---|
targetProfileId - ID!
|
Example
Query
mutation ensureDirectCommunicationExists($targetProfileId: ID!) {
ensureDirectCommunicationExists(targetProfileId: $targetProfileId) {
id
active
componentId
icon {
...ResourceFragment
}
iconId
iconUrl
backgroundImageId
backgroundImage {
...ResourceFragment
}
backgroundImageUrl
backgroundColor
label
pinCode
readOnly
allowPseudonyms
visibleByProfileRoles
visibleByDepartments
autoSubscribedRoles
autoSubscribedGroups
subscriptionsCount
directAdminProfilesIds
directAdminProfiles {
...UserProfileFragment
}
adminGroupId
adminGroup {
...GroupFragment
}
}
}
Variables
{"targetProfileId": "4"}
Response
{
"data": {
"ensureDirectCommunicationExists": {
"id": 4,
"active": false,
"componentId": "xyz789",
"icon": Resource,
"iconId": 4,
"iconUrl": "xyz789",
"backgroundImageId": "4",
"backgroundImage": Resource,
"backgroundImageUrl": "abc123",
"backgroundColor": "xyz789",
"label": "xyz789",
"pinCode": "abc123",
"readOnly": false,
"allowPseudonyms": false,
"visibleByProfileRoles": ["abc123"],
"visibleByDepartments": ["abc123"],
"autoSubscribedRoles": ["abc123"],
"autoSubscribedGroups": ["abc123"],
"subscriptionsCount": {},
"directAdminProfilesIds": ["abc123"],
"directAdminProfiles": [UserProfile],
"adminGroupId": 4,
"adminGroup": Group
}
}
}
exportUserProfiles
Description
exportiert die Liste aller App Nutzer, die den gegebenen Filter-Kriterien entsprechen in eine Datei des gewünschten Formats
Response
Returns an UploadId
Arguments
| Name | Description |
|---|---|
filter - String
|
Default = "" |
format - UserProfileExportFormat
|
|
search - String
|
Default = "" |
sort - Sort
|
Example
Query
mutation exportUserProfiles(
$filter: String,
$format: UserProfileExportFormat,
$search: String,
$sort: Sort
) {
exportUserProfiles(
filter: $filter,
format: $format,
search: $search,
sort: $sort
)
}
Variables
{
"filter": "",
"format": "HTML",
"search": "",
"sort": Sort
}
Response
{"data": {"exportUserProfiles": UploadId}}
exportWorksheet
Description
exportiert alle Daten des Arbeitsblattes in eine Excel-Datei
Response
Returns an UploadId
Arguments
| Name | Description |
|---|---|
filter - WorksheetQuery!
|
Example
Query
mutation exportWorksheet($filter: WorksheetQuery!) {
exportWorksheet(filter: $filter)
}
Variables
{"filter": WorksheetQuery}
Response
{"data": {"exportWorksheet": UploadId}}
externalOpenIdConnectAuthenticated
Description
Überprüft das Token mit dem externen Identitätsdienst und synchronisiert die Daten
Response
Returns a ProfileValidationStatus
Example
Query
mutation externalOpenIdConnectAuthenticated(
$accessToken: String!,
$refreshToken: String!
) {
externalOpenIdConnectAuthenticated(
accessToken: $accessToken,
refreshToken: $refreshToken
) {
emailVerificationPending
roleVerificationPending
phoneVerificationPending
valid
}
}
Variables
{
"accessToken": "xyz789",
"refreshToken": "abc123"
}
Response
{
"data": {
"externalOpenIdConnectAuthenticated": {
"emailVerificationPending": false,
"roleVerificationPending": false,
"phoneVerificationPending": false,
"valid": false
}
}
}
fileStoreMoveFiles
Description
Verschiebt die Dateien und verzeichnisse in der Struktur
Response
Returns [FSFile]
Arguments
| Name | Description |
|---|---|
storeId - FSId
|
|
files - [FSFileId]!
|
|
newParent - FSFileId
|
Example
Query
mutation fileStoreMoveFiles(
$storeId: FSId,
$files: [FSFileId]!,
$newParent: FSFileId
) {
fileStoreMoveFiles(
storeId: $storeId,
files: $files,
newParent: $newParent
) {
fsId
id
parentId
contentType
name
contentLength
directory
status
created
createdBy
lastModified
lastModifiedBy
eTag
uploadUrl
downloadUrl
thumbnailImageUrl
}
}
Variables
{
"storeId": FSId,
"files": [FSFileId],
"newParent": FSFileId
}
Response
{
"data": {
"fileStoreMoveFiles": [
{
"fsId": FSId,
"id": FSFileId,
"parentId": FSFileId,
"contentType": "abc123",
"name": "abc123",
"contentLength": {},
"directory": true,
"status": "READY",
"created": "2007-12-03",
"createdBy": "xyz789",
"lastModified": "2007-12-03",
"lastModifiedBy": "xyz789",
"eTag": "xyz789",
"uploadUrl": Url,
"downloadUrl": Url,
"thumbnailImageUrl": Url
}
]
}
}
fileStoreUploadComplete
Description
Der Upload wurde abgeschlossen. Post-Prozesse werden gestartet
Example
Query
mutation fileStoreUploadComplete(
$storeId: FSId,
$file: FSFileId!
) {
fileStoreUploadComplete(
storeId: $storeId,
file: $file
) {
fsId
id
parentId
contentType
name
contentLength
directory
status
created
createdBy
lastModified
lastModifiedBy
eTag
uploadUrl
downloadUrl
thumbnailImageUrl
}
}
Variables
{"storeId": FSId, "file": FSFileId}
Response
{
"data": {
"fileStoreUploadComplete": {
"fsId": FSId,
"id": FSFileId,
"parentId": FSFileId,
"contentType": "xyz789",
"name": "abc123",
"contentLength": {},
"directory": false,
"status": "READY",
"created": "2007-12-03",
"createdBy": "abc123",
"lastModified": "2007-12-03",
"lastModifiedBy": "xyz789",
"eTag": "abc123",
"uploadUrl": Url,
"downloadUrl": Url,
"thumbnailImageUrl": Url
}
}
}
generateAPIToken
Description
Genertiert ein Api Token, falls dies für den User aktiviert ist
Response
Returns a String
Example
Query
mutation generateAPIToken {
generateAPIToken
}
Response
{"data": {"generateAPIToken": "abc123"}}
importCalendarExcelFile
Description
Importiert die Kalenderdaten aus einer XLSX Datei im die aus dem ehemaligen Terminmodul exportiert wurde. Die Daten werden zu dem gegebenen Kalender hinzugefügt.
Example
Query
mutation importCalendarExcelFile(
$calendarId: ID!,
$file: UploadId!
) {
importCalendarExcelFile(
calendarId: $calendarId,
file: $file
)
}
Variables
{
"calendarId": "4",
"file": UploadId
}
Response
{"data": {"importCalendarExcelFile": 123}}
importICSFile
Description
Importiert die Kalenderdaten aus einer ICS Datei im iCal Format in den bestehenden Kalender.
Example
Query
mutation importICSFile(
$calendarId: ID!,
$file: UploadId!
) {
importICSFile(
calendarId: $calendarId,
file: $file
)
}
Variables
{"calendarId": 4, "file": UploadId}
Response
{"data": {"importICSFile": 987}}
importScheduledPushNotificationsExcel
Description
importiert eine Excel Liste mit geplanten PushNachrichten, welche zu dem gegebenen Zeitpunkt versendet werden sollen.
Example
Query
mutation importScheduledPushNotificationsExcel($excelFile: UploadId!) {
importScheduledPushNotificationsExcel(excelFile: $excelFile)
}
Variables
{"excelFile": UploadId}
Response
{"data": {"importScheduledPushNotificationsExcel": 987}}
importUserProfiles
Description
Importiert das Benutzerprofil von einer Excel-Datei. Als Ergebnis wird der Log-Output geliefert.
Response
Returns a String
Arguments
| Name | Description |
|---|---|
file - UploadId!
|
|
settings - UserProfileExcelImportSettings!
|
Example
Query
mutation importUserProfiles(
$file: UploadId!,
$settings: UserProfileExcelImportSettings!
) {
importUserProfiles(
file: $file,
settings: $settings
)
}
Variables
{
"file": UploadId,
"settings": UserProfileExcelImportSettings
}
Response
{"data": {"importUserProfiles": "abc123"}}
importWorksheet
Description
importiert die Daten in das gegebene Arbeitsblatt. Wenn clear gesetzt, dann werden vorhandene Daten gelöscht, andernfalls werden die Daten angehängt. Als Ergebnis wird die Anzahl der importieren Zeilen geliefert.
Response
Returns an Int
Example
Query
mutation importWorksheet(
$worksheetId: ID!,
$file: UploadId!,
$clear: Boolean!
) {
importWorksheet(
worksheetId: $worksheetId,
file: $file,
clear: $clear
)
}
Variables
{"worksheetId": 4, "file": UploadId, "clear": true}
Response
{"data": {"importWorksheet": 123}}
inviteToGroup
Description
Lädt eine Person zu der Gruppe ein
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
request - GroupAccessInvitationRequestInput!
|
Example
Query
mutation inviteToGroup($request: GroupAccessInvitationRequestInput!) {
inviteToGroup(request: $request)
}
Variables
{"request": GroupAccessInvitationRequestInput}
Response
{"data": {"inviteToGroup": true}}
migrateLegacyCalendarWorkbook
Description
Migration auf Bais einer gegebenen Workbook Id
Example
Query
mutation migrateLegacyCalendarWorkbook($workbookId: String!) {
migrateLegacyCalendarWorkbook(workbookId: $workbookId) {
id
appId
componentIds
title
color
description
readerRoles {
...CustomEnumValueFragment
}
writerRoles {
...CustomEnumValueFragment
}
readerGroupIds
readerGroups {
...GroupFragment
}
writerGroupIds
writerGroups {
...GroupFragment
}
ownedByGroupId
categories {
...CalendarEventCategoryFragment
}
iCalUrl
iCalLastSynced
canRead
canWrite
hints
}
}
Variables
{"workbookId": "abc123"}
Response
{
"data": {
"migrateLegacyCalendarWorkbook": {
"id": "4",
"appId": AppID,
"componentIds": [4],
"title": "xyz789",
"color": Color,
"description": "xyz789",
"readerRoles": [CustomEnumValue],
"writerRoles": [CustomEnumValue],
"readerGroupIds": ["abc123"],
"readerGroups": [Group],
"writerGroupIds": ["xyz789"],
"writerGroups": [Group],
"ownedByGroupId": "abc123",
"categories": [CalendarEventCategory],
"iCalUrl": Url,
"iCalLastSynced": "2007-12-03",
"canRead": true,
"canWrite": true,
"hints": ["abc123"]
}
}
}
moveWorkspaceFile
Description
Verschiebt eine Datei / Verzeichnis in der Struktur
Example
Query
mutation moveWorkspaceFile(
$file: WSFileId!,
$newParent: WSFileId!
) {
moveWorkspaceFile(
file: $file,
newParent: $newParent
) {
id
workspaceId
type
key
readonly
name
lastModified
lastModifiedBy
description
size
parentId
}
}
Variables
{
"file": WSFileId,
"newParent": WSFileId
}
Response
{
"data": {
"moveWorkspaceFile": {
"id": WSFileId,
"workspaceId": WSFileId,
"type": "ROOT",
"key": "xyz789",
"readonly": true,
"name": "xyz789",
"lastModified": "2007-12-03",
"lastModifiedBy": "xyz789",
"description": "xyz789",
"size": 123,
"parentId": "xyz789"
}
}
}
promoteToGroupLeader
Description
Befördert ein Mitglied zu einem Gruppenleiter
Example
Query
mutation promoteToGroupLeader(
$id: ID!,
$profile: ID!
) {
promoteToGroupLeader(
id: $id,
profile: $profile
) {
id
appId
name
memberIds
members {
...UserProfileBasicDataFragment
}
leaderIds
leaders {
...UserProfileBasicDataFragment
}
roles
system
numberOfMembers
description
publicGroup
listedGroup
icon {
...ResourceFragment
}
iconId
leader
groupSpaceEnabled
}
}
Variables
{"id": 4, "profile": "4"}
Response
{
"data": {
"promoteToGroupLeader": {
"id": "4",
"appId": AppID,
"name": "xyz789",
"memberIds": ["xyz789"],
"members": [UserProfileBasicData],
"leaderIds": ["abc123"],
"leaders": [UserProfileBasicData],
"roles": ["abc123"],
"system": true,
"numberOfMembers": 987,
"description": "abc123",
"publicGroup": false,
"listedGroup": false,
"icon": Resource,
"iconId": "xyz789",
"leader": false,
"groupSpaceEnabled": true
}
}
}
refreshCalendarFromICal
Description
Sofern der Kalender mit einer iCal Datenquelle verbunden ist, werden die Daten von dort neu geladen und unsere lokale Kopie entsprechend aktualisiert. Dies kann entweder über einen expliziten Refresh (Button in der UI) oder periodisch per Hintergrundprozess erfolgen.
Example
Query
mutation refreshCalendarFromICal($calendarId: ID!) {
refreshCalendarFromICal(calendarId: $calendarId) {
id
appId
componentIds
title
color
description
readerRoles {
...CustomEnumValueFragment
}
writerRoles {
...CustomEnumValueFragment
}
readerGroupIds
readerGroups {
...GroupFragment
}
writerGroupIds
writerGroups {
...GroupFragment
}
ownedByGroupId
categories {
...CalendarEventCategoryFragment
}
iCalUrl
iCalLastSynced
canRead
canWrite
hints
}
}
Variables
{"calendarId": 4}
Response
{
"data": {
"refreshCalendarFromICal": {
"id": 4,
"appId": AppID,
"componentIds": ["4"],
"title": "abc123",
"color": Color,
"description": "abc123",
"readerRoles": [CustomEnumValue],
"writerRoles": [CustomEnumValue],
"readerGroupIds": ["xyz789"],
"readerGroups": [Group],
"writerGroupIds": ["xyz789"],
"writerGroups": [Group],
"ownedByGroupId": "abc123",
"categories": [CalendarEventCategory],
"iCalUrl": Url,
"iCalLastSynced": "2007-12-03",
"canRead": true,
"canWrite": false,
"hints": ["abc123"]
}
}
}
registerDeviceInfoAdmin
Description
Registriert das Gerät als Admin-Gerät
Response
Returns a DeviceInfo
Example
Query
mutation registerDeviceInfoAdmin(
$appId: AppID!,
$deviceId: String!,
$deviceSecret: String
) {
registerDeviceInfoAdmin(
appId: $appId,
deviceId: $deviceId,
deviceSecret: $deviceSecret
) {
deviceId
adminDevice
appId
locale
iosPushToken
aosPushToken
pin
osVersion
deviceName
deviceModel
deviceSystem
created
lastConnect
}
}
Variables
{
"appId": AppID,
"deviceId": "abc123",
"deviceSecret": "xyz789"
}
Response
{
"data": {
"registerDeviceInfoAdmin": {
"deviceId": "xyz789",
"adminDevice": false,
"appId": "xyz789",
"locale": "xyz789",
"iosPushToken": "xyz789",
"aosPushToken": "xyz789",
"pin": "abc123",
"osVersion": "abc123",
"deviceName": "abc123",
"deviceModel": "xyz789",
"deviceSystem": "xyz789",
"created": "2007-12-03",
"lastConnect": "2007-12-03"
}
}
}
rejectEventAttendance
Description
Widerruft die Teilnahme am Event Dies kann nur von einem zuständigen Ansprechpartner des Termins am Tag des Termins durchgeführt werden.
Response
Returns a CalendarEventRegistration
Arguments
| Name | Description |
|---|---|
registrationId - ID!
|
Example
Query
mutation rejectEventAttendance($registrationId: ID!) {
rejectEventAttendance(registrationId: $registrationId) {
id
creationDate
calendarEventId
seat {
...SeatFragment
}
comment
deviceId
clientId
client {
...UserProfileBasicDataFragment
}
status
waitingPosition
payed
formData
}
}
Variables
{"registrationId": 4}
Response
{
"data": {
"rejectEventAttendance": {
"id": 4,
"creationDate": "2007-12-03",
"calendarEventId": "4",
"seat": Seat,
"comment": "xyz789",
"deviceId": "xyz789",
"clientId": "xyz789",
"client": UserProfileBasicData,
"status": "xyz789",
"waitingPosition": 123,
"payed": false,
"formData": {}
}
}
}
rejectEventPayment
Description
Der Veranstalter/Verantwortliche des Events zieht die Bezahlbestätigung zurück
Response
Returns a CalendarEventRegistration
Arguments
| Name | Description |
|---|---|
registrationId - ID!
|
Example
Query
mutation rejectEventPayment($registrationId: ID!) {
rejectEventPayment(registrationId: $registrationId) {
id
creationDate
calendarEventId
seat {
...SeatFragment
}
comment
deviceId
clientId
client {
...UserProfileBasicDataFragment
}
status
waitingPosition
payed
formData
}
}
Variables
{"registrationId": "4"}
Response
{
"data": {
"rejectEventPayment": {
"id": "4",
"creationDate": "2007-12-03",
"calendarEventId": "4",
"seat": Seat,
"comment": "abc123",
"deviceId": "abc123",
"clientId": "abc123",
"client": UserProfileBasicData,
"status": "xyz789",
"waitingPosition": 987,
"payed": false,
"formData": {}
}
}
}
removeChatChannel
Description
Löscht einen Kanal aus der Chat-Komponente
renameFileStoreFile
Description
Benennt eine Datei oder ein Verzeichnis um
Response
Returns an FSFile
Example
Query
mutation renameFileStoreFile(
$storeId: FSId,
$file: FSFileId!,
$newName: String!
) {
renameFileStoreFile(
storeId: $storeId,
file: $file,
newName: $newName
) {
fsId
id
parentId
contentType
name
contentLength
directory
status
created
createdBy
lastModified
lastModifiedBy
eTag
uploadUrl
downloadUrl
thumbnailImageUrl
}
}
Variables
{
"storeId": FSId,
"file": FSFileId,
"newName": "abc123"
}
Response
{
"data": {
"renameFileStoreFile": {
"fsId": FSId,
"id": FSFileId,
"parentId": FSFileId,
"contentType": "xyz789",
"name": "abc123",
"contentLength": {},
"directory": false,
"status": "READY",
"created": "2007-12-03",
"createdBy": "xyz789",
"lastModified": "2007-12-03",
"lastModifiedBy": "xyz789",
"eTag": "abc123",
"uploadUrl": Url,
"downloadUrl": Url,
"thumbnailImageUrl": Url
}
}
}
renameWorkspaceFile
Description
Ändert den Dateinamen
Example
Query
mutation renameWorkspaceFile(
$file: WSFileId!,
$name: String!
) {
renameWorkspaceFile(
file: $file,
name: $name
) {
id
workspaceId
type
key
readonly
name
lastModified
lastModifiedBy
description
size
parentId
}
}
Variables
{
"file": WSFileId,
"name": "xyz789"
}
Response
{
"data": {
"renameWorkspaceFile": {
"id": WSFileId,
"workspaceId": WSFileId,
"type": "ROOT",
"key": "xyz789",
"readonly": false,
"name": "xyz789",
"lastModified": "2007-12-03",
"lastModifiedBy": "xyz789",
"description": "abc123",
"size": 987,
"parentId": "abc123"
}
}
}
requestAndroidAppUpdate
Description
request IOS Update
returns true if update requested
requestCalendarEventRegistration
Description
Registrieungsanfrage zu einem Termin. Bei der Anfrage werden so viele 'Plätze' reserviert wie es Teilnehmer in der Anfrage gibt. Die Registrierung gelingt nur dann, wenn noch ausreichendes Kontingent für alle Teilnehmer in dieser Anfrage vorhanden ist. Je nachdem, ob für den Termin eine Warteliste verwaltet werden soll, erhält man entsprechend eine Fehlermeldung oder zugeteilte Positionen.
Response
Returns [CalendarEventRegistration]!
Arguments
| Name | Description |
|---|---|
request - CalendarEventRegistrationRequest
|
Example
Query
mutation requestCalendarEventRegistration($request: CalendarEventRegistrationRequest) {
requestCalendarEventRegistration(request: $request) {
id
creationDate
calendarEventId
seat {
...SeatFragment
}
comment
deviceId
clientId
client {
...UserProfileBasicDataFragment
}
status
waitingPosition
payed
formData
}
}
Variables
{"request": CalendarEventRegistrationRequest}
Response
{
"data": {
"requestCalendarEventRegistration": [
{
"id": "4",
"creationDate": "2007-12-03",
"calendarEventId": "4",
"seat": Seat,
"comment": "abc123",
"deviceId": "xyz789",
"clientId": "abc123",
"client": UserProfileBasicData,
"status": "xyz789",
"waitingPosition": 987,
"payed": true,
"formData": {}
}
]
}
}
requestCaptcha
Description
Erzeugt ein Captcha Bild in der gwünschten Grösse
Response
Returns a Captcha
Example
Query
mutation requestCaptcha(
$width: Int,
$height: Int
) {
requestCaptcha(
width: $width,
height: $height
) {
id
image
}
}
Variables
{"width": 300, "height": 200}
Response
{
"data": {
"requestCaptcha": {
"id": "4",
"image": "xyz789"
}
}
}
requestGroupAccess
Description
Fragt die Mitgliedschaft in einer Gruppe an Gibt true zurück, wenn es eine öffentliche Gruppe ist und automatisch beigetreten wurde. Gibt false zurück, wenn es einer Bestätigung bedarf
Response
Returns a Boolean
Arguments
| Name | Description |
|---|---|
request - GroupAccessRequestInput!
|
Example
Query
mutation requestGroupAccess($request: GroupAccessRequestInput!) {
requestGroupAccess(request: $request)
}
Variables
{"request": GroupAccessRequestInput}
Response
{"data": {"requestGroupAccess": false}}
requestIOSAppUpdate
Description
request IOS Update
returns true if update requested
requestPublicCalendarEventRegistration
Description
Spezielle Version der "requestCalendarEventRegistration" zum einbinden in die öffentliche Webseite über unser CalendarWidget. Nur erlaubt bei Terminen, die mit 'öffentliche Anmeldung erlauben' markiert sind. Der Request benötigt nur die Felder Name, Vorname, EMail. Um Mißbrauch über ein Skript zu verhindern muss zusätzlich noch ein Captcha gelöst werden. Technisch werden die Personen vom Termin-Verantwortlichen als Begleitpersonen angemeldet.
Response
Returns [CalendarEventRegistration]!
Arguments
| Name | Description |
|---|---|
request - CalendarEventRegistrationRequest!
|
|
captcha - CaptchaSolution!
|
Example
Query
mutation requestPublicCalendarEventRegistration(
$request: CalendarEventRegistrationRequest!,
$captcha: CaptchaSolution!
) {
requestPublicCalendarEventRegistration(
request: $request,
captcha: $captcha
) {
id
creationDate
calendarEventId
seat {
...SeatFragment
}
comment
deviceId
clientId
client {
...UserProfileBasicDataFragment
}
status
waitingPosition
payed
formData
}
}
Variables
{
"request": CalendarEventRegistrationRequest,
"captcha": CaptchaSolution
}
Response
{
"data": {
"requestPublicCalendarEventRegistration": [
{
"id": 4,
"creationDate": "2007-12-03",
"calendarEventId": 4,
"seat": Seat,
"comment": "xyz789",
"deviceId": "abc123",
"clientId": "xyz789",
"client": UserProfileBasicData,
"status": "xyz789",
"waitingPosition": 987,
"payed": true,
"formData": {}
}
]
}
}
requestPushNotificationCertificate
Description
Fordert das aktualisieren eines Zertifikats an
Response
Returns a Boolean
Example
Query
mutation requestPushNotificationCertificate {
requestPushNotificationCertificate
}
Response
{"data": {"requestPushNotificationCertificate": false}}
resetAdminUserPassword
Description
Setzt das Passwort eines Administrators zurück(INTERNAL)
resetUserPassword
Description
Setzt das Passwort eines App-Administrators
rotateConferencePhonePin
Description
Ändert den Konferenz-Pin
Response
Returns a ConferencePhonePin
Arguments
| Name | Description |
|---|---|
conferenceId - String!
|
Example
Query
mutation rotateConferencePhonePin($conferenceId: String!) {
rotateConferencePhonePin(conferenceId: $conferenceId) {
pin
}
}
Variables
{"conferenceId": "abc123"}
Response
{"data": {"rotateConferencePhonePin": {"pin": {}}}}
security_app_assign_admin
Please use registerDeviceInfoAdmin
Description
Registriert das Gerät als Admin-Gerät
Response
Returns a DeviceInfo
Example
Query
mutation security_app_assign_admin(
$appId: AppID!,
$deviceId: String!,
$deviceSecret: String
) {
security_app_assign_admin(
appId: $appId,
deviceId: $deviceId,
deviceSecret: $deviceSecret
) {
deviceId
adminDevice
appId
locale
iosPushToken
aosPushToken
pin
osVersion
deviceName
deviceModel
deviceSystem
created
lastConnect
}
}
Variables
{
"appId": AppID,
"deviceId": "abc123",
"deviceSecret": "abc123"
}
Response
{
"data": {
"security_app_assign_admin": {
"deviceId": "xyz789",
"adminDevice": true,
"appId": "xyz789",
"locale": "xyz789",
"iosPushToken": "xyz789",
"aosPushToken": "xyz789",
"pin": "abc123",
"osVersion": "abc123",
"deviceName": "xyz789",
"deviceModel": "xyz789",
"deviceSystem": "xyz789",
"created": "2007-12-03",
"lastConnect": "2007-12-03"
}
}
}
security_create_temporary_technical_user
Please use createTemporaryTechnicalUser
Description
erzeugt einen neuen temporären technischen Benutzer und gibt die Credentials zurück
Response
Returns a User
Example
Query
mutation security_create_temporary_technical_user {
security_create_temporary_technical_user {
username
email
currentAppId
permissions
lastLogin
deviceIds
language
technicalAppUser
inactive
appIds
currentAppDivisions
managed
fullName
cnumber
invalidLoginAttemps
password
lastAppLogin
}
}
Response
{
"data": {
"security_create_temporary_technical_user": {
"username": "abc123",
"email": "xyz789",
"currentAppId": AppID,
"permissions": ["MANAGE_COMPONENT"],
"lastLogin": "2007-12-03",
"deviceIds": ["abc123"],
"language": "xyz789",
"technicalAppUser": false,
"inactive": true,
"appIds": ["abc123"],
"currentAppDivisions": ["xyz789"],
"managed": false,
"fullName": "abc123",
"cnumber": "abc123",
"invalidLoginAttemps": 987,
"password": "xyz789",
"lastAppLogin": "2007-12-03"
}
}
}
sendLoginNotificationToDevices
Description
Eine interne Operation, die vom Login- Server benutzt wird, um Push Nachrichten zu senden
Response
Returns a PushNotification
Arguments
| Name | Description |
|---|---|
appId - AppID!
|
|
notification - LoginPushNotificationInput
|
|
targets - [String!]
|
Example
Query
mutation sendLoginNotificationToDevices(
$appId: AppID!,
$notification: LoginPushNotificationInput,
$targets: [String!]
) {
sendLoginNotificationToDevices(
appId: $appId,
notification: $notification,
targets: $targets
) {
id
status
message
appId
androidUsers
iphoneUsers
androidUsersMax
iphoneUsersMax
username
badge
sheduleDate
sound
soundId
componentId
imageUrl
pending
componentReference {
...ComponentReferenceFragment
}
url
channelIds
channels {
...PushChannelFragment
}
roleIds
departmentIds
groupIds
dispatchDate
mode
publicPushNotification
}
}
Variables
{
"appId": AppID,
"notification": LoginPushNotificationInput,
"targets": ["xyz789"]
}
Response
{
"data": {
"sendLoginNotificationToDevices": {
"id": 4,
"status": "SCHEDULED",
"message": "xyz789",
"appId": "xyz789",
"androidUsers": 123,
"iphoneUsers": 987,
"androidUsersMax": 987,
"iphoneUsersMax": 123,
"username": "xyz789",
"badge": 987,
"sheduleDate": "2007-12-03",
"sound": false,
"soundId": "xyz789",
"componentId": "abc123",
"imageUrl": "abc123",
"pending": 987,
"componentReference": ComponentReference,
"url": "abc123",
"channelIds": ["xyz789"],
"channels": [PushChannel],
"roleIds": ["xyz789"],
"departmentIds": ["xyz789"],
"groupIds": ["abc123"],
"dispatchDate": "2007-12-03",
"mode": "NORMAL",
"publicPushNotification": true
}
}
}
sendMail
Description
Formatiert eine HTML e-Mail auf Basis der gegebenen Vorlage und den zu ersetzenden Variablen und sendet diese an die Empfänger. Aus Sicherheitsgründen erlauben wir nur die Verwendung von Empfänger-Mailadressen, die in unserem System bekannt sind, also entweder von Portal Benutzern oder App Nutzer Profilen.
Response
Returns an ID!
Arguments
| Name | Description |
|---|---|
to - [String]!
|
|
captcha - CaptchaSolution
|
|
subject - String!
|
|
templateKey - String!
|
|
variables - JSON!
|
|
images - [InlineImage]
|
|
textAttachment - TextAttachment
|
Example
Query
mutation sendMail(
$to: [String]!,
$captcha: CaptchaSolution,
$subject: String!,
$templateKey: String!,
$variables: JSON!,
$images: [InlineImage],
$textAttachment: TextAttachment
) {
sendMail(
to: $to,
captcha: $captcha,
subject: $subject,
templateKey: $templateKey,
variables: $variables,
images: $images,
textAttachment: $textAttachment
)
}
Variables
{
"to": ["xyz789"],
"captcha": CaptchaSolution,
"subject": "xyz789",
"templateKey": "abc123",
"variables": {},
"images": [InlineImage],
"textAttachment": TextAttachment
}
Response
{"data": {"sendMail": 4}}
sendPushNotificationToDevices
Description
sendet die Push Nachricht an alle registrierten Empfänger Geräte der App oder eine ausgeählte Teilmenge.
Response
Returns a PushNotification
Arguments
| Name | Description |
|---|---|
notification - PushNotificationInput
|
|
targets - [String!]
|
Example
Query
mutation sendPushNotificationToDevices(
$notification: PushNotificationInput,
$targets: [String!]
) {
sendPushNotificationToDevices(
notification: $notification,
targets: $targets
) {
id
status
message
appId
androidUsers
iphoneUsers
androidUsersMax
iphoneUsersMax
username
badge
sheduleDate
sound
soundId
componentId
imageUrl
pending
componentReference {
...ComponentReferenceFragment
}
url
channelIds
channels {
...PushChannelFragment
}
roleIds
departmentIds
groupIds
dispatchDate
mode
publicPushNotification
}
}
Variables
{
"notification": PushNotificationInput,
"targets": ["abc123"]
}
Response
{
"data": {
"sendPushNotificationToDevices": {
"id": 4,
"status": "SCHEDULED",
"message": "xyz789",
"appId": "xyz789",
"androidUsers": 987,
"iphoneUsers": 987,
"androidUsersMax": 987,
"iphoneUsersMax": 987,
"username": "xyz789",
"badge": 123,
"sheduleDate": "2007-12-03",
"sound": true,
"soundId": "abc123",
"componentId": "xyz789",
"imageUrl": "xyz789",
"pending": 123,
"componentReference": ComponentReference,
"url": "abc123",
"channelIds": ["xyz789"],
"channels": [PushChannel],
"roleIds": ["abc123"],
"departmentIds": ["xyz789"],
"groupIds": ["abc123"],
"dispatchDate": "2007-12-03",
"mode": "NORMAL",
"publicPushNotification": false
}
}
}
sendPushNotificationToDevices2
Description
experimentell
Response
Returns an AppBackgroundJob
Arguments
| Name | Description |
|---|---|
countOnly - Boolean
|
Default = true |
notification - PushNotificationInput
|
|
targets - [String!]
|
Example
Query
mutation sendPushNotificationToDevices2(
$countOnly: Boolean,
$notification: PushNotificationInput,
$targets: [String!]
) {
sendPushNotificationToDevices2(
countOnly: $countOnly,
notification: $notification,
targets: $targets
) {
id
androidMaxHits
androidProgress
iosMaxHits
iosProgress
filtered
}
}
Variables
{
"countOnly": true,
"notification": PushNotificationInput,
"targets": ["xyz789"]
}
Response
{
"data": {
"sendPushNotificationToDevices2": {
"id": 4,
"androidMaxHits": 987,
"androidProgress": 123,
"iosMaxHits": 987,
"iosProgress": 987,
"filtered": false
}
}
}
sendPushNotificationToDevicesAdmin
Description
Eine interne Operation, die vom Chat Server benutzt wird, um Push Nachrichten zu senden
Response
Returns a PushNotification
Arguments
| Name | Description |
|---|---|
appId - AppID!
|
|
notification - PushNotificationInput
|
|
targets - [String!]
|
Example
Query
mutation sendPushNotificationToDevicesAdmin(
$appId: AppID!,
$notification: PushNotificationInput,
$targets: [String!]
) {
sendPushNotificationToDevicesAdmin(
appId: $appId,
notification: $notification,
targets: $targets
) {
id
status
message
appId
androidUsers
iphoneUsers
androidUsersMax
iphoneUsersMax
username
badge
sheduleDate
sound
soundId
componentId
imageUrl
pending
componentReference {
...ComponentReferenceFragment
}
url
channelIds
channels {
...PushChannelFragment
}
roleIds
departmentIds
groupIds
dispatchDate
mode
publicPushNotification
}
}
Variables
{
"appId": AppID,
"notification": PushNotificationInput,
"targets": ["abc123"]
}
Response
{
"data": {
"sendPushNotificationToDevicesAdmin": {
"id": "4",
"status": "SCHEDULED",
"message": "abc123",
"appId": "xyz789",
"androidUsers": 123,
"iphoneUsers": 987,
"androidUsersMax": 987,
"iphoneUsersMax": 987,
"username": "abc123",
"badge": 987,
"sheduleDate": "2007-12-03",
"sound": false,
"soundId": "xyz789",
"componentId": "xyz789",
"imageUrl": "xyz789",
"pending": 987,
"componentReference": ComponentReference,
"url": "xyz789",
"channelIds": ["xyz789"],
"channels": [PushChannel],
"roleIds": ["xyz789"],
"departmentIds": ["abc123"],
"groupIds": ["abc123"],
"dispatchDate": "2007-12-03",
"mode": "NORMAL",
"publicPushNotification": true
}
}
}
sendPushNotificationToEventAttendees
Description
Sendet eine Push-Nachricht an alle angemeldeten Teilnhemer eines Events, sofern diese ein Profil besitzen. Liefert die Anzahl der Teilnehmer mit Profil. Kann zusätzlich auf ProfilIds eingeschränkt werden (optional)
Response
Returns an Int
Arguments
| Name | Description |
|---|---|
eventId - ID!
|
|
profileIds - [String]
|
|
notification - PushNotificationInput
|
Example
Query
mutation sendPushNotificationToEventAttendees(
$eventId: ID!,
$profileIds: [String],
$notification: PushNotificationInput
) {
sendPushNotificationToEventAttendees(
eventId: $eventId,
profileIds: $profileIds,
notification: $notification
)
}
Variables
{
"eventId": 4,
"profileIds": ["abc123"],
"notification": PushNotificationInput
}
Response
{"data": {"sendPushNotificationToEventAttendees": 123}}
sendPushNotificationToProfile
Description
Sendet eine Push-Nachricht an ein Profil
Response
Returns a PushNotification
Arguments
| Name | Description |
|---|---|
notification - PushNotificationInput
|
|
profileId - String!
|
Example
Query
mutation sendPushNotificationToProfile(
$notification: PushNotificationInput,
$profileId: String!
) {
sendPushNotificationToProfile(
notification: $notification,
profileId: $profileId
) {
id
status
message
appId
androidUsers
iphoneUsers
androidUsersMax
iphoneUsersMax
username
badge
sheduleDate
sound
soundId
componentId
imageUrl
pending
componentReference {
...ComponentReferenceFragment
}
url
channelIds
channels {
...PushChannelFragment
}
roleIds
departmentIds
groupIds
dispatchDate
mode
publicPushNotification
}
}
Variables
{
"notification": PushNotificationInput,
"profileId": "xyz789"
}
Response
{
"data": {
"sendPushNotificationToProfile": {
"id": "4",
"status": "SCHEDULED",
"message": "abc123",
"appId": "abc123",
"androidUsers": 987,
"iphoneUsers": 987,
"androidUsersMax": 123,
"iphoneUsersMax": 987,
"username": "abc123",
"badge": 123,
"sheduleDate": "2007-12-03",
"sound": true,
"soundId": "abc123",
"componentId": "xyz789",
"imageUrl": "xyz789",
"pending": 987,
"componentReference": ComponentReference,
"url": "abc123",
"channelIds": ["abc123"],
"channels": [PushChannel],
"roleIds": ["xyz789"],
"departmentIds": ["abc123"],
"groupIds": ["abc123"],
"dispatchDate": "2007-12-03",
"mode": "NORMAL",
"publicPushNotification": true
}
}
}
setPersonalThreshold
Description
setzt bzw. ändert die oberen und unteren Grenzwerte zu einer Serie, die zu einer entsprechenden Push Mitteilung führen, sobald diese unter- bzw. überschritten werden
Response
Returns a Threshold
Arguments
| Name | Description |
|---|---|
input - ThresholdInput
|
Example
Query
mutation setPersonalThreshold($input: ThresholdInput) {
setPersonalThreshold(input: $input) {
timeSeriesId
upper
lower
profileId
}
}
Variables
{"input": ThresholdInput}
Response
{
"data": {
"setPersonalThreshold": {
"timeSeriesId": 4,
"upper": 987.65,
"lower": 123.45,
"profileId": "4"
}
}
}
setTimeSeriesVisibility
Description
Schaltet die Sichtbarkeit einer Serie ein oder aus
Response
Returns a TimeSeries
Example
Query
mutation setTimeSeriesVisibility(
$seriesId: ID!,
$visibility: Boolean!,
$roleVisibility: [RoleRef]
) {
setTimeSeriesVisibility(
seriesId: $seriesId,
visibility: $visibility,
roleVisibility: $roleVisibility
) {
id
name
appId
unit
granularity
latestEntry {
...TimeSeriesDataFragment
}
delta
metaData
roleVisibility {
...CustomEnumValueFragment
}
visible
lastModified
}
}
Variables
{
"seriesId": 4,
"visibility": false,
"roleVisibility": [RoleRef]
}
Response
{
"data": {
"setTimeSeriesVisibility": {
"id": "4",
"name": "abc123",
"appId": AppID,
"unit": "abc123",
"granularity": "xyz789",
"latestEntry": TimeSeriesData,
"delta": 123.45,
"metaData": {},
"roleVisibility": [CustomEnumValue],
"visible": true,
"lastModified": "2007-12-03"
}
}
}
startPhoneNumberVerification
Description
Startet den Wechsel der Telefonnummer
Example
Query
mutation startPhoneNumberVerification($phoneNumber: String) {
startPhoneNumberVerification(phoneNumber: $phoneNumber)
}
Variables
{"phoneNumber": "abc123"}
Response
{"data": {"startPhoneNumberVerification": false}}
subscribePushChannel
Description
Subscribe device to push channel
triggerLoginByMail
Description
Sendet an die gegebene Zieladresse eine Mail mit einer PIN, welche für 5 Minuten gilt, die benutzt werden kann, um ein Token mit den Berechtigungen des zugehörigen Benutzerprofils zu bekommen. Siehe query 'getTokenByMailAndPin'.
Response
Returns a Boolean
Example
Query
mutation triggerLoginByMail(
$receiverMail: String!,
$mailTemplateKey: String
) {
triggerLoginByMail(
receiverMail: $receiverMail,
mailTemplateKey: $mailTemplateKey
)
}
Variables
{
"receiverMail": "abc123",
"mailTemplateKey": "login_pin"
}
Response
{"data": {"triggerLoginByMail": false}}
triggerTimeSeriesChangedListener
Description
Es wird die Benachrichtigung für Grenzwertmeldungen zu einer Serie aktiv angestossen.
unlinkDevice
Description
Das Device soll von dem aktuellen Benutzerprofil getrennt werden
Response
Returns [DeviceSummary]
Arguments
| Name | Description |
|---|---|
deviceId - String!
|
Example
Query
mutation unlinkDevice($deviceId: String!) {
unlinkDevice(deviceId: $deviceId) {
deviceId
lastConnect
osVersion
deviceName
deviceModel
deviceSystem
pin
}
}
Variables
{"deviceId": "abc123"}
Response
{
"data": {
"unlinkDevice": [
{
"deviceId": "abc123",
"lastConnect": "2007-12-03",
"osVersion": "abc123",
"deviceName": "xyz789",
"deviceModel": "xyz789",
"deviceSystem": "abc123",
"pin": "abc123"
}
]
}
}
unlinkUserDevice
Description
Das Device soll vom aktuellen CMS-Benutzer getrennt werden
Response
Returns [DeviceSummary]
Arguments
| Name | Description |
|---|---|
deviceId - String!
|
Example
Query
mutation unlinkUserDevice($deviceId: String!) {
unlinkUserDevice(deviceId: $deviceId) {
deviceId
lastConnect
osVersion
deviceName
deviceModel
deviceSystem
pin
}
}
Variables
{"deviceId": "xyz789"}
Response
{
"data": {
"unlinkUserDevice": [
{
"deviceId": "xyz789",
"lastConnect": "2007-12-03",
"osVersion": "abc123",
"deviceName": "xyz789",
"deviceModel": "abc123",
"deviceSystem": "abc123",
"pin": "xyz789"
}
]
}
}
unsubscribePushChannel
Description
Removes subscription
updateAdminUser
Description
Updated einen Administrator (INTERNAL)
Response
Returns a User
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
request - AdminUserInput
|
Example
Query
mutation updateAdminUser(
$id: ID!,
$request: AdminUserInput
) {
updateAdminUser(
id: $id,
request: $request
) {
username
email
currentAppId
permissions
lastLogin
deviceIds
language
technicalAppUser
inactive
appIds
currentAppDivisions
managed
fullName
cnumber
invalidLoginAttemps
password
lastAppLogin
}
}
Variables
{
"id": "4",
"request": AdminUserInput
}
Response
{
"data": {
"updateAdminUser": {
"username": "abc123",
"email": "abc123",
"currentAppId": AppID,
"permissions": ["MANAGE_COMPONENT"],
"lastLogin": "2007-12-03",
"deviceIds": ["xyz789"],
"language": "xyz789",
"technicalAppUser": false,
"inactive": false,
"appIds": ["abc123"],
"currentAppDivisions": ["xyz789"],
"managed": false,
"fullName": "abc123",
"cnumber": "abc123",
"invalidLoginAttemps": 987,
"password": "abc123",
"lastAppLogin": "2007-12-03"
}
}
}
updateAdvertiseGraphic
Description
Aktualisiert die Werbegrafik
Response
Returns a ProjectMetadata
Arguments
| Name | Description |
|---|---|
file - UploadId!
|
Example
Query
mutation updateAdvertiseGraphic($file: UploadId!) {
updateAdvertiseGraphic(file: $file) {
ios_appname
ios_subname
ios_app_short_name
ios_description
ios_keywords
ios_support_url
ios_marketing_url
ios_copyright
ios_category_a
ios_category_b
ios_promotext
ios_appicon_76x76_url
ios_appicon_152x152_url
ios_appicon_180x180_url
ios_appicon_167x167_url
ios_splasscreen_1242x2208_url
ios_appicon_big_url
ios_high_resolution_icon_url
ios_askForUpdate
ios_goinglive
ios_lastUpdate
ios_libVersion
ios_developer_Account
ios_dev_comment
ios_appstore_link
aos_appname
aos_adverttext
aos_website
aos_category
aos_short_description
aos_description
aos_appicon_url
aos_splasscreenicon_url
aos_high_resolution_icon_url
aos_function_icon_url
aos_advert_icon_url
advertisingGraphic_url
aos_askForUpdate
aos_goinglive
aos_lastUpdate
aos_libVersion
aos_dev_comment
aos_firebase_project_id
aos_developer_account
aos_appstore_link
portalAppName
facebookPage
projectDescription
portalAppIconUrl
videoQuotaMB
contractGroup
aos_fcm_server_key
projectType
}
}
Variables
{"file": UploadId}
Response
{
"data": {
"updateAdvertiseGraphic": {
"ios_appname": "abc123",
"ios_subname": "xyz789",
"ios_app_short_name": "xyz789",
"ios_description": "xyz789",
"ios_keywords": "abc123",
"ios_support_url": "abc123",
"ios_marketing_url": "abc123",
"ios_copyright": "xyz789",
"ios_category_a": "abc123",
"ios_category_b": "abc123",
"ios_promotext": "abc123",
"ios_appicon_76x76_url": "xyz789",
"ios_appicon_152x152_url": "xyz789",
"ios_appicon_180x180_url": "xyz789",
"ios_appicon_167x167_url": "xyz789",
"ios_splasscreen_1242x2208_url": "abc123",
"ios_appicon_big_url": "xyz789",
"ios_high_resolution_icon_url": "abc123",
"ios_askForUpdate": true,
"ios_goinglive": "2007-12-03",
"ios_lastUpdate": "2007-12-03",
"ios_libVersion": 123,
"ios_developer_Account": "xyz789",
"ios_dev_comment": "abc123",
"ios_appstore_link": "xyz789",
"aos_appname": "abc123",
"aos_adverttext": "abc123",
"aos_website": "xyz789",
"aos_category": "abc123",
"aos_short_description": "abc123",
"aos_description": "xyz789",
"aos_appicon_url": "xyz789",
"aos_splasscreenicon_url": "xyz789",
"aos_high_resolution_icon_url": "abc123",
"aos_function_icon_url": "abc123",
"aos_advert_icon_url": "xyz789",
"advertisingGraphic_url": "abc123",
"aos_askForUpdate": true,
"aos_goinglive": "2007-12-03",
"aos_lastUpdate": "2007-12-03",
"aos_libVersion": 123,
"aos_dev_comment": "abc123",
"aos_firebase_project_id": "abc123",
"aos_developer_account": "abc123",
"aos_appstore_link": "xyz789",
"portalAppName": "xyz789",
"facebookPage": "xyz789",
"projectDescription": "xyz789",
"portalAppIconUrl": "abc123",
"videoQuotaMB": "abc123",
"contractGroup": "xyz789",
"aos_fcm_server_key": "xyz789",
"projectType": "xyz789"
}
}
}
updateAndroidAppStoreResource
Description
Aktualisiert eine Datei für den Android Store
valid resourceTypes:
appicon
splashscreen
functionicon
Response
Returns a ProjectMetadata
Example
Query
mutation updateAndroidAppStoreResource(
$file: UploadId!,
$resourceType: String!
) {
updateAndroidAppStoreResource(
file: $file,
resourceType: $resourceType
) {
ios_appname
ios_subname
ios_app_short_name
ios_description
ios_keywords
ios_support_url
ios_marketing_url
ios_copyright
ios_category_a
ios_category_b
ios_promotext
ios_appicon_76x76_url
ios_appicon_152x152_url
ios_appicon_180x180_url
ios_appicon_167x167_url
ios_splasscreen_1242x2208_url
ios_appicon_big_url
ios_high_resolution_icon_url
ios_askForUpdate
ios_goinglive
ios_lastUpdate
ios_libVersion
ios_developer_Account
ios_dev_comment
ios_appstore_link
aos_appname
aos_adverttext
aos_website
aos_category
aos_short_description
aos_description
aos_appicon_url
aos_splasscreenicon_url
aos_high_resolution_icon_url
aos_function_icon_url
aos_advert_icon_url
advertisingGraphic_url
aos_askForUpdate
aos_goinglive
aos_lastUpdate
aos_libVersion
aos_dev_comment
aos_firebase_project_id
aos_developer_account
aos_appstore_link
portalAppName
facebookPage
projectDescription
portalAppIconUrl
videoQuotaMB
contractGroup
aos_fcm_server_key
projectType
}
}
Variables
{
"file": UploadId,
"resourceType": "abc123"
}
Response
{
"data": {
"updateAndroidAppStoreResource": {
"ios_appname": "xyz789",
"ios_subname": "xyz789",
"ios_app_short_name": "xyz789",
"ios_description": "xyz789",
"ios_keywords": "xyz789",
"ios_support_url": "xyz789",
"ios_marketing_url": "abc123",
"ios_copyright": "abc123",
"ios_category_a": "abc123",
"ios_category_b": "abc123",
"ios_promotext": "abc123",
"ios_appicon_76x76_url": "abc123",
"ios_appicon_152x152_url": "xyz789",
"ios_appicon_180x180_url": "abc123",
"ios_appicon_167x167_url": "xyz789",
"ios_splasscreen_1242x2208_url": "xyz789",
"ios_appicon_big_url": "xyz789",
"ios_high_resolution_icon_url": "xyz789",
"ios_askForUpdate": true,
"ios_goinglive": "2007-12-03",
"ios_lastUpdate": "2007-12-03",
"ios_libVersion": 987,
"ios_developer_Account": "abc123",
"ios_dev_comment": "abc123",
"ios_appstore_link": "xyz789",
"aos_appname": "xyz789",
"aos_adverttext": "abc123",
"aos_website": "abc123",
"aos_category": "xyz789",
"aos_short_description": "abc123",
"aos_description": "abc123",
"aos_appicon_url": "xyz789",
"aos_splasscreenicon_url": "abc123",
"aos_high_resolution_icon_url": "xyz789",
"aos_function_icon_url": "xyz789",
"aos_advert_icon_url": "xyz789",
"advertisingGraphic_url": "abc123",
"aos_askForUpdate": true,
"aos_goinglive": "2007-12-03",
"aos_lastUpdate": "2007-12-03",
"aos_libVersion": 123,
"aos_dev_comment": "xyz789",
"aos_firebase_project_id": "xyz789",
"aos_developer_account": "xyz789",
"aos_appstore_link": "xyz789",
"portalAppName": "xyz789",
"facebookPage": "xyz789",
"projectDescription": "abc123",
"portalAppIconUrl": "abc123",
"videoQuotaMB": "xyz789",
"contractGroup": "xyz789",
"aos_fcm_server_key": "abc123",
"projectType": "abc123"
}
}
}
updateAndroidAppStoreSettings
Description
Aktualisiert die Appstore informationen
Response
Returns a ProjectMetadata
Arguments
| Name | Description |
|---|---|
settings - AndroidAppStoreSettingsInput!
|
Example
Query
mutation updateAndroidAppStoreSettings($settings: AndroidAppStoreSettingsInput!) {
updateAndroidAppStoreSettings(settings: $settings) {
ios_appname
ios_subname
ios_app_short_name
ios_description
ios_keywords
ios_support_url
ios_marketing_url
ios_copyright
ios_category_a
ios_category_b
ios_promotext
ios_appicon_76x76_url
ios_appicon_152x152_url
ios_appicon_180x180_url
ios_appicon_167x167_url
ios_splasscreen_1242x2208_url
ios_appicon_big_url
ios_high_resolution_icon_url
ios_askForUpdate
ios_goinglive
ios_lastUpdate
ios_libVersion
ios_developer_Account
ios_dev_comment
ios_appstore_link
aos_appname
aos_adverttext
aos_website
aos_category
aos_short_description
aos_description
aos_appicon_url
aos_splasscreenicon_url
aos_high_resolution_icon_url
aos_function_icon_url
aos_advert_icon_url
advertisingGraphic_url
aos_askForUpdate
aos_goinglive
aos_lastUpdate
aos_libVersion
aos_dev_comment
aos_firebase_project_id
aos_developer_account
aos_appstore_link
portalAppName
facebookPage
projectDescription
portalAppIconUrl
videoQuotaMB
contractGroup
aos_fcm_server_key
projectType
}
}
Variables
{"settings": AndroidAppStoreSettingsInput}
Response
{
"data": {
"updateAndroidAppStoreSettings": {
"ios_appname": "xyz789",
"ios_subname": "abc123",
"ios_app_short_name": "abc123",
"ios_description": "xyz789",
"ios_keywords": "abc123",
"ios_support_url": "xyz789",
"ios_marketing_url": "abc123",
"ios_copyright": "xyz789",
"ios_category_a": "xyz789",
"ios_category_b": "xyz789",
"ios_promotext": "abc123",
"ios_appicon_76x76_url": "xyz789",
"ios_appicon_152x152_url": "xyz789",
"ios_appicon_180x180_url": "abc123",
"ios_appicon_167x167_url": "abc123",
"ios_splasscreen_1242x2208_url": "abc123",
"ios_appicon_big_url": "xyz789",
"ios_high_resolution_icon_url": "abc123",
"ios_askForUpdate": false,
"ios_goinglive": "2007-12-03",
"ios_lastUpdate": "2007-12-03",
"ios_libVersion": 123,
"ios_developer_Account": "abc123",
"ios_dev_comment": "abc123",
"ios_appstore_link": "abc123",
"aos_appname": "xyz789",
"aos_adverttext": "abc123",
"aos_website": "abc123",
"aos_category": "abc123",
"aos_short_description": "xyz789",
"aos_description": "xyz789",
"aos_appicon_url": "abc123",
"aos_splasscreenicon_url": "xyz789",
"aos_high_resolution_icon_url": "xyz789",
"aos_function_icon_url": "abc123",
"aos_advert_icon_url": "abc123",
"advertisingGraphic_url": "abc123",
"aos_askForUpdate": false,
"aos_goinglive": "2007-12-03",
"aos_lastUpdate": "2007-12-03",
"aos_libVersion": 123,
"aos_dev_comment": "xyz789",
"aos_firebase_project_id": "xyz789",
"aos_developer_account": "abc123",
"aos_appstore_link": "abc123",
"portalAppName": "abc123",
"facebookPage": "xyz789",
"projectDescription": "xyz789",
"portalAppIconUrl": "xyz789",
"videoQuotaMB": "xyz789",
"contractGroup": "xyz789",
"aos_fcm_server_key": "abc123",
"projectType": "xyz789"
}
}
}
updateBase64ImageInWorksheetCell
Description
ersetzt ein Base64 Bild in einer Zelle durch das Neue
Response
Returns a JSON!
Example
Query
mutation updateBase64ImageInWorksheetCell(
$worksheetId: ID!,
$autoId: Int!,
$imageProperty: String!,
$base64: String!
) {
updateBase64ImageInWorksheetCell(
worksheetId: $worksheetId,
autoId: $autoId,
imageProperty: $imageProperty,
base64: $base64
)
}
Variables
{
"worksheetId": "4",
"autoId": 123,
"imageProperty": "xyz789",
"base64": "abc123"
}
Response
{"data": {"updateBase64ImageInWorksheetCell": {}}}
updateBonusBooklet
Description
Aktualisiert ein Bonusheft
Response
Returns a BonusBooklet
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - BonusBookletInput!
|
Example
Query
mutation updateBonusBooklet(
$id: ID!,
$input: BonusBookletInput!
) {
updateBonusBooklet(
id: $id,
input: $input
) {
id
lastModified
bookletImage {
...ResourceFragment
}
bookletImageUrl
bookletImageId
stampImage {
...ResourceFragment
}
stampImageUrl
stampImageId
backgroundColor
couponId
coupon {
...CouponFragment
}
active
stamps {
...StampFragment
}
expires
}
}
Variables
{"id": 4, "input": BonusBookletInput}
Response
{
"data": {
"updateBonusBooklet": {
"id": "4",
"lastModified": "2007-12-03",
"bookletImage": Resource,
"bookletImageUrl": "abc123",
"bookletImageId": "4",
"stampImage": Resource,
"stampImageUrl": "xyz789",
"stampImageId": 4,
"backgroundColor": "xyz789",
"couponId": "4",
"coupon": Coupon,
"active": false,
"stamps": [Stamp],
"expires": "2007-12-03"
}
}
}
updateBookmarks
Description
Passt die Lesezeichen des Users an
Response
Returns a UserBookmarks
Arguments
| Name | Description |
|---|---|
input - UserBookmarksInput!
|
Example
Query
mutation updateBookmarks($input: UserBookmarksInput!) {
updateBookmarks(input: $input) {
refs {
...UserBookmarkRefFragment
}
}
}
Variables
{"input": UserBookmarksInput}
Response
{"data": {"updateBookmarks": {"refs": [UserBookmarkRef]}}}
updateCalendar
Description
Aktualisiert Kalender Einstellungen.
Response
Returns a Calendar
Arguments
| Name | Description |
|---|---|
calendarId - ID!
|
|
data - CalendarInput!
|
Example
Query
mutation updateCalendar(
$calendarId: ID!,
$data: CalendarInput!
) {
updateCalendar(
calendarId: $calendarId,
data: $data
) {
id
appId
componentIds
title
color
description
readerRoles {
...CustomEnumValueFragment
}
writerRoles {
...CustomEnumValueFragment
}
readerGroupIds
readerGroups {
...GroupFragment
}
writerGroupIds
writerGroups {
...GroupFragment
}
ownedByGroupId
categories {
...CalendarEventCategoryFragment
}
iCalUrl
iCalLastSynced
canRead
canWrite
hints
}
}
Variables
{
"calendarId": "4",
"data": CalendarInput
}
Response
{
"data": {
"updateCalendar": {
"id": "4",
"appId": AppID,
"componentIds": [4],
"title": "abc123",
"color": Color,
"description": "abc123",
"readerRoles": [CustomEnumValue],
"writerRoles": [CustomEnumValue],
"readerGroupIds": ["xyz789"],
"readerGroups": [Group],
"writerGroupIds": ["xyz789"],
"writerGroups": [Group],
"ownedByGroupId": "xyz789",
"categories": [CalendarEventCategory],
"iCalUrl": Url,
"iCalLastSynced": "2007-12-03",
"canRead": true,
"canWrite": true,
"hints": ["abc123"]
}
}
}
updateCalendarEmbedUrl
Description
Aktualisiert die Embed-Url der Komponente
updateCalendarEvents
Description
An einem vorhandenen Event wurden Änderungen vorgenommen. Die in dem Template gesendeten Änderungen werden auf dem Event mit der gegebenen Id übertragen. Sofern die SerienId gesetzt wird, werden auch alle Events innerhalb der Serie auf die gleiche Weise geändert, die auf den genannten Event folgen.
Response
Returns [CalendarEvent]!
Arguments
| Name | Description |
|---|---|
eventId - ID!
|
|
seriesId - ID
|
|
data - CalendarEventTemplate!
|
|
scope - ModificationScope!
|
Example
Query
mutation updateCalendarEvents(
$eventId: ID!,
$seriesId: ID,
$data: CalendarEventTemplate!,
$scope: ModificationScope!
) {
updateCalendarEvents(
eventId: $eventId,
seriesId: $seriesId,
data: $data,
scope: $scope
) {
id
calendarId
seriesId
title
subTitle
description
timeZoneId
timeZoneOffset
dateStart
dateTimeStart
localDateTimeStart
dateEnd
dateTimeEnd
localDateTimeEnd
categories {
...CalendarEventCategoryFragment
}
registrationRequired
publicRegistrationAllowed
allDay
maxSignUps
minSignUps
multiSignUpAllowed
memberListVisibility
maxAdditionalSignUps
registrationCount
deadlineStartOffsetMinutes
startOfRegistrationOffsetMinutes
cancelRegistrationDeadlineOffsetMinutes
requestCount
iconImage {
...MediaReferenceFragment
}
resources {
...MediaReferenceFragment
}
location {
...LocationFragment
}
detailLink
seats
ownRegistrations {
...CalendarEventRegistrationFragment
}
ownerId
owner {
...UserProfileFragment
}
contactId
contact {
...UserProfileFragment
}
contactGroupId
contactGroup {
...GroupFragment
}
canWrite
onlineConference
notifyEventContactPersonOnSignUp
issueTicketsUponRegistration
manageAttendees
reminder {
...CalendarEventReminderFragment
}
paymentDocumentation
registrationFormId
registrationForm {
...CalendarRegistrationFormFragment
}
products {
...ProductDefinitionFragment
}
waitingListEnabled
badgeEnabled
lastModificationDate
}
}
Variables
{
"eventId": 4,
"seriesId": "4",
"data": CalendarEventTemplate,
"scope": "SELECTED"
}
Response
{
"data": {
"updateCalendarEvents": [
{
"id": 4,
"calendarId": 4,
"seriesId": 4,
"title": "abc123",
"subTitle": "xyz789",
"description": "abc123",
"timeZoneId": "xyz789",
"timeZoneOffset": "abc123",
"dateStart": "2007-12-03",
"dateTimeStart": "abc123",
"localDateTimeStart": "2020-07-19T08:45:59",
"dateEnd": "2007-12-03",
"dateTimeEnd": "abc123",
"localDateTimeEnd": "2020-07-19T08:45:59",
"categories": [CalendarEventCategory],
"registrationRequired": false,
"publicRegistrationAllowed": false,
"allDay": true,
"maxSignUps": 123,
"minSignUps": 987,
"multiSignUpAllowed": false,
"memberListVisibility": "ADMIN",
"maxAdditionalSignUps": 123,
"registrationCount": 987,
"deadlineStartOffsetMinutes": 987,
"startOfRegistrationOffsetMinutes": 987,
"cancelRegistrationDeadlineOffsetMinutes": 987,
"requestCount": 123,
"iconImage": MediaReference,
"resources": [MediaReference],
"location": Location,
"detailLink": "xyz789",
"seats": ["abc123"],
"ownRegistrations": [CalendarEventRegistration],
"ownerId": "abc123",
"owner": UserProfile,
"contactId": "xyz789",
"contact": UserProfile,
"contactGroupId": 4,
"contactGroup": Group,
"canWrite": false,
"onlineConference": true,
"notifyEventContactPersonOnSignUp": true,
"issueTicketsUponRegistration": true,
"manageAttendees": true,
"reminder": CalendarEventReminder,
"paymentDocumentation": false,
"registrationFormId": 4,
"registrationForm": CalendarRegistrationForm,
"products": [ProductDefinition],
"waitingListEnabled": true,
"badgeEnabled": true,
"lastModificationDate": "2007-12-03"
}
]
}
}
updateCalendarRegistrationForm
Description
Ändert ein Formular
Response
Returns a CalendarRegistrationForm
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - CalendarRegistrationFormInput!
|
Example
Query
mutation updateCalendarRegistrationForm(
$id: ID!,
$input: CalendarRegistrationFormInput!
) {
updateCalendarRegistrationForm(
id: $id,
input: $input
) {
name
id
header
footer
fields {
...WorksheetColumnMetaDataFragment
}
usedInEventsCount
}
}
Variables
{
"id": "4",
"input": CalendarRegistrationFormInput
}
Response
{
"data": {
"updateCalendarRegistrationForm": {
"name": "abc123",
"id": "4",
"header": "abc123",
"footer": "xyz789",
"fields": [WorksheetColumnMetaData],
"usedInEventsCount": {}
}
}
}
updateChatChannel
Description
Aktualisiert einen Chat-Kanal
Response
Returns a ChatChannel
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - ChatChannelInput!
|
Example
Query
mutation updateChatChannel(
$id: ID!,
$input: ChatChannelInput!
) {
updateChatChannel(
id: $id,
input: $input
) {
id
active
componentId
icon {
...ResourceFragment
}
iconId
iconUrl
backgroundImageId
backgroundImage {
...ResourceFragment
}
backgroundImageUrl
backgroundColor
label
pinCode
readOnly
allowPseudonyms
visibleByProfileRoles
visibleByDepartments
autoSubscribedRoles
autoSubscribedGroups
subscriptionsCount
directAdminProfilesIds
directAdminProfiles {
...UserProfileFragment
}
adminGroupId
adminGroup {
...GroupFragment
}
}
}
Variables
{
"id": "4",
"input": ChatChannelInput
}
Response
{
"data": {
"updateChatChannel": {
"id": 4,
"active": false,
"componentId": "xyz789",
"icon": Resource,
"iconId": "4",
"iconUrl": "abc123",
"backgroundImageId": 4,
"backgroundImage": Resource,
"backgroundImageUrl": "xyz789",
"backgroundColor": "xyz789",
"label": "xyz789",
"pinCode": "xyz789",
"readOnly": false,
"allowPseudonyms": true,
"visibleByProfileRoles": ["xyz789"],
"visibleByDepartments": ["abc123"],
"autoSubscribedRoles": ["xyz789"],
"autoSubscribedGroups": ["abc123"],
"subscriptionsCount": {},
"directAdminProfilesIds": ["xyz789"],
"directAdminProfiles": [UserProfile],
"adminGroupId": 4,
"adminGroup": Group
}
}
}
updateChatComponent
Description
Ändert die Einstellungen der Chat-Komponente
Response
Returns a ChatComponent
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - ChatComponentInput!
|
Example
Query
mutation updateChatComponent(
$id: ID!,
$input: ChatComponentInput!
) {
updateChatComponent(
id: $id,
input: $input
) {
id
appId
channels {
...ChatChannelFragment
}
lastModified
lastModifiedBy
chatHomeUrl
defaultAvatarUrl
helpPageId
helpPage {
...IWSFileFragment
}
helpPageUrl
rulesPageId
rulesPage {
...IWSFileFragment
}
rulePageUrl
accentColor
version
showContacts
restrictedShowContactRoles
allowDirectCommunication
allowGroups
allowVideo
allowPoll
allowPollForNonAdmin
restrictedDirectCommunicationRoles
restrictDirectCommunicationToSameRole
}
}
Variables
{
"id": "4",
"input": ChatComponentInput
}
Response
{
"data": {
"updateChatComponent": {
"id": 4,
"appId": AppID,
"channels": [ChatChannel],
"lastModified": "2007-12-03",
"lastModifiedBy": "abc123",
"chatHomeUrl": "abc123",
"defaultAvatarUrl": "xyz789",
"helpPageId": "xyz789",
"helpPage": IWSFile,
"helpPageUrl": "abc123",
"rulesPageId": "abc123",
"rulesPage": IWSFile,
"rulePageUrl": "xyz789",
"accentColor": "abc123",
"version": 123,
"showContacts": true,
"restrictedShowContactRoles": [
"xyz789"
],
"allowDirectCommunication": true,
"allowGroups": false,
"allowVideo": true,
"allowPoll": false,
"allowPollForNonAdmin": false,
"restrictedDirectCommunicationRoles": [
"abc123"
],
"restrictDirectCommunicationToSameRole": true
}
}
}
updateCurrentApp
Description
Wechselt die aktuelle app des Benutzers
updateCustomEnumValue
Description
Updated einen Key
Response
Returns a CustomEnum
Arguments
| Name | Description |
|---|---|
enumId - ID!
|
|
entry - CustomEnumKeyInput!
|
Example
Query
mutation updateCustomEnumValue(
$enumId: ID!,
$entry: CustomEnumKeyInput!
) {
updateCustomEnumValue(
enumId: $enumId,
entry: $entry
) {
id
keys
locales
translations {
...EnumTranslationFragment
}
}
}
Variables
{
"enumId": "4",
"entry": CustomEnumKeyInput
}
Response
{
"data": {
"updateCustomEnumValue": {
"id": "4",
"keys": ["xyz789"],
"locales": ["xyz789"],
"translations": [EnumTranslation]
}
}
}
updateFamilyMember
Description
Update eines Familienmitgliedes
Response
Returns a UserProfile
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
userProfile - FamilyMemberInput!
|
Example
Query
mutation updateFamilyMember(
$id: ID!,
$userProfile: FamilyMemberInput!
) {
updateFamilyMember(
id: $id,
userProfile: $userProfile
) {
salutation {
...CustomEnumValueFragment
}
roles {
...CustomEnumValueFragment
}
requestedRoles {
...CustomEnumValueFragment
}
departments {
...CustomEnumValueFragment
}
groups {
...GroupFragment
}
id
externalId
lastModified
created
appId
appGroup
name
firstname
email
birthday
title
imageId
imageThumbId
deviceIds
membershipNumber
agreedToAds
verificationPending
mailConfirmationPending
locked
mainProfile
familyProfileNumber
locale
country {
...CustomEnumValueFragment
}
degree
nickname
street
postcode
city
state
phone
phoneMobile
phoneMobileRequest
phoneMobileVerificationStatus
identityNumber
personnelNumber
level
sports
companyName
companyDepartment
companyFunction
university
community
maritalStatus
skills
specialization
offers
interests
bankAccountHolder
bankBIC
bankIBAN
bankName
bankSEPARef
bankSEPADate
feeKind
feeAmount
paymentMethod
entryDate
exitDate
coachingLicense
customerNumber
dataPrivacyStatementAccepted
datePrivacyStatementAccepted
dataTermsOfUseAccepted
dateTermsOfUseAccepted
statutesAccepted
chatRulesAccepted
publicProfile
remarks
members {
...UserProfileFragment
}
accountActive
chatAccount
activationCode
clubName
clubNumber
team
playerPosition
playerNumber
playerHeight
licenseNumber
realname
customFields
agreedDisplayName
agreedDisplayPhone
agreedDisplayMail
}
}
Variables
{"id": 4, "userProfile": FamilyMemberInput}
Response
{
"data": {
"updateFamilyMember": {
"salutation": CustomEnumValue,
"roles": [CustomEnumValue],
"requestedRoles": [CustomEnumValue],
"departments": [CustomEnumValue],
"groups": [Group],
"id": "abc123",
"externalId": "abc123",
"lastModified": "2007-12-03",
"created": "2007-12-03",
"appId": "xyz789",
"appGroup": "xyz789",
"name": "abc123",
"firstname": "xyz789",
"email": "abc123",
"birthday": "2007-12-03",
"title": "xyz789",
"imageId": "xyz789",
"imageThumbId": "abc123",
"deviceIds": ["xyz789"],
"membershipNumber": "xyz789",
"agreedToAds": false,
"verificationPending": true,
"mailConfirmationPending": false,
"locked": false,
"mainProfile": true,
"familyProfileNumber": "xyz789",
"locale": "abc123",
"country": CustomEnumValue,
"degree": "xyz789",
"nickname": "abc123",
"street": "xyz789",
"postcode": "xyz789",
"city": "abc123",
"state": "xyz789",
"phone": "abc123",
"phoneMobile": "xyz789",
"phoneMobileRequest": "abc123",
"phoneMobileVerificationStatus": "REQUIRED",
"identityNumber": "xyz789",
"personnelNumber": "xyz789",
"level": "xyz789",
"sports": "abc123",
"companyName": "xyz789",
"companyDepartment": "xyz789",
"companyFunction": "abc123",
"university": "abc123",
"community": "xyz789",
"maritalStatus": "xyz789",
"skills": "xyz789",
"specialization": "abc123",
"offers": "abc123",
"interests": "abc123",
"bankAccountHolder": "abc123",
"bankBIC": "xyz789",
"bankIBAN": "xyz789",
"bankName": "xyz789",
"bankSEPARef": "abc123",
"bankSEPADate": "2007-12-03",
"feeKind": "xyz789",
"feeAmount": "abc123",
"paymentMethod": "abc123",
"entryDate": "2007-12-03",
"exitDate": "2007-12-03",
"coachingLicense": true,
"customerNumber": "xyz789",
"dataPrivacyStatementAccepted": "abc123",
"datePrivacyStatementAccepted": "2007-12-03",
"dataTermsOfUseAccepted": "xyz789",
"dateTermsOfUseAccepted": "2007-12-03",
"statutesAccepted": false,
"chatRulesAccepted": true,
"publicProfile": true,
"remarks": "abc123",
"members": [UserProfile],
"accountActive": false,
"chatAccount": true,
"activationCode": "abc123",
"clubName": "xyz789",
"clubNumber": "abc123",
"team": "xyz789",
"playerPosition": "abc123",
"playerNumber": "xyz789",
"playerHeight": 123,
"licenseNumber": "xyz789",
"realname": "xyz789",
"customFields": {},
"agreedDisplayName": false,
"agreedDisplayPhone": true,
"agreedDisplayMail": false
}
}
}
updateGroup
Description
Gruppe ändern (Name oder Mitglieder)
Response
Returns a Group
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
group - GroupInput!
|
Example
Query
mutation updateGroup(
$id: ID!,
$group: GroupInput!
) {
updateGroup(
id: $id,
group: $group
) {
id
appId
name
memberIds
members {
...UserProfileBasicDataFragment
}
leaderIds
leaders {
...UserProfileBasicDataFragment
}
roles
system
numberOfMembers
description
publicGroup
listedGroup
icon {
...ResourceFragment
}
iconId
leader
groupSpaceEnabled
}
}
Variables
{"id": 4, "group": GroupInput}
Response
{
"data": {
"updateGroup": {
"id": "4",
"appId": AppID,
"name": "xyz789",
"memberIds": ["xyz789"],
"members": [UserProfileBasicData],
"leaderIds": ["xyz789"],
"leaders": [UserProfileBasicData],
"roles": ["xyz789"],
"system": false,
"numberOfMembers": 987,
"description": "xyz789",
"publicGroup": true,
"listedGroup": false,
"icon": Resource,
"iconId": "xyz789",
"leader": false,
"groupSpaceEnabled": true
}
}
}
updateGroupSpace
Description
Aktualisiert ein Group Space
Response
Returns a GroupSpace
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
update - GroupSpaceUpdate!
|
Example
Query
mutation updateGroupSpace(
$id: ID!,
$update: GroupSpaceUpdate!
) {
updateGroupSpace(
id: $id,
update: $update
) {
description
name
headerImageUrl
id
conferenceRoomEnabled
fileStoreEnabled
fileStoreMembersWrite
conferenceRoom {
...ConferenceFragment
}
links {
...GroupSpaceLinkFragment
}
members {
...UserProfileBasicDataFragment
}
leaders {
...UserProfileBasicDataFragment
}
leader
badge
}
}
Variables
{"id": 4, "update": GroupSpaceUpdate}
Response
{
"data": {
"updateGroupSpace": {
"description": "xyz789",
"name": "xyz789",
"headerImageUrl": "xyz789",
"id": "4",
"conferenceRoomEnabled": true,
"fileStoreEnabled": true,
"fileStoreMembersWrite": false,
"conferenceRoom": Conference,
"links": [GroupSpaceLink],
"members": [UserProfileBasicData],
"leaders": [UserProfileBasicData],
"leader": false,
"badge": 123
}
}
}
updateIOSAppStoreResource
Description
Aktualisiert eine Datei für den IOS Store
appicon
splasscreen
high_resolution
Response
Returns a ProjectMetadata
Example
Query
mutation updateIOSAppStoreResource(
$file: UploadId!,
$resourceType: String!
) {
updateIOSAppStoreResource(
file: $file,
resourceType: $resourceType
) {
ios_appname
ios_subname
ios_app_short_name
ios_description
ios_keywords
ios_support_url
ios_marketing_url
ios_copyright
ios_category_a
ios_category_b
ios_promotext
ios_appicon_76x76_url
ios_appicon_152x152_url
ios_appicon_180x180_url
ios_appicon_167x167_url
ios_splasscreen_1242x2208_url
ios_appicon_big_url
ios_high_resolution_icon_url
ios_askForUpdate
ios_goinglive
ios_lastUpdate
ios_libVersion
ios_developer_Account
ios_dev_comment
ios_appstore_link
aos_appname
aos_adverttext
aos_website
aos_category
aos_short_description
aos_description
aos_appicon_url
aos_splasscreenicon_url
aos_high_resolution_icon_url
aos_function_icon_url
aos_advert_icon_url
advertisingGraphic_url
aos_askForUpdate
aos_goinglive
aos_lastUpdate
aos_libVersion
aos_dev_comment
aos_firebase_project_id
aos_developer_account
aos_appstore_link
portalAppName
facebookPage
projectDescription
portalAppIconUrl
videoQuotaMB
contractGroup
aos_fcm_server_key
projectType
}
}
Variables
{
"file": UploadId,
"resourceType": "abc123"
}
Response
{
"data": {
"updateIOSAppStoreResource": {
"ios_appname": "xyz789",
"ios_subname": "abc123",
"ios_app_short_name": "abc123",
"ios_description": "abc123",
"ios_keywords": "xyz789",
"ios_support_url": "abc123",
"ios_marketing_url": "xyz789",
"ios_copyright": "xyz789",
"ios_category_a": "xyz789",
"ios_category_b": "xyz789",
"ios_promotext": "abc123",
"ios_appicon_76x76_url": "xyz789",
"ios_appicon_152x152_url": "xyz789",
"ios_appicon_180x180_url": "abc123",
"ios_appicon_167x167_url": "abc123",
"ios_splasscreen_1242x2208_url": "abc123",
"ios_appicon_big_url": "abc123",
"ios_high_resolution_icon_url": "xyz789",
"ios_askForUpdate": true,
"ios_goinglive": "2007-12-03",
"ios_lastUpdate": "2007-12-03",
"ios_libVersion": 987,
"ios_developer_Account": "abc123",
"ios_dev_comment": "xyz789",
"ios_appstore_link": "xyz789",
"aos_appname": "abc123",
"aos_adverttext": "xyz789",
"aos_website": "xyz789",
"aos_category": "abc123",
"aos_short_description": "abc123",
"aos_description": "abc123",
"aos_appicon_url": "abc123",
"aos_splasscreenicon_url": "xyz789",
"aos_high_resolution_icon_url": "xyz789",
"aos_function_icon_url": "abc123",
"aos_advert_icon_url": "abc123",
"advertisingGraphic_url": "xyz789",
"aos_askForUpdate": true,
"aos_goinglive": "2007-12-03",
"aos_lastUpdate": "2007-12-03",
"aos_libVersion": 123,
"aos_dev_comment": "abc123",
"aos_firebase_project_id": "abc123",
"aos_developer_account": "abc123",
"aos_appstore_link": "abc123",
"portalAppName": "xyz789",
"facebookPage": "abc123",
"projectDescription": "abc123",
"portalAppIconUrl": "xyz789",
"videoQuotaMB": "xyz789",
"contractGroup": "abc123",
"aos_fcm_server_key": "xyz789",
"projectType": "xyz789"
}
}
}
updateIOSAppStoreSettings
Description
Aktualisiert die Appstore informationen
Response
Returns a ProjectMetadata
Arguments
| Name | Description |
|---|---|
settings - IOSAppStoreSettingsInput!
|
Example
Query
mutation updateIOSAppStoreSettings($settings: IOSAppStoreSettingsInput!) {
updateIOSAppStoreSettings(settings: $settings) {
ios_appname
ios_subname
ios_app_short_name
ios_description
ios_keywords
ios_support_url
ios_marketing_url
ios_copyright
ios_category_a
ios_category_b
ios_promotext
ios_appicon_76x76_url
ios_appicon_152x152_url
ios_appicon_180x180_url
ios_appicon_167x167_url
ios_splasscreen_1242x2208_url
ios_appicon_big_url
ios_high_resolution_icon_url
ios_askForUpdate
ios_goinglive
ios_lastUpdate
ios_libVersion
ios_developer_Account
ios_dev_comment
ios_appstore_link
aos_appname
aos_adverttext
aos_website
aos_category
aos_short_description
aos_description
aos_appicon_url
aos_splasscreenicon_url
aos_high_resolution_icon_url
aos_function_icon_url
aos_advert_icon_url
advertisingGraphic_url
aos_askForUpdate
aos_goinglive
aos_lastUpdate
aos_libVersion
aos_dev_comment
aos_firebase_project_id
aos_developer_account
aos_appstore_link
portalAppName
facebookPage
projectDescription
portalAppIconUrl
videoQuotaMB
contractGroup
aos_fcm_server_key
projectType
}
}
Variables
{"settings": IOSAppStoreSettingsInput}
Response
{
"data": {
"updateIOSAppStoreSettings": {
"ios_appname": "xyz789",
"ios_subname": "abc123",
"ios_app_short_name": "abc123",
"ios_description": "xyz789",
"ios_keywords": "abc123",
"ios_support_url": "abc123",
"ios_marketing_url": "xyz789",
"ios_copyright": "abc123",
"ios_category_a": "xyz789",
"ios_category_b": "xyz789",
"ios_promotext": "abc123",
"ios_appicon_76x76_url": "xyz789",
"ios_appicon_152x152_url": "xyz789",
"ios_appicon_180x180_url": "abc123",
"ios_appicon_167x167_url": "abc123",
"ios_splasscreen_1242x2208_url": "abc123",
"ios_appicon_big_url": "xyz789",
"ios_high_resolution_icon_url": "xyz789",
"ios_askForUpdate": true,
"ios_goinglive": "2007-12-03",
"ios_lastUpdate": "2007-12-03",
"ios_libVersion": 123,
"ios_developer_Account": "abc123",
"ios_dev_comment": "xyz789",
"ios_appstore_link": "abc123",
"aos_appname": "abc123",
"aos_adverttext": "xyz789",
"aos_website": "abc123",
"aos_category": "xyz789",
"aos_short_description": "xyz789",
"aos_description": "abc123",
"aos_appicon_url": "xyz789",
"aos_splasscreenicon_url": "xyz789",
"aos_high_resolution_icon_url": "abc123",
"aos_function_icon_url": "xyz789",
"aos_advert_icon_url": "xyz789",
"advertisingGraphic_url": "xyz789",
"aos_askForUpdate": false,
"aos_goinglive": "2007-12-03",
"aos_lastUpdate": "2007-12-03",
"aos_libVersion": 123,
"aos_dev_comment": "xyz789",
"aos_firebase_project_id": "xyz789",
"aos_developer_account": "xyz789",
"aos_appstore_link": "xyz789",
"portalAppName": "xyz789",
"facebookPage": "xyz789",
"projectDescription": "abc123",
"portalAppIconUrl": "xyz789",
"videoQuotaMB": "abc123",
"contractGroup": "abc123",
"aos_fcm_server_key": "abc123",
"projectType": "abc123"
}
}
}
updateListComponent
Description
Einstellungen der Liste werden geändert
Response
Returns a ListComponent
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - ListComponentInput
|
Example
Query
mutation updateListComponent(
$id: ID!,
$input: ListComponentInput
) {
updateListComponent(
id: $id,
input: $input
) {
id
appId
lastModified
lastModifiedBy
entries {
...ListEntryFragment
}
androidWidescreenEnabled
backgroundColor
backgroundImageId
backgroundImageUrl
pinList
componentReference
precache
timeBasedPublication
lastExternalDataSourceUpdate
rssUrl
sectionsEnabled
rssTimerEnabled
rssTargetComponentId
rssTargetComponent {
...ComponentReferenceFragment
}
rssError
rssPushChannels
direction
sortField
newsFeedDatasourceId
}
}
Variables
{"id": 4, "input": ListComponentInput}
Response
{
"data": {
"updateListComponent": {
"id": "4",
"appId": AppID,
"lastModified": "2007-12-03",
"lastModifiedBy": "xyz789",
"entries": [ListEntry],
"androidWidescreenEnabled": false,
"backgroundColor": "xyz789",
"backgroundImageId": 4,
"backgroundImageUrl": "xyz789",
"pinList": true,
"componentReference": "abc123",
"precache": false,
"timeBasedPublication": true,
"lastExternalDataSourceUpdate": "2007-12-03",
"rssUrl": "abc123",
"sectionsEnabled": true,
"rssTimerEnabled": false,
"rssTargetComponentId": "4",
"rssTargetComponent": ComponentReference,
"rssError": "xyz789",
"rssPushChannels": ["abc123"],
"direction": "xyz789",
"sortField": "xyz789",
"newsFeedDatasourceId": 4
}
}
}
updateListEntry
Description
Der Eintrag wird im CMS zeilenweise bearbeitet, d.h es werden auch die Felder gesendet, die nicht geändert wurden!
Response
Returns a ListEntry
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - ListEntryInput
|
Example
Query
mutation updateListEntry(
$id: ID!,
$input: ListEntryInput
) {
updateListEntry(
id: $id,
input: $input
) {
id
appId
enabled
componentId
contentUrl
contentId
content {
...IWSFileFragment
}
imageUrl
imageId
previewImageUrl
previewImageId
audioUrl
audioId
audio {
...ResourceFragment
}
extraImageId
extraImageUrl
videoDownloadUrl
videoDownloadId
videoDownload {
...ResourceFragment
}
message
snippet
title
position
pinCode
publicationStart
publicationEnd
description
visibleByProfileRoles
zoomEnabled
facebookEnabled
lastModificationDate
creationDate
link
poiId
backgroundColor
eventStart
eventEnd
address
componentLink {
...ComponentReferenceFragment
}
componentLinkId
}
}
Variables
{"id": 4, "input": ListEntryInput}
Response
{
"data": {
"updateListEntry": {
"id": 4,
"appId": AppID,
"enabled": false,
"componentId": "abc123",
"contentUrl": "xyz789",
"contentId": 4,
"content": IWSFile,
"imageUrl": "abc123",
"imageId": 4,
"previewImageUrl": "abc123",
"previewImageId": "4",
"audioUrl": "xyz789",
"audioId": 4,
"audio": Resource,
"extraImageId": "4",
"extraImageUrl": "xyz789",
"videoDownloadUrl": "abc123",
"videoDownloadId": "4",
"videoDownload": Resource,
"message": "xyz789",
"snippet": "abc123",
"title": "xyz789",
"position": 123,
"pinCode": "xyz789",
"publicationStart": "2007-12-03",
"publicationEnd": "2007-12-03",
"description": "abc123",
"visibleByProfileRoles": ["abc123"],
"zoomEnabled": false,
"facebookEnabled": false,
"lastModificationDate": "2007-12-03",
"creationDate": "2007-12-03",
"link": "xyz789",
"poiId": "abc123",
"backgroundColor": "abc123",
"eventStart": "2007-12-03",
"eventEnd": "2007-12-03",
"address": "xyz789",
"componentLink": ComponentReference,
"componentLinkId": "4"
}
}
}
updateListOrder
Description
Aktualisiert die Sortierung in der Liste
Response
Returns a ListComponent
Example
Query
mutation updateListOrder(
$id: ID!,
$sourceIndex: Int!,
$targetIndex: Int!
) {
updateListOrder(
id: $id,
sourceIndex: $sourceIndex,
targetIndex: $targetIndex
) {
id
appId
lastModified
lastModifiedBy
entries {
...ListEntryFragment
}
androidWidescreenEnabled
backgroundColor
backgroundImageId
backgroundImageUrl
pinList
componentReference
precache
timeBasedPublication
lastExternalDataSourceUpdate
rssUrl
sectionsEnabled
rssTimerEnabled
rssTargetComponentId
rssTargetComponent {
...ComponentReferenceFragment
}
rssError
rssPushChannels
direction
sortField
newsFeedDatasourceId
}
}
Variables
{
"id": "4",
"sourceIndex": 987,
"targetIndex": 987
}
Response
{
"data": {
"updateListOrder": {
"id": "4",
"appId": AppID,
"lastModified": "2007-12-03",
"lastModifiedBy": "abc123",
"entries": [ListEntry],
"androidWidescreenEnabled": true,
"backgroundColor": "abc123",
"backgroundImageId": 4,
"backgroundImageUrl": "xyz789",
"pinList": false,
"componentReference": "xyz789",
"precache": true,
"timeBasedPublication": true,
"lastExternalDataSourceUpdate": "2007-12-03",
"rssUrl": "xyz789",
"sectionsEnabled": true,
"rssTimerEnabled": false,
"rssTargetComponentId": "4",
"rssTargetComponent": ComponentReference,
"rssError": "xyz789",
"rssPushChannels": ["xyz789"],
"direction": "xyz789",
"sortField": "abc123",
"newsFeedDatasourceId": 4
}
}
}
updateLocation
Description
updates location
Response
Returns a Location!
Arguments
| Name | Description |
|---|---|
locationId - ID!
|
|
location - LocationInput
|
Example
Query
mutation updateLocation(
$locationId: ID!,
$location: LocationInput
) {
updateLocation(
locationId: $locationId,
location: $location
) {
id
appId
title
street
postalCode
city
geoLat
geoLng
}
}
Variables
{
"locationId": "4",
"location": LocationInput
}
Response
{
"data": {
"updateLocation": {
"id": 4,
"appId": AppID,
"title": "abc123",
"street": "xyz789",
"postalCode": "xyz789",
"city": "xyz789",
"geoLat": 123.45,
"geoLng": 987.65
}
}
}
updateProduct
Description
Aktualisiert ein Produkt
Response
Returns a ProductDefinition
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - ProductDefinitionInput!
|
Example
Query
mutation updateProduct(
$id: ID!,
$input: ProductDefinitionInput!
) {
updateProduct(
id: $id,
input: $input
) {
id
name
description
imageId
image {
...ResourceFragment
}
type
unitCount
validMonths
price {
...PriceFragment
}
tax {
...TaxFragment
}
paymentProviderReference {
...PaymentProviderReferenceFragment
}
sellCount
}
}
Variables
{"id": 4, "input": ProductDefinitionInput}
Response
{
"data": {
"updateProduct": {
"id": "4",
"name": "abc123",
"description": "abc123",
"imageId": "4",
"image": Resource,
"type": "SINGLE_TICKET",
"unitCount": 123,
"validMonths": 987,
"price": Price,
"tax": Tax,
"paymentProviderReference": PaymentProviderReference,
"sellCount": 987
}
}
}
updateProjectStructureNode
Description
aktualisiert einen Strukturknoten
Response
Returns a ProjectStructureNode
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
update - ProjectStructureNodeUpdateInput!
|
Example
Query
mutation updateProjectStructureNode(
$id: ID!,
$update: ProjectStructureNodeUpdateInput!
) {
updateProjectStructureNode(
id: $id,
update: $update
) {
id
parentId
label
component {
...ComponentReferenceFragment
}
categories {
...ProjectStructureNodeCategoryFragment
}
children
}
}
Variables
{"id": 4, "update": ProjectStructureNodeUpdateInput}
Response
{
"data": {
"updateProjectStructureNode": {
"id": 4,
"parentId": 4,
"label": "abc123",
"component": ComponentReference,
"categories": [ProjectStructureNodeCategory],
"children": ["abc123"]
}
}
}
updatePushChannel
Description
Updated einen Pushkanal
Response
Returns a PushChannel
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
channel - PushChannelInput!
|
Example
Query
mutation updatePushChannel(
$id: ID!,
$channel: PushChannelInput!
) {
updatePushChannel(
id: $id,
channel: $channel
) {
appId
id
number
name
description
imageResource {
...ResourceFragment
}
imageResourceId
soundId
autoSubscribe
initialSubscribe
active
subscriptionCount
allowedGroups {
...GroupFragment
}
allowedGroupIds
subscribed
}
}
Variables
{
"id": "4",
"channel": PushChannelInput
}
Response
{
"data": {
"updatePushChannel": {
"appId": AppID,
"id": "4",
"number": 987,
"name": "xyz789",
"description": "xyz789",
"imageResource": Resource,
"imageResourceId": "xyz789",
"soundId": "abc123",
"autoSubscribe": false,
"initialSubscribe": true,
"active": false,
"subscriptionCount": 123,
"allowedGroups": [Group],
"allowedGroupIds": ["4"],
"subscribed": false
}
}
}
updatePushConfiguration
Description
aktualisiert eine bestehende Push-Configuration
Response
Returns a PushConfiguration!
Arguments
| Name | Description |
|---|---|
input - PushConfigurationInput!
|
Example
Query
mutation updatePushConfiguration($input: PushConfigurationInput!) {
updatePushConfiguration(input: $input) {
forceSendOverPushChannel
preset {
...PushConfigurationPresetFragment
}
}
}
Variables
{"input": PushConfigurationInput}
Response
{
"data": {
"updatePushConfiguration": {
"forceSendOverPushChannel": true,
"preset": PushConfigurationPreset
}
}
}
updatePushHistoryComponent
Description
aktualisiert eine bestehende Push-Historien-Komponente
Response
Returns a PushHistoryComponent!
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - PushHistoryComponentInput!
|
Example
Query
mutation updatePushHistoryComponent(
$id: ID!,
$input: PushHistoryComponentInput!
) {
updatePushHistoryComponent(
id: $id,
input: $input
) {
headerImageUrl
headerImage {
...ResourceFragment
}
headerImageId
limit
dayLimit
backgroundColor
backgroundColor2
messageTextColor
dateTextColor
}
}
Variables
{"id": 4, "input": PushHistoryComponentInput}
Response
{
"data": {
"updatePushHistoryComponent": {
"headerImageUrl": "abc123",
"headerImage": Resource,
"headerImageId": "4",
"limit": 987,
"dayLimit": 987,
"backgroundColor": "xyz789",
"backgroundColor2": "xyz789",
"messageTextColor": "abc123",
"dateTextColor": "abc123"
}
}
}
updatePushNotification
Description
Updated eine Push-Nachricht im System
Response
Returns a PushNotification
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
pushNotification - PushNotificationInput!
|
Example
Query
mutation updatePushNotification(
$id: ID!,
$pushNotification: PushNotificationInput!
) {
updatePushNotification(
id: $id,
pushNotification: $pushNotification
) {
id
status
message
appId
androidUsers
iphoneUsers
androidUsersMax
iphoneUsersMax
username
badge
sheduleDate
sound
soundId
componentId
imageUrl
pending
componentReference {
...ComponentReferenceFragment
}
url
channelIds
channels {
...PushChannelFragment
}
roleIds
departmentIds
groupIds
dispatchDate
mode
publicPushNotification
}
}
Variables
{"id": 4, "pushNotification": PushNotificationInput}
Response
{
"data": {
"updatePushNotification": {
"id": "4",
"status": "SCHEDULED",
"message": "abc123",
"appId": "abc123",
"androidUsers": 123,
"iphoneUsers": 987,
"androidUsersMax": 123,
"iphoneUsersMax": 123,
"username": "xyz789",
"badge": 123,
"sheduleDate": "2007-12-03",
"sound": false,
"soundId": "xyz789",
"componentId": "xyz789",
"imageUrl": "abc123",
"pending": 987,
"componentReference": ComponentReference,
"url": "xyz789",
"channelIds": ["xyz789"],
"channels": [PushChannel],
"roleIds": ["abc123"],
"departmentIds": ["abc123"],
"groupIds": ["abc123"],
"dispatchDate": "2007-12-03",
"mode": "NORMAL",
"publicPushNotification": true
}
}
}
updateResource
Description
Aktualisiert diverse Eigenschaften der Resource
Response
Returns a Resource
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
resource - BasicResourceUpdateInput!
|
Example
Query
mutation updateResource(
$id: ID!,
$resource: BasicResourceUpdateInput!
) {
updateResource(
id: $id,
resource: $resource
) {
id
url
notes
previewImageUrl
creationDate
lastModificationDate
mimeType
title
creator
resourceCategoryId
resourceCategory {
...ResourceCategoryFragment
}
width
height
contentLength
status
deviceId
user_comment
user_title
user_contact
user_category
lat
lng
}
}
Variables
{
"id": "4",
"resource": BasicResourceUpdateInput
}
Response
{
"data": {
"updateResource": {
"id": "4",
"url": "xyz789",
"notes": "xyz789",
"previewImageUrl": "abc123",
"creationDate": "2007-12-03",
"lastModificationDate": "2007-12-03",
"mimeType": "abc123",
"title": "xyz789",
"creator": "abc123",
"resourceCategoryId": "xyz789",
"resourceCategory": ResourceCategory,
"width": 123,
"height": 123,
"contentLength": 123,
"status": "pending",
"deviceId": "xyz789",
"user_comment": "abc123",
"user_title": "abc123",
"user_contact": "xyz789",
"user_category": "abc123",
"lat": "xyz789",
"lng": "xyz789"
}
}
}
updateResourceCategory
Description
aktualisiert eine Kategorie. Aktuell valide Scopes sind: IMAGES oder HTML
Response
Returns a ResourceCategory
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
input - ResourceCategoryInput!
|
Example
Query
mutation updateResourceCategory(
$id: ID!,
$input: ResourceCategoryInput!
) {
updateResourceCategory(
id: $id,
input: $input
) {
id
name
scope
color
lastModificationDate
}
}
Variables
{"id": 4, "input": ResourceCategoryInput}
Response
{
"data": {
"updateResourceCategory": {
"id": 4,
"name": "xyz789",
"scope": "xyz789",
"color": "abc123",
"lastModificationDate": "2007-12-03"
}
}
}
updateStatistics
Response
Returns a UsageStatistics
Example
Query
mutation updateStatistics {
updateStatistics {
appId
storageQuota
storageUsedTotal
storageUsedPercentage
storageFreePercentage
images {
...UsageStatisticItemFragment
}
pages {
...UsageStatisticItemFragment
}
videos {
...UsageStatisticItemFragment
}
audios {
...UsageStatisticItemFragment
}
documents {
...UsageStatisticItemFragment
}
}
}
Response
{
"data": {
"updateStatistics": {
"appId": AppID,
"storageQuota": {},
"storageUsedTotal": {},
"storageUsedPercentage": 987.65,
"storageFreePercentage": 987.65,
"images": UsageStatisticItem,
"pages": UsageStatisticItem,
"videos": UsageStatisticItem,
"audios": UsageStatisticItem,
"documents": UsageStatisticItem
}
}
}
updateStructureNodeCategory
Description
Aktualisiert eine Kategorie
Response
Returns a ProjectStructureNodeCategory
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
category - ProjectStructureNodeCategoryInput!
|
Example
Query
mutation updateStructureNodeCategory(
$id: ID!,
$category: ProjectStructureNodeCategoryInput!
) {
updateStructureNodeCategory(
id: $id,
category: $category
) {
id
name
color
lastModificationDate
}
}
Variables
{"id": 4, "category": ProjectStructureNodeCategoryInput}
Response
{
"data": {
"updateStructureNodeCategory": {
"id": 4,
"name": "abc123",
"color": "abc123",
"lastModificationDate": "2007-12-03"
}
}
}
updateTemplateCoupon
Description
Aktualisiert eine Gutschein Vorlage. Bereits ausgegebene Inszanzen dieser Vorlage werden nicht geändert.
Response
Returns a Coupon
Arguments
| Name | Description |
|---|---|
couponId - ID!
|
|
update - CouponUpdate!
|
Example
Query
mutation updateTemplateCoupon(
$couponId: ID!,
$update: CouponUpdate!
) {
updateTemplateCoupon(
couponId: $couponId,
update: $update
) {
id
bonusBookletId
bonusProgramId
couponSpecificationId
description
enabled
expireDate
imageId
image {
...ResourceFragment
}
imageURL
startupCoupon
startupCouponDispatchDate
status
title
used
usedDate
value
lastModified
}
}
Variables
{"couponId": 4, "update": CouponUpdate}
Response
{
"data": {
"updateTemplateCoupon": {
"id": 4,
"bonusBookletId": "4",
"bonusProgramId": "4",
"couponSpecificationId": 4,
"description": "abc123",
"enabled": false,
"expireDate": "2007-12-03",
"imageId": "4",
"image": Resource,
"imageURL": "xyz789",
"startupCoupon": false,
"startupCouponDispatchDate": "2007-12-03",
"status": "inactive",
"title": "xyz789",
"used": false,
"usedDate": "2007-12-03",
"value": 123,
"lastModified": "2007-12-03"
}
}
}
updateTextWidget
Description
Update widget content
Response
Returns a TextWidget
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
update - TextWidgetInput!
|
Example
Query
mutation updateTextWidget(
$id: ID!,
$update: TextWidgetInput!
) {
updateTextWidget(
id: $id,
update: $update
) {
id
key
title
sections {
...TextWidgetSectionFragment
}
settings {
...WidgetSettingsFragment
}
language
languages
header
footer
}
}
Variables
{"id": 4, "update": TextWidgetInput}
Response
{
"data": {
"updateTextWidget": {
"id": "4",
"key": "xyz789",
"title": "xyz789",
"sections": [TextWidgetSection],
"settings": WidgetSettings,
"language": "abc123",
"languages": ["xyz789"],
"header": "abc123",
"footer": "abc123"
}
}
}
updateTimeSeriesData
Description
einen existierenden Datenpunkt aktualisieren
Response
Returns a TimeSeriesData!
Arguments
| Name | Description |
|---|---|
seriesId - ID!
|
|
data - TimeSeriesDataInput!
|
Example
Query
mutation updateTimeSeriesData(
$seriesId: ID!,
$data: TimeSeriesDataInput!
) {
updateTimeSeriesData(
seriesId: $seriesId,
data: $data
) {
id
timeSeriesId
metaData
timestamp
value
}
}
Variables
{"seriesId": 4, "data": TimeSeriesDataInput}
Response
{
"data": {
"updateTimeSeriesData": {
"id": 4,
"timeSeriesId": "4",
"metaData": {},
"timestamp": "2007-12-03",
"value": 987.65
}
}
}
updateUser
Description
Aktualisiert einen App-Administrator
Example
Query
mutation updateUser(
$id: ID!,
$request: UserInput
) {
updateUser(
id: $id,
request: $request
) {
username
email
currentAppId
permissions
lastLogin
deviceIds
language
technicalAppUser
inactive
appIds
currentAppDivisions
managed
fullName
cnumber
invalidLoginAttemps
password
lastAppLogin
}
}
Variables
{"id": 4, "request": UserInput}
Response
{
"data": {
"updateUser": {
"username": "abc123",
"email": "abc123",
"currentAppId": AppID,
"permissions": ["MANAGE_COMPONENT"],
"lastLogin": "2007-12-03",
"deviceIds": ["xyz789"],
"language": "xyz789",
"technicalAppUser": false,
"inactive": false,
"appIds": ["xyz789"],
"currentAppDivisions": ["abc123"],
"managed": true,
"fullName": "xyz789",
"cnumber": "xyz789",
"invalidLoginAttemps": 123,
"password": "xyz789",
"lastAppLogin": "2007-12-03"
}
}
}
updateUserCurrentApp
Description
Wechselt die aktuelle App
Example
Query
mutation updateUserCurrentApp($appId: AppID!) {
updateUserCurrentApp(appId: $appId) {
username
email
currentAppId
permissions
lastLogin
deviceIds
language
technicalAppUser
inactive
appIds
currentAppDivisions
managed
fullName
cnumber
invalidLoginAttemps
password
lastAppLogin
}
}
Variables
{"appId": AppID}
Response
{
"data": {
"updateUserCurrentApp": {
"username": "abc123",
"email": "xyz789",
"currentAppId": AppID,
"permissions": ["MANAGE_COMPONENT"],
"lastLogin": "2007-12-03",
"deviceIds": ["abc123"],
"language": "abc123",
"technicalAppUser": true,
"inactive": true,
"appIds": ["abc123"],
"currentAppDivisions": ["xyz789"],
"managed": true,
"fullName": "xyz789",
"cnumber": "xyz789",
"invalidLoginAttemps": 123,
"password": "xyz789",
"lastAppLogin": "2007-12-03"
}
}
}
updateUserProfile
Description
Update eines Benutzerprofils
Response
Returns a UserProfile
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
userProfile - UserProfileInput!
|
Example
Query
mutation updateUserProfile(
$id: ID!,
$userProfile: UserProfileInput!
) {
updateUserProfile(
id: $id,
userProfile: $userProfile
) {
salutation {
...CustomEnumValueFragment
}
roles {
...CustomEnumValueFragment
}
requestedRoles {
...CustomEnumValueFragment
}
departments {
...CustomEnumValueFragment
}
groups {
...GroupFragment
}
id
externalId
lastModified
created
appId
appGroup
name
firstname
email
birthday
title
imageId
imageThumbId
deviceIds
membershipNumber
agreedToAds
verificationPending
mailConfirmationPending
locked
mainProfile
familyProfileNumber
locale
country {
...CustomEnumValueFragment
}
degree
nickname
street
postcode
city
state
phone
phoneMobile
phoneMobileRequest
phoneMobileVerificationStatus
identityNumber
personnelNumber
level
sports
companyName
companyDepartment
companyFunction
university
community
maritalStatus
skills
specialization
offers
interests
bankAccountHolder
bankBIC
bankIBAN
bankName
bankSEPARef
bankSEPADate
feeKind
feeAmount
paymentMethod
entryDate
exitDate
coachingLicense
customerNumber
dataPrivacyStatementAccepted
datePrivacyStatementAccepted
dataTermsOfUseAccepted
dateTermsOfUseAccepted
statutesAccepted
chatRulesAccepted
publicProfile
remarks
members {
...UserProfileFragment
}
accountActive
chatAccount
activationCode
clubName
clubNumber
team
playerPosition
playerNumber
playerHeight
licenseNumber
realname
customFields
agreedDisplayName
agreedDisplayPhone
agreedDisplayMail
}
}
Variables
{
"id": "4",
"userProfile": UserProfileInput
}
Response
{
"data": {
"updateUserProfile": {
"salutation": CustomEnumValue,
"roles": [CustomEnumValue],
"requestedRoles": [CustomEnumValue],
"departments": [CustomEnumValue],
"groups": [Group],
"id": "abc123",
"externalId": "abc123",
"lastModified": "2007-12-03",
"created": "2007-12-03",
"appId": "abc123",
"appGroup": "abc123",
"name": "xyz789",
"firstname": "xyz789",
"email": "xyz789",
"birthday": "2007-12-03",
"title": "xyz789",
"imageId": "abc123",
"imageThumbId": "abc123",
"deviceIds": ["abc123"],
"membershipNumber": "xyz789",
"agreedToAds": false,
"verificationPending": true,
"mailConfirmationPending": true,
"locked": true,
"mainProfile": false,
"familyProfileNumber": "xyz789",
"locale": "abc123",
"country": CustomEnumValue,
"degree": "abc123",
"nickname": "abc123",
"street": "abc123",
"postcode": "xyz789",
"city": "xyz789",
"state": "abc123",
"phone": "abc123",
"phoneMobile": "abc123",
"phoneMobileRequest": "xyz789",
"phoneMobileVerificationStatus": "REQUIRED",
"identityNumber": "abc123",
"personnelNumber": "abc123",
"level": "abc123",
"sports": "xyz789",
"companyName": "abc123",
"companyDepartment": "xyz789",
"companyFunction": "xyz789",
"university": "abc123",
"community": "abc123",
"maritalStatus": "abc123",
"skills": "abc123",
"specialization": "abc123",
"offers": "abc123",
"interests": "abc123",
"bankAccountHolder": "xyz789",
"bankBIC": "abc123",
"bankIBAN": "xyz789",
"bankName": "xyz789",
"bankSEPARef": "xyz789",
"bankSEPADate": "2007-12-03",
"feeKind": "abc123",
"feeAmount": "xyz789",
"paymentMethod": "abc123",
"entryDate": "2007-12-03",
"exitDate": "2007-12-03",
"coachingLicense": true,
"customerNumber": "abc123",
"dataPrivacyStatementAccepted": "xyz789",
"datePrivacyStatementAccepted": "2007-12-03",
"dataTermsOfUseAccepted": "xyz789",
"dateTermsOfUseAccepted": "2007-12-03",
"statutesAccepted": true,
"chatRulesAccepted": false,
"publicProfile": false,
"remarks": "xyz789",
"members": [UserProfile],
"accountActive": false,
"chatAccount": false,
"activationCode": "abc123",
"clubName": "abc123",
"clubNumber": "abc123",
"team": "abc123",
"playerPosition": "xyz789",
"playerNumber": "xyz789",
"playerHeight": 987,
"licenseNumber": "abc123",
"realname": "abc123",
"customFields": {},
"agreedDisplayName": false,
"agreedDisplayPhone": true,
"agreedDisplayMail": false
}
}
}
updateUserProfileConfiguration
Description
Speichert Änderungen an der Profil Konfiguration. Partielles Update wird nicht unterstützt
Response
Returns a UserProfileConfiguration!
Arguments
| Name | Description |
|---|---|
input - UserProfileConfigurationInput
|
Example
Query
mutation updateUserProfileConfiguration($input: UserProfileConfigurationInput) {
updateUserProfileConfiguration(input: $input) {
id
rolesVisibleOnRegistration
profileManagerEMail
registrationAllowed
editingAllowed
notifyOnRegistration
userProfileDeletion
supportFamilyMembership
familyMembershipEditable
autodeleteOnExitDate
allowDirectActivation
codeActivation
notifyOnChange
usedFields
unusedFields
customFields
fields {
...WorksheetColumnMetaDataFragment
}
note
roleKeysToVerify
roleKeysToUse
defaultRoles
dataPrivacyStatementUrl
dataTermsOfUseUrl
idCard
usePrivacyPage
useTermsOfUsePage
useGroups
useOpenIDConnect
phoneNumberVerificationRequired
url
birthdayMessageActive
birthdayMessageText
birthdayMessageTargetComponent
}
}
Variables
{"input": UserProfileConfigurationInput}
Response
{
"data": {
"updateUserProfileConfiguration": {
"id": AppID,
"rolesVisibleOnRegistration": false,
"profileManagerEMail": "xyz789",
"registrationAllowed": true,
"editingAllowed": false,
"notifyOnRegistration": false,
"userProfileDeletion": false,
"supportFamilyMembership": true,
"familyMembershipEditable": false,
"autodeleteOnExitDate": true,
"allowDirectActivation": false,
"codeActivation": true,
"notifyOnChange": true,
"usedFields": ["xyz789"],
"unusedFields": ["xyz789"],
"customFields": ["xyz789"],
"fields": [WorksheetColumnMetaData],
"note": "xyz789",
"roleKeysToVerify": ["abc123"],
"roleKeysToUse": ["xyz789"],
"defaultRoles": ["abc123"],
"dataPrivacyStatementUrl": "abc123",
"dataTermsOfUseUrl": "xyz789",
"idCard": false,
"usePrivacyPage": false,
"useTermsOfUsePage": true,
"useGroups": true,
"useOpenIDConnect": false,
"phoneNumberVerificationRequired": true,
"url": "xyz789",
"birthdayMessageActive": true,
"birthdayMessageText": "xyz789",
"birthdayMessageTargetComponent": "abc123"
}
}
}
updateUserProfileFromDevice
Description
Aktualisiert ein Benutzerprofil von einem Gerät
Response
Returns a UserProfile
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
userProfile - UserProfileInput
|
Example
Query
mutation updateUserProfileFromDevice(
$id: ID!,
$userProfile: UserProfileInput
) {
updateUserProfileFromDevice(
id: $id,
userProfile: $userProfile
) {
salutation {
...CustomEnumValueFragment
}
roles {
...CustomEnumValueFragment
}
requestedRoles {
...CustomEnumValueFragment
}
departments {
...CustomEnumValueFragment
}
groups {
...GroupFragment
}
id
externalId
lastModified
created
appId
appGroup
name
firstname
email
birthday
title
imageId
imageThumbId
deviceIds
membershipNumber
agreedToAds
verificationPending
mailConfirmationPending
locked
mainProfile
familyProfileNumber
locale
country {
...CustomEnumValueFragment
}
degree
nickname
street
postcode
city
state
phone
phoneMobile
phoneMobileRequest
phoneMobileVerificationStatus
identityNumber
personnelNumber
level
sports
companyName
companyDepartment
companyFunction
university
community
maritalStatus
skills
specialization
offers
interests
bankAccountHolder
bankBIC
bankIBAN
bankName
bankSEPARef
bankSEPADate
feeKind
feeAmount
paymentMethod
entryDate
exitDate
coachingLicense
customerNumber
dataPrivacyStatementAccepted
datePrivacyStatementAccepted
dataTermsOfUseAccepted
dateTermsOfUseAccepted
statutesAccepted
chatRulesAccepted
publicProfile
remarks
members {
...UserProfileFragment
}
accountActive
chatAccount
activationCode
clubName
clubNumber
team
playerPosition
playerNumber
playerHeight
licenseNumber
realname
customFields
agreedDisplayName
agreedDisplayPhone
agreedDisplayMail
}
}
Variables
{"id": 4, "userProfile": UserProfileInput}
Response
{
"data": {
"updateUserProfileFromDevice": {
"salutation": CustomEnumValue,
"roles": [CustomEnumValue],
"requestedRoles": [CustomEnumValue],
"departments": [CustomEnumValue],
"groups": [Group],
"id": "xyz789",
"externalId": "xyz789",
"lastModified": "2007-12-03",
"created": "2007-12-03",
"appId": "abc123",
"appGroup": "abc123",
"name": "xyz789",
"firstname": "xyz789",
"email": "xyz789",
"birthday": "2007-12-03",
"title": "xyz789",
"imageId": "xyz789",
"imageThumbId": "abc123",
"deviceIds": ["abc123"],
"membershipNumber": "abc123",
"agreedToAds": true,
"verificationPending": true,
"mailConfirmationPending": false,
"locked": true,
"mainProfile": true,
"familyProfileNumber": "xyz789",
"locale": "abc123",
"country": CustomEnumValue,
"degree": "xyz789",
"nickname": "abc123",
"street": "abc123",
"postcode": "xyz789",
"city": "xyz789",
"state": "abc123",
"phone": "abc123",
"phoneMobile": "abc123",
"phoneMobileRequest": "abc123",
"phoneMobileVerificationStatus": "REQUIRED",
"identityNumber": "xyz789",
"personnelNumber": "abc123",
"level": "xyz789",
"sports": "xyz789",
"companyName": "abc123",
"companyDepartment": "abc123",
"companyFunction": "abc123",
"university": "xyz789",
"community": "xyz789",
"maritalStatus": "abc123",
"skills": "xyz789",
"specialization": "abc123",
"offers": "xyz789",
"interests": "abc123",
"bankAccountHolder": "abc123",
"bankBIC": "xyz789",
"bankIBAN": "xyz789",
"bankName": "abc123",
"bankSEPARef": "abc123",
"bankSEPADate": "2007-12-03",
"feeKind": "xyz789",
"feeAmount": "xyz789",
"paymentMethod": "xyz789",
"entryDate": "2007-12-03",
"exitDate": "2007-12-03",
"coachingLicense": true,
"customerNumber": "abc123",
"dataPrivacyStatementAccepted": "xyz789",
"datePrivacyStatementAccepted": "2007-12-03",
"dataTermsOfUseAccepted": "xyz789",
"dateTermsOfUseAccepted": "2007-12-03",
"statutesAccepted": true,
"chatRulesAccepted": false,
"publicProfile": false,
"remarks": "abc123",
"members": [UserProfile],
"accountActive": false,
"chatAccount": true,
"activationCode": "abc123",
"clubName": "xyz789",
"clubNumber": "xyz789",
"team": "abc123",
"playerPosition": "xyz789",
"playerNumber": "abc123",
"playerHeight": 987,
"licenseNumber": "xyz789",
"realname": "xyz789",
"customFields": {},
"agreedDisplayName": false,
"agreedDisplayPhone": false,
"agreedDisplayMail": false
}
}
}
updateUserProfileImage
Description
Lädt ein neues Profilbild hoch und gibt die neue ID zurück
Response
Returns a UserProfile
Example
Query
mutation updateUserProfileImage(
$id: ID!,
$file: UploadId!
) {
updateUserProfileImage(
id: $id,
file: $file
) {
salutation {
...CustomEnumValueFragment
}
roles {
...CustomEnumValueFragment
}
requestedRoles {
...CustomEnumValueFragment
}
departments {
...CustomEnumValueFragment
}
groups {
...GroupFragment
}
id
externalId
lastModified
created
appId
appGroup
name
firstname
email
birthday
title
imageId
imageThumbId
deviceIds
membershipNumber
agreedToAds
verificationPending
mailConfirmationPending
locked
mainProfile
familyProfileNumber
locale
country {
...CustomEnumValueFragment
}
degree
nickname
street
postcode
city
state
phone
phoneMobile
phoneMobileRequest
phoneMobileVerificationStatus
identityNumber
personnelNumber
level
sports
companyName
companyDepartment
companyFunction
university
community
maritalStatus
skills
specialization
offers
interests
bankAccountHolder
bankBIC
bankIBAN
bankName
bankSEPARef
bankSEPADate
feeKind
feeAmount
paymentMethod
entryDate
exitDate
coachingLicense
customerNumber
dataPrivacyStatementAccepted
datePrivacyStatementAccepted
dataTermsOfUseAccepted
dateTermsOfUseAccepted
statutesAccepted
chatRulesAccepted
publicProfile
remarks
members {
...UserProfileFragment
}
accountActive
chatAccount
activationCode
clubName
clubNumber
team
playerPosition
playerNumber
playerHeight
licenseNumber
realname
customFields
agreedDisplayName
agreedDisplayPhone
agreedDisplayMail
}
}
Variables
{"id": 4, "file": UploadId}
Response
{
"data": {
"updateUserProfileImage": {
"salutation": CustomEnumValue,
"roles": [CustomEnumValue],
"requestedRoles": [CustomEnumValue],
"departments": [CustomEnumValue],
"groups": [Group],
"id": "xyz789",
"externalId": "abc123",
"lastModified": "2007-12-03",
"created": "2007-12-03",
"appId": "abc123",
"appGroup": "xyz789",
"name": "abc123",
"firstname": "abc123",
"email": "xyz789",
"birthday": "2007-12-03",
"title": "abc123",
"imageId": "abc123",
"imageThumbId": "xyz789",
"deviceIds": ["abc123"],
"membershipNumber": "abc123",
"agreedToAds": false,
"verificationPending": false,
"mailConfirmationPending": true,
"locked": false,
"mainProfile": false,
"familyProfileNumber": "xyz789",
"locale": "xyz789",
"country": CustomEnumValue,
"degree": "xyz789",
"nickname": "xyz789",
"street": "xyz789",
"postcode": "xyz789",
"city": "xyz789",
"state": "xyz789",
"phone": "abc123",
"phoneMobile": "abc123",
"phoneMobileRequest": "abc123",
"phoneMobileVerificationStatus": "REQUIRED",
"identityNumber": "abc123",
"personnelNumber": "abc123",
"level": "abc123",
"sports": "xyz789",
"companyName": "abc123",
"companyDepartment": "xyz789",
"companyFunction": "xyz789",
"university": "xyz789",
"community": "xyz789",
"maritalStatus": "xyz789",
"skills": "abc123",
"specialization": "abc123",
"offers": "abc123",
"interests": "xyz789",
"bankAccountHolder": "xyz789",
"bankBIC": "xyz789",
"bankIBAN": "abc123",
"bankName": "xyz789",
"bankSEPARef": "xyz789",
"bankSEPADate": "2007-12-03",
"feeKind": "abc123",
"feeAmount": "abc123",
"paymentMethod": "abc123",
"entryDate": "2007-12-03",
"exitDate": "2007-12-03",
"coachingLicense": false,
"customerNumber": "xyz789",
"dataPrivacyStatementAccepted": "abc123",
"datePrivacyStatementAccepted": "2007-12-03",
"dataTermsOfUseAccepted": "abc123",
"dateTermsOfUseAccepted": "2007-12-03",
"statutesAccepted": false,
"chatRulesAccepted": false,
"publicProfile": true,
"remarks": "xyz789",
"members": [UserProfile],
"accountActive": false,
"chatAccount": true,
"activationCode": "abc123",
"clubName": "abc123",
"clubNumber": "abc123",
"team": "xyz789",
"playerPosition": "xyz789",
"playerNumber": "abc123",
"playerHeight": 123,
"licenseNumber": "abc123",
"realname": "xyz789",
"customFields": {},
"agreedDisplayName": false,
"agreedDisplayPhone": false,
"agreedDisplayMail": false
}
}
}
updateUserProfileImageFromDevice
Description
Aktualisiert das Profilbild eines Nutzerprofils von einem Gerät
Example
Query
mutation updateUserProfileImageFromDevice($base64Image: String!) {
updateUserProfileImageFromDevice(base64Image: $base64Image)
}
Variables
{"base64Image": "abc123"}
Response
{"data": {"updateUserProfileImageFromDevice": 4}}
updateWidgetSettings
Description
Update settings
Response
Returns a WidgetSettings
Arguments
| Name | Description |
|---|---|
id - ID!
|
|
settings - WidgetSettingsInput!
|
Example
Query
mutation updateWidgetSettings(
$id: ID!,
$settings: WidgetSettingsInput!
) {
updateWidgetSettings(
id: $id,
settings: $settings
) {
size
dismissible
followUpInDays
backgroundColor
textColor
priority
collapsable
published
projectPhases
projectTypes
serviceLevels
checkable
tag
}
}
Variables
{"id": 4, "settings": WidgetSettingsInput}
Response
{
"data": {
"updateWidgetSettings": {
"size": 123,
"dismissible": false,
"followUpInDays": 123,
"backgroundColor": "abc123",
"textColor": "xyz789",
"priority": 123,
"collapsable": true,
"published": false,
"projectPhases": [123],
"projectTypes": ["STANDARD"],
"serviceLevels": ["NONE"],
"checkable": true,
"tag": "xyz789"
}
}
}
updateWorkbook
Description
Updates Workbook info
Response
Returns a WorkbookComponent
Arguments
| Name | Description |
|---|---|
workbookId - ID!
|
|
input - WorkbookInput!
|
Example
Query
mutation updateWorkbook(
$workbookId: ID!,
$input: WorkbookInput!
) {
updateWorkbook(
workbookId: $workbookId,
input: $input
) {
id
adminMail
worksheetIds
worksheets {
...WorksheetFragment
}
}
}
Variables
{
"workbookId": "4",
"input": WorkbookInput
}
Response
{
"data": {
"updateWorkbook": {
"id": 4,
"adminMail": "xyz789",
"worksheetIds": ["abc123"],
"worksheets": [Worksheet]
}
}
}
updateWorksheet
Description
Aktualisiert das Worksheet
Response
Returns a Worksheet
Arguments
| Name | Description |
|---|---|
worksheetId - ID!
|
|
input - WorksheetInput!
|
Example
Query
mutation updateWorksheet(
$worksheetId: ID!,
$input: WorksheetInput!
) {
updateWorksheet(
worksheetId: $worksheetId,
input: $input
) {
id
name
adminRoleKeys
columns {
...WorksheetColumnMetaDataFragment
}
readAccess
writeAccess
deleteAccess
}
}
Variables
{
"worksheetId": "4",
"input": WorksheetInput
}
Response
{
"data": {
"updateWorksheet": {
"id": 4,
"name": "abc123",
"adminRoleKeys": ["xyz789"],
"columns": [WorksheetColumnMetaData],
"readAccess": "ALWAYS_ALLOW",
"writeAccess": "ALWAYS_ALLOW",
"deleteAccess": "ALWAYS_ALLOW"
}
}
}
updateWorksheetRow
Description
Ändert eine bestehende Row
Response
Returns a GenericRow
Example
Query
mutation updateWorksheetRow(
$worksheetId: ID!,
$id: ID!,
$data: JSON!
) {
updateWorksheetRow(
worksheetId: $worksheetId,
id: $id,
data: $data
) {
id
autoId
sheet
created
lastModified
user
deviceId
userProfileId
userProfile {
...UserProfileBasicDataFragment
}
data
}
}
Variables
{"worksheetId": "4", "id": 4, "data": {}}
Response
{
"data": {
"updateWorksheetRow": {
"id": "4",
"autoId": 987,
"sheet": "xyz789",
"created": "2007-12-03",
"lastModified": "2007-12-03",
"user": "xyz789",
"deviceId": "abc123",
"userProfileId": "xyz789",
"userProfile": UserProfileBasicData,
"data": {}
}
}
}
updateWorkspaceContentWithText
Description
Aktualisiert eine Seite
Response
Returns an WSTextContent
Example
Query
mutation updateWorkspaceContentWithText(
$file: WSFileId!,
$text: String!
) {
updateWorkspaceContentWithText(
file: $file,
text: $text
) {
... on WSCss {
...WSCssFragment
}
... on WSJavaScript {
...WSJavaScriptFragment
}
... on WSPage {
...WSPageFragment
}
... on WSJson {
...WSJsonFragment
}
... on WSDynamicPage {
...WSDynamicPageFragment
}
... on WSMailTemplate {
...WSMailTemplateFragment
}
}
}
Variables
{
"file": WSFileId,
"text": "xyz789"
}
Response
{"data": {"updateWorkspaceContentWithText": WSCss}}
updateWorkspaceFileMeta
Description
Aktualisiert Metadaten einer Datei
Response
Returns an IWSFile
Arguments
| Name | Description |
|---|---|
file - WSFileId!
|
|
meta - WSFileMetaUpdate!
|
Example
Query
mutation updateWorkspaceFileMeta(
$file: WSFileId!,
$meta: WSFileMetaUpdate!
) {
updateWorkspaceFileMeta(
file: $file,
meta: $meta
) {
id
workspaceId
type
key
readonly
name
lastModified
lastModifiedBy
description
size
parentId
}
}
Variables
{
"file": WSFileId,
"meta": WSFileMetaUpdate
}
Response
{
"data": {
"updateWorkspaceFileMeta": {
"id": WSFileId,
"workspaceId": WSFileId,
"type": "ROOT",
"key": "abc123",
"readonly": true,
"name": "xyz789",
"lastModified": "2007-12-03",
"lastModifiedBy": "abc123",
"description": "abc123",
"size": 123,
"parentId": "xyz789"
}
}
}
updateWorkspaceLink
Description
Aktualisiert ein Link
Example
Query
mutation updateWorkspaceLink(
$file: WSFileId!,
$url: String!
) {
updateWorkspaceLink(
file: $file,
url: $url
) {
id
workspaceId
type
key
readonly
name
lastModified
lastModifiedBy
description
size
contentType
url
parentId
}
}
Variables
{
"file": WSFileId,
"url": "xyz789"
}
Response
{
"data": {
"updateWorkspaceLink": {
"id": WSFileId,
"workspaceId": WSFileId,
"type": "ROOT",
"key": "xyz789",
"readonly": true,
"name": "abc123",
"lastModified": "2007-12-03",
"lastModifiedBy": "abc123",
"description": "abc123",
"size": 123,
"contentType": "xyz789",
"url": "xyz789",
"parentId": "xyz789"
}
}
}
uploadPushNotificationCertificate
Description
Im Falle von IOS muss in regelmäßigen Abständen ein Zertifikat erneuert werden.
Response
Returns a PushCertificateInfo
Arguments
| Name | Description |
|---|---|
file - UploadId!
|
Example
Query
mutation uploadPushNotificationCertificate($file: UploadId!) {
uploadPushNotificationCertificate(file: $file) {
expireDate
expiresInDays
}
}
Variables
{"file": UploadId}
Response
{
"data": {
"uploadPushNotificationCertificate": {
"expireDate": "2007-12-03",
"expiresInDays": 987
}
}
}
verifyProfile
Description
Das Profil aus dem JWT Token wird validiert. Sofern die Telefonnummer auch geprüft werden muss, ist diese und der Code mitzugeben.
Example
Query
mutation verifyProfile(
$phoneNumber: String,
$code: String
) {
verifyProfile(
phoneNumber: $phoneNumber,
code: $code
)
}
Variables
{
"phoneNumber": "abc123",
"code": "xyz789"
}
Response
{"data": {"verifyProfile": false}}
Types
AdminUserInput
Description
Eingabe Daten zur Erzeuhung eines neuen Admin Benutzers
Example
{
"username": "xyz789",
"email": "xyz789",
"permissions": ["abc123"],
"currentAppDivisions": ["abc123"],
"appIds": ["abc123"],
"fullName": "xyz789",
"cnumber": "xyz789",
"inactive": false,
"managed": false,
"invalidLoginAttemps": 123,
"technicalAppUser": false
}
AndroidAppStoreSettingsInput
Fields
| Input Field | Description |
|---|---|
aos_appname - String
|
|
aos_adverttext - String
|
|
aos_website - String
|
|
aos_category - String
|
|
aos_short_description - String
|
|
aos_description - String
|
|
aos_askForUpdate - Boolean
|
|
aos_dev_comment - String
|
|
aos_developer_account - String
|
|
aos_goinglive - Date
|
|
aos_lastUpdate - Date
|
|
aos_appstore_link - String
|
|
aos_fcm_server_key - String
|
|
aos_firebase_project_id - String
|
|
aos_libVersion - Int
|
Example
{
"aos_appname": "abc123",
"aos_adverttext": "xyz789",
"aos_website": "abc123",
"aos_category": "xyz789",
"aos_short_description": "xyz789",
"aos_description": "xyz789",
"aos_askForUpdate": true,
"aos_dev_comment": "xyz789",
"aos_developer_account": "abc123",
"aos_goinglive": "2007-12-03",
"aos_lastUpdate": "2007-12-03",
"aos_appstore_link": "abc123",
"aos_fcm_server_key": "xyz789",
"aos_firebase_project_id": "xyz789",
"aos_libVersion": 123
}
AppBackgroundJob
Description
Liefert Informationen zum Fortschritt eines lang laufenden Hintergrundprozesses
Example
{
"id": "4",
"androidMaxHits": 123,
"androidProgress": 123,
"iosMaxHits": 987,
"iosProgress": 123,
"filtered": false
}
AppID
Description
eindeutige Id eines App Projektes
Example
AppID
AppackProject
Description
Das umfassende Container Objekt auf das sich der Vertrag bezieht. Zu einem Projekt gibt es mindestens eine Projektversion - in der Regel die deutsche Sprachversion
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Basis Id für das ganze Projekt z.B 'PreviewApp' |
languages - [Locale]
|
welche Sprachen wurden bestellt |
structureRootId - ID!
|
globaler Strukturbaum. Hier sind alle versionsübergreifenden Komponenten zu finden |
versions - [AppackProjectVersion]
|
Example
{
"id": "4",
"languages": ["zh-cmn-Hans-CN"],
"structureRootId": "4",
"versions": [AppackProjectVersion]
}
AppackProjectVersion
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Zusammengesetzte ID dieser Version z.B 'PreviewApp-de' |
label - String
|
Der Projektname in der jeweiligen Sprache |
language - Locale
|
|
structureRootId - ID!
|
Die Id des Wurzelknotens der Versionsstruktur |
structureNodes - [StructureNode]!
|
alle Strukturknoten dieser Projektversion als flache ungeordnete Liste. Die Hierarchie muss client seitig beginnend mit dem Wurzelknoten(root) aufgebaut werden. |
navigationList - [NavigationNode]
|
Diejenigen Nodes aus dem Strukturbaum, die als Navigationselemente in der App auftauchen sollen. |
Example
{
"id": "4",
"label": "xyz789",
"language": "zh-cmn-Hans-CN",
"structureRootId": 4,
"structureNodes": [StructureNode],
"navigationList": [NavigationNode]
}
AttendeeInput
Description
Die notwendigen Angaben, die für eine Registrierung zu einem Event benötigt werden. Wenn der Teilnehmer bereits über sein Profil bekannt ist, reicht die Angabe der Id und die Daten werden aus dem Profil übernommen.
Fields
| Input Field | Description |
|---|---|
profileId - String
|
Der Teilnehmer ist ein bekanntes Benutzerprofil |
name - String
|
Nachname aus dem Profil |
firstname - String
|
Vorname des Teilnehmer |
email - String
|
eMail des Teilnehmers |
phoneNumber - String
|
Telefonnummer des Teilnehmers |
comment - String
|
Kommentar zum Teilnehmer |
formData - JSON
|
Additional custom fields |
Example
{
"profileId": "abc123",
"name": "xyz789",
"firstname": "abc123",
"email": "abc123",
"phoneNumber": "abc123",
"comment": "xyz789",
"formData": {}
}
BadgeResult
BasicResourceUpdateInput
Example
{
"notes": "abc123",
"status": "pending",
"user_comment": "abc123",
"user_title": "xyz789",
"user_contact": "abc123",
"user_category": "xyz789",
"lat": "xyz789",
"lng": "xyz789",
"resourceCategoryId": "xyz789"
}
BonusBooklet
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
lastModified - Date
|
wann wurde die Komponente erstellt bzw. zuletzt geändert |
bookletImage - Resource
|
Hintergrundbild auf das sich die Stempelkoordinaten beziehen |
bookletImageUrl - String
|
Bild-Url des Booklets |
bookletImageId - ID
|
Hintergrundbild ID |
stampImage - Resource
|
Bild, welches als 'Stempel' verwendet wird |
stampImageUrl - String
|
Stempelbild URL |
stampImageId - ID
|
Stempelbild ID |
backgroundColor - String
|
Farbe |
couponId - ID
|
Coupon |
coupon - Coupon
|
Coupon |
active - Boolean
|
Ist die Ausgabe des Bonusheftes Aktiv? |
stamps - [Stamp]
|
Liste der Stempelfelder. Die Grösse des Arrays korrespondiert mit den Feldern auf dem Hintergrundbild und die Reihenfolge definiert die Reihenfolge in der gestempelt wird." |
expires - Date
|
Gültigkeit des Bonusheftes, entspricht der gültigkeit des Gutscheins |
Example
{
"id": "4",
"lastModified": "2007-12-03",
"bookletImage": Resource,
"bookletImageUrl": "abc123",
"bookletImageId": 4,
"stampImage": Resource,
"stampImageUrl": "abc123",
"stampImageId": 4,
"backgroundColor": "xyz789",
"couponId": 4,
"coupon": Coupon,
"active": false,
"stamps": [Stamp],
"expires": "2007-12-03"
}
BonusBookletInput
Fields
| Input Field | Description |
|---|---|
bookletImageId - ID
|
|
stampImageId - ID
|
|
couponId - ID
|
|
backgroundColor - String
|
Farbe |
active - Boolean
|
Ist die Ausgabe des Bonusheftes Aktiv? |
stamps - [StampInput]
|
Liste der Stempelfelder. Die Grösse des Arrays korrespondiert mit den Feldern auf dem Hintergrundbild und die Reihenfolge definiert die Reihenfolge in der gestempelt wird." |
expires - Date
|
Example
{
"bookletImageId": "4",
"stampImageId": 4,
"couponId": "4",
"backgroundColor": "abc123",
"active": false,
"stamps": [StampInput],
"expires": "2007-12-03"
}
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
Calendar
Description
collection of events that form a logical group.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Primärschlüssel |
appId - AppID!
|
App Kontext dieses Kalenders (Eigentümer App) |
componentIds - [ID]
|
optionale Komponente(n) Zugehörigkeit |
title - String!
|
Titel |
color - Color!
|
HEX color Wert |
description - String
|
Beschreibungstext für die Inhalte des Kalenders |
readerRoles - [CustomEnumValue]
|
wenn gesetzt, dann muss der Nutzer, der diesen Kalender lesen will ein Benutzerprofil haben und mindestens eine der gelisteten Rollen. |
writerRoles - [CustomEnumValue]
|
wenn gesetzt, dann können Einträge in diesem Kalender nur dann erzeugt bzw. bearbeitet werden, wenn der Bearbeiter ein Profil mit mindestens einer der genannten Rollen hat. |
readerGroupIds - [String]
|
Gruppen, welche den Kalender lesen dürfen |
readerGroups - [Group]
|
|
writerGroupIds - [String]
|
Gruppen, welche den Kalender schreiben dürfen |
writerGroups - [Group]
|
|
ownedByGroupId - String
|
Ist gesetzt wenn es sich um einen Gruppenkalender handelt, der nur für die Mitgliedern der Gruppe sichtbar sein soll und standardmäßig nur von den Gruppenleitern zu bearbeiten ist. |
categories - [CalendarEventCategory]
|
Optionale Kategorien des Events |
iCalUrl - Url
|
sofern der Calendar aus einer iCal Quelle erzeugt erzeugt wurde, findet sich hier die Url zur Quelle |
iCalLastSynced - Date
|
Zeitpunkt der letzten iCal Synchronisation |
canRead - Boolean
|
Der Kalender kann vom anfragenden Benutzer gelesen werden, wenn keine Rollen zum lesen definiert wurden oder der Benutzer eine der notwendigen Rollen besitzt. |
canWrite - Boolean
|
Der Kalender kann vom anfragenden Benutzer geschrieben werden, sofern der Kalender nicht extern verwaltet (iCal Feed) und er eine für das Schreiben notwendige Rollen hat. |
hints - [String]
|
Bis zu 3 der beim letzten iCal-Sync aufgetretenen Fehlermeldungen. |
Example
{
"id": 4,
"appId": AppID,
"componentIds": [4],
"title": "xyz789",
"color": Color,
"description": "xyz789",
"readerRoles": [CustomEnumValue],
"writerRoles": [CustomEnumValue],
"readerGroupIds": ["xyz789"],
"readerGroups": [Group],
"writerGroupIds": ["xyz789"],
"writerGroups": [Group],
"ownedByGroupId": "xyz789",
"categories": [CalendarEventCategory],
"iCalUrl": Url,
"iCalLastSynced": "2007-12-03",
"canRead": false,
"canWrite": false,
"hints": ["abc123"]
}
CalendarEvent
Description
der eigentliche Ereignis/Termin/Veranstaltung Eintrag in einem Kalender.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Primärschlüssel |
calendarId - ID!
|
Kalender zu dem dieses Ereignis gehört |
seriesId - ID
|
Serien Id wenn über eine Widerholung erzeugt |
title - String!
|
der Titel |
subTitle - String
|
Untertitel |
description - String
|
ausführlicher Beschreibungstext, der auch HTML Markup enthalten kann |
timeZoneId - String!
|
Zeitenzone, in welcher der Termin stattfindet |
timeZoneOffset - String
|
Zeitzonen Offset zwischen UTC und der Zeitzone des Termins zum Zeitpunkt des Termins unter Berücksichtigung von Sommer/Winterzeit z.B +02:00 bedeutet UTC+2 Stunden |
dateStart - Date
|
erstes bzw. einziges Datum der ersten Auftretens dieses Ereignisses Die Darstellung bzw. Serialisierung in JSON erfolgt immer in UTC Zeitzone |
dateTimeStart - String
|
RFC 5455 reprensentation of the start date |
localDateTimeStart - LocalDateTime
|
Start Zeit im ISO-8601 Format, ohne Angabe der Zeitzone z.B 2007-12-03T10:15:30 Die entspricht der Zeit, so wie der Anwender sie in der Oberfläche eingegeben hat |
dateEnd - Date
|
Ende des ersten Termins. Aus der Differenz zwischen Start und Ende werden jeweils die Endzeitpunkte für alle Serientermine abgeleitet |
dateTimeEnd - String
|
RFC 5455 Darstellung der Ende-Zeit |
localDateTimeEnd - LocalDateTime
|
Ende Zeit im ISO-8601 Format, ohne Angabe der Zeitzone z.B 2007-12-03T11:15:30 |
categories - [CalendarEventCategory]
|
welchen Kategorien aus dem Kalender wurde dieser Event zugeordnet |
registrationRequired - Boolean
|
sind Anmeldungen notwendig |
publicRegistrationAllowed - Boolean
|
sind öffentliche Anmeldungen erlaubt ? |
allDay - Boolean
|
es handelt sich um einen ganztägigen Event |
maxSignUps - Int
|
maximale Anzahl erlaubte Teilnehmer. Wenn nicht gesetzt bedeutet dies, dass es keine Limitierung gibt. |
minSignUps - Int
|
Mindestteilnehmer Anzahl die erforderlich ist, damit der Event stattfinden kann. |
multiSignUpAllowed - Boolean
|
Ist es bei Reservierungen erlaubt, mehrere Teilnehmer (Gruppe/Familie) gleichzeitig anzumelden |
memberListVisibility - MemberListVisibility
|
Sichtbarkeitsregel für die Teilnehmerliste |
maxAdditionalSignUps - Int
|
Anzahl der Begleitpersonen in einer Reservierung/Anmeldung |
registrationCount - Int
|
aktuelle Anzahl an Registrierungen, also die Grösse der Teilnehmerliste |
deadlineStartOffsetMinutes - Int
|
Es gibt einen Anmeldeschluss Minuten vor Veranstaltungsbeginn |
startOfRegistrationOffsetMinutes - Int
|
Anmeldebeginn (Offset in Minuten) vor Veranstaltungsbeginn |
cancelRegistrationDeadlineOffsetMinutes - Int
|
Abmeldeschluss (Offset in Minuten) vor Veranstaltungsbeginn |
requestCount - Int
|
Anzahl der Reservierungsanfragen und damit Indikator für die Nachfrage |
iconImage - MediaReference
|
Verweis auf Icon Bild |
resources - [MediaReference]
|
weitere Anhänge (Bilder, Videos, Audios) für die Detail Ansicht |
location - Location
|
Angabe zum Ort |
detailLink - String
|
Link zu weiterführenden Informationen |
seats - [String]
|
Sitzbelegung im Falle eines registrierungspflichtigen Events. Liefert '[ ]' für leere Sitze oder '[x]' mit der zugeordneten Kartennummer |
ownRegistrations - [CalendarEventRegistration]
|
liefert die Reservierungen, die der User zu diesem Event durchgeführt hat, also alle Plätze für sich und andere |
ownerId - String
|
Shortcut für owner.id sofern keine Details des Profils benötigt werden |
owner - UserProfile
|
Der Benutzer, der den Event erstellt hat |
contactId - String
|
Die Id des Profils der die Rolle des Ansprechpartners/Verantwortlichen hat |
contact - UserProfile
|
Das Profil des Ansprechpartners/Verantwortlichen |
contactGroupId - ID
|
Verantwotliche Gruppe ID |
contactGroup - Group
|
Verantwortliche Gruppe |
canWrite - Boolean
|
Ist der aktuelle Benutzer berechtigt diesen Event zu ändern. |
onlineConference - Boolean
|
Ist dies eine Online-Konferenz? |
notifyEventContactPersonOnSignUp - Boolean
|
Gibt an, ob bei einer Registrierung eine Benachrichtigung an den Verantwortlichen des Events geschickt werden soll. |
issueTicketsUponRegistration - Boolean
|
Wenn gewünscht erhält jeder Teilnehmer eine Registrierungsbestätigung per Mail. Der darin enthaltene QR-Code kann dann zum Check-In für den Termin genutzt werden. |
manageAttendees - Boolean
|
Teilnehmerliste führen |
reminder - CalendarEventReminder
|
Erinnerung |
paymentDocumentation - Boolean
|
Dokumentiert die Bezahlung bei Teilnahme |
registrationFormId - ID
|
ID des Anmeldeformulars |
registrationForm - CalendarRegistrationForm
|
Formular |
products - [ProductDefinition]
|
|
waitingListEnabled - Boolean
|
Warteliste aktiviert? |
badgeEnabled - Boolean
|
Soll das event ein badge auslösen? |
lastModificationDate - Date
|
Letzte änderung |
Example
{
"id": "4",
"calendarId": "4",
"seriesId": 4,
"title": "abc123",
"subTitle": "abc123",
"description": "abc123",
"timeZoneId": "abc123",
"timeZoneOffset": "abc123",
"dateStart": "2007-12-03",
"dateTimeStart": "xyz789",
"localDateTimeStart": "2020-07-19T08:45:59",
"dateEnd": "2007-12-03",
"dateTimeEnd": "xyz789",
"localDateTimeEnd": "2020-07-19T08:45:59",
"categories": [CalendarEventCategory],
"registrationRequired": false,
"publicRegistrationAllowed": true,
"allDay": true,
"maxSignUps": 987,
"minSignUps": 123,
"multiSignUpAllowed": true,
"memberListVisibility": "ADMIN",
"maxAdditionalSignUps": 123,
"registrationCount": 987,
"deadlineStartOffsetMinutes": 987,
"startOfRegistrationOffsetMinutes": 123,
"cancelRegistrationDeadlineOffsetMinutes": 123,
"requestCount": 123,
"iconImage": MediaReference,
"resources": [MediaReference],
"location": Location,
"detailLink": "abc123",
"seats": ["abc123"],
"ownRegistrations": [CalendarEventRegistration],
"ownerId": "abc123",
"owner": UserProfile,
"contactId": "abc123",
"contact": UserProfile,
"contactGroupId": "4",
"contactGroup": Group,
"canWrite": true,
"onlineConference": false,
"notifyEventContactPersonOnSignUp": false,
"issueTicketsUponRegistration": false,
"manageAttendees": true,
"reminder": CalendarEventReminder,
"paymentDocumentation": true,
"registrationFormId": 4,
"registrationForm": CalendarRegistrationForm,
"products": [ProductDefinition],
"waitingListEnabled": true,
"badgeEnabled": true,
"lastModificationDate": "2007-12-03"
}
CalendarEventCategory
CalendarEventCategoryInput
CalendarEventRegistration
Description
Teilnahme Registrierung zu einem Event bzw. Position in der Warteliste
Fields
| Field Name | Description |
|---|---|
id - ID!
|
Primärschlüssel |
creationDate - Date
|
Zeitpunkt an dem die Registrierung eingegangen ist. Dies ist wichtig für eine eventuelle Warteliste bei einem Ereignis mit einer maximalen Teilnehmerzahl |
calendarEventId - ID!
|
Ereignis auf das sich diese Anmeldung bezieht |
seat - Seat!
|
Sitzplatzinformation zu der Reservierung |
comment - String
|
Hinweise des Buchenden zu seiner Anmeldung |
deviceId - String
|
technische ID des Geräts mit dem die Anmeldung durchgeührt wurde Dies kann dazu benutzt werden, dem Benutzer eine Bestätigung per Push Benachrichtigung zu senden. |
clientId - String!
|
bekannter Benutzer(Profil) der die Registrierung durchgeführt hat. Der Benutzer muss nicht selbst ein Teilnehmer sein. |
client - UserProfileBasicData
|
Der bekannte App Nutzer "hinter" der clientId, der die Registrierung durchgeführt hat. |
status - String
|
Der Status der Registrierungsanfrage. Entweder "CONFIRMED" wenn die Registrierung erfolgreich war oder ATTENDED nachdem die Teilnahme bestätigt wurde. |
waitingPosition - Int
|
Wenn der Status QUEUED ist. Position in der Warteschlange. Gibt 0 zurück, wenn der Platz nicht ermittelt werden konnte |
payed - Boolean
|
Dokumentiert ob der Teilnehmer bereits gezahlt hat. |
formData - JSON
|
Additional custom fields |
Example
{
"id": "4",
"creationDate": "2007-12-03",
"calendarEventId": "4",
"seat": Seat,
"comment": "xyz789",
"deviceId": "abc123",
"clientId": "abc123",
"client": UserProfileBasicData,
"status": "abc123",
"waitingPosition": 987,
"payed": true,
"formData": {}
}
CalendarEventRegistrationRequest
Description
Registrieungsanfrage zu einem Termin. Bei der Anfrage werden so viele 'Plätze' reserviert wie es Teilnehmer in der Anfrage gibt. Die Registrierung gelingt nur dann, wenn noch ausreichendes Kontingent für alle Teilnehmer in dieser Anfrage vorhanden ist. Je nachdem, ob für den Termin eine Warteliste verwaltet werden soll, erhält man entsprechend eine Fehlermeldung oder zugeteilte Positionen. Je nach Einstellung des betreffenden Termins werden dabei nur registrierte Benutzerprofile zugelassen oder die eingegeben Daten werden nicht validiert.
Fields
| Input Field | Description |
|---|---|
calendarEventId - ID!
|
Ereignis auf das sich diese Anmeldung bezieht |
attendees - [AttendeeInput]
|
optionale Liste der weiteren Teilnehmer bzw. Begleitpersonen |
Example
{
"calendarEventId": "4",
"attendees": [AttendeeInput]
}
CalendarEventReminder
CalendarEventReminderInput
CalendarEventTemplate
Description
Vorlagen Event auf dessen Basis eine Instanz bzw. eine Serie erzeugt oder geändert werden soll.
Fields
| Input Field | Description |
|---|---|
calendarId - ID
|
ID des Kalenders. Wird nur benötigt, wenn ein Event bzw. eine Serie in einen anderen Kalender verschoben werden soll |
title - String
|
der Titel |
subTitle - String
|
Untertitel |
description - String
|
ausführlicher Beschreibungstext, der auch HTML Markup enthalten kann |
timeZoneId - String!
|
Zeitenzone, in welcher der Termin stattfindet. Default = "Europe/Berlin" |
dateStart - Date
|
Datum des Events bzw. des ersten Auftretens im Fall einer Serie |
dateEnd - Date
|
Optionaler Endzeitpunkt des Events |
categoryIds - [ID]
|
Liste der Kategorien (aus der Menge der beim dem Kalender hinterlegten) die dem Event zugeordnet werden sollen. |
registrationRequired - Boolean
|
erfordert die Teilname eine Registrierung ? |
publicRegistrationAllowed - Boolean
|
sind öffentliche Anmeldungen erlaubt ? |
allDay - Boolean
|
es handelt sich um einen ganztägigen Event |
maxSignUps - Int
|
maximale Anzahl erlaubte Teilnehmer. Wenn nicht gesetzt bedeutet dies, dass es keine Limitierung gibt. |
minSignUps - Int
|
Mindestteilnehmer Anzahl die erforderlich ist, damit der Event stattfinden kann. |
multiSignUpAllowed - Boolean
|
Ist es bei Reservierungen erlaubt, mehrere Teilnehmer (Gruppe/Familie) gleichzeitig anzumelden |
memberListVisibility - MemberListVisibility
|
Sichtbarkeitsregel für die Teilnehmerliste |
notifyEventContactPersonOnSignUp - Boolean
|
Gibt an, ob bei einer Registrierung eine Benachrichtigung an den Verantwortlichen des Events geschickt werden soll. |
issueTicketsUponRegistration - Boolean
|
Wenn gewünscht erhält jeder Teilnehmer eine Registrierungsbestätigung per Mail. Der darin enthaltene QR-Code kann dann zum Check-In für den Termin genutzt werden. |
manageAttendees - Boolean
|
Teilnehmerliste führen |
maxAdditionalSignUps - Int
|
Anzahl der Begleitpersonen in einer Reservierung/Anmeldung |
deadlineStartOffsetMinutes - Int
|
Es gibt einen Anmeldeschluss Minuten vor Veranstaltungsbeginn |
startOfRegistrationOffsetMinutes - Int
|
Anmeldebeginn (Offset in Minuten) vor Veranstaltungsbeginn |
cancelRegistrationDeadlineOffsetMinutes - Int
|
Abmeldeschluss (Offset in Minuten) vor Veranstaltungsbeginn |
locationId - ID
|
optionale Referenz zu einem Veranstaltungsort |
detailLink - String
|
Link zu weiterführenden Informationen |
iconImageId - ID
|
optionale Referenz auf ein Vorschaubild |
resourceIds - [ID]
|
weitere Resource Referenzen für die Detailansicht |
rrule - String
|
for details to the RRULE syntax see https://jakubroztocil.github.io/rrule/ if this is set an implicit seriesId will be created that correlates the cretaed instances. |
onlineConference - Boolean
|
Ist dies eine Online-Konferenz? Dadurch wird ein Raum im Jitsi gebucht. |
contactId - String
|
Die Id des Profils der die Rolle des Ansprechpartners/Verantwortlichen hat |
contactGroupId - String
|
Die Id der Gruppe, welches für dieses Event verantwortlich ist |
reminder - CalendarEventReminderInput
|
Reminder, wann die Teilnehmer an das Event erinnert werden sollen |
paymentDocumentation - Boolean
|
Dokumentiert die Bezahlung bei Teilnahme |
groupRegistration - ID
|
Teilnehmer dieser Gruppe werden automatisch als Teilnehmer in dem Event eingetragen |
registrationFormId - ID
|
Formular, welches bei der Registrierung ausgefüllt werden muss. |
productIds - [ID]
|
Produkte |
waitingListEnabled - Boolean
|
Warteliste aktiviert? |
badgeEnabled - Boolean
|
Soll das event ein badge auslösen? |
Example
{
"calendarId": 4,
"title": "abc123",
"subTitle": "xyz789",
"description": "abc123",
"timeZoneId": "xyz789",
"dateStart": "2007-12-03",
"dateEnd": "2007-12-03",
"categoryIds": [4],
"registrationRequired": true,
"publicRegistrationAllowed": true,
"allDay": true,
"maxSignUps": 987,
"minSignUps": 987,
"multiSignUpAllowed": false,
"memberListVisibility": "ADMIN",
"notifyEventContactPersonOnSignUp": true,
"issueTicketsUponRegistration": true,
"manageAttendees": false,
"maxAdditionalSignUps": 987,
"deadlineStartOffsetMinutes": 123,
"startOfRegistrationOffsetMinutes": 987,
"cancelRegistrationDeadlineOffsetMinutes": 123,
"locationId": 4,
"detailLink": "xyz789",
"iconImageId": 4,
"resourceIds": [4],
"rrule": "abc123",
"onlineConference": true,
"contactId": "abc123",
"contactGroupId": "abc123",
"reminder": CalendarEventReminderInput,
"paymentDocumentation": true,
"groupRegistration": "4",
"registrationFormId": 4,
"productIds": [4],
"waitingListEnabled": true,
"badgeEnabled": true
}
CalendarInput
Description
Eingabe Daten zur Erzeugung einer Kalender Instanz.
Fields
| Input Field | Description |
|---|---|
title - String
|
Titel des Kalenders |
description - String
|
Beschreibungstext für die Inhalte des Kalenders |
readerRoles - [RoleRef]
|
Optionale Liste von Rollen Keys (aus der aktuellen App) für welche der Calender sichtbar sein soll. Wenn nichts angegeben wird ist es damit ein öffentlicher Kalender. |
writerRoles - [RoleRef]
|
wenn gesetzt, dann können Einträge in diesem Kalender nur dann erzeugt bzw. bearbeitet werden, wenn der Bearbeiter ein Profil mit mindestens einer der genannten Rollen hat. |
readerGroups - [String]
|
Gruppen, welche den Kalender lesen dürfen |
writerGroups - [String]
|
Gruppen, welche den Kalender schreiben dürfen |
componentIds - [ID]
|
optionale Einschränkung auf Komponente(n) |
color - Color
|
Farbe des Kalenders |
Example
{
"title": "xyz789",
"description": "abc123",
"readerRoles": [RoleRef],
"writerRoles": [RoleRef],
"readerGroups": ["abc123"],
"writerGroups": ["abc123"],
"componentIds": [4],
"color": Color
}
CalendarRegistrationForm
Example
{
"name": "abc123",
"id": "4",
"header": "xyz789",
"footer": "abc123",
"fields": [WorksheetColumnMetaData],
"usedInEventsCount": {}
}
CalendarRegistrationFormInput
Fields
| Input Field | Description |
|---|---|
name - String
|
Name des Formulars |
fields - [WorksheetColumnMetaDataInput]
|
Feldkonfiguration |
header - String
|
Text vor dem Formular |
footer - String
|
Text nach dem Formular |
Example
{
"name": "xyz789",
"fields": [WorksheetColumnMetaDataInput],
"header": "abc123",
"footer": "xyz789"
}
Captcha
CaptchaSolution
ChatChannel
Fields
| Field Name | Description |
|---|---|
id - ID!
|
eindeutige Id der Komponente |
active - Boolean
|
Ist der Channel aktiv oder deaktiviert |
componentId - String
|
|
icon - Resource
|
Löst die Bild-Resource auf |
iconId - ID
|
|
iconUrl - String
|
|
backgroundImageId - ID
|
|
backgroundImage - Resource
|
Löst die Bild-Resource auf |
backgroundImageUrl - String
|
|
backgroundColor - String
|
|
label - String
|
Bezeichnung |
pinCode - String
|
PinCode zum Teilnehmen an der Gruppe |
readOnly - Boolean
|
Schreibgeschützt. (nur Admin kann schreiben) |
allowPseudonyms - Boolean
|
Pseudonyme erlauben? |
visibleByProfileRoles - [String]
|
Gibt an welche Rollen diesen Kanal sehen können |
visibleByDepartments - [String]
|
Gibt an welche Departments diesen Kanal sehen können |
autoSubscribedRoles - [String]
|
Nutzer mit dieser Rolle, werden automatisch am Kanal subscribed |
autoSubscribedGroups - [String]
|
Nutzer in dieser Gruppe, werden automatisch am Kanal subscribed |
subscriptionsCount - Long
|
Berechnete Anzahl an Teilnehmern |
directAdminProfilesIds - [String]
|
Direkte Admin-Profile |
directAdminProfiles - [UserProfile]
|
Direkte Admin-Profile |
adminGroupId - ID
|
Admin-Gruppe |
adminGroup - Group
|
Admin-Gruppe |
Example
{
"id": 4,
"active": false,
"componentId": "abc123",
"icon": Resource,
"iconId": 4,
"iconUrl": "abc123",
"backgroundImageId": "4",
"backgroundImage": Resource,
"backgroundImageUrl": "abc123",
"backgroundColor": "xyz789",
"label": "abc123",
"pinCode": "xyz789",
"readOnly": false,
"allowPseudonyms": true,
"visibleByProfileRoles": ["xyz789"],
"visibleByDepartments": ["xyz789"],
"autoSubscribedRoles": ["xyz789"],
"autoSubscribedGroups": ["xyz789"],
"subscriptionsCount": {},
"directAdminProfilesIds": ["xyz789"],
"directAdminProfiles": [UserProfile],
"adminGroupId": 4,
"adminGroup": Group
}
ChatChannelInput
Fields
| Input Field | Description |
|---|---|
active - Boolean
|
Ist der Channel aktiv oder deaktiviert |
iconId - ID
|
Löst die Bild-Resource auf |
iconUrl - String
|
|
backgroundImageId - ID
|
|
backgroundColor - String
|
|
label - String!
|
Bezeichnung |
pinCode - String
|
PinCode zum Teilnehmen an der Gruppe |
readOnly - Boolean
|
Schreibgeschützt. (nur Admin kann schreiben) |
allowPseudonyms - Boolean
|
Pseudonyme erlauben? |
visibleByProfileRoles - [String]
|
Gibt an welche Rollen diesen Kanal sehen können |
visibleByDepartments - [String]
|
Gibt an welche Departments diesen Kanal sehen können |
autoSubscribedRoles - [String]
|
Nutzer mit dieser Rolle, werden automatisch am Kanal subscribed |
autoSubscribedGroups - [String]
|
Nutzer in dieser Gruppe, werden automatisch am Kanal subscribed |
directAdminProfilesIds - [String]
|
Direkte Admin-Profile |
adminGroupId - ID
|
Admin-Gruppe |
Example
{
"active": true,
"iconId": "4",
"iconUrl": "abc123",
"backgroundImageId": "4",
"backgroundColor": "abc123",
"label": "abc123",
"pinCode": "abc123",
"readOnly": true,
"allowPseudonyms": true,
"visibleByProfileRoles": ["xyz789"],
"visibleByDepartments": ["xyz789"],
"autoSubscribedRoles": ["xyz789"],
"autoSubscribedGroups": ["xyz789"],
"directAdminProfilesIds": ["abc123"],
"adminGroupId": "4"
}
ChatComponent
Fields
| Field Name | Description |
|---|---|
id - ID!
|
eindeutige Id der Komponente |
appId - AppID!
|
|
channels - [ChatChannel]
|
|
lastModified - Date
|
wann wurde die Komponente erstellt bzw. zuletzt geändert |
lastModifiedBy - String
|
wer hat die letzte Änderung durchgeführt |
chatHomeUrl - String
|
Url zu der WebApp |
defaultAvatarUrl - String
|
|
helpPageId - String
|
|
helpPage - IWSFile
|
|
helpPageUrl - String
|
|
rulesPageId - String
|
|
rulesPage - IWSFile
|
|
rulePageUrl - String
|
|
accentColor - String
|
|
version - Int
|
|
showContacts - Boolean
|
|
restrictedShowContactRoles - [String]
|
|
allowDirectCommunication - Boolean
|
|
allowGroups - Boolean
|
|
allowVideo - Boolean
|
|
allowPoll - Boolean
|
|
allowPollForNonAdmin - Boolean
|
|
restrictedDirectCommunicationRoles - [String]
|
|
restrictDirectCommunicationToSameRole - Boolean
|
Example
{
"id": 4,
"appId": AppID,
"channels": [ChatChannel],
"lastModified": "2007-12-03",
"lastModifiedBy": "abc123",
"chatHomeUrl": "xyz789",
"defaultAvatarUrl": "xyz789",
"helpPageId": "abc123",
"helpPage": IWSFile,
"helpPageUrl": "xyz789",
"rulesPageId": "abc123",
"rulesPage": IWSFile,
"rulePageUrl": "xyz789",
"accentColor": "abc123",
"version": 123,
"showContacts": false,
"restrictedShowContactRoles": ["xyz789"],
"allowDirectCommunication": true,
"allowGroups": false,
"allowVideo": false,
"allowPoll": true,
"allowPollForNonAdmin": true,
"restrictedDirectCommunicationRoles": [
"abc123"
],
"restrictDirectCommunicationToSameRole": false
}
ChatComponentInput
Fields
| Input Field | Description |
|---|---|
chatHomeUrl - String
|
|
defaultAvatarUrl - String
|
|
helpPageUrl - String
|
|
helpPageId - String
|
|
rulesPageId - String
|
|
accentColor - String
|
|
version - Int
|
|
showContacts - Boolean
|
|
restrictedShowContactRoles - [String]
|
|
allowDirectCommunication - Boolean
|
|
allowGroups - Boolean
|
|
allowVideo - Boolean
|
|
allowPoll - Boolean
|
|
allowPollForNonAdmin - Boolean
|
|
restrictedDirectCommunicationRoles - [String]
|
|
restrictDirectCommunicationToSameRole - Boolean
|
Example
{
"chatHomeUrl": "xyz789",
"defaultAvatarUrl": "xyz789",
"helpPageUrl": "xyz789",
"helpPageId": "abc123",
"rulesPageId": "xyz789",
"accentColor": "xyz789",
"version": 123,
"showContacts": true,
"restrictedShowContactRoles": ["abc123"],
"allowDirectCommunication": true,
"allowGroups": false,
"allowVideo": true,
"allowPoll": true,
"allowPollForNonAdmin": false,
"restrictedDirectCommunicationRoles": [
"xyz789"
],
"restrictDirectCommunicationToSameRole": true
}
Color
Description
ein HEX colr Wert. '#ff0000'
Example
Color
ComponentReference
Example
{
"name": "xyz789",
"ref": "xyz789",
"icon": "xyz789",
"iconSet": "abc123",
"iconUrl": "xyz789",
"title": "xyz789",
"type": "TextImage",
"typeMetaData": "abc123",
"state": "PUBLIC",
"badgeEnabled": true,
"visibleByProfileRoles": ["abc123"],
"visibleByProfileGroups": ["abc123"]
}
ComponentReferenceType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"TextImage"
ComponentState
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"PUBLIC"
Conference
Description
collection of events that form a logical group.
Example
{
"id": "4",
"room": "abc123",
"url": "xyz789",
"guestUrl": "xyz789",
"end": "2007-12-03",
"phonePin": ConferencePhonePin
}
ConferenceInput
Example
{
"id": 4,
"room": "xyz789",
"end": "2007-12-03",
"phonePin": false
}
ConferencePhonePin
Fields
| Field Name | Description |
|---|---|
pin - Long!
|
Pin |
Example
{"pin": {}}
Coupon
Description
Ein Gutschein bzw. eine Vorlage dazu
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
bonusBookletId - ID
|
Gesetzt, wenn der Gutschein zu einem Bonusheft gehört |
bonusProgramId - ID
|
Gesetzt, wenn der Gutschein zu einem Bonusprogram gehört |
couponSpecificationId - ID
|
Coupon-ID |
description - String
|
Beschreibung des Gutscheins |
enabled - Boolean
|
true, wenn der Gutschein aktiv ist |
expireDate - Date
|
Ablaufdatum des Gutscheins |
imageId - ID
|
Bild des Gutscheins |
image - Resource
|
|
imageURL - String
|
|
startupCoupon - Boolean
|
Gutschein wird automatisch ausgegeben |
startupCouponDispatchDate - Date
|
Gutschein wrid ab Datum automatisch ausgegeben |
status - CouponStatus
|
Gutschein-Status |
title - String
|
Gutschein-Titel |
used - Boolean
|
Ist der Gutschein bereits eingelöst? |
usedDate - Date
|
Datum, wann der Gutschein eingelöst wurde |
value - Int
|
Wert des Gutscheins |
lastModified - Date
|
Letzte Änderung |
Example
{
"id": 4,
"bonusBookletId": 4,
"bonusProgramId": 4,
"couponSpecificationId": "4",
"description": "abc123",
"enabled": true,
"expireDate": "2007-12-03",
"imageId": 4,
"image": Resource,
"imageURL": "xyz789",
"startupCoupon": false,
"startupCouponDispatchDate": "2007-12-03",
"status": "inactive",
"title": "xyz789",
"used": true,
"usedDate": "2007-12-03",
"value": 123,
"lastModified": "2007-12-03"
}
CouponStatistic
Fields
| Field Name | Description |
|---|---|
couponSpecificationId - ID!
|
Id der Gutschein-Vorlage |
couponUrl - String!
|
|
title - String!
|
Titel |
dispatchedCoupons - Int!
|
Anzahl der ausgegebenen Instanzen |
activeCoupons - Int!
|
davon aktiv |
inactiveCoupons - Int!
|
davon inaktiv |
expiredCoupons - Int!
|
abgelaufen |
cashedCoupons - Int!
|
eingelöste |
Example
{
"couponSpecificationId": 4,
"couponUrl": "abc123",
"title": "abc123",
"dispatchedCoupons": 987,
"activeCoupons": 123,
"inactiveCoupons": 123,
"expiredCoupons": 123,
"cashedCoupons": 987
}
CouponStatus
Values
| Enum Value | Description |
|---|---|
|
|
Inaktiv |
|
|
Aktiv |
|
|
Wird verarbeitet |
|
|
Bereits eingelöst |
|
|
Abgelaufen |
Example
"inactive"
CouponTemplate
Description
Gutschein-Vorlage auf dessen Basis die Gutschein Instanzen dann erzeugt werden
Fields
| Input Field | Description |
|---|---|
imageId - ID!
|
Bild des Gutscheins |
description - String
|
Beschreibung des Gutscheins |
startupCoupon - Boolean
|
Gutschein wird automatisch ausgegeben |
startupCouponDispatchDate - Date
|
Gutschein wrid ab Datum automatisch ausgegeben |
expireDate - Date
|
Ablaufdatum des Gutscheins |
title - String!
|
Gutschein-Titel |
value - Int
|
Wert des Gutscheins |
Example
{
"imageId": "4",
"description": "abc123",
"startupCoupon": true,
"startupCouponDispatchDate": "2007-12-03",
"expireDate": "2007-12-03",
"title": "xyz789",
"value": 123
}
CouponUpdate
Description
Felder, die bei einer Gutschein-Vorlage geändert werden können. Änderungen greifen nicht für bereits vorhandene Gutschein-Instanuzen.
Fields
| Input Field | Description |
|---|---|
title - String!
|
Gutschein-Titel |
description - String!
|
Beschreibung des Gutscheins |
expireDate - Date!
|
Ablaufdatum des Gutscheins |
startupCoupon - Boolean!
|
Gutschein wird automatisch ausgegeben |
startupCouponDispatchDate - Date!
|
Gutschein wrid ab Datum automatisch ausgegeben |
imageId - ID!
|
Bild des Gutscheins |
value - Int!
|
Wert des Gutscheins |
Example
{
"title": "xyz789",
"description": "xyz789",
"expireDate": "2007-12-03",
"startupCoupon": true,
"startupCouponDispatchDate": "2007-12-03",
"imageId": 4,
"value": 987
}
CustomEnum
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
keys - [String]!
|
|
locales - [String]!
|
|
translations - [EnumTranslation]
|
Example
{
"id": "4",
"keys": ["xyz789"],
"locales": ["xyz789"],
"translations": [EnumTranslation]
}
CustomEnumKeyInput
Description
Zu einer Aufzählung, z.B Abteilungen oder angepasste Rollen werden neue Keys eingefügt.
Example
{
"enumId": "abc123",
"enumKey": "abc123",
"locales": ["xyz789"],
"values": ["abc123"]
}
CustomEnumValue
Description
Verweis auf einen Wert in einer benutzerdefinierten Aufzählung
Example
{
"enumId": "xyz789",
"enumKey": "xyz789",
"value": "abc123"
}
CustomEnumValueInput
Date
Description
ein Datum im ISO Format mit Zeitzonen Angabe
Example
"2007-12-03"
DateRange
DeviceInfo
Example
{
"deviceId": "abc123",
"adminDevice": true,
"appId": "xyz789",
"locale": "xyz789",
"iosPushToken": "abc123",
"aosPushToken": "abc123",
"pin": "abc123",
"osVersion": "abc123",
"deviceName": "xyz789",
"deviceModel": "abc123",
"deviceSystem": "xyz789",
"created": "2007-12-03",
"lastConnect": "2007-12-03"
}
DeviceSummary
Description
Eine Kurzinfo zu einem mit dem Benutzerprofil verknüpften Gerät
Example
{
"deviceId": "xyz789",
"lastConnect": "2007-12-03",
"osVersion": "xyz789",
"deviceName": "abc123",
"deviceModel": "xyz789",
"deviceSystem": "abc123",
"pin": "xyz789"
}
Direction
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ASC"
DispatchMode
Values
| Enum Value | Description |
|---|---|
|
|
nur admin Geräte |
|
|
User, die den Gutschein noch nicht hatten |
|
|
Benutzer ohne einen aktiven Gutschein |
|
|
App-Nutzer, die eine der genannten Rollen haben |
|
|
App-Nutzer, die Mitglied in einer der genannten Gruppen sind |
|
|
Alle Geräte der App |
Example
"adminDevices"
Division
DownloadHistory
Fields
| Field Name | Description |
|---|---|
appId - AppID!
|
|
history - [DownloadHistoryEntry]
|
der historische Verlauf |
Example
{
"appId": AppID,
"history": [DownloadHistoryEntry]
}
DownloadHistoryEntry
DownloadStatsData
Description
spezielle TimeSeries welche den Installationsverlauf je App und Tag enthält. Siehe Dashboard/Download Statistik
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
appId - AppID!
|
|
ts - Date!
|
|
day - String
|
Der Tag in ISO Form JJJJ-MM-DD |
total - Int!
|
Summierte Anzahl der bekannten Installationen |
android - Int!
|
Summe der Android Installationen |
android_delta - Int!
|
Auf wievielen Android-Geräten wurde die App an diesem Tag neu installiert |
ios_delta - Int!
|
Auf wievielen iOS-Geräten wurde die App an diesem Tag neu installiert |
ios - Int!
|
Summe der IOS Installationen |
Example
{
"id": "4",
"appId": AppID,
"ts": "2007-12-03",
"day": "abc123",
"total": 123,
"android": 123,
"android_delta": 123,
"ios_delta": 987,
"ios": 987
}
EnumTranslation
EnumValue
FSFile
Fields
| Field Name | Description |
|---|---|
fsId - FSId!
|
Id des FileStores zu dem dieses File gehört |
id - FSFileId!
|
Id des Files |
parentId - FSFileId
|
Id des übergeordneten Folders oder Null, wenn auf der Root Ebene |
contentType - String
|
Mimetype des Files, z.B application/pdf. Nicht gesetzt Bei Foldern |
name - String!
|
Der Dateiname, der angezeigt werden soll |
contentLength - Long
|
Größe der Datei |
directory - Boolean
|
true, wenn es ein Verzeichnis ist |
status - FSFileStatus
|
Status der Datei |
created - Date
|
Erstellt am |
createdBy - String
|
Erstellt von |
lastModified - Date
|
Zuletzt geändert |
lastModifiedBy - String
|
Zuletzt geändert von |
eTag - String
|
eTag |
uploadUrl - Url
|
Put-URL to update the file |
downloadUrl - Url
|
URL of the file |
thumbnailImageUrl - Url
|
Vorschaubild |
Example
{
"fsId": FSId,
"id": FSFileId,
"parentId": FSFileId,
"contentType": "xyz789",
"name": "abc123",
"contentLength": {},
"directory": true,
"status": "READY",
"created": "2007-12-03",
"createdBy": "abc123",
"lastModified": "2007-12-03",
"lastModifiedBy": "xyz789",
"eTag": "xyz789",
"uploadUrl": Url,
"downloadUrl": Url,
"thumbnailImageUrl": Url
}
FSFileId
Description
eindeutige Id zu einem File innerhalb eines FileStore
Example
FSFileId
FSFileStatus
Values
| Enum Value | Description |
|---|---|
|
|
File vollständig hochgeladen |
|
|
File noch nicht hochgeladen |
|
|
Upload läuft |
Example
"READY"
FSFileUploadRequest
Description
Upload
Example
{
"contentLength": {},
"name": "xyz789",
"contentType": "xyz789"
}
FSId
Description
Id eines Filestore
Example
FSId
FamilyMemberInput
Description
minimale Angaben zur Erzeugung des Profils eines Familienmitgliedes. In der Regel Kinder, die noch keine eigene Mail Adresse haben.
Example
{
"salutation": CustomEnumValueInput,
"name": "abc123",
"firstname": "xyz789",
"email": "xyz789",
"birthday": "2007-12-03",
"membershipNumber": "abc123"
}
FileStore
Fields
| Field Name | Description |
|---|---|
id - ID!
|
eindeutige Id. Diese ist identisch mit der Id des 'Besitzers' also z.B einer Gruppe oder einem User Profil |
files - [FSFile]
|
Die Files in undefinierter Reihenfolge, da die Sortierung in der Oberfläche erfolgt |
writeAccess - Boolean
|
Hat der aktuelle Nutzer Schreibzugriff |
operationLogAccess - Boolean
|
Hat Zugriff auf die Protokolle |
acceptedFileTypes - [String]
|
Erlaubte Dateitypen |
Example
{
"id": 4,
"files": [FSFile],
"writeAccess": false,
"operationLogAccess": false,
"acceptedFileTypes": ["abc123"]
}
FileStoreOperationLog
Example
{
"id": "4",
"created": "2007-12-03",
"executor": "abc123",
"source": "xyz789",
"destination": "xyz789",
"operationType": "CREATE_FILE",
"downloadUrl": Url
}
FileStoreOperationType
Values
| Enum Value | Description |
|---|---|
|
|
Datei erstellt |
|
|
Verzeichnis erstellt |
|
|
Löschoperation |
|
|
Rename-Operation |
|
|
Verschiebeoperation |
Example
"CREATE_FILE"
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.
Example
123.45
GenericRow
Example
{
"id": "4",
"autoId": 123,
"sheet": "abc123",
"created": "2007-12-03",
"lastModified": "2007-12-03",
"user": "xyz789",
"deviceId": "xyz789",
"userProfileId": "xyz789",
"userProfile": UserProfileBasicData,
"data": {}
}
Group
Description
Eine Gruppe von Benutzern, z.B eine Manschaft oder eine Abteilung
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
appId - AppID!
|
|
name - String!
|
Name der Grupe |
memberIds - [String]
|
Mitglieder der Gruppe |
members - [UserProfileBasicData]
|
Profile der Mitglieder der Gruppe |
leaderIds - [String]
|
Ids der Gruppenleiter |
leaders - [UserProfileBasicData]
|
Gruppeleiter |
roles - [String]
|
" Rollenbasierte Gruppe |
system - Boolean
|
" Gibt ab, ob es sich um eine Systemrolle handelt. Diese können aus dem System nicht gelöscht werden. |
numberOfMembers - Int
|
Anzahl der Mitglieder |
description - String
|
Individuelle Beschreibung der Gruppe |
publicGroup - Boolean
|
In öffentliche Gruppen kann man ohne Einladung / Anfrage eintreten |
listedGroup - Boolean
|
|
icon - Resource
|
Gruppensymbol |
iconId - String
|
Gruppensymbol-Id |
leader - Boolean
|
Ist das aktuelle Profil Gruppenleiter |
groupSpaceEnabled - Boolean
|
Ist ein Group-Space angelegt? |
Example
{
"id": "4",
"appId": AppID,
"name": "xyz789",
"memberIds": ["abc123"],
"members": [UserProfileBasicData],
"leaderIds": ["xyz789"],
"leaders": [UserProfileBasicData],
"roles": ["xyz789"],
"system": false,
"numberOfMembers": 123,
"description": "xyz789",
"publicGroup": true,
"listedGroup": false,
"icon": Resource,
"iconId": "xyz789",
"leader": true,
"groupSpaceEnabled": true
}
GroupAccessInvitationRequestInput
GroupAccessRequest
GroupAccessRequestAnswerInput
Fields
| Input Field | Description |
|---|---|
answer - GroupAccessRequestAnswerType!
|
|
message - String
|
|
requestId - ID!
|
Example
{
"answer": "ALLOW",
"message": "abc123",
"requestId": "4"
}
GroupAccessRequestAnswerType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ALLOW"
GroupAccessRequestInput
GroupInput
Description
Input zum Erzeugen einer Gruppe
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
memberIds - [ID]
|
|
leaderIds - [ID]
|
|
roles - [String]
|
|
description - String
|
Individuelle Beschreibung der Gruppe |
publicGroup - Boolean
|
In öffentliche Gruppen kann man ohne Einladung / Anfrage eintreten |
listedGroup - Boolean
|
Soll diese Gruppe in der Gruppensuche aufgelistet werden |
iconId - String
|
Gruppensymbol-Id |
groupSpaceEnabled - Boolean
|
Aktiviert / Deaktiviert den Group Space |
Example
{
"name": "abc123",
"memberIds": ["4"],
"leaderIds": ["4"],
"roles": ["abc123"],
"description": "xyz789",
"publicGroup": true,
"listedGroup": false,
"iconId": "abc123",
"groupSpaceEnabled": true
}
GroupSpace
Fields
| Field Name | Description |
|---|---|
description - String
|
Beschreibung |
name - String
|
Name |
headerImageUrl - String
|
Bild |
id - ID
|
Identifier |
conferenceRoomEnabled - Boolean
|
Videokonferenz aktiviert |
fileStoreEnabled - Boolean
|
FileStore Aktiviert |
fileStoreMembersWrite - Boolean
|
Wenn gesetzt, dürfen alle Mitglieder Schreiboperationen auf dem Filestore durchführen. Wenn nicht, dürfen nur die Gruppenleiter Schreiboperationen durchführen. |
conferenceRoom - Conference
|
Videokonferenz |
links - [GroupSpaceLink]
|
alle Referenzierten Module bzw. Chat-Kanäle |
members - [UserProfileBasicData]
|
Mitglieder |
leaders - [UserProfileBasicData]
|
Gruppenleiter |
leader - Boolean
|
Ist das aktuelle Profil Gruppenleiter |
badge - Int
|
Badge des Spaces |
Example
{
"description": "abc123",
"name": "abc123",
"headerImageUrl": "xyz789",
"id": 4,
"conferenceRoomEnabled": true,
"fileStoreEnabled": false,
"fileStoreMembersWrite": true,
"conferenceRoom": Conference,
"links": [GroupSpaceLink],
"members": [UserProfileBasicData],
"leaders": [UserProfileBasicData],
"leader": true,
"badge": 123
}
GroupSpaceLink
Fields
| Field Name | Description |
|---|---|
id - ID
|
eindeutige Id des Links innerhalb des Group Spaces |
name - String
|
Beschriftung des Buttons |
linkType - GroupSpaceLinkType
|
Art des Ziels |
targetComponentId - String
|
Modul das angesprungen werden soll |
target - String
|
Zielobjekt innerhalb des Moduls |
badge - Int
|
Badge-Value |
Example
{
"id": "4",
"name": "abc123",
"linkType": "CHAT_CHANNEL",
"targetComponentId": "xyz789",
"target": "abc123",
"badge": 123
}
GroupSpaceLinkType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"CHAT_CHANNEL"
GroupSpaceUpdate
Fields
| Input Field | Description |
|---|---|
description - String
|
Beschreibung |
conferenceRoomEnabled - Boolean
|
Videokonferenz aktiviert |
fileStoreEnabled - Boolean
|
FileStore Aktiviert |
fileStoreMembersWrite - Boolean
|
Wenn gesetzt, dürfen alle Mitglieder Schreiboperationen auf dem Filestore durchführen. Wenn nicht, dürfen nur die Gruppenleiter Schreiboperationen durchführen. |
headerImageUpload - UploadId
|
Aktualisiert das Dashboard Bild |
name - String
|
Ändert den Namen |
Example
{
"description": "abc123",
"conferenceRoomEnabled": true,
"fileStoreEnabled": true,
"fileStoreMembersWrite": true,
"headerImageUpload": UploadId,
"name": "abc123"
}
ICategory
Possible Types
| ICategory Types |
|---|
Example
{
"id": "4",
"name": "xyz789",
"color": "abc123",
"lastModificationDate": "2007-12-03"
}
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
"4"
IOSAppStoreSettingsInput
Fields
| Input Field | Description |
|---|---|
ios_appname - String
|
|
ios_subname - String
|
|
ios_app_short_name - String
|
|
ios_description - String
|
|
ios_keywords - String
|
|
ios_support_url - String
|
|
ios_marketing_url - String
|
|
ios_copyright - String
|
|
ios_category_a - String
|
|
ios_category_b - String
|
|
ios_promotext - String
|
|
ios_askForUpdate - Boolean
|
|
ios_dev_comment - String
|
|
ios_appstore_link - String
|
|
ios_libVersion - Int
|
|
ios_developer_Account - String
|
|
ios_goinglive - Date
|
|
ios_lastUpdate - Date
|
Example
{
"ios_appname": "xyz789",
"ios_subname": "abc123",
"ios_app_short_name": "abc123",
"ios_description": "abc123",
"ios_keywords": "xyz789",
"ios_support_url": "abc123",
"ios_marketing_url": "xyz789",
"ios_copyright": "xyz789",
"ios_category_a": "abc123",
"ios_category_b": "xyz789",
"ios_promotext": "xyz789",
"ios_askForUpdate": true,
"ios_dev_comment": "abc123",
"ios_appstore_link": "xyz789",
"ios_libVersion": 987,
"ios_developer_Account": "abc123",
"ios_goinglive": "2007-12-03",
"ios_lastUpdate": "2007-12-03"
}
IWSFile
Description
Allgemeine Informationen zu Files im Object Store.
Fields
| Field Name | Description |
|---|---|
id - WSFileId!
|
eindeutiges Handle auf das File |
workspaceId - WSFileId!
|
Id des Workspace root, in dem dieses File enthalten ist |
type - WSFileType!
|
Art der Datei |
key - String
|
Key innerhalb des Object Store |
readonly - Boolean!
|
true, wenn keine Bearbeitung möglich |
name - String!
|
Name des Files |
lastModified - Date!
|
Wann wurde die letzte Änderung gemacht |
lastModifiedBy - String
|
Wer hat zuletzt etwas geändert |
description - String
|
Bermrekungen, Hinweise, Notizen |
size - Int
|
Grösse in Bytes |
parentId - String
|
Übergeordnerter Knoten |
Possible Types
| IWSFile Types |
|---|
Example
{
"id": WSFileId,
"workspaceId": WSFileId,
"type": "ROOT",
"key": "xyz789",
"readonly": false,
"name": "xyz789",
"lastModified": "2007-12-03",
"lastModifiedBy": "abc123",
"description": "xyz789",
"size": 987,
"parentId": "xyz789"
}
InlineImage
Description
Bild, das in eine HTML Mail inline eingfügt werden soll als Base64 kodierter String. Über eine cid:name Referenz muss das Bild dann an der Stelle im Quellcode eingesetzt werden.
Example
{
"name": "xyz789",
"base64": "abc123",
"mimeType": "abc123"
}
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
987
Invoice
JSON
Description
Das brauchen wir zum Durchtunneln von generischen Maps
Example
{}
ListComponent
Fields
| Field Name | Description |
|---|---|
id - ID!
|
eindeutige Id der Komponente |
appId - AppID!
|
|
lastModified - Date
|
wann wurde die Komponente erstellt bzw. zuletzt geändert |
lastModifiedBy - String
|
wer hat die letzte Änderung durchgeführt |
entries - [ListEntry]
|
die eigentlichen Einträge in der Liste |
androidWidescreenEnabled - Boolean
|
|
backgroundColor - String
|
|
backgroundImageId - ID
|
|
backgroundImageUrl - String
|
|
pinList - Boolean
|
|
componentReference - String
|
|
precache - Boolean
|
|
timeBasedPublication - Boolean
|
|
lastExternalDataSourceUpdate - Date
|
|
rssUrl - String
|
|
sectionsEnabled - Boolean
|
|
rssTimerEnabled - Boolean
|
|
rssTargetComponentId - ID
|
|
rssTargetComponent - ComponentReference
|
|
rssError - String
|
Ist vorhande, wenn ein Fehler bei der Verarbeitung des RSS aufgetreten ist. |
rssPushChannels - [String]
|
|
direction - String!
|
|
sortField - String!
|
|
newsFeedDatasourceId - ID
|
Externe Datenquelle |
Example
{
"id": "4",
"appId": AppID,
"lastModified": "2007-12-03",
"lastModifiedBy": "xyz789",
"entries": [ListEntry],
"androidWidescreenEnabled": false,
"backgroundColor": "abc123",
"backgroundImageId": "4",
"backgroundImageUrl": "xyz789",
"pinList": true,
"componentReference": "abc123",
"precache": false,
"timeBasedPublication": false,
"lastExternalDataSourceUpdate": "2007-12-03",
"rssUrl": "xyz789",
"sectionsEnabled": false,
"rssTimerEnabled": false,
"rssTargetComponentId": 4,
"rssTargetComponent": ComponentReference,
"rssError": "xyz789",
"rssPushChannels": ["xyz789"],
"direction": "abc123",
"sortField": "xyz789",
"newsFeedDatasourceId": "4"
}
ListComponentInput
Fields
| Input Field | Description |
|---|---|
backgroundColor - String
|
|
backgroundImageId - ID
|
Zeigt auf das Bild in der Mediathek. Kommt zum Tragen wenn Liste als Audioguide verwendet wird |
pinList - Boolean
|
|
componentReference - String
|
|
precache - Boolean
|
|
timeBasedPublication - Boolean
|
|
rssUrl - String
|
|
sectionsEnabled - Boolean
|
|
rssTimerEnabled - Boolean
|
|
rssPushChannels - [String]
|
|
sortField - String
|
|
direction - String
|
|
rssTargetComponentId - ID
|
|
newsFeedDatasourceId - ID
|
Externe Datenquelle |
Example
{
"backgroundColor": "xyz789",
"backgroundImageId": 4,
"pinList": true,
"componentReference": "xyz789",
"precache": true,
"timeBasedPublication": true,
"rssUrl": "abc123",
"sectionsEnabled": true,
"rssTimerEnabled": true,
"rssPushChannels": ["xyz789"],
"sortField": "xyz789",
"direction": "xyz789",
"rssTargetComponentId": "4",
"newsFeedDatasourceId": 4
}
ListEntry
Fields
| Field Name | Description |
|---|---|
id - ID!
|
eindeutige Id des Eintrags |
appId - AppID!
|
|
enabled - Boolean
|
|
componentId - String
|
|
contentUrl - String
|
Inhalt |
contentId - ID
|
|
content - IWSFile
|
|
imageUrl - String
|
Bild |
imageId - ID
|
|
previewImageUrl - String
|
Bild Listenansicht |
previewImageId - ID
|
|
audioUrl - String
|
Audio |
audioId - ID
|
|
audio - Resource
|
|
extraImageId - ID
|
Zusatzbild |
extraImageUrl - String
|
|
videoDownloadUrl - String
|
VideoDownload |
videoDownloadId - ID
|
|
videoDownload - Resource
|
|
message - String
|
|
snippet - String
|
|
title - String
|
|
position - Int
|
|
pinCode - String
|
|
publicationStart - Date
|
|
publicationEnd - Date
|
|
description - String
|
|
visibleByProfileRoles - [String]
|
|
zoomEnabled - Boolean
|
|
facebookEnabled - Boolean
|
|
lastModificationDate - Date
|
|
creationDate - Date
|
|
link - String
|
|
poiId - String
|
|
backgroundColor - String
|
|
eventStart - Date
|
|
eventEnd - Date
|
|
address - String
|
|
componentLink - ComponentReference
|
|
componentLinkId - ID
|
Example
{
"id": "4",
"appId": AppID,
"enabled": true,
"componentId": "abc123",
"contentUrl": "xyz789",
"contentId": 4,
"content": IWSFile,
"imageUrl": "xyz789",
"imageId": 4,
"previewImageUrl": "xyz789",
"previewImageId": "4",
"audioUrl": "xyz789",
"audioId": 4,
"audio": Resource,
"extraImageId": 4,
"extraImageUrl": "abc123",
"videoDownloadUrl": "abc123",
"videoDownloadId": "4",
"videoDownload": Resource,
"message": "xyz789",
"snippet": "xyz789",
"title": "xyz789",
"position": 987,
"pinCode": "xyz789",
"publicationStart": "2007-12-03",
"publicationEnd": "2007-12-03",
"description": "abc123",
"visibleByProfileRoles": ["abc123"],
"zoomEnabled": false,
"facebookEnabled": true,
"lastModificationDate": "2007-12-03",
"creationDate": "2007-12-03",
"link": "abc123",
"poiId": "xyz789",
"backgroundColor": "abc123",
"eventStart": "2007-12-03",
"eventEnd": "2007-12-03",
"address": "abc123",
"componentLink": ComponentReference,
"componentLinkId": 4
}
ListEntryInput
Description
Felder die bei einem Listen-Eintrag geändert werden können
Fields
| Input Field | Description |
|---|---|
audioId - ID
|
Audio |
imageId - ID
|
Bild |
contentId - ID
|
Inhalt (Seite) |
previewImageId - ID
|
Bild Listenansicht |
extraImageId - ID
|
Zusatzbild |
videoDownloadId - ID
|
VideoDownload |
message - String
|
|
snippet - String
|
|
title - String
|
|
pinCode - String
|
|
publicationStart - Date
|
|
publicationEnd - Date
|
|
enabled - Boolean
|
|
position - Int
|
|
description - String
|
|
visibleByProfileRoles - [String]
|
|
zoomEnabled - Boolean
|
|
facebookEnabled - Boolean
|
|
link - String
|
|
poiId - String
|
|
backgroundColor - String
|
|
eventStart - Date
|
|
eventEnd - Date
|
|
componentLink - ID
|
|
address - String
|
Example
{
"audioId": "4",
"imageId": "4",
"contentId": "4",
"previewImageId": "4",
"extraImageId": "4",
"videoDownloadId": 4,
"message": "abc123",
"snippet": "xyz789",
"title": "abc123",
"pinCode": "abc123",
"publicationStart": "2007-12-03",
"publicationEnd": "2007-12-03",
"enabled": true,
"position": 987,
"description": "abc123",
"visibleByProfileRoles": ["abc123"],
"zoomEnabled": false,
"facebookEnabled": false,
"link": "xyz789",
"poiId": "abc123",
"backgroundColor": "abc123",
"eventStart": "2007-12-03",
"eventEnd": "2007-12-03",
"componentLink": "4",
"address": "abc123"
}
LocalDateTime
Description
A date-time without a time-zone in the ISO-8601 calendar system, such as 2007-12-03T10:15:30.
Example
"2020-07-19T08:45:59"
Locale
Example
"zh-cmn-Hans-CN"
Location
Description
Ein Ort wie z.B eine Sporthalle oder Geschäftsstelle die im Kontext einer App verwendet werden, um Termine dort zu planen, Die Position auf einer Karte einzublenden oder Ressourcen dort zu buchen.
Example
{
"id": 4,
"appId": AppID,
"title": "abc123",
"street": "abc123",
"postalCode": "xyz789",
"city": "abc123",
"geoLat": 123.45,
"geoLng": 987.65
}
LocationInput
Example
{
"title": "abc123",
"street": "xyz789",
"postalCode": "xyz789",
"city": "abc123",
"geoLat": 987.65,
"geoLng": 987.65
}
LoginPushNotificationInput
Long
Example
{}
MediaReference
MemberListVisibility
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ADMIN"
ModificationScope
Description
Gibt an, worauf sich eine Lösch- bzw. Änderungsaktion bezieht.
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"SELECTED"
ModuleContainer
Description
Eine Menge von zusammengehörenden Modulen über die grenzen einer Projektversion hinweg. Z.B alle Startseiten der verschiedenen Sprachversionen. Sinn dieses Containers ist es, dem Anwender zu ermöglichen zu erkennen, dass eine Änderung an einem Modul höchstwahrscheinlich auch Änderungen in den anderen Modulen des Containers bedeutet, z.B eine Änderung in der deutschen Version einer Seite in der englischen Version der gleichen Seite nachgezogen werden muss.
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
type - ComponentReferenceType
|
Referenz zu einem Modultyp |
references - [ModuleReference]
|
Example
{
"id": "4",
"type": "TextImage",
"references": [ModuleReference]
}
ModuleIcon
ModuleReference
PageRequest
PaymentEnvironment
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Produktivumgebung |
Example
"TEST"
PaymentProviderReference
Fields
| Field Name | Description |
|---|---|
refId - String
|
Feld wird gesetzt, sobald das Produkt beim Zahlungsdienstleister registriert wurde |
environment - PaymentEnvironment
|
Umgebung des Zahlungsanbieters |
Example
{"refId": "xyz789", "environment": "TEST"}
Permission
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"MANAGE_COMPONENT"
PhoneNumberVerificationStatus
Values
| Enum Value | Description |
|---|---|
|
|
Der Nutzer muss seine Telefonnummer noch eingeben, um die Verifikation zu starten |
|
|
Standard bei allen Profilen, die kein Verify Service benutzen |
|
|
ein Code wurde gesendet, der User muss diesen noch eingeben |
|
|
Nummer wurde verifiziert |
Example
"REQUIRED"
Price
Fields
| Field Name | Description |
|---|---|
id - ID
|
Id sofern mit Zahlungsanbieter registriert |
currency - String!
|
Three-letter ISO currency code for now only 'eur' is supported. |
amount - Int!
|
Betrag in Euro-Cent bzw. der kleinsten Einheit der Währung |
Example
{
"id": 4,
"currency": "abc123",
"amount": 987
}
PriceInput
Fields
| Input Field | Description |
|---|---|
currency - String!
|
Three-letter ISO currency code for now only 'eur' is supported. |
amount - Int!
|
Betrag in Euro-Cent bzw. der kleinsten Einheit der Währung |
Example
{"currency": "xyz789", "amount": 123}
ProductDefinition
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
description - String
|
|
imageId - ID
|
verweis auf das Produkt-Bild in der Mediathek |
image - Resource
|
|
type - ProductType
|
|
unitCount - Int
|
Anzahl der Einheiten. Wird beim Multi-Ticket verwendet |
validMonths - Int
|
Anzahl der gültigen Monate, Zeitticket |
price - Price!
|
Standard Preis |
tax - Tax
|
Steuer |
paymentProviderReference - PaymentProviderReference
|
Feld wird gesetzt, sobald das Produkt beim Zahlungsdienstleister registriert wurde |
sellCount - Int
|
Zeigt an, wie oft das Produkt gekauft wurde. Benötigt spezielle Berechtigung |
Example
{
"id": 4,
"name": "abc123",
"description": "xyz789",
"imageId": 4,
"image": Resource,
"type": "SINGLE_TICKET",
"unitCount": 987,
"validMonths": 987,
"price": Price,
"tax": Tax,
"paymentProviderReference": PaymentProviderReference,
"sellCount": 987
}
ProductDefinitionInput
Fields
| Input Field | Description |
|---|---|
name - String!
|
|
description - String
|
|
imageId - ID!
|
ID des Produktbildes aus der Mediathek |
type - ProductType
|
|
price - PriceInput!
|
|
unitCount - Int
|
Anzahl der Einheiten. Wird beim Multi-Ticket verwendet |
validMonths - Int
|
Anzahl der gültigen Monate, Zeitticket |
tax - TaxInput!
|
Steuersatz |
Example
{
"name": "xyz789",
"description": "xyz789",
"imageId": 4,
"type": "SINGLE_TICKET",
"price": PriceInput,
"unitCount": 987,
"validMonths": 123,
"tax": TaxInput
}
ProductType
Values
| Enum Value | Description |
|---|---|
|
|
Ticket kann einmal verwendet werden bevor es ungültig wird |
|
|
Ticket kann in einem Zeitraum beliebig verwendet werden |
|
|
Mehrfachkarte |
Example
"SINGLE_TICKET"
ProfileFieldInput
Description
Die Einstellungen zu einem verwendeten Feld des Benutzerprofils
Example
{
"name": "abc123",
"mandatory": true,
"readonly": true
}
ProfileValidationStatus
ProjectContentQuery
Fields
| Input Field | Description |
|---|---|
text - String
|
|
types - [ProjectContentType]
|
Example
{
"text": "xyz789",
"types": ["COMPONENT_REFERENCE"]
}
ProjectContentQueryResult
Fields
| Field Name | Description |
|---|---|
items - [ProjectContentQueryResultItem]
|
Example
{"items": [ProjectContentQueryResultItem]}
ProjectContentQueryResultItem
Fields
| Field Name | Description |
|---|---|
type - ProjectContentType
|
|
id - ID!
|
|
title - String
|
|
imageUrl - String
|
|
categories - [ProjectStructureNodeCategory]
|
Example
{
"type": "COMPONENT_REFERENCE",
"id": "4",
"title": "xyz789",
"imageUrl": "xyz789",
"categories": [ProjectStructureNodeCategory]
}
ProjectContentType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"COMPONENT_REFERENCE"
ProjectIconSet
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
icons - [ModuleIcon]
|
Example
{
"id": 4,
"name": "abc123",
"icons": [ModuleIcon]
}
ProjectMetadata
Fields
| Field Name | Description |
|---|---|
ios_appname - String
|
Name der IOS App |
ios_subname - String
|
Untertitel der IOS App |
ios_app_short_name - String
|
Kurzname auf dem Display |
ios_description - String
|
Beschreibung im Appstore |
ios_keywords - String
|
Keywords |
ios_support_url - String
|
SupportURL |
ios_marketing_url - String
|
Marketing URL |
ios_copyright - String
|
Copyright |
ios_category_a - String
|
Katgorie a |
ios_category_b - String
|
Kategorie b |
ios_promotext - String
|
Promotext IOS |
ios_appicon_76x76_url - String
|
AppIcon-URL für IOS |
ios_appicon_152x152_url - String
|
AppIcon-URL für IOS |
ios_appicon_180x180_url - String
|
AppIcon-URL für IOS |
ios_appicon_167x167_url - String
|
AppIcon-URL für IOS |
ios_splasscreen_1242x2208_url - String
|
AppIcon-URL für IOS |
ios_appicon_big_url - String
|
AppIcon-URL für IOS alias 120x120 |
ios_high_resolution_icon_url - String
|
IOS High Resolution-Icon |
ios_askForUpdate - Boolean
|
Update-Request gesetzt |
ios_goinglive - Date
|
Datum des Going-Live IOS |
ios_lastUpdate - Date
|
Letztes Updatedatum IOS |
ios_libVersion - Int
|
Library Version IOS |
ios_developer_Account - String
|
Developer Account IOS |
ios_dev_comment - String
|
Kommentar für die Entwickler |
ios_appstore_link - String
|
AppStore Link IOS |
aos_appname - String
|
Name der App Android |
aos_adverttext - String
|
Berbetext |
aos_website - String
|
Website |
aos_category - String
|
Kategorie |
aos_short_description - String
|
Kurzbeschreibung |
aos_description - String
|
Beschreibung |
aos_appicon_url - String
|
AppIcon Android |
aos_splasscreenicon_url - String
|
AppIcon Android |
aos_high_resolution_icon_url - String
|
High resolution icon |
aos_function_icon_url - String
|
|
aos_advert_icon_url - String
|
|
advertisingGraphic_url - String
|
Werbegrafik für den App-Banner |
aos_askForUpdate - Boolean
|
Update angefordert? |
aos_goinglive - Date
|
Going live datum |
aos_lastUpdate - Date
|
Letztes Update |
aos_libVersion - Int
|
Version der Library |
aos_dev_comment - String
|
Kommentar an die Entwickler |
aos_firebase_project_id - String
|
Firebase Project ID |
aos_developer_account - String
|
Developer Account |
aos_appstore_link - String
|
Link im Appstore |
portalAppName - String
|
Name der App im CMS |
facebookPage - String
|
Facebook-Seite |
projectDescription - String
|
Beschreibung zum Projekt |
portalAppIconUrl - String
|
Icon |
videoQuotaMB - String
|
Verfügbarer Videospeicher |
contractGroup - String
|
Vertragsgruppe |
aos_fcm_server_key - String
|
Google Push Key |
projectType - String
|
Google Push Key |
Example
{
"ios_appname": "abc123",
"ios_subname": "abc123",
"ios_app_short_name": "abc123",
"ios_description": "xyz789",
"ios_keywords": "abc123",
"ios_support_url": "xyz789",
"ios_marketing_url": "abc123",
"ios_copyright": "abc123",
"ios_category_a": "abc123",
"ios_category_b": "xyz789",
"ios_promotext": "xyz789",
"ios_appicon_76x76_url": "xyz789",
"ios_appicon_152x152_url": "xyz789",
"ios_appicon_180x180_url": "xyz789",
"ios_appicon_167x167_url": "xyz789",
"ios_splasscreen_1242x2208_url": "xyz789",
"ios_appicon_big_url": "abc123",
"ios_high_resolution_icon_url": "xyz789",
"ios_askForUpdate": true,
"ios_goinglive": "2007-12-03",
"ios_lastUpdate": "2007-12-03",
"ios_libVersion": 123,
"ios_developer_Account": "abc123",
"ios_dev_comment": "xyz789",
"ios_appstore_link": "abc123",
"aos_appname": "xyz789",
"aos_adverttext": "xyz789",
"aos_website": "xyz789",
"aos_category": "xyz789",
"aos_short_description": "xyz789",
"aos_description": "xyz789",
"aos_appicon_url": "xyz789",
"aos_splasscreenicon_url": "abc123",
"aos_high_resolution_icon_url": "abc123",
"aos_function_icon_url": "xyz789",
"aos_advert_icon_url": "abc123",
"advertisingGraphic_url": "abc123",
"aos_askForUpdate": true,
"aos_goinglive": "2007-12-03",
"aos_lastUpdate": "2007-12-03",
"aos_libVersion": 987,
"aos_dev_comment": "abc123",
"aos_firebase_project_id": "abc123",
"aos_developer_account": "xyz789",
"aos_appstore_link": "abc123",
"portalAppName": "xyz789",
"facebookPage": "xyz789",
"projectDescription": "xyz789",
"portalAppIconUrl": "abc123",
"videoQuotaMB": "xyz789",
"contractGroup": "abc123",
"aos_fcm_server_key": "abc123",
"projectType": "xyz789"
}
ProjectMetrics
Fields
| Field Name | Description |
|---|---|
groupId - AppID!
|
zu welcher App Gruppe |
name - String
|
Name der App, die gerade angezeigt wird |
description - String
|
App Store Beschreibungstext aus der App, die gerade angezeigt wird |
projectType - ProjectType
|
Ist es ein Stifterhelfen, DOSB oder Spezuialentwicklungsprojekt. Dies wird aus der welcomepage und dem contractGroup abgeleitet |
androidDeviceCount - Int
|
Anzahl der Android Geräte |
iosDeviceCount - Int
|
Anzahl der Apple Geräte |
totalDeviceCount - Int
|
Summe der Geräte |
androidPublicationDate - Date
|
Datum der Veröffentlichung bei Google Play |
androidLastUpdate - Date
|
Dateum des letzten Updates |
iosPublicationDate - Date
|
Datum der Veröffentlichung im App Store |
iosLastUpdate - Date
|
Dateum des letzten Updates |
calendarEventsInNext100days - Int
|
Anzahl der gepflegten Termine in allen Kalendern in den nächsten 100 Tagen |
calendarModuleExists - Boolean
|
Liefert die Information, ob ein Kalendermodul verbaut ist |
appIconSet - Boolean!
|
Das App Icon ist für beide Betriebssysteme hinterlegt |
splashScreenSet - Boolean!
|
Der Start Screen ist für beide Betriebssysteme hinterlegt |
privacyPolicySet - Boolean!
|
Es wurde eine Datenschutz URL hinterlegt |
cmsUserCount - Int
|
Anzahl der User Accounts im CMS, die dieser App zugeordnet sind |
lastCmsLoginAt - Date
|
Zeitpunkt des letzten CMS Logins |
lastLoginBy - String
|
Name des zuletzt eingeloggten Users |
pushNotificationCount - Int!
|
Zahl der jemals gesendeten Push Nachrichten |
lastPushNotificationSent - Date
|
wann wurde zuletzt eine Push Nachricht gesendet |
phase - Int
|
Projektphase |
pushCertificateExpirationDate - Date
|
Ablaufdatum des Push Zertifikats für iOS |
serviceLevel - ProjectServiceLevel
|
Service-Level |
groupSpacesCount - Int!
|
Anzahl der Gruppen mit aktiviertem Dashboard |
Example
{
"groupId": AppID,
"name": "xyz789",
"description": "abc123",
"projectType": "STANDARD",
"androidDeviceCount": 123,
"iosDeviceCount": 987,
"totalDeviceCount": 123,
"androidPublicationDate": "2007-12-03",
"androidLastUpdate": "2007-12-03",
"iosPublicationDate": "2007-12-03",
"iosLastUpdate": "2007-12-03",
"calendarEventsInNext100days": 987,
"calendarModuleExists": true,
"appIconSet": false,
"splashScreenSet": true,
"privacyPolicySet": false,
"cmsUserCount": 987,
"lastCmsLoginAt": "2007-12-03",
"lastLoginBy": "abc123",
"pushNotificationCount": 987,
"lastPushNotificationSent": "2007-12-03",
"phase": 123,
"pushCertificateExpirationDate": "2007-12-03",
"serviceLevel": "NONE",
"groupSpacesCount": 123
}
ProjectServiceLevel
Values
| Enum Value | Description |
|---|---|
|
|
kein SLA |
|
|
individuelle Absprachen, siehe Vertrag |
|
|
gemäß PLUS Paket |
|
|
Advanced Paket |
Example
"NONE"
ProjectSpecification
Example
{
"name": "xyz789",
"portalAppName": "abc123",
"groupId": "abc123",
"iosNavigationType": "xyz789",
"locale": "abc123",
"components": [ComponentReference]
}
ProjectStructureNode
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
parentId - ID
|
Id des übergeordneten Nodes, außer beim Root |
label - String
|
Beschriftung des Knotens |
component - ComponentReference
|
|
categories - [ProjectStructureNodeCategory]
|
Kategorien des Knotens |
children - [String]
|
momentan nur beim root node gesetzt. Enthält die Elemente des App Menüs in der definierten Reihenfolge |
Example
{
"id": 4,
"parentId": 4,
"label": "abc123",
"component": ComponentReference,
"categories": [ProjectStructureNodeCategory],
"children": ["xyz789"]
}
ProjectStructureNodeCategory
ProjectStructureNodeCategoryInput
ProjectStructureNodeCreateInput
Description
Input Daten, um ein neues Modul zu einer App hinzuzufügen.
Fields
| Input Field | Description |
|---|---|
type - ComponentReferenceType!
|
|
name - String!
|
|
extraData - String
|
Typ abhängige Zusatzinformationen, wie z.B die Vorlage |
Example
{
"type": "TextImage",
"name": "xyz789",
"extraData": "abc123"
}
ProjectStructureNodeUpdateInput
Description
Eigenschaften, die an einem Strukturknoten geändert werden können
Example
{
"title": "xyz789",
"icon": "abc123",
"iconSet": "abc123",
"state": "PUBLIC",
"badgeEnabled": false,
"categoryIds": ["abc123"],
"visibleByProfileRoles": ["abc123"],
"visibleByProfileGroups": ["xyz789"],
"children": ["xyz789"]
}
ProjectType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"STANDARD"
PushCertificateInfo
PushChannel
Fields
| Field Name | Description |
|---|---|
appId - AppID!
|
|
id - ID
|
|
number - Int!
|
|
name - String!
|
|
description - String
|
|
imageResource - Resource
|
|
imageResourceId - String
|
|
soundId - String
|
|
autoSubscribe - Boolean
|
|
initialSubscribe - Boolean
|
|
active - Boolean
|
|
subscriptionCount - Int
|
|
allowedGroups - [Group]
|
|
allowedGroupIds - [ID]
|
|
subscribed - Boolean
|
true, Wenn das aktuelle Gerät am Kanal abonniert ist |
Example
{
"appId": AppID,
"id": "4",
"number": 123,
"name": "xyz789",
"description": "xyz789",
"imageResource": Resource,
"imageResourceId": "abc123",
"soundId": "xyz789",
"autoSubscribe": true,
"initialSubscribe": false,
"active": false,
"subscriptionCount": 123,
"allowedGroups": [Group],
"allowedGroupIds": ["4"],
"subscribed": true
}
PushChannelInput
Example
{
"number": 123,
"name": "xyz789",
"description": "abc123",
"imageResourceId": "abc123",
"soundId": "abc123",
"autoSubscribe": false,
"initialSubscribe": false,
"active": false,
"allowedGroupIds": ["xyz789"]
}
PushConfiguration
Fields
| Field Name | Description |
|---|---|
forceSendOverPushChannel - Boolean
|
Erzwingt das Verschicken über einen Push-Kanal |
preset - PushConfigurationPreset
|
Voreinstellung des Push-Nachrichten-Versands |
Example
{
"forceSendOverPushChannel": true,
"preset": PushConfigurationPreset
}
PushConfigurationInput
Fields
| Input Field | Description |
|---|---|
forceSendOverPushChannel - Boolean
|
Erzwingt das Verschicken über einen Push-Kanal |
preset - PushConfigurationPresetInput
|
Voreinstellung des Push-Nachrichten-Versands |
Example
{
"forceSendOverPushChannel": false,
"preset": PushConfigurationPresetInput
}
PushConfigurationPreset
PushConfigurationPresetInput
PushHistoryComponent
Fields
| Field Name | Description |
|---|---|
headerImageUrl - String
|
|
headerImage - Resource
|
|
headerImageId - ID
|
|
limit - Int
|
Nachrichtenlimit |
dayLimit - Int
|
Tage-Limit |
backgroundColor - String
|
Hintergrundfarbe (gerade) |
backgroundColor2 - String
|
Hintergrundfarbe (ungerade) |
messageTextColor - String
|
Farbe Text |
dateTextColor - String
|
Farbe Text-Datum |
Example
{
"headerImageUrl": "xyz789",
"headerImage": Resource,
"headerImageId": "4",
"limit": 987,
"dayLimit": 987,
"backgroundColor": "xyz789",
"backgroundColor2": "abc123",
"messageTextColor": "abc123",
"dateTextColor": "abc123"
}
PushHistoryComponentInput
Example
{
"headerImageId": "4",
"limit": 123,
"dayLimit": 123,
"backgroundColor": "xyz789",
"backgroundColor2": "abc123",
"messageTextColor": "abc123",
"dateTextColor": "xyz789"
}
PushNotification
Fields
| Field Name | Description |
|---|---|
id - ID
|
|
status - PushNotificationStatus
|
|
message - String
|
|
appId - String
|
|
androidUsers - Int
|
|
iphoneUsers - Int
|
|
androidUsersMax - Int
|
|
iphoneUsersMax - Int
|
|
username - String
|
|
badge - Int
|
|
sheduleDate - Date
|
|
sound - Boolean
|
|
soundId - String
|
|
componentId - String
|
|
imageUrl - String
|
|
pending - Int
|
Anzahl der aussteneden Sendevorgänge |
componentReference - ComponentReference
|
Die Referenz zum optionalen Nachladen der Props (titel, icon...) |
url - String
|
|
channelIds - [String]
|
|
channels - [PushChannel]
|
join zu den Push Channels für die Anzeige |
roleIds - [String]
|
|
departmentIds - [String]
|
|
groupIds - [String]
|
|
dispatchDate - Date
|
|
mode - PushNotificationMode
|
|
publicPushNotification - Boolean
|
Example
{
"id": "4",
"status": "SCHEDULED",
"message": "xyz789",
"appId": "abc123",
"androidUsers": 123,
"iphoneUsers": 123,
"androidUsersMax": 123,
"iphoneUsersMax": 987,
"username": "abc123",
"badge": 987,
"sheduleDate": "2007-12-03",
"sound": true,
"soundId": "abc123",
"componentId": "xyz789",
"imageUrl": "xyz789",
"pending": 123,
"componentReference": ComponentReference,
"url": "xyz789",
"channelIds": ["abc123"],
"channels": [PushChannel],
"roleIds": ["abc123"],
"departmentIds": ["xyz789"],
"groupIds": ["xyz789"],
"dispatchDate": "2007-12-03",
"mode": "NORMAL",
"publicPushNotification": false
}
PushNotificationInput
Fields
| Input Field | Description |
|---|---|
mode - PushNotificationMode
|
|
message - String!
|
der eigentliche Nachrichten Inhalt (Text, Bild, Badge, Sound...) |
url - String
|
Optinale externe URL |
imageUrl - String
|
Bild, welches mit der Push-Nachricht verschickt werden soll |
componentId - String
|
Komponente in welche eingesprungen werden soll |
sound - Boolean
|
Soll ein akkustisches Signal auf dem Gerät ertönen |
roleIds - [String]
|
Filter auf App-Nutzer-Rollen |
departmentIds - [String]
|
Filter auf Abteilunen |
groupIds - [String]
|
Filter auf Gruppen |
channelIds - [String]
|
Filter auf Push-Kanäle |
sheduleDate - Date
|
Date to dispatch message |
chatChannelId - String
|
Chat channel |
Example
{
"mode": "NORMAL",
"message": "xyz789",
"url": "abc123",
"imageUrl": "xyz789",
"componentId": "xyz789",
"sound": true,
"roleIds": ["xyz789"],
"departmentIds": ["abc123"],
"groupIds": ["xyz789"],
"channelIds": ["xyz789"],
"sheduleDate": "2007-12-03",
"chatChannelId": "xyz789"
}
PushNotificationMode
Description
Mode einer Push Benachrichtigung
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"NORMAL"
PushNotificationReceiverStats
PushNotificationStatus
Description
Status einer Push Benachrichtigung
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"SCHEDULED"
Resource
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
url - String
|
|
notes - String
|
|
previewImageUrl - String
|
|
creationDate - Date
|
|
lastModificationDate - Date
|
|
mimeType - String
|
|
title - String
|
|
creator - String
|
|
resourceCategoryId - String
|
|
resourceCategory - ResourceCategory
|
|
width - Int
|
|
height - Int
|
|
contentLength - Int
|
|
status - ResourceStatus
|
|
deviceId - String
|
|
user_comment - String
|
|
user_title - String
|
|
user_contact - String
|
|
user_category - String
|
|
lat - String
|
|
lng - String
|
Example
{
"id": 4,
"url": "xyz789",
"notes": "xyz789",
"previewImageUrl": "xyz789",
"creationDate": "2007-12-03",
"lastModificationDate": "2007-12-03",
"mimeType": "xyz789",
"title": "abc123",
"creator": "xyz789",
"resourceCategoryId": "xyz789",
"resourceCategory": ResourceCategory,
"width": 987,
"height": 123,
"contentLength": 123,
"status": "pending",
"deviceId": "xyz789",
"user_comment": "abc123",
"user_title": "abc123",
"user_contact": "xyz789",
"user_category": "xyz789",
"lat": "abc123",
"lng": "abc123"
}
ResourceCategory
ResourceCategoryInput
ResourcePagingResponse
Fields
| Field Name | Description |
|---|---|
content - [Resource]
|
|
totalcount - Int!
|
Example
{"content": [Resource], "totalcount": 987}
ResourceSearchCriteria
Fields
| Input Field | Description |
|---|---|
text - String
|
|
mimeTypes - [String]
|
|
userUploads - Boolean
|
|
categoryId - String
|
|
status - [ResourceStatus]
|
Example
{
"text": "xyz789",
"mimeTypes": ["xyz789"],
"userUploads": true,
"categoryId": "abc123",
"status": ["pending"]
}
ResourceStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"pending"
ResourceUploadSigningRequest
Example
{
"filename": "abc123",
"contentLength": 987,
"mimeType": "xyz789",
"userUpload": false,
"userComment": "xyz789",
"userTitle": "abc123",
"userContact": "xyz789",
"userCategory": "abc123",
"lat": "xyz789",
"lng": "abc123"
}
ResourceUploadSigningResponse
RoleRef
Description
Verweis auf eine bestimmte Rolle innerhalb der Rollenaufzählung im App Kontext.
Example
RoleRef
Seat
Description
Das Ergebnis einer erfolgreichen Reservierung ist die Zuweisung eines virtuellen/realen Sitz/Platzes
Fields
| Field Name | Description |
|---|---|
id - ID!
|
eindeutige Bezeichnung des Sitzes |
userProfileId - String
|
Bezug zum Benutzerprofil falls vorhanden |
name - String
|
Nachname aus dem Profil |
firstname - String
|
Vorname des Teilnehmer |
comment - String
|
Hinweise des Benutzers zu seiner Anmeldung |
email - String
|
email Adresse des Benutzers, falls kein Profil vorhanden |
address - String
|
Anschrift des Benutzers, falls kein Profil vorhanden |
phoneNumber - String
|
Telfonnummer für eventuelle Rückfragen, falls kein Profil vorhanden |
Example
{
"id": 4,
"userProfileId": "xyz789",
"name": "xyz789",
"firstname": "abc123",
"comment": "abc123",
"email": "xyz789",
"address": "abc123",
"phoneNumber": "abc123"
}
Sort
Fields
| Input Field | Description |
|---|---|
direction - Direction!
|
|
property - String
|
Example
{"direction": "ASC", "property": "xyz789"}
Stamp
StampInput
String
Description
The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.
Example
"abc123"
StructureNode
Description
Der Strukturknoten innerhalb einer App Version
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
container - ModuleContainer
|
Optionale Referenz zu einem Modulcontainer |
label - String
|
Bezeichnung des Nodes in der Sprache der zugehörigen Projektversion |
children - [ID]
|
optionale Liste der untergeordneten Knoten |
Example
{
"id": "4",
"container": ModuleContainer,
"label": "xyz789",
"children": [4]
}
SystemConfig
Tax
Fields
| Field Name | Description |
|---|---|
rate - Int!
|
Betrag in Euro-Cent bzw. der kleinsten Einheit der Währung |
Example
{"rate": 987}
TaxInput
Fields
| Input Field | Description |
|---|---|
rate - Int!
|
Betrag in Euro-Cent bzw. der kleinsten Einheit der Währung |
Example
{"rate": 123}
TextAttachment
TextWidget
Description
Ein Widget, welches ein oder mehrere Abschnitte enthält, die optional Ein-/Ausgeklappt werden können.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
key - String!
|
Widget-Schlüssel |
title - String!
|
Titel |
sections - [TextWidgetSection]!
|
Abschnitte/Elemente des Widgets |
settings - WidgetSettings!
|
Einstellungen |
language - String!
|
Aktuelle Sprache |
languages - [String]
|
verfügbare Sprachen des Widgets |
header - String
|
Footer Text |
footer - String
|
Header Text |
Example
{
"id": 4,
"key": "abc123",
"title": "xyz789",
"sections": [TextWidgetSection],
"settings": WidgetSettings,
"language": "xyz789",
"languages": ["abc123"],
"header": "abc123",
"footer": "abc123"
}
TextWidgetInput
Fields
| Input Field | Description |
|---|---|
title - String
|
|
sections - [TextWidgetSectionInput]
|
|
header - String
|
Footer Text |
Example
{
"title": "abc123",
"sections": [TextWidgetSectionInput],
"header": "abc123"
}
TextWidgetSection
TextWidgetSectionInput
Threshold
Description
Schwellenwert Einstellung eines Users zu einer Serie für die er/sie benachrichtigt werden möchte
Example
{
"timeSeriesId": 4,
"upper": 123.45,
"lower": 123.45,
"profileId": "4"
}
ThresholdInput
TimePeriod
Description
Verwendete Zeitspannen bei der Anzeige von Messerten
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"HOUR"
TimeSeries
Description
Eine Gruppe von gleichartigen Werten über einen zeitlichen Verlauf. Beispiele sind:
- der Kursveraluf einer Aktie
- der Verlauf eines Sensors (Temperatur)
- Eine Preisentwicklung (Gas, Strom)
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
Anzeigename |
appId - AppID!
|
App Kontext |
unit - String!
|
Einheit für alle Werte dieser Serie |
granularity - String
|
Erwartete Frequenz mit der neue Werte ins System kommen |
latestEntry - TimeSeriesData
|
der aktuellste Datenpunkt |
delta - Float
|
Differenz aus dem letzten und vorletzten Datenpunkt |
metaData - JSON
|
anwendungsspezifische Zusatzdaten zu der Serie |
roleVisibility - [CustomEnumValue]
|
Sichtbarkeit für bestimmte Rollen des aktuellen Users begrenzen. |
visible - Boolean!
|
Schalter um die temporäre Sichtbarkeit zu ändern, z.B wenn eine Serie bereits angelegt wird aber erst später für die Kunden sichtbar sein soll. |
lastModified - Date
|
Zeitpunkt an dem zuletzt ein Wert zu dieser Serie hinzugefügt wurde |
Example
{
"id": "4",
"name": "abc123",
"appId": AppID,
"unit": "xyz789",
"granularity": "abc123",
"latestEntry": TimeSeriesData,
"delta": 987.65,
"metaData": {},
"roleVisibility": [CustomEnumValue],
"visible": true,
"lastModified": "2007-12-03"
}
TimeSeriesData
Description
Wert innerhalb einer Serie, z.B Messwert eines Sensors, Kurs einer Aktie, Strompreis etc.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
eindeutige Id des Messwerts/Datenpunktes |
timeSeriesId - ID!
|
Zu welcher Serie gehört der Wert |
metaData - JSON
|
Zusatzinformationen zu dem Wert, z.B ein Defekt wurde erkannt oder von welchem sensor stammt der Wert etc. |
timestamp - Date
|
Wann wurde der Wert erhoben/gemessen |
value - Float
|
Der eigentliche Wert in der Einheit der Serie |
Example
{
"id": 4,
"timeSeriesId": "4",
"metaData": {},
"timestamp": "2007-12-03",
"value": 987.65
}
TimeSeriesDataInput
Fields
| Input Field | Description |
|---|---|
id - ID
|
optionaler Update auf bestehenden Datenpunkt |
timestamp - Date
|
Wann wurde der Wert erhoben/gemessen |
value - Float
|
Der eigentliche Wert in der Einheit der Serie |
metaData - JSON
|
meta Informationen zu dem Wert z.B manuelle Messung oder sensorbasiert, von wem durchgeführt etc. |
Example
{
"id": "4",
"timestamp": "2007-12-03",
"value": 987.65,
"metaData": {}
}
TimeSeriesInput
Description
Input Daten zum Erzeugen einer neuen TimeSeries.
Fields
| Input Field | Description |
|---|---|
name - String!
|
Anzeigename |
unit - String!
|
Einheit für alle Werte dieser Serie |
granularity - String
|
Erwartete Frequenz mit der neue Werte ins System kommen. Default = "DAILY" |
metaData - JSON
|
Zusatzinformationen zu dem Wert, z.B ein Defekt wurde erkannt oder von welchem sensor stammt der Wert etc. |
Example
{
"name": "xyz789",
"unit": "abc123",
"granularity": "xyz789",
"metaData": {}
}
UploadId
Description
ein temporärer File Upload, der automatisch nach einer gegebenen Zeit wieder gelöscht wird
Example
UploadId
Url
Example
Url
UsageStatisticItem
UsageStatistics
Fields
| Field Name | Description |
|---|---|
appId - AppID!
|
App Kontext |
storageQuota - Long!
|
verfügbares Gesamt Speicherkontingent in Bytes |
storageUsedTotal - Long!
|
aktuell verwendeter Speicher in Bytes |
storageUsedPercentage - Float!
|
belegter Speicherplatz in Prozent |
storageFreePercentage - Float!
|
freier Speicherplatz in Prozent |
images - UsageStatisticItem!
|
Alle Bilder (mimetype image/*) |
pages - UsageStatisticItem!
|
Alle HTML Seiten (mimetype text/*) |
videos - UsageStatisticItem!
|
Videos (mimetype video/*) |
audios - UsageStatisticItem!
|
Audio Dateien (mimetype audio/*) |
documents - UsageStatisticItem!
|
Anwendungsdateien Word, Excel, (mimetype application/*) |
Example
{
"appId": AppID,
"storageQuota": {},
"storageUsedTotal": {},
"storageUsedPercentage": 123.45,
"storageFreePercentage": 123.45,
"images": UsageStatisticItem,
"pages": UsageStatisticItem,
"videos": UsageStatisticItem,
"audios": UsageStatisticItem,
"documents": UsageStatisticItem
}
User
Description
CMS User
Fields
| Field Name | Description |
|---|---|
username - String!
|
|
email - String
|
|
currentAppId - AppID!
|
|
permissions - [Permission]
|
|
lastLogin - Date
|
|
deviceIds - [String]
|
|
language - String
|
|
technicalAppUser - Boolean
|
|
inactive - Boolean
|
|
appIds - [String]
|
|
currentAppDivisions - [String]
|
|
managed - Boolean
|
|
fullName - String!
|
|
cnumber - String
|
|
invalidLoginAttemps - Int
|
|
password - String
|
|
lastAppLogin - Date
|
Example
{
"username": "xyz789",
"email": "xyz789",
"currentAppId": AppID,
"permissions": ["MANAGE_COMPONENT"],
"lastLogin": "2007-12-03",
"deviceIds": ["abc123"],
"language": "xyz789",
"technicalAppUser": false,
"inactive": false,
"appIds": ["xyz789"],
"currentAppDivisions": ["abc123"],
"managed": true,
"fullName": "xyz789",
"cnumber": "xyz789",
"invalidLoginAttemps": 987,
"password": "abc123",
"lastAppLogin": "2007-12-03"
}
UserBookmarkRef
UserBookmarkRefInput
UserBookmarks
Fields
| Field Name | Description |
|---|---|
refs - [UserBookmarkRef]
|
Example
{"refs": [UserBookmarkRef]}
UserBookmarksInput
Fields
| Input Field | Description |
|---|---|
refs - [UserBookmarkRefInput]!
|
Example
{"refs": [UserBookmarkRefInput]}
UserInput
Fields
| Input Field | Description |
|---|---|
email - String!
|
E-Mail des Benutzers |
permissions - [String]
|
Berechtigungen des Benutzers |
currentAppDivisions - [String]
|
|
appIds - [String]
|
AppIds, auf welcher der Benutzer Zugriff erhält |
fullName - String!
|
Name des Benutzers |
inactive - Boolean
|
Benutzer aktivieren oder deaktivieren |
Example
{
"email": "abc123",
"permissions": ["abc123"],
"currentAppDivisions": ["abc123"],
"appIds": ["abc123"],
"fullName": "xyz789",
"inactive": false
}
UserPagingResponse
UserProfile
Description
Das Benutzerprofil eines App Nutzers
Fields
| Field Name | Description |
|---|---|
salutation - CustomEnumValue
|
Die Anrede |
roles - [CustomEnumValue]!
|
Rollen, die der Benutzer gerade hat |
requestedRoles - [CustomEnumValue]
|
Rollen, die der Benutzer zuletzt angefordert hat |
departments - [CustomEnumValue]!
|
Abteilungen |
groups - [Group]
|
|
id - String
|
eindeutige Id |
externalId - String
|
Id des externen Benutzerverwaltungssystems sofern vorhanden |
lastModified - Date
|
letzte Änderung |
created - Date
|
Erstellungsdatum |
appId - String
|
AppId |
appGroup - String
|
App-Gruppe |
name - String
|
Nachname |
firstname - String
|
Vorname |
email - String!
|
email Adresse |
birthday - Date
|
Geburtsdatum |
title - String
|
Titel |
imageId - String
|
Avatar bzw. Profilbild |
imageThumbId - String
|
|
deviceIds - [String]
|
|
membershipNumber - String
|
membershipNumber |
agreedToAds - Boolean
|
|
verificationPending - Boolean
|
|
mailConfirmationPending - Boolean
|
|
locked - Boolean
|
|
mainProfile - Boolean
|
|
familyProfileNumber - String
|
Familiennummer. Muss bei allen Mitgliedern der Familie gesetzt und gleich sein |
locale - String
|
|
country - CustomEnumValue
|
|
degree - String
|
|
nickname - String
|
|
street - String
|
|
postcode - String
|
|
city - String
|
|
state - String
|
|
phone - String
|
|
phoneMobile - String
|
|
phoneMobileRequest - String
|
Requested Telefonnummer - verifizierung steht aus |
phoneMobileVerificationStatus - PhoneNumberVerificationStatus
|
Status der Verifikation der Mobilnummer |
identityNumber - String
|
|
personnelNumber - String
|
|
level - String
|
|
sports - String
|
|
companyName - String
|
|
companyDepartment - String
|
|
companyFunction - String
|
|
university - String
|
|
community - String
|
|
maritalStatus - String
|
|
skills - String
|
|
specialization - String
|
|
offers - String
|
|
interests - String
|
|
bankAccountHolder - String
|
|
bankBIC - String
|
|
bankIBAN - String
|
|
bankName - String
|
|
bankSEPARef - String
|
|
bankSEPADate - Date
|
|
feeKind - String
|
|
feeAmount - String
|
|
paymentMethod - String
|
|
entryDate - Date
|
|
exitDate - Date
|
|
coachingLicense - Boolean
|
|
customerNumber - String
|
|
dataPrivacyStatementAccepted - String
|
|
datePrivacyStatementAccepted - Date
|
|
dataTermsOfUseAccepted - String
|
|
dateTermsOfUseAccepted - Date
|
|
statutesAccepted - Boolean
|
|
chatRulesAccepted - Boolean
|
|
publicProfile - Boolean
|
|
remarks - String
|
|
members - [UserProfile]
|
|
accountActive - Boolean
|
|
chatAccount - Boolean
|
|
activationCode - String
|
|
clubName - String
|
|
clubNumber - String
|
|
team - String
|
|
playerPosition - String
|
|
playerNumber - String
|
|
playerHeight - Int
|
|
licenseNumber - String
|
Lizenznummer |
realname - String
|
Vorname und Nachname |
customFields - JSON
|
Projekt-spezifische Felder |
agreedDisplayName - Boolean
|
Darf der Name in der App angezeigt werden? |
agreedDisplayPhone - Boolean
|
Darf die Telefonnummer in der App angezeigt werden? |
agreedDisplayMail - Boolean
|
Darf die E-Mail in der App angezeigt werden? |
Example
{
"salutation": CustomEnumValue,
"roles": [CustomEnumValue],
"requestedRoles": [CustomEnumValue],
"departments": [CustomEnumValue],
"groups": [Group],
"id": "xyz789",
"externalId": "abc123",
"lastModified": "2007-12-03",
"created": "2007-12-03",
"appId": "abc123",
"appGroup": "xyz789",
"name": "abc123",
"firstname": "abc123",
"email": "xyz789",
"birthday": "2007-12-03",
"title": "abc123",
"imageId": "abc123",
"imageThumbId": "xyz789",
"deviceIds": ["abc123"],
"membershipNumber": "xyz789",
"agreedToAds": false,
"verificationPending": true,
"mailConfirmationPending": true,
"locked": true,
"mainProfile": false,
"familyProfileNumber": "xyz789",
"locale": "xyz789",
"country": CustomEnumValue,
"degree": "abc123",
"nickname": "abc123",
"street": "xyz789",
"postcode": "xyz789",
"city": "abc123",
"state": "xyz789",
"phone": "xyz789",
"phoneMobile": "xyz789",
"phoneMobileRequest": "abc123",
"phoneMobileVerificationStatus": "REQUIRED",
"identityNumber": "xyz789",
"personnelNumber": "xyz789",
"level": "abc123",
"sports": "xyz789",
"companyName": "abc123",
"companyDepartment": "abc123",
"companyFunction": "xyz789",
"university": "xyz789",
"community": "abc123",
"maritalStatus": "xyz789",
"skills": "xyz789",
"specialization": "xyz789",
"offers": "xyz789",
"interests": "abc123",
"bankAccountHolder": "xyz789",
"bankBIC": "xyz789",
"bankIBAN": "xyz789",
"bankName": "abc123",
"bankSEPARef": "abc123",
"bankSEPADate": "2007-12-03",
"feeKind": "xyz789",
"feeAmount": "xyz789",
"paymentMethod": "xyz789",
"entryDate": "2007-12-03",
"exitDate": "2007-12-03",
"coachingLicense": false,
"customerNumber": "xyz789",
"dataPrivacyStatementAccepted": "xyz789",
"datePrivacyStatementAccepted": "2007-12-03",
"dataTermsOfUseAccepted": "xyz789",
"dateTermsOfUseAccepted": "2007-12-03",
"statutesAccepted": true,
"chatRulesAccepted": false,
"publicProfile": true,
"remarks": "xyz789",
"members": [UserProfile],
"accountActive": true,
"chatAccount": true,
"activationCode": "xyz789",
"clubName": "xyz789",
"clubNumber": "abc123",
"team": "xyz789",
"playerPosition": "abc123",
"playerNumber": "xyz789",
"playerHeight": 987,
"licenseNumber": "abc123",
"realname": "xyz789",
"customFields": {},
"agreedDisplayName": true,
"agreedDisplayPhone": false,
"agreedDisplayMail": true
}
UserProfileBasicData
Example
{
"id": "xyz789",
"name": "xyz789",
"firstname": "xyz789",
"email": "abc123",
"imageThumbId": 4,
"imageId": 4,
"nickname": "xyz789",
"phoneMobile": "abc123"
}
UserProfileConfiguration
Description
Definiert die App spezifischen Einstellungen bezüglich des Verhaltens und der verwendeten Felder bei den Benutzer Profilen.
Fields
| Field Name | Description |
|---|---|
id - AppID!
|
zu welcher App gehört die Konfiguration |
rolesVisibleOnRegistration - Boolean
|
Soll eine Rollenauswahl bei der Neuregistrierung möglich sein |
profileManagerEMail - String
|
Verantwortlicher für Profil Freigaben |
registrationAllowed - Boolean
|
Benutzer können sich selbst anmdelden (default) oder die Anmeldung erfolgt per Datenübernahme vom Herausgeber |
editingAllowed - Boolean
|
Benutzer dürfen Ihr Profil ändern |
notifyOnRegistration - Boolean
|
App Verantwortlichen bei Neu-Anmeldungen benachrichtigen |
userProfileDeletion - Boolean
|
User kann sein Profil selbst löschen |
supportFamilyMembership - Boolean
|
Familienmitgliedschaft wird unterstützt |
familyMembershipEditable - Boolean
|
Dürfen Hauptmitglieder Ihre Familenmitglieder selbst verwalten? |
autodeleteOnExitDate - Boolean
|
Das Profil automatisch am Austrittsdatum löschen |
allowDirectActivation - Boolean
|
Direktaktivierung erlauben |
codeActivation - Boolean
|
QR-Code-Aktivierung erlauben |
notifyOnChange - Boolean
|
App Verantwortlichen bei Daten Änderungen benachrichtigen |
usedFields - [String]
|
Feldnamen, die von der App benutzt werden in der definierten Reihenfolge |
unusedFields - [String]
|
Feldnamen, die von der App nicht benutzt werden |
customFields - [String]
|
Profil Feld Erweiterungen, die im Rahmen der App gemacht wurden |
fields - [WorksheetColumnMetaData]
|
Alle Felder, die im Kontext der App bekannt sind |
note - String
|
Hinweise |
roleKeysToVerify - [String]
|
Genehmigungspflichtige Rollen |
roleKeysToUse - [String]
|
Benutze Rollen |
defaultRoles - [String]
|
Standard-Rollen |
dataPrivacyStatementUrl - String
|
Link zur Datenschuterklärung |
dataTermsOfUseUrl - String
|
Link zur Datenschuterklärung |
idCard - Boolean
|
Soll der Ausweis angezeigt werden ? |
usePrivacyPage - Boolean
|
Soll die Datenschutzseite benutzt werden? |
useTermsOfUsePage - Boolean
|
Soll die Nutzungsbedinungen benutzt werden? |
useGroups - Boolean
|
Wird die Gruppenverwaltung benutzt |
useOpenIDConnect - Boolean
|
Soll ein Externes Identitätsmanagement benutzt werden. Bitte kontaktieren Sie uns |
phoneNumberVerificationRequired - Boolean
|
Muss die Handy-Nummer vor der Freigabe des Profils validiert werden |
url - String
|
URL des Profilmoduls |
birthdayMessageActive - Boolean
|
Funktion: Geburtstagsgruß aktiviert |
birthdayMessageText - String
|
Funktion: Geburtstagsgruß Text |
birthdayMessageTargetComponent - String
|
Funktion: Geburtstagsgruß Ziel-Komponente |
Example
{
"id": AppID,
"rolesVisibleOnRegistration": true,
"profileManagerEMail": "abc123",
"registrationAllowed": true,
"editingAllowed": false,
"notifyOnRegistration": false,
"userProfileDeletion": true,
"supportFamilyMembership": false,
"familyMembershipEditable": false,
"autodeleteOnExitDate": false,
"allowDirectActivation": false,
"codeActivation": true,
"notifyOnChange": true,
"usedFields": ["xyz789"],
"unusedFields": ["abc123"],
"customFields": ["xyz789"],
"fields": [WorksheetColumnMetaData],
"note": "abc123",
"roleKeysToVerify": ["xyz789"],
"roleKeysToUse": ["abc123"],
"defaultRoles": ["xyz789"],
"dataPrivacyStatementUrl": "xyz789",
"dataTermsOfUseUrl": "xyz789",
"idCard": true,
"usePrivacyPage": false,
"useTermsOfUsePage": false,
"useGroups": false,
"useOpenIDConnect": true,
"phoneNumberVerificationRequired": true,
"url": "xyz789",
"birthdayMessageActive": true,
"birthdayMessageText": "xyz789",
"birthdayMessageTargetComponent": "abc123"
}
UserProfileConfigurationInput
Description
Eingabe Objekt bei Änderungen an der Profil Konfiguration einer App.
Fields
| Input Field | Description |
|---|---|
rolesVisibleOnRegistration - Boolean!
|
Soll eine Rollenauswahl bei der Neuregistrierung möglich sein |
profileManagerEMail - String
|
Verantwortlicher für Profil Freigaben |
registrationAllowed - Boolean
|
Benutzer können sich selbst anmdelden (default) oder die Anmeldung erfolgt per Datenübernahme vom Herausgeber |
notifyOnRegistration - Boolean
|
App Verantwortlichen bei Neu-Anmeldungen benachrichtigen |
userProfileDeletion - Boolean
|
User kann sein Profil selbst löschen |
supportFamilyMembership - Boolean
|
Familienmitgliedschaft wird unterstützt |
familyMembershipEditable - Boolean
|
Dürfen Hauptmitglieder Ihre Familenmitglieder selbst verwalten? |
autodeleteOnExitDate - Boolean
|
Das Profil automatisch am Austrittsdatum löschen |
allowDirectActivation - Boolean
|
Direktaktivierung erlauben |
codeActivation - Boolean
|
QR-Code-Aktivierung erlauben |
notifyOnChange - Boolean
|
App Verantwortlichen bei Daten Änderungen benachrichtigen |
usedFieldsConfig - [ProfileFieldInput]
|
Feldnamen, die von der App benutzt werden in der definierten Reihenfolge |
note - String
|
Hinweise |
roleKeysToVerify - [String]
|
Genehmigungspflichtige Rollen |
roleKeysToUse - [String]
|
Benutze Rollen |
defaultRoles - [String]
|
Standard-Rollen |
idCard - Boolean
|
Soll der Ausweis angezeigt werden ? |
editingAllowed - Boolean
|
Benutzer dürfen Ihr Profil ändern |
usePrivacyPage - Boolean
|
Soll die Datenschutzseite benutzt werden? |
useTermsOfUsePage - Boolean
|
Soll die Nutzungsbedinungen benutzt werden? |
useGroups - Boolean
|
Wird die Gruppenverwaltung benutzt |
useOpenIDConnect - Boolean
|
Soll ein Externes Identitätsmanagement benutzt werden. Bitte kontaktieren Sie uns |
phoneNumberVerificationRequired - Boolean
|
Muss die Handy-Nummer vor der Freigabe des Profils validiert werden |
birthdayMessageActive - Boolean
|
Funktion: Geburtstagsgruß aktiviert |
birthdayMessageText - String
|
Funktion: Geburtstagsgruß Text |
birthdayMessageTargetComponent - String
|
Funktion: Geburtstagsgruß Ziel-Komponente |
Example
{
"rolesVisibleOnRegistration": false,
"profileManagerEMail": "abc123",
"registrationAllowed": true,
"notifyOnRegistration": true,
"userProfileDeletion": false,
"supportFamilyMembership": true,
"familyMembershipEditable": false,
"autodeleteOnExitDate": false,
"allowDirectActivation": true,
"codeActivation": true,
"notifyOnChange": false,
"usedFieldsConfig": [ProfileFieldInput],
"note": "xyz789",
"roleKeysToVerify": ["xyz789"],
"roleKeysToUse": ["xyz789"],
"defaultRoles": ["abc123"],
"idCard": true,
"editingAllowed": false,
"usePrivacyPage": true,
"useTermsOfUsePage": false,
"useGroups": true,
"useOpenIDConnect": false,
"phoneNumberVerificationRequired": true,
"birthdayMessageActive": false,
"birthdayMessageText": "xyz789",
"birthdayMessageTargetComponent": "xyz789"
}
UserProfileExcelImportSettings
Fields
| Input Field | Description |
|---|---|
clearDatabase - Boolean
|
Achtung: Löscht alle Benutzer vor dem Import |
simulate - Boolean
|
Simuliert: Simuliert den Import |
delta - Boolean
|
Führt nur ein Delta-Import aus. Ersetzt nur bestehende Datensätze. |
createActivationCode - Boolean
|
Erstellt für jeden importierten App-Nutzer automatisch ein Aktivierungs-Code |
Example
{
"clearDatabase": true,
"simulate": true,
"delta": false,
"createActivationCode": false
}
UserProfileExportFormat
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"HTML"
UserProfileInput
Description
Input Type zum Erzeugen bzw. Ändern eines Benutzerprofils.
Fields
| Input Field | Description |
|---|---|
externalId - String
|
optionale externe Id |
salutation - CustomEnumValueInput
|
|
roles - [CustomEnumValueInput]
|
|
departments - [CustomEnumValueInput]
|
|
groupIds - [ID]
|
|
name - String
|
Nachname |
firstname - String
|
Vorname |
email - String
|
email Adresse muss bei der Neuanlage zwingend mitgegeben werden |
birthday - Date
|
Geburtsdatum |
title - String
|
|
membershipNumber - String
|
|
agreedToAds - Boolean
|
|
verificationPending - Boolean
|
|
mailConfirmationPending - Boolean
|
|
locked - Boolean
|
|
mainProfile - Boolean
|
|
familyProfileNumber - String
|
|
locale - String
|
|
degree - String
|
|
nickname - String
|
|
street - String
|
|
postcode - String
|
|
city - String
|
|
state - String
|
|
country - CustomEnumValueInput
|
|
phone - String
|
|
phoneMobile - String
|
|
identityNumber - String
|
|
personnelNumber - String
|
|
level - String
|
|
sports - String
|
|
companyName - String
|
|
companyDepartment - String
|
|
companyFunction - String
|
|
university - String
|
|
community - String
|
|
maritalStatus - String
|
|
skills - String
|
|
specialization - String
|
|
offers - String
|
|
interests - String
|
|
bankAccountHolder - String
|
|
bankBIC - String
|
|
bankIBAN - String
|
|
bankName - String
|
|
bankSEPARef - String
|
|
bankSEPADate - Date
|
|
feeKind - String
|
|
feeAmount - String
|
|
paymentMethod - String
|
|
entryDate - Date
|
|
exitDate - Date
|
|
coachingLicense - Boolean
|
|
customerNumber - String
|
|
dataPrivacyStatementAccepted - Boolean
|
|
datePrivacyStatementAccepted - Date
|
|
dataTermsOfUseAccepted - String
|
|
dateTermsOfUseAccepted - Date
|
|
statutesAccepted - Boolean
|
|
chatRulesAccepted - Boolean
|
|
publicProfile - Boolean
|
|
remarks - String
|
|
clubName - String
|
|
clubNumber - String
|
|
team - String
|
|
playerPosition - String
|
|
playerNumber - String
|
|
playerHeight - Int
|
|
licenseNumber - String
|
|
agreedDisplayName - Boolean
|
Darf der Name in der App angezeigt werden? |
agreedDisplayPhone - Boolean
|
Darf die Telefonnummer in der App angezeigt werden? |
agreedDisplayMail - Boolean
|
Darf die E-Mail in der App angezeigt werden? |
Example
{
"externalId": "xyz789",
"salutation": CustomEnumValueInput,
"roles": [CustomEnumValueInput],
"departments": [CustomEnumValueInput],
"groupIds": ["4"],
"name": "abc123",
"firstname": "abc123",
"email": "abc123",
"birthday": "2007-12-03",
"title": "abc123",
"membershipNumber": "xyz789",
"agreedToAds": false,
"verificationPending": true,
"mailConfirmationPending": false,
"locked": false,
"mainProfile": true,
"familyProfileNumber": "xyz789",
"locale": "xyz789",
"degree": "xyz789",
"nickname": "abc123",
"street": "xyz789",
"postcode": "abc123",
"city": "xyz789",
"state": "xyz789",
"country": CustomEnumValueInput,
"phone": "abc123",
"phoneMobile": "xyz789",
"identityNumber": "abc123",
"personnelNumber": "abc123",
"level": "xyz789",
"sports": "abc123",
"companyName": "xyz789",
"companyDepartment": "xyz789",
"companyFunction": "abc123",
"university": "abc123",
"community": "xyz789",
"maritalStatus": "xyz789",
"skills": "abc123",
"specialization": "abc123",
"offers": "abc123",
"interests": "abc123",
"bankAccountHolder": "xyz789",
"bankBIC": "xyz789",
"bankIBAN": "xyz789",
"bankName": "abc123",
"bankSEPARef": "abc123",
"bankSEPADate": "2007-12-03",
"feeKind": "xyz789",
"feeAmount": "xyz789",
"paymentMethod": "xyz789",
"entryDate": "2007-12-03",
"exitDate": "2007-12-03",
"coachingLicense": false,
"customerNumber": "xyz789",
"dataPrivacyStatementAccepted": true,
"datePrivacyStatementAccepted": "2007-12-03",
"dataTermsOfUseAccepted": "xyz789",
"dateTermsOfUseAccepted": "2007-12-03",
"statutesAccepted": false,
"chatRulesAccepted": true,
"publicProfile": false,
"remarks": "xyz789",
"clubName": "abc123",
"clubNumber": "xyz789",
"team": "xyz789",
"playerPosition": "xyz789",
"playerNumber": "abc123",
"playerHeight": 123,
"licenseNumber": "abc123",
"agreedDisplayName": false,
"agreedDisplayPhone": true,
"agreedDisplayMail": false
}
UserProfilePagingResponse
Fields
| Field Name | Description |
|---|---|
content - [UserProfile]
|
|
totalcount - Int!
|
Example
{"content": [UserProfile], "totalcount": 987}
UserProfileRegistrationResult
Fields
| Field Name | Description |
|---|---|
code - UserProfileRegistrationResultStatusCode!
|
|
message - String
|
|
redirectUrl - Url
|
Wird gesetzt, sofern für die App ein externes Primärsystem konfiguriert ist, welches die Erzeugung von neuen Profilen übernimmt |
Example
{
"code": "ALREADY_ASSIGNED",
"message": "xyz789",
"redirectUrl": Url
}
UserProfileRegistrationResultStatusCode
Values
| Enum Value | Description |
|---|---|
|
|
Dieses Gerät ist bereits verbunden |
|
|
Mail Adresse ist nicht eindeutig, z.B bei einer Familienfreigabe oder im verbundenen Primärsystem |
|
|
Zu dieser Mail Adresse gibt es kein Profil. Es muss eine Neu Registrierung erfolgen |
|
|
Warten auf Bestätigung der Mail Adresse |
|
|
Die Mobilnummer muss noch eingegeben werden, bevor die Verifikation erfolgen kann |
Example
"ALREADY_ASSIGNED"
UserSettingsInput
WSBinary
Fields
| Field Name | Description |
|---|---|
id - WSFileId!
|
|
workspaceId - WSFileId!
|
|
type - WSFileType!
|
|
key - String
|
|
readonly - Boolean!
|
|
name - String!
|
|
lastModified - Date!
|
|
lastModifiedBy - String
|
|
description - String
|
|
size - Int
|
Grösse in Bytes |
contentType - String!
|
Typ der Datei, wir aus der Endung abgeleitet. |
url - String
|
Zieladresse |
signedURL - Url
|
Zieladresse inklusive Signatur (d.h private Inhalte können zeitlich begrenzt abgerufen werden) |
parentId - String
|
Übergeordnerter Knoten |
Example
{
"id": WSFileId,
"workspaceId": WSFileId,
"type": "ROOT",
"key": "xyz789",
"readonly": true,
"name": "abc123",
"lastModified": "2007-12-03",
"lastModifiedBy": "abc123",
"description": "abc123",
"size": 987,
"contentType": "abc123",
"url": "xyz789",
"signedURL": Url,
"parentId": "xyz789"
}
WSCss
Fields
| Field Name | Description |
|---|---|
id - WSFileId!
|
|
workspaceId - WSFileId!
|
|
type - WSFileType!
|
|
key - String
|
|
readonly - Boolean!
|
|
name - String!
|
|
lastModified - Date!
|
|
lastModifiedBy - String
|
|
description - String
|
|
size - Int
|
Grösse in Bytes |
contentType - String!
|
text/html |
url - String
|
Zieladresse |
signedURL - Url
|
Zieladresse inklusive Signatur (d.h private Inhalte können zeitlich begrenzt abgerufen werden) |
parentId - String
|
Übergeordnerter Knoten |
Example
{
"id": WSFileId,
"workspaceId": WSFileId,
"type": "ROOT",
"key": "xyz789",
"readonly": true,
"name": "abc123",
"lastModified": "2007-12-03",
"lastModifiedBy": "abc123",
"description": "abc123",
"size": 123,
"contentType": "xyz789",
"url": "xyz789",
"signedURL": Url,
"parentId": "abc123"
}
WSDependency
WSDependencyAnalysis
Fields
| Field Name | Description |
|---|---|
validDependencies - [WSDependency]
|
|
invalidDependencies - [WSDependency]
|
Example
{
"validDependencies": [WSDependency],
"invalidDependencies": [WSDependency]
}
WSDynamicPage
Description
ehemalige dynamische Seiten
Fields
| Field Name | Description |
|---|---|
id - WSFileId!
|
|
workspaceId - WSFileId!
|
|
type - WSFileType!
|
|
key - String
|
|
readonly - Boolean!
|
|
name - String!
|
|
lastModified - Date!
|
|
lastModifiedBy - String
|
|
description - String
|
|
size - Int
|
Grösse in Bytes |
contentType - String!
|
text/html |
url - String
|
Zieladresse zum anzeigen des gerenderten Ergebnisses |
templateUrl - Url
|
Zieladresse dem Quellcode der dynamischen Seite |
parentId - String
|
Übergeordnerter Knoten |
targetComponentId - String
|
Id der Datenquelle |
targetComponentType - String
|
Typ der Datenquelle |
sharedResourceId - Int
|
|
cssCode - String
|
Example
{
"id": WSFileId,
"workspaceId": WSFileId,
"type": "ROOT",
"key": "abc123",
"readonly": true,
"name": "xyz789",
"lastModified": "2007-12-03",
"lastModifiedBy": "xyz789",
"description": "xyz789",
"size": 123,
"contentType": "xyz789",
"url": "xyz789",
"templateUrl": Url,
"parentId": "xyz789",
"targetComponentId": "xyz789",
"targetComponentType": "abc123",
"sharedResourceId": 123,
"cssCode": "xyz789"
}
WSFileId
Description
Handle zu einem File im Workspace einer App
Example
WSFileId
WSFileMetaUpdate
Example
{
"description": "abc123",
"targetComponentId": "xyz789",
"targetComponentType": "xyz789",
"sharedResourceId": 987,
"cssCode": "xyz789",
"mailTemplateKey": "xyz789",
"subject": "xyz789"
}
WSFileType
Description
Unterstützte Datei Arten innerhalb des Workspace
Values
| Enum Value | Description |
|---|---|
|
|
Der Root Folder des Workspace |
|
|
ein Verzeichnis |
|
|
ein binary File |
|
|
eine HTML Seite |
|
|
Eine CSS-Datei |
|
|
Eine Javascript-Datei |
|
|
Eine JSON-Datei |
|
|
eine HTML Seite mit Datenquelle (dynamische Seite) |
|
|
ein externer Verweis |
|
|
eine Mail Vorlage |
Example
"ROOT"
WSFolder
Fields
| Field Name | Description |
|---|---|
id - WSFileId!
|
|
workspaceId - WSFileId!
|
|
type - WSFileType!
|
|
key - String
|
|
readonly - Boolean!
|
|
name - String!
|
|
lastModified - Date!
|
|
lastModifiedBy - String
|
|
description - String
|
|
size - Int
|
Grösse in Bytes |
children - Int!
|
Anzahl der Unterelemente |
parentId - String
|
Übergeordnerter Knoten |
Example
{
"id": WSFileId,
"workspaceId": WSFileId,
"type": "ROOT",
"key": "xyz789",
"readonly": false,
"name": "abc123",
"lastModified": "2007-12-03",
"lastModifiedBy": "xyz789",
"description": "abc123",
"size": 123,
"children": 123,
"parentId": "xyz789"
}
WSJavaScript
Fields
| Field Name | Description |
|---|---|
id - WSFileId!
|
|
workspaceId - WSFileId!
|
|
type - WSFileType!
|
|
key - String
|
|
readonly - Boolean!
|
|
name - String!
|
|
lastModified - Date!
|
|
lastModifiedBy - String
|
|
description - String
|
|
size - Int
|
Grösse in Bytes |
contentType - String!
|
text/html |
url - String
|
Zieladresse |
signedURL - Url
|
Zieladresse inklusive Signatur (d.h private Inhalte können zeitlich begrenzt abgerufen werden) |
parentId - String
|
Übergeordnerter Knoten |
Example
{
"id": WSFileId,
"workspaceId": WSFileId,
"type": "ROOT",
"key": "xyz789",
"readonly": false,
"name": "abc123",
"lastModified": "2007-12-03",
"lastModifiedBy": "abc123",
"description": "xyz789",
"size": 123,
"contentType": "abc123",
"url": "xyz789",
"signedURL": Url,
"parentId": "abc123"
}
WSJson
Fields
| Field Name | Description |
|---|---|
id - WSFileId!
|
|
workspaceId - WSFileId!
|
|
type - WSFileType!
|
|
key - String
|
|
readonly - Boolean!
|
|
name - String!
|
|
lastModified - Date!
|
|
lastModifiedBy - String
|
|
description - String
|
|
contentType - String!
|
text/html |
size - Int
|
Grösse in Bytes |
url - String
|
Zieladresse |
signedURL - Url
|
Zieladresse inklusive Signatur (d.h private Inhalte können zeitlich begrenzt abgerufen werden) |
parentId - String
|
Übergeordnerter Knoten |
Example
{
"id": WSFileId,
"workspaceId": WSFileId,
"type": "ROOT",
"key": "abc123",
"readonly": false,
"name": "xyz789",
"lastModified": "2007-12-03",
"lastModifiedBy": "abc123",
"description": "xyz789",
"contentType": "xyz789",
"size": 987,
"url": "xyz789",
"signedURL": Url,
"parentId": "xyz789"
}
WSLink
Description
ehemalige externe Seiten
Fields
| Field Name | Description |
|---|---|
id - WSFileId!
|
|
workspaceId - WSFileId!
|
|
type - WSFileType!
|
|
key - String
|
|
readonly - Boolean!
|
|
name - String!
|
|
lastModified - Date!
|
|
lastModifiedBy - String
|
|
description - String
|
|
size - Int
|
Grösse in Bytes |
contentType - String!
|
text/html |
url - String
|
Zieladresse zum anzeigen des gerenderten Ergebnisses |
parentId - String
|
Übergeordnerter Knoten |
Example
{
"id": WSFileId,
"workspaceId": WSFileId,
"type": "ROOT",
"key": "abc123",
"readonly": false,
"name": "abc123",
"lastModified": "2007-12-03",
"lastModifiedBy": "abc123",
"description": "abc123",
"size": 123,
"contentType": "abc123",
"url": "xyz789",
"parentId": "abc123"
}
WSMailTemplate
Description
Eine HTML Datei auf Basis der thymeleaf Template Engine, welche Variablen enthalten kann. Beim Erzeugen einer E-Mail auf Basis einer solchen Vorlage, müssen die konkreten Werte für die einzelnen Variablen als Kontext gesetzt werden.
Fields
| Field Name | Description |
|---|---|
id - WSFileId!
|
|
workspaceId - WSFileId!
|
|
type - WSFileType!
|
|
key - String
|
|
readonly - Boolean!
|
|
name - String!
|
|
lastModified - Date!
|
|
lastModifiedBy - String
|
|
description - String
|
|
size - Int
|
Grösse in Bytes |
contentType - String!
|
text/html |
url - String
|
Zieladresse zum anzeigen des gerenderten Ergebnisses |
parentId - String
|
Übergeordnerter Knoten |
variables - [String]
|
Variablen Namen, die in der Vorlage verwendet werden |
signedURL - Url
|
signierte Url |
mailTemplateKey - String
|
EMAIL-Schlüssel |
subject - String
|
Betreff der Mail (kann selbst Variablen enthalten) |
Example
{
"id": WSFileId,
"workspaceId": WSFileId,
"type": "ROOT",
"key": "abc123",
"readonly": false,
"name": "abc123",
"lastModified": "2007-12-03",
"lastModifiedBy": "abc123",
"description": "abc123",
"size": 123,
"contentType": "abc123",
"url": "abc123",
"parentId": "abc123",
"variables": ["xyz789"],
"signedURL": Url,
"mailTemplateKey": "abc123",
"subject": "abc123"
}
WSPage
Fields
| Field Name | Description |
|---|---|
id - WSFileId!
|
|
workspaceId - WSFileId!
|
|
type - WSFileType!
|
|
key - String
|
|
readonly - Boolean!
|
|
name - String!
|
|
lastModified - Date!
|
|
lastModifiedBy - String
|
|
description - String
|
|
size - Int
|
Grösse in Bytes |
contentType - String!
|
text/html |
url - String
|
Zieladresse |
signedURL - Url
|
Zieladresse inklusive Signatur (d.h private Inhalte können zeitlich begrenzt abgerufen werden) |
parentId - String
|
Übergeordnerter Knoten |
Example
{
"id": WSFileId,
"workspaceId": WSFileId,
"type": "ROOT",
"key": "abc123",
"readonly": true,
"name": "abc123",
"lastModified": "2007-12-03",
"lastModifiedBy": "abc123",
"description": "xyz789",
"size": 123,
"contentType": "abc123",
"url": "abc123",
"signedURL": Url,
"parentId": "xyz789"
}
WSRoot
Fields
| Field Name | Description |
|---|---|
id - WSFileId!
|
|
workspaceId - WSFileId!
|
|
type - WSFileType!
|
|
key - String
|
|
readonly - Boolean!
|
|
name - String!
|
|
lastModified - Date!
|
|
lastModifiedBy - String
|
|
description - String
|
|
size - Int
|
Grösse in Bytes |
children - Int!
|
Anzahl der Unterelemente |
parentId - String
|
Übergeordnerter Knoten |
Example
{
"id": WSFileId,
"workspaceId": WSFileId,
"type": "ROOT",
"key": "xyz789",
"readonly": false,
"name": "xyz789",
"lastModified": "2007-12-03",
"lastModifiedBy": "xyz789",
"description": "xyz789",
"size": 123,
"children": 123,
"parentId": "abc123"
}
WSTextContent
Types
| Union Types |
|---|
Example
WSCss
WhoamiResponse
Fields
| Field Name | Description |
|---|---|
expiresAt - Date
|
Ablaufzeitpunkt des aktuellen JWT Token. |
claims - [String]
|
Die claims aus dem JWT Token |
appScope - String
|
Security Context des JWT Tokens |
deviceId - String
|
der aktuelle Gerätekontext, sofern vorhanden |
user - User
|
aktueller Benutzer |
userProfile - UserProfile
|
aktuelles Benutzerprofil |
connectToken - String
|
connect token, deprecated |
Example
{
"expiresAt": "2007-12-03",
"claims": ["xyz789"],
"appScope": "xyz789",
"deviceId": "abc123",
"user": User,
"userProfile": UserProfile,
"connectToken": "xyz789"
}
WidgetSettings
Fields
| Field Name | Description |
|---|---|
size - Int
|
Größe des Widgets. Bezieht sich auf 12- Grid-System |
dismissible - Boolean
|
Kann vom benutzer als gelesen markiert und vom Dashboard entfernt werden |
followUpInDays - Int
|
Wiedervorlage nach Tagen |
backgroundColor - String
|
Background color |
textColor - String
|
Text color |
priority - Int
|
Priorität |
collapsable - Boolean
|
mit oder ohne Einklapp-Funktion |
published - Boolean
|
Ist das Widget Veröffentlicht |
projectPhases - [Int]
|
Verfügbar in Phasen |
projectTypes - [ProjectType]
|
verfügbar in folgenden Projekt-Typen |
serviceLevels - [ProjectServiceLevel]
|
verfügbar in folgenden Service-Levels |
checkable - Boolean
|
Checkable |
tag - String
|
Tag |
Example
{
"size": 123,
"dismissible": false,
"followUpInDays": 123,
"backgroundColor": "xyz789",
"textColor": "xyz789",
"priority": 123,
"collapsable": true,
"published": false,
"projectPhases": [123],
"projectTypes": ["STANDARD"],
"serviceLevels": ["NONE"],
"checkable": true,
"tag": "xyz789"
}
WidgetSettingsInput
Fields
| Input Field | Description |
|---|---|
size - Int
|
Größe des Widgets. Bezieht sich auf 12- Grid-System |
dismissible - Boolean
|
Kann vom benutzer als gelesen markiert und vom Dashboard entfernt werden |
followUpInDays - Int
|
Wiedervorlage nach Tagen |
backgroundColor - String
|
Background color |
textColor - String
|
Text color |
priority - Int
|
Priorität |
collapsable - Boolean
|
mit oder ohne Einklapp-Funktion |
published - Boolean
|
Ist das Widget Veröffentlicht |
projectPhases - [Int]
|
Verfügbar in Phasen |
projectTypes - [ProjectType]
|
verfügbar in folgenden Projekt-Typen |
serviceLevels - [ProjectServiceLevel]
|
verfügbar in folgenden Service-Levels |
checkable - Boolean
|
Checkable |
tag - String
|
Tag |
Example
{
"size": 123,
"dismissible": true,
"followUpInDays": 123,
"backgroundColor": "abc123",
"textColor": "xyz789",
"priority": 123,
"collapsable": false,
"published": false,
"projectPhases": [123],
"projectTypes": ["STANDARD"],
"serviceLevels": ["NONE"],
"checkable": false,
"tag": "xyz789"
}
WorkbookComponent
Description
Analog zu einem Excel Dokument eine Sammlung von Arbeitsblättern, die als generisches Datenmodell für Spezialentwicklungen benutzt werden.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
adminMail - String
|
|
worksheetIds - [String]
|
|
worksheets - [Worksheet]
|
Example
{
"id": "4",
"adminMail": "abc123",
"worksheetIds": ["xyz789"],
"worksheets": [Worksheet]
}
WorkbookInput
WorkbookTemplate
Worksheet
Description
Ein von Excel inspiriertes Konzept eines Arbeitsblatts. Das Datenmodell umfasst eine beliebige Anzahl von Spalten, die verschiedene Datentypen haben können. Es wird dann zeilenbasiert damit gearbeitet.
Fields
| Field Name | Description |
|---|---|
id - ID!
|
|
name - String!
|
|
adminRoleKeys - [String]
|
diese Rollen haben Admin Rechte |
columns - [WorksheetColumnMetaData]
|
|
readAccess - WorksheetAccessLevel!
|
|
writeAccess - WorksheetAccessLevel!
|
|
deleteAccess - WorksheetAccessLevel!
|
Example
{
"id": "4",
"name": "abc123",
"adminRoleKeys": ["abc123"],
"columns": [WorksheetColumnMetaData],
"readAccess": "ALWAYS_ALLOW",
"writeAccess": "ALWAYS_ALLOW",
"deleteAccess": "ALWAYS_ALLOW"
}
WorksheetAccessLevel
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ALWAYS_ALLOW"
WorksheetColumnMetaData
Fields
| Field Name | Description |
|---|---|
columnName - String
|
Anzeigename der Spalte ggfs. Abhängig von der Sprache des Users |
propertyName - String
|
Name des Poperties im Record |
datatype - WorksheetColumnType
|
Datentyp der Spalte |
mandatory - Boolean
|
Ob es sich um ein Pflichtfeld handelt oder nicht |
readonly - Boolean
|
Ob das Feld nur gelesen werden kann, also vom User nicht selbst geändert |
format - String
|
Angaben zum Format abhängig vom Datentyp |
enumValues - [EnumValue]
|
Sofern der Datatype 'enum' ist, finden sich hier die verfügbaren Werte |
Example
{
"columnName": "xyz789",
"propertyName": "xyz789",
"datatype": "IMAGE",
"mandatory": false,
"readonly": true,
"format": "xyz789",
"enumValues": [EnumValue]
}
WorksheetColumnMetaDataInput
Fields
| Input Field | Description |
|---|---|
columnName - String
|
Anzeigename der Spalte ggfs. Abhängig von der Sprache des Users |
propertyName - String
|
Name des Poperties im Record |
type - WorksheetColumnType
|
|
format - String
|
Angaben zum Format abhängig vom Datentyp |
mandatory - Boolean
|
Ob es sich um ein Pflichtfeld handelt oder nicht |
Example
{
"columnName": "abc123",
"propertyName": "abc123",
"type": "IMAGE",
"format": "abc123",
"mandatory": false
}
WorksheetColumnType
Values
| Enum Value | Description |
|---|---|
|
|
Referenz auf eine Bild-Ressource in der Mediathek Über das Format wird gesteuert welche Mime Types erlaubt sind (PNG, JPG) legacy mapping: (string, imageRef) |
|
|
Referenz auf eine Ressource in der Mediathek Über das Format wird gesteuert welche Mime Types erlaubt sind (AUDIO,VIDEO,IMAGE) legacy mapping: (string, mediaRef) |
|
|
Referenz auf ein File im Workspace. Über das Format wird gesteuert welche File Typen erlaubt sind (HTML, JS, CSS) legacy mapping: (string, htmlRef) |
|
|
Referenz auf ein File im GridFS des User Upload Bereichs Über das Format wird gesteuert welche File Typen erlaubt sind. Momentan nur Bilder legacy mapping: (string, gridFSImageRef) |
|
|
Refereenz auf eine Rolle in der App Nutzer Verwaltung. legacy mapping: (auto, roleRef) |
|
|
Eingabefeld für Kommazahlen Könnte über das Format in mix und max bzw. Zahl der Nachkommastellen begrenzt werden legacy mapping: (double, numberfield) |
|
|
Eingabefeld für ganze Zahlen. Könnte über das Format in min und max begrenzt werden legacy mapping: (int, numberfield) |
|
|
Eingabefeld für Datumsangaben Kann über das Format in der Anzahl des Jahreszahlen bzw. Uhrzeitangabe eingeschränkt werden. legacy mapping: (date, datefield) |
|
|
Eingabefeld Ja/Nein, On/Off Über das Format könnte spezifiziert werden, wie Ja/nein gespeichert werden soll (true/false, 1/0, J/N) legacy mapping: (bool, checkboxfield) |
|
|
Ein langer Text der aus mehreren Zeilen besteht. Könnte über das Format kann die Anzahl der Zeilen begrenzt werden legacy mapping: (string, textarea) |
|
|
Ein langer Text der aus mehreren Zeilen besteht. Könnte über das Format kann die Anzahl der Zeilen begrenzt werden legacy mapping: (string, textinput) |
|
|
Aufzählungen. kein legacy mapping |
|
|
Referenz auf ein Profil |
Example
"IMAGE"
WorksheetInput
Fields
| Input Field | Description |
|---|---|
name - String
|
|
columns - [WorksheetColumnMetaDataInput]
|
|
adminRoleKeys - [String]
|
|
readAccess - WorksheetAccessLevel
|
|
writeAccess - WorksheetAccessLevel
|
|
deleteAccess - WorksheetAccessLevel
|
Example
{
"name": "xyz789",
"columns": [WorksheetColumnMetaDataInput],
"adminRoleKeys": ["xyz789"],
"readAccess": "ALWAYS_ALLOW",
"writeAccess": "ALWAYS_ALLOW",
"deleteAccess": "ALWAYS_ALLOW"
}
WorksheetPagingResponse
Fields
| Field Name | Description |
|---|---|
content - [GenericRow]
|
|
totalcount - Int!
|
Example
{"content": [GenericRow], "totalcount": 987}