{"openapi":"3.0.1","info":{"contact":{"email":"bkama@atlassian.com"},"description":"Operations APIs for Compass","title":"Compass Operations API","version":"2"},"servers":[{"url":"https://api.atlassian.com/compass/cloud/{cloudId}/ops","description":"Generated server url"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"schemas":{"ErrorResponses":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ErrorResponse":{"type":"object","properties":{"title":{"type":"string"},"code":{"type":"string"}}},"UnauthorizedErrorResponse":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"}}},"SchedulePaginationLinks":{"description":"Links for the other pages.","type":"object","properties":{"next":{"type":"string","description":"Link to the next page of results.","example":"/v1/schedules?offset=50&size=25"}}},"CreateRotationRequest":{"required":["startDate","type"],"type":"object","properties":{"name":{"type":"string","description":"Name of the rotation.","example":"Daily rotation"},"startDate":{"type":"string","format":"date-time","description":"Start time of the rotation.","example":"2023-11-10T05:00:00Z"},"endDate":{"type":"string","format":"date-time","description":"End time of the rotation.","example":"2024-04-28T10:00:00Z"},"type":{"type":"string","enum":["daily","weekly","hourly"],"description":"Type of the rotation.","example":"weekly"},"length":{"minimum":1,"default":1,"type":"integer","format":"int32","description":"Length of the rotation based on type.","example":2},"participants":{"type":"array","items":{"$ref":"#/components/schemas/ResponderInfo"},"description":"Participants of the rotation.","example":[{"type":"user","id":"14a994fd-78c6-4236-8b83-d107e5d32d6a"},{"type":"team","id":"2ad4505d-d7a9-4997-8745-c40a3b641573"}]},"timeRestriction":{"oneOf":[{"$ref":"#/components/schemas/TimeOfDayTimeRestrictionRequest"},{"$ref":"#/components/schemas/WeekdayTimeRestrictionRequest"}]}}},"UpdateScheduleRequest":{"type":"object","properties":{"name":{"type":"string","description":"Name of the schedule.","example":"Support Schedule"},"teamId":{"type":"string","description":"ID of the team that schedule belongs to. Set as empty string to change it to global schedule.","example":"cd68207b-c55d-4611-ab25-72fd0c439e9f"},"description":{"type":"string","description":"Description of the schedule.","example":"On-call schedule for support team"},"timezone":{"type":"string","description":"Time zone ID of the schedule.","example":"America/New_York"},"enabled":{"type":"boolean","description":"Indicates whether the schedule is enabled or not.","example":true},"rotations":{"type":"array","items":{"$ref":"#/components/schemas/CreateRotationRequest"}}}},"ErrorResponseList":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/SchedulesErrorResponse"}}}},"TimelineRotation":{"type":"object","properties":{"id":{"type":"string","description":"ID of the rotation."},"name":{"type":"string","description":"Name of the rotation."},"order":{"type":"number","format":"float","description":"Order of the rotation. Empty if the rotation has been deleted."},"deleted":{"type":"boolean","description":"Indicates whether the rotation is deleted or not."},"periods":{"type":"array","items":{"$ref":"#/components/schemas/TimelinePeriod"},"description":"List of the on-call periods that belong to the rotation."}}},"UpdateOverrideRequest":{"required":["endDate","responder","startDate"],"type":"object","properties":{"responder":{"$ref":"#/components/schemas/OverrideResponderInfo"},"startDate":{"type":"string","format":"date-time","description":"Start time of the override.","example":"2023-11-27T05:00:00Z"},"endDate":{"type":"string","format":"date-time","description":"End time of the override.","example":"2023-11-28T10:00:00Z"},"rotationIds":{"type":"array","items":{"type":"string"},"description":"IDs of the rotations that the override is applied to. Should be null to apply the override to all rotations.","example":["dec43451-becf-4d2b-99c6-2f98ff2c1eb3","0c829882-7de3-431e-8b64-8edcca7606d8"]}}},"TimeOfDayTimeRestrictionSettings":{"description":"Details of the time restriction. Returned if the type of the time restriction is `time-of-day`.","type":"object","properties":{"startHour":{"maximum":23,"minimum":0,"type":"integer","format":"int32","description":"Start hour of the time restriction.","example":10},"endHour":{"maximum":23,"minimum":0,"type":"integer","format":"int32","description":"End hour of the time restriction.","example":20},"startMin":{"maximum":59,"minimum":0,"type":"integer","format":"int32","description":"Start minute of the time restriction.","example":30},"endMin":{"maximum":59,"minimum":0,"type":"integer","format":"int32","description":"End minute of the time restriction.","example":0}}},"WeekdayTimeRestrictionSettings":{"type":"object","properties":{"startDay":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"description":"Start day of the time restriction."},"endDay":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"description":"End day of the time restriction."},"startHour":{"maximum":23,"minimum":0,"type":"integer","format":"int32","description":"Start hour of the time restriction."},"endHour":{"maximum":23,"minimum":0,"type":"integer","format":"int32","description":"End hour of the time restriction."},"startMin":{"maximum":59,"minimum":0,"type":"integer","format":"int32","description":"Start minute of the time restriction."},"endMin":{"maximum":59,"minimum":0,"type":"integer","format":"int32","description":"End minute of the time restriction."}}},"CreateScheduleRequest":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"Name of the schedule. Cannot be empty.","example":"Support Schedule"},"teamId":{"type":"string","description":"ID of the team that schedule belongs to.","example":"cd68207b-c55d-4611-ab25-72fd0c439e9f"},"description":{"type":"string","description":"Description of the schedule.","example":"On-call schedule for support team"},"timezone":{"type":"string","default":"America/New_York","description":"Time zone ID of the schedule.","example":"America/New_York"},"enabled":{"type":"boolean","default":true,"description":"Indicates whether the schedule is enabled or not.","example":true},"rotations":{"minItems":1,"maxItems":500,"type":"array","items":{"$ref":"#/components/schemas/CreateRotationRequest"},"description":"Rotation details of the schedule."}}},"WeekdayTimeRestrictionRequest":{"description":"Time restrictions of the rotation.","required":["type"],"type":"object","properties":{"type":{"type":"string","default":"weekday-and-time-of-day","description":"Type of the time restriction.","example":"time-of-day"},"restrictions":{"type":"array","items":{"$ref":"#/components/schemas/WeekdayTimeRestrictionSettingsRequest"},"example":null}}},"OnCallParticipants":{"type":"object","description":"Details of the on-call participants. Returned only `flat=false` is sent in the request.","properties":{"onCallParticipants":{"type":"array","items":{"$ref":"#/components/schemas/OnCallParticipant"}}}},"TimeOfDayTimeRestrictionRequest":{"description":"Time restrictions of the rotation.","required":["type"],"type":"object","properties":{"type":{"type":"string","default":"time-of-day","description":"Type of the time restriction.","example":"time-of-day"},"restriction":{"$ref":"#/components/schemas/TimeOfDayTimeRestrictionSettingsRequest"}}},"CreateOverrideRequest":{"required":["endDate","responder","startDate"],"type":"object","properties":{"responder":{"$ref":"#/components/schemas/OverrideResponderInfo"},"startDate":{"type":"string","format":"date-time","description":"Start time of the override.","example":"2023-11-27T05:00:00Z"},"endDate":{"type":"string","format":"date-time","description":"End time of the override.","example":"2023-11-28T10:00:00Z"},"rotationIds":{"type":"array","items":{"type":"string"},"description":"IDs of the rotations that this override is applied to. Should be null to apply override to all rotations.","example":["dec43451-becf-4d2b-99c6-2f98ff2c1eb3","0c829882-7de3-431e-8b64-8edcca7606d8"]}}},"WeekdayTimeRestriction":{"type":"object","properties":{"type":{"type":"string","default":"weekday-and-time-of-day","description":"Type of the time restriction."},"restrictions":{"type":"array","items":{"$ref":"#/components/schemas/WeekdayTimeRestrictionSettings"},"description":"Details of the time restriction. Returned if the type of the time restriction is `weekday-and-time-of-day`."}}},"TimelinePeriod":{"type":"object","properties":{"startDate":{"type":"string","format":"date-time","description":"Start time of the on-call period."},"endDate":{"type":"string","format":"date-time","description":"End time of the on-call period."},"type":{"type":"string","enum":["base","override","forwarding","historical"],"description":"Type of the on-call period."},"from":{"$ref":"#/components/schemas/ForwardingResponder"},"responder":{"$ref":"#/components/schemas/TimelineResponder"},"flattenedResponders":{"type":"array","items":{"$ref":"#/components/schemas/TimelineResponder"},"description":"List of the flattened responders of the on-call period."}}},"ListSchedulesResponse":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/Schedule"},"description":"List of the schedules."},"links":{"$ref":"#/components/schemas/SchedulePaginationLinks"},"_expands":{"type":"array","items":{"type":"string"},"description":"List of all possible expansions.","example":["rotation"]}}},"ForwardingResponder":{"description":"Information of the forwarding user.","type":"object","properties":{"id":{"type":"string","description":"ID of the responder.","example":"15b35ada-89be-4e79-b9e8-509f6f25bb42"},"type":{"type":"string","enum":["user"],"description":"Type of the responder.","example":"user"},"deleted":{"type":"boolean","description":"Indicates whether the responder is deleted or not.","example":false}}},"OnCallResponse":{"type":"object","example":{"onCallParticipants":[{"id":"bc667897-cb21-496f-a46e-7c05ff0419dd","type":"team"},{"id":"5b2b0e011b3a756623f4e25e","type":"user"},{"id":"7a24e9d7-7a4f-4f86-a1df-21ca9c3112ac","type":"escalation","onCallParticipants":[{"id":"5b2b0e011b3a756623f4e25e","type":"user","forwardedFrom":{"id":"c5646941-3f05-404d-8594-825fa73af99f","type":"user"}}]}]},"oneOf":[{"$ref":"#/components/schemas/OnCallParticipants"},{"$ref":"#/components/schemas/OnCallUsers"}]},"NextOnCallParticipants":{"type":"object","description":"Details of the next on-call participants. Returned only `flat=false` is sent in the request.","properties":{"nextOnCallParticipants":{"type":"array","items":{"$ref":"#/components/schemas/OnCallParticipant"}}}},"UpdateRotationRequest":{"type":"object","properties":{"name":{"type":"string","description":"Name of the rotation.","example":"Daily rotation"},"startDate":{"type":"string","format":"date-time","description":"Start time of the rotation.","example":"2023-11-10T05:00:00Z"},"endDate":{"type":"string","format":"date-time","description":"End time of the rotation.","example":"2024-04-28T10:00:00Z"},"type":{"type":"string","enum":["daily","weekly","hourly"],"description":"Type of the rotation.","example":"weekly"},"length":{"minimum":1,"default":1,"type":"integer","format":"int32","description":"Length of the rotation based on type.","example":2},"participants":{"type":"array","items":{"$ref":"#/components/schemas/ResponderInfo"},"description":"Participants of the rotation.","example":[{"type":"user","id":"14a994fd-78c6-4236-8b83-d107e5d32d6a"},{"type":"team","id":"2ad4505d-d7a9-4997-8745-c40a3b641573"}]},"timeRestriction":{"oneOf":[{"$ref":"#/components/schemas/TimeOfDayTimeRestrictionRequest"},{"$ref":"#/components/schemas/WeekdayTimeRestrictionRequest"}]}}},"ListOverridesResponse":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/Override"}},"links":{"$ref":"#/components/schemas/OverridePaginationLinks"}}},"SchedulesErrorResponse":{"type":"object","properties":{"title":{"type":"string"},"code":{"type":"string"}}},"OnCallParticipant":{"type":"object","properties":{"id":{"type":"string","description":"ID of the on-call participant."},"type":{"type":"string","description":"Type of the on-call participant."},"onCallParticipants":{"type":"array","items":{"$ref":"#/components/schemas/OnCallParticipant"},"description":"List of the flattened participants of the participant."},"forwardedFrom":{"description":"The details of the forwarding participant. Only set if the participant is on-call because of another participant that has forwarding to current participant.","allOf":[{"$ref":"#/components/schemas/OnCallParticipant"}]}}},"TimelineResponder":{"description":"The responder of the on-call period.","type":"object","properties":{"id":{"type":"string","description":"ID of the responder."},"type":{"type":"string","enum":["user","team","escalation","noone"],"description":"Type of the responder."},"deleted":{"type":"boolean","description":"Indicates whether the responder is deleted or not."}}},"Override":{"type":"object","properties":{"alias":{"type":"string","description":"Alias of the override.","example":"c73c3ffa-dcc3-4f28-ad13-d150ec108fc9"},"responder":{"$ref":"#/components/schemas/OverrideResponderInfo"},"startDate":{"type":"string","format":"date-time","description":"Start time of the override.","example":"2023-11-27T05:00:00Z"},"endDate":{"type":"string","format":"date-time","description":"End time of the override.","example":"2023-11-28T10:00:00Z"},"rotationIds":{"type":"array","items":{"type":"string"},"description":"IDs of the rotations that override applies to. Null if no rotation is specified during override creation.","example":["dec43451-becf-4d2b-99c6-2f98ff2c1eb3","0c829882-7de3-431e-8b64-8edcca7606d8"]}}},"NextOnCallResponse":{"type":"object","example":{"nextOnCallParticipants":[{"id":"bc667897-cb21-496f-a46e-7c05ff0419dd","type":"team"},{"id":"5b2b0e011b3a756623f4e25e","type":"user"},{"id":"7a24e9d7-7a4f-4f86-a1df-21ca9c3112ac","type":"escalation","nextOnCallParticipants":[{"id":"5b2b0e011b3a756623f4e25e","type":"user","forwardedFrom":{"id":"c5646941-3f05-404d-8594-825fa73af99f","type":"user"}}]}]},"oneOf":[{"$ref":"#/components/schemas/NextOnCallParticipants"},{"$ref":"#/components/schemas/NextOnCallUsers"}]},"ScheduleTimelineResponse":{"type":"object","example":{"startDate":"2024-01-29T00:00:00Z","endDate":"2024-02-12T00:00:00Z","finalTimeline":{"rotations":[{"id":"072cb9c1-698e-49fa-b1dc-1e8c190a76a6","name":"Primary Rotation","order":1,"deleted":false,"periods":[{"startDate":"2024-01-29T00:00:00Z","endDate":"2024-02-01T08:11:21.263Z","type":"historical","responder":{"id":"153c98d1-ca2c-44d8-b8ea-10280f7c2c75","type":"team"},"flattenedResponders":[{"id":"153c98d1-ca2c-44d8-b8ea-10280f7c2c75","type":"team"}]},{"startDate":"2024-02-01T08:11:21.263Z","endDate":"2024-02-01T08:12:19.866Z","type":"historical","responder":{"id":"5b2b0e011b3a756623f4e25e","type":"user"},"flattenedResponders":[{"id":"5b2b0e011b3a756623f4e25e","type":"user"}]},{"startDate":"2024-02-01T08:12:19.866Z","endDate":"2024-02-02T00:00:00Z","type":"override","responder":{"id":"5b2b0e011b3a756623f4e25e","type":"user"}},{"startDate":"2024-02-02T00:00:00Z","endDate":"2024-02-03T07:00:00Z","type":"base","responder":{"id":"153c98d1-ca2c-44d8-b8ea-10280f7c2c75","type":"team"}},{"startDate":"2024-02-03T07:00:00Z","endDate":"2024-02-05T21:00:00Z","type":"base","responder":{"id":"5b2b0e011b3a756623f4e25e","type":"user"}},{"startDate":"2024-02-05T21:00:00Z","endDate":"2024-02-06T21:00:00Z","type":"forwarding","from":{"id":"40973cb0-6990-4997-aac3-46f8a6031f0f","type":"user","deleted":false},"responder":{"id":"e75fed1b-4234-45bc-b5b3-b936979f3cc0","type":"user"}},{"startDate":"2024-02-06T21:00:00Z","endDate":"2024-02-10T07:00:00Z","type":"base","responder":{"id":"5b2b0e011b3a756623f4e25e","type":"user"}},{"startDate":"2024-02-10T07:00:00Z","endDate":"2024-02-12T00:00:00Z","type":"base","responder":{"id":"153c98d1-ca2c-44d8-b8ea-10280f7c2c75","type":"team"}}]},{"id":"18b6b7e7-b83b-4b18-81c2-e3f7ceb9ef7b","name":"Secondary Rotation","order":4,"deleted":false,"periods":[{"startDate":"2024-01-29T00:00:00Z","endDate":"2024-02-01T07:00:00Z","type":"historical","responder":{"id":"ab73148c-afa6-4604-ae04-7dc5daea6c8b","type":"escalation"},"flattenedResponders":[{"id":"e75fed1b-4234-45bc-b5b3-b936979f3cc0","type":"user"},{"id":"5b2b0e011b3a756623f4e25e","type":"user"}]},{"startDate":"2024-02-01T07:00:00Z","endDate":"2024-02-01T08:12:19.866Z","type":"historical","responder":{"id":"5b2b0e011b3a756623f4e25e","type":"user"},"flattenedResponders":[{"id":"5b2b0e011b3a756623f4e25e","type":"user"}]},{"startDate":"2024-02-01T08:12:19.866Z","endDate":"2024-02-04T00:00:00Z","type":"base","responder":{"id":"5b2b0e011b3a756623f4e25e","type":"user"}},{"startDate":"2024-02-04T00:00:00Z","endDate":"2024-02-05T00:00:00Z","type":"override","responder":{"id":"e75fed1b-4234-45bc-b5b3-b936979f3cc0","type":"user"}},{"startDate":"2024-02-05T00:00:00Z","endDate":"2024-02-05T21:00:00Z","type":"base","responder":{"id":"5b2b0e011b3a756623f4e25e","type":"user"}},{"startDate":"2024-02-05T21:00:00Z","endDate":"2024-02-06T21:00:00Z","type":"forwarding","from":{"id":"40973cb0-6990-4997-aac3-46f8a6031f0f","type":"user","deleted":false},"responder":{"id":"e75fed1b-4234-45bc-b5b3-b936979f3cc0","type":"user"}},{"startDate":"2024-02-06T21:00:00Z","endDate":"2024-02-12T00:00:00Z","type":"base","responder":{"id":"5b2b0e011b3a756623f4e25e","type":"user"}}]},{"id":"9625a842-18b0-464f-8d6e-b5ea33af8a13","name":"Backup Rotation","order":null,"deleted":true,"periods":[{"startDate":"2024-01-29T00:00:00Z","endDate":"2024-01-29T12:00:00Z","type":"historical","responder":{"type":"noone"}},{"startDate":"2024-01-29T12:00:00Z","endDate":"2024-01-30T12:00:00Z","type":"historical","responder":{"id":"ab73148c-afa6-4604-ae04-7dc5daea6c8b","type":"escalation"},"flattenedResponders":[{"id":"e75fed1b-4234-45bc-b5b3-b936979f3cc0","type":"user"},{"id":"5b2b0e011b3a756623f4e25e","type":"user"}]},{"startDate":"2024-01-30T12:00:00Z","endDate":"2024-01-31T12:00:00Z","type":"historical","responder":{"type":"noone"}},{"startDate":"2024-01-31T12:00:00Z","endDate":"2024-02-01T07:59:12.993Z","type":"historical","responder":{"id":"ab73148c-afa6-4604-ae04-7dc5daea6c8b","type":"escalation"},"flattenedResponders":[{"id":"e75fed1b-4234-45bc-b5b3-b936979f3cc0","type":"user"},{"id":"5b2b0e011b3a756623f4e25e","type":"user"}]}]},{"id":"2adfb43b-dfdf-455d-9e67-6bd4cce76d11","name":"Old Rotation","order":null,"deleted":true,"periods":[{"startDate":"2024-01-29T08:00:00Z","endDate":"2024-01-30T18:30:00Z","type":"historical","responder":{"type":"noone"}},{"startDate":"2024-01-31T09:00:00Z","endDate":"2024-02-01T07:59:17.791Z","type":"historical","responder":{"type":"noone"}}]}]},"baseTimeline":{"rotations":[{"id":"072cb9c1-698e-49fa-b1dc-1e8c190a76a6","name":"Primary Rotation","order":1,"deleted":false,"periods":[{"startDate":"2024-01-29T00:00:00Z","endDate":"2024-02-03T07:00:00Z","type":"base","responder":{"id":"153c98d1-ca2c-44d8-b8ea-10280f7c2c75","type":"team"}},{"startDate":"2024-02-03T07:00:00Z","endDate":"2024-02-10T07:00:00Z","type":"base","responder":{"id":"5b2b0e011b3a756623f4e25e","type":"user"}},{"startDate":"2024-02-10T07:00:00Z","endDate":"2024-02-12T00:00:00Z","type":"base","responder":{"id":"153c98d1-ca2c-44d8-b8ea-10280f7c2c75","type":"team"}}]},{"id":"18b6b7e7-b83b-4b18-81c2-e3f7ceb9ef7b","name":"Secondary Rotation","order":4,"deleted":false,"periods":[{"startDate":"2024-01-29T00:00:00Z","endDate":"2024-02-01T07:00:00Z","type":"base","responder":{"id":"ab73148c-afa6-4604-ae04-7dc5daea6c8b","type":"escalation"}},{"startDate":"2024-02-01T07:00:00Z","endDate":"2024-02-12T00:00:00Z","type":"base","responder":{"id":"5b2b0e011b3a756623f4e25e","type":"user"}}]}]},"overrideTimeline":{"rotations":[{"id":"072cb9c1-698e-49fa-b1dc-1e8c190a76a6","name":"Primary Rotation","order":1,"deleted":false,"periods":[{"startDate":"2024-02-01T08:11:21.263Z","endDate":"2024-02-02T00:00:00Z","type":"override","responder":{"id":"5b2b0e011b3a756623f4e25e","type":"user"}}]},{"id":"18b6b7e7-b83b-4b18-81c2-e3f7ceb9ef7b","name":"Secondary Rotation","order":4,"deleted":false,"periods":[{"startDate":"2024-02-04T00:00:00Z","endDate":"2024-02-05T00:00:00Z","type":"override","responder":{"id":"e75fed1b-4234-45bc-b5b3-b936979f3cc0","type":"user"}}]}]},"forwardingTimeline":{"rotations":[{"id":"072cb9c1-698e-49fa-b1dc-1e8c190a76a6","name":"Primary Rotation","order":1,"deleted":false,"periods":[{"startDate":"2024-02-05T21:00:00Z","endDate":"2024-02-06T21:00:00Z","type":"forwarding","from":{"id":"40973cb0-6990-4997-aac3-46f8a6031f0f","type":"user","deleted":false},"responder":{"id":"e75fed1b-4234-45bc-b5b3-b936979f3cc0","type":"user"}}]},{"id":"18b6b7e7-b83b-4b18-81c2-e3f7ceb9ef7b","name":"Secondary Rotation","order":4,"deleted":false,"periods":[{"startDate":"2024-02-05T21:00:00Z","endDate":"2024-02-06T21:00:00Z","type":"forwarding","from":{"id":"40973cb0-6990-4997-aac3-46f8a6031f0f","type":"user","deleted":false},"responder":{"id":"e75fed1b-4234-45bc-b5b3-b936979f3cc0","type":"user"}}]}]},"_expands":["base","forwarding","override"]},"properties":{"startDate":{"type":"string","format":"date-time","description":"Start time of the timeline.","example":"2023-11-01T00:00:00Z"},"endDate":{"type":"string","format":"date-time","description":"End time of the timeline.","example":"2023-12-01T00:00:00Z"},"finalTimeline":{"description":"Timeline for the final layer.","allOf":[{"$ref":"#/components/schemas/Timeline"}]},"baseTimeline":{"description":"Timeline for the base layer. Returned only if the `base` expansion is requested.","allOf":[{"$ref":"#/components/schemas/Timeline"}]},"overrideTimeline":{"description":"Timeline for the override layer. Returned only if the `override` expansion is requested.","allOf":[{"$ref":"#/components/schemas/Timeline"}]},"forwardingTimeline":{"description":"Timeline for the forwarding layer. Returned only if the `forwarding` expansion is requested.","allOf":[{"$ref":"#/components/schemas/Timeline"}]},"_expands":{"type":"array","items":{"type":"string"},"description":"List of all possible expansions."}}},"OnCallUsers":{"type":"object","description":"User IDs of the on-call participants. Returned only `flat=true` is sent in the request.","properties":{"onCallUsers":{"type":"array","items":{"type":"string"}}}},"NextOnCallUsers":{"type":"object","description":"User IDs of the next on-call participants. Returned only `flat=true` is sent in the request.","properties":{"nextOnCallUsers":{"type":"array","items":{"type":"string"}}}},"RotationPaginationLinks":{"description":"Links for the other pages.","type":"object","properties":{"next":{"type":"string","description":"Link to the next page of results.","example":"/v1/schedules/f8f2a4ec-54b2-4513-865b-8cb3b81c9544/rotations?offset=50&size=25"}}},"Rotation":{"type":"object","properties":{"id":{"type":"string","description":"ID of the rotation.","example":"3ce33f53-69be-4b92-8d34-a1df0efe642e"},"name":{"type":"string","description":"Name of the rotation.","example":"Daily rotation"},"startDate":{"type":"string","format":"date-time","description":"Start time of the rotation.","example":"2023-11-10T05:00:00Z"},"endDate":{"type":"string","format":"date-time","description":"End time of the rotation.","example":"2024-04-28T10:00:00Z"},"type":{"type":"string","enum":["daily","weekly","hourly"],"description":"Type of the rotation.","example":"weekly"},"length":{"type":"integer","format":"int32","description":"Length of the rotation based on type.","example":2},"participants":{"type":"array","items":{"$ref":"#/components/schemas/ResponderInfo"},"description":"List of participants of the rotation.","example":[{"type":"user","id":"14a994fd-78c6-4236-8b83-d107e5d32d6a"},{"type":"team","id":"2ad4505d-d7a9-4997-8745-c40a3b641573"}]},"timeRestriction":{"oneOf":[{"$ref":"#/components/schemas/TimeOfDayTimeRestriction"},{"$ref":"#/components/schemas/WeekdayTimeRestriction"}]}}},"TimeOfDayTimeRestrictionSettingsRequest":{"required":["endHour","endMin","startHour","startMin"],"type":"object","properties":{"startHour":{"maximum":23,"minimum":0,"type":"integer","format":"int32","description":"Start hour of the time restriction.","example":10},"endHour":{"maximum":23,"minimum":0,"type":"integer","format":"int32","description":"End hour of the time restriction.","example":20},"startMin":{"maximum":59,"minimum":0,"type":"integer","format":"int32","description":"Start minute of the time restriction.","example":30},"endMin":{"maximum":59,"minimum":0,"type":"integer","format":"int32","description":"End minute of the time restriction.","example":0}}},"OverrideResponderInfo":{"description":"Responder that takes on-call via the override.","required":["type"],"type":"object","properties":{"type":{"type":"string","enum":["user","noone"],"description":"Type of the responder.","example":"user"},"id":{"type":"string","description":"ID of the responder. Null if the type is `noone`.","example":"1626a3a7-e159-45e0-b067-b99210917b16"}}},"Timeline":{"description":"Timeline details for the layer.","type":"object","properties":{"rotations":{"type":"array","items":{"$ref":"#/components/schemas/TimelineRotation"}}}},"OverridePaginationLinks":{"description":"Links for the other pages.","type":"object","properties":{"next":{"type":"string","description":"Link to the next page of results.","example":"/v1/schedules/f8f2a4ec-54b2-4513-865b-8cb3b81c9544/overrides?offset=50&size=25"}}},"Schedule":{"type":"object","properties":{"id":{"type":"string","description":"ID of the schedule.","example":"f8f2a4ec-54b2-4513-865b-8cb3b81c9544"},"name":{"type":"string","description":"Name of the schedule.","example":"Support Schedule"},"description":{"type":"string","description":"Description of the schedule.","example":"On-call schedule for support team"},"timezone":{"type":"string","description":"Time zone ID of the schedule.","example":"America/New_York"},"enabled":{"type":"boolean","description":"Indicates whether the schedule is enabled or not.","example":true},"teamId":{"type":"string","description":"ID of the team that schedule belongs to.","example":"cd68207b-c55d-4611-ab25-72fd0c439e9f"},"rotations":{"type":"array","items":{"$ref":"#/components/schemas/Rotation"},"description":"Rotation details of the schedule."}}},"ListRotationsResponse":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/Rotation"}},"links":{"$ref":"#/components/schemas/RotationPaginationLinks"}}},"WeekdayTimeRestrictionSettingsRequest":{"required":["endDay","endHour","endMin","startDay","startHour","startMin"],"type":"object","properties":{"startDay":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"description":"Start day of the time restriction."},"endDay":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"],"description":"End day of the time restriction."},"startHour":{"maximum":23,"minimum":0,"type":"integer","format":"int32","description":"Start hour of the time restriction."},"endHour":{"maximum":23,"minimum":0,"type":"integer","format":"int32","description":"End hour of the time restriction."},"startMin":{"maximum":59,"minimum":0,"type":"integer","format":"int32","description":"Start minute of the time restriction."},"endMin":{"maximum":59,"minimum":0,"type":"integer","format":"int32","description":"End minute of the time restriction."}}},"ResponderInfo":{"required":["type"],"type":"object","properties":{"type":{"type":"string","enum":["user","team","escalation","noone"],"description":"Type of the responder.","example":"user"},"id":{"type":"string","description":"ID of the responder. Null if the type is `noone`.","example":"14a994fd-78c6-4236-8b83-d107e5d32d6a"}}},"TimeOfDayTimeRestriction":{"type":"object","properties":{"type":{"type":"string","default":"time-of-day","description":"Type of the time restriction.","example":"time-of-day"},"restriction":{"$ref":"#/components/schemas/TimeOfDayTimeRestrictionSettings"}}},"EscalationLinks":{"type":"object","properties":{"next":{"type":"string","description":"Link to the next page of results."}},"example":{"next":"/v1/teams/77b933c9-92bb-46e7-a73c-764b8d7c3c25/escalations?offset=10&size=5"}},"EscalationRuleResponse":{"type":"object","properties":{"condition":{"type":"string","description":"The condition for notifying the recipient of escalation rule that is based on the alert state.","enum":["if-not-acked","if-not-closed"]},"notifyType":{"type":"string","description":"Recipient calculation logic for escalations. Possible values are: <br /> <b>default</b>: on call users <br /> <b>next</b>: next users in rotation <br /> <b>previous</b>: previous users on rotation <br /> <b>users</b>: users of the team <br /> <b>admins</b>: admins of the team <br /> <b>random</b>: randomly in the team <br /> <b>all</b>: all members of the team.","enum":["default","next","previous","users","admins","all","random"]},"delay":{"description":"Time delay of the escalation rule in minutes.","type":"integer","format":"int64","minimum":1,"example":5},"recipient":{"type":"object","description":"Object of schedule, team, or users which will be notified in escalation.","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["user","schedule","team"]}},"example":{"id":"f0f07a3d-bde8-4b2a-8d3e-f97020a51e32","type":"team"},"discriminator":{"propertyName":"type"}}}},"EscalationResponse":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the escalation.","example":"69291859-ed73-4396-8b74-c61a3c810cdf"},"name":{"description":"Name of the escalation.","type":"string","example":"FE Daily On-call Escalation"},"description":{"description":"Description of the escalation.","type":"string","example":"Your primary responsibilities include handling unexpected incidents that impact the functionality or performance of the frontend"},"rules":{"description":"List of the escalation rules.","type":"array","items":{"$ref":"#/components/schemas/EscalationRuleResponse"}},"enabled":{"type":"boolean"},"repeat":{"$ref":"#/components/schemas/EscalationRepeat"}}},"CreateEscalationRequest":{"required":["name","rules"],"type":"object","properties":{"name":{"type":"string","description":"Name of the escalation.","example":"FE Daily On-call Escalation","maximum":100},"description":{"type":"string","description":"Description of the escalation.","example":"","maximum":200},"rules":{"type":"array","description":"List of the escalation rules.","items":{"$ref":"#/components/schemas/EscalationRule"}},"enabled":{"type":"boolean","default":true},"repeat":{"$ref":"#/components/schemas/EscalationRepeat"}}},"Recipient":{"required":["type"],"type":"object","description":"Object of schedule, team, or users which will be notified in escalation.","properties":{"id":{"type":"string"},"type":{"type":"string","enum":["user","schedule","team"]}},"example":{"id":"f0f07a3d-bde8-4b2a-8d3e-f97020a51e32","type":"team"},"discriminator":{"propertyName":"type"}},"EscalationRule":{"required":["condition","delay","notifyType","recipient"],"type":"object","properties":{"condition":{"type":"string","description":"The condition for notifying the recipient of escalation rule that is based on the alert state.","enum":["if-not-acked","if-not-closed"]},"notifyType":{"type":"string","description":"Recipient calculation logic for escalations. Possible values are: <br /> <b>default</b>: on call users <br /> <b>next</b>: next users in rotation <br /> <b>previous</b>: previous users on rotation <br /> <b>users</b>: users of the team <br /> <b>admins</b>: admins of the team <br /> <b>random</b>: randomly in the team <br /> <b>all</b>: all members of the team.","enum":["default","next","previous","users","admins","all","random"]},"delay":{"description":"Time delay of the escalation rule in minutes.","type":"integer","format":"int64","minimum":1,"example":5},"recipient":{"$ref":"#/components/schemas/Recipient"}}},"UpdateEscalationRequest":{"type":"object","properties":{"name":{"type":"string","description":"Name of the escalation.","example":"FE Daily On-call Escalation","maximum":100},"description":{"type":"string","description":"Description of the escalation.","example":"","maximum":200},"rules":{"type":"array","description":"List of the escalation rules.","items":{"$ref":"#/components/schemas/EscalationRule"}},"enabled":{"type":"boolean","default":true},"repeat":{"$ref":"#/components/schemas/EscalationRepeat"}}},"EscalationPaginatedResponse":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/EscalationResponse"}},"links":{"$ref":"#/components/schemas/EscalationLinks"}}},"EscalationRepeat":{"type":"object","description":"Repeat preferences of the escalation including repeat interval, count, reverting acknowledge and seen states back and closing an alert automatically as soon as repeats are completed.","properties":{"waitInterval":{"description":"The duration in minutes to repeat the escalation rules after processing the last escalation rule. It is mandatory if you would like to add or remove repeat option. 0 should be given as a value to disable repeat option.","minimum":0,"type":"integer","format":"int32","default":0,"example":10},"count":{"description":"Repeat time indicating how many times the repeat action will be performed.","maximum":20,"minimum":1,"default":1,"type":"integer","format":"int32","example":5},"resetRecipientStates":{"description":"It is for reverting <b>acknowledge</b> and <b>seen</b> states back on each repeat turn if an alert is not closed.","type":"boolean","default":false},"closeAlertAfterAll":{"description":"It is to close the alert automatically if escalation repeats are completed.","type":"boolean","default":false}}},"TeamAlertPolicyPaginatedResponse":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/PolicyListResponse"}},"links":{"$ref":"#/components/schemas/TeamAlertPolicyLinks"}}},"TeamNotificationPolicyPaginatedResponse":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/NotificationPolicyListResponse"}},"links":{"$ref":"#/components/schemas/TeamNotificationPolicyLinks"}}},"GlobalPolicyPaginatedResponse":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/PolicyListResponse"}},"links":{"$ref":"#/components/schemas/GlobalPolicyLinks"}}},"PolicyListResponse":{"type":"object","properties":{"type":{"type":"string","description":"type of policy","example":"alert"},"id":{"type":"string","description":"Identifier of the policy.","example":"69291859-ed73-4396-8b74-c61a3c810cdf"},"name":{"description":"Name of the policy.","type":"string","example":"FE Daily On-call Policy"},"enabled":{"type":"boolean","example":false},"order":{"type":"integer","format":"int32","example":1}}},"NotificationPolicyListResponse":{"type":"object","properties":{"type":{"type":"string","description":"type of policy","example":"alert"},"id":{"type":"string","description":"Identifier of the policy.","example":"69291859-ed73-4396-8b74-c61a3c810cdf"},"name":{"description":"Name of the policy.","type":"string","example":"FE Daily On-call Policy"},"enabled":{"type":"boolean","example":false},"order":{"type":"integer","format":"int32","example":1}}},"GlobalPolicyLinks":{"type":"object","properties":{"next":{"type":"string","description":"Link to the next page of results."}},"example":{"next":"/v1/alerts/policies?offset=1&size=1"}},"TeamAlertPolicyLinks":{"type":"object","properties":{"next":{"type":"string","description":"Link to the next page of results."}},"example":{"next":"/v1/teams/{teamId}/policies?offset=1&size=1&type=alert"}},"TeamNotificationPolicyLinks":{"type":"object","properties":{"next":{"type":"string","description":"Link to the next page of results."}},"example":{"next":"/v1/teams/{teamId}/policies?offset=1&size=1&type=notification"}},"CreateGlobalPolicyRequest":{"type":"object","required":["type","name","enabled","message"],"properties":{"type":{"type":"string","example":"alert","description":"this can be only alert for global policies"},"name":{"type":"string","example":"policy for dynamoDB","description":"Name of the policy"},"description":{"type":"string","example":"policy desc","description":"Description of the policy"},"enabled":{"type":"boolean","example":true,"description":"Initial status of the integration."},"filter":{"description":"Conditions specified in this field must be met for this policy to work.","required":["type","conditions"],"properties":{"type":{"type":"string","enum":["match-all","match-any-condition","match-all-conditions"],"example":"match-any-condition"},"conditions":{"description":"List of conditions will be checked before applying policy","type":"array","items":{"type":"object","properties":{"field":{"type":"string","example":"message","description":"Specifies which alert field will be used in condition. Possible values are message, \nalias, description, source, entity, tags, actions, details, extra-properties, responders, teams\nor priority"},"not":{"type":"boolean","example":false,"description":"Indicates behaviour of the given operation. Default value is false"},"operation":{"type":"string","example":"contains","description":"It is the operation that will be executed for the given field and key. Possible \noperations are matches, contains, starts-with, ends-with, equals, contains-key, contains-value, \ngreater-than, less-than, is-empty and equals-ignore-whitespace."},"expectedValue":{"type":"string","example":"asd","description":"User defined value that will be compared with alert field according to the operation. Default value is empty string"},"order":{"type":"number","example":0,"description":"Order of the condition in conditions list"}}}}},"type":"object"},"timeRestriction":{"required":["enabled","timeRestrictions","appliedTimeZone"],"properties":{"enabled":{"type":"boolean","example":true},"timeRestrictions":{"type":"array","items":{"type":"object","properties":{"startHour":{"type":"number","example":0},"startMinute":{"type":"number","example":0},"endHour":{"type":"number","example":1},"endMinute":{"type":"number","example":0}}}},"appliedTimeZone":{"type":"string","example":"(GMT+03:00) Europe/Istanbul TRT"}},"type":"object"},"alias":{"type":"string","example":"{{alias}}","description":"Alias of the alert. You can use {{alias}} to refer to the original alias. Default value is {{alias}}"},"message":{"type":"string","example":"{{message}} addional message","description":"Message of the alert"},"alertDescription":{"type":"string","example":"{{description}}","description":"Description of the alert. You can use {{description}} to refer to the original alert  description. Default value is {{description}}"},"source":{"type":"string","example":"{{source}}","description":"Source field of the alert. You can use {{source}} to refer to the original source.  Default value is {{source}}"},"entity":{"type":"string","example":"{{entity}}","description":"Entity field of the alert. You can use {{entity}} to refer to the original entity. Default value is {{entity}}"},"responders":{"type":"array","description":"Responders to add to the alerts original responders value as a list of teams, users or the \nreserved word none or all. If ignoreOriginalResponders field is set to true, this will replace the \noriginal responders","items":{"type":"object","properties":{"type":{"type":"string","example":"team"},"id":{"type":"string","example":"0f5f6b40-7dca-44fc-8036-6d6d550e853f"}}}},"actions":{"type":"array","description":"Actions as a list of strings to add to the alerts original actions value. If ignoreOriginalActions field is set to true, this will replace the original actions.","items":{"type":"string"},"example":["action1, action2"]},"tags":{"type":"array","description":"Tags to add to the alerts original tags value as a list of strings. If ignoreOriginalResponders  field is set to true, this will replace the original responders.","items":{"type":"string"},"example":["tag1","tag2"]},"details":{"type":"object","description":"Map of key-value pairs to use as custom properties of the alert details. If ignoreOriginalDetails field is set to true, this will replace the original details."},"continue":{"type":"boolean","example":false,"description":"Will trigger other modify policies if set to true. Default value is false"},"updatePriority":{"type":"boolean","example":false,"description":"Priority of the alert. Should be one of P1, P2, P3, P4, or P5"},"keepOriginalResponders":{"type":"boolean","example":true,"description":"If set to false, policy will ignore the original responders of the alert. Default value is true"},"keepOriginalDetails":{"type":"boolean","example":true,"description":"If set to false, policy will ignore the original details of the alert. Default value is true"},"keepOriginalActions":{"type":"boolean","example":true,"description":"If set to false, policy will ignore the original actions of the alert. Default value is true"},"keepOriginalTags":{"type":"boolean","example":true,"description":"If set to false, policy will ignore the original tags of the alert. Default value is true"}}},"PolicyFilterDto":{"type":"object","properties":{"type":{"type":"string","description":"Link to the next page of results.","enum":["1","2"]}}},"PolicyTimeRestrictionDto":{"type":"object","properties":{"next":{"type":"string","description":"Link to the next page of results."}},"example":{"next":"/v1/alerts/policies?offset=1&size=1"}},"GetGlobalAlertPolicy":{"type":"object","properties":{"type":{"type":"string","example":"ALERT"},"id":{"type":"string","example":"5422f159-0ca5-4fd9-9f73-770b2778baa3"},"name":{"type":"string","example":"test 2"},"description":{"type":"string","example":"asdasd"},"teamId":{"type":"string","example":""},"enabled":{"type":"boolean","example":true},"order":{"type":"number","example":0},"filter":{"required":["type","conditions"],"properties":{"type":{"type":"string","example":"match-any-condition"},"conditions":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","example":"message"},"not":{"type":"boolean","example":false},"operation":{"type":"string","example":"contains"},"expectedValue":{"type":"string","example":"asd"},"order":{"type":"number","example":0}}}}},"type":"object"},"timeRestriction":{"required":["enabled","timeRestrictions","appliedTimeZone"],"properties":{"enabled":{"type":"boolean","example":true},"timeRestrictions":{"type":"array","items":{"type":"object","properties":{"startHour":{"type":"number","example":0},"startMinute":{"type":"number","example":0},"endHour":{"type":"number","example":1},"endMinute":{"type":"number","example":0}}}},"appliedTimeZone":{"type":"string","example":"(GMT+03:00) Europe/Istanbul TRT"}},"type":"object"},"alias":{"type":"string","example":"{{alias}}"},"message":{"type":"string","example":"{{message}} asd"},"alertDescription":{"type":"string","example":"{{description}}"},"source":{"type":"string","example":"{{source}}"},"entity":{"type":"string","example":"{{entity}}"},"responders":{"type":"array","items":{"type":"string"},"example":[]},"actions":{"type":"array","items":{"type":"string"},"example":[]},"tags":{"type":"array","items":{"type":"string"},"example":[]},"details":{"properties":{},"type":"object"},"continue":{"type":"boolean","example":false},"updatePriority":{"type":"boolean","example":false},"keepOriginalResponders":{"type":"boolean","example":true},"keepOriginalDetails":{"type":"boolean","example":true},"keepOriginalActions":{"type":"boolean","example":true},"keepOriginalTags":{"type":"boolean","example":true}}},"TeamAlertPolicyDto":{"type":"object","properties":{"type":{"type":"string","example":"ALERT"},"id":{"type":"string","example":"5422f159-0ca5-4fd9-9f73-770b2778baa3"},"name":{"type":"string","example":"test 2"},"description":{"type":"string","example":"asdasd"},"teamId":{"type":"string","example":"5422f159-0ca5-4fd9-9f73-7707enver82a3"},"enabled":{"type":"boolean","example":true},"order":{"type":"number","example":0},"filter":{"required":["type","conditions"],"properties":{"type":{"type":"string","example":"match-any-condition"},"conditions":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","example":"message"},"not":{"type":"boolean","example":false},"operation":{"type":"string","example":"contains"},"expectedValue":{"type":"string","example":"asd"},"order":{"type":"number","example":0}}}}},"type":"object"},"timeRestriction":{"required":["enabled","timeRestrictions","appliedTimeZone"],"properties":{"enabled":{"type":"boolean","example":true},"timeRestrictions":{"type":"array","items":{"type":"object","properties":{"startHour":{"type":"number","example":0},"startMinute":{"type":"number","example":0},"endHour":{"type":"number","example":1},"endMinute":{"type":"number","example":0}}}},"appliedTimeZone":{"type":"string","example":"(GMT+03:00) Europe/Istanbul TRT"}},"type":"object"},"alias":{"type":"string","example":"{{alias}}"},"message":{"type":"string","example":"{{message}} asd"},"alertDescription":{"type":"string","example":"{{description}}"},"source":{"type":"string","example":"{{source}}"},"entity":{"type":"string","example":"{{entity}}"},"responders":{"type":"array","items":{"type":"string"},"example":[]},"actions":{"type":"array","items":{"type":"string"},"example":[]},"tags":{"type":"array","items":{"type":"string"},"example":[]},"details":{"properties":{},"type":"object"},"continue":{"type":"boolean","example":false},"updatePriority":{"type":"boolean","example":false},"keepOriginalResponders":{"type":"boolean","example":true},"keepOriginalDetails":{"type":"boolean","example":true},"keepOriginalActions":{"type":"boolean","example":true},"keepOriginalTags":{"type":"boolean","example":true}}},"TeamNotificationPolicyDto":{"type":"object","properties":{"type":{"type":"string","example":"NOTIFICATION"},"id":{"type":"string","example":"5422f159-0ca5-4fd9-9f73-770b2778baa3"},"name":{"type":"string","example":"test 2"},"description":{"type":"string","example":"asdasd"},"teamId":{"type":"string","example":"5422f159-0ca5-4fd9-9f73-7707enver82a3"},"enabled":{"type":"boolean","example":true},"order":{"type":"number","example":0},"filter":{"required":["type","conditions"],"properties":{"type":{"type":"string","example":"match-any-condition"},"conditions":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string","example":"message"},"not":{"type":"boolean","example":false},"operation":{"type":"string","example":"contains"},"expectedValue":{"type":"string","example":"asd"},"order":{"type":"number","example":0}}}}},"type":"object"},"timeRestriction":{"required":["enabled","timeRestrictions","appliedTimeZone"],"properties":{"enabled":{"type":"boolean","example":true},"timeRestrictions":{"type":"array","items":{"type":"object","properties":{"startHour":{"type":"number","example":0},"startMinute":{"type":"number","example":0},"endHour":{"type":"number","example":1},"endMinute":{"type":"number","example":0}}}},"appliedTimeZone":{"type":"string","example":"(GMT+03:00) Europe/Istanbul TRT"}},"type":"object"},"delayAction":{"required":["waitDuration","delayOption","delayTime"],"properties":{"waitDuration":{"type":"number"},"delayOption":{"type":"string"},"delayTime":{"required":["hours","minutes"],"properties":{"hours":{"type":"number"},"minutes":{"type":"number"}},"type":"object"}},"type":"object"},"deduplicationAction":{"required":["waitDuration","frequency","countValueLimit","deduplicationActionType"],"properties":{"waitDuration":{"type":"number"},"frequency":{"type":"number"},"countValueLimit":{"type":"number"},"deduplicationActionType":{"type":"string"}},"type":"object"},"autoCloseAction":{"required":["waitDuration","durationFormat"],"properties":{"waitDuration":{"type":"number"},"durationFormat":{"type":"string"}},"type":"object"},"autoRestartAction":{"required":["waitDuration","durationFormat","maxRepeatCount"],"properties":{"waitDuration":{"type":"number"},"durationFormat":{"type":"string"},"maxRepeatCount":{"type":"number"}},"type":"object"},"suppress":{"type":"boolean"}}},"ChangePolicyOrderRequest":{"type":"object","properties":{"order":{"type":"number","description":"new policy order","example":3}}},"ListErrorResponse":{"type":"object","properties":{"errors":{"type":"array","description":"List of all errors encountered.","items":{"$ref":"#/components/schemas/LogsErrorResponse"}}},"example":{"errors":[{"code":"BAD_REQUEST","title":"Invalid or missing startTime"}]}},"LogsErrorResponse":{"type":"object","properties":{"code":{"type":"string","description":"Category of the error generated.","enum":["BAD_REQUEST","FORBIDDEN_OPERATION","USER_NOT_FOUND","INTERNAL_SERVER_ERROR"]},"title":{"type":"string","description":"Brief description about the error."}},"example":{"code":"BAD_REQUEST","title":"Invalid or missing startTime"}},"AuditLogResponse":{"type":"object","properties":{"created":{"type":"string","format":"date-time","description":"Exact date and time when the audit log was generated.","example":"2024-01-05T07:06:47.958Z"},"message":{"type":"string","example":"Escalation policy [escalation] added","description":"Summary message for the audit log."},"details":{"type":"string","example":"{\"targetUser\":\"xyz@abc.com\"}","description":"Details of the audit log in JSON string format."},"category":{"type":"string","description":"Represents category of the audit log like Alerts, Notifications etc.","enum":["Automation","Incoming Data","Alerts","API","Configuration Changes","Emails","Heartbeats","Incident Management","Integrations","Syncs","Notifications","Oncall Management","Services","User Import","Added user to group","Added user to role"],"example":"Integrations"},"level":{"type":"string","description":"Log level of the audit log.","enum":["Information","Error","Warning"],"example":"Information"}}},"ListAuditLogResponse":{"type":"object","properties":{"values":{"type":"array","description":"List of Audit logs.","items":{"$ref":"#/components/schemas/AuditLogResponse"}},"count":{"type":"integer","format":"int32","description":"Total number of audit logs in response.","example":1},"links":{"$ref":"#/components/schemas/ListAuditLogResponseLink"}}},"ListAuditLogResponseLink":{"type":"object","properties":{"next":{"description":"Link to the next page of results. This will be null when all logs have been returned","type":"string"}},"example":{"next":"/logs?startTime=2024-01-01T00:00:00Z&endTime=2024-01-01T15:30:00Z&limit=5000&pageToken=WzE3MDgxNjk0M"}},"Status":{"type":"string","example":"cancelled","description":"Current status of the maintenance plan.","enum":["cancelled","past","active","planned"]},"StartDate":{"type":"string","format":"date-time","description":"Date and time when the maintenance plan starts.","example":"2023-12-11T11:37:40.501Z"},"GetTeamMaintenance":{"type":"object","properties":{"teamId":{"type":"string","description":"Identifier of the maintenance owning team.","example":"77b933c9-92bb-46e7-a73c-764b8d7c3c25"},"id":{"type":"string","example":"0762db96-f795-4246-90be-edd295af8fca","description":"Identifier of the maintenance."},"status":{"$ref":"#/components/schemas/Status"},"description":{"$ref":"#/components/schemas/MaintenanceDescription"},"startDate":{"$ref":"#/components/schemas/StartDate"},"endDate":{"$ref":"#/components/schemas/EndDate"},"rules":{"type":"array","description":"Rules of maintenance, which takes a list of rule objects and defines the maintenance rules over policies, integrations and syncs.","items":{"type":"object","properties":{"entity":{"$ref":"#/components/schemas/MaintenanceEntity"},"state":{"type":"string","enum":["disabled","enabled"],"description":"State of rule that will be defined in maintenance. This field has to be disabled for integrations and syncs.","example":"enabled"}},"example":{"state":"disabled","entity":{"id":"51e9e162-767b-47a6-a00a-4cd8b6f94829","type":"integration"}}}}}},"CreateMaintenanceRequest":{"required":["rules"],"type":"object","properties":{"description":{"$ref":"#/components/schemas/MaintenanceDescription"},"startDate":{"$ref":"#/components/schemas/StartDate"},"endDate":{"$ref":"#/components/schemas/EndDate"},"rules":{"$ref":"#/components/schemas/Rules"}}},"UpdateMaintenanceRequest":{"type":"object","properties":{"description":{"$ref":"#/components/schemas/MaintenanceDescription"},"startDate":{"$ref":"#/components/schemas/StartDate"},"endDate":{"$ref":"#/components/schemas/EndDate"},"rules":{"$ref":"#/components/schemas/Rules"}}},"MaintenanceLinks":{"type":"object","properties":{"next":{"type":"string","nullable":true,"description":"Link to the next page of results.","example":"/v1/maintenances?offset=50&size=25"}}},"MaintenanceDescription":{"type":"string","example":"Maintenance Plan","description":"Description or name for the maintenance plan. This can be any text that helps identify the purpose or characteristics of the maintenance plan.","maximum":200},"MaintenanceEntity":{"type":"object","description":"Entities within a maintenance policy rule are used to specify which entity like policy, integration or sync should enabled or disabled during maintenance period.","example":{"id":"258bec1f-bae6-4190-bcc6-56c42990131c","type":"policy"},"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["sync","integration","policy"]}}},"MaintenanceRule":{"type":"object","required":["entity","state"],"properties":{"entity":{"$ref":"#/components/schemas/MaintenanceEntity"},"state":{"type":"string","enum":["disabled","enabled"],"description":"State of rule that will be defined in maintenance. This field has to be disabled for integrations and syncs.","example":"enabled"}},"example":{"state":"disabled","entity":{"id":"51e9e162-767b-47a6-a00a-4cd8b6f94829","type":"integration"}}},"EndDate":{"type":"string","format":"date-time","description":"Date and time when the maintenance plan ends.","example":"2023-12-11T11:42:40.501Z"},"Rules":{"type":"array","description":"Rules of maintenance, which takes a list of rule objects and defines the maintenance rules over policies, integrations and syncs.","items":{"$ref":"#/components/schemas/MaintenanceRule"}},"GetGlobalMaintenance":{"type":"object","properties":{"id":{"type":"string","example":"0762db96-f795-4246-90be-edd295af8fca","description":"Identifier of the maintenance."},"status":{"$ref":"#/components/schemas/Status"},"description":{"$ref":"#/components/schemas/MaintenanceDescription"},"startDate":{"$ref":"#/components/schemas/StartDate"},"endDate":{"$ref":"#/components/schemas/EndDate"},"rules":{"type":"array","description":"Rules of maintenance, which takes a list of rule objects and defines the maintenance rules over policies, integrations and syncs.","items":{"type":"object","properties":{"entity":{"$ref":"#/components/schemas/MaintenanceEntity"},"state":{"type":"string","enum":["disabled","enabled"],"description":"State of rule that will be defined in maintenance. This field has to be disabled for integrations and syncs.","example":"enabled"}},"example":{"state":"disabled","entity":{"id":"51e9e162-767b-47a6-a00a-4cd8b6f94829","type":"integration"}}}}}},"NotificationRulesStepContact":{"description":"Defines the contact that notification will be sent to.","required":["method","to"],"type":"object","properties":{"method":{"type":"string","description":"This parameter is the contact method of user.","example":"email","enum":["email","sms","voice","mobile"]},"to":{"type":"string","description":"Address of the contact notification will be sent to.","example":"johnsmith@atlassian.com"}}},"NotificationRulesStepLinks":{"type":"object","properties":{"next":{"type":"string","description":"Link to the next page of results."}},"example":{"next":"/v1/notification-rules/0hcb717e-c442-4185-8bc1-cc998844f567/steps?offset=10&size=5"}},"NotificationRulesStepNotificationRuleStep":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the notification rule step which belongs to given notification rule.","example":"dbf70781-d6d8-4924-b90d-6a0c77833748"},"sendAfter":{"description":"Time period when notification will be sent after in minutes.","type":"integer","format":"int64","minimum":0,"example":5},"contact":{"$ref":"#/components/schemas/NotificationRulesStepContact"},"enabled":{"description":"Specifies whether given step will be enabled or not when it is created.","type":"boolean"}}},"UpdateNotificationRuleStepRequest":{"type":"object","properties":{"contact":{"$ref":"#/components/schemas/NotificationRulesStepContact"},"sendAfter":{"description":"Time period when notification will be sent after in minutes.","type":"integer","format":"int64","minimum":0,"example":5},"enabled":{"description":"Specifies whether given step will be enabled or not when it is created.","type":"boolean"}}},"NotificationRulesStepCreateNotificationRuleStepRequest":{"required":["contact","enabled"],"type":"object","properties":{"contact":{"$ref":"#/components/schemas/NotificationRulesStepContact"},"sendAfter":{"description":"Time period when notification will be sent after in minutes.","type":"integer","format":"int64","minimum":0,"example":5},"enabled":{"description":"Specifies whether given step will be enabled or not when it is created.","type":"boolean"}}},"NotificationRulesStepPaginatedResponse":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/NotificationRulesStepNotificationRuleStep"}},"links":{"$ref":"#/components/schemas/NotificationRulesStepLinks"}}},"CreateContactPayload":{"required":["method","to"],"type":"object","properties":{"method":{"type":"string","description":"The method of the contact.","enum":["email","sms","voice"]},"to":{"description":"The contact address.","type":"string"}},"example":{"method":"email","to":"test@atlassian.com"}},"PaginatedResponseContactWithApplyOrderResponse":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/ContactWithApplyOrderResponse"}},"links":{"$ref":"#/components/schemas/CustomRolesLinks"}}},"ContactSuccessResponse":{"type":"object","properties":{"message":{"type":"string"},"data":{"$ref":"#/components/schemas/SimpleData"}}},"CustomUserRoleSuccessResponse":{"type":"object","properties":{"message":{"type":"string"},"data":{"$ref":"#/components/schemas/SimpleData"}}},"ContactResponse":{"type":"object","properties":{"id":{"type":"string","description":"The id of the contact."},"method":{"description":"The method of the contact.","type":"string","enum":["email","sms","voice","mobile"]},"to":{"description":"The contact address.","type":"string"},"status":{"$ref":"#/components/schemas/ContactStatus"}}},"SimpleCreateData":{"type":"object","properties":{"id":{"type":"string"}}},"SimpleData":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"ContactWithApplyOrderResponse":{"type":"object","properties":{"id":{"description":"The id of the contact.","type":"string"},"method":{"description":"The method of the contact.","type":"string","enum":["email","sms","voice","mobile"]},"to":{"description":"The contact address.","type":"string"},"status":{"$ref":"#/components/schemas/ContactStatus"},"applyOrder":{"type":"integer","format":"int32"}}},"ContactCreateResponse":{"type":"object","properties":{"message":{"type":"string"},"data":{"$ref":"#/components/schemas/SimpleCreateData"}}},"CustomRolesLinks":{"type":"object","properties":{"next":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"}}},"UpdateContactPayload":{"required":["to"],"type":"object","properties":{"to":{"description":"The contact address.","type":"string"}},"example":{"to":"90-5555559999"}},"PaginatedResponseCustomUserRoleSummaryResponse":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/CustomUserRoleSummaryResponse"}},"_expands":{"type":"array","items":{"type":"string"}},"links":{"$ref":"#/components/schemas/CustomRolesLinks"}}},"CustomUserRoleSummaryResponse":{"type":"object","properties":{"id":{"description":"The id of the custom user role.","type":"string"},"name":{"description":"The name of the custom user role.","type":"string"}}},"ContactStatus":{"type":"object","properties":{"enabled":{"description":"The status of the contact.","type":"boolean"},"disabledReason":{"description":"The reason why the contact is deactivated.","type":"string"}}},"CustomUserRoleUpdateRequest":{"type":"object","properties":{"id":{"type":"string","description":"The id of the custom user role."},"name":{"type":"string","description":"The name of the custom user role."},"grantedRights":{"type":"array","description":"The list of rights to grant to the custom user role.","items":{"type":"string"}},"disallowedRights":{"type":"array","description":"The list of rights to disallow to the custom user role.","items":{"type":"string"}}},"example":{"name":"conflictRightRole_1","grantedRights":["alerts-access-all","incident-add-note","asdasdad"],"disallowedRights":["incident-reopen"]}},"AssignRoleRequest":{"required":["accountId","roleId"],"type":"object","properties":{"accountId":{"type":"string","description":"The accountId of the user to assign the role to."},"roleId":{"type":"string","description":"The id of the role to assign."}},"example":{"accountId":"630a55c646556c72662aaaaa","roleId":"44a48324-f5f9-45af-b8c9-02978aaaaaaa"}},"CustomRolesPaginatedResponse":{"type":"object","properties":{"values":{"description":"The list of response values.","type":"array","items":{"type":"object"}},"_expands":{"type":"array","items":{"type":"string"}},"links":{"$ref":"#/components/schemas/CustomRolesLinks"}}},"CustomUserRoleCreateRequest":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the custom user role."},"grantedRights":{"type":"array","description":"The list of rights to grant to the custom user role.","items":{"type":"string"}},"disallowedRights":{"type":"array","description":"The list of rights to disallow to the custom user role.","items":{"type":"string"}}},"example":{"name":"Pre req Rest Api 3","grantedRights":["alert-action","alert-create","alert-add-note"],"disallowedRights":["alert-delete"]}},"GetCustomUserRoleResponse":{"type":"object","properties":{"id":{"description":"The id of the custom user role.","type":"string"},"name":{"description":"The name of the custom user role.","type":"string"},"extendedRole":{"description":"The extended role of the custom user role.","type":"string"},"grantedRights":{"description":"The list of rights granted to the custom user role.","type":"array","items":{"type":"string"}},"disallowedRights":{"description":"The list of rights disallowed to the custom user role.","type":"array","items":{"type":"string"}}}},"IntegrationsCondition":{"type":"object","properties":{"field":{"type":"string"},"expectedValue":{"type":"string"},"not":{"type":"boolean"},"operation":{"type":"string"},"key":{"type":"string"}},"description":"List of the filter conditions."},"UpdateIntegrationActionRequest":{"type":"object","properties":{"name":{"type":"string","description":"Name of the action.","example":"Updated action name"},"enabled":{"type":"boolean","description":"This parameter is for specifying whether the integration action will be enabled or not. Defaults to false","example":false},"filter":{"$ref":"#/components/schemas/Filter"},"typeSpecificProperties":{"type":"object","additionalProperties":{"type":"object","description":"Action specific properties of the action."},"description":"Action specific properties of the action."},"fieldMappings":{"type":"object","additionalProperties":{"type":"object","description":"The fields mapping between payload and alert fields."},"description":"The fields mapping between payload and alert fields.","example":{"note":"","description":"{{message}}","source":"Email","message":"{{subject}}","priority":"{{priority}}","tags":[],"alias":"","details":{"From":"{{from_address}}"},"user":"","actions":[],"entity":""}},"actionMapping":{"$ref":"#/components/schemas/ActionMapping"}}},"Integration":{"title":"Integration","type":"object","properties":{"id":{"type":"string","description":"ID of the integration."},"type":{"type":"string","description":"Type of the integration."},"name":{"type":"string","description":"Name of the integration."},"enabled":{"type":"boolean","description":"Indicates whether the integration is enabled or not."},"teamId":{"type":"string","description":"ID of the team that integration belongs to."},"typeSpecificProperties":{"type":"object","description":"Integration specific properties.","additionalProperties":{"type":"object"}}}},"IntegrationActions":{"title":"IntegrationActions","type":"object","properties":{"links":{"$ref":"#/components/schemas/IntegrationsLinks"},"values":{"type":"array","items":{"$ref":"#/components/schemas/ActionDetail"}}}},"ActionDetail":{"type":"object","properties":{"id":{"type":"string","description":"ID of the integration action."},"name":{"type":"string","description":"Name of the integration action."},"type":{"type":"string","description":"Type of the integration action."},"direction":{"type":"string","description":"Direction of the action. It can be *incoming* or *outgoing*."},"domain":{"type":"string","description":"Domain of the action. It can be *alert*."},"actionMappingType":{"type":"string","description":"Mapped action of the integration action. This will be provided for the outgoing actions. Alert action will be mapped to the actions."},"groupType":{"type":"string","description":"Group type of the action. It can be *forwarding*, *updating* or *checkbox*. It will be provided for outgoing actions"}}},"IntegrationAction":{"title":"IntegrationAction","type":"object","properties":{"id":{"type":"string","description":"ID of the integration action."},"type":{"type":"string","description":"Type of the integration action."},"name":{"type":"string","description":"Name of the integration action."},"domain":{"type":"string","description":"Domain of the action. It can be *alert*","enum":["alert"]},"direction":{"type":"string","description":"Direction of the action. It can be *incoming* or *outgoing*","enum":["incoming","outgoing"]},"actionMapping":{"$ref":"#/components/schemas/ActionMapping"},"groupType":{"type":"string","description":"Group type of the action. It can be *forwarding*, *updating* or *checkbox*. It is not blank for outgoing actions","enum":["forwarding","updating","checkbox"]},"extraField":{"type":"string","example":"","description":"Extra field for the action"},"filter":{"$ref":"#/components/schemas/Filter"},"typeSpecificProperties":{"type":"object","description":"Action specific properties.","additionalProperties":{"type":"object"}},"fieldMappings":{"type":"object","description":"The fields mapping between payload and alert fields.","additionalProperties":{"type":"object"},"example":{"note":"","description":"{{message}}","source":"Email Updated","message":"{{subject}}","priority":"{{priority}}","tags":[],"alias":"","details":{"From":"{{from_address}}"},"user":"","actions":[],"entity":""}}}},"CreateIntegrationRequest":{"required":["name","type"],"type":"object","properties":{"name":{"type":"string","description":"Name of the integration. Name must be unique for each integration.","example":"Email Integration A"},"type":{"type":"string","description":"Type of the integration. (For instance, \"API\" for API Integration.","example":"Email"},"description":{"type":"string","description":"Description of the integration.","example":"A Sample of Email Integration"},"enabled":{"type":"boolean","description":"This parameter is for specifying whether the integration will be enabled or not. Defaults to false","example":true},"teamId":{"type":"string","example":"8ae8a0a2-1122-5566-8899-11b82bbd85c9","description":"ID of the team that integration belongs to."},"typeSpecificProperties":{"type":"object","example":{"emailUsername":"email-integration-test1","suppressNotifications":false},"additionalProperties":{"type":"object","description":"Integration spesific properties may be provided to this object. \nFor instance, this map may constist \n- *suppressNotifications* for incoming integrations\n- *emailUsername* for email integrations\n- *allowReadAccess* , *allowWriteAccess*, *allowDeleteAccess*, *allowConfigurationAccess* for API Integrations\n- some credential properties or tool spesific properties such as URLs for outgoing integrations"},"description":"Integration spesific properties may be provided to this object. \nFor instance, this map may constist \n- *suppressNotifications* for incoming integrations\n- *emailUsername* for email integrations\n- *allowReadAccess* , *allowWriteAccess*, *allowDeleteAccess*, *allowConfigurationAccess* for API Integrations\n- some credential properties or tool spesific properties such as URLs for outgoing integrations"}}},"UpdateIntegrationActionOrderRequest":{"type":"object","properties":{"successorId":{"type":"string","description":"Id of the successor integration action. The action order will be defined with reference to order of the successor action."}}},"IntegrationResponse":{"type":"object","properties":{"id":{"type":"string","description":"ID of the integration."},"name":{"type":"string","description":"Name of the integration."},"type":{"type":"string","description":"Type of the integration."},"enabled":{"type":"boolean","description":"Indicates whether the integration is enabled or not."},"teamId":{"type":"string","description":"ID of the team that integration belongs to."},"advanced":{"type":"boolean","description":"Indicates whether the integration is configured as different than the default version."},"maintenanceSources":{"type":"array","items":{"$ref":"#/components/schemas/MaintenanceSource"}},"directions":{"type":"array","description":"Direction of the action. It can be *incoming* or *outgoing*","items":{"type":"string","enum":["incoming","outgoing"]}},"domains":{"type":"array","description":"Domain of the action. It can be *alert*","items":{"type":"string","enum":["alert"]}},"typeSpecificProperties":{"type":"object","description":"Action specific properties.","additionalProperties":{"type":"object"}}}},"IntegrationsLinks":{"type":"object","properties":{"next":{"type":"string","description":"Relative path to next page."},"previous":{"type":"string","description":"Relative path to previous page."}}},"ActionMapping":{"required":["type"],"type":"object","properties":{"type":{"type":"string"},"parameter":{"type":"object"}}},"Integrations":{"title":"Integrations","type":"object","properties":{"links":{"$ref":"#/components/schemas/IntegrationsLinks"},"values":{"type":"array","items":{"$ref":"#/components/schemas/IntegrationDetail"}}}},"MaintenanceSource":{"type":"object","properties":{"maintenanceId":{"type":"string"},"enabled":{"type":"boolean","description":"Indicates whether the maintainance is enabled or not."},"interval":{"$ref":"#/components/schemas/MaintenanceInterval"}}},"Filter":{"type":"object","properties":{"conditionsEmpty":{"type":"boolean","description":"Indicates whether the condition is empty or not."},"conditionMatchType":{"type":"string","description":"It is condition match type of the action. It can be *match-all*, *match-any-condition* or *match-all-conditions*","enum":["match-all","match-any-condition","match-all-conditions"],"example":"match-all"},"conditions":{"type":"array","description":"List of the filter conditions.","example":[],"items":{"$ref":"#/components/schemas/IntegrationCondition"}}}},"UpdateIntegrationRequest":{"type":"object","properties":{"name":{"type":"string","description":"Name of the integration. Name must be unique for each integration.","example":"Webhook Integration A"},"enabled":{"type":"boolean","description":"This parameter is for specifying whether the integration will be enabled or not. Defaults to false","example":true},"description":{"type":"string","description":"Description of the integration.","example":"A Sample of Webhook Integration"},"teamId":{"type":"string","description":"ID of the team that integration belongs to.","example":"8ae8a0a2-1122-5566-8899-11b82bbd85c9"},"typeSpecificProperties":{"type":"object","example":{"addAlertDetails":false,"headers":{},"addAlertDescription":false,"outgoingSettingsEnabled":false,"forwardingActionGroupEnabled":true,"url":"http://asd.com"},"additionalProperties":{"type":"object","description":"This is for some integration spesific properties. For instance this map is consisting suppressNotifications for incoming integrations, emailUsername for email integrations or allowReadAccess/allowWriteAccess/allowDeleteAccessallowConfigurationAccess for API Integrations."},"description":"This is for some integration spesific properties. For instance this map is consisting suppressNotifications for incoming integrations, emailUsername for email integrations or allowReadAccess/allowWriteAccess/allowDeleteAccessallowConfigurationAccess for API Integrations."}}},"MaintenanceInterval":{"type":"object","properties":{"startTimeMillis":{"type":"integer","format":"int64"},"endTimeMillis":{"type":"integer","format":"int64"}}},"IntegrationFilter":{"title":"IntegrationFilter","type":"object","properties":{"conditionMatchType":{"type":"string","description":"It is condition match type of the action. It can be *match-all*, *match-any-condition* or *match-all-conditions*","enum":["match-all","match-any-condition","match-all-conditions"]},"conditions":{"type":"array","description":"List of the action conditions","example":[],"items":{"$ref":"#/components/schemas/IntegrationsCondition"}}}},"IntegrationDetail":{"type":"object","properties":{"id":{"type":"string","description":"ID of the integration."},"name":{"type":"string","description":"Name of the integration."},"type":{"type":"string","description":"Type of the integration."},"enabled":{"type":"boolean","description":"Indicates whether the integration is enabled or not."},"teamId":{"type":"string","description":"ID of the team that integration belongs to."}}},"CreateIntegrationActionRequest":{"required":["direction","domain","filter","name","type"],"type":"object","properties":{"type":{"type":"string","description":"Type of the action. It can be *create*, *close*, *acknowledge* or *addNote* for incoming actions. Types of outgoing actions can be change according to integration types such as *publish* or *sendMessage* etc.","example":"create"},"name":{"type":"string","description":"Name of the action.","example":"Create Alert2"},"domain":{"type":"string","description":"Domain of the action. It can be *alert*","enum":["alert"],"example":"alert"},"direction":{"type":"string","description":"Direction of the action. It can be *incoming* or *outgoing*","enum":["incoming","outgoing"],"example":"incoming"},"groupType":{"type":"string","description":"Group type of the action. It can be *forwarding*, *updating* or *checkbox*. It must be provided for outgoing actions","enum":["forwarding","updating","checkbox"],"example":""},"extraField":{"type":"string","description":"Extra field for the action","example":""},"filter":{"$ref":"#/components/schemas/Filter"},"typeSpecificProperties":{"type":"object","additionalProperties":{"type":"object","description":"Action specific properties of the action."},"description":"Action specific properties of the action."},"fieldMappings":{"type":"object","additionalProperties":{"type":"object","description":"The fields mapping between payload and alert fields."},"description":"The fields mapping between payload and alert fields.","example":{"note":"","description":"{{message}}","source":"Email","message":"{{subject}}","priority":"{{priority}}","tags":[],"alias":"","details":{"From":"{{from_address}}"},"user":"","actions":[],"entity":""}},"actionMapping":{"$ref":"#/components/schemas/ActionMapping"},"enabled":{"type":"boolean","description":"This parameter is for specifying whether the integration action will be enabled or not. Defaults to false"}}},"IntegrationCondition":{"required":["field","operation"],"type":"object","properties":{"order":{"type":"integer","format":"int32"},"field":{"type":"string"},"expectedValue":{"type":"string"},"not":{"type":"boolean"},"operation":{"type":"string","enum":["matches","contains","starts-with","ends-with","equals","contains-key","contains-value","greater-than","less-than","is-empty","equals-ignore-whitespace"]},"key":{"type":"string"},"systemCondition":{"type":"boolean"}}},"ForwardingRuleResponse":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the forwarding rule.","example":"6667cb5b-a5ce-4550-9469-1dbcabac6ffb"},"fromUserId":{"type":"string","description":"The id of user whose notifications will be forwarded.","example":"e58d6ee3-37bd-432f-9ded-64808b761ae0"},"toUserId":{"type":"string","description":"The id of user who will receive the forwarded notifications.","example":"4b26961a-a837-49d2-a1fe-0973013e3c3b"},"startDate":{"type":"string","description":"The date and time for forwarding will start, which takes a date format as (yyyy-MM-dd'T'HH:mm:ssZ) (e.g. 2017-01-15T08:00:00+02:00).","example":"2022-07-05T08:00:00Z"},"endDate":{"type":"string","description":"The date and time for forwarding will end, which takes a date format as (yyyy-MM-dd'T'HH:mm:ssZ) (e.g. 2017-01-15T08:00:00+02:00).","example":"2022-07-06T18:00:00Z"}}},"ForwardingPaginatedResponse":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/ForwardingRuleResponse"}},"links":{"$ref":"#/components/schemas/ForwardingLinks"}}},"ForwardingLinks":{"type":"object","properties":{"next":{"description":"Link to the next page of results.","type":"string","example":"/v1/forwarding-rules?offset=1&size=5"}}},"CreateForwardingRuleRequest":{"required":["endDate","fromUserId","startDate","toUserId"],"type":"object","properties":{"toUserId":{"type":"string","description":"The id of user who will receive the forwarded notifications.","example":"e58d6ee3-37bd-432f-9ded-64808b761ae0"},"fromUserId":{"type":"string","description":"The id of user whose notifications will be forwarded.","example":"4b26961a-a837-49d2-a1fe-0973013e3c3b"},"startDate":{"type":"string","format":"date-time","description":"The date and time for forwarding will start, which takes a date format as (yyyy-MM-dd'T'HH:mm:ssZ) (e.g. 2017-01-15T08:00:00+02:00).","example":"2022-07-05T08:00:00Z"},"endDate":{"type":"string","format":"date-time","description":"The date and time for forwarding will end, which takes a date format as (yyyy-MM-dd'T'HH:mm:ssZ) (e.g. 2017-01-15T08:00:00+02:00).","example":"2022-07-06T18:00:00Z"}}},"HeartbeatPaginatedResponse":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/Heartbeat"}},"links":{"$ref":"#/components/schemas/HeartbeatLinks"}}},"HeartbeatLinks":{"type":"object","properties":{"next":{"type":"string","description":"Link to the next page of results.","example":"/v1/teams/77b933c9-92bb-46e7-a73c-764b8d7c3c25/heartbeats?offset=13&size=5"}}},"SimpleSuccessResponse":{"properties":{"message":{"type":"string","example":"PONG - Heartbeat received"}}},"Heartbeat":{"type":"object","properties":{"name":{"type":"string","description":"Name of the heartbeat.","example":"Service Heartbeat"},"description":{"type":"string","description":"Description of the heartbeat.","example":"Heartbeat for checking service health"},"interval":{"type":"integer","format":"int32","description":"Specifies how often a heartbeat message should be expected.","example":5},"intervalUnit":{"type":"string","enum":["Days","Minutes","Hours"],"example":"Days"},"enabled":{"type":"boolean","description":"Enable/disable heartbeat monitoring.","example":"true"},"status":{"type":"string","enum":["Unresponsive","Responsive","Off","Pending"],"example":"Responsive"},"ownerTeamId":{"type":"string","description":"Owner team of the heartbeat, consisting id of the owner team","example":"4b26961a-a837-49d2-a1fe-0973013e3c3b"},"alertMessage":{"type":"string","description":"Specifies the alert message for heartbeat expiration alert.","example":"Service does not respond"},"alertTags":{"description":"Specifies the alert tags for heartbeat expiration alert.","type":"array","items":{"type":"string"},"example":["HighPriority","Database"]},"alertPriority":{"type":"string","description":"Specifies the alert priority for heartbeat expiration alert.","enum":["P1","P2","P3","P4","P5"],"example":"P2"}}},"UpdateHeartbeatRequest":{"required":["name"],"type":"object","properties":{"description":{"type":"string","description":"An optional description of the heartbe.at","maximum":10000,"example":"It checks whether server is online or not."},"interval":{"minimum":1,"type":"integer","format":"int32","description":"Specifies how often a heartbeat message should be expected.","example":5},"intervalUnit":{"type":"string","enum":["hours","minutes","days"],"example":"minutes"},"enabled":{"type":"boolean","description":"Enable/disable heartbeat monitoring.","example":true},"alertMessage":{"type":"string","description":"Specifies the alert message for heartbeat expiration alert.","maximum":130,"example":"HeartbeatName is expired"},"alertTags":{"description":"Specifies the alert tags for heartbeat expiration alert.","type":"array","items":{"type":"string"},"example":["critical","dns"]},"alertPriority":{"type":"string","description":"Specifies the alert priority for heartbeat expiration alert.","enum":["P1","P2","P3","P4","P5"],"default":"P3"}}},"CreateHeartbeatRequest":{"required":["interval","intervalUnit","name"],"type":"object","properties":{"name":{"type":"string","description":"Name of the heartbeat.","maximum":200,"example":"DNS Server Checker"},"description":{"type":"string","description":"Description of the heartbeat.","maximum":10000,"example":"It checks whether server is online or not"},"interval":{"minimum":1,"type":"integer","format":"int32","description":"Specifies how often a heartbeat message should be expected.","example":5},"enabled":{"type":"boolean","description":"Enable/disable heartbeat monitoring.","default":false,"example":true},"intervalUnit":{"type":"string","enum":["hours","minutes","days"],"example":"minutes"},"alertMessage":{"type":"string","description":"Specifies the alert message for heartbeat expiration alert.","maximum":130,"default":"HeartbeatName is expired","example":"HeartbeatName is expired"},"alertTags":{"description":"Specifies the alert tags for heartbeat expiration alert.","type":"array","items":{"type":"string"},"example":["critical","dns"]},"alertPriority":{"type":"string","description":"Specifies the alert priority for heartbeat expiration alert. If this is not provided, default priority is P3","enum":["P1","P2","P3","P4","P5"],"default":"P3","example":"P3"}}},"NotificationRulesWeekdayTimeRestrictionInterval":{"required":["type","restrictions"],"type":"object","properties":{"type":{"description":"This parameter should be set **weekday-and-time-of-day** (week-based).","type":"string","discriminator":{"propertyName":"type"}},"restrictions":{"description":"It is a list of restriction objects.","maxItems":15,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/NotificationRulesWeekTimeRestriction"}}}},"NotificationRulesLinks":{"type":"object","properties":{"next":{"description":"Link to the next page of results.","type":"string"}},"example":{"next":"/v1/notification-rules?offset=10&size=5"}},"NotificationRulesWeekTimeRestriction":{"description":"It is a restriction object.","required":["endHour","endMin","startHour","startMin","startDay","endDay"],"type":"object","properties":{"startDay":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"endDay":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"startHour":{"description":"Value of the hour that frame will start.","maximum":23,"minimum":0,"type":"integer","format":"int32"},"endHour":{"description":"Value of the hour that frame will end.","maximum":23,"minimum":0,"type":"integer","format":"int32"},"startMin":{"description":"Value of the minute that frame will start.","maximum":59,"minimum":0,"type":"integer","format":"int32"},"endMin":{"description":"Value of the minute that frame will end.","maximum":59,"minimum":0,"type":"integer","format":"int32"}}},"NotificationRuleRequest":{"required":["actionType","enabled","name"],"type":"object","properties":{"name":{"description":"Name of the notification rule.","type":"string"},"actionType":{"description":"Type of the action that notification rule will have.","type":"string","enum":["create-alert","acknowledged-alert","closed-alert","assigned-alert","add-note","schedule-start","schedule-end","incoming-call-routing"]},"criteria":{"description":"Defines the conditions that will be checked before applying notification rule and type of the operations that will be applied on conditions. Default value is matching all notification rules.","oneOf":[{"$ref":"#/components/schemas/NotificationRulesMatchAllAnyConditionsFilter"},{"$ref":"#/components/schemas/NotificationRulesMatchAllFilter"}]},"notificationTime":{"description":"List of Time Periods that notification for schedule start/end will be sent.","type":"array","items":{"type":"string","enum":["just-before","15-minutes-ago","1-hour-ago","1-day-ago"]}},"timeRestriction":{"description":"Time interval that notification rule will work. It can be just one restriction which will be applied all days, or list of restrictions will be applied to the specified days.","oneOf":[{"$ref":"#/components/schemas/NotificationRulesTimeOfDayTimeRestrictionInterval"},{"$ref":"#/components/schemas/NotificationRulesWeekdayTimeRestrictionInterval"}]},"schedules":{"description":"This field is valid for Schedule Start/End rules. It can be list of schedule IDs that notification rule will be applied when on call of that schedule starts/ends. This field shall only be populated with the specified users' schedules.","type":"array","items":{"type":"string"}},"order":{"description":"The order of the notification rule within the notification rules with the same action type. Order value is actually the index of the notification rule whose minimum value is 0 and whose maximum value is n-1 (number of notification rules with the same action type is n).","type":"integer","format":"int32"},"steps":{"description":"List of steps that will be added to notification rule.","type":"array","items":{"$ref":"#/components/schemas/NotificationRulesCreateNotificationRuleStepRequest"}},"repeat":{"description":"The amount of time in minutes that notification steps will be repeatedly apply.","$ref":"#/components/schemas/NotificationRuleRepeat"},"enabled":{"description":"If notification rule will be enabled or not when it is created.","type":"boolean"}},"example":{"name":"Create Alert","actionType":"create-alert","criteria":{"type":"match-all"},"steps":[{"id":"0hcb717e-c442-4185-8bc1-cc998844f567","sendAfter":0,"contact":{"method":"email","to":"test@atlassian.com"},"enabled":true}],"enabled":true}},"NotificationRulesTimeOfDayTimeRestrictionInterval":{"required":["type","restriction"],"type":"object","properties":{"type":{"description":"This parameter should be set **time-of-day** (day-based).","type":"string","discriminator":{"propertyName":"type"}},"restriction":{"$ref":"#/components/schemas/NotificationRulesDayTimeRestriction"}}},"NotificationRulesMatchAllAnyConditionsFilter":{"required":["type","conditions"],"type":"object","properties":{"type":{"description":"Type of the operation will be applied on conditions.","type":"string","enum":["match-any-condition","match-all-conditions"],"discriminator":{"propertyName":"type"}},"conditions":{"description":"List of conditions will be checked before applying team routing rule.","minItems":1,"type":"array","items":{"$ref":"#/components/schemas/NotificationRulesCondition"}}}},"NotificationRulesCondition":{"required":["field","operation"],"type":"object","properties":{"field":{"description":"Specifies which alert field will be used in condition.","type":"string","enum":["message","alias","description","source","entity","tags","actions","extra-properties","priority","details","responders"]},"key":{"description":"If field is set as extra-properties, key could be used for key-value pair.","type":"string"},"not":{"description":"Indicates behaviour of the given operation.","type":"boolean","default":false},"operation":{"description":"It is the operation that will be executed for the given field and key.\nAvailable operations changes according to the fields type: \n- String Operations: contains, equals, starts-with, ends-with, matches, is-empty, equals-ignore-whitespace \n- List Operations: contains, is-empty \n- Map Operations: contains, contains-key, contains-value, is-empty \n- Number Operations: matches, equals, greater-than, less-than \n- Boolean Operations: equals","type":"string","enum":["matches","contains","starts-with","ends-with","equals","contains-key","contains-value","greater-than","less-than","is-empty","equals-ignore-whitespace"]},"expectedValue":{"description":"User defined value that will be compared with alert field according to the operation. Default value is empty string.","type":"string"},"order":{"description":"Order of the condition in conditions list.","type":"integer","format":"int32"}}},"NotificationRulesCreateNotificationRuleStepRequest":{"required":["contact","enabled"],"type":"object","properties":{"contact":{"$ref":"#/components/schemas/NotificationRulesContact"},"sendAfter":{"description":"Time period when notification will be sent after in minutes.","type":"integer","format":"int64","minimum":0},"enabled":{"description":"Specifies whether given step will be enabled or not when it is created.","type":"boolean"}}},"NotificationRulesNotificationRuleStep":{"type":"object","properties":{"id":{"description":"Id of the notification rule step.","type":"string"},"sendAfter":{"description":"Time period when notification will be sent after in minutes.","type":"integer","format":"int64","minimum":0},"contact":{"$ref":"#/components/schemas/NotificationRulesContact"},"enabled":{"description":"Specifies whether given step will be enabled or not when it is created.","type":"boolean"}}},"NotificationRulesMatchAllFilter":{"required":["type"],"type":"object","properties":{"type":{"description":"Type of the operation will be applied on conditions.","type":"string","enum":["match-all"],"discriminator":{"propertyName":"type"}}}},"NotificationRuleResponse":{"type":"object","properties":{"id":{"description":"Identifier of the notification rule.","type":"string"},"name":{"description":"Name of the notification rule.","type":"string"},"actionType":{"description":"Type of the action that notification rule will have.","type":"string","enum":["create-alert","acknowledged-alert","closed-alert","assigned-alert","add-note","schedule-start","schedule-end","incoming-call-routing"]},"criteria":{"description":"Defines the conditions that will be checked before applying notification rule and type of the operations that will be applied on conditions. Default value is matching all notification rules.","oneOf":[{"$ref":"#/components/schemas/NotificationRulesMatchAllAnyConditionsFilter"},{"$ref":"#/components/schemas/NotificationRulesMatchAllFilter"}]},"notificationTime":{"description":"List of Time Periods that notification for schedule start/end will be sent. If actionType is **scheduleStart** or **scheduleEnd**, notificationTime is mandatory.","type":"array","items":{"type":"string","enum":["just-before","15-minutes-ago","1-hour-ago","1-day-ago"]}},"timeRestriction":{"description":"Time interval that notification rule will work. It can be just one restriction which will be applied all days, or list of restrictions will be applied to the specified days.","oneOf":[{"$ref":"#/components/schemas/NotificationRulesTimeOfDayTimeRestrictionInterval"},{"$ref":"#/components/schemas/NotificationRulesWeekdayTimeRestrictionInterval"}]},"schedules":{"description":"This field is valid for Schedule Start/End rules. It can be list of schedule IDs that notification rule will be applied when on call of that schedule starts/ends. This field shall only be populated with the specified users' schedules.","type":"array","items":{"type":"string"}},"order":{"description":"The order of the notification rule within the notification rules with the same action type. Order value is actually the index of the notification rule whose minimum value is 0 and whose maximum value is n-1 (number of notification rules with the same action type is n).","type":"integer","format":"int32"},"steps":{"description":"List of steps that will be added to notification rule.","type":"array","items":{"$ref":"#/components/schemas/NotificationRulesNotificationRuleStep"}},"repeat":{"$ref":"#/components/schemas/NotificationRuleRepeat"},"enabled":{"description":"If notification rule will be enabled or not when it is created.","type":"boolean"}},"example":{"id":"4292c912-12ac-4ac0-b195-9484fbb98c5c","name":"Create Alert","actionType":"create-alert","criteria":{"type":"match-all"},"timeRestriction":{"type":"weekday-and-time-of-day","restrictions":[{"startDay":"monday","endDay":"friday","startHour":13,"endHour":18,"startMin":0,"endMin":0}]},"order":1,"steps":[{"id":"0hcb717e-c442-4185-8bc1-cc998844f567","sendAfter":0,"contact":{"method":"email","to":"test@atlassian.com"},"enabled":true}],"repeat":{"loopAfter":1,"enabled":true},"enabled":true}},"NotificationRulesPaginatedResponse":{"type":"object","properties":{"values":{"type":"array","items":{"type":"object","$ref":"#/components/schemas/NotificationRuleResponse"}},"links":{"$ref":"#/components/schemas/NotificationRulesLinks"}}},"NotificationRulesContact":{"description":"Defines the contact that notification will be sent to.","required":["method","to"],"type":"object","properties":{"method":{"description":"This parameter is the contact method of user.","type":"string","enum":["email","sms","voice","mobile"]},"to":{"description":"Address of the contact notification will be sent to.","type":"string"}}},"NotificationRuleRepeat":{"description":"The amount of time in minutes that notification steps will be repeatedly apply.","type":"object","properties":{"loopAfter":{"description":"This parameter is amount in minutes that notification steps will be repeatedly apply. It can not be less than 0.","minimum":0,"type":"integer","format":"int32"},"enabled":{"description":"Determine whether loopAfter is enabled or not. If it is set to false, repeating will be disabled.","type":"boolean"}}},"NotificationRulesDayTimeRestriction":{"description":"It is a restriction object.","required":["endHour","endMin","startHour","startMin"],"type":"object","properties":{"startHour":{"description":"Value of the hour that frame will start.","maximum":23,"minimum":0,"type":"integer","format":"int32"},"endHour":{"description":"Value of the hour that frame will end.","maximum":23,"minimum":0,"type":"integer","format":"int32"},"startMin":{"description":"Value of the minute that frame will start.","maximum":59,"minimum":0,"type":"integer","format":"int32"},"endMin":{"description":"Value of the minute that frame will end.","maximum":59,"minimum":0,"type":"integer","format":"int32"}}},"CreateRoutingRuleRequest":{"required":["notify"],"type":"object","properties":{"name":{"type":"string","description":"Name of the routing rule."},"order":{"maximum":100,"minimum":0,"example":0,"type":"integer","format":"int32","description":"The order of the team routing rule within the rules. Order value is actually the index of the team routing rule whose minimum value is 0 and whose maximum value is n-1 (number of team routing rules is n)."},"criteria":{"description":"Defines the conditions that will be checked before applying routing rule and type of the operations that will be applied on conditions.","oneOf":[{"$ref":"#/components/schemas/RoutingRulesMatchAllAnyConditionsFilter"},{"$ref":"#/components/schemas/RoutingRulesMatchAllFilter"}]},"timeRestriction":{"description":"Time interval that routing rule will work. It can be just one restriction which will be applied all days, or list of restrictions will be applied to the specified days.","oneOf":[{"$ref":"#/components/schemas/RoutingRulesTimeOfDayTimeRestrictionInterval"},{"$ref":"#/components/schemas/RoutingRulesWeekdayTimeRestrictionInterval"}]},"notify":{"$ref":"#/components/schemas/Notify"},"timezone":{"description":"Timezone of team routing rule. If timezone field is not given, account timezone is used as default.","type":"string","example":"Europe/Istanbul"}},"example":{"name":"My Empty Rule","order":1,"criteria":{"type":"match-all"},"notify":{"type":"none"}}},"Notify":{"required":["type"],"type":"object","description":"Target entity of schedule, escalation, or the reserved word none which will be notified in routing rule.","properties":{"id":{"type":"string","example":"d2acfc54-a145-451e-a963-ffbc089baea1","description":"If type is **none**, id is not required."},"type":{"type":"string","example":"escalation","enum":["escalation","schedule","none"]}}},"RoutingRulesMatchAllFilter":{"required":["type"],"type":"object","properties":{"type":{"description":"Type of the operation will be applied on conditions.","type":"string","enum":["match-all"],"discriminator":{"propertyName":"type"}}}},"RoutingRuleResponse":{"type":"object","properties":{"id":{"type":"string","example":"5bb421a5-c7ee-45fe-a89c-307c95da8b60","description":"Identifier of the routing rule."},"name":{"type":"string","description":"Name of the routing rule.","example":"My Primary Routing Rule"},"isDefault":{"type":"boolean","example":true,"description":"Indicates whether given routing rule is default or not."},"order":{"type":"integer","format":"int32","example":0,"description":"The order of the team routing rule within the rules. Order value is actually the index of the team routing rule whose minimum value is 0 and whose maximum value is n-1 (number of team routing rules is n)."},"criteria":{"description":"Defines the conditions that will be checked before applying routing rule and type of the operations that will be applied on conditions.","oneOf":[{"$ref":"#/components/schemas/RoutingRulesMatchAllAnyConditionsFilter"},{"$ref":"#/components/schemas/RoutingRulesMatchAllFilter"}]},"timezone":{"description":"Timezone of team routing rule. If timezone field is not given, account timezone is used as default.","type":"string","example":"Europe/Istanbul"},"timeRestriction":{"description":"Time interval that routing rule will work. It can be just one restriction which will be applied all days, or list of restrictions will be applied to the specified days.","oneOf":[{"$ref":"#/components/schemas/RoutingRulesTimeOfDayTimeRestrictionInterval"},{"$ref":"#/components/schemas/RoutingRulesWeekdayTimeRestrictionInterval"}]},"notify":{"$ref":"#/components/schemas/Notify"}},"example":{"id":"4292c912-12ac-4ac0-b195-9484fbb98c5c","name":"My Primary Routing Rule","isDefault":"true","criteria":{"type":"match-any-condition","conditions":[{"field":"message","operation":"matches","expectedValue":"my critical alert"}]},"timezone":"Europe/Istanbul","timeRestriction":{"type":"weekday-and-time-of-day","restrictions":[{"startDay":"monday","endDay":"friday","startHour":13,"endHour":18,"startMin":0,"endMin":0}]},"order":0,"notify":{"id":"d2acfc54-a145-451e-a963-ffbc089baea1","type":"escalation"}}},"UpdateRoutingRuleRequest":{"type":"object","properties":{"name":{"type":"string","description":"Name of the routing rule."},"order":{"maximum":100,"minimum":0,"example":0,"type":"integer","format":"int32","description":"The order of the team routing rule within the rules. Order value is actually the index of the team routing rule whose minimum value is 0 and whose maximum value is n-1 (number of team routing rules is n)."},"criteria":{"description":"Defines the conditions that will be checked before applying routing rule and type of the operations that will be applied on conditions.","oneOf":[{"$ref":"#/components/schemas/RoutingRulesMatchAllAnyConditionsFilter"},{"$ref":"#/components/schemas/RoutingRulesMatchAllFilter"}]},"timeRestriction":{"description":"Time interval that routing rule will work. It can be just one restriction which will be applied all days, or list of restrictions will be applied to the specified days.","oneOf":[{"$ref":"#/components/schemas/RoutingRulesTimeOfDayTimeRestrictionInterval"},{"$ref":"#/components/schemas/RoutingRulesWeekdayTimeRestrictionInterval"}]},"notify":{"$ref":"#/components/schemas/Notify"},"timezone":{"description":"Timezone of team routing rule. If timezone field is not given, account timezone is used as default.","type":"string","example":"Europe/Istanbul"}},"example":{"name":"My Empty Rule","order":1,"criteria":{"type":"match-all"},"notify":{"type":"none"}}},"RoutingRulesLinks":{"type":"object","properties":{"next":{"type":"string","description":"Link to the next page of results."}},"example":{"next":"/v1/teams/77b933c9-92bb-46e7-a73c-764b8d7c3c25/routing-rules?offset=10&size=5"}},"RoutingRuleChangeOrderRequest":{"required":["order"],"type":"object","description":"The order of the team routing rule within the rules. Value is actually the index of the team routing rule whose minimum value is 0 and whose maximum value is n-1 (number of team routing rules is n).","properties":{"order":{"minimum":0,"type":"integer","format":"int32"}}},"RoutingRulesTimeOfDayTimeRestrictionInterval":{"required":["type","restriction"],"type":"object","properties":{"type":{"description":"This parameter should be set **time-of-day** (day-based).","type":"string","discriminator":{"propertyName":"type"}},"restriction":{"$ref":"#/components/schemas/RoutingRulesDayTimeRestriction"}}},"RoutingRulesPaginatedResponse":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/RoutingRuleResponse"}},"links":{"$ref":"#/components/schemas/RoutingRulesLinks"}}},"RoutingRulesMatchAllAnyConditionsFilter":{"required":["type","conditions"],"type":"object","properties":{"type":{"description":"Type of the operation will be applied on conditions.","type":"string","enum":["match-any-condition","match-all-conditions"],"discriminator":{"propertyName":"type"}},"conditions":{"description":"List of conditions will be checked before applying team routing rule.","minItems":1,"type":"array","items":{"$ref":"#/components/schemas/RoutingRulesCondition"}}}},"RoutingRulesWeekdayTimeRestrictionInterval":{"required":["type","restrictions"],"type":"object","properties":{"type":{"description":"This parameter should be set **weekday-and-time-of-day** (week-based).","type":"string","discriminator":{"propertyName":"type"}},"restrictions":{"description":"It is a list of restriction objects.","maxItems":15,"minItems":1,"type":"array","items":{"$ref":"#/components/schemas/RoutingRulesWeekTimeRestriction"}}}},"RoutingRulesWeekTimeRestriction":{"description":"It is a restriction object.","required":["endHour","endMin","startHour","startMin","startDay","endDay"],"type":"object","properties":{"startDay":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"endDay":{"type":"string","enum":["monday","tuesday","wednesday","thursday","friday","saturday","sunday"]},"startHour":{"description":"Value of the hour that frame will start.","maximum":23,"minimum":0,"type":"integer","format":"int32"},"endHour":{"description":"Value of the hour that frame will end.","maximum":23,"minimum":0,"type":"integer","format":"int32"},"startMin":{"description":"Value of the minute that frame will start.","maximum":59,"minimum":0,"type":"integer","format":"int32"},"endMin":{"description":"Value of the minute that frame will end.","maximum":59,"minimum":0,"type":"integer","format":"int32"}}},"RoutingRulesCondition":{"required":["field","operation"],"type":"object","properties":{"field":{"description":"Specifies which alert field will be used in condition.","type":"string","enum":["message","alias","description","source","entity","tags","actions","extra-properties","priority","details","responders"],"example":"message"},"key":{"description":"If field is set as extra-properties, key could be used for key-value pair.","type":"string"},"not":{"description":"Indicates behaviour of the given operation.","type":"boolean","default":false},"operation":{"description":"It is the operation that will be executed for the given field and key.\nAvailable operations changes according to the fields type: \n- String Operations: contains, equals, starts-with, ends-with, matches, is-empty, equals-ignore-whitespace \n- List Operations: contains, is-empty \n- Map Operations: contains, contains-key, contains-value, is-empty \n- Number Operations: matches, equals, greater-than, less-than \n- Boolean Operations: equals","type":"string","enum":["matches","contains","starts-with","ends-with","equals","contains-key","contains-value","greater-than","less-than","is-empty","equals-ignore-whitespace"]},"expectedValue":{"description":"User defined value that will be compared with alert field according to the operation.","type":"string","default":"","example":"my critical alert"},"order":{"description":"Order of the condition in conditions list.","type":"integer","format":"int32","example":0}}},"RoutingRulesDayTimeRestriction":{"description":"It is a restriction object.","required":["endHour","endMin","startHour","startMin"],"type":"object","properties":{"startHour":{"description":"Value of the hour that frame will start.","maximum":23,"minimum":0,"type":"integer","format":"int32"},"endHour":{"description":"Value of the hour that frame will end.","maximum":23,"minimum":0,"type":"integer","format":"int32"},"startMin":{"description":"Value of the minute that frame will start.","maximum":59,"minimum":0,"type":"integer","format":"int32"},"endMin":{"description":"Value of the minute that frame will end.","maximum":59,"minimum":0,"type":"integer","format":"int32"}}},"Entity":{"type":"string","example":"DatabaseServer1","description":"Entity that the alert is related to. It could be a server, service, application or another source that's being monitored. The 'entity' helps in identifying and categorizing the origin of the alert, enabling quicker diagnostics and resolution of the issue.","maximum":512},"CreateAlertRequest":{"required":["message"],"type":"object","properties":{"message":{"$ref":"#/components/schemas/Message"},"responders":{"$ref":"#/components/schemas/Responders"},"visibleTo":{"maxItems":50,"minItems":0,"type":"array","example":[{"id":"4513b7ea-3b91-438f-b7e4-e3e54af9147c","type":"team"},{"id":"bb4d9938-c3c2-455d-aaab-727aa701c0d8","type":"user"}],"items":{"$ref":"#/components/schemas/VisibleTo"}},"note":{"type":"string","description":"Additional context or information about the alert that isn't captured in other fields. This could include steps taken to address the alert, details about the potential cause, or other relevant information.","example":"This server has experienced high CPU usage multiple times in the past week. A server upgrade has been recommended to prevent future occurrences.","maximum":25000},"alias":{"$ref":"#/components/schemas/Alias"},"entity":{"$ref":"#/components/schemas/Entity"},"source":{"$ref":"#/components/schemas/Source"},"tags":{"$ref":"#/components/schemas/Tags"},"actions":{"$ref":"#/components/schemas/Actions"},"description":{"$ref":"#/components/schemas/AlertDescription"},"priority":{"$ref":"#/components/schemas/Priority"},"extraProperties":{"$ref":"#/components/schemas/ExtraProperties"}}},"AssignAlertRequest":{"required":["accountId"],"type":"object","properties":{"accountId":{"description":"Represents the identifier for the user to which the alert is to be assigned.","type":"string","example":"bb4d9938-c3c2-455d-aaab-727aa701c0d8"}}},"Message":{"type":"string","description":"Brief summary of the alert that provides enough information to understand the nature of the issue at a glance.","example":"The CPU usage on Server XYZ has exceeded 80% for over 5 minutes.","maximum":130},"ExecuteCustomActionRequest":{"required":["actionName"],"type":"object","properties":{"actionName":{"example":"RestartServer","description":"Action name that can be executed on the alert. This action is a custom to your organization and can be used to automate responses to specific alerts.","type":"string"}}},"AlertNote":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the note.","example":"1704869443312000050"},"createdAt":{"type":"string","format":"date-time","description":"Represents the timestamp at which the alert note was added.","example":"2024-01-05T07:06:47.958Z"},"updatedAt":{"type":"string","format":"date-time","description":"Represents the timestamp at which the alert note was updated.","example":"2024-01-05T07:06:47.958Z"},"note":{"type":"string","description":"Represents the actual note.","example":"System downtime expected due to maintenance activities."},"owner":{"type":"string","description":"Signifies the entity that added the note.","example":"user@atlassian.com"}}},"AlertLog":{"type":"object","properties":{"logTime":{"type":"string","format":"date-time","description":"Represents the timestamp at which the alert log was generated.","example":"2024-01-05T07:06:47.958Z"},"logType":{"type":"string","description":"Represents the type of the log. The value is a string that describes the nature of the alert activity.","example":"system"},"log":{"type":"string","description":"Represents the actual log message. The value is a string that provides detailed information about the alert activity.","example":"Assigning owner team [Dream] to alert because it is the only team on the alert and alert is not created via team integration."},"owner":{"type":"string","description":"Represents the entity that initiated the alert activity. The value is a string that could be a user, team, or system that carried out the action logged.","example":"system"}}},"AlertLogsResponse":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/AlertLog"}},"links":{"$ref":"#/components/schemas/AlertLogLink"}}},"GetRequestStatusResponse":{"type":"object","properties":{"action":{"type":"string","example":"Create"},"processedAt":{"type":"string","format":"date-time","description":"This property signifies the time when the requested operation was processed.","example":"2024-01-05T07:44:10.409Z"},"integrationId":{"type":"string","example":""},"isSuccess":{"type":"boolean","example":true},"status":{"type":"string","example":"Alert does not exist"},"alertId":{"type":"string","example":"9b251e07-73c9-4907-9996-8cb53a6a20d0-1704440650350"},"alias":{"$ref":"#/components/schemas/Alias"}}},"Source":{"type":"string","example":"DBMonitoringTool","description":"Origin of the alert, i.e., the system or application where the alert was generated. This field is useful for tracking and sorting alerts according to their originating sources, which can help in troubleshooting and determining the cause of the alerts.","maximum":100,"default":"IP address of the incoming request."},"UpdateAlertMessageRequest":{"required":["message"],"type":"object","properties":{"message":{"$ref":"#/components/schemas/Message"}}},"AlertErrorResponse":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"message":{"type":"string"}},"example":{"took":0,"requestId":"c1b85a37-2c39-48c8-8ef7-d620b4927a66","message":"Request method 'POST' is not supported"}},"AlertTagsRequest":{"required":["tags"],"type":"object","properties":{"tags":{"type":"array","description":"Represents a list of tags to be associated with an alert.","items":{"type":"string"},"example":["production","urgent"]}}},"ListAlertResponse":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/AlertResponse"}},"count":{"type":"integer","format":"int64","description":"Total number of alerts.","example":1},"links":{"$ref":"#/components/schemas/ListAlertResponseLink"}}},"AlertNoteLink":{"type":"object","properties":{"next":{"description":"Link to the next page of results.","type":"string"}},"example":{"next":"/v1/alerts/4513b7ea-3b91-438f-b7e4-e3e54af9147c/notes?after=1492000072838"}},"ExtraProperties":{"type":"object","description":"Map of key-value pairs to use as custom properties of the alert. This can include context-specific data, diagnostic information, or other metadata that can assist in understanding and resolving the alert.","maximum":8000,"example":{"backend":false,"browser":"Firefox 113.0","browser.name":"Firefox","bundler":"parcel@2.10.3","environment":"production"},"additionalProperties":{"type":"string"}},"Tags":{"type":"array","description":"Additional categorizing information. These tags can then be used for searching or grouping alerts, making it easier to manage and prioritize them.","example":["OverwriteQuietHours","Critical"],"items":{"type":"string"}},"Responders":{"maxItems":50,"minItems":0,"type":"array","description":"Teams, users, escalations and schedules that the alert will be routed to send notifications.","example":[{"id":"4513b7ea-3b91-438f-b7e4-e3e54af9147c","type":"team"},{"id":"bb4d9938-c3c2-455d-aaab-727aa701c0d8","type":"user"},{"id":"aee8a0de-c80f-4515-a232-501c0bc9d715","type":"escalation"},{"id":"80564037-1984-4f38-b98e-8a1f662df552","type":"schedule"}],"items":{"$ref":"#/components/schemas/Responder"}},"SuccessResponse":{"type":"object","properties":{"result":{"type":"string","description":"Indicates the outcome of the request.","example":"Request will be processed"},"requestId":{"type":"string","description":"Identifier of the request. This ID can be used to trace or track the request in the system logs or for debugging purposes in case the request fails or causes an error.","example":"d383c6e9-b1e7-4b59-9c35-72f1a2187777"},"took":{"type":"integer","format":"int32","example":0.195}}},"VisibleTo":{"type":"object","properties":{"id":{"type":"string","example":"ac140ae4-757c-48a4-a079-041eb3bfe8d7"},"type":{"type":"string","enum":["team","user"]}}},"AlertResponse":{"type":"object","properties":{"id":{"description":"Identifier of alert.","type":"string","example":"e0caa0ce-d52f-4500-81b9-d592d06970b6"},"tinyId":{"type":"string","description":"Unique, system-generated identification code assigned to each alert. This ID is shorter and simpler than the primary alert ID, making it easier to reference in communications and operations. It serves as a quick reference point to uniquely identify each alert.","example":"1234"},"createdAt":{"type":"string","format":"date-time","description":"Exact date and time when the alert was generated. It helps in tracking the timeline of the alerts and understanding the chronology of events.","example":"2024-01-05T07:06:47.958Z"},"updatedAt":{"type":"string","format":"date-time","description":"Exact date and time when the alert was updated.","example":"2024-01-05T07:06:47.958Z"},"message":{"$ref":"#/components/schemas/Message"},"entity":{"$ref":"#/components/schemas/Entity"},"source":{"$ref":"#/components/schemas/Source"},"status":{"type":"string","description":"Current state of the alert represents whether the alert is new, has been acknowledged by a team member, has been resolved etc.","enum":["open","acked","resolved","snoozed","closed"],"example":"closed"},"alias":{"$ref":"#/components/schemas/Alias"},"tags":{"$ref":"#/components/schemas/Tags"},"extraProperties":{"$ref":"#/components/schemas/ExtraProperties"},"description":{"$ref":"#/components/schemas/AlertDescription"},"acknowledged":{"type":"boolean","description":"Indicating whether the alert has been acknowledged by a team member or not. If the alert has been acknowledged, it means that someone is actively looking into the issue.","example":true},"count":{"type":"integer","format":"int32","description":"Represents the number of times the alert has been triggered. Each time the same alert is triggered, instead of creating a new alert, the count of the existing alert increases. This helps in reducing noise and focusing on the recurring issue.","example":3},"owner":{"type":"string","example":"John Smith","description":"Display name of the alert owner."},"snoozed":{"type":"boolean","description":"Reflects whether the alert has been temporarily silenced or not. If set to 'true', it means the alert notifications have been paused for a specified duration and will not disturb the users during this period.","example":false},"snoozedUntil":{"type":"string","format":"date-time","description":"Represents the time until which the alert is snoozed.","example":"2022-05-01T00:00:00Z"},"lastOccurredAt":{"type":"string","format":"date-time","description":"Represents the most recent time the alert was triggered.","example":"2022-04-01T00:00:00Z"},"integrationType":{"type":"string","description":"Denotes the type of integration used to create the alert.","example":"API"},"integrationName":{"type":"string","description":"Denotes the name of integration used to create the alert.","example":"Default API"},"priority":{"$ref":"#/components/schemas/Priority"},"responders":{"$ref":"#/components/schemas/Responders"},"actions":{"$ref":"#/components/schemas/Actions"},"seen":{"description":"Represents whether the alert has been viewed by a user or not.","type":"boolean","example":true}}},"ListAlertResponseLink":{"type":"object","properties":{"next":{"description":"Link to the next page of results.","type":"string"}},"example":{"next":"/v1/alerts?offset=10&size=5"}},"Actions":{"type":"array","description":"A list of actions that can be executed on the alert. These actions are custom to your organization and can be used to automate responses to specific alerts.","example":["RestartServer"],"items":{"type":"string"}},"Priority":{"type":"string","description":"Urgency level of the alert. The priority can be set as 'P1', 'P2', 'P3', 'P4', or 'P5', with 'P1' being the highest and 'P5' the lowest. The 'priority' attribute aids in effective alert management by allowing alerts to be categorized and handled according to their importance.","enum":["P1","P2","P3","P4","P5"],"default":"P3"},"AlertLogLink":{"type":"object","properties":{"next":{"description":"Link to the next page of results.","type":"string"}},"example":{"next":"/v1/alerts/4513b7ea-3b91-438f-b7e4-e3e54af9147c/logs?after=1492000072838_1492000072838234593"}},"AddExtraPropertiesRequest":{"required":["extraProperties"],"type":"object","properties":{"extraProperties":{"$ref":"#/components/schemas/ExtraProperties"}}},"DeleteExtraPropertiesRequest":{"required":["keys"],"type":"object","properties":{"keys":{"description":"Keys of extra properties.","type":"array","example":["backend","browser"],"items":{"type":"string"}}}},"EscalateToNextRequest":{"required":["escalationId"],"type":"object","properties":{"escalationId":{"description":"Escalation that the alert will be escalated.","type":"string"}}},"AlertSnoozeRequest":{"required":["endTime"],"type":"object","properties":{"endTime":{"type":"string","format":"date-time","description":"Specifies the date and time when the snooze operation for an alert should end. Once this time is reached, the alert will exit the snooze state and return to its previous status, making it active for notifications again.","example":"2024-01-05T07:44:10.409Z"}}},"AddResponderRequest":{"required":["id","type"],"type":"object","properties":{"id":{"type":"string","description":"Identifier of the responder.","example":"ac140ae4-757c-48a4-a079-041eb3bfe8d7"},"type":{"type":"string","description":"Type of the responder.","enum":["team","user","escalation","schedule"]}}},"AlertDescription":{"type":"string","description":"Detailed information contains more comprehensive information than the 'message' field, including the implications of the alert, steps to reproduce the issue, or suggestions for resolving the problem. It serves as a guide for the person or team responding to the alert to better understand the situation and take appropriate actions.","example":"The alert is triggered due to the high CPU usage on Server XYZ. The CPU usage has consistently been above 80% for more than 5 minutes which could potentially lead to server slowdown or even a crash. Suggested action is to investigate the processes consuming high CPU and optimize or terminate them as needed. If the issue persists, consider upgrading the server resources.","maximum":15000},"UpdateAlertDescriptionRequest":{"type":"object","properties":{"description":{"$ref":"#/components/schemas/AlertDescription"}}},"Alias":{"type":"string","description":"Client-defined identifier of the alert, that is also the key element of <a target=\"_self\" href=\"https://support.atlassian.com/atlassian/docs/what-is-alert-de-duplication/\">Alert De-Duplication</a>.","example":"DatabaseConnectionFailure_DatabaseServer1","maximum":512},"UpdateAlertPriorityRequest":{"required":["priority"],"type":"object","properties":{"priority":{"$ref":"#/components/schemas/Priority"}}},"GetAlertNotesResponse":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/AlertNote"}},"links":{"$ref":"#/components/schemas/AlertNoteLink"}}},"NoteRequest":{"required":["note"],"type":"object","properties":{"note":{"type":"string","example":"System downtime expected due to maintenance activities."}}},"Responder":{"type":"object","properties":{"id":{"type":"string","description":"Identifier of the responder.","example":"ac140ae4-757c-48a4-a079-041eb3bfe8d7"},"type":{"type":"string","description":"Type of the responder.","enum":["team","user","escalation","schedule"]}}},"CreateSyncDto":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"Name of the sync. Name must be unique for each sync."},"description":{"type":"string","description":"Description of the sync."},"enabled":{"type":"boolean","description":"This parameter is for specifying whether the integration will be enabled or not. Defaults to false"},"teamId":{"type":"string","description":"Owner team of the sync, consisting id of the owner team."},"type":{"type":"string","description":"Type of the sync. (For instance, \"jira-software-cloud\" for Jira Software Cloud Sync.)"},"properties":{"type":"object","additionalProperties":{"type":"object","description":"Sync specific properties may be provided to this object. \nFor instance, this map should consist \n- *connectionId*\n- *projectKey*"},"description":"Sync specific properties may be provided to this object. \nFor instance, this map should consist \n- *connectionId*\n- *projectKey*"}}},"SyncActionGroupMetadataDto":{"type":"object","properties":{"id":{"type":"string","description":"Id of the action group."},"type":{"type":"string","description":"Type of the action group.","enum":["forwarding","updating"]},"name":{"type":"string","description":"Name of the action group."},"order":{"type":"number","description":"Order of the action group.","format":"float"},"enabled":{"type":"boolean","description":"Enabled status of the action group."}}},"ActionsDto":{"type":"object","properties":{"added":{"type":"array","description":"List of the actions that will be created.","items":{"$ref":"#/components/schemas/AddedActionDto"}},"updated":{"type":"array","description":"List of the actions that will be updated.","items":{"$ref":"#/components/schemas/UpdatedActionDto"}},"deleted":{"type":"array","description":"List of the actions that will be deleted.","items":{"type":"string","description":"List of the actions that will be deleted."}}},"description":"List of the actions that will be updated."},"UpdateActionGroupDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the action group."},"enabled":{"type":"boolean","description":"Enabled status of the action group."},"actions":{"$ref":"#/components/schemas/ActionsDto"}}},"SyncLinks":{"type":"object","properties":{"next":{"type":"string"},"previous":{"type":"string"}},"description":"Links of the sync actions."},"UpdateSyncActionOrderRequest":{"type":"object","properties":{"successorId":{"type":"string"}}},"UpdatedActionDto":{"required":["id"],"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"name":{"type":"string"},"enabled":{"type":"boolean"},"filter":{"$ref":"#/components/schemas/FilterDto"},"typeSpecificProperties":{"type":"object","additionalProperties":{"type":"object"}},"fieldMappings":{"type":"object","additionalProperties":{"type":"object"}},"actionMapping":{"$ref":"#/components/schemas/ActionMappingDto"}},"description":"List of the actions that will be updated."},"UpdateSyncDto":{"type":"object","properties":{"name":{"type":"string","description":"Name of the sync. Name must be unique for each sync."},"description":{"type":"string","description":"Description of the sync."},"enabled":{"type":"boolean","description":"This parameter is for specifying whether the integration will be enabled or not."},"teamId":{"type":"string","description":"Owner team of the sync, consisting id of the owner team."},"properties":{"type":"object","additionalProperties":{"type":"object","description":"Sync specific properties may be provided to this object. \nFor instance, this map should consist \n- *connectionId*\n- *projectKey*"},"description":"Sync specific properties may be provided to this object. \nFor instance, this map should consist \n- *connectionId*\n- *projectKey*"}}},"CreateActionGroupDto":{"required":["name","type"],"type":"object","properties":{"type":{"type":"string","description":"Type of the action group. It can be *forwarding*, *updating* or *checkbox*.","enum":["forwarding","updating","checkbox"]},"name":{"type":"string","description":"Name of the action group."},"order":{"type":"number","description":"Order of the action group.","format":"float"},"enabled":{"type":"boolean","description":"Enabled status of the action group."},"rootAction":{"$ref":"#/components/schemas/AddedActionDto"},"updateActions":{"type":"array","description":"List of the actions that will be created.","items":{"$ref":"#/components/schemas/AddedActionDto"}}}},"FilterDto":{"type":"object","properties":{"conditionsEmpty":{"type":"boolean"},"conditionMatchType":{"type":"string","enum":["match-all","match-any-condition","match-all-conditions"]},"conditions":{"type":"array","items":{"$ref":"#/components/schemas/IntegrationConditionDto"}}},"description":"Filter of the action."},"Syncs":{"title":"Syncs","type":"object","properties":{"links":{"$ref":"#/components/schemas/SyncLinks"},"values":{"type":"array","description":"List of syncs.","items":{"$ref":"#/components/schemas/SyncMetadata"}}}},"SyncActions":{"title":"SyncActions","type":"object","properties":{"links":{"$ref":"#/components/schemas/SyncLinks"},"values":{"type":"array","description":"List of sync actions.","items":{"$ref":"#/components/schemas/SyncActionMetadataDto"}}}},"SyncMetadata":{"title":"SyncMetadata","type":"object","properties":{"id":{"type":"string","description":"Id of the sync."},"name":{"type":"string","description":"Name of the sync."},"type":{"type":"string","description":"Type of the sync. (For instance, \"jira-software-cloud\" for Jira Software Cloud Sync.)"},"enabled":{"type":"boolean","description":"This parameter is for specifying whether the sync will be enabled or not. Defaults to false"},"teamId":{"type":"string","description":"Owner team of the sync, consisting id of the owner team."}},"description":"List of syncs."},"CreateSyncActionRequest":{"required":["direction","filter","name","type"],"type":"object","properties":{"type":{"type":"string","description":"Type of the action. It can be *create*, *close*, *acknowledge* or *addNote* for incoming actions. Types of outgoing actions can be change according to integration types such as *addComment* or *closeIssue* etc."},"name":{"type":"string","description":"Name of the action."},"direction":{"type":"string","description":"Direction of the action. It can be *incoming* or *outgoing*","enum":["incoming","outgoing"]},"actionGroupType":{"type":"string","description":"Group type of the action. It can be *forwarding*, *updating* or *checkbox*. It must be provided for outgoing actions","enum":["forwarding","updating","checkbox"]},"actionMapping":{"$ref":"#/components/schemas/ActionMappingDto"},"enabled":{"type":"boolean","description":"Enabled status of the action."},"filter":{"$ref":"#/components/schemas/FilterDto"},"properties":{"type":"object","additionalProperties":{"type":"object","description":"Action specific properties of the action."},"description":"Action specific properties of the action."},"fieldMappings":{"type":"object","additionalProperties":{"type":"object","description":"The fields mapping between payload and alert fields."},"description":"The fields mapping between payload and alert fields."}}},"IntegrationConditionDto":{"required":["field","operation"],"type":"object","properties":{"order":{"type":"integer","format":"int32"},"field":{"type":"string"},"expectedValue":{"type":"string"},"not":{"type":"boolean"},"operation":{"type":"string","enum":["matches","contains","starts-with","ends-with","equals","contains-key","contains-value","greater-than","less-than","is-empty","equals-ignore-whitespace"]},"key":{"type":"string"},"systemCondition":{"type":"boolean"}}},"SyncAction":{"title":"SyncAction","type":"object","properties":{"id":{"type":"string","description":"Id of the action."},"name":{"type":"string","description":"Name of the action."},"type":{"type":"string","description":"Type of the action."},"enabled":{"type":"boolean","description":"Enabled status of the action."},"order":{"type":"number","description":"Order of the action.","format":"float"},"direction":{"type":"string","description":"Direction of the action.","enum":["incoming","outgoing"]},"actionGroupId":{"type":"string","description":"Id of the action group that the action belongs to."},"actionMapping":{"$ref":"#/components/schemas/ActionMappingDto"},"filter":{"$ref":"#/components/schemas/FilterDto"},"fieldMappings":{"type":"object","additionalProperties":{"type":"object","description":"Field mappings of the action."},"description":"Field mappings of the action."},"properties":{"type":"object","additionalProperties":{"type":"object","description":"Properties of the action."},"description":"Properties of the action."}},"description":"Update actions of the action group."},"AddedActionDto":{"required":["name","type"],"type":"object","properties":{"type":{"type":"string"},"name":{"type":"string"},"enabled":{"type":"boolean"},"filter":{"$ref":"#/components/schemas/FilterDto"},"typeSpecificProperties":{"type":"object","additionalProperties":{"type":"object"}},"fieldMappings":{"description":"You can use field search API (https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-fields/#api-rest-api-3-field-search-get) to find id or name of the fields while populating fieldMappings for outgoing root actions.","type":"object","additionalProperties":{"type":"object"}},"actionMapping":{"$ref":"#/components/schemas/ActionMappingDto"}},"description":"List of the actions that will be created."},"UpdateSyncActionRequest":{"required":["direction","filter","name","type"],"type":"object","properties":{"type":{"type":"string","description":"Type of the action. It can be *create*, *close*, *acknowledge* or *addNote* for incoming actions. Types of outgoing actions can be change according to integration types such as *addComment* or *closeIssue* etc."},"name":{"type":"string","description":"Name of the action."},"direction":{"type":"string","description":"Direction of the action. It can be *incoming* or *outgoing*","enum":["incoming","outgoing"]},"actionGroupType":{"type":"string","description":"Group type of the action. It can be *forwarding*, *updating* or *checkbox*. It must be provided for outgoing actions","enum":["forwarding","updating","checkbox"]},"actionMapping":{"$ref":"#/components/schemas/ActionMappingDto"},"enabled":{"type":"boolean","description":"Enabled status of the action."},"filter":{"$ref":"#/components/schemas/FilterDto"},"properties":{"type":"object","additionalProperties":{"type":"object","description":"Action specific properties of the action."},"description":"Action specific properties of the action."},"fieldMappings":{"type":"object","additionalProperties":{"type":"object","description":"The fields mapping between payload and alert fields."},"description":"The fields mapping between payload and alert fields."}}},"SyncActionMetadataDto":{"type":"object","properties":{"id":{"type":"string","description":"Id of the action."},"name":{"type":"string","description":"Name of the action."},"type":{"type":"string","description":"Type of the action."},"enabled":{"type":"boolean","description":"Enabled status of the action."},"order":{"type":"number","description":"Order of the action.","format":"float"},"direction":{"type":"string","description":"Direction of the action.","enum":["incoming","outgoing"]},"actionGroupId":{"type":"string","description":"Id of the action group that the action belongs to."}},"description":"List of sync actions."},"SyncActionGroup":{"title":"SyncActionGroup","type":"object","properties":{"id":{"type":"string","description":"Id of the action group."},"type":{"type":"string","description":"Type of the action group.","enum":["forwarding","updating","checkbox"]},"name":{"type":"string","description":"Name of the action group."},"order":{"type":"number","description":"Order of the action group.","format":"float"},"enabled":{"type":"boolean","description":"Enabled status of the action group."},"rootAction":{"$ref":"#/components/schemas/SyncAction"},"updateActions":{"type":"array","description":"Update actions of the action group.","items":{"$ref":"#/components/schemas/SyncAction"}}}},"UpdateSyncActionGroupOrderRequest":{"required":["successorId"],"type":"object","properties":{"successorId":{"type":"string","description":"The action group will be in the next order of the given successor."}}},"Sync":{"title":"Sync","type":"object","properties":{"id":{"type":"string","description":"Id of the sync."},"name":{"type":"string","description":"Name of the sync."},"type":{"type":"string","description":"Type of the sync. (For instance, \"jira-software-cloud\" for Jira Software Cloud Sync.)"},"enabled":{"type":"boolean","description":"This parameter is for specifying whether the sync will be enabled or not. Defaults to false"},"teamId":{"type":"string","description":"Owner team of the sync, consisting id of the owner team."},"properties":{"type":"object","additionalProperties":{"type":"object","description":"Properties of the sync."},"description":"Properties of the sync."}}},"ActionMappingDto":{"required":["type"],"type":"object","properties":{"type":{"type":"string"},"parameter":{"type":"object"}},"description":"Action mapping of the action."}}},"x-atlassian-narrative":{"documents":[{"title":"About","anchor":"about","body":"<div style=\"background-color: #deebff; padding: 10px; margin-bottom: 12px;\">\n  <strong><span style=\"color: #0552cc;\">&#9432;</span></strong> This article highlights a new alerting feature that's natively available in Compass \n  which is gradually rolling out to some Compass customers. It may not yet be visible or available on your site.\n</div>\nThis is the reference for the Compass operations REST API. The REST API is for developers who want to integrate Compass operations with other applications \nor administrators that want to automate their workflows and processes."},{"title":"Permissions and roles","anchor":"permissions","body":"Permissions control the level of a user's access to the Compass instance, while roles are how the permissions are assigned to individual users.\nFor detailed information on roles and permissions, see [Permissions overview](https://developer.atlassian.com/cloud/compass/getting-started/understand-user-roles-in-Compass/).\nTo use the Operations API, users must obtain either Global or Team roles depending on specific domain requirements.\n\n**Global Roles** \n- Admin - They are responsible for overall administration, including managing global settings, user accounts, and security settings. \n  [Give users admin permissions](https://support.atlassian.com/user-management/docs/give-users-admin-permissions/)\n- User - This standard role allows users to update their own information. Additionally, this role can be extended through the definition of custom roles. \n  [For more details, please refer to](https://compass-ops-help.atlassian.net/wiki/spaces/OPERATIONS/pages/11469915/Work+with+custom+roles)\n\n**Team Roles**\n- Team Admin - Members of your team that take this role can manage any kind of settings, configuration (schedule configuration, \nintegration setup, etc.), and other users in the team. [Learn more about Team Roles](https://compass-ops-help.atlassian.net/wiki/spaces/OPERATIONS/pages/10420253/Work+with+member+roles)\n- Team Member - Team members can only access the configurations that they're part of, and they can only access the alerts that they have permission for."},{"title":"Authentication","anchor":"authentication","body":"Compass operations API supports the use of the basic authentication method.\n[Basic auth for REST APIs](https://developer.atlassian.com/cloud/compass/rest/v2/intro/#authentication) for details."},{"title":"Status codes and responses","anchor":"status","body":"- <span class=\"aui-lozenge aui-lozenge-success\">Status 200</span> Returned if the requested content (GET) is returned or content is updated (PUT).\n- <span class=\"aui-lozenge aui-lozenge-success\">Status 201</span> Returned if new records are created (PUT).\n- <span class=\"aui-lozenge aui-lozenge-success\">Status 204</span> Returned where the request may or may not have been actioned, \n  but the outcome is as expected. For example, the schedule has been successfully removed, but there's no additional content to display as a result.\n- <span class=\"aui-lozenge aui-lozenge-error\">Status 400</span> Returned if the request was invalid.\n- <span class=\"aui-lozenge aui-lozenge-error\">Status 401</span> Returned if the API token is not valid. Resolve this by validating the API token and reissuing the call.\n- <span class=\"aui-lozenge aui-lozenge-error\">Status 402</span> Returned if the client must pay to access the requested resource.\n- <span class=\"aui-lozenge aui-lozenge-error\">Status 403</span> Returned if the user does not have the necessary permission to access the resource or run the method.\n- <span class=\"aui-lozenge aui-lozenge-error\">Status 404</span> Returned if the passed path parameters do not correspond to an object in the instance, for example, \n  no Schedule exists for a passed ID.\n- <span class=\"aui-lozenge aui-lozenge-error\">Status 409</span> Returned when a conflict is identified with the request. This typically happens when\n  the request tries to create an entity that already exists.\n- <span class=\"aui-lozenge aui-lozenge-error\">Status 422</span> Returned when the server understands the content type of the request entity, but the server\n  was unable to process the contained instructions.\n- <span class=\"aui-lozenge aui-lozenge-error\">Status 429</span> Returned when the number of requests has exceeded the rate limit.\n\nResources will return a response body in addition to the error status codes. The returned entity for errors is as follows:\n\n```json\n{\n  \"errors\": [\n    {\n      \"title\": \"Actual reason why user was not found\",\n    },\n    {\n      ...\n    }\n  ]\n}\n```"},{"title":"URL format","anchor":"url","body":"The Compass operations REST API uses a consistent URL pattern to access different resources. The general format is as follows: \n```\n  https://api.atlassian.com/compass/cloud/{cloudId}/ops/{version}/{domain}\n```\n- **{cloudId}** represents the unique identifier for your cloud instance.\n- **{version}** is the version of the API you want to access. Currently, only version 1 ('v1') is available.\n- **{domain}**  is the specific domain of the API you want to access. Examples include 'schedule', 'team', 'alert', 'user', among others. \n  The exact domain will depend on the specific area of the API you wish to access.\n  \nAn example of a fully constructed URL might look like this: `https://api.atlassian.com/compass/cloud/{cloudId}/ops/v1/schedules/{scheduleId}`.\nThis URL accesses the 'schedule' domain of the API for retrieving a schedule based on its id."},{"title":"Date and time format","anchor":"dateTime","body":"The Compass operations REST API follows the **ISO 8601** standard for representing dates and times. This consistent string format, \nsuch as '2023-12-15T15:20:25+00:00', is used across all API endpoints. In this format, '2023-12-15' denotes the date (**year-month-day**), 'T' is a\ndelimiter that separates the date from the time, '15:20:25' represents the time (**hours:minutes:seconds**), and '+00:00' indicates the timezone offset\nfrom Coordinated Universal Time (**UTC**)."},{"title":"Pagination","anchor":"pagination","body":"The Compass operations REST API uses pagination to conserve server resources and limit the size of responses. Pagination is enforced for \nmethods that could return a large collection. When you make a request to a paged API, the response will wrap the returned values in a JSON object with\npaging metadata, as follows:\n\n**Request**\n```\nhttps://api.atlassian.com/compass/cloud/{cloudId}/ops/v1/{domain}?offset=0&size=10\n```\n\n**Response**\n```json\n{\n  \"values\" : [\n    //list of DTOs\n  ],\n  \"links\": {\n    \"next\": \"https://api.atlassian.com/compass/cloud/{cloudId}/ops/v1/{domain}?offset=1&size=10\", //absence or null indicates it is the last page\n    \"prev\": \"\",  //optional field\n    \"first\": \"\", //optional field\n    \"last\": \"\"   //optional field\n  }\n}\n```"},{"title":"Expansion","anchor":"expansion","body":"To simplify API responses, the Compass operations REST API uses resource expansion: the API will only return parts of the resource\nwhen explicitly requested. Use the `expand` query parameter to specify the list of entities that you want to be expanded, \nidentifying each of them by name. \n\nFor example, appending `?expand=base` to a request's URI results in the inclusion of the base timeline details in the response of schedule timeline. \nThe following URL would be used to get that information for the request:\n\n```\nhttps://api.atlassian.com/compass/cloud/{cloudId}/ops/v1/schedules/{scheduleId}/timeline?expand=base\n```\n\nAlternatively, you can pass the list of entities you want to be expanded as a single comma-separated parameter, as in:\n\n```\nhttps://api.atlassian.com/compass/cloud/{cloudId}/ops/v1/schedules/{scheduleId}/timeline?expand=base,forwarding,override\n```\n\nTo discover the expansion identifiers for each entity, look at the `_expands` property in the parent object. In the JSON example below, the resource declares\n`base`, `forwarding` and `override` as expandable\n\n```json\n{\n  \"startDate\": \"2023-12-24T21:00:00Z\",\n  \"endDate\": \"2023-12-31T21:00:00Z\",\n  \"finalTimeline\": {\n    \"rotations\": [\n      // rotation DTOs\n    ]\n  },\n  \"baseTimeline\": {\n    \"rotations\": [\n      // rotation DTOs\n    ]\n  },\n  \"_expands\": [\n    \"base\",\n    \"forwarding\",\n    \"override\"\n  ]\n}\n```"}]},"x-common-scopes":{"read_alert":[{"basicAuth":[]}],"write_alert":[{"basicAuth":[]}],"delete_alert":[{"basicAuth":[]}],"read_config":[{"basicAuth":[]}],"write_config":[{"basicAuth":[]}],"delete_config":[{"basicAuth":[]}]},"tags":[{"name":"Alerts","description":"The Alerts API is designed to manage alerts which provide critical \ncontext and enable teams to manage incidents effectively. This resource represents\nthe all contracts of alerts in Compass."},{"name":"Audit Logs","description":"The Audit Logs API is designed to help you access the operations audit\nlogs which capture the key changes and activities in Compass.\nThe activities include alerting, on-call, incident management, and other operation\nfeatures."},{"name":"Contacts","description":"This resource represents the contract to create/update/delete alert notification contacts in Compass."},{"name":"Custom user roles"},{"name":"Escalations","description":"Escalation policies can be used to notify multiple users/teams/schedules\nin order till the alert is acknowledged by someone. This resource represents\nthe contract to create/update/delete/get of escalations in Compass."},{"name":"Forwarding rules","description":"This resource represents the contract to create/update/delete/get\nof forwarding-rules in Compass. Forwarding rules are used for\nforwarding the incoming notification to another user."},{"name":"Heartbeats","description":"This resource represents the contract to create/update/delete/get\nof heartbeats in Compass."},{"name":"Integrations","description":"This resource represents Integrations in Compass. Use it to get, list, create,\nupdate, or delete integrations."},{"name":"Integration actions","description":"This resource represents Integration Actions in Compass. Use it to get, list,\ncreate, update, delete, or reorder of actions of an integration."},{"name":"Integration outgoing filters","description":"This resource represents Alert Filters of an Integration in Compass. \nUse it to get or update alert filters of an integration."},{"name":"Maintenances","description":"A set of rules that can be added to enable or disable multiple policies,\nintegrations or syncs with a single entry. This resource represents the all\ncontracts of maintenance plans in Compass."},{"name":"Notification rules","description":"Notification rules allow users to configure notification steps that\nuse their existing contact methods and define conditions & time constraints\non them. This resource represents the contract to create/get/update/delete/list\nof notification-rules in Compass."},{"name":"Notification rule steps","description":"Notification rule steps allow users to define how they want to be\nnotified. This resource represents the all contracts of notification rule steps\nin Compass."},{"name":"Policies","description":"This resource represents the contract to create/read/update/delete of Policies in Compass."},{"name":"Team Policies","description":"This resource represents the contract to create/read/update/delete of Team Policies in Compass."},{"name":"Routing rules","description":"This resource represents the contract to create/read/update/delete\nof routing rules in Compass."},{"name":"Schedules","description":"This resource represents schedules in Compass. Use it to:\n- create a new schedule.\n- list all schedules.\n- get a schedule.\n- update a schedule.\n- delete a schedule."},{"name":"Schedule on-calls","description":"This resource represents schedule on-calls in Compass. Use it to:\n- list on-call responders on a schedule.\n- list the next on-call responders on a schedule.\n- export on-call responders on a schedule in calendar format."},{"name":"Schedule overrides","description":"This resource represents schedule overrides in Compass. Use it to:\n- list all overrides of a schedule.\n- create a new override.\n- get an override.\n- update an override.\n- delete an override."},{"name":"Schedule rotations","description":"This resource represents on-call schedule rotations in Compass. Use it to:\n- list all rotations of a schedule.\n- create a new rotation.\n- get a rotation.\n- update a rotation.\n- delete a rotation."},{"name":"Schedule timelines","description":"This resource represents schedule timelines in Compass. Use it to:\n- calculate the timeline of a schedule.\n- export the timeline of a schedule in calendar format."},{"name":"Syncs","description":"This resource represents Syncs in Compass. Use it to get, list, create, update, or delete syncs."},{"name":"Sync actions","description":"This resource represents Sync Actions in Compass. Use it to get, list, create, update, delete or reorder of actions of a sync."},{"name":"Sync action groups","description":"This resource represents Sync Action Groups in Compass. Use it to get, list, create, update, delete or reorder of action groups of a sync."}],"paths":{"/v1/schedules":{"get":{"tags":["Schedules"],"summary":"List schedules","description":"Lists all schedules that user can view. It optionally takes two parameters - offset and size.<br> <br> **Permissions required:** Permission to access Compass; however, the list contains a schedule if: \n - the user has read-only administrative right. \n - the schedule's assigned team is one of the teams that the user belongs to. \n - the user is added to a rotation of the schedule as a responder. \n - a team is added to a rotation of the schedule as a responder, and the user is a member of this team. \n - an escalation is added to a rotation of the schedule as a responder, and the user is a member of this escalation. \n - there is an override to the user in the schedule.","operationId":"listSchedules","parameters":[{"name":"query","in":"query","description":"The query keyword to filter schedules by name.","required":false,"schema":{"type":"string"}},{"name":"size","in":"query","description":"The limit parameter controls the maximum number of items that\nmay be returned for a single request.","required":false,"schema":{"type":"integer","format":"int32","default":25,"maximum":50,"minimum":1}},{"name":"offset","in":"query","description":"The offset parameter controls the starting point within the\ncollection of resource results.","required":false,"schema":{"type":"integer","format":"int32","default":0,"minimum":0}},{"name":"expand","in":"query","description":"The list of possible expansions in the response. Possible values: `rotation`.","required":false,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSchedulesResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"422":{"description":"Returned if the query parameters cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"post":{"tags":["Schedules"],"summary":"Create schedule","description":"Creates a schedule with given properties.<br> <br> **Permissions required:** Permission to create a schedule: \n - the user has edit configuration right. \n - the user is the admin of the team that the schedule belongs to.","operationId":"createSchedule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateScheduleRequest"}}},"required":true},"responses":{"201":{"description":"Returned if the schedule is created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Schedule"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the user does not have permission to create the schedule.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"409":{"description":"Returned if there exists another schedule with the same name.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/schedules/{id}":{"get":{"tags":["Schedules"],"summary":"Get schedule","description":"Returns the details of the schedule with given id in the request. <br> <br> **Permissions required:** Permission to access to the schedule: \n - the user has read-only administrative right. \n - the schedule's assigned team is one of the teams that the user belongs to. \n - the user is added to a rotation of the schedule as a responder. \n - a team is added to a rotation of the schedule as a responder, and the user is a member of this team. \n - an escalation is added to a rotation of the schedule as a responder, and the user is a member of this escalation. \n - there is an override to the user in the schedule.","operationId":"getSchedule","parameters":[{"name":"id","in":"path","description":"ID of the schedule.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Schedule"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the requesting user does not have permission to view the schedule.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the schedule is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"patch":{"tags":["Schedules"],"summary":"Update schedule","description":"Updates the schedule with given id in the request. <br> <br> **Permissions required:** Permission to update the schedule: \n - the user has edit configuration right. \n - the user is the admin of the team that the schedule belongs to.","operationId":"updateSchedule","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateScheduleRequest"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Schedule"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the user does not have permission to update the schedule.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the schedule is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"409":{"description":"Returned if there exists another schedule with the same name.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"delete":{"tags":["Schedules"],"summary":"Delete schedule","description":"Deletes the schedule with given id in the request. <br> <br> **Permissions required:** Permission to delete the schedule: \n - the user has delete configuration right. \n - the user is the admin of the team that the schedule belongs to.","operationId":"deleteSchedule","parameters":[{"name":"id","in":"path","description":"ID of the schedule.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the schedule is deleted successfully."},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the requesting user does not have permission to delete the schedule.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the schedule is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/schedules/{scheduleId}/rotations":{"get":{"tags":["Schedule rotations"],"summary":"List rotations","description":"Lists all rotations of the schedule with given id in the request. It optionally takes two parameters - offset and size.<br> <br> **Permissions required:** Permission to access to the schedule: \n - the user has read-only administrative right. \n - the schedule's assigned team is one of the teams that the user belongs to. \n - the user is added to a rotation of the schedule as a responder. \n - a team is added to a rotation of the schedule as a responder, and the user is a member of this team. \n - an escalation is added to a rotation of the schedule as a responder, and the user is a member of this escalation. \n - there is an override to the user in the schedule.","operationId":"listRotations","parameters":[{"name":"scheduleId","in":"path","required":true,"schema":{"type":"string"},"description":"ID of the schedule."},{"name":"size","in":"query","description":"The limit parameter controls the maximum number of items that\nmay be returned for a single request.","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":50,"default":25}},{"name":"offset","in":"query","required":false,"description":"The offset parameter controls the starting point within the\ncollection of resource results.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListRotationsResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the requesting user does not have permission to view the schedule.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the schedule is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"post":{"tags":["Schedule rotations"],"summary":"Create rotation","description":"Creates a new rotation for the schedule with given id and properties.<br> <br> **Permissions required:** Permission to edit a schedule: \n - the user has edit configuration right. \n - the user is the admin of the team that the schedule belongs to.","operationId":"createRotation","parameters":[{"name":"scheduleId","in":"path","required":true,"schema":{"type":"string"},"description":"ID of the schedule."}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRotationRequest"}}},"required":true},"responses":{"201":{"description":"Returned if the rotation is created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rotation"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the user does not have permission to create the rotation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the schedule is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"409":{"description":"Returned if there exists another rotation with the same name.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/schedules/{scheduleId}/rotations/{id}":{"get":{"tags":["Schedule rotations"],"summary":"Get rotation","description":"Returns the details of the rotation of a schedule with given IDs in the request. <br> <br> **Permissions required:** Permission to access to the schedule: \n - the user has read-only administrative right. \n - the schedule's assigned team is one of the teams that the user belongs to. \n - the user is added to a rotation of the schedule as a responder. \n - a team is added to a rotation of the schedule as a responder, and the user is a member of this team. \n - an escalation is added to a rotation of the schedule as a responder, and the user is a member of this escalation. \n - there is an override to the user in the schedule.","operationId":"getRotation","parameters":[{"name":"scheduleId","in":"path","required":true,"schema":{"type":"string"},"description":"ID of the schedule."},{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"ID of the rotation."}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rotation"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the requesting user does not have permission to view the schedule.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the schedule or rotation is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"delete":{"tags":["Schedule rotations"],"summary":"Delete rotation","description":"Deletes the rotation of a schedule with given IDs in the request. <br> <br> **Permissions required:** Permission to delete the rotation: \n - the user has delete configuration right. \n - the user is the admin of the team that rotation's schedule belongs to.","operationId":"deleteRotation","parameters":[{"name":"scheduleId","in":"path","required":true,"schema":{"type":"string"},"description":"ID of the schedule."},{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"ID of the rotation."}],"responses":{"204":{"description":"Returned if the rotation is deleted successfully."},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the requesting user does not have permission to delete the rotation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the schedule or rotation is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"patch":{"tags":["Schedule rotations"],"summary":"Update rotation","description":"Updates the rotation of a schedule with given IDs in the request. <br> <br> **Permissions required:** Permission to edit a schedule: \n - the user has edit configuration right. \n - the user is the admin of the team that the schedule belongs to.","operationId":"updateRotation","parameters":[{"name":"scheduleId","in":"path","required":true,"schema":{"type":"string"},"description":"ID of the schedule."},{"name":"id","in":"path","required":true,"schema":{"type":"string"},"description":"ID of the rotation."}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRotationRequest"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Rotation"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the user does not have permission to update the rotation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the schedule or rotation is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"409":{"description":"Returned if there exists another rotation with the same name.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/schedules/{scheduleId}/overrides":{"get":{"tags":["Schedule overrides"],"summary":"List overrides","description":"Lists all ongoing and future overrides of the schedule with given id in the request. It optionally takes two parameters - offset and size.<br> <br> **Permissions required:** Permission to access to the schedule: \n - the user has read-only administrative right. \n - the schedule's assigned team is one of the teams that the user belongs to. \n - the user is added to a rotation of the schedule as a responder. \n - a team is added to a rotation of the schedule as a responder, and the user is a member of this team. \n - an escalation is added to a rotation of the schedule as a responder, and the user is a member of this escalation. \n - there is an override to the user in the schedule.","operationId":"listOverrides","parameters":[{"name":"scheduleId","in":"path","required":true,"schema":{"type":"string"},"description":"ID of the schedule."},{"name":"size","in":"query","description":"The limit parameter controls the maximum number of items that\nmay be returned for a single request.","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":50,"default":25}},{"name":"offset","in":"query","required":false,"description":"The offset parameter controls the starting point within the\ncollection of resource results.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOverridesResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the requesting user does not have permission to view the schedule.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the schedule is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"post":{"tags":["Schedule overrides"],"summary":"Create override","description":"Creates a new override for the schedule with given id and properties.<br> <br> **Permissions required:** Permission to create an override: \n - the user has edit configuration right. \n - the user is a member of the team that the schedule belongs to. \n - the user is adding override to themself. \n - the user exists in the schedule directly or indirectly.","operationId":"createOverride","parameters":[{"name":"scheduleId","in":"path","required":true,"schema":{"type":"string"},"description":"ID of the schedule."}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOverrideRequest"}}},"required":true},"responses":{"201":{"description":"Returned if the override is created successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Override"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the user does not have permission to create the override.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the schedule is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/schedules/{scheduleId}/overrides/{alias}":{"get":{"tags":["Schedule overrides"],"summary":"Get override","description":"Returns the details of the override of a schedule with given IDs in the request. <br> <br> **Permissions required:** Permission to access to the schedule: \n - the user has read-only administrative right. \n - the schedule's assigned team is one of the teams that the user belongs to. \n - the user is added to a rotation of the schedule as a responder. \n - a team is added to a rotation of the schedule as a responder, and the user is a member of this team. \n - an escalation is added to a rotation of the schedule as a responder, and the user is a member of this escalation. \n - there is an override to the user in the schedule.","operationId":"getOverride","parameters":[{"name":"scheduleId","in":"path","required":true,"schema":{"type":"string"},"description":"ID of the schedule."},{"name":"alias","in":"path","required":true,"schema":{"type":"string"},"description":"Alias of the override."}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Override"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the requesting user does not have permission to view the override.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the schedule or override is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"put":{"tags":["Schedule overrides"],"summary":"Update override","description":"Updates the override of a schedule with given IDs in the request.<br> <br> **Permissions required:** Permission to update an override: \n - the user has edit configuration right. \n - the user is a member of the team that the schedule belongs to. \n - the user is adding override to themself. \n - the user exists in the schedule directly or indirectly by flattening.","operationId":"updateOverride","parameters":[{"name":"scheduleId","in":"path","required":true,"schema":{"type":"string"},"description":"ID of the schedule."},{"name":"alias","in":"path","required":true,"schema":{"type":"string"},"description":"Alias of the override."}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOverrideRequest"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Override"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the user does not have permission to update the override.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the schedule or override is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"delete":{"tags":["Schedule overrides"],"summary":"Delete override","description":"Deletes the override of a schedule with given IDs in the request. <br> <br> **Permissions required:** Permission to delete the override: \n - the user is the responder of the override. \n - the user has edit configuration right. \n - the user is the admin of the team that the schedule belongs to.","operationId":"deleteOverride","parameters":[{"name":"scheduleId","in":"path","required":true,"schema":{"type":"string"},"description":"ID of the schedule."},{"name":"alias","in":"path","required":true,"schema":{"type":"string"},"description":"Alias of the override."}],"responses":{"204":{"description":"Returned if the override is deleted successfully."},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the requesting user does not have permission to delete the override.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the schedule or override is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/schedules/{scheduleId}/timeline":{"get":{"tags":["Schedule timelines"],"summary":"Get schedule timeline","description":"Returns the timeline of the schedule with given id in the request. The time range of the timeline can go back at most one year from today and as far as two years from today. Therefore, query parameters should be given accordingly.<br> <br> **Permissions required:** Permission to access to the schedule: \n - the user has read-only administrative right. \n - the schedule's assigned team is one of the teams that the user belongs to. \n - the user is added to a rotation of the schedule as a responder. \n - a team is added to a rotation of the schedule as a responder, and the user is a member of this team. \n - an escalation is added to a rotation of the schedule as a responder, and the user is a member of this escalation. \n - there is an override to the user in the schedule.","operationId":"getTimeline","parameters":[{"name":"scheduleId","in":"path","required":true,"schema":{"type":"string"},"description":"ID of the schedule."},{"name":"interval","in":"query","schema":{"type":"integer","format":"int32","default":1},"description":"The length of the timeline calculation time range as an integer in `intervalUnits`."},{"name":"intervalUnit","in":"query","schema":{"type":"string","enum":["days","weeks","months"],"default":"weeks"},"description":"The unit of the timeline calculation time range."},{"name":"date","in":"query","schema":{"type":"string","format":"date-time","default":"time of request"},"description":"The date to calculate timeline according to. The `interval`, \n`intervalUnit`, and this field are combined to calculate to time range \nof the timeline. The start of the time range is the point of time that \nis the beginning of the `intervalUnit` containing this date. The end of \nthe time range is the point of time `intervalUnit` * `interval` time is \nadded to the start of the time range. <br> <br> For example, for the parameters \n`interval = 2`, `intervalUnit = months`, `date = '2023-12-15T15:20:25+00:00'`, \nthe time range of the timeline is (`2023-12-01T00:00:00+00:00`, `2024-02-01T00:00:00+00:00`)."},{"name":"expand","in":"query","schema":{"type":"array","items":{"type":"string"}},"description":"The list of possible expansions in the response. The default response \nonly contains the timeline of the final layer. With these expansions, \ntimeline of base, forwarding, and override layers can also be calculated. \nPossible values: `base`, `forwarding`, `override`."}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleTimelineResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the requesting user does not have permission to view the schedule.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the schedule is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the query parameters cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/schedules/{scheduleId}.ics":{"get":{"tags":["Schedule timelines"],"summary":"Export schedule timeline","description":"Exports the timeline in the calendar (.ics) format for the schedule with given id in the request. The time range of the export starts from the beginning of the current month and ends one year after the start date.<br> <br> **Permissions required:** Permission to access to the schedule: \n - the user has read-only administrative right. \n - the schedule's assigned team is one of the teams that the user belongs to. \n - the user is added to a rotation of the schedule as a responder. \n - a team is added to a rotation of the schedule as a responder, and the user is a member of this team. \n - an escalation is added to a rotation of the schedule as a responder, and the user is a member of this escalation. \n - there is an override to the user in the schedule.","operationId":"exportTimeline","parameters":[{"name":"scheduleId","in":"path","required":true,"schema":{"type":"string"},"description":"ID of the schedule."}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"text/calendar":{"schema":{"type":"object"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the requesting user does not have permission to view the schedule.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the schedule is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/schedules/{scheduleId}/on-calls":{"get":{"tags":["Schedule on-calls"],"summary":"List on-call responders","description":"Lists the on-call responders at a specific time for the schedule with given id in the request.<br> <br> **Permissions required:** Permission to access to the schedule: \n - the user has read-only administrative right. \n - the schedule's assigned team is one of the teams that the user belongs to. \n - the user is added to a rotation of the schedule as a responder. \n - a team is added to a rotation of the schedule as a responder, and the user is a member of this team. \n - an escalation is added to a rotation of the schedule as a responder, and the user is a member of this escalation. \n - there is an override to the user in the schedule.","operationId":"getOnCalls","parameters":[{"name":"scheduleId","in":"path","required":true,"schema":{"type":"string"},"description":"ID of the schedule."},{"name":"flat","in":"query","required":false,"schema":{"type":"boolean","default":false},"description":"When enabled, returns only the user names of the on-call participants\nin user type. Otherwise, returns the complete flattening tree for on-calls."},{"name":"date","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"description":"The date for which the schedule's on-calls are requested."}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OnCallResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the requesting user does not have permission to view the schedule.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the schedule is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the query parameters cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/schedules/{scheduleId}/next-on-calls":{"get":{"tags":["Schedule on-calls"],"summary":"List next on-call responders","description":"Lists the next on-call responders at a specific time for the schedule with given id in the request.<br> <br> **Permissions required:** Permission to access to the schedule: \n - the user has read-only administrative right. \n - the schedule's assigned team is one of the teams that the user belongs to. \n - the user is added to a rotation of the schedule as a responder. \n - a team is added to a rotation of the schedule as a responder, and the user is a member of this team. \n - an escalation is added to a rotation of the schedule as a responder, and the user is a member of this escalation. \n - there is an override to the user in the schedule.","operationId":"getNextOnCalls","parameters":[{"name":"scheduleId","in":"path","required":true,"schema":{"type":"string"},"description":"ID of the schedule."},{"name":"flat","in":"query","required":false,"schema":{"type":"boolean","default":false},"description":"When enabled, returns only the user names of all next on-call participants\nin user type. Otherwise, returns the complete flattening tree for next on-calls."},{"name":"date","in":"query","required":false,"schema":{"type":"string","format":"date-time"},"description":"The date for which the schedule's next on-calls are requested."}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NextOnCallResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the requesting user does not have permission to view the schedule.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the schedule is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the query parameters cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/schedules/on-calls/{userIdentifier}.ics":{"get":{"tags":["Schedule on-calls"],"summary":"Export on-call responders","description":"Exports the on-call periods in the calendar (.ics) format for the user with given id in the request.\n \n **Permissions required:** Permission to export to the user on-calls: \n - the user exports the on-call calendar for themselves. \n - the user exports the on-call calendar for another user, and the requesting user is the admin. \n - the user exports the on-call calendar for another user, and the requesting user is the team admin in one of the teams of the requested user. \n","operationId":"exportOnCalls","parameters":[{"name":"userIdentifier","in":"path","required":true,"schema":{"type":"string"},"description":"ID of the user whose on-call calendar to be exported."}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"text/calendar":{"schema":{"type":"object"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the requesting user does not have permission to export the on-calls calendar for the requested user.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the schedule or the requested user is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/teams/{teamId}/escalations":{"get":{"tags":["Escalations"],"summary":"List escalations","description":"Lists all escalations under given team. It optionally takes two parameters - offset and size.","operationId":"listEscalation","parameters":[{"name":"teamId","in":"path","description":"Identifier of the escalation owning team.","required":true,"schema":{"type":"string"}},{"name":"offset","in":"query","description":"The offset parameter controls the starting point within the\ncollection of resource results.","required":false,"schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","description":"The limit parameter controls the maximum number of items that\nmay be returned for a single request.","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EscalationPaginatedResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have read-only permission for escalations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the escalation owning team is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"post":{"tags":["Escalations"],"summary":"Create escalation","description":"Creates an escalation with the given properties.","operationId":"createEscalation","parameters":[{"name":"teamId","in":"path","description":"Identifier of the escalation owning team.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEscalationRequest"},"example":{"name":"FE Daily On-call Escalation","description":"","rules":[{"condition":"if-not-acked","notifyType":"default","delay":5,"recipient":{"id":"f0f07a3d-bde8-4b2a-8d3e-f97020a51e32","type":"team"}}],"enabled":true,"repeat":{"waitInterval":10,"count":5,"resetRecipientStates":true,"closeAlertAfterAll":true}}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EscalationResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to create escalation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/teams/{teamId}/escalations/{id}":{"get":{"tags":["Escalations"],"summary":"Get escalation","description":"Gets an escalation with given id in the request.","operationId":"getEscalation","parameters":[{"name":"teamId","in":"path","description":"Identifier of the escalation owning team.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Identifier of the escalation.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EscalationResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to view the escalation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the escalation owning team or escalation is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"delete":{"tags":["Escalations"],"summary":"Delete escalation","description":"Deletes an escalation with given id in the request.","operationId":"deleteEscalation","parameters":[{"name":"teamId","in":"path","description":"Identifer of the escalation owning team.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Identifier of the escalation.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful"},"401":{"description":"Returned if the authentication credentials are incorrect","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to delete escalation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the escalation owning team or escalation is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"patch":{"tags":["Escalations"],"summary":"Update escalation","description":"Updates an escalation with given id in the request.","operationId":"updateEscalation","parameters":[{"name":"teamId","in":"path","description":"Identifier of the escalation owning team.","required":true,"schema":{"type":"string"}},{"name":"id","in":"path","description":"Identifier of the escalation.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEscalationRequest"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EscalationResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to update escalation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/logs":{"get":{"tags":["Audit Logs"],"summary":"Get audit Logs","description":"This endpoint returns all operations audit logs in Compass, allowing retrieval of logs in a specified time range and filtering based on log level and category. <br> <br> **Permissions required:** Permission to view Compass Audit logs using a Compass Org/Site/Product admin role ","operationId":"listLogs","parameters":[{"name":"limit","in":"query","required":false,"description":"Maximum number of items to return in the response.","schema":{"maximum":5000,"minimum":1000,"type":"integer","format":"int32","default":1000}},{"name":"pageToken","in":"query","required":false,"description":"Token for fetching the next set of paginated results. The page\ntoken can be retrieved from the `links.next` key in each API response.","schema":{"type":"string"}},{"name":"category","in":"query","required":false,"description":"Filter the audit logs based on the event category. Multiple\ncategories can be passed by providing a comma-separated list of values.","schema":{"type":"string","enum":["AUTOMATION","INCOMING_DATA","ALERTS","API","CONFIG_CHANGE","EMAIL","HEARTBEAT","INCIDENT_MANAGEMENT","INTEGRATION","SYNC","NOTIFICATION","ONCALL_MANAGEMENT","SERVICE","USER_IMPORT","ADD_USER_TO_GROUP","ADD_USER_TO_ROLE"]}},{"name":"level","in":"query","required":false,"description":"Filter the audit logs based on the log level. Multiple log\nlevels can be passed by providing a comma-separated list of values.","schema":{"type":"string","enum":["INFORTMATION","ERROR","WARN"]}},{"name":"startTime","in":"query","required":true,"description":"The starting date-time after which returned audit logs must\nhave been created. Accepts the ISO format **(yyyy-MM-dd'T'HH:mm:ssZ)**\n(e.g. 2024-01-15T08:00:00+02:00).","schema":{"type":"string","format":"date-time"}},{"name":"endTime","in":"query","required":true,"description":"The ending date-time before which returned audit logs must have\nbeen created. Accepts the ISO format **(yyyy-MM-dd'T'HH:mm:ssZ)**\n(e.g. 2024-01-15T08:00:00+02:00).","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"This message is returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAuditLogResponse"},"example":{"values":[{"created":"2024-02-17T11:33:34.940Z","category":"Notifications","summary":"Rule[Schedule Start][scheduleStart] -> [email] notification to [xyz@abc.com] Submitted to provider.","level":"Information","details":"{\"targetUser\": \"xyz@abc.com\"}"},{"created":"2024-02-17T11:35:34.940Z","category":"Configuration Changes","summary":"Schedule rotation [scheduleId: fa740f73, id: c124f500] added.","level":"Information","details":"{\"_incomingData\": {\"_httpParams\": {}, \"httpUrl\": \"/compass/v1/schedules/fa740f73\", \"incomingDataId\": \"c124f500\", \"_httpHeaders\": {\"Referer\": \"https://org.abc.com/jira/teams/70b66b25/on-call\", \"_entity\": {\"-rotationMetadata\": [{\"name\": \"Rotation1\", \"id\": \"bd6fdeb5\"}]}}}"}],"count":5000,"links":{"next":"/logs?startTime=2024-01-01T00:00:00Z&endTime=2024-01-01T15:30:00Z&limit=5000&pageToken=WzE3MDgxNjk0M"}}}}},"400":{"description":"Returned if the required request parameters are missing, or if any of them are incorrectly formed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"401":{"description":"Returned if the authentication credentials are incorrect or if a user with insufficient permissions is attempting to fetch the audit logs.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/maintenances":{"get":{"tags":["Maintenances"],"summary":"List global maintenances","description":"This endpoint is used to retrieve a list of maintenance that have been created within your organization's account in Compass system. It optionally takes three parameters - offset, size and type.","operationId":"listGlobalMaintenances","parameters":[{"name":"type","in":"query","required":false,"description":"Defines which maintenance will be listed according to maintenance status.","schema":{"type":"string","enum":["all","non-expired","past"],"default":"all"}},{"name":"offset","in":"query","required":false,"description":"The offset parameter controls the starting point within the collection of resource results.","schema":{"type":"integer","minimum":0,"format":"int32","default":0}},{"name":"size","in":"query","required":false,"description":"The limit parameter controls the maximum number of items that may be returned for a single request.","schema":{"maximum":100,"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/GetGlobalMaintenance"}},"links":{"$ref":"#/components/schemas/MaintenanceLinks"}}}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"422":{"description":"Returned if the payload or request cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"post":{"tags":["Maintenances"],"summary":"Create global maintenance","description":"This endpoint is used to create a new maintenance which applies rules to all teams across your organization in Compass. The maintenance plan can include various rules that enable or disable multiple entities like policies, integrations or syncs. <b>Please note that integrations and syncs cannot be enabled via a maintenance plan but policies can.</b>","operationId":"createGlobalMaintenance","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMaintenanceRequest"}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetGlobalMaintenance"}}}},"400":{"description":"Returned if the request is malformed or the request data is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to create maintenance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/maintenances/{id}":{"get":{"tags":["Maintenances"],"summary":"Get global maintenance","description":"Gets an account based global maintenance with given id in the request.","operationId":"getGlobalMaintenance","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the maintenance.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetGlobalMaintenance"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"404":{"description":"Returned if the maintenance is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"delete":{"tags":["Maintenances"],"summary":"Deletes global maintenance","description":"This request is used to delete a global maintenance.","operationId":"deleteGlobalMaintenance","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the maintenance.","schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful."},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to delete maintenance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the maintenance is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"patch":{"tags":["Maintenances"],"summary":"Update global maintenance","description":"This endpoint is used to update a global maintenance in Compass.","operationId":"updateGlobalMaintenance","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the maintenance.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMaintenanceRequest"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetGlobalMaintenance"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to update maintenance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the maintenance is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/maintenances/{id}/cancel":{"post":{"tags":["Maintenances"],"summary":"Cancel global maintenance","description":"This endpoint is used to stop an ongoing maintenance plan early. The functionality allows you to end the maintenance plan before the initially set end time.","operationId":"cancelGlobalMaintenance","parameters":[{"name":"id","in":"path","description":"Identifier of the maintenance.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetGlobalMaintenance"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to cancel maintenance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the maintenance is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/teams/{teamId}/maintenances":{"get":{"tags":["Maintenances"],"summary":"List team maintenances","description":"This endpoint is used to retrieve a list of maintenance associated with a specific team in Compass system. It optionally takes three parameters - offset, size and type.","operationId":"listTeamMaintenances","parameters":[{"name":"teamId","in":"path","required":true,"description":"Identifier of the maintenance owning team.","example":"77b933c9-92bb-46e7-a73c-764b8d7c3c25","schema":{"type":"string"}},{"name":"type","in":"query","required":false,"description":"Defines which maintenance will be listed according to maintenance status.","schema":{"type":"string","enum":["all","non-expired","past"],"default":"all"}},{"name":"offset","in":"query","required":false,"description":"The offset parameter controls the starting point within the collection of resource results.","schema":{"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","required":false,"description":"The limit parameter controls the maximum number of items that may be returned for a single request.","schema":{"maximum":100,"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/GetTeamMaintenance"}},"links":{"$ref":"#/components/schemas/MaintenanceLinks"}}},"example":{"values":[{"id":"0762db96-f795-4246-90be-edd295af8fca","status":"cancelled","description":"Maintenance Plan","startDate":"2023-12-11T11:37:39.501Z","endDate":"2023-12-11T11:42:39.501Z","rules":[{"entity":{"id":"258bec1f-bae6-4190-bcc6-56c42990131c","type":"policy"},"state":"enabled"}],"teamId":"77b933c9-92bb-46e7-a73c-764b8d7c3c25"}],"links":{"next":"/v1/teams/77b933c9-92bb-46e7-a73c-764b8d7c3c25/maintenances?offset=50&size=25"}}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have read-only permission for maintenance plans.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the maintenance owning team is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"post":{"tags":["Maintenances"],"summary":"Create team maintenance","description":"This endpoint is used to create a new maintenance for a specific team in Compass. The maintenance plan can include various rules that enable or disable multiple entities like policies, integrations or syncs. <b>Please note that integrations and syncs cannot be enabled via a maintenance plan but policies can.</b>","operationId":"createTeamMaintenance","parameters":[{"name":"teamId","in":"path","required":true,"description":"Identifier of the maintenance owning team.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMaintenanceRequest"}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful and a new maintenance has been created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTeamMaintenance"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to create maintenance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the maintenance owning team is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/teams/{teamId}/maintenances/{id}":{"get":{"tags":["Maintenances"],"summary":"Get team maintenance","description":"This request is used to retrieve a specific maintenance of a specific team.","operationId":"getTeamMaintenance","parameters":[{"name":"teamId","in":"path","required":true,"description":"Identifier of the maintenance owning team.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the maintenance.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTeamMaintenance"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have read-only permission for maintenance plans.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the maintenance owning team or maintenance is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"delete":{"tags":["Maintenances"],"summary":"Delete team maintenance","description":"Deletes a maintenance with given id in the request.","operationId":"deleteTeamMaintenance","parameters":[{"name":"teamId","in":"path","required":true,"description":"Identifier of the maintenance owning team.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the maintenance.","schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful."},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to delete maintenance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the maintenance owning team or maintenance is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"patch":{"tags":["Maintenances"],"summary":"Update team maintenance","description":"Updates a team maintenance with given id in the request.","operationId":"updateTeamMaintenance","parameters":[{"name":"teamId","in":"path","required":true,"description":"Identifier of the maintenance owning team.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the maintenance.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateMaintenanceRequest"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTeamMaintenance"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to update maintenance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the maintenance owning team or maintenance is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/teams/{teamId}/maintenances/{id}/cancel":{"post":{"tags":["Maintenances"],"summary":"Cancel team maintenance","description":"This endpoint is used to stop an ongoing maintenance plan of a specific team early. The functionality allows you to end the maintenance period before the initially set end time. ","operationId":"cancelTeamMaintenance","parameters":[{"name":"teamId","in":"path","required":true,"description":"Identifier of the maintenance owning team.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the maintenance.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTeamMaintenance"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to cancel maintenance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the maintenance owning team or maintenance is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/notification-rules/{ruleId}/steps":{"get":{"tags":["Notification rule steps"],"summary":"List notification rule steps","description":"Lists all notifaction rule steps for the user. It optionally takes two parameters - offset and size.","operationId":"listNotificationRuleSteps","parameters":[{"name":"ruleId","in":"path","description":"Identifier of the notification rule","required":true,"schema":{"type":"string"}},{"name":"offset","in":"query","required":false,"description":"The offset parameter controls the starting point within the\ncollection of resource results.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","description":"The size parameter controls the maximum number of items that\nmay be returned for a single request.","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationRulesStepPaginatedResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"404":{"description":"Returned if the notification rule with given id is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"post":{"tags":["Notification rule steps"],"summary":"Create notification rule step","description":"Creates a notification rule step with the given properties.","operationId":"createNotificationRuleStep","parameters":[{"name":"ruleId","in":"path","required":true,"description":"Identifier of the notification rule.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationRulesStepCreateNotificationRuleStepRequest"}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationRulesStepNotificationRuleStep"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to create notification rule step.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the notification rule with given id is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/notification-rules/{ruleId}/steps/{id}":{"get":{"tags":["Notification rule steps"],"summary":"Get notification rule step","description":"Gets a notification rule step with given id in the request.","operationId":"getNotificationRuleStep","parameters":[{"name":"ruleId","in":"path","required":true,"description":"Identifier of the notification rule.","schema":{"type":"string"}},{"name":"id","in":"path","description":"Identifier of the notification rule step which belongs to given\nnotification rule.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationRulesStepNotificationRuleStep"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"404":{"description":"Returned if the notification rule with given id or its steps are not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"delete":{"tags":["Notification rule steps"],"summary":"Delete notification rule step","description":"Deletes a notification rule step with given id in the request.","operationId":"deleteNotificationRuleStep","parameters":[{"name":"ruleId","in":"path","required":true,"description":"Identifier of the notification rule.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the notification rule step which belongs to given\nnotification rule.","schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful."},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to delete the notification rule step.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the notification rule with given id or its steps are not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"patch":{"tags":["Notification rule steps"],"summary":"Update notification rule step","description":"Updates a notification rule step with given id in the request.","operationId":"updateNotificationRuleStep","parameters":[{"name":"ruleId","in":"path","required":true,"description":"Identifier of the notification rule.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the notification rule step which belongs to given\nnotification rule.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateNotificationRuleStepRequest"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationRulesStepNotificationRuleStep"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to update the notification rule step.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the notification rule with given id or its steps are not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/roles/{identifier}":{"get":{"tags":["Custom user roles"],"summary":"Get custom user role","description":"Returns details of a custom user role. \n - The user should have admin role and custom user role right.","operationId":"getRole","parameters":[{"name":"identifier","in":"path","description":"Id of the custom user role.","required":true,"schema":{"type":"string","description":"Id of the custom user role."}},{"name":"identifierType","in":"query","description":"Type of the identifier.","required":false,"schema":{"type":"string","description":"Type of the identifier.","enum":["id","name"]}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCustomUserRoleResponse"},"example":{"id":"288c1908-2337-47c0-8a15-9d80fb12aaaa","name":"FinanceRole","extendedRole":"user","grantedRights":["alert-action","alert-create"],"disallowedRights":["alert-delete","alert-delete-note","alert-close","alert-close-all"]}}}},"403":{"description":"Returned if the request user does not have permission to get a custom user role.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the role with the identifier cannot be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the requested identifier doesn't belong to custom user role.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"put":{"tags":["Custom user roles"],"summary":"Update custom user role","description":"Updates the details of a custom user role. \n - The user should have admin role and custom user role right.","operationId":"update","parameters":[{"name":"identifier","in":"path","description":"Id of the custom user role.","required":true,"schema":{"type":"string","description":"Id of the custom user role."}},{"name":"identifierType","in":"query","description":"Type of the identifier.","required":false,"schema":{"type":"string","description":"Type of the identifier.","enum":["id","name"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomUserRoleUpdateRequest"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomUserRoleSuccessResponse"},"example":{"message":"Updated","data":{"id":"44a48324-f5f9-45af-b8c9-02978ab0aaaa","name":"FinanceRole"}}}}},"403":{"description":"Returned if the request user does not have permission to update a custom user role.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the role with the identifier cannot be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the requested identifier doesn't belong to custom user role.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"delete":{"tags":["Custom user roles"],"summary":"Delete custom user role.","description":"Deletes a custom user role. \n - The user should have admin role and custom user role right.","operationId":"delete","parameters":[{"name":"identifier","in":"path","required":true,"description":"Id of the custom user role.","schema":{"type":"string"}},{"name":"identifierType","in":"query","description":"Type of the identifier.","required":false,"schema":{"type":"string","description":"type of the identifier.","enum":["id","name"]}}],"responses":{"204":{"description":"Returned if the request is successful."},"403":{"description":"Returned if the request user does not have permission to delete a custom user role","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the role with the identifier cannot be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the requested identifier doesn't belong to custom user role.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/roles/assign":{"post":{"tags":["Custom user roles"],"summary":"Assign custom user role","description":"Assignes a custom user role to a user. \n - The user should have admin role and custom user role right. \n - Assignment on the admin roles can be done through Atlassian Administration.","operationId":"assignCustomRole","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignRoleRequest"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomRolesPaginatedResponse"},"example":{"message":"Created","data":{"id":"b08dc67b-a19d-4d84-925a-eaa9e13a8aa1","name":"FinanceRole"}}}}},"400":{"description":"Returned if an field is not properly set.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"403":{"description":"Returned if the request user does not have permission to assign a custom user role.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the role with the identifier cannot be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the requested identifier doesn't belong to custom user role.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/roles":{"get":{"tags":["Custom user roles"],"summary":"List custom user roles","description":"Returns the list of the custom user roles.  \n - The user should have admin role and custom user role right.","operationId":"getRoles","parameters":[{"name":"offset","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":0,"minimum":0}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":20,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponseCustomUserRoleSummaryResponse"},"example":{"values":[{"id":"288c1908-2337-47c0-8a15-9d80fb1256ea","name":"FinanceRole"},{"id":"2c8f2e0b-4784-4276-a3c9-040e8bc299ab","name":"DeveloperRole"},{"id":"33579c31-627c-4cc1-bb94-fd2c214142f7","name":"SRERole"}],"links":{"next":"/v1/roles?offset=20&size=3","last":"/v1/roles?offset=20&size=3"}}}}},"400":{"description":"Returned if an field is not properly set.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"403":{"description":"Returned if the request user does not have permission to get the list of custom user roles.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the role with the identifier cannot be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the requested identifier doesn't belong to custom user role.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"post":{"tags":["Custom user roles"],"summary":"Create custom user role","description":"Creates a new custom user role. \n - The user should have admin role and custom user role right.","operationId":"createCustomRole","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomUserRoleCreateRequest"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomUserRoleSuccessResponse"},"example":{"message":"Created","data":{"id":"b08dc67b-a19d-4d84-925a-eaa9e13a8aa1","name":"FinanceRole"}}}}},"400":{"description":"Returned if an field is not properly set.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"403":{"description":"Returned if the request user does not have permission to create a custom user role.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/users/contacts":{"get":{"tags":["Contacts"],"summary":"List contacts","description":"Returns the list of the contacts of a user.","operationId":"list","parameters":[{"name":"offset","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":0,"minimum":0}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":20,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponseContactWithApplyOrderResponse"},"example":{"values":[{"id":"299003c3-8221-4a9f-b63d-2370c4caaaaa","method":"email","to":"test@example.com","status":{"enabled":true},"applyOrder":0},{"id":"735a619b-e420-4d46-ab5c-45523011aaaa","method":"sms","to":"90-555-555-5555","status":{"enabled":true},"applyOrder":1}],"links":{"next":"url?offset=2&size=1","last":"url?offset=2&size=1"}}}}},"401":{"description":"Returned if the user is not authorized to do the operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"404":{"description":"Returned if the user with the identifier cannot be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if an field is not properly set.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"post":{"tags":["Contacts"],"summary":"Create contact","description":"Creates a new contact for a user.","operationId":"create","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateContactPayload"}}}},"responses":{"201":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactCreateResponse"},"example":{"message":"Created","data":{"id":"35c958bb-ecc3-4cfa-8976-3830daa6231e"}}}}},"401":{"description":"Returned if the user is not authorized to do the operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"404":{"description":"Returned if the user with the identifier cannot be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if an field is not properly set.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/users/contacts/{id}/activate":{"patch":{"tags":["Contacts"],"summary":"Activate contact","description":"Activates a contact of a user.","operationId":"activate","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactSuccessResponse"},"example":{"message":"Activated","data":{"id":"35c958bb-ecc3-4cfa-8976-3830daa6231e"}}}}},"401":{"description":"Returned if the user is not authorized to do the operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"404":{"description":"Returned if the user or contact with the identifier cannot be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if a field is not properly set.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/users/contacts/{id}/deactivate":{"patch":{"tags":["Contacts"],"summary":"Deactivate contact","description":"Deactivates a contact of a user.","operationId":"deactivate","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactSuccessResponse"},"example":{"message":"Deactivated","data":{"id":"35c958bb-ecc3-4cfa-8976-3830daa6231e"}}}}},"401":{"description":"Returned if the user is not authorized to do the operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"404":{"description":"Returned if the user or contact with the identifier cannot be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if a field is not properly set.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/users/contacts/{id}":{"get":{"tags":["Contacts"],"summary":"Get contact","description":"Returns the details of a contact.","operationId":"get","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactResponse"},"example":{"id":"35c958bb-ecc3-4cfa-8976-3830daa6231e","method":"email","to":"test@atlassian.com","status":{"enabled":true}}}}},"401":{"description":"Returned if the user is not authorized to do the operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"404":{"description":"Returned if the user with the identifier cannot be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"delete":{"tags":["Contacts"],"summary":"Delete contact","description":"Delete a contact of a user.","operationId":"delete_1","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful."},"401":{"description":"Returned if the user is not authorized to do the operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"404":{"description":"Returned if the user or contact with the identifier cannot be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if an field is not properly set.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"patch":{"tags":["Contacts"],"summary":"Update contact","description":"Update the details of a contact of a user. This method can be applied only to email contacts.","operationId":"update_1","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateContactPayload"}}}},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactSuccessResponse"},"example":{"message":"Updated","data":{"id":"06ba9237-d45d-40f3-a340-4a89acbdb61a"}}}}},"401":{"description":"Returned if the user is not authorized to do the operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"404":{"description":"Returned if the user or contact with the identifier cannot be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if an field is not properly set.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/integrations":{"get":{"tags":["Integrations"],"summary":"List integrations","description":"Returns all integrations that user can view. <br> <br> **Permissions required:** Permission to access Compass; however, the list contains an integration if: \n - the user has read-only administrative right. \n - the integration's assigned team is one of the teams that the user belongs to.","operationId":"list","parameters":[{"name":"type","in":"query","required":false,"description":"Type of the integration.","schema":{"type":"string"}},{"name":"teamId","in":"query","description":"ID of the team that integration belongs to.","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","required":false,"description":"Name of the integration.","schema":{"type":"string"}},{"name":"offset","in":"query","description":"The index of the first item to return in a page of results.","required":false,"schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","description":"The maximum number of items to return per page.","required":false,"schema":{"type":"integer","format":"int32","default":100}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Integrations"},"example":{"links":{"next":"/v1/integrations?offset=8&size=2","previous":"/v1/integrations?offset=4&size=2"},"values":[{"id":"22334455-1288-414d-b0cc-e725ba3331f7","name":"amazon rds integration - Team B","type":"AmazonRds","enabled":true,"teamId":"8ae8a0a2-1122-5566-8899-11b82bbd85c9"},{"id":"12fa0a15-1288-414d-b0cc-e725ba3331f7","name":"solarwinds integration - team A","type":"SolarwindsMSPNCentral","enabled":false,"teamId":"005564cf-1122-5566-8899-fa8ed200bdf6"}]}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to list integrations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"post":{"tags":["Integrations"],"summary":"Create integration","description":"Creates an integration. It can be team or global integration by using teamId in the payload.\n  \n **Permissions required:** Permission to create an integration:\n - the user has edit configuration right. \n - the user is the admin of the team that the integration belongs to. \n  \n <br>*Slack* and *Microsoft Teams* types of integration are not supported for this operation.","operationId":"create","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIntegrationRequest"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Integration"},"example":{"id":"72719124-9933-5566-8899-33b829756765","name":"Email Integration A","type":"Email","description":"A Sample of Email Integration","enabled":true,"teamId":"8ae8a0a2-1122-5566-8899-11b82bbd85c9","typeSpecificProperties":{"emailUsername":"email-integration-test1","suppressNotifications":false}}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to create integration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/integrations/{integrationId}/actions":{"get":{"tags":["Integration actions"],"summary":"List integration actions","description":"Lists integration actions of an integration that user can view. <br> <br> **Permissions required:** Permission to get the integration action: \n - the user has read-only administrative right. \n - the integration's assigned team is one of the teams that the user belongs to.","operationId":"list_1","parameters":[{"name":"type","description":"Type of the integration action.","in":"query","required":false,"schema":{"type":"string"}},{"name":"direction","description":"Direction of the action. It can be *incoming* or *outgoing*","in":"query","required":false,"schema":{"type":"string"}},{"name":"domain","in":"query","required":false,"description":"Domain of the action. It can be *alert*","schema":{"type":"string"}},{"name":"name","description":"Name of the integration action.","in":"query","required":false,"schema":{"type":"string"}},{"name":"offset","in":"query","required":false,"description":"The index of the first item to return in a page of results.","schema":{"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","description":"The maximum number of items to return per page.","required":false,"schema":{"type":"integer","format":"int32","default":50}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationActions"},"example":{"links":{"next":"/v1/integrations/12fa0a15-4b2f-470c-91ac-2a8cb06a4cc2/actions?offset=1&size=1"},"values":[{"id":"1687265768289000040","name":"postToUrl","type":"postToUrl","direction":"outgoing","domain":"alert","actionMappingType":"create","groupType":"forwarding"}]}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to list integration actions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the integration is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"post":{"tags":["Integration actions"],"summary":"Create integration action","description":"Creates an integration action.<br> <br> **Permissions required:** Permission to create an integration action: \n - the user has read-only administrative right. \n - the user is the admin of the team that the integration belongs to.","operationId":"create_1","parameters":[{"name":"integrationId","in":"path","required":true,"description":"ID of the integration","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIntegrationActionRequest"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationAction"},"example":{"id":"1704982046651000029","type":"create","name":"Create Alert2","domain":"alert","direction":"incoming","filter":{"conditionsEmpty":false,"conditionMatchType":"match-all","conditions":[]},"typeSpecificProperties":{"keepRespondersFromPayload":false,"appendAttachments":true,"keepTagsFromPayload":true,"keepActionsFromPayload":true,"keepExtraPropertiesFromPayload":true},"fieldMappings":{"note":"","description":"{{message}}","source":"Email","message":"{{subject}}","priority":"{{priority}}","responders":[{"type":"team","id":"8ae8a0a2-1122-5566-8899-11b82bbd85c9"}],"tags":[],"alias":"","details":{"From":"{{from_address}}"},"user":"","actions":[],"entity":""}}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to create integration action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the integration is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/integrations/{integrationId}/outgoing/alert-filter/main":{"get":{"tags":["Integration outgoing filters"],"summary":"Get integration alert filter","description":"Returns the outgoing alert filter details of an integration. <br> <br> **Permissions required:** Permission to access to the integration outgoing alert filter: \n - the user has read-only administrative right. \n - the integration's assigned team is one of the teams that the user belongs to.","operationId":"get","parameters":[{"name":"id","description":"ID of the integration.","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationFilter"},"example":{"conditionMatchType":"match-all","conditions":[]}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to get the integration outgoing filter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the integration is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"patch":{"tags":["Integration outgoing filters"],"summary":"Update integration alert filter","description":"Updates Integration outgoing alert filter. <br> <br> **Permissions required:** Permission to update integration alert filter:\n - the user has read-only administrative right. \n - the user is the admin of the team that the integration belongs to.","operationId":"update","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationFilter"},"example":{"conditionMatchType":"match-all","conditions":[]}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationFilter"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to update the integration outgoing filter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the integration is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/integrations/{integrationId}/actions/{id}":{"get":{"tags":["Integration actions"],"summary":"Get integration action","description":"Returns the action of an integration. <br> <br> **Permissions required:** Permission to access to the integration action: \n - the user has read-only administrative right. \n - the integration's assigned team is one of the teams that the user belongs to.","operationId":"get_1","parameters":[{"name":"integrationId","description":"ID of the integration.","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","description":"ID of the integration action.","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationAction"},"example":{"id":"1704982046651000029","type":"create","name":"Create Alert2","domain":"alert","direction":"incoming","filter":{"conditionsEmpty":false,"conditionMatchType":"match-all","conditions":[]},"typeSpecificProperties":{"keepRespondersFromPayload":false,"appendAttachments":true,"keepTagsFromPayload":true,"keepActionsFromPayload":true,"keepExtraPropertiesFromPayload":true},"fieldMappings":{"note":"","description":"{{message}}","source":"Email","message":"{{subject}}","priority":"{{priority}}","responders":[{"type":"team","id":"8ae8a0a2-1122-5566-8899-11b82bbd85c9"}],"tags":[],"alias":"","details":{"From":"{{from_address}}"},"user":"","actions":[],"entity":""}}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to get the integration action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the integration or the integration action is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"delete":{"tags":["Integration actions"],"summary":"Delete integration action","description":"Deletes an integration action. <br> <br> **Permissions required:** Permission to update integration alert filter:\n - the user has read-only administrative right. \n - the user is the admin of the team that the integration belongs to.","operationId":"delete","parameters":[{"name":"integrationId","description":"ID of the integration.","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","description":"ID of the integration action.","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful."},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to delete the integration action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the integration or the integration action is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"patch":{"tags":["Integration actions"],"summary":"Update integration action","description":"Updates an integration action. <br> <br> **Permissions required:** Permission to update the integration action:\n - the user has read-only administrative right. \n - the user is the admin of the team that the integration belongs to.","operationId":"update_1","parameters":[{"name":"integrationId","description":"ID of the integration.","in":"path","required":true,"schema":{"type":"string"}},{"name":"id","description":"ID of the integration action.","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIntegrationActionRequest"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Integration"},"example":{"id":"1704982046651000029","type":"create","name":"Updated action name","domain":"alert","direction":"incoming","filter":{"conditionsEmpty":false,"conditionMatchType":"match-all","conditions":[]},"typeSpecificProperties":{"keepRespondersFromPayload":false,"appendAttachments":true,"keepTagsFromPayload":true,"keepActionsFromPayload":true,"keepExtraPropertiesFromPayload":true},"fieldMappings":{"note":"","description":"{{message}}","source":"Email","message":"{{subject}}","priority":"{{priority}}","responders":[{"type":"team","id":"8ae8a0a2-1122-5566-8899-11b82bbd85c9"}],"tags":[],"alias":"","details":{"From":"{{from_address}}"},"user":"","actions":[],"entity":""}}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to update the integration action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the integration or the integration action is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/integrations/{integrationId}/actions/{id}/order":{"patch":{"tags":["Integration actions"],"summary":"Reorder integration action","description":"Reorders an integration action.  <br> <br> **Permissions required:** Permission to reorder the integration action:\n - the user has read-only administrative right. \n - the user is the admin of the team that the integration belongs to.","operationId":"reorder","parameters":[{"name":"integrationId","in":"path","description":"ID of the integration.","required":true,"schema":{"type":"string"}},{"name":"id","description":"ID of the integration action.","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIntegrationActionOrderRequest"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful."},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to reorder the integration action.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the integration or the integration action is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/integrations/{id}":{"get":{"tags":["Integrations"],"summary":"Get integration","description":"Returns the integration details. <br> <br> **Permissions required:** Permission to access to the integration: \n - the user has read-only administrative right. \n - the integration's assigned team is one of the teams that the user belongs to.","operationId":"get_2","parameters":[{"name":"id","description":"ID of the integration.","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IntegrationResponse"},"example":{"id":"33224455-1122-5566-8899-11b82bbd85c9","type":"Webhook","name":"emelk webhook Sample","enabled":false,"teamId":"8ae8a0a2-1122-5566-8899-11b82bbd85c9","advanced":true,"maintenanceSources":[],"directions":["outgoing"],"domains":["alert"],"typeSpecificProperties":{"addAlertDetails":false,"headers":{},"addAlertDescription":false,"outgoingSettingsEnabled":false,"forwardingActionGroupEnabled":true,"url":""}}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to get the integration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the integration is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"delete":{"tags":["Integrations"],"summary":"Delete integration","description":"Deletes an integration. <br> <br> **Permissions required:** Permission to delete the integration:\n - the user has read-only administrative right. \n - the user is the admin of the team that the integration belongs to.","operationId":"delete_1","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful."},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to delete the integration.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the integration is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"patch":{"tags":["Integrations"],"summary":"Update integration","description":"Updates an integration.  <br> <br> **Permissions required:** Permission to update the integration:\n - the user has read-only administrative right. \n - the user is the admin of the team that the integration belongs to.","operationId":"update_2","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateIntegrationRequest"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Integration"},"example":{"id":"33224455-1122-5566-8899-11b82bbd85c9","type":"Webhook","name":"emelk webhook Sample","enabled":false,"teamId":"8ae8a0a2-1122-5566-8899-11b82bbd85c9","typeSpecificProperties":{"addAlertDetails":false,"headers":{},"addAlertDescription":false,"outgoingSettingsEnabled":false,"forwardingActionGroupEnabled":true,"url":"http://asd.com"}}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to update the integration","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/forwarding-rules":{"get":{"tags":["Forwarding rules"],"summary":"List forwarding rules","description":"Lists the all forwarding rules user can view. It optionally takes three parameters - offset, size and showAll.","operationId":"listForwardings","parameters":[{"name":"showAll","description":"Display all forwardings of the account.","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"offset","description":"The offset parameter controls the starting point within the collection of resource results.","in":"query","required":false,"schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"size","description":"The limit parameter controls the maximum number of items that may be returned for a single request.","in":"query","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForwardingPaginatedResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"402":{"description":"Returned if the customer subscription plan does not cover forwarding rules.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"403":{"description":"Returned if the request user does not have permission to access forwarding rule.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"post":{"tags":["Forwarding rules"],"summary":"Create forwarding rule","description":"Creates a forwarding rule with the given properties.","operationId":"createForwarding","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateForwardingRuleRequest"}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForwardingRuleResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"402":{"description":"Returned if the customer subscription plan does not cover forwarding rule.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"403":{"description":"Returned if the request user does not have permission to create forwarding rule.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if user with the given Id does not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/forwarding-rules/{id}":{"get":{"tags":["Forwarding rules"],"summary":"Get forwarding rule","description":"Gets a forwarding rule with given id in the request.","operationId":"getForwarding","parameters":[{"name":"id","in":"path","description":"Identifier of the forwarding rule.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForwardingRuleResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"402":{"description":"Returned if the customer subscription plan does not cover forwarding rules.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"403":{"description":"Returned if the request user does not have permission to access forwarding rule.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the forwarding rule is not found with given identifier.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"put":{"tags":["Forwarding rules"],"summary":"Update forwarding rule","description":"Updates a forwaring rule with given id in the request.","operationId":"updateForwarding","parameters":[{"name":"id","in":"path","description":"Identifier of the forwarding rule.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateForwardingRuleRequest"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForwardingRuleResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"402":{"description":"Returned if the customer subscription plan does not cover forwarding rule.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"403":{"description":"Returned if the request user does not have permission to update forwarding rule.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the request with given id does not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"delete":{"tags":["Forwarding rules"],"summary":"Delete forwarding rule","description":"Deletes a forwarding rule with given id in the request.","operationId":"deleteForwarding","parameters":[{"name":"id","in":"path","description":"Identifier of the forwarding rule.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful."},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"402":{"description":"Returned if the customer subscription plan does not cover forwarding rules.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"403":{"description":"Returned if the request user does not have permission to delete forwarding rule.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the request with given id does not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/teams/{teamId}/heartbeats":{"get":{"tags":["Heartbeats"],"summary":"List heartbeats","description":"Lists the all heartbeats user can view. If a heartbeatName is passed, it filters out given heartbeat and only return given heartbeat.","operationId":"listHeartbeats","parameters":[{"name":"teamId","in":"path","description":"Identifier of the heartbeat owning team.","required":true,"schema":{"type":"string"}},{"name":"name","in":"query","required":false,"description":"Name of the heartbeat for identification.","schema":{"type":"string","maximum":200}},{"name":"offset","in":"query","required":false,"description":"The offset parameter controls the starting point within the collection of resource results.","schema":{"type":"integer","format":"int64","minimum":0,"default":0}},{"name":"size","in":"query","required":false,"description":"The limit parameter controls the maximum number of items that may be returned for a single request.","schema":{"type":"integer","format":"int64","default":20,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"Returned if the request is successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HeartbeatPaginatedResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"402":{"description":"Returned if the customer subscription plan does not cover heartbeats.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"403":{"description":"Returned if the request user does not have permission to edit heartbeats.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"post":{"tags":["Heartbeats"],"summary":"Create heartbeat","description":"Create heartbeat request is used to define heartbeats in Compass. A heartbeat needs to be added, before sending heartbeat messages to Compass","operationId":"createHeartbeat","parameters":[{"name":"teamId","in":"path","description":"Identifier of the heartbeat owning team.","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateHeartbeatRequest"}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Heartbeat"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"402":{"description":"Returned if the customer subscription plan does not cover heartbeats.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"403":{"description":"Returned if the request user does not have permission to create heartbeat.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"delete":{"tags":["Heartbeats"],"summary":"Delete heartbeat","description":"Deletes the heartbeat with given name in the request.","operationId":"deleteHeartbeat","parameters":[{"name":"teamId","in":"path","description":"Identifier of the heartbeat owning team.","required":true,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Name of the heartbeat for identification.","required":true,"schema":{"type":"string","maximum":200}}],"responses":{"204":{"description":"Returned if the request is successful."},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"402":{"description":"Returned if the customer subscription plan does not cover heartbeats.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"403":{"description":"Returned if the request user does not have permission to delete heartbeat.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"patch":{"tags":["Heartbeats"],"summary":"Update heartbeat","description":"Updates the heartbeat with the given name. Name of a heartbeat cannot be changed","operationId":"updateHeartbeat","parameters":[{"name":"teamId","in":"path","description":"Identifier of the heartbeat owning team.","required":true,"schema":{"type":"string"}},{"name":"name","in":"query","description":"Name of the heartbeat for identification.","required":true,"schema":{"type":"string","maximum":200}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateHeartbeatRequest"}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Heartbeat"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"402":{"description":"Returned if the customer subscription plan does not cover heartbeats.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"403":{"description":"Returned if the request user does not have permission to update heartbeat.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/teams/{teamId}/heartbeats/ping":{"post":{"tags":["Heartbeats"],"summary":"Ping Heartbeat","description":"Pings the heartbeat with given name. Heartbeat ping requests processed asynchronously, it does not check if the heartbeat exists or not before responding. Please note that receiving a PONG response does not necessarily mean that the heartbeat exists.","operationId":"pingHeartbeat","parameters":[{"name":"teamId","in":"path","description":"Identifier of the heartbeat owning team.","required":true,"schema":{"type":"string"}},{"name":"name","in":"query","required":true,"description":"Name of the heartbeat for identification.","schema":{"type":"string","maximum":200}}],"responses":{"202":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SimpleSuccessResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"402":{"description":"Returned if the customer subscription plan does not cover heartbeats.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"403":{"description":"Returned if the request user does not have permission to ping heartbeat.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/notification-rules":{"get":{"tags":["Notification rules"],"summary":"List notification rules","description":"Lists all notification rules for the user. It optionally takes two parameters - offset and size.","operationId":"listNotificationRule","parameters":[{"name":"offset","description":"The offset parameter controls the starting point within the collection of resource results.","in":"query","required":false,"schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"size","description":"The size parameter controls the maximum number of items that may be returned for a single request.","in":"query","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationRulesPaginatedResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"post":{"tags":["Notification rules"],"summary":"Create notification rule","description":"Creates a notification rule with the given properties for the user.","operationId":"createNotificationRule","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationRuleRequest"}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationRuleResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to create notification rule.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/notification-rules/{id}":{"get":{"tags":["Notification rules"],"summary":"Get notification rule","description":"Gets a notification rule with given id in the request.","operationId":"getNotificationRule","parameters":[{"name":"id","description":"Identifier of the notification rule","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationRuleResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"404":{"description":"Returned if the notification rule with given id is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"delete":{"tags":["Notification rules"],"summary":"Delete notification rule","description":"Deletes a notification rule with given id in the request.","operationId":"deleteNotificationRule","parameters":[{"name":"id","description":"Identifier of the notification rule","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful."},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to delete notification rule.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the notification rule with given id is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"patch":{"tags":["Notification rules"],"summary":"Update notification rule","description":"Updates a notification rule with given id in the request.","operationId":"updateNotificationRule","parameters":[{"name":"id","description":"Identifier of the notification rule","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationRuleRequest"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationRuleResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to update notification rule.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the notification rule with given id is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/teams/{teamId}/routing-rules":{"get":{"tags":["Routing rules"],"summary":"List routing rules","description":"Lists all routing rules of given team. It optionally takes two parameters - offset and size.","operationId":"listRoutingRules","parameters":[{"name":"teamId","in":"path","required":true,"description":"Identifier of the routing rules owning team.","schema":{"type":"string"}},{"name":"offset","in":"query","required":false,"description":"The offset parameter controls the starting point within the collection of resource results.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","required":false,"description":"The limit parameter controls the maximum number of items that may be returned for a single request.","schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoutingRulesPaginatedResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the user does not have permission see routing rules.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the routing rule owning team is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"post":{"tags":["Routing rules"],"summary":"Create routing rule","description":"Creates a routing rule with the given properties.","operationId":"createRoutingRule","parameters":[{"name":"teamId","in":"path","required":true,"description":"Identifier of the routing rules owning team.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRoutingRuleRequest"}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoutingRuleResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the user does not have permission see routing rules.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/teams/{teamId}/routing-rules/{id}":{"get":{"tags":["Routing rules"],"summary":"Get routing rule","description":"Gets a routing rule with given id in the request.","operationId":"getRoutingRule","parameters":[{"name":"teamId","in":"path","required":true,"description":"Identifier of the routing rules owning team.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the routing rule.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoutingRuleResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the user does not have permission see routing rule.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if routing rule owning team or routing rule are not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"delete":{"tags":["Routing rules"],"summary":"Delete routing rule","description":"Deletes a routing rule with given id in the request.","operationId":"deleteRoutingRule","parameters":[{"name":"teamId","in":"path","required":true,"description":"Identifier of the routing rules owning team.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the routing rule.","schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful."},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the user does not have permission delete routing rule.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if routing rule owning team or routing rule are not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"patch":{"tags":["Routing rules"],"summary":"Update routing rule","description":"Updates a routing rule with given id in the request.","operationId":"updateRoutingRule","parameters":[{"name":"teamId","in":"path","required":true,"description":"Identifier of the routing rules owning team.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the routing rule.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateRoutingRuleRequest"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoutingRuleResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the user does not have permission to update routing rules.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if routing rule owning team or routing rule are not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/teams/{teamId}/routing-rules/{id}/change-order":{"patch":{"tags":["Routing rules"],"summary":"Change routing rule order","description":"Changes routing rule's order with given id in the request.","operationId":"changeRoutingRuleOrder","parameters":[{"name":"teamId","in":"path","required":true,"description":"Identifier of the routing rules owning team.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the routing rule.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RoutingRuleChangeOrderRequest"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful."},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the user does not have permission change routing rules' order.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/alerts/requests/{id}":{"get":{"tags":["Alerts"],"summary":"Get request status","description":"Alert creation, deletion, and action requests are processed asynchronously to provide higher availability and scalability. This endpoint is used to track the status and alert details (if any) of the request whose identifier is given.","operationId":"getRequestStatus","parameters":[{"name":"id","in":"path","description":"Identifier of the questioned request. Please note that ID of the request was provided within response.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRequestStatusResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"404":{"description":"Returned if the request is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/alerts":{"get":{"tags":["Alerts"],"summary":"List alerts","description":"This endpoint is designed to provide a comprehensive view of all alerts in your system. This API supports pagination and filtering with allowing you to customize the view based on your specific needs. More than 20000 alerts cannot be retrieved. Sum of offset and size should be lower than 20K.","operationId":"listAlerts","parameters":[{"name":"size","in":"query","required":false,"description":"Maximum number of items to provide in the result.","schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":20}},{"name":"sort","in":"query","required":false,"description":"Name of the field that result set will be sorted by.","schema":{"type":"string","default":"insertedAt","enum":["createdAt","insertedAt","lastOccurredAt","priority"]}},{"name":"offset","in":"query","required":false,"description":"The offset parameter controls the starting point within the collection of resource results.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"order","in":"query","required":false,"description":"Sorting order of the result set.","schema":{"type":"string","default":"desc","enum":["asc","desc"]}},{"name":"query","in":"query","required":false,"description":"This parameter is used to filter the alerts based on specified criteria.\nIt accepts a string value that represents the search query.\nThis parameter provides a powerful way to retrieve alerts that meet certain\nconditions or contain specific information. You can refer \n[Alerts Search Query Help](https://operations-help.atlassian.net/wiki/spaces/OPSHELP/pages/8028374/Search+syntax+for+alerts) \nfor further information about search queries.","schema":{"type":"string"}},{"name":"from","in":"query","required":false,"description":"The starting date-time to consider while filtering the alerts.\nIt helps in narrowing down the list of alerts to a specific time frame.","schema":{"type":"integer","format":"int32"}},{"name":"to","in":"query","required":false,"description":"The ending date-time to consider while filtering the alerts. \nUsed in conjunction with 'from', it defines the specific time window to \nfocus on for the alert listing.","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAlertResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"post":{"tags":["Alerts"],"summary":"Create alert","description":"The endpoint allows users to programmatically generate alerts with customized parameters. It integrates with existing systems to transform raw data into actionable alerts, ensuring timely notifications for incident management.","operationId":"createAlert","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAlertRequest"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to create alert.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/alerts/{id}":{"get":{"tags":["Alerts"],"summary":"Get alert","description":"This endpoint provides users the ability to retrieve comprehensive details of a specific alert using its unique id.","operationId":"getAlertWithId","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the alert.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the alert is not visirequest user does not have read-only permission for alerts.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the alert is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"delete":{"tags":["Alerts"],"summary":"Delete alert","description":"This endpoint is utilized to delete alerts, along with the unique identifier of the alert.","operationId":"deleteAlert","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the alert.","schema":{"type":"string"}}],"responses":{"202":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to delete an alert.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/alerts/{id}/acknowledge":{"post":{"tags":["Alerts"],"operationId":"ackAlert","summary":"Acknowledge alert","description":"This endpoint is used to acknowledge an existing alert. Acknowledging an alert indicates that it has been received and is being acted upon, preventing duplicate efforts and coordinating response actions.","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the alert.","schema":{"type":"string"}}],"responses":{"202":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/alerts/{id}/assign":{"post":{"tags":["Alerts"],"operationId":"assignAlert","summary":"Assign alert","description":"This endpoint is used to assign an existing alert to a user or a group. Assigning an alert ensures that responsibility for addressing the alert is clearly established, promoting efficient alert management and quicker resolution times. It is a crucial operation for coordinating incident response efforts effectively.","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the alert.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignAlertRequest"}}},"required":true},"responses":{"202":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/alerts/{id}/responders":{"post":{"tags":["Alerts"],"operationId":"addResponder","summary":"Add responder to alert","description":"This endpoint is used to assign a responder to an existing alert. The responder is the individual or team responsible for addressing the alert. This operation streamlines the alert management process by ensuring that alerts are directed to the correct parties for timely resolution.","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the alert.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddResponderRequest"}}},"required":true},"responses":{"202":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/alerts/{id}/extra-properties":{"post":{"tags":["Alerts"],"summary":"Add extra properties to alert","description":"This endpoint is used to enrich existing alerts with additional information to provide more detailed context.","operationId":"addExtraPropertyToAlert","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the alert.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddExtraPropertiesRequest"}}},"required":true},"responses":{"202":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"delete":{"tags":["Alerts"],"summary":"Delete extra properties from alert","description":"This endpoint is used to delete the multiple extra properties.","operationId":"deleteExtraPropertyFromAlert","parameters":[{"name":"alertId","in":"path","required":true,"description":"Identifier of the alert.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteExtraPropertiesRequest"}}},"required":true},"responses":{"202":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/alerts/{id}/tags":{"post":{"tags":["Alerts"],"operationId":"addTags","summary":"Add tags to alert","description":"This endpoint is used to add tags to an existing alert. Tags provide a means to categorize and manage alerts more effectively, enabling quick identification and sorting of related alerts based on the assigned tags.","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the alert.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertTagsRequest"}}},"required":true},"responses":{"202":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"delete":{"tags":["Alerts"],"operationId":"deleteTags","summary":"Delete tags from alert","description":"This endpoint is used to remove tags from an existing alert. This operation allows for the modification of alert categorization and can aid in the management process by enabling alerts to be unlinked from certain categories or groups, as represented by their tags.","parameters":[{"name":"alertId","in":"path","required":true,"description":"Identifier of the alert.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertTagsRequest"}}},"required":true},"responses":{"202":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to update an alert.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/alerts/{id}/close":{"post":{"tags":["Alerts"],"operationId":"closeAlert","summary":"Close alert","description":"This endpoint is used to close an existing alert. Closing an alert indicates that the issue has been resolved and no further action is necessary. This operation is essential for maintaining an accurate overview of the operational status and for ensuring that only active, unresolved issues remain open.","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the alert.","schema":{"type":"string"}}],"responses":{"202":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/alerts/{id}/escalate":{"post":{"tags":["Alerts"],"operationId":"escalateAlert","summary":"Escalate alert to next","description":"This endpoint is used to escalate an existing alert. Escalation triggers the defined escalation policies which could involve notifying additional users or teams, or increasing the frequency of notifications for the alert. This operation is particularly useful in situations where an alert requires urgent attention or has not been addressed within a certain timeframe according to the pre-set escalation paths.","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the alert.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EscalateToNextRequest"}}},"required":true},"responses":{"202":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/alerts/{id}/action":{"post":{"tags":["Alerts"],"operationId":"executeAlertAction","summary":"Execute custom action","description":"This endpoint is used to execute custom actions on an existing alert. Custom actions allow for more flexible and specific responses to alerts, including integrations with external systems or triggering complex workflows. This operation is a powerful tool for extending the capabilities of the alert management process beyond predefined actions.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExecuteCustomActionRequest"}}},"required":true},"responses":{"202":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/alerts/{id}/snooze":{"post":{"tags":["Alerts"],"operationId":"snoozeAlert","summary":"Snooze alert","description":"This endpoint is used to snooze an existing alert. The snooze operation temporarily silences the alert, preventing it from triggering notifications for a specified period. This is particularly useful for managing alerts that require attention at a later time or to reduce noise from non-critical alerts.","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the alert.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertSnoozeRequest"}}},"required":true},"responses":{"202":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/alerts/{id}/unacknowledge":{"post":{"summary":"Unacknowledge alert","tags":["Alerts"],"operationId":"unackAlert","description":"This endpoint is used to set the 'acknowledged' property of an existing alert as 'false', effectively marking it's status as 'open'. This allows for better tracking and management of alerts by indicating that an alert has not yet been acknowledged or addressed.","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the alert.","schema":{"type":"string"}}],"responses":{"202":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/alerts/{id}/notes":{"get":{"tags":["Alerts"],"operationId":"getAlertNotes","description":"This endpoint is used to retrieve a list of notes for a specified alert. Notes provide additional information or context about an alert, helping to enhance the understanding and management of alerts.","summary":"List alert notes","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the alert.","schema":{"type":"string"}},{"name":"after","in":"query","required":false,"description":"This parameter is used in pagination for the alert notes.\nIt accepts a string key of the last record from the previous page.\nThe system will return the next page of notes that come after this specified key.\nThis is useful for fetching subsequent segments of data when there are more notes than the size specified.","schema":{"type":"string"}},{"name":"size","in":"query","required":false,"description":"This parameter is used to limit the number of alert notes returned by the system.\nIt accepts an integer that specifies the maximum number of notes to be retrieved.","schema":{"type":"integer","format":"int32","minimum":1,"maximum":100,"default":20}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAlertNotesResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to update an alert.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the alert is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"post":{"tags":["Alerts"],"operationId":"addAlertNote","description":"This endpoint is used to add a note to an existing alert.","summary":"Add alert note","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the alert.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoteRequest"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertNote"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to update an alert.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the alert is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/alerts/{alertId}/notes/{id}":{"patch":{"tags":["Alerts"],"operationId":"updateAlertNote","description":"This endpoint is used to update a note associated with a specific alert.","summary":"Update alert note","parameters":[{"name":"alertId","in":"path","required":true,"description":"Identifier of the alert.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the note.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoteRequest"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertNote"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to update an alert.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the alert is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"delete":{"tags":["Alerts"],"operationId":"deleteAlertNote","description":"This endpoint is used to delete a note from an existing alert.","summary":"Delete alert note","parameters":[{"name":"alertId","in":"path","required":true,"description":"Identifier of the alert.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"Identifier of the note.","schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the request is successful."},"403":{"description":"Returned if the request user does not have permission to update an alert.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the Alert note does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/alerts/{id}/priority":{"patch":{"tags":["Alerts"],"summary":"Update alert priority","description":"This endpoint is used to modify the priority level of an existing alert. This endpoint allows for dynamic control over alert urgency. This aids in effective incident management by ensuring the most critical issues are addressed first.","operationId":"updateAlertPriority","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the alert.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAlertPriorityRequest"}}},"required":true},"responses":{"202":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/alerts/{id}/message":{"patch":{"tags":["Alerts"],"summary":"Update alert message","description":"This endpoint is used to update the message of an existing alert. This endpoint plays a crucial role in ensuring that alert messages remain accurate and up-to-date, aiding in the effective management and resolution of incidents.","operationId":"updateAlertMessage","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the alert.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAlertMessageRequest"}}},"required":true},"responses":{"202":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/alerts/{id}/description":{"patch":{"tags":["Alerts"],"summary":"Update alert description","description":"This endpoint is used to update the description of an existing alert. This endpoint plays a crucial role in ensuring that team members have the most current details for incident response.","operationId":"updateAlertDescription","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the alert.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAlertDescriptionRequest"}}},"required":true},"responses":{"202":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/alerts/{id}/logs":{"get":{"tags":["Alerts"],"summary":"List alert logs","description":"This endpoint is used to retrieve a paginated list of alert logs which provides users to obtain a comprehensive record of alert activities. This includes alert creation, acknowledgment, assignment, and closure details. This endpoint is crucial for audit purposes, incident reviews, and enhancing the overall incident management process by providing complete visibility into alert history.","operationId":"getAlertLogs","parameters":[{"name":"id","in":"path","required":true,"description":"Identifier of the alert.","schema":{"type":"string"}},{"name":"after","in":"query","required":false,"description":"This parameter is used in pagination for the alert logs retrieved\nby the system. It accepts a string key of the last record from the previous\npage. The system will return the next page of logs that come after this\nspecified key. This is useful for fetching subsequent segments of data\nwhen there are more logs than the limit specified.","schema":{"type":"string"}},{"name":"size","in":"query","required":false,"description":"This parameter is used to limit the number of alert logs returned\nby the system. It accepts an integer that specifies the maximum number\nof logs to be retrieved.","schema":{"type":"integer","format":"int32","default":20,"minimum":1,"maximum":100}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertLogsResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have read-only permission for alerts.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if the alert is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/syncs":{"get":{"tags":["Syncs"],"summary":"List syncs","description":"Lists syncs according to the provided filters.\n- The user should have view permission for syncs.","operationId":"list","parameters":[{"name":"type","in":"query","description":"Type of the sync. (For instance, \\\"jira-software-cloud\\\" for Jira Software Cloud Sync.)","required":false,"schema":{"type":"string","description":"Type of the sync. (For instance, \\\"jira-software-cloud\\\" for Jira Software Cloud Sync.)"}},{"name":"teamId","in":"query","description":"Id of the team that the syncs belongs to.","required":false,"schema":{"type":"string","description":"Id of the team that the syncs belongs to."}},{"name":"offset","in":"query","description":"The offset parameter controls the starting point within the collection of resource results.","required":false,"schema":{"type":"string","description":"The offset parameter controls the starting point within the collection of resource results."}},{"name":"size","in":"query","description":"The limit parameter controls the maximum number of items that may be returned for a single request.","required":false,"schema":{"type":"string","description":"The limit parameter controls the maximum number of items that may be returned for a single request."}}],"responses":{"200":{"description":"Returned if the request is successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Syncs"},"example":{"links":{"next":"/v1/syncs?offset=8&size=2","previous":"/v1/syncs?offset=4&size=2"},"values":[{"id":"22334455-1288-414d-b0cc-e725ba3331f7","name":"Jira Example","type":"jira-software-cloud","enabled":true,"teamId":"8ae8a0a2-1122-5566-8899-11b82bbd85c9"},{"id":"12fa0a15-1288-414d-b0cc-e725ba3331f7","name":"JSM Example","type":"jira-service-management-cloud","enabled":false,"teamId":"005564cf-1122-5566-8899-fa8ed200bdf6"}]}}}},"401":{"description":"Returned if the authentication credentials are incorrect","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to view the sync or operation is not allowed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload is not validated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"post":{"tags":["Syncs"],"summary":"Create sync","description":"Creates a sync for syncing alerts created and issues in a selected project. \n- The user should have sync creation permission.","operationId":"createSync","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSyncDto"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncMetadata"},"example":{"id":"12fa0a15-1288-414d-b0cc-e725ba3331f7","name":"JSM Example","type":"jira-service-management-cloud","enabled":true,"teamId":"005564cf-1122-5566-8899-fa8ed200bdf6"}}}},"401":{"description":"Returned if the authentication credentials are incorrect","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to create the sync or operation is not allowed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload is not validated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/syncs/{id}":{"get":{"tags":["Syncs"],"summary":"Get sync","description":"Returns the sync.","operationId":"getSync","parameters":[{"name":"id","in":"path","description":"Id of the sync.","required":true,"schema":{"type":"string","description":"Id of the sync."}}],"responses":{"200":{"description":"Returned if the request is successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Sync"},"example":{"id":"12fa0a15-1288-414d-b0cc-e725ba3331f7","name":"JSM Example","type":"jira-service-management-cloud","description":"A Sample of JSM Sync","enabled":true,"typeSpecificProperties":{"connectionId":"dfd0441e-c86b-4011-bd54-7b6717f45b61","projectKey":"JE","forwardingActionGroupEnabled":false,"updatingActionGroupEnabled":true,"suppressNotifications":false}}}}},"401":{"description":"Returned if the authentication credentials are incorrect","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to view the sync or operation is not allowed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if sync is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload is not validated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"delete":{"tags":["Syncs"],"summary":"Delete sync","description":"Deletes a sync. \n- The user should have delete permission for sync.","operationId":"deleteSync","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful"},"401":{"description":"Returned if the authentication credentials are incorrect","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to delete the sync or operation is not allowed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if sync is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload is not validated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"patch":{"tags":["Syncs"],"summary":"Update sync","description":"Updates a sync. \n- The user should have edit permission for sync.","operationId":"updateSync","parameters":[{"name":"id","in":"path","description":"Id of the sync.","required":true,"schema":{"type":"string","description":"Id of the sync."}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSyncDto"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncMetadata"},"example":{"id":"12fa0a15-1288-414d-b0cc-e725ba3331f7","name":"JSM Example","type":"jira-service-management-cloud","enabled":true,"teamId":"005564cf-1122-5566-8899-fa8ed200bdf6"}}}},"401":{"description":"Returned if the authentication credentials are incorrect","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to edit the sync or operation is not allowed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload is not validated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/syncs/{syncId}/actions":{"get":{"tags":["Sync actions"],"summary":"List sync actions","description":"Lists sync actions of a sync","operationId":"list_1","parameters":[{"name":"type","in":"query","description":"Type of the action.","required":false,"schema":{"type":"string","description":"Type of the action."}},{"name":"direction","in":"query","description":"Direction of the action.","required":false,"schema":{"type":"string","description":"Direction of the action."}},{"name":"groupId","in":"query","description":"Id of the action group that the action belongs to.","required":false,"schema":{"type":"string","description":"Id of the action group that the action belongs to."}},{"name":"name","in":"query","description":"Name of the action.","required":false,"schema":{"type":"string","description":"Name of the action."}},{"name":"offset","in":"query","description":"The offset parameter controls the starting point within the collection of resource results.","required":false,"schema":{"type":"string","description":"The offset parameter controls the starting point within the collection of resource results."}},{"name":"size","in":"query","description":"The limit parameter controls the maximum number of items that may be returned for a single request.","required":false,"schema":{"type":"string","description":"The limit parameter controls the maximum number of items that may be returned for a single request."}}],"responses":{"200":{"description":"Returned if the request is successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncActions"},"example":{"links":{"next":"/v1/integrations/12fa0a15-1288-414d-b0cc-e725ba3331f7/actions?offset=1&size=1"},"values":[{"id":"2da91c9a-0d77-42fd-bb83-41e2849c0538","name":"Create Alert","type":"create","direction":"incoming","order":2.1779103,"enabled":true,"actionGroupId":""},{"id":"f28e8e7f-b944-41ff-bc6f-ea5d24d55569","name":"Create Issue","type":"createIssue","direction":"outgoing","order":3.1779103,"enabled":true,"actionGroupId":"9fb515a9-a902-444a-aa77-ff8b942cd250"}]}}}},"401":{"description":"Returned if the authentication credentials are incorrect","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to view the sync or operation is not allowed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if sync or sync is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload is not validated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"post":{"tags":["Sync actions"],"summary":"Create sync action","description":"Creates a sync action","operationId":"create","parameters":[{"name":"syncId","in":"path","description":"Id of the sync.","required":true,"schema":{"type":"string","description":"Id of the sync."}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSyncActionRequest"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncAction"},"examples":{"incoming":{"value":{"id":"2da91c9a-0d77-42fd-bb83-41e2849c0538","name":"Create Alert","type":"create","direction":"incoming","order":2.1779103,"enabled":true,"filter":{"conditionMatchType":"match-all-conditions","conditions":[{"order":0,"field":"eventType","expectedValue":"issue_created","not":false,"operation":"equals","systemCondition":false}]},"fieldMappings":{"alias":"{{key}}","description":"{{description}}","source":"","message":"{{summary}}","priority":"{{priority}}","note":"","responders":[{"type":"team","id":"8ae8a0a2-1122-5566-8899-11b82bbd85c9"}],"tags":["{{labels}}"],"details":{"issueKey":"{{key}}","priority":"{{priority}}","status":"{{status}}"},"user":"Jira","actions":[],"entity":""},"typeSpecificProperties":{}}},"outgoing":{"value":{"id":"597f3162-4d33-4ecc-ae99-f70fc06b86f6","name":"Comment Issue","type":"commentIssue","enabled":true,"order":3.1722643,"direction":"outgoing","actionGroupId":"f9447ae4-5138-4cee-983c-a0b4f1492963","actionMapping":{"type":"close"},"filter":{"conditionsEmpty":false,"conditionMatchType":"match-all","conditions":null}}}}}}},"401":{"description":"Returned if the authentication credentials are incorrect","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to create the sync or operation is not allowed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if sync is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload is not validated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/syncs/{syncId}/actions/{id}":{"get":{"tags":["Sync actions"],"summary":"Get sync action","description":"Gets a sync action. ","operationId":"get","parameters":[{"name":"syncId","in":"path","description":"Id of the sync.","required":true,"schema":{"type":"string","description":"Id of the sync."}},{"name":"id","in":"path","description":"Id of the sync action.","required":true,"schema":{"type":"string","description":"Id of the sync action."}}],"responses":{"200":{"description":"Returned if the request is successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncAction"},"examples":{"incoming":{"value":{"id":"2da91c9a-0d77-42fd-bb83-41e2849c0538","name":"Create Alert","type":"create","direction":"incoming","order":2.1779103,"enabled":true,"filter":{"conditionMatchType":"match-all-conditions","conditions":[{"order":0,"field":"eventType","expectedValue":"issue_created","not":false,"operation":"equals","systemCondition":false}]},"fieldMappings":{"alias":"{{key}}","description":"{{description}}","source":"","message":"{{summary}}","priority":"{{priority}}","note":"","responders":[{"type":"team","id":"8ae8a0a2-1122-5566-8899-11b82bbd85c9"}],"tags":["{{labels}}"],"details":{"issueKey":"{{key}}","priority":"{{priority}}","status":"{{status}}"},"user":"Jira","actions":[],"entity":""},"typeSpecificProperties":{}}},"outgoing":{"value":{"id":"597f3162-4d33-4ecc-ae99-f70fc06b86f6","name":"Comment Issue","type":"commentIssue","enabled":true,"order":3.1722643,"direction":"outgoing","actionGroupId":"f9447ae4-5138-4cee-983c-a0b4f1492963","actionMapping":{"type":"close"},"filter":{"conditionsEmpty":false,"conditionMatchType":"match-all","conditions":null}}}}}}},"401":{"description":"Returned if the authentication credentials are incorrect","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to view the sync or operation is not allowed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if sync or sync action is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload is not validated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"delete":{"tags":["Sync actions"],"summary":"Delete sync action","description":"Deletes a sync action.","operationId":"delete","parameters":[{"name":"syncId","in":"path","description":"Id of the sync.","required":true,"schema":{"type":"string","description":"Id of the sync."}},{"name":"id","in":"path","description":"Id of the sync action.","required":true,"schema":{"type":"string","description":"Id of the sync action."}}],"responses":{"200":{"description":"Returned if the request is successful"},"401":{"description":"Returned if the authentication credentials are incorrect","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to delete the sync or operation is not allowed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if sync or sync action is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload is not validated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"patch":{"tags":["Sync actions"],"summary":"Update sync action","description":"Updates a sync action.","operationId":"update","parameters":[{"name":"syncId","in":"path","description":"Id of the sync.","required":true,"schema":{"type":"string","description":"Id of the sync."}},{"name":"id","in":"path","description":"Id of the sync action.","required":true,"schema":{"type":"string","description":"Id of the sync action."}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSyncActionRequest"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncAction"},"examples":{"incoming":{"value":{"id":"2da91c9a-0d77-42fd-bb83-41e2849c0538","name":"Create Alert","type":"create","direction":"incoming","order":2.1779103,"enabled":true,"filter":{"conditionMatchType":"match-all-conditions","conditions":[{"order":0,"field":"eventType","expectedValue":"issue_created","not":false,"operation":"equals","systemCondition":false}]},"fieldMappings":{"alias":"{{key}}","description":"{{description}}","source":"","message":"{{summary}}","priority":"{{priority}}","note":"","responders":[{"type":"team","id":"8ae8a0a2-1122-5566-8899-11b82bbd85c9"}],"tags":["{{labels}}"],"details":{"issueKey":"{{key}}","priority":"{{priority}}","status":"{{status}}"},"user":"Jira","actions":[],"entity":""},"typeSpecificProperties":{}}},"outgoing":{"value":{"id":"597f3162-4d33-4ecc-ae99-f70fc06b86f6","name":"Comment Issue","type":"commentIssue","enabled":true,"order":3.1722643,"direction":"outgoing","actionGroupId":"f9447ae4-5138-4cee-983c-a0b4f1492963","actionMapping":{"type":"close"},"filter":{"conditionsEmpty":false,"conditionMatchType":"match-all","conditions":null}}}}}}},"401":{"description":"Returned if the authentication credentials are incorrect","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to edit the sync or operation is not allowed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if sync or sync action is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload is not validated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/syncs/{syncId}/actions/{id}/order":{"patch":{"tags":["Sync actions"],"summary":"Reorder sync action","description":"Reorders a sync action. ","operationId":"reorder","parameters":[{"name":"syncId","in":"path","description":"Id of the sync.","required":true,"schema":{"type":"string","description":"Id of the sync."}},{"name":"id","in":"path","description":"Id of the sync action.","required":true,"schema":{"type":"string","description":"Id of the sync action."}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSyncActionOrderRequest"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful"},"401":{"description":"Returned if the authentication credentials are incorrect","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to edit the sync or operation is not allowed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if sync or sync action is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload is not validated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/syncs/{syncId}/action-groups":{"get":{"tags":["Sync action groups"],"summary":"List sync action groups","description":"Lists sync action groups of a sync","operationId":"list_2","parameters":[{"name":"syncId","in":"path","description":"Id of the sync","required":true,"schema":{"type":"string","description":"Id of the sync"}},{"name":"type","in":"query","description":"Type of the action group.","required":false,"schema":{"type":"string","description":"Type of the action group."}}],"responses":{"200":{"description":"Returned if the request is successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncActions"},"example":[{"id":"9fb515a9-a902-444a-aa77-ff8b942cd250","type":"forwarding","name":"Create alert","order":2.2864804,"enabled":false},{"id":"f9447ae4-5138-4cee-983c-a0b4f1492963","type":"updating","name":"alert updating rules","order":1,"enabled":true}]}}},"401":{"description":"Returned if the authentication credentials are incorrect","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to view the sync or operation is not allowed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if sync or sync is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload is not validated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"post":{"tags":["Sync action groups"],"summary":"Create sync action group","description":"Creates a sync action group","operationId":"create_1","parameters":[{"name":"syncId","in":"path","description":"Id of the sync","required":true,"schema":{"type":"string","description":"Id of the sync"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateActionGroupDto"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncActionGroupMetadataDto"},"examples":{"updating":{"value":{"id":"f9447ae4-5138-4cee-983c-a0b4f1492963","type":"updating","name":"alert updating rules","order":1,"enabled":true,"updateActions":[{"id":"95c5fe2d-dad9-470e-a9af-e7fcdb692058","name":"Comment Issue","type":"commentIssue","enabled":true,"order":2.1411576,"direction":"outgoing","actionGroupId":"f9447ae4-5138-4cee-983c-a0b4f1492963","actionMapping":{"type":"acknowledge"},"filter":{"conditionsEmpty":false,"conditionMatchType":"match-all","conditions":[]},"fieldMappings":{},"typeSpecificProperties":{}},{"id":"597f3162-4d33-4ecc-ae99-f70fc06b86f6","name":"Comment Issue","type":"commentIssue","enabled":true,"order":3.1722643,"direction":"outgoing","actionGroupId":"f9447ae4-5138-4cee-983c-a0b4f1492963","actionMapping":{"type":"close"},"filter":{"conditionsEmpty":false,"conditionMatchType":"match-all","conditions":[]},"fieldMappings":{},"typeSpecificProperties":{}}]}},"forwarding":{"value":{"id":"9fb515a9-a902-444a-aa77-ff8b942cd250","type":"forwarding","name":"Create alert","order":2.2864804,"enabled":false,"rootAction":{"id":"f28e8e7f-b944-41ff-bc6f-ea5d24d55569","name":"Create alert_createIssue","type":"createIssue","enabled":false,"order":9.283745,"direction":"outgoing","actionGroupId":"9fb515a9-a902-444a-aa77-ff8b942cd250","actionMapping":{"type":"create"},"filter":{"conditionsEmpty":false,"conditionMatchType":"match-all","conditions":[]},"fieldMappings":{"summary":"{{message}}","description":"{{description}}","priority":"3","duedate":"2024-02-07"},"typeSpecificProperties":{"issueType":"10027"}},"updateActions":[{"id":"0f6add6c-7ee6-4da9-9804-ff751075f180","name":"Create alert_commentIssue","type":"commentIssue","enabled":true,"order":10.644114,"direction":"outgoing","actionGroupId":"9fb515a9-a902-444a-aa77-ff8b942cd250","actionMapping":{"type":"acknowledge"},"filter":{"conditionsEmpty":true,"conditionMatchType":"match-all-conditions","conditions":[]},"fieldMappings":{},"typeSpecificProperties":{}}]}}}}}},"401":{"description":"Returned if the authentication credentials are incorrect","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to create the sync or operation is not allowed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if sync is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload is not validated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/syncs/{syncId}/action-groups/{id}":{"get":{"tags":["Sync action groups"],"summary":"Get sync action group","description":"Gets a sync action group. ","operationId":"get_1","parameters":[{"name":"syncId","in":"path","description":"Id of the sync","required":true,"schema":{"type":"string","description":"Id of the sync"}},{"name":"actionGroupId","in":"path","description":"Id of the action group","required":true,"schema":{"type":"string","description":"Id of the action group"}}],"responses":{"200":{"description":"Returned if the request is successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncActionGroup"},"examples":{"updating":{"value":{"id":"f9447ae4-5138-4cee-983c-a0b4f1492963","type":"updating","name":"alert updating rules","order":1,"enabled":true,"updateActions":[{"id":"95c5fe2d-dad9-470e-a9af-e7fcdb692058","name":"Comment Issue","type":"commentIssue","enabled":true,"order":2.1411576,"direction":"outgoing","actionGroupId":"f9447ae4-5138-4cee-983c-a0b4f1492963","actionMapping":{"type":"acknowledge"},"filter":{"conditionsEmpty":false,"conditionMatchType":"match-all","conditions":[]},"fieldMappings":{},"typeSpecificProperties":{}},{"id":"597f3162-4d33-4ecc-ae99-f70fc06b86f6","name":"Comment Issue","type":"commentIssue","enabled":true,"order":3.1722643,"direction":"outgoing","actionGroupId":"f9447ae4-5138-4cee-983c-a0b4f1492963","actionMapping":{"type":"close"},"filter":{"conditionsEmpty":false,"conditionMatchType":"match-all","conditions":[]},"fieldMappings":{},"typeSpecificProperties":{}}]}},"forwarding":{"value":{"id":"9fb515a9-a902-444a-aa77-ff8b942cd250","type":"forwarding","name":"Create alert","order":2.2864804,"enabled":false,"rootAction":{"id":"f28e8e7f-b944-41ff-bc6f-ea5d24d55569","name":"Create alert_createIssue","type":"createIssue","enabled":false,"order":9.283745,"direction":"outgoing","actionGroupId":"9fb515a9-a902-444a-aa77-ff8b942cd250","actionMapping":{"type":"create"},"filter":{"conditionsEmpty":false,"conditionMatchType":"match-all","conditions":[]},"fieldMappings":{"summary":"{{message}}","description":"{{description}}","priority":"3","duedate":"2024-02-07"},"typeSpecificProperties":{"issueType":"10027"}},"updateActions":[{"id":"0f6add6c-7ee6-4da9-9804-ff751075f180","name":"Create alert_commentIssue","type":"commentIssue","enabled":true,"order":10.644114,"direction":"outgoing","actionGroupId":"9fb515a9-a902-444a-aa77-ff8b942cd250","actionMapping":{"type":"acknowledge"},"filter":{"conditionsEmpty":true,"conditionMatchType":"match-all-conditions","conditions":[]},"fieldMappings":{},"typeSpecificProperties":{}}]}}}}}},"401":{"description":"Returned if the authentication credentials are incorrect","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to view the sync or operation is not allowed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if sync or sync action group is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload is not validated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"delete":{"tags":["Sync action groups"],"summary":"Delete sync action group","description":"Deletes a sync action group.","operationId":"delete_1","parameters":[{"name":"syncId","in":"path","description":"Id of the sync","required":true,"schema":{"type":"string","description":"Id of the sync"}},{"name":"id","in":"path","description":"Id of the action group","required":true,"schema":{"type":"string","description":"Id of the action group"}}],"responses":{"200":{"description":"Returned if the request is successful"},"401":{"description":"Returned if the authentication credentials are incorrect","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to delete the sync or operation is not allowed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if sync or sync action group is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload is not validated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"patch":{"tags":["Sync action groups"],"summary":"Update sync action group","description":"Updates a sync action group.","operationId":"update_1","parameters":[{"name":"syncId","in":"path","description":"Id of the sync","required":true,"schema":{"type":"string","description":"Id of the sync"}},{"name":"id","in":"path","description":"Id of the action group","required":true,"schema":{"type":"string","description":"Id of the action group"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateActionGroupDto"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SyncAction"},"examples":{"updating":{"value":{"id":"f9447ae4-5138-4cee-983c-a0b4f1492963","type":"updating","name":"alert updating rules","order":1,"enabled":true,"updateActions":[{"id":"95c5fe2d-dad9-470e-a9af-e7fcdb692058","name":"Comment Issue","type":"commentIssue","enabled":true,"order":2.1411576,"direction":"outgoing","actionGroupId":"f9447ae4-5138-4cee-983c-a0b4f1492963","actionMapping":{"type":"acknowledge"},"filter":{"conditionsEmpty":false,"conditionMatchType":"match-all","conditions":[]},"fieldMappings":{},"typeSpecificProperties":{}},{"id":"597f3162-4d33-4ecc-ae99-f70fc06b86f6","name":"Comment Issue","type":"commentIssue","enabled":true,"order":3.1722643,"direction":"outgoing","actionGroupId":"f9447ae4-5138-4cee-983c-a0b4f1492963","actionMapping":{"type":"close"},"filter":{"conditionsEmpty":false,"conditionMatchType":"match-all","conditions":[]},"fieldMappings":{},"typeSpecificProperties":{}}]}},"forwarding":{"value":{"id":"9fb515a9-a902-444a-aa77-ff8b942cd250","type":"forwarding","name":"Create alert","order":2.2864804,"enabled":false,"rootAction":{"id":"f28e8e7f-b944-41ff-bc6f-ea5d24d55569","name":"Create alert_createIssue","type":"createIssue","enabled":false,"order":9.283745,"direction":"outgoing","actionGroupId":"9fb515a9-a902-444a-aa77-ff8b942cd250","actionMapping":{"type":"create"},"filter":{"conditionsEmpty":false,"conditionMatchType":"match-all","conditions":[]},"fieldMappings":{"summary":"{{message}}","description":"{{description}}","priority":"3","duedate":"2024-02-07"},"typeSpecificProperties":{"issueType":"10027"}},"updateActions":[{"id":"0f6add6c-7ee6-4da9-9804-ff751075f180","name":"Create alert_commentIssue","type":"commentIssue","enabled":true,"order":10.644114,"direction":"outgoing","actionGroupId":"9fb515a9-a902-444a-aa77-ff8b942cd250","actionMapping":{"type":"acknowledge"},"filter":{"conditionsEmpty":true,"conditionMatchType":"match-all-conditions","conditions":[]},"fieldMappings":{},"typeSpecificProperties":{}}]}}}}}},"401":{"description":"Returned if the authentication credentials are incorrect","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to edit the sync or operation is not allowed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if sync or sync action group is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload is not validated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/syncs/{syncId}/action-groups/{id}/order":{"patch":{"tags":["Sync action groups"],"summary":"Reorder sync action group","description":"Reorders a sync action group. ","operationId":"reorder_1","parameters":[{"name":"syncId","in":"path","description":"Id of the sync","required":true,"schema":{"type":"string","description":"Id of the sync"}},{"name":"id","in":"path","description":"Id of the action group","required":true,"schema":{"type":"string","description":"Id of the action group"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSyncActionGroupOrderRequest"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful"},"401":{"description":"Returned if the authentication credentials are incorrect","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"403":{"description":"Returned if the request user does not have permission to edit the sync or operation is not allowed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"404":{"description":"Returned if sync or sync action group is not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload is not validated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/alerts/policies":{"get":{"tags":["Policies"],"summary":"List global alert policies","description":"List global alert policies","operationId":"listGlobalPolicies","parameters":[{"name":"offset","in":"query","description":"The offset parameter controls the starting point within the collection of resource results.","required":false,"schema":{"minimum":0,"type":"integer","format":"int32","default":0}},{"name":"size","in":"query","description":"The limit parameter controls the maximum number of items that may be returned for a single request.","required":false,"schema":{"maximum":100,"minimum":1,"type":"integer","format":"int32","default":20}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalPolicyPaginatedResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"404":{"description":"Returned if the maintenance is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"post":{"tags":["Policies"],"summary":"Create global alert policy","description":"Create global alert policy","operationId":"createGlobalPolicy","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGlobalPolicyRequest"}}},"required":true},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GlobalPolicyPaginatedResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"404":{"description":"Returned if the maintenance is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/alerts/policies/{policyId}":{"get":{"tags":["Policies"],"summary":"Get global alert policy","description":"Get global alert policy","operationId":"getGlobalPolicies","parameters":[{"name":"policyId","in":"path","required":true,"description":"Identifier of the policy.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetGlobalAlertPolicy"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"404":{"description":"Returned if the policy is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"put":{"tags":["Policies"],"summary":"Put global alert policy","description":"Put global alert policy","operationId":"putGlobalPolicies","parameters":[{"name":"policyId","in":"path","required":true,"description":"Identifier of the policy.","schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGlobalPolicyRequest"}}}},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetGlobalAlertPolicy"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"404":{"description":"Returned if the policy is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"delete":{"tags":["Policies"],"summary":"Delete global alert policy","description":"Delete global alert policy","operationId":"deleteGlobalPolicies","parameters":[{"name":"policyId","in":"path","required":true,"description":"Identifier of the policy.","schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the policy is deleted successfully."},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"404":{"description":"Returned if the policy is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/alerts/policies/{policyId}/change-order":{"post":{"tags":["Policies"],"summary":"Change the order of global alert policy","description":"Change the order of global alert policy","operationId":"createGlobalPolicy","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangePolicyOrderRequest"}}},"required":true},"responses":{"204":{"description":"Returned if the policy is deleted successfully."},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"404":{"description":"Returned if the maintenance is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/alerts/policies/{policyId}/enable":{"post":{"tags":["Policies"],"summary":"Enable the global alert policy","description":"Enable the global alert policy","operationId":"enableGlobalPolicy","parameters":[{"name":"policyId","in":"path","required":true,"description":"Identifier of the policy.","schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetGlobalAlertPolicy"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"404":{"description":"Returned if the maintenance is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/alerts/policies/{policyId}/disable":{"post":{"parameters":[{"name":"policyId","in":"path","required":true,"description":"Identifier of the policy.","schema":{"type":"string"}}],"tags":["Policies"],"summary":"Disable the global alert policy","description":"Disable the global alert policy","operationId":"disableGlobalPolicy","responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetGlobalAlertPolicy"}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"404":{"description":"Returned if the maintenance is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/teams/{teamId}/policies":{"get":{"tags":["Team Policies"],"summary":"List team policies","description":"List team policies","operationId":"listTeamPolicies","parameters":[{"name":"teamId","in":"path","description":"The team identifier","required":true,"schema":{"type":"string"}},{"name":"type","in":"query","description":"The type of policy. alert or notification ","required":true,"schema":{"type":"string","enum":["notification","alert"]}},{"name":"size","in":"query","description":"The limit parameter controls the maximum number of items that may be returned for a single request.","required":false,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":50,"default":25}},{"name":"offset","in":"query","required":false,"description":"The offset parameter controls the starting point within the collection of resource results.","schema":{"minimum":0,"type":"integer","format":"int32","default":0}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/TeamNotificationPolicyPaginatedResponse"},{"$ref":"#/components/schemas/TeamAlertPolicyPaginatedResponse"}]}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"404":{"description":"Returned if the maintenance is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"post":{"tags":["Team Policies"],"summary":"Create team policy","description":"Create team policy","operationId":"putTeamPolicies","parameters":[{"name":"policyId","in":"path","required":true,"description":"Identifier of the policy.","schema":{"type":"string"}},{"name":"teamId","in":"path","description":"The team identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/TeamAlertPolicyDto"},{"$ref":"#/components/schemas/TeamNotificationPolicyDto"}]}}}},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/TeamAlertPolicyDto"},{"$ref":"#/components/schemas/TeamNotificationPolicyDto"}]}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"404":{"description":"Returned if the policy is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/teams/{teamId}/policies/{policyId}":{"get":{"tags":["Team Policies"],"summary":"Get team policy","description":"Get team policy","operationId":"getTeamPolicies","parameters":[{"name":"policyId","in":"path","required":true,"description":"Identifier of the policy.","schema":{"type":"string"}},{"name":"teamId","in":"path","description":"The team identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/TeamAlertPolicyDto"},{"$ref":"#/components/schemas/TeamNotificationPolicyDto"}]}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"404":{"description":"Returned if the policy is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"put":{"tags":["Team Policies"],"summary":"Put team policy","description":"Put team policy","operationId":"putTeamPolicies","parameters":[{"name":"policyId","in":"path","required":true,"description":"Identifier of the policy.","schema":{"type":"string"}},{"name":"teamId","in":"path","description":"The team identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/TeamAlertPolicyDto"},{"$ref":"#/components/schemas/TeamNotificationPolicyDto"}]}}}},"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/TeamAlertPolicyDto"},{"$ref":"#/components/schemas/TeamNotificationPolicyDto"}]}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"404":{"description":"Returned if the policy is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true},"delete":{"tags":["Team Policies"],"summary":"Delete global alert policy","description":"Delete global alert policy","operationId":"deleteGlobalPolicies","parameters":[{"name":"policyId","in":"path","required":true,"description":"Identifier of the policy.","schema":{"type":"string"}},{"name":"teamId","in":"path","description":"The team identifier","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the policy is deleted successfully."},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"404":{"description":"Returned if the policy is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/teams/{teamId}/policies/{policyId}/change-order":{"post":{"tags":["Team Policies"],"summary":"Change the order of team policy","description":"Change the order of team policy","operationId":"createGlobalPolicy","parameters":[{"name":"policyId","in":"path","required":true,"description":"Identifier of the policy.","schema":{"type":"string"}},{"name":"teamId","in":"path","description":"The team identifier","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangePolicyOrderRequest"}}},"required":true},"responses":{"204":{"description":"Returned if the policy is deleted successfully."},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"404":{"description":"Returned if the maintenance is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/teams/{teamId}/policies/{policyId}/enable":{"post":{"tags":["Team Policies"],"summary":"Enable the team policy","description":"Enable the team policy","operationId":"enableGlobalPolicy","parameters":[{"name":"policyId","in":"path","required":true,"description":"Identifier of the policy.","schema":{"type":"string"}},{"name":"teamId","in":"path","description":"The team identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/TeamAlertPolicyDto"},{"$ref":"#/components/schemas/TeamNotificationPolicyDto"}]}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"404":{"description":"Returned if the maintenance is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}},"/v1/teams/{teamId}/policies/{policyId}/disable":{"post":{"parameters":[{"name":"policyId","in":"path","required":true,"description":"Identifier of the policy.","schema":{"type":"string"}},{"name":"teamId","in":"path","description":"The team identifier","required":true,"schema":{"type":"string"}}],"tags":["Team Policies"],"summary":"Disable the global alert policy","description":"Disable the global alert policy","operationId":"disableGlobalPolicy","responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/TeamAlertPolicyDto"},{"$ref":"#/components/schemas/TeamNotificationPolicyDto"}]}}}},"401":{"description":"Returned if the authentication credentials are incorrect.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErrorResponse"}}}},"404":{"description":"Returned if the maintenance is not found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}},"422":{"description":"Returned if the payload cannot be validated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponses"}}}}},"security":[{"basicAuth":[]}],"x-experimental":true}}}}