{"swagger":"2.0","info":{"description":"Rest APIs for Pingum Events - Retrieve and Interact with Events, Status, Tags, and much more!","version":"v0.1.0","title":"Pingum Events API","contact":{"name":"Pingum Support","url":"https://pingum.io/about/","email":"support@pingum.io"},"license":{"name":"Apache License Version 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0\""}},"host":"event-api.pingum.io","basePath":"/","tags":[{"name":"Comments","description":"Comment Controller"},{"name":"Dashboards","description":"Dashboard Controller"},{"name":"Event Data","description":"Event Data Controller"},{"name":"Event Status","description":"Event Status Controller"},{"name":"Event Templates","description":"Event Template Controller"},{"name":"Event Uploads","description":"Event Upload Controller"},{"name":"Events","description":"Event Controller"},{"name":"Forms","description":"Form Controller"},{"name":"Logs","description":"Log Controller"},{"name":"Statuses","description":"Status Controller"},{"name":"Tag Types","description":"Tag Type Controller"},{"name":"Tags","description":"Tag Controller"},{"name":"Users","description":"User Controller"}],"paths":{"/api/v1/auditLogs":{"get":{"tags":["Logs"],"summary":"Get Logs Related to Event Settings","operationId":"getTenantLogsUsingGET","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"actions","in":"query","description":"actions","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"startTime","in":"query","description":"startTime","required":true,"type":"string","format":"date-time"},{"name":"endTime","in":"query","description":"endTime","required":false,"type":"string","format":"date-time"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/v1/comments/{commentId}":{"delete":{"tags":["Comments"],"summary":"Delete Comment","operationId":"deleteCommentUsingDELETE","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"commentId","in":"path","description":"commentId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"204":{"description":"No Content"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided comment does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}},"patch":{"tags":["Comments"],"summary":"Update Comment","operationId":"patchCommentUsingPATCH","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"commentId","in":"path","description":"commentId","required":true,"type":"integer","format":"int32"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/PatchComment"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Comment"}},"204":{"description":"No Content"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided comment does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}}},"/api/v1/dashboards":{"get":{"tags":["Dashboards"],"summary":"Get All Dashboards","operationId":"getDashboardsUsingGET","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Dashboard"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"post":{"tags":["Dashboards"],"summary":"Create Dashboard","description":"Create a dashboard with preset filters for returning events","operationId":"createDashboardUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/CreateDashboard"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Dashboard"}},"201":{"description":"Created"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"409":{"description":"The tenant for this data does not match the header tenant"}}}},"/api/v1/dashboards/{dashboardId}":{"delete":{"tags":["Dashboards"],"summary":"Delete Dashboard","description":"Once deleting a dashoard, it cannot be retreived again","operationId":"deleteDashboardUsingDELETE","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"dashboardId","in":"path","description":"dashboardId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"204":{"description":"No Content"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided dashboard does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}},"patch":{"tags":["Dashboards"],"summary":"Update Dashboard","description":"Update and existing dashboard with new data","operationId":"patchDashboardUsingPATCH","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"dashboardId","in":"path","description":"dashboardId","required":true,"type":"integer","format":"int32"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/PatchDashboard"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Dashboard"}},"204":{"description":"No Content"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided  dashbaord does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}}},"/api/v1/dashboards/{dashboardId}/subscriptions":{"get":{"tags":["Dashboards"],"summary":"Get All Subscriptions to Dashboard","operationId":"getSubscriptionsToDashboardUsingGET","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"dashboardId","in":"path","description":"dashboardId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/UserSubscription"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/v1/eventData":{"get":{"tags":["Event Data"],"summary":"Get All Event Data","operationId":"getEventDataUsingGET","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"includeArchived","in":"query","description":"includeArchived","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/EventData"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"post":{"tags":["Event Data"],"summary":"Create Event Data","description":"Create a data field that can be used as additional data input when creating events","operationId":"createEventDataUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"in":"body","name":"Create Event Data Request","description":"Name is used to display the field. Type is used to determine the input type (value must be one of: (Text, Number)","required":true,"schema":{"$ref":"#/definitions/CreateEventData"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EventData"}},"201":{"description":"Created"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"409":{"description":"The tenant for this data does not match the header tenant"}}}},"/api/v1/eventData/{eventDataId}":{"patch":{"tags":["Event Data"],"summary":"Update Event Data","operationId":"patchEventDataUsingPATCH","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"eventDataId","in":"path","description":"eventDataId","required":true,"type":"integer","format":"int32"},{"in":"body","name":"Patch Event Data Request","description":"Name is used to display the field. Type is used to determine the input type (value must be one of: (Text, Number)","required":true,"schema":{"$ref":"#/definitions/PatchEventData"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EventData"}},"204":{"description":"No Content"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided event data does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}}},"/api/v1/eventStatus/{eventStatusId}":{"delete":{"tags":["Event Status"],"summary":"Delete EventStatus","operationId":"deleteEventStatusUsingDELETE","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"eventStatusId","in":"path","description":"eventStatusId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"204":{"description":"No Content"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided event status does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}},"patch":{"tags":["Event Status"],"summary":"Update EventStatus","operationId":"patchEventStatusUsingPATCH","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"eventStatusId","in":"path","description":"eventStatusId","required":true,"type":"integer","format":"int32"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/PatchEventStatus"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EventStatus"}},"204":{"description":"No Content"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided event status does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}}},"/api/v1/eventStatuses/{eventStatusId}":{"delete":{"tags":["Event Status"],"summary":"Delete EventStatus","operationId":"deleteEventStatusUsingDELETE_1","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"eventStatusId","in":"path","description":"eventStatusId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"204":{"description":"No Content"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided event status does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}},"patch":{"tags":["Event Status"],"summary":"Update EventStatus","operationId":"patchEventStatusUsingPATCH_1","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"eventStatusId","in":"path","description":"eventStatusId","required":true,"type":"integer","format":"int32"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/PatchEventStatus"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EventStatus"}},"204":{"description":"No Content"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided event status does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}}},"/api/v1/eventTemplates":{"get":{"tags":["Event Templates"],"summary":"Get Event Templates","operationId":"getEventTemplatesUsingGET","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"includeArchived","in":"query","description":"includeArchived","required":false,"type":"boolean","default":false},{"name":"search","in":"query","description":"search","required":false,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"page","in":"query","description":"Results page you want to retrieve (0..N)","required":false,"type":"ref"},{"name":"size","in":"query","description":"Number of records per page.","required":false,"type":"ref"},{"name":"sort","in":"query","description":"Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Page«EventTemplate»"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"post":{"tags":["Event Templates"],"summary":"Create New Event Template","description":"Create an event template by providing the all required data","operationId":"createEventTemplateUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/CreateEventTemplate"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EventTemplate"}},"201":{"description":"Created"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided status or tag does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}}},"/api/v1/eventTemplates/search":{"post":{"tags":["Event Templates"],"summary":"Search For Event Templates","operationId":"searchEventTemplatesUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"includeArchived","in":"query","description":"includeArchived","required":false,"type":"boolean","default":false},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/SearchEventTemplates"}},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/EventTemplate"}}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/v1/eventTemplates/{eventTemplateId}":{"delete":{"tags":["Event Templates"],"summary":"Delete An Event Template","description":"Deleting an event template will remove it completely and cannot be retrieved","operationId":"deleteEventTemplateUsingDELETE","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"eventTemplateId","in":"path","description":"eventTemplateId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"boolean"}},"204":{"description":"No Content"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided event template does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}},"patch":{"tags":["Event Templates"],"summary":"Update An Event Template","description":"Update event template fields","operationId":"patchEventTemplateUsingPATCH","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"eventTemplateId","in":"path","description":"eventTemplateId","required":true,"type":"integer","format":"int32"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/PatchEventTemplate"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EventTemplate"}},"204":{"description":"No Content"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided event template, status, or tag does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}}},"/api/v1/eventTemplates/{eventTemplateId}/events":{"post":{"tags":["Event Templates"],"summary":"Create Event From Event Template","description":"Quickly create and event by providing an event templates pre defined data","operationId":"createEventFromEventTemplateUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"X-Timezone","in":"header","description":"X-Timezone","required":false,"type":"string"},{"name":"eventTemplateId","in":"path","description":"eventTemplateId","required":true,"type":"integer","format":"int32"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/CreateEventFromEventTemplate"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Event"}},"201":{"description":"Created"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided event template or tag does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}}},"/api/v1/eventTemplates/{eventTemplateId}/subscriptions":{"get":{"tags":["Event Templates"],"summary":"Get All Subscriptions to Event Template","operationId":"getSubscriptionsToEventTemplateUsingGET","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"eventTemplateId","in":"path","description":"eventTemplateId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/UserSubscription"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/v1/eventUploads/{eventUploadId}":{"post":{"tags":["Event Uploads"],"summary":"Update Event Upload","description":"Update and existing event upload with a new file.","operationId":"updateEventUploadUsingPOST","consumes":["multipart/form-data"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"eventUploadId","in":"path","description":"eventUploadId","required":true,"type":"integer","format":"int32"},{"name":"file","in":"formData","description":"file","required":true,"type":"file"},{"name":"displayName","in":"query","description":"displayName","required":false,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EventUpload"}},"201":{"description":"Created"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided event upload does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}},"delete":{"tags":["Event Uploads"],"summary":"Delete Upload for Event Upload","description":"Remove an event upload. This action cannot be undone and the file will not able to be retrieved again.","operationId":"deleteEventUploadUsingDELETE","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"eventUploadId","in":"path","description":"eventUploadId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"204":{"description":"No Content"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided event upload does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}}},"/api/v1/eventUploads/{eventUploadId}/download":{"get":{"tags":["Event Uploads"],"summary":"Download Event Upload","operationId":"downloadEventUploadFileUsingGET","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"eventUploadId","in":"path","description":"eventUploadId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"object"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided event upload does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}}},"/api/v1/events":{"post":{"tags":["Events"],"summary":"Create Event","description":"Create an event by providing the all required data to do so.","operationId":"createEventUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"X-Timezone","in":"header","description":"X-Timezone","required":false,"type":"string"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/CreateEvent"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Event"}},"201":{"description":"Created"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided status or tag does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}}},"/api/v1/events/analytics":{"post":{"tags":["Events"],"summary":"Get Analytics Data for Events","description":"Get Analytics for events by providing filters and search criteria","operationId":"getAnalyticsForEventsUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"X-Timezone","in":"header","description":"X-Timezone","required":false,"type":"string"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/SearchEvents"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EventAnalytics"}},"201":{"description":"Created"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/v1/events/export":{"post":{"tags":["Events"],"summary":"Export Events","operationId":"exportEventsUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"X-Timezone","in":"header","description":"X-Timezone","required":false,"type":"string"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/SearchEvents"}}],"responses":{"200":{"description":"OK","schema":{"type":"object"}},"201":{"description":"Created"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/v1/events/notifications":{"get":{"tags":["Events"],"summary":"Get server sent events for new and updated events","operationId":"getEventNotificationsUsingGET","produces":["text/event-stream"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/SseEmitter"}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/v1/events/search":{"post":{"tags":["Events"],"summary":"Search Events","description":"Search for events by providing filters and search criteria","operationId":"searchEventUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"X-Timezone","in":"header","description":"X-Timezone","required":false,"type":"string"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/SearchEvents"}},{"name":"page","in":"query","description":"Results page you want to retrieve (0..N)","required":false,"type":"ref"},{"name":"size","in":"query","description":"Number of records per page.","required":false,"type":"ref"},{"name":"updatedAfter","in":"query","description":"Only include events created or updated after this date: ISO format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'","required":false,"type":"string","format":"date"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Page«Event»"}},"201":{"description":"Created"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/v1/events/{eventId}":{"get":{"tags":["Events"],"summary":"Get Event By Id","operationId":"getEventUsingGET","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"eventId","in":"path","description":"eventId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Event"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided event does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}},"patch":{"tags":["Events"],"summary":"Update Event","description":"Update and existing event with new data.","operationId":"patchEventUsingPATCH","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"X-Timezone","in":"header","description":"X-Timezone","required":false,"type":"string"},{"name":"eventId","in":"path","description":"eventId","required":true,"type":"integer","format":"int32"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/PatchEvent"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Event"}},"204":{"description":"No Content"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided event or tag does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}}},"/api/v1/events/{eventId}/comments":{"get":{"tags":["Events"],"summary":"Get Comments for Event","operationId":"getCommentsForEventUsingGET","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"eventId","in":"path","description":"eventId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Comment"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided event does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}},"post":{"tags":["Events"],"summary":"Add Comment to Event","operationId":"createCommentForEventUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"X-Timezone","in":"header","description":"X-Timezone","required":false,"type":"string"},{"name":"eventId","in":"path","description":"eventId","required":true,"type":"integer","format":"int32"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/CreateComment"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Comment"}},"201":{"description":"Created"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided event does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}}},"/api/v1/events/{eventId}/eventStatus":{"post":{"tags":["Events"],"summary":"Add/Change Status for Event","description":"Move event to the provided status","operationId":"createEventStatusForEventUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"X-Timezone","in":"header","description":"X-Timezone","required":false,"type":"string"},{"name":"eventId","in":"path","description":"eventId","required":true,"type":"integer","format":"int32"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/CreateEventStatus"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EventStatus"}},"201":{"description":"Created"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided event or status does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}}},"/api/v1/events/{eventId}/eventStatuses":{"post":{"tags":["Events"],"summary":"Add/Change Status for Event","description":"Move event to the provided status","operationId":"createEventStatusForEventUsingPOST_1","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"X-Timezone","in":"header","description":"X-Timezone","required":false,"type":"string"},{"name":"eventId","in":"path","description":"eventId","required":true,"type":"integer","format":"int32"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/CreateEventStatus"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EventStatus"}},"201":{"description":"Created"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided event or status does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}}},"/api/v1/events/{eventId}/eventUploads":{"get":{"tags":["Events"],"summary":"Get Event Uploads by Event ID","description":"Return all file uploads for the event","operationId":"getEventUploadsForEventUsingGET","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"eventId","in":"path","description":"eventId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/EventUpload"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided event does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}},"post":{"tags":["Events"],"summary":"Add Event Upload to Event","description":"Upload a file to the event","operationId":"addEventUploadToEventUsingPOST","consumes":["multipart/form-data"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"X-Timezone","in":"header","description":"X-Timezone","required":false,"type":"string"},{"name":"eventId","in":"path","description":"eventId","required":true,"type":"integer","format":"int32"},{"name":"file","in":"formData","description":"file","required":true,"type":"file"},{"name":"displayName","in":"query","description":"displayName","required":false,"type":"string"},{"name":"sendNotifications","in":"query","description":"sendNotifications","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/EventUpload"}},"201":{"description":"Created"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided event does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}}},"/api/v1/forms/{formId}/events":{"post":{"tags":["Forms"],"summary":"Create Events From Form","description":"Create events for the given form and templates.","operationId":"createEventsFromFormUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"X-Timezone","in":"header","description":"X-Timezone","required":false,"type":"string"},{"name":"formId","in":"path","description":"formId","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/CreateEventsFromForm"}}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"201":{"description":"Created"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/v1/status":{"get":{"tags":["Statuses"],"summary":"Get All Statuses","operationId":"getStatusesUsingGET","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"includeArchived","in":"query","description":"includeArchived","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Status"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"post":{"tags":["Statuses"],"summary":"Create Status","description":"Creates a new status that events can be placed into. Status order is used for ordering all statuses.","operationId":"createStatusUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/CreateStatus"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Status"}},"201":{"description":"Created"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"409":{"description":"The tenant for this data does not match the header tenant"}}}},"/api/v1/status/{statusId}":{"get":{"tags":["Statuses"],"summary":"Get Status By Id","operationId":"getStatusUsingGET","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"statusId","in":"path","description":"statusId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Status"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided status does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}},"patch":{"tags":["Statuses"],"summary":"Update Status","operationId":"updateStatusUsingPATCH","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"statusId","in":"path","description":"statusId","required":true,"type":"integer","format":"int32"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/PatchStatus"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Status"}},"204":{"description":"No Content"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided status does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}}},"/api/v1/statuses":{"get":{"tags":["Statuses"],"summary":"Get All Statuses","operationId":"getStatusesUsingGET_1","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"includeArchived","in":"query","description":"includeArchived","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Status"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"post":{"tags":["Statuses"],"summary":"Create Status","description":"Creates a new status that events can be placed into. Status order is used for ordering all statuses.","operationId":"createStatusUsingPOST_1","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/CreateStatus"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Status"}},"201":{"description":"Created"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"409":{"description":"The tenant for this data does not match the header tenant"}}}},"/api/v1/statuses/{statusId}":{"get":{"tags":["Statuses"],"summary":"Get Status By Id","operationId":"getStatusUsingGET_1","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"statusId","in":"path","description":"statusId","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Status"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided status does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}},"patch":{"tags":["Statuses"],"summary":"Update Status","operationId":"updateStatusUsingPATCH_1","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"statusId","in":"path","description":"statusId","required":true,"type":"integer","format":"int32"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/PatchStatus"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Status"}},"204":{"description":"No Content"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided status does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}}},"/api/v1/tagTypes":{"get":{"tags":["Tag Types"],"summary":"Get All Tag Types","description":"Returns all tag types for tenant.","operationId":"getTagTypesUsingGET","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"includeArchived","in":"query","description":"includeArchived","required":false,"type":"boolean","default":false},{"name":"includeTags","in":"query","description":"includeTags","required":false,"type":"boolean","default":false},{"name":"buildHierarchicalList","in":"query","description":"buildHierarchicalList","required":false,"type":"boolean","default":true}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/TagType"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"post":{"tags":["Tag Types"],"summary":"Create Tag Type","description":"Create new tag type with provided data.","operationId":"createTagTypeUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/CreateTagType"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TagType"}},"201":{"description":"Created"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"409":{"description":"The tenant for this data does not match the header tenant"}}}},"/api/v1/tagTypes/{tagTypeId}":{"patch":{"tags":["Tag Types"],"summary":"Update Tag Type","description":"Update existing tag type with provided data.","operationId":"patchTagTypeUsingPATCH","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"tagTypeId","in":"path","description":"tagTypeId","required":true,"type":"integer","format":"int32"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/PatchTagType"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TagType"}},"204":{"description":"No Content"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided tag type does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}}},"/api/v1/tagTypes/{tagTypeId}/tags":{"get":{"tags":["Tag Types"],"summary":"Get Tags For Tag Type","description":"Returns all tags for tag type. Result can be returned in flat list or in the parent child hierarchy.","operationId":"getTagsUsingGET_1","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"tagTypeId","in":"path","description":"tagTypeId","required":true,"type":"integer","format":"int32"},{"name":"includeArchived","in":"query","description":"includeArchived","required":false,"type":"boolean","default":false},{"name":"buildHierarchicalList","in":"query","description":"buildHierarchicalList","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Tag"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided tag type does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}},"post":{"tags":["Tag Types"],"summary":"Create Tag For Tag Type","description":"Creates new tag tied to tag type with provided data.","operationId":"createTagUsingPOST","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"tagTypeId","in":"path","description":"tagTypeId","required":true,"type":"integer","format":"int32"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/CreateTag"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Tag"}},"201":{"description":"Created"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided tag type or tag does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}}},"/api/v1/tags":{"get":{"tags":["Tags"],"summary":"Get All Tags","description":"Returns all tags for tenant. Result can be returned in flat list or in the parent child hierarchy.","operationId":"getTagsUsingGET","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"includeArchived","in":"query","description":"includeArchived","required":false,"type":"boolean","default":false},{"name":"buildHierarchicalList","in":"query","description":"buildHierarchicalList","required":false,"type":"boolean","default":false}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Tag"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"patch":{"tags":["Tags"],"summary":"Bulk Update Tags","description":"Update a list of existing tags with new data.","operationId":"patchTagsUsingPATCH","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"in":"body","name":"request","description":"request","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/PatchTags"}}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/Tag"}}},"204":{"description":"No Content"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided event or tag or tag type does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}}},"/api/v1/tags/{tagId}":{"patch":{"tags":["Tags"],"summary":"Update Tag","description":"Update and existing tag with new data.","operationId":"patchTagUsingPATCH","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"tagId","in":"path","description":"tagId","required":true,"type":"integer","format":"int32"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/PatchTag"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/Tag"}},"204":{"description":"No Content"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"The provided event or tag or tag type does not exist"},"409":{"description":"The tenant for this data does not match the header tenant"}}}},"/api/v1/users/subscription/search":{"get":{"tags":["Users"],"summary":"Search Subscriptions","operationId":"searchSubscriptionsUsingGET","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"eventTemplateId","in":"query","description":"eventTemplateId","required":false,"type":"integer","format":"int32"},{"name":"statusId","in":"query","description":"statusId","required":false,"type":"integer","format":"int32"},{"name":"tagIds","in":"query","description":"tagIds","required":false,"type":"array","items":{"type":"integer","format":"int32"},"collectionFormat":"multi"},{"name":"searchFields","in":"query","description":"searchFields","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/UserSubscription"}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}}},"/api/v1/users/{auth0UserId}/subscriptions":{"get":{"tags":["Users"],"summary":"Get Subscriptions for User","operationId":"getUserSubscriptionUsingGET","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"auth0UserId","in":"path","description":"auth0UserId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UserSubscription"}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}}},"delete":{"tags":["Users"],"summary":"Delete Subscriptions for User","operationId":"deleteUserSubscriptionUsingDELETE","produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"auth0UserId","in":"path","description":"auth0UserId","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"string"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}},"patch":{"tags":["Users"],"summary":"Update Subscriptions for User","operationId":"updateUserSubscriptionUsingPATCH","consumes":["application/json"],"produces":["*/*"],"parameters":[{"name":"Authorization","in":"header","description":"Authorization","required":true,"type":"string"},{"name":"X-Tenant","in":"header","description":"X-Tenant","required":true,"type":"string"},{"name":"auth0UserId","in":"path","description":"auth0UserId","required":true,"type":"string"},{"in":"body","name":"request","description":"request","required":true,"schema":{"$ref":"#/definitions/PatchUserSubscription"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/UserSubscription"}},"204":{"description":"No Content"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}}},"definitions":{"AnalyticBreakdown":{"type":"object","properties":{"fields":{"type":"array","items":{"type":"string"}},"values":{"type":"array","items":{"type":"array","items":{"type":"number","format":"double"}}}},"title":"AnalyticBreakdown"},"Comment":{"type":"object","properties":{"comment":{"type":"string"},"commentHeader":{"type":"string"},"createdByAuth0UserId":{"type":"string"},"createdByEmail":{"type":"string"},"createdByName":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"id":{"type":"integer","format":"int32"},"parentComment":{"$ref":"#/definitions/Comment"},"parentCommentId":{"type":"integer","format":"int32"},"updatedByAuth0UserId":{"type":"string"},"updatedByEmail":{"type":"string"},"updatedByName":{"type":"string"},"updatedDate":{"type":"string","format":"date-time"}},"title":"Comment"},"CreateComment":{"type":"object","properties":{"comment":{"type":"string","description":"Comment text","allowEmptyValue":false},"commentHeader":{"type":"string","description":"Header or title describing this comment","allowEmptyValue":false},"parentCommentId":{"type":"integer","format":"int32","description":"ID of parent or in reply to comment","allowEmptyValue":false}},"title":"CreateComment"},"CreateDashboard":{"type":"object","required":["directLinkName","name","organizationExposed"],"properties":{"auditLog":{"type":"string"},"dashboardData":{"description":"Filter data for dashboard","allowEmptyValue":false,"$ref":"#/definitions/SearchEvents"},"defaultView":{"type":"string","description":"Default view for the dashboard. 'list' is default selection","allowEmptyValue":false,"enum":["list","grid","kanban","analytics"]},"description":{"type":"string","description":"Description of the dashobard","allowEmptyValue":false},"directLinkName":{"type":"string","description":"Direct link name for accessing the dashboard","allowEmptyValue":false},"name":{"type":"string","description":"Name of the dashboard","allowEmptyValue":false},"organizationExposed":{"type":"boolean","example":false,"description":"Is this dashboard available for all organization members?","allowEmptyValue":false},"selectedColumns":{"type":"array","description":"What columns are shown for this dashboard, and in what order","allowEmptyValue":false,"items":{"$ref":"#/definitions/Map«string,string»"}}},"title":"CreateDashboard"},"CreateEvent":{"type":"object","required":["name","startingStatusId","tags"],"properties":{"description":{"type":"string","description":"Description of the event","allowEmptyValue":false},"dueDate":{"type":"string","format":"date-time","description":"Date event is due for completion","allowEmptyValue":false},"eventData":{"type":"object","description":"JSON Map of event data fields and label values for the event","allowEmptyValue":false,"additionalProperties":{"$ref":"#/definitions/EventDataLabel"}},"name":{"type":"string","description":"Name of the event","allowEmptyValue":false},"startingStatusComment":{"type":"string","description":"Comment for the initial status of the event","allowEmptyValue":false},"startingStatusId":{"type":"integer","format":"int32","description":"ID of the status this event will start in","allowEmptyValue":false},"tags":{"type":"array","description":"List of tag IDs to be assigned to the event","allowEmptyValue":false,"items":{"type":"integer","format":"int32"}}},"title":"CreateEvent"},"CreateEventData":{"type":"object","required":["name","type"],"properties":{"auditLog":{"type":"string"},"configuration":{"type":"object","description":"Configuration for the event data","allowEmptyValue":false},"description":{"type":"string","description":"Description of the event data field","allowEmptyValue":false},"name":{"type":"string","description":"Field Name of the event data field","allowEmptyValue":false},"order":{"type":"integer","format":"int32","description":"Order to display the event data field?","allowEmptyValue":false},"required":{"type":"boolean","example":false,"description":"Is the Event Data required?","allowEmptyValue":false},"type":{"type":"string","description":"Data type for the field","allowEmptyValue":false,"enum":["Text","Number","Date","Datetime","User","Address","Email","Phone","YesNo"]}},"title":"CreateEventData"},"CreateEventFromEventTemplate":{"type":"object","properties":{"description":{"type":"string","description":"Description of the event","allowEmptyValue":false},"dueDate":{"type":"string","format":"date-time","description":"Due date of the event","allowEmptyValue":false},"eventData":{"type":"object","description":"JSON Map of event data fields and label values for the event","allowEmptyValue":false,"additionalProperties":{"$ref":"#/definitions/EventDataLabel"}},"name":{"type":"string","description":"Name of event - override name on event template - only allowed on templates that have configurable name set to true","allowEmptyValue":false},"startingStatusComment":{"type":"string","description":"Comment for the initial status of the event","allowEmptyValue":false},"startingStatusId":{"type":"integer","format":"int32","description":"Starting status id of the event","allowEmptyValue":false},"tags":{"type":"array","description":"List of tag IDs to be assigned to the event. Only provide this field if you want to override the tags already defined for the Event Template","allowEmptyValue":false,"items":{"type":"integer","format":"int32"}}},"title":"CreateEventFromEventTemplate"},"CreateEventStatus":{"type":"object","required":["completeEvent","statusId"],"properties":{"completeEvent":{"type":"boolean","example":false,"description":"Is this completing the event?","allowEmptyValue":false},"statusComment":{"type":"string","description":"Comment for new status of event","allowEmptyValue":false},"statusId":{"type":"integer","format":"int32","description":"ID of the status","allowEmptyValue":false}},"title":"CreateEventStatus"},"CreateEventTemplate":{"type":"object","required":["defaultStartStatusId","name","tags"],"properties":{"allowActiveDuplicates":{"type":"boolean","example":false,"description":"Allow multiple active events created from the event template","allowEmptyValue":false},"configurableName":{"type":"boolean","example":false,"description":"Allow the name of the event being created or updated from the template to have a different name?","allowEmptyValue":false},"configurableStartStatus":{"type":"boolean","example":false,"description":"Allow the starting status of the event being created or updated from the template to be changed for default","allowEmptyValue":false},"configurableTags":{"type":"boolean","example":false,"description":"Allow different tags to be provided when creating events from this event template?","allowEmptyValue":false},"defaultStartStatusId":{"type":"integer","format":"int32","description":"ID of the status events created from this event template will start in","allowEmptyValue":false},"description":{"type":"string","description":"Description of the event template - also used as the description of events created from this event template","allowEmptyValue":false},"dueDateDefaultTime":{"type":"integer","format":"int64","description":"The amount of time in millis to auto create the due date from the submission time","allowEmptyValue":false},"eventData":{"type":"array","description":"List of event data fields that will be available when creating events from this event template","allowEmptyValue":false,"items":{"type":"integer","format":"int32"}},"eventDataDefaultValues":{"type":"object","description":"JSON Map of event data default values to be displayed on event creation forms when template is selected","allowEmptyValue":false,"additionalProperties":{"type":"string"}},"name":{"type":"string","description":"Name of the event template - also used as the name of events created from this event template","allowEmptyValue":false},"tags":{"type":"array","description":"List of tag IDs to be assigned to the events created from this event template","allowEmptyValue":false,"items":{"type":"integer","format":"int32"}}},"title":"CreateEventTemplate"},"CreateEventsFromForm":{"type":"object","properties":{"createEventFromTemplates":{"type":"object","additionalProperties":{"$ref":"#/definitions/CreateEventFromEventTemplate"}}},"title":"CreateEventsFromForm"},"CreateStatus":{"type":"object","required":["name","statusOrder"],"properties":{"auditLog":{"type":"string"},"endingStatus":{"type":"boolean","example":false,"description":"Does this status represent the ending status for events? If true, when events are moved to this status they will automatically be completed.","allowEmptyValue":false},"icon":{"type":"string","example":"credit_card","description":"Icon for the status. This is a text name of any material icon: https://material.io/tools/icons","allowEmptyValue":false},"iconColor":{"type":"string","example":"#1111111","description":"Color for the status icon. Must be 7 characters in length representing hex color.","allowEmptyValue":false},"name":{"type":"string","description":"Name of the status","allowEmptyValue":false},"requireComment":{"type":"boolean","example":false,"description":"Is a comment required when changing an event to this status.","allowEmptyValue":false},"statusOrder":{"type":"integer","format":"int32","description":"Order of the status in relation to other status. Must be greater than 0.","allowEmptyValue":false}},"title":"CreateStatus"},"CreateTag":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"Name of the tag","allowEmptyValue":false},"parentTagId":{"type":"integer","format":"int32","description":"ID of parent tag - leave null if there is no parent","allowEmptyValue":false}},"title":"CreateTag"},"CreateTagType":{"type":"object","required":["name"],"properties":{"auditLog":{"type":"string"},"description":{"type":"string","description":"Description of the tag type","allowEmptyValue":false},"icon":{"type":"string","example":"credit_card","description":"Icon for the tag type. This is a text name of any material icon: https://material.io/tools/icons","allowEmptyValue":false},"iconColor":{"type":"string","example":"#1111111","description":"Color for the tag type icon. Must be 7 characters in length representing hex color.","allowEmptyValue":false},"name":{"type":"string","description":"Name of the tag type","allowEmptyValue":false}},"title":"CreateTagType"},"Dashboard":{"type":"object","properties":{"createdByEmail":{"type":"string"},"createdByName":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"dashboardData":{"$ref":"#/definitions/SearchEvents"},"defaultView":{"type":"string"},"description":{"type":"string"},"directLinkName":{"type":"string"},"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"organizationExposed":{"type":"boolean"},"selectedColumns":{"type":"array","description":"What columns are shown for this dashboard - this field is not used in event searches but data display in Pingum","allowEmptyValue":false,"items":{"$ref":"#/definitions/Map«string,string»"}},"tenant":{"type":"string"},"updatedByEmail":{"type":"string"},"updatedByName":{"type":"string"},"updatedDate":{"type":"string","format":"date-time"}},"title":"Dashboard"},"Event":{"type":"object","properties":{"archived":{"type":"boolean"},"comments":{"type":"array","items":{"$ref":"#/definitions/Comment"}},"completeDate":{"type":"string","format":"date-time"},"createdByAuth0UserId":{"type":"string"},"createdByEmail":{"type":"string"},"createdByName":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"currentEventStatus":{"$ref":"#/definitions/EventStatus"},"description":{"type":"string"},"dueDate":{"type":"string","format":"date-time"},"eventData":{"type":"object","additionalProperties":{"$ref":"#/definitions/EventDataLabel"}},"eventStatus":{"type":"array","items":{"$ref":"#/definitions/EventStatus"}},"eventStatuses":{"type":"array","items":{"$ref":"#/definitions/EventStatus"}},"eventTemplateId":{"type":"integer","format":"int32"},"eventUploads":{"type":"array","items":{"$ref":"#/definitions/EventUpload"}},"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"startDate":{"type":"string","format":"date-time"},"tags":{"type":"array","items":{"$ref":"#/definitions/Tag"}},"tenant":{"type":"string"},"updatedByAuth0UserId":{"type":"string"},"updatedByEmail":{"type":"string"},"updatedByName":{"type":"string"},"updatedDate":{"type":"string","format":"date-time"}},"title":"Event"},"EventAnalytics":{"type":"object","properties":{"analyticBreakdowns":{"type":"object","additionalProperties":{"$ref":"#/definitions/AnalyticBreakdown"}},"averageActiveTime":{"type":"string"},"averageActiveTimeTrendingComment":{"type":"string"},"averageActiveTimeTrendingIcon":{"type":"string"},"completedEvents":{"type":"integer","format":"int32"},"completedEventsTrendingComment":{"type":"string"},"completedEventsTrendingIcon":{"type":"string"},"createdEvents":{"type":"integer","format":"int32"},"createdEventsTrendingComment":{"type":"string"},"createdEventsTrendingIcon":{"type":"string"}},"title":"EventAnalytics"},"EventData":{"type":"object","properties":{"archived":{"type":"boolean"},"configuration":{"type":"object","description":"What configuration is set for this event data","allowEmptyValue":false},"createdByEmail":{"type":"string"},"createdByName":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"description":{"type":"string"},"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"order":{"type":"integer","format":"int32"},"required":{"type":"boolean"},"tenant":{"type":"string"},"type":{"type":"string"},"updatedByEmail":{"type":"string"},"updatedByName":{"type":"string"},"updatedDate":{"type":"string","format":"date-time"}},"title":"EventData"},"EventDataLabel":{"type":"object","required":["type","value"],"properties":{"type":{"type":"string","description":"Data type for event data","allowEmptyValue":false},"value":{"type":"string","description":"String value of event data","allowEmptyValue":false}},"title":"EventDataLabel"},"EventStatus":{"type":"object","properties":{"completeEvent":{"type":"boolean"},"createdByAuth0UserId":{"type":"string"},"createdByEmail":{"type":"string"},"createdByName":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"id":{"type":"integer","format":"int32"},"startEvent":{"type":"boolean"},"status":{"$ref":"#/definitions/Status"},"statusComment":{"type":"string"}},"title":"EventStatus"},"EventTemplate":{"type":"object","properties":{"allowActiveDuplicates":{"type":"boolean"},"archived":{"type":"boolean"},"configurableName":{"type":"boolean"},"configurableStartStatus":{"type":"boolean"},"configurableTags":{"type":"boolean"},"createdByEmail":{"type":"string"},"createdByName":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"defaultStartStatus":{"$ref":"#/definitions/Status"},"description":{"type":"string"},"dueDateDefaultTime":{"type":"integer","format":"int64"},"eventData":{"type":"array","items":{"$ref":"#/definitions/EventData"}},"eventDataDefaultValues":{"type":"object","additionalProperties":{"type":"string"}},"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"tags":{"type":"array","items":{"$ref":"#/definitions/Tag"}},"tenant":{"type":"string"},"updatedByEmail":{"type":"string"},"updatedByName":{"type":"string"},"updatedDate":{"type":"string","format":"date-time"}},"title":"EventTemplate"},"EventUpload":{"type":"object","properties":{"createdByEmail":{"type":"string"},"createdByName":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"deleted":{"type":"boolean"},"displayName":{"type":"string"},"fileLink":{"type":"string"},"fileName":{"type":"string"},"id":{"type":"integer","format":"int32"},"updatedByEmail":{"type":"string"},"updatedByName":{"type":"string"},"updatedDate":{"type":"string","format":"date-time"}},"title":"EventUpload"},"File":{"type":"object","properties":{"absolute":{"type":"boolean"},"absoluteFile":{"$ref":"#/definitions/File"},"absolutePath":{"type":"string"},"canonicalFile":{"$ref":"#/definitions/File"},"canonicalPath":{"type":"string"},"directory":{"type":"boolean"},"executable":{"type":"boolean"},"file":{"type":"boolean"},"freeSpace":{"type":"integer","format":"int64"},"hidden":{"type":"boolean"},"lastModified":{"type":"integer","format":"int64"},"name":{"type":"string"},"parent":{"type":"string"},"parentFile":{"$ref":"#/definitions/File"},"path":{"type":"string"},"readable":{"type":"boolean"},"totalSpace":{"type":"integer","format":"int64"},"usableSpace":{"type":"integer","format":"int64"},"writable":{"type":"boolean"}},"title":"File"},"InputStream":{"type":"object","title":"InputStream"},"Map«string,string»":{"type":"object","title":"Map«string,string»","additionalProperties":{"type":"string"}},"Pageable":{"type":"object","properties":{"offset":{"type":"integer","format":"int64"},"pageNumber":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32"},"paged":{"type":"boolean"},"sort":{"$ref":"#/definitions/Sort"},"unpaged":{"type":"boolean"}},"title":"Pageable"},"Page«EventTemplate»":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/EventTemplate"}},"empty":{"type":"boolean"},"first":{"type":"boolean"},"last":{"type":"boolean"},"number":{"type":"integer","format":"int32"},"numberOfElements":{"type":"integer","format":"int32"},"pageable":{"$ref":"#/definitions/Pageable"},"size":{"type":"integer","format":"int32"},"sort":{"$ref":"#/definitions/Sort"},"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"}},"title":"Page«EventTemplate»"},"Page«Event»":{"type":"object","properties":{"content":{"type":"array","items":{"$ref":"#/definitions/Event"}},"empty":{"type":"boolean"},"first":{"type":"boolean"},"last":{"type":"boolean"},"number":{"type":"integer","format":"int32"},"numberOfElements":{"type":"integer","format":"int32"},"pageable":{"$ref":"#/definitions/Pageable"},"size":{"type":"integer","format":"int32"},"sort":{"$ref":"#/definitions/Sort"},"totalElements":{"type":"integer","format":"int64"},"totalPages":{"type":"integer","format":"int32"}},"title":"Page«Event»"},"PatchComment":{"type":"object","properties":{"comment":{"type":"string","description":"Comment text","allowEmptyValue":false},"commentHeader":{"type":"string","description":"Header or title describing this comment","allowEmptyValue":false}},"title":"PatchComment"},"PatchDashboard":{"type":"object","required":["organizationExposed"],"properties":{"auditLog":{"type":"string"},"dashboardData":{"description":"Filter data for dashboard","allowEmptyValue":false,"$ref":"#/definitions/SearchEvents"},"defaultView":{"type":"string","description":"Default view for the dashboard. 'list' is default selection","allowEmptyValue":false,"enum":["list","grid","kanban","analytics"]},"description":{"type":"string","description":"Description of the dashobard","allowEmptyValue":false},"directLinkName":{"type":"string","description":"Direct link name for accessing the dashboard","allowEmptyValue":false},"name":{"type":"string","description":"Name of the dashboard","allowEmptyValue":false},"organizationExposed":{"type":"boolean","example":false,"description":"Is this dashboard available for all organization members?","allowEmptyValue":false},"selectedColumns":{"type":"array","description":"What columns are shown for this dashboard, and in what order","allowEmptyValue":false,"items":{"$ref":"#/definitions/Map«string,string»"}}},"title":"PatchDashboard"},"PatchEvent":{"type":"object","properties":{"archived":{"type":"boolean","example":false,"description":"Is the event archived?","allowEmptyValue":false},"completeEvent":{"type":"boolean","example":false,"description":"Is the event complete?","allowEmptyValue":false},"description":{"type":"string","description":"Description of the event","allowEmptyValue":false},"dueDate":{"type":"string","format":"date-time","description":"Date event is due for completion","allowEmptyValue":false},"eventData":{"type":"object","description":"JSON Map of event data fields and label values for the event","allowEmptyValue":false,"additionalProperties":{"$ref":"#/definitions/EventDataLabel"}},"name":{"type":"string","description":"Name of the event","allowEmptyValue":false},"tags":{"type":"array","description":"List of tag IDs to be assigned to the event","allowEmptyValue":false,"items":{"type":"integer","format":"int32"}}},"title":"PatchEvent"},"PatchEventData":{"type":"object","properties":{"archived":{"type":"boolean","example":false,"description":"Is the Event Data archived?","allowEmptyValue":false},"auditLog":{"type":"string"},"configuration":{"type":"object","description":"Configuration for the event data","allowEmptyValue":false},"description":{"type":"string","description":"Description of the event data field","allowEmptyValue":false},"name":{"type":"string","description":"Field Name of the event data field","allowEmptyValue":false},"order":{"type":"integer","format":"int32","description":"Order to display the event data field?","allowEmptyValue":false},"required":{"type":"boolean","example":false,"description":"Is the Event Data required?","allowEmptyValue":false},"type":{"type":"string","description":"Data type for the field","allowEmptyValue":false,"enum":["Text","Number","Date","Datetime","User","Address","Email","Phone","YesNo"]}},"title":"PatchEventData"},"PatchEventStatus":{"type":"object","properties":{"statusComment":{"type":"string","description":"Comment for event status","allowEmptyValue":false}},"title":"PatchEventStatus"},"PatchEventTemplate":{"type":"object","properties":{"allowActiveDuplicates":{"type":"boolean","example":false,"description":"Allow multiple active events created from the event template","allowEmptyValue":false},"archived":{"type":"boolean","example":false,"description":"Is the event template archived","allowEmptyValue":false},"configurableName":{"type":"boolean","example":false,"description":"Allow the name of the event being created or updated from the template to have a different name?","allowEmptyValue":false},"configurableStartStatus":{"type":"boolean","example":false,"description":"Allow the starting status of the event being created or updated from the template to be changed for default","allowEmptyValue":false},"configurableTags":{"type":"boolean","example":false,"description":"Allow different tags to be provided when creating events from this event template?","allowEmptyValue":false},"defaultStartStatusId":{"type":"integer","format":"int32","description":"ID of the status events created from this event template will start in","allowEmptyValue":false},"description":{"type":"string","description":"Description of the event template - also used as the description of events created from this event template","allowEmptyValue":false},"dueDateDefaultTime":{"type":"integer","format":"int64","description":"The amount of time in millis to auto create the due date from the submission time","allowEmptyValue":false},"eventData":{"type":"array","description":"JSON Map of event data fields that will be available when creating events from this event template","allowEmptyValue":false,"items":{"type":"integer","format":"int32"}},"eventDataDefaultValues":{"type":"object","description":"JSON Map of event data default values to be displayed on event creation forms when template is selected","allowEmptyValue":false,"additionalProperties":{"type":"string"}},"name":{"type":"string","description":"Name of the event template - also used as the name of events created from this event template","allowEmptyValue":false},"tags":{"type":"array","description":"List of tag IDs to be assigned to the events created from this event template","allowEmptyValue":false,"items":{"type":"integer","format":"int32"}}},"title":"PatchEventTemplate"},"PatchStatus":{"type":"object","properties":{"archived":{"type":"boolean","example":false,"description":"Is the status archived?","allowEmptyValue":false},"auditLog":{"type":"string"},"endingStatus":{"type":"boolean","example":false,"description":"Does this status represent the ending status for events? If true, when events are moved to this status they will automatically be completed.","allowEmptyValue":false},"icon":{"type":"string","example":"credit_card","description":"Icon for the status. This is a text name of any material icon: https://material.io/tools/icons","allowEmptyValue":false},"iconColor":{"type":"string","example":"#1111111","description":"Color for the status icon. Must be 7 characters in length representing hex color.","allowEmptyValue":false},"name":{"type":"string","description":"Name of the status","allowEmptyValue":false},"requireComment":{"type":"boolean","example":false,"description":"Is a comment required when changing an event to this status.","allowEmptyValue":false},"statusOrder":{"type":"integer","format":"int32","description":"Order of the status in relation to other status. Must be greater than 0.","allowEmptyValue":false}},"title":"PatchStatus"},"PatchSubscriptionEntity":{"type":"object","properties":{"add":{"type":"array","description":"List of IDs to add","allowEmptyValue":false,"items":{"type":"integer","format":"int32"}},"remove":{"type":"array","description":"List of IDs to remove","allowEmptyValue":false,"items":{"type":"integer","format":"int32"}}},"title":"PatchSubscriptionEntity"},"PatchTag":{"type":"object","properties":{"archived":{"type":"boolean","example":false,"description":"Is the tag archived?","allowEmptyValue":false},"customActions":{"description":"Custom actions for patching tags","allowEmptyValue":false,"$ref":"#/definitions/PatchTagCustomActions"},"name":{"type":"string","description":"Name of the tag","allowEmptyValue":false},"parentTagId":{"type":"integer","format":"int32","description":"ID of parent tag - leave null if there is no parent","allowEmptyValue":false},"tagTypeId":{"type":"integer","format":"int32","description":"ID of the tag type associated with this tag","allowEmptyValue":false}},"title":"PatchTag"},"PatchTagCustomActions":{"type":"object","properties":{"removeParentTag":{"type":"boolean","example":false,"description":"Remove the parent tag? If set to true, any parent tag for this tag will be removed and this tag will become a root tag.","allowEmptyValue":false}},"title":"PatchTagCustomActions"},"PatchTagType":{"type":"object","properties":{"archived":{"type":"boolean","example":false,"description":"Is the tag type archived?","allowEmptyValue":false},"auditLog":{"type":"string"},"description":{"type":"string","description":"Description of the tag type","allowEmptyValue":false},"icon":{"type":"string","example":"credit_card","description":"Icon for the tag type. This is a text name of any material icon: https://material.io/tools/icons","allowEmptyValue":false},"iconColor":{"type":"string","example":"#1111111","description":"Color for the tag type icon. Must be 7 characters in length representing hex color.","allowEmptyValue":false},"name":{"type":"string","description":"Name of the tag type","allowEmptyValue":false}},"title":"PatchTagType"},"PatchTags":{"type":"object","required":["tagId"],"properties":{"archived":{"type":"boolean","example":false,"description":"Is the tag archived?","allowEmptyValue":false},"customActions":{"description":"Custom actions for patching tags","allowEmptyValue":false,"$ref":"#/definitions/PatchTagCustomActions"},"name":{"type":"string","description":"Name of the tag","allowEmptyValue":false},"parentTagId":{"type":"integer","format":"int32","description":"ID of parent tag - leave null if there is no parent","allowEmptyValue":false},"tagId":{"type":"integer","format":"int32","description":"ID of the Tag being updated","allowEmptyValue":false},"tagTypeId":{"type":"integer","format":"int32","description":"ID of the tag type associated with this tag","allowEmptyValue":false}},"title":"PatchTags"},"PatchUserSubscription":{"type":"object","properties":{"dashboards":{"description":"Dashboaard subscriptions to update","allowEmptyValue":false,"$ref":"#/definitions/PatchSubscriptionEntity"},"eventTemplates":{"description":"Event Template subscriptions to update","allowEmptyValue":false,"$ref":"#/definitions/PatchSubscriptionEntity"}},"title":"PatchUserSubscription"},"Resource":{"type":"object","properties":{"description":{"type":"string"},"file":{"$ref":"#/definitions/File"},"filename":{"type":"string"},"inputStream":{"$ref":"#/definitions/InputStream"},"open":{"type":"boolean"},"readable":{"type":"boolean"},"uri":{"$ref":"#/definitions/URI"},"url":{"$ref":"#/definitions/URL"}},"title":"Resource"},"SearchEventTemplates":{"type":"object","properties":{"search":{"type":"string"},"statusIds":{"type":"array","items":{"type":"integer","format":"int32"}},"tagConditions":{"type":"array","example":[[27,87],[18]],"description":"The tagConditions field is a conditional search. It will group lists of tag ids together and ensure we grab events which have any of those tag ids in the list. The search next uses an AND condition to grab any other events which have any of the next array of tag Ids based on the previous serches. Ex: [[1,2],[3,4] would return all Event Templates which have a tag with id 1 OR 2. Then with that subset of events, it will filter the returned list with events which have a tag with id 3 OR 4. Events with Tags: [[1 OR 2] AND [3 OR 4] ... ]","allowEmptyValue":false,"items":{"type":"array","items":{"type":"integer","format":"int32"}}}},"title":"SearchEventTemplates"},"SearchEvents":{"type":"object","properties":{"completedLookBackTimeMillis":{"type":"integer","format":"int64","description":"(If including completed events) Number of milliseconds to look back for completed events when searching events","allowEmptyValue":false},"endDate":{"type":"string","format":"date-time","description":"Return all event starting before this date - null means no end date filter - dateFilter value must be null for this field to be used","allowEmptyValue":false},"includeArchived":{"type":"boolean","example":false,"description":"Include archived events?","allowEmptyValue":false},"includeComplete":{"type":"boolean","example":false,"description":"Include completed events?","allowEmptyValue":false},"presetDateFilter":{"type":"string","description":"Filter events in time range - null means no time range fitler","allowEmptyValue":false,"enum":["Today","ThisWeek","ThisMonth"]},"searchText":{"type":"string","description":"Filter result with provided text searching the following fields: Event name/description, Tag name/description, Status name, Comments, and Event Data Fields","allowEmptyValue":false},"sortStartDateDesc":{"type":"boolean","example":false,"description":"Sort result by start date descending or ascending","allowEmptyValue":false},"startDate":{"type":"string","format":"date-time","description":"Return all event starting after this date - null means no start date filter - dateFilter value must be null for this field to be used","allowEmptyValue":false},"statusIds":{"type":"array","description":"Filter result with events in the provided statuses","allowEmptyValue":false,"items":{"type":"integer","format":"int32"}},"tagConditions":{"type":"array","example":[[27,87],[18]],"description":"The tagConditions field is a conditional search. It will group lists of tag ids together and ensure we grab events which have any of those tag ids in the list. The search next uses an AND condition to grab any other events which have any of the next array of tag Ids based on the previous serches. Ex: [[1,2],[3,4] would return all Events which have a tag with id 1 OR 2. Then with that subset of events, it will filter the returned list with events which have a tag with id 3 OR 4. Events with Tags: [[1 OR 2] AND [3 OR 4] ... ]","allowEmptyValue":false,"items":{"type":"array","items":{"type":"integer","format":"int32"}}}},"title":"SearchEvents"},"Sort":{"type":"object","properties":{"empty":{"type":"boolean"},"sorted":{"type":"boolean"},"unsorted":{"type":"boolean"}},"title":"Sort"},"SseEmitter":{"type":"object","properties":{"timeout":{"type":"integer","format":"int64"}},"title":"SseEmitter"},"Status":{"type":"object","properties":{"archived":{"type":"boolean"},"createdByEmail":{"type":"string"},"createdByName":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"endingStatus":{"type":"boolean"},"icon":{"type":"string"},"iconColor":{"type":"string"},"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"requireComment":{"type":"boolean"},"statusOrder":{"type":"integer","format":"int32"},"tenant":{"type":"string"},"updatedByEmail":{"type":"string"},"updatedByName":{"type":"string"},"updatedDate":{"type":"string","format":"date-time"}},"title":"Status"},"SubscriptionId":{"type":"object","properties":{"auth0UserId":{"type":"string"},"tenant":{"type":"string"}},"title":"SubscriptionId"},"Tag":{"type":"object","properties":{"archived":{"type":"boolean"},"children":{"type":"array","items":{"$ref":"#/definitions/Tag"}},"createdByEmail":{"type":"string"},"createdByName":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"parentTag":{"$ref":"#/definitions/Tag"},"tagType":{"$ref":"#/definitions/TagType"},"updatedByEmail":{"type":"string"},"updatedByName":{"type":"string"},"updatedDate":{"type":"string","format":"date-time"}},"title":"Tag"},"TagType":{"type":"object","properties":{"archived":{"type":"boolean"},"createdByEmail":{"type":"string"},"createdByName":{"type":"string"},"createdDate":{"type":"string","format":"date-time"},"description":{"type":"string"},"icon":{"type":"string"},"iconColor":{"type":"string"},"id":{"type":"integer","format":"int32"},"name":{"type":"string"},"tags":{"type":"array","items":{"$ref":"#/definitions/Tag"}},"tenant":{"type":"string"},"updatedByEmail":{"type":"string"},"updatedByName":{"type":"string"},"updatedDate":{"type":"string","format":"date-time"}},"title":"TagType"},"Template":{"type":"object","properties":{"createEventFromTemplate":{"$ref":"#/definitions/CreateEventFromEventTemplate"},"dashboards":{"type":"array","items":{"$ref":"#/definitions/CreateDashboard"}},"eventData":{"type":"array","items":{"$ref":"#/definitions/CreateEventData"}},"eventTemplates":{"type":"array","items":{"$ref":"#/definitions/CreateEventTemplate"}},"statuses":{"type":"array","items":{"$ref":"#/definitions/CreateStatus"}},"tagTypes":{"type":"array","items":{"$ref":"#/definitions/CreateTagType"}}},"title":"Template"},"URI":{"type":"object","properties":{"absolute":{"type":"boolean"},"authority":{"type":"string"},"fragment":{"type":"string"},"host":{"type":"string"},"opaque":{"type":"boolean"},"path":{"type":"string"},"port":{"type":"integer","format":"int32"},"query":{"type":"string"},"rawAuthority":{"type":"string"},"rawFragment":{"type":"string"},"rawPath":{"type":"string"},"rawQuery":{"type":"string"},"rawSchemeSpecificPart":{"type":"string"},"rawUserInfo":{"type":"string"},"scheme":{"type":"string"},"schemeSpecificPart":{"type":"string"},"userInfo":{"type":"string"}},"title":"URI"},"URL":{"type":"object","properties":{"authority":{"type":"string"},"content":{"type":"object"},"defaultPort":{"type":"integer","format":"int32"},"deserializedFields":{"$ref":"#/definitions/URLStreamHandler"},"file":{"type":"string"},"host":{"type":"string"},"path":{"type":"string"},"port":{"type":"integer","format":"int32"},"protocol":{"type":"string"},"query":{"type":"string"},"ref":{"type":"string"},"serializedHashCode":{"type":"integer","format":"int32"},"userInfo":{"type":"string"}},"title":"URL"},"URLStreamHandler":{"type":"object","title":"URLStreamHandler"},"UserSubscription":{"type":"object","properties":{"auth0UserId":{"type":"string"},"dashboards":{"type":"array","items":{"type":"integer","format":"int32"}},"eventTemplates":{"type":"array","items":{"type":"integer","format":"int32"}},"subscriptionId":{"$ref":"#/definitions/SubscriptionId"},"userEmail":{"type":"string"}},"title":"UserSubscription"}}}