openapi-directory/api/signl4.com.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.1","servers":[{"url":"https://connect.signl4.com/api"}],"x-hasEquivalentPaths":true,"info":{"contact":{"url":"https://www.signl4.com/feedback-we-love-hear-from-you/","x-twitter":"signl4me"},"description":"<p>Use our API for systems integration or to build your own use cases. Sample scenarios include but are not limited to:</p><ul><li>2-way integration: Triggering of Signls and updates in the third party systems when alert state changes occur</li><li>Retrieving alarms for logging purposes</li><li>Calendar integrations: Creation and management of on-call duties</li><li>Punch users in and out based on external calendars</li><li>etc.</li></ul><p>AUTHENTICATION<br>Using the API requires an API key, which you can generate in the SIGNL4 portal under 'Developers'.<br>This key must then be specified in a special header in every HTTP request.<br>This header is called <b style='color:#F8B41F'>X-S4-Api-Key</b>.<br><br>The base URL of the API is <a rel='noopener noreferrer' target='_blank' href='https://connect.signl4.com/api/'>https://connect.signl4.com/api/</a>.<br>Copyright © Derdack GmbH<br></p>","license":{"name":"Derdack GmbH","url":"https://www.signl4.com"},"title":"SIGNL4 API","version":"v1","x-apisguru-categories":["messaging"],"x-origin":[{"format":"openapi","url":"https://connect.signl4.com/api/docs/v1/swagger.json","version":"3.0"}],"x-providerName":"signl4.com"},"security":[{"oauth2":["public_api_write","public_api_read","offline_access"]}],"tags":[{"description":"Provide access to all informations about signls and the ability to interact with them.","name":"Alerts"},{"description":"Provides access to services and system categories in a SIGNL4 team.","name":"Categories"},{"description":"Provide access to duty information and the ability to create, delete and update them.","name":"Duties"},{"description":"Provide access to all informations about events and their parameters.","name":"Events"},{"description":"Provides access to the prepaid balance and transactions","name":"Prepaid"},{"description":"Provides access to apps that are available in SIGNL4 and e.g. allows adding an app to a SIGNL4 team.","name":"Scripts"},{"description":"Provides management capabilities for a SIGNL4 subscription.","name":"Subscriptions"},{"description":"Provides misc. operations, e.g. for managing settings or preferences, of a team in a SIGNL4 subscription.","name":"Teams"},{"description":"Provides management for team members in a SIGNL4 team.","name":"Users"},{"description":"Provides management for outbound notifications (e.g. a Signl was confirmed) via webhooks.","name":"Webhooks"}],"paths":{"/alerts":{"post":{"description":"Triggers a new alert for your team. All team members on duty will receive alert notifications.","requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/RaiseAlertInfo"}},"application/json":{"schema":{"$ref":"#/components/schemas/RaiseAlertInfo"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/RaiseAlertInfo"}},"text/json":{"schema":{"$ref":"#/components/schemas/RaiseAlertInfo"}}},"description":"Alert to raise."},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertInfo"}},"text/json":{"schema":{"$ref":"#/components/schemas/AlertInfo"}},"text/plain":{"schema":{"$ref":"#/components/schemas/AlertInfo"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Required information could not be found in the request/claims."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Required entities could not be found in the database."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Internal general error occured."}},"summary":"Trigger Alert","tags":["Alerts"]}},"/alerts/acknowledgeAll":{"post":{"description":"This method confirms all unhandled alerts your team currently has by a specific user.","parameters":[{"description":"User ID of the user to be used to acknowledge the alarms.","in":"query","name":"userId","schema":{"type":"string"}}],"requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusFilterInfo"}},"application/json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusFilterInfo"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusFilterInfo"}},"text/json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusFilterInfo"}}}},"responses":{"204":{"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Required information could not be found in the request/claims."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Required entities could not be found in the database."},"500":{"description":"Internal general error occured."}},"summary":"Confirms all visible alerts","tags":["Alerts"]}},"/alerts/acknowledgeMultiple":{"post":{"description":"This method confirms all alerts provided.","requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusMultipleInfo"}},"application/json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusMultipleInfo"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusMultipleInfo"}},"text/json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusMultipleInfo"}}}},"responses":{"204":{"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Required information could not be found in the request/claims."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Internal general error occured."}},"summary":"Acknowlegde multiple alerts","tags":["Alerts"]}},"/alerts/closeAll":{"post":{"description":"This method closes all acknowledged alerts your team currently has.","parameters":[{"description":"User ID of the user to be used to close the alarms.","in":"query","name":"userId","schema":{"type":"string"}}],"requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusFilterInfo"}},"application/json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusFilterInfo"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusFilterInfo"}},"text/json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusFilterInfo"}}}},"responses":{"204":{"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Required information could not be found in the request/claims."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Required entities could not be found in the database."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Internal general error occured."}},"summary":"Close all acknowledged alerts.","tags":["Alerts"]}},"/alerts/closeMultiple":{"post":{"description":"This method closes all alerts provided.","requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusMultipleInfo"}},"application/json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusMultipleInfo"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusMultipleInfo"}},"text/json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusMultipleInfo"}}}},"responses":{"204":{"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Required information could not be found in the request/claims."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Internal general error occured."}},"summary":"Close multiple alerts","tags":["Alerts"]}},"/alerts/paged":{"post":{"parameters":[{"description":"Defines the limit of retrieved alert details per request. 1 to 100 are allowed per request.\r\n                Number of alerts could be less if filtered but at least 1.","in":"query","name":"maxResults","schema":{"format":"int32","type":"integer"}},{"description":"User ID of the user you want to get alerts for.","in":"query","name":"userId","schema":{"type":"string"}}],"requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/AlertFilterPublic"}},"application/json":{"schema":{"$ref":"#/components/schemas/AlertFilterPublic"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/AlertFilterPublic"}},"text/json":{"schema":{"$ref":"#/components/schemas/AlertFilterPublic"}}},"description":"The filter defines which alerts are supposed to be retrieved."},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverviewAlertPagedResultsPublic"}},"text/json":{"schema":{"$ref":"#/components/schemas/OverviewAlertPagedResultsPublic"}},"text/plain":{"schema":{"$ref":"#/components/schemas/OverviewAlertPagedResultsPublic"}}},"description":"Returns a paged result with found alerts and continuation token if more alerts are in the database."},"204":{"description":"There were no alerts found for the specified filter."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Required parameters could not be found in the request/claims."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Authorization failed"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Internal general error occured."}},"summary":"Gets alerts paged","tags":["Alerts"]}},"/alerts/report":{"get":{"description":"Returns information about the occurred alert volume in different time periods as well as information about the\r\nresponse behaviour (amount of confirmed and unhandled alerts) of your team members.","parameters":[{"description":"User ID of the user for whom you want a report.","in":"query","name":"userId","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertReport"}},"text/json":{"schema":{"$ref":"#/components/schemas/AlertReport"}},"text/plain":{"schema":{"$ref":"#/components/schemas/AlertReport"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Required information could not be found in the request/claims."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Required entities could not be found in the database."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Internal general error occured."}},"summary":"Get Alert Report","tags":["Alerts"]}},"/alerts/undoAcknowledgeMultiple":{"post":{"description":"This method tries to undo the acknowledgement of multiple alerts via a queue. The operation is handled in the background.","requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusMultipleInfo"}},"application/json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusMultipleInfo"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusMultipleInfo"}},"text/json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusMultipleInfo"}}},"description":"Configure which user should be undone for which alerts."},"responses":{"204":{"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Required information could not be found in the request/claims."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Forbidden"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Internal general error occured."}},"summary":"Queue undo of multiple acknowledgments.","tags":["Alerts"]}},"/alerts/undoCloseMultiple":{"post":{"description":"This method tries to undo multiple alert closes. The operation is handled in the background.","requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusMultipleInfo"}},"application/json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusMultipleInfo"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusMultipleInfo"}},"text/json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusMultipleInfo"}}}},"responses":{"204":{"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Required information could not be found in the request/claims."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Internal general error occured."}},"summary":"Withdraw closure of multiple alerts","tags":["Alerts"]}},"/alerts/{alertId}":{"get":{"description":"Gets an alert by id.","parameters":[{"description":"Id of the requested Alert.","in":"path","name":"alertId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertInfo"}},"text/json":{"schema":{"$ref":"#/components/schemas/AlertInfo"}},"text/plain":{"schema":{"$ref":"#/components/schemas/AlertInfo"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Required information could not be found in the request/claims."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Required entities could not be found in the database."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Internal general error occured."}},"summary":"Get Alert","tags":["Alerts"]}},"/alerts/{alertId}/acknowledge":{"post":{"parameters":[{"description":"Id to acknowledge an alert.","in":"path","name":"alertId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusInfo"}},"application/json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusInfo"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusInfo"}},"text/json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusInfo"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertInfo"}},"text/json":{"schema":{"$ref":"#/components/schemas/AlertInfo"}},"text/plain":{"schema":{"$ref":"#/components/schemas/AlertInfo"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Required information could not be found in the request/claims."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"No alert with id was found."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Alert can't be acknowledged because it is against the defined alert lifecycle."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Internal general error occured."}},"summary":"Acknowledge an alert","tags":["Alerts"]}},"/alerts/{alertId}/annotate":{"post":{"description":"Annotates an alert by given Annotation Info.","parameters":[{"description":"Id of the alert to annotate.","in":"path","name":"alertId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/AlertAnnotationInfo"}},"application/json":{"schema":{"$ref":"#/components/schemas/AlertAnnotationInfo"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/AlertAnnotationInfo"}},"text/json":{"schema":{"$ref":"#/components/schemas/AlertAnnotationInfo"}}},"description":"Annotation Information."},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertAnnotationInfo"}},"text/json":{"schema":{"$ref":"#/components/schemas/AlertAnnotationInfo"}},"text/plain":{"schema":{"$ref":"#/components/schemas/AlertAnnotationInfo"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Required information could not be found in the request/claims."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Required entities could not be found in the database."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Internal general error occured."}},"summary":"Annotate Alert","tags":["Alerts"]}},"/alerts/{alertId}/annotations":{"get":{"description":"Get annotations of an alert by id.","parameters":[{"description":"Id of the requested Alert.","in":"path","name":"alertId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/AlertAnnotationInfo"},"type":"array"}},"text/json":{"schema":{"items":{"$ref":"#/components/schemas/AlertAnnotationInfo"},"type":"array"}},"text/plain":{"schema":{"items":{"$ref":"#/components/schemas/AlertAnnotationInfo"},"type":"array"}}},"description":"Success"},"204":{"description":"No annotations were found for the alert."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Required information could not be found in the request/claims."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Not Found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Server Error"}},"summary":"Get annotations of an alert","tags":["Alerts"]}},"/alerts/{alertId}/attachments":{"get":{"description":"Get attachments of an alert by id.","parameters":[{"description":"Id of the requested Alert.","in":"path","name":"alertId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/AlertAttachmentInfo"},"type":"array"}},"text/json":{"schema":{"items":{"$ref":"#/components/schemas/AlertAttachmentInfo"},"type":"array"}},"text/plain":{"schema":{"items":{"$ref":"#/components/schemas/AlertAttachmentInfo"},"type":"array"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Required information could not be found in the request/claims."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Required entities could not be found in the database."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Internal general error occured."}},"summary":"Get attachments of an alert","tags":["Alerts"]}},"/alerts/{alertId}/attachments/{attachmentId}":{"get":{"parameters":[{"description":"Id of the alert that contains the wanted attachment.","in":"path","name":"alertId","required":true,"schema":{"type":"string"}},{"description":"Id of the attachment, that you want to retrieve.","in":"path","name":"attachmentId","required":true,"schema":{"type":"string"}},{"description":"Optional parameter defining the wanted width of the picture that is retrieved.","in":"query","name":"width","schema":{"format":"int32","type":"integer"}},{"description":"Optional parameter defining the wanted height of the picture that is retrieved.","in":"query","name":"height","schema":{"format":"int32","type":"integer"}},{"description":"Optional parameter defining whether it's wanted to scale the retrieved image. Default is set to\r\ntrue.","in":"query","name":"scale","schema":{"default":true,"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"format":"binary","type":"string"}},"text/json":{"schema":{"format":"binary","type":"string"}},"text/plain":{"schema":{"format":"binary","type":"string"}}},"description":"Returns the attachment image with additional meta information."},"204":{"description":"The image of the attachment was not uploaded yet."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"A passed parameter was either empty or invalid."},"403":{"description":"Authorization failed."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"The attachment image was not found."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Internal general error occured."}},"summary":"Gets a specified attachment of a specified alert.","tags":["Alerts"]}},"/alerts/{alertId}/close":{"post":{"parameters":[{"description":"Id to acknowledge an alert.","in":"path","name":"alertId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusInfo"}},"application/json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusInfo"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusInfo"}},"text/json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusInfo"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertInfo"}},"text/json":{"schema":{"$ref":"#/components/schemas/AlertInfo"}},"text/plain":{"schema":{"$ref":"#/components/schemas/AlertInfo"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Required information could not be found in the request/claims."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"No alert with id was found."},"409":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Alert can't be closed because it is against the defined alert lifecycle."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Internal general error occured."}},"summary":"Close an alert","tags":["Alerts"]}},"/alerts/{alertId}/notifications":{"get":{"description":"Get notifications of all users by alert id.","parameters":[{"description":"Id of the requested Alert.","in":"path","name":"alertId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/AlertNotificationInfo"},"type":"array"}},"text/json":{"schema":{"items":{"$ref":"#/components/schemas/AlertNotificationInfo"},"type":"array"}},"text/plain":{"schema":{"items":{"$ref":"#/components/schemas/AlertNotificationInfo"},"type":"array"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Required information could not be found in the request/claims."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Required entities could not be found in the database."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Internal general error occured."}},"summary":"Get alert notifications","tags":["Alerts"]}},"/alerts/{alertId}/overview":{"get":{"description":"Get overview alert by id.","parameters":[{"description":"Id of the requested Alert.","in":"path","name":"alertId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverviewAlert"}},"text/json":{"schema":{"$ref":"#/components/schemas/OverviewAlert"}},"text/plain":{"schema":{"$ref":"#/components/schemas/OverviewAlert"}}},"description":"Returns alert with all information attached."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Required information could not be found in the request/claims."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Required entities could not be found in the database."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Server Error"}},"summary":"Get an overview alert.","tags":["Alerts"]}},"/alerts/{alertId}/undoAcknowledge":{"post":{"description":"This method tries to undo an alert acknowledgement.","parameters":[{"in":"path","name":"alertId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusInfo"}},"application/json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusInfo"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusInfo"}},"text/json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusInfo"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverviewAlert"}},"text/json":{"schema":{"$ref":"#/components/schemas/OverviewAlert"}},"text/plain":{"schema":{"$ref":"#/components/schemas/OverviewAlert"}}},"description":"Returns updated alert."},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Required information could not be found in the request/claims."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"User is not allowed to undo the acknowledgement."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Internal general error occured."}},"summary":"Undo the acknowledgement of an alert.","tags":["Alerts"]}},"/alerts/{alertId}/undoClose":{"post":{"description":"This method tries to undo an alert close.","parameters":[{"in":"path","name":"alertId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusInfo"}},"application/json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusInfo"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusInfo"}},"text/json":{"schema":{"$ref":"#/components/schemas/ChangeAlertStatusInfo"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OverviewAlert"}},"text/json":{"schema":{"$ref":"#/components/schemas/OverviewAlert"}},"text/plain":{"schema":{"$ref":"#/components/schemas/OverviewAlert"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Required information could not be found in the request/claims."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"User is not allowed to undo the close."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Internal general error occured."}},"summary":"Undo the closure of an alert.","tags":["Alerts"]}},"/categories/images":{"get":{"responses":{"200":{"content":{"application/json":{"schema":{"items":{"type":"string"},"type":"array"}},"text/json":{"schema":{"items":{"type":"string"},"type":"array"}},"text/plain":{"schema":{"items":{"type":"string"},"type":"array"}}},"description":"Returns the alert categories."},"204":{"description":"Request was canceled."},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"If you have no permission to access the resource."},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"No categories were found."},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"Internal general error occured."}},"summary":"Gets the names of all alert category images.\r\nYou can get the image by going to account.signl4.com/images/alerts/categoryImageName.svg","tags":["Categories"]}},"/categories/{teamId}":{"get":{"description":"Sample Request:\r\n            \r\n    GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7","parameters":[{"description":"ID of the team the categories belong to","in":"path","name":"teamId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CategoryInfo"},"type":"array"}},"text/json":{"schema":{"items":{"$ref":"#/components/schemas/CategoryInfo"},"type":"array"}},"text/plain":{"schema":{"items":{"$ref":"#/components/schemas/CategoryInfo"},"type":"array"}}},"description":"Returns the category infos"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"If the input is not valid"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"If you have no permission to access this resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"If the resource was not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"If any server side errors occur"}},"summary":"Get all categories","tags":["Categories"]},"post":{"description":"Sample Request:\r\n            \r\n    POST /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7\r\n    {\r\n        \"name\": \"Water\",\r\n        \"imageName\": \"water.svg\",\r\n        \"color\": \"#0000cc\",\r\n        \"keywordMatching\": \"Any\",\r\n        \"keywords\": [\r\n            {\r\n                \"value\": \"H2O\"\r\n            },\r\n            {\r\n                \"value\": \"Water\"\r\n            }\r\n        ]\r\n    }","parameters":[{"description":"ID of the team the category belongs to","in":"path","name":"teamId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/*+json":{"schema":{"$ref":"#/components/schemas/CategoryInfo"}},"application/json":{"schema":{"$ref":"#/components/schemas/CategoryInfo"}},"application/json-patch+json":{"schema":{"$ref":"#/components/schemas/CategoryInfo"}},"text/json":{"schema":{"$ref":"#/components/schemas/CategoryInfo"}}},"description":"Category to be created"},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryInfo"}},"text/json":{"schema":{"$ref":"#/components/schemas/CategoryInfo"}},"text/plain":{"schema":{"$ref":"#/components/schemas/CategoryInfo"}}},"description":"Returns the newly created category"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"If the input is not valid"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"If you have no permission to access this resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"If the resource was not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"If any server side errors occur"}},"summary":"Create a new category","tags":["Categories"]}},"/categories/{teamId}/metrics":{"get":{"description":"Sample Request:\r\n            \r\n    GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/metrics","parameters":[{"description":"ID of the team the categories belongs to","in":"path","name":"teamId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CategoryMetrics"},"type":"array"}},"text/json":{"schema":{"items":{"$ref":"#/components/schemas/CategoryMetrics"},"type":"array"}},"text/plain":{"schema":{"items":{"$ref":"#/components/schemas/CategoryMetrics"},"type":"array"}}},"description":"Returns a list of category metrics"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"If the input is not valid"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"If you have no permission to access this resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"If the resource was not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"If any server side errors occur"}},"summary":"Get metrics for all categories","tags":["Categories"]}},"/categories/{teamId}/{categoryId}":{"delete":{"description":"Sample Request:\r\n            \r\n    DELETE /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e","parameters":[{"description":"ID of the team the category belongs to","in":"path","name":"teamId","required":true,"schema":{"type":"string"}},{"description":"ID of the category to delete","in":"path","name":"categoryId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"If the delete operation was successful"},"204":{"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"If the input is not valid"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"If you have no permission to access this resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"If the resource was not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"If any server side errors occur"}},"summary":"Delete an existing category","tags":["Categories"]},"get":{"description":"Sample Request:\r\n            \r\n    GET /categories/cbb70402-1359-477f-ac92-0171cf2b5ff7/c0054336-cd89-4abf-882d-ba69b5adb25e","parameters":[{"description":"ID of the team the category belongs to","in":"path","name":"teamId","required":true,"schema":{"type":"string"}},{"description":"ID of the category to get","in":"path","name":"categoryId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryInfo"}},"text/json":{"schema":{"$ref":"#/components/schemas/CategoryInfo"}},"text/plain":{"schema":{"$ref":"#/components/schemas/CategoryInfo"}}},"description":"Returns the category details"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"If the input is not valid"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"If you have no permission to access this resource"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}},"description":"If the resource was not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/json":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}},"text/plain":{"schema":{"$ref":"#/components/schemas/ErrorResponseContent"}}}