Created
February 4, 2025 21:18
-
-
Save xmonkee/5affeea0cbc15b36ffaabf387283a863 to your computer and use it in GitHub Desktop.
This file has been truncated, but you can view the full file.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "openapi": "3.0.0", | |
| "info": { | |
| "version": "1.1.0", | |
| "title": "Zenduty", | |
| "termsOfService": "https://zenduty.com", | |
| "contact": { | |
| "email": "[email protected]" | |
| }, | |
| "license": { | |
| "name": "Apache 2.0" | |
| }, | |
| "x-logo": { | |
| "url": "data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAxOS4wLjAsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT4NCjxzdmcgdmVyc2lvbj0iMS4xIiBpZD0iTGF5ZXJfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgeD0iMHB4IiB5PSIwcHgiDQoJIHZpZXdCb3g9Ii05OC4zIDE3My43IDIwNi4zIDUzLjIiIHN0eWxlPSJlbmFibGUtYmFja2dyb3VuZDpuZXcgLTk4LjMgMTczLjcgMjA2LjMgNTMuMjsiIHhtbDpzcGFjZT0icHJlc2VydmUiPg0KPHN0eWxlIHR5cGU9InRleHQvY3NzIj4NCgkuc3Qwe2ZpbGw6IzBGMTcyQTt9DQoJLnN0MXtmaWxsOiNGRDlBMDA7fQ0KPC9zdHlsZT4NCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik0tMjksMjEwLjJoNi4zYzIuNywwLDQuOSwyLjIsNC45LDQuOWgtMTguMWMwLTUuMyw0LjEtOS40LDcuOS0xMy4xbDMuOC0zLjdoLTcuMWMtMi41LDAtNC42LTIuMS00LjYtNC42aDE4DQoJYzAsNS4zLTQuMSw5LjQtNy44LDEzLjJMLTI5LDIxMC4yeiIvPg0KPHBhdGggY2xhc3M9InN0MCIgZD0iTTMuNywyMDUuOGgtMTUuNWMwLjEsMS41LDAuNiwyLjcsMS42LDMuNmMwLjksMC45LDIuMSwxLjIsMy41LDEuMmMyLDAsMy40LTAuOSw0LjMtMi41aDUuOA0KCWMtMC42LDItMS44LDMuNi0zLjUsNC45Yy0xLjgsMS4yLTMuOSwyLTYuNCwyYy0yLDAtMy45LTAuNS01LjUtMS40Yy0xLjYtMC45LTIuOS0yLjEtMy44LTMuN2MtMC45LTEuNi0xLjQtMy40LTEuNC01LjcNCgljMC0yLjEsMC41LTQuMSwxLjQtNS43YzAuOS0xLjYsMi4xLTIuOCwzLjgtMy43YzEuNi0wLjksMy40LTEuNCw1LjUtMS40YzIsMCwzLjgsMC40LDUuNCwxLjJjMS42LDAuOSwyLjgsMi4xLDMuNywzLjYNCgljMC45LDEuNiwxLjMsMy4zLDEuMyw1LjRDMy44LDIwNC42LDMuOCwyMDUuMiwzLjcsMjA1Ljh6IE0tMS43LDIwMi4yYzAtMS40LTAuNS0yLjUtMS41LTMuMmMtMS0wLjktMi4xLTEuMi0zLjUtMS4yDQoJYy0xLjQsMC0yLjQsMC40LTMuNCwxLjJjLTAuOSwwLjctMS41LDEuOC0xLjYsMy4zaDEwLjFWMjAyLjJ6Ii8+DQo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNMjcuOSwxOTguNGMwLjktMS42LDItMi45LDMuNS0zLjhjMS41LTAuOSwzLjEtMS40LDQuOS0xLjRjMS40LDAsMi42LDAuMywzLjksMC45YzEuMywwLjYsMi4zLDEuNCwzLDIuNHYtMTYuNw0KCWg1LjR2MzVoLTUuNHYtMy4xYy0wLjYsMS0xLjYsMS45LTIuOCwyLjVjLTEuMywwLjYtMi42LDEtNC4yLDFjLTEuOCwwLTMuNC0wLjUtNC45LTEuNGMtMS41LTAuOS0yLjYtMi4zLTMuNS0zLjkNCgljLTAuOS0xLjYtMS4zLTMuNS0xLjMtNS44QzI2LjYsMjAyLDI3LDIwMCwyNy45LDE5OC40eiBNNDIuNSwyMDAuOWMtMC41LTAuOS0xLjMtMS42LTItMi4xYy0wLjktMC41LTEuOC0wLjgtMi44LTAuOA0KCWMtMSwwLTEuOSwwLjMtMi44LDAuOGMtMC45LDAuNS0xLjUsMS4xLTIsMi4xYy0wLjUsMC45LTAuOCwyLTAuOCwzLjNjMCwxLjMsMC4zLDIuNCwwLjgsMy40YzAuNSwxLDEuMywxLjYsMiwyLjENCgljMC45LDAuNSwxLjgsMC44LDIuOCwwLjhjMSwwLDEuOS0wLjMsMi44LTAuOGMwLjktMC41LDEuNS0xLjMsMi0yLjFjMC41LTAuOSwwLjgtMiwwLjgtMy40UzQzLDIwMS44LDQyLjUsMjAwLjl6Ii8+DQo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNMjUuNCwyMDQuM3YxMC42aC01di0xMC42YzAtMi0wLjUtMy41LTEuNS00LjVjLTEtMS4xLTIuMS0xLjYtMy41LTEuNnMtMi41LDAuNS0zLjUsMS42DQoJYy0wLjksMS0xLjQsMi42LTEuNCw0LjV2MTAuNkg1LjV2LTEwLjZjMC0yLjEsMC41LTQsMS4zLTUuN2MwLjktMS42LDItMi45LDMuNS0zLjhzMy4xLTEuNCw1LTEuNHMzLjUsMC41LDUsMS40DQoJYzEuNSwwLjksMi42LDIuMSwzLjUsMy44QzI0LjksMjAwLjMsMjUuNCwyMDIuMiwyNS40LDIwNC4zeiIvPg0KPHBhdGggY2xhc3M9InN0MCIgZD0iTTUxLjMsMjA0LjF2LTEwLjRoNXYxMC40YzAsMiwwLjUsMy41LDEuNSw0LjVjMSwxLjEsMi4xLDEuNiwzLjUsMS42YzEuNCwwLDIuNS0wLjUsMy41LTEuNg0KCWMwLjktMSwxLjQtMi42LDEuNC00LjV2LTEwLjRoNC45djEwLjRjMCwyLjEtMC41LDQtMS4zLDUuN2MtMC45LDEuNi0yLDIuOS0zLjUsMy44Yy0xLjUsMC45LTMuMSwxLjQtNSwxLjRzLTMuNS0wLjUtNS0xLjQNCgljLTEuNS0wLjktMi42LTIuMS0zLjUtMy44QzUxLjcsMjA4LjEsNTEuMywyMDYuMiw1MS4zLDIwNC4xeiIvPg0KPHBhdGggY2xhc3M9InN0MCIgZD0iTTgwLjcsMTk4djEwLjJjMCwwLjgsMC4xLDEuMywwLjUsMS41YzAuNCwwLjQsMC45LDAuNSwxLjgsMC41aDIuNXY0LjVoLTMuNGMtNC41LDAtNi44LTIuMS02LjgtNi41VjE5OGgtNS4xDQoJdi00LjRoNS4xdi04LjdoNS40djguN2g0LjhsMi42LDQuNEg4MC43eiIvPg0KPHBhdGggY2xhc3M9InN0MCIgZD0iTTEwNy40LDE5My42bC04LjcsMjAuNmwtNSwxMS44aC01LjdsNS4xLTExLjhsLTguNC0yMC42aDZsNS40LDE0LjdsNS41LTE0LjdIMTA3LjR6Ii8+DQo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNLTY2LjksMTg5LjJjLTEuOSwwLTQuNy0yLjEtNC43LTQuOHYtMy42YzAtMi43LDAuOC00LjgsNC43LTQuOGMzLjksMCw0LjcsMi4xLDQuNyw0Ljh2My42DQoJQy02Mi4yLDE4Ny4xLTY1LDE4OS4yLTY2LjksMTg5LjJ6Ii8+DQo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNLTM3LjcsMjIzaC0yMS41bDMuOC0xMS40bDAuNy0xLjhjNC4yLDEuNywxMy4xLDcuMiwxNy43LDExLjZDLTM2LjQsMjIyLjEtMzYuOCwyMjMtMzcuNywyMjN6Ii8+DQo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNLTU3LjMsMTkyLjlsLTE1LjksMTAuNGMtNC4yLTIuNS05LjItNS45LTEyLjItOC44Yy0wLjYtMC42LTAuMi0xLjUsMC43LTEuNUgtNTcuM3oiLz4NCjxwYXRoIGNsYXNzPSJzdDEiIGQ9Ik0tNDguNiwxOTQuM2wtNiwxNS42bC0wLjcsMS44bC0zLjgsMTEuNEgtOTZjLTAuOCwwLTEuMy0wLjktMC44LTEuNWMwLjktMS4yLDEuOC0yLjMsMi43LTMuMw0KCWMyLjEtMi4yLDQuNC00LjEsNi45LTUuOGwwLjEtMC4xYzAuOC0wLjYsMS42LTEuMSwyLjQtMS42bDExLjQtNy40bDE1LjktMTAuNGg3LjdDLTQ4LjgsMTkyLjktNDguNCwxOTMuNi00OC42LDE5NC4zeiIvPg0KPC9zdmc+DQo=" | |
| }, | |
| "description": "# Introduction\n\nZenduty is a cutting edge platform for incident management. With high level automation, Zenduty enables faster and better incident resolution keeping developers first.\n\n\n Javascript Libraries: https://github.com/Zenduty/zenduty-js\n\n Ruby Libraries: https://github.com/Zenduty/zenduty-ruby\n\n Python Libraries: https://github.com/Zenduty/zenduty-python-sdk\n\n Postman Collection for Zenduty API: https://github.com/Zenduty/zenduty-api-postman.git\n\n Account-level roles and permissions: https://docs.zenduty.com/docs/users#account-level-roles-and-permissions\n\n Team-level roles and permissions: https://docs.zenduty.com/docs/users#team-level-roles-and-permissions\n" | |
| }, | |
| "tags": [ | |
| { | |
| "name": "Account Member", | |
| "description": "This object represents a user of the account. Each account member object has a role, which can be owner, admin, or user. Each account has a single owner, but the admins and users can be multiple." | |
| }, | |
| { | |
| "name": "Account Custom Role", | |
| "description": "This object represents a custom role of the account. Each custom role object has custom permissions, which the account admin can set from account level permissions and assign this custom role to a particular user." | |
| }, | |
| { | |
| "name": "User Custom Role", | |
| "description": "This object represents a user's custom role. Each user can be assigned to only one custom role." | |
| }, | |
| { | |
| "name": "Notification Rules", | |
| "description": "This object represents a user's notification rules. A user can have notification rules for high urgency and low urgency incidents." | |
| }, | |
| { | |
| "name": "Forwarding Rules", | |
| "description": "This object represents a user's forwarding rules. A user can forward his notifications to the other account members in case an incident occurs." | |
| }, | |
| { | |
| "name": "Contact Methods", | |
| "description": "This object represents one of the following communication channels(Email, SMS, Phone Call, Slack, Microsoft Team, Google Chat). A user can add multiple contacts methods." | |
| }, | |
| { | |
| "name": "Teams", | |
| "description": "This object represents a team of the account. It lets you create different independent operational units in the account. You can check out the team docs here https://docs.zenduty.com/docs/teams." | |
| }, | |
| { | |
| "name": "Team Members", | |
| "description": "This object represents the users of a team. Each team member has a role which can be a manager or a user. You can checkout the team member docs here https://docs.zenduty.com/docs/users" | |
| }, | |
| { | |
| "name": "Team Permissions", | |
| "description": "This object represents the permissions of a team. It lets you access the particular team elements that the team has given permissions to use." | |
| }, | |
| { | |
| "name": "Schedules", | |
| "description": "This object represents the schedule of a team. You can checkout the schedule docs here https://docs.zenduty.com/docs/schedules" | |
| }, | |
| { | |
| "name": "Schedule Overrides", | |
| "description": "This object represents the Override of a Schedule. You can checkout the Schedule Override docs here https://docs.zenduty.com/docs/schedules/#schedule-override" | |
| }, | |
| { | |
| "name": "Escalation Policies", | |
| "description": "This object represents the escalation policy of a team. You can checkout the escalation policy docs here https://docs.zenduty.com/docs/escalationpolicies" | |
| }, | |
| { | |
| "name": "Services", | |
| "description": "This object represents the services associated with a team. You can checkout the services docs here https://docs.zenduty.com/docs/services" | |
| }, | |
| { | |
| "name": "Integrations", | |
| "description": "This object represents the integrations associated with a service. You can checkout the integration docs here https://docs.zenduty.com/docs/integrations" | |
| }, | |
| { | |
| "name": "Integration Alerts", | |
| "description": "This object represents the integration alerts of an integration" | |
| }, | |
| { | |
| "name": "Incidents", | |
| "description": "This object represents the incidents of the account. You can checkout the incident docs here https://docs.zenduty.com/docs/incidents" | |
| }, | |
| { | |
| "name": "Incidents (Deprecated)", | |
| "description": "These endpoints are deprecated and will no longer receive maintenance. Please use the [new endpoints](#tag/Incidents), which utilize the Incident ID." | |
| }, | |
| { | |
| "name": "Incident Roles", | |
| "description": "This object represents the incident roles of an incident. You can checkout the incident role docs here https://docs.zenduty.com/docs/incidentroles" | |
| }, | |
| { | |
| "name": "Incident Notes", | |
| "description": "This object represents the incident notes of an incident." | |
| }, | |
| { | |
| "name": "Incident Tags", | |
| "description": "This object represents the incident tags of an incident." | |
| }, | |
| { | |
| "name": "Incident Responders", | |
| "description": "This object represents the incident responders of an incident." | |
| }, | |
| { | |
| "name": "Events", | |
| "description": "This object represents the events of an integration." | |
| }, | |
| { | |
| "name": "Incident Alerts", | |
| "description": "This object represents the incident alerts of an incident." | |
| }, | |
| { | |
| "name": "Tags", | |
| "description": "This object represents the tags of an incident. You can checkout the tag docs here https://docs.zenduty.com/docs/incidenttags" | |
| }, | |
| { | |
| "name": "Task Templates", | |
| "description": "This object represents the task templates of the team. You can checkout the task template docs here https://docs.zenduty.com/docs/tasktemplates" | |
| }, | |
| { | |
| "name": "Priorities", | |
| "description": "This object represents the priority of an incident. You can checkout the priority docs here https://docs.zenduty.com/docs/incidentpriority" | |
| }, | |
| { | |
| "name": "SLA", | |
| "description": "This object represents the SLA of an incident. You can checkout the SLA docs here https://docs.zenduty.com/docs/incidentsla" | |
| }, | |
| { | |
| "name": "Team Maintenance Mode", | |
| "description": "This object represents the maintenance mode of a team. You can checkout the team maintenance mode docs here https://docs.zenduty.com/docs/maintenancewindows" | |
| }, | |
| { | |
| "name": "Postmortem", | |
| "description": "This object represents the postmortem of an incident. You can checkout the postmortem docs here https://docs.zenduty.com/docs/incidentpostmortem" | |
| }, | |
| { | |
| "name": "OnCall", | |
| "description": "This object represents the user who is oncall." | |
| }, | |
| { | |
| "name": "Global Router", | |
| "description": "This object represents the Global Router of the Account. You can checkout the global alert routing docs here https://docs.zenduty.com/docs/globalalertrouting" | |
| }, | |
| { | |
| "name": "Global Router Rules", | |
| "description": "The Rules of the Global Router in an Account are represented by this object. Visit this link to view the documentation for the global alert routing rules https://docs.zenduty.com/docs/globalalertrouting" | |
| }, | |
| { | |
| "name": "Alert Rules", | |
| "description": "Alert Rules in Zenduty are advanced conditions for incoming alerts. They dictate how Zenduty handles alerts and their incidents upon receipt, altering behavior and routing based on predefined rules and actions set by the user within Zenduty Integrations.Visit this link to view the documentation for the alert rules https://www.zenduty.com/docs/alertrules/" | |
| } | |
| ], | |
| "servers": [ | |
| { | |
| "url": "https://www.zenduty.com" | |
| } | |
| ], | |
| "security": [ | |
| { | |
| "bearerAuth": [ ] | |
| } | |
| ], | |
| "paths": { | |
| "/api/account/api_invite/": { | |
| "post": { | |
| "tags": [ | |
| "Account Member" | |
| ], | |
| "summary": "Invite User", | |
| "description": "Returns an Account Member object.", | |
| "requestBody": { | |
| "description": "Request body parameters to create the Account Member object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/InviteUserPayload" | |
| }, | |
| "example": { | |
| "team": "db61f7ed-ba78-4536-9b2d-256b135a731d", | |
| "user_detail": { | |
| "first_name": "Michael", | |
| "last_name": "Scott", | |
| "email": "[email protected]", | |
| "role": 3 | |
| } | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/InviteUserPayload" | |
| }, | |
| "example": { | |
| "team": "db61f7ed-ba78-4536-9b2d-256b135a731d", | |
| "user_detail": { | |
| "first_name": "Michael", | |
| "last_name": "Scott", | |
| "email": "[email protected]", | |
| "role": 3 | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TeamMember" | |
| }, | |
| "example": { | |
| "unique_id": "e6931b6d-55d7-45e4-9f30-4dbf72bbcf06", | |
| "team": "db61f7ed-ba78-4536-9b2d-256b135a731d", | |
| "user": { | |
| "username": "39f4dedd-2754-4ee1-9c0c-1", | |
| "first_name": "Michael", | |
| "last_name": "Scott", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-09-20T14:29:05.997454Z", | |
| "role": 2 | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TeamMember" | |
| }, | |
| "example": { | |
| "unique_id": "e6931b6d-55d7-45e4-9f30-4dbf72bbcf06", | |
| "team": "db61f7ed-ba78-4536-9b2d-256b135a731d", | |
| "user": { | |
| "username": "39f4dedd-2754-4ee1-9c0c-1", | |
| "first_name": "Michael", | |
| "last_name": "Scott", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-09-20T14:29:05.997454Z", | |
| "role": 2 | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/members/": { | |
| "get": { | |
| "tags": [ | |
| "Account Member" | |
| ], | |
| "summary": "List all Account Member objects", | |
| "description": "Returns a list of Account Member objects. The Account Member objects are sorted by joining_date, with the most recent Account Member object appearing last.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AccountMember" | |
| }, | |
| "example": [ | |
| { | |
| "unique_id": "96f437aa-ae86-46cc-a01a-b2ede620d25a", | |
| "time_zone": "UTC", | |
| "user": { | |
| "username": "216bba3d-7268-4a8e-89e9-6", | |
| "first_name": "Anshul", | |
| "last_name": "Rajput", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T10:28:36.804578Z", | |
| "role": 1, | |
| "is_verified": false | |
| }, | |
| { | |
| "unique_id": "49868e5e-aa68-471b-82e2-10b6238f42f6", | |
| "time_zone": "UTC", | |
| "user": { | |
| "username": "507dfda0-a1fd-40e5-943a-e", | |
| "first_name": "Mary", | |
| "last_name": "Jane", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T10:31:56.830785Z", | |
| "role": 3, | |
| "is_verified": false | |
| }, | |
| { | |
| "unique_id": "ab188a19-7f5c-4f6f-b7cd-d1bfa0725dcd", | |
| "time_zone": "UTC", | |
| "user": { | |
| "username": "85b563c8-18d0-4668-9462-9", | |
| "first_name": "Vishwa", | |
| "last_name": "Krishnakumar", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T10:32:42.191552Z", | |
| "role": 2, | |
| "is_verified": false | |
| } | |
| ] | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AccountMember" | |
| }, | |
| "example": [ | |
| { | |
| "unique_id": "96f437aa-ae86-46cc-a01a-b2ede620d25a", | |
| "time_zone": "UTC", | |
| "user": { | |
| "username": "216bba3d-7268-4a8e-89e9-6", | |
| "first_name": "Anshul", | |
| "last_name": "Rajput", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T10:28:36.804578Z", | |
| "role": 1, | |
| "is_verified": false | |
| }, | |
| { | |
| "unique_id": "49868e5e-aa68-471b-82e2-10b6238f42f6", | |
| "time_zone": "UTC", | |
| "user": { | |
| "username": "507dfda0-a1fd-40e5-943a-e", | |
| "first_name": "Mary", | |
| "last_name": "Jane", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T10:31:56.830785Z", | |
| "role": 3, | |
| "is_verified": false | |
| }, | |
| { | |
| "unique_id": "ab188a19-7f5c-4f6f-b7cd-d1bfa0725dcd", | |
| "time_zone": "UTC", | |
| "user": { | |
| "username": "85b563c8-18d0-4668-9462-9", | |
| "first_name": "Vishwa", | |
| "last_name": "Krishnakumar", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T10:32:42.191552Z", | |
| "role": 2, | |
| "is_verified": false | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/members/{username}/": { | |
| "parameters": [ | |
| { | |
| "name": "username", | |
| "in": "path", | |
| "schema": { | |
| "type": "string", | |
| "description": "A system-generated string that represents the User object's username" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "get": { | |
| "tags": [ | |
| "Account Member" | |
| ], | |
| "summary": "Retrieve the Account Member object", | |
| "description": "Retrieve the specified Account Member object.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AccountMember" | |
| }, | |
| "example": { | |
| "unique_id": "ab188a19-7f5c-4f6f-b7cd-d1bfa0725dcd", | |
| "time_zone": "UTC", | |
| "user": { | |
| "username": "85b563c8-18d0-4668-9462-9", | |
| "first_name": "Vishwa", | |
| "last_name": "Krishnakumar", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T10:32:42.191552Z", | |
| "role": 2, | |
| "is_verified": false | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AccountMember" | |
| }, | |
| "example": { | |
| "unique_id": "ab188a19-7f5c-4f6f-b7cd-d1bfa0725dcd", | |
| "time_zone": "UTC", | |
| "user": { | |
| "username": "85b563c8-18d0-4668-9462-9", | |
| "first_name": "Vishwa", | |
| "last_name": "Krishnakumar", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T10:32:42.191552Z", | |
| "role": 2, | |
| "is_verified": false | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": [ | |
| "Account Member" | |
| ], | |
| "summary": "Update the Account Member object", | |
| "description": "Updates the specified Account Member object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.", | |
| "requestBody": { | |
| "description": "Request body parameters to update the Account Member object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AccountMemberPayload" | |
| }, | |
| "example": { | |
| "user": { | |
| "username": "507dfda0-a1fd-40e5-943a-e", | |
| "first_name": "Mary", | |
| "last_name": "Jane" | |
| }, | |
| "role": 2 | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AccountMemberPayload" | |
| }, | |
| "example": { | |
| "user": { | |
| "username": "507dfda0-a1fd-40e5-943a-e", | |
| "first_name": "Mary", | |
| "last_name": "Jane" | |
| }, | |
| "role": 2 | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AccountMember" | |
| }, | |
| "example": { | |
| "unique_id": "49868e5e-aa68-471b-82e2-10b6238f42f6", | |
| "time_zone": "UTC", | |
| "user": { | |
| "username": "507dfda0-a1fd-40e5-943a-e", | |
| "first_name": "Mary", | |
| "last_name": "Jane", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T10:31:56.830785Z", | |
| "role": 2, | |
| "is_verified": false | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AccountMember" | |
| }, | |
| "example": { | |
| "unique_id": "49868e5e-aa68-471b-82e2-10b6238f42f6", | |
| "time_zone": "UTC", | |
| "user": { | |
| "username": "507dfda0-a1fd-40e5-943a-e", | |
| "first_name": "Mary", | |
| "last_name": "Jane", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T10:31:56.830785Z", | |
| "role": 2, | |
| "is_verified": false | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/deleteuser/": { | |
| "post": { | |
| "tags": [ | |
| "Account Member" | |
| ], | |
| "summary": "Delete User", | |
| "description": "Delete the specified Account Member object", | |
| "requestBody": { | |
| "description": "Request body parameters to create the Account Member object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DeleteUserPayload" | |
| }, | |
| "example": { | |
| "username": "6b2af4db-8b31-4bfb-9742-4" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/DeleteUserPayload" | |
| }, | |
| "example": { | |
| "username": "6b2af4db-8b31-4bfb-9742-4" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "204": { | |
| "description": "Success" | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/customroles/": { | |
| "post": { | |
| "tags": [ | |
| "Account Custom Role" | |
| ], | |
| "summary": "Create the Account Custom Role object", | |
| "description": "Create the Account Custom Role object by setting the values of all the required parameters passed in the request body.", | |
| "requestBody": { | |
| "description": "Request body parameters to create the Account Custom Role object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AccountCustomRolePayload" | |
| }, | |
| "example": { | |
| "name": "Role 1", | |
| "description": "Role 1 Description", | |
| "permissions": [ | |
| "sla_read" | |
| ] | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AccountCustomRolePayload" | |
| }, | |
| "example": { | |
| "name": "Role 1", | |
| "description": "Role 1 Description", | |
| "permissions": [ | |
| "sla_read" | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AccountCustomRolePostAndPutResponse" | |
| }, | |
| "example": { | |
| "unique_id": "97208d3e-e45d-409a-b951-4eae928a59b9", | |
| "name": "Role 1", | |
| "description": "Role 1 Description" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AccountCustomRolePostAndPutResponse" | |
| }, | |
| "example": { | |
| "unique_id": "97208d3e-e45d-409a-b951-4eae928a59b9", | |
| "name": "Role 1", | |
| "description": "Role 1 Description" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "get": { | |
| "tags": [ | |
| "Account Custom Role" | |
| ], | |
| "summary": "List all Account Custom Role objects", | |
| "description": "Returns a list of Account Custom Role objects.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AccountCustomRole" | |
| }, | |
| "example": [ | |
| { | |
| "unique_id": "ddf61a4d-6489-4665-bee6-7e21205f9d6f", | |
| "name": "Role 1 Updated", | |
| "description": "Role 1 Description", | |
| "permissions": [ | |
| "member_read", | |
| "schedule_read", | |
| "team_read" | |
| ] | |
| }, | |
| { | |
| "unique_id": "97208d3e-e45d-409a-b951-4eae928a59b9", | |
| "name": "Role 2", | |
| "description": "Role 1 Description", | |
| "permissions": [ | |
| "member_read", | |
| "sla_read", | |
| "team_read" | |
| ] | |
| }, | |
| { | |
| "unique_id": "0d087386-cebf-47ee-8dd3-c52f05c43128", | |
| "name": "w4e5rty", | |
| "description": "ew4rtyg", | |
| "permissions": [ | |
| "escalation_policy_read", | |
| "incident_read", | |
| "incident_role_read", | |
| "member_read", | |
| "priority_read", | |
| "schedule_read", | |
| "service_read", | |
| "sla_read", | |
| "tag_read", | |
| "task_template_read", | |
| "team_read" | |
| ] | |
| } | |
| ] | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AccountCustomRole" | |
| }, | |
| "example": [ | |
| { | |
| "unique_id": "ddf61a4d-6489-4665-bee6-7e21205f9d6f", | |
| "name": "Role 1 Updated", | |
| "description": "Role 1 Description", | |
| "permissions": [ | |
| "member_read", | |
| "schedule_read", | |
| "team_read" | |
| ] | |
| }, | |
| { | |
| "unique_id": "97208d3e-e45d-409a-b951-4eae928a59b9", | |
| "name": "Role 2", | |
| "description": "Role 1 Description", | |
| "permissions": [ | |
| "member_read", | |
| "sla_read", | |
| "team_read" | |
| ] | |
| }, | |
| { | |
| "unique_id": "0d087386-cebf-47ee-8dd3-c52f05c43128", | |
| "name": "w4e5rty", | |
| "description": "ew4rtyg", | |
| "permissions": [ | |
| "escalation_policy_read", | |
| "incident_read", | |
| "incident_role_read", | |
| "member_read", | |
| "priority_read", | |
| "schedule_read", | |
| "service_read", | |
| "sla_read", | |
| "tag_read", | |
| "task_template_read", | |
| "team_read" | |
| ] | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/customroles/{custom_role_id}/": { | |
| "parameters": [ | |
| { | |
| "name": "custom_role_id", | |
| "in": "path", | |
| "description": "unique_id of the Account Custom Role object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "get": { | |
| "tags": [ | |
| "Account Custom Role" | |
| ], | |
| "summary": "Retrieve the Account Custom Role object", | |
| "description": "Retrieve the specified Account Custom Role object.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AccountCustomRole" | |
| }, | |
| "example": { | |
| "unique_id": "ddf61a4d-6489-4665-bee6-7e21205f9d6f", | |
| "name": "Role 1 Updated", | |
| "description": "Role 1 Description", | |
| "permissions": [ | |
| "member_read", | |
| "schedule_read", | |
| "team_read" | |
| ] | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AccountCustomRole" | |
| }, | |
| "example": { | |
| "unique_id": "ddf61a4d-6489-4665-bee6-7e21205f9d6f", | |
| "name": "Role 1 Updated", | |
| "description": "Role 1 Description", | |
| "permissions": [ | |
| "member_read", | |
| "schedule_read", | |
| "team_read" | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": [ | |
| "Account Custom Role" | |
| ], | |
| "summary": "Update the Account Custom Role object", | |
| "description": "Updates the specified Account Custom Role object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.", | |
| "requestBody": { | |
| "description": "Request body parameters to update the Account Custom Role object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AccountCustomRolePayload" | |
| }, | |
| "example": { | |
| "name": "Role Updated", | |
| "permissions": [ | |
| "sla_read" | |
| ] | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AccountCustomRolePayload" | |
| }, | |
| "example": { | |
| "name": "Role Updated", | |
| "permissions": [ | |
| "sla_read" | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AccountCustomRolePostAndPutResponse" | |
| }, | |
| "example": { | |
| "unique_id": "ddf61a4d-6489-4665-bee6-7e21205f9d6f", | |
| "name": "Role Updated", | |
| "description": "Role 1 Description" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AccountCustomRolePostAndPutResponse" | |
| }, | |
| "example": { | |
| "unique_id": "ddf61a4d-6489-4665-bee6-7e21205f9d6f", | |
| "name": "Role Updated", | |
| "description": "Role 1 Description" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Account Custom Role" | |
| ], | |
| "summary": "Delete the Account Custom Role object", | |
| "description": "Delete the specified Account Custom Role object permanently.", | |
| "responses": { | |
| "204": { | |
| "description": "Success" | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/users/{username}/customroles/": { | |
| "parameters": [ | |
| { | |
| "name": "username", | |
| "in": "path", | |
| "description": "username of the User object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "post": { | |
| "tags": [ | |
| "User Custom Role" | |
| ], | |
| "summary": "Create the User Custom Role object", | |
| "description": "Create the User Custom Role object by setting the values of all the required parameters passed in the request body.", | |
| "requestBody": { | |
| "description": "Request body parameters to create the User Custom Role object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/UserCustomRolePayload" | |
| }, | |
| "example": { | |
| "custom_role": "ddf61a4d-6489-4665-bee6-7e21205f9d6f" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/UserCustomRolePayload" | |
| }, | |
| "example": { | |
| "custom_role": "ddf61a4d-6489-4665-bee6-7e21205f9d6f" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/UserCustomRole" | |
| }, | |
| "example": { | |
| "user": "6278fd1d-7e7c-486a-80e3-5", | |
| "custom_role": "ddf61a4d-6489-4665-bee6-7e21205f9d6f", | |
| "custom_role_details": { | |
| "name": "Role Updated" | |
| } | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/UserCustomRole" | |
| }, | |
| "example": { | |
| "user": "6278fd1d-7e7c-486a-80e3-5", | |
| "custom_role": "ddf61a4d-6489-4665-bee6-7e21205f9d6f", | |
| "custom_role_details": { | |
| "name": "Role Updated" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "get": { | |
| "tags": [ | |
| "User Custom Role" | |
| ], | |
| "summary": "List all User Custom Role objects", | |
| "description": "Returns a list of User Custom Role objects.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/UserCustomRole" | |
| }, | |
| "example": { | |
| "user": "6278fd1d-7e7c-486a-80e3-5", | |
| "custom_role": "ddf61a4d-6489-4665-bee6-7e21205f9d6f", | |
| "custom_role_details": { | |
| "name": "Role Updated" | |
| } | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/UserCustomRole" | |
| }, | |
| "example": { | |
| "user": "6278fd1d-7e7c-486a-80e3-5", | |
| "custom_role": "ddf61a4d-6489-4665-bee6-7e21205f9d6f", | |
| "custom_role_details": { | |
| "name": "Role Updated" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/users/{username}/notification_rules/": { | |
| "parameters": [ | |
| { | |
| "name": "username", | |
| "in": "path", | |
| "description": "username of the User object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "post": { | |
| "tags": [ | |
| "Notification Rules" | |
| ], | |
| "summary": "Create the User Notification Rules object", | |
| "description": "Create the User Notification Rules object by setting the values of all the required parameters passed in the request body.", | |
| "requestBody": { | |
| "description": "Request body parameters to create the User Notification Rule object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/UserNotificationRulePayload" | |
| }, | |
| "example": { | |
| "start_delay": 0, | |
| "contact": "caabda03-5e15-4cf1-b293-fab41b688ac7", | |
| "urgency": 1 | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/UserNotificationRulePayload" | |
| }, | |
| "example": { | |
| "start_delay": 0, | |
| "contact": "caabda03-5e15-4cf1-b293-fab41b688ac7", | |
| "urgency": 1 | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/UserNotificationRule" | |
| }, | |
| "example": { | |
| "creation_date": "2023-03-01T15:28:35.582391Z", | |
| "start_delay": 0, | |
| "type": "", | |
| "unique_id": "3433edb5-f589-4227-baa5-a6646d93e76b", | |
| "contact": "caabda03-5e15-4cf1-b293-fab41b688ac7", | |
| "urgency": 1 | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/UserNotificationRule" | |
| }, | |
| "example": { | |
| "creation_date": "2023-03-01T15:28:35.582391Z", | |
| "start_delay": 0, | |
| "type": "", | |
| "unique_id": "3433edb5-f589-4227-baa5-a6646d93e76b", | |
| "contact": "caabda03-5e15-4cf1-b293-fab41b688ac7", | |
| "urgency": 1 | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "get": { | |
| "tags": [ | |
| "Notification Rules" | |
| ], | |
| "summary": "List all Users' Notification Rule objects", | |
| "description": "Returns a list of User Notification Rule objects.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/UserNotificationRule" | |
| }, | |
| "example": [ | |
| { | |
| "creation_date": "2023-03-01T15:20:45.565595Z", | |
| "start_delay": 0, | |
| "type": "", | |
| "unique_id": "1d757ec0-39d3-4cd0-9536-7e0bb3e2665c", | |
| "contact": "374d3e48-b4bd-438d-8e18-d69ddeadd183", | |
| "urgency": 1 | |
| }, | |
| { | |
| "creation_date": "2023-03-01T15:20:45.922128Z", | |
| "start_delay": 0, | |
| "type": "", | |
| "unique_id": "68ed337e-8481-4cca-81da-b35342660377", | |
| "contact": "caabda03-5e15-4cf1-b293-fab41b688ac7", | |
| "urgency": 1 | |
| }, | |
| { | |
| "creation_date": "2023-03-01T15:28:35.582391Z", | |
| "start_delay": 5, | |
| "type": "", | |
| "unique_id": "3433edb5-f589-4227-baa5-a6646d93e76b", | |
| "contact": "caabda03-5e15-4cf1-b293-fab41b688ac7", | |
| "urgency": 1 | |
| } | |
| ] | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/UserNotificationRule" | |
| }, | |
| "example": [ | |
| { | |
| "creation_date": "2023-03-01T15:20:45.565595Z", | |
| "start_delay": 0, | |
| "type": "", | |
| "unique_id": "1d757ec0-39d3-4cd0-9536-7e0bb3e2665c", | |
| "contact": "374d3e48-b4bd-438d-8e18-d69ddeadd183", | |
| "urgency": 1 | |
| }, | |
| { | |
| "creation_date": "2023-03-01T15:20:45.922128Z", | |
| "start_delay": 0, | |
| "type": "", | |
| "unique_id": "68ed337e-8481-4cca-81da-b35342660377", | |
| "contact": "caabda03-5e15-4cf1-b293-fab41b688ac7", | |
| "urgency": 1 | |
| }, | |
| { | |
| "creation_date": "2023-03-01T15:28:35.582391Z", | |
| "start_delay": 5, | |
| "type": "", | |
| "unique_id": "3433edb5-f589-4227-baa5-a6646d93e76b", | |
| "contact": "caabda03-5e15-4cf1-b293-fab41b688ac7", | |
| "urgency": 1 | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/users/{username}/notification_rules/{notification_rule_id}/": { | |
| "parameters": [ | |
| { | |
| "name": "username", | |
| "in": "path", | |
| "description": "username of the User object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| }, | |
| { | |
| "name": "notification_rule_id", | |
| "in": "path", | |
| "description": "unique_id of the User Notification Rule object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "get": { | |
| "tags": [ | |
| "Notification Rules" | |
| ], | |
| "summary": "Retrieve the User Notification Rule object", | |
| "description": "Retrieve the specified User's Notification Rule object.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/UserNotificationRule" | |
| }, | |
| "example": { | |
| "creation_date": "2023-03-01T15:20:45.565595Z", | |
| "start_delay": 5, | |
| "type": "", | |
| "unique_id": "1d757ec0-39d3-4cd0-9536-7e0bb3e2665c", | |
| "contact": "374d3e48-b4bd-438d-8e18-d69ddeadd183", | |
| "urgency": 1 | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/UserNotificationRule" | |
| }, | |
| "example": { | |
| "creation_date": "2023-03-01T15:20:45.565595Z", | |
| "start_delay": 5, | |
| "type": "", | |
| "unique_id": "1d757ec0-39d3-4cd0-9536-7e0bb3e2665c", | |
| "contact": "374d3e48-b4bd-438d-8e18-d69ddeadd183", | |
| "urgency": 1 | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Notification Rules" | |
| ], | |
| "summary": "Delete the User Notification Rules object", | |
| "description": "Delete the specified User Notification Rules object permanently.", | |
| "responses": { | |
| "204": { | |
| "description": "Success" | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/users/{username}/forwarding_rules/": { | |
| "parameters": [ | |
| { | |
| "name": "username", | |
| "in": "path", | |
| "description": "username of the User object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "post": { | |
| "tags": [ | |
| "Forwarding Rules" | |
| ], | |
| "summary": "Create the User Forwarding Rules object", | |
| "description": "Create the User's Forwarding Rules object by setting the values of all the required parameters passed in the request body.", | |
| "requestBody": { | |
| "description": "Request body parameters to create the User Forwarding Rules object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/UserForwardingRulePayload" | |
| }, | |
| "example": { | |
| "from_date": "2023-03-01T16:37:58.654Z", | |
| "to_date": "2023-03-01T16:37:58.654Z", | |
| "time_zone": "UTC", | |
| "to_user": "7e26fed1-f11c-4e78-afc6-a" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/UserForwardingRulePayload" | |
| }, | |
| "example": { | |
| "from_date": "2023-03-01T16:37:58.654Z", | |
| "to_date": "2023-03-01T16:37:58.654Z", | |
| "time_zone": "UTC", | |
| "to_user": "7e26fed1-f11c-4e78-afc6-a" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/UserForwardingRule" | |
| }, | |
| "example": { | |
| "creation_date": "2023-03-01T16:43:00.031310Z", | |
| "unique_id": "8bd02ac2-07fe-4d32-a37f-e1def9673746", | |
| "time_zone": "UTC", | |
| "from_date": "2023-03-01T16:37:58.654000Z", | |
| "to_date": "2023-03-01T16:37:58.654000Z", | |
| "to_user": "7e26fed1-f11c-4e78-afc6-a", | |
| "created_by": "7e26fed1-f11c-4e78-afc6-a", | |
| "user": "4f9f41eb-4252-462e-9e33-6" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/UserForwardingRule" | |
| }, | |
| "example": { | |
| "creation_date": "2023-03-01T16:43:00.031310Z", | |
| "unique_id": "8bd02ac2-07fe-4d32-a37f-e1def9673746", | |
| "time_zone": "UTC", | |
| "from_date": "2023-03-01T16:37:58.654000Z", | |
| "to_date": "2023-03-01T16:37:58.654000Z", | |
| "to_user": "7e26fed1-f11c-4e78-afc6-a", | |
| "created_by": "7e26fed1-f11c-4e78-afc6-a", | |
| "user": "4f9f41eb-4252-462e-9e33-6" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "get": { | |
| "tags": [ | |
| "Forwarding Rules" | |
| ], | |
| "summary": "List all User Forwarding Rule objects", | |
| "description": "Returns a list of User Forwarding Rule objects.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/UserForwardingRule" | |
| }, | |
| "example": [ | |
| { | |
| "creation_date": "2023-03-01T16:38:22.540374Z", | |
| "unique_id": "a6011d7c-3a44-4cab-8580-a410881f4ff9", | |
| "time_zone": "UTC", | |
| "from_date": "2023-03-01T16:37:58.654000Z", | |
| "to_date": "2023-03-01T16:37:58.654000Z", | |
| "to_user": "7e26fed1-f11c-4e78-afc6-a", | |
| "created_by": "7e26fed1-f11c-4e78-afc6-a", | |
| "user": "4f9f41eb-4252-462e-9e33-6" | |
| }, | |
| { | |
| "creation_date": "2023-03-01T16:44:31.446633Z", | |
| "unique_id": "e2c523b9-af2b-4e66-a3fd-338bd7ffc641", | |
| "time_zone": "UTC", | |
| "from_date": "2023-03-01T16:44:22.757000Z", | |
| "to_date": "2023-03-01T16:44:22.757000Z", | |
| "to_user": "25692874-e54d-4101-bbfc-7", | |
| "created_by": "7e26fed1-f11c-4e78-afc6-a", | |
| "user": "4f9f41eb-4252-462e-9e33-6" | |
| } | |
| ] | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/UserForwardingRule" | |
| }, | |
| "example": [ | |
| { | |
| "creation_date": "2023-03-01T16:38:22.540374Z", | |
| "unique_id": "a6011d7c-3a44-4cab-8580-a410881f4ff9", | |
| "time_zone": "UTC", | |
| "from_date": "2023-03-01T16:37:58.654000Z", | |
| "to_date": "2023-03-01T16:37:58.654000Z", | |
| "to_user": "7e26fed1-f11c-4e78-afc6-a", | |
| "created_by": "7e26fed1-f11c-4e78-afc6-a", | |
| "user": "4f9f41eb-4252-462e-9e33-6" | |
| }, | |
| { | |
| "creation_date": "2023-03-01T16:44:31.446633Z", | |
| "unique_id": "e2c523b9-af2b-4e66-a3fd-338bd7ffc641", | |
| "time_zone": "UTC", | |
| "from_date": "2023-03-01T16:44:22.757000Z", | |
| "to_date": "2023-03-01T16:44:22.757000Z", | |
| "to_user": "25692874-e54d-4101-bbfc-7", | |
| "created_by": "7e26fed1-f11c-4e78-afc6-a", | |
| "user": "4f9f41eb-4252-462e-9e33-6" | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/users/{username}/forwarding_rules/{forwarding_rule_id}/": { | |
| "parameters": [ | |
| { | |
| "name": "username", | |
| "in": "path", | |
| "description": "username of the User object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| }, | |
| { | |
| "name": "forwarding_rule_id", | |
| "in": "path", | |
| "description": "unique_id of the User Forwarding Rules object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "get": { | |
| "tags": [ | |
| "Forwarding Rules" | |
| ], | |
| "summary": "Retrieve the User Forwarding Rules object", | |
| "description": "Retrieve the specified User's Forwarding Rules object.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/UserForwardingRule" | |
| }, | |
| "example": { | |
| "creation_date": "2023-03-01T16:38:22.540374Z", | |
| "unique_id": "a6011d7c-3a44-4cab-8580-a410881f4ff9", | |
| "time_zone": "UTC", | |
| "from_date": "2023-03-01T16:37:58.654000Z", | |
| "to_date": "2023-03-01T16:37:58.654000Z", | |
| "to_user": "7e26fed1-f11c-4e78-afc6-a", | |
| "created_by": "7e26fed1-f11c-4e78-afc6-a", | |
| "user": "4f9f41eb-4252-462e-9e33-6" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/UserForwardingRule" | |
| }, | |
| "example": { | |
| "creation_date": "2023-03-01T16:38:22.540374Z", | |
| "unique_id": "a6011d7c-3a44-4cab-8580-a410881f4ff9", | |
| "time_zone": "UTC", | |
| "from_date": "2023-03-01T16:37:58.654000Z", | |
| "to_date": "2023-03-01T16:37:58.654000Z", | |
| "to_user": "7e26fed1-f11c-4e78-afc6-a", | |
| "created_by": "7e26fed1-f11c-4e78-afc6-a", | |
| "user": "4f9f41eb-4252-462e-9e33-6" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Forwarding Rules" | |
| ], | |
| "summary": "Delete the User Forwarding Rule object", | |
| "description": "Delete the specified User's Forwarding Rules object permanently.", | |
| "responses": { | |
| "204": { | |
| "description": "Success" | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/users/{username}/contacts/": { | |
| "parameters": [ | |
| { | |
| "name": "username", | |
| "in": "path", | |
| "description": "username of the User object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "post": { | |
| "tags": [ | |
| "Contact Methods" | |
| ], | |
| "summary": "Create the User Contact Methods object", | |
| "description": "Create the User Contact Methods object by setting the values of all the required parameters passed in the request body. A user can only create email Contact Methods through API.", | |
| "requestBody": { | |
| "description": "Request body parameters to create the User Contact Methods object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/UserContactMethodPayload" | |
| }, | |
| "example": { | |
| "name": "Secondary Email", | |
| "value": "[email protected]", | |
| "contact_type": 1 | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/UserContactMethodPayload" | |
| }, | |
| "example": { | |
| "name": "Secondary Email", | |
| "value": "[email protected]", | |
| "contact_type": 1 | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/UserContactMethod" | |
| }, | |
| "example": { | |
| "name": "Secondary Email", | |
| "creation_date": "2023-03-02", | |
| "contact_type": 1, | |
| "value": "[email protected]", | |
| "unique_id": "8a862f18-9332-4d08-90ad-06c070803c05" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/UserContactMethod" | |
| }, | |
| "example": { | |
| "name": "Secondary Email", | |
| "creation_date": "2023-03-02", | |
| "contact_type": 1, | |
| "value": "[email protected]", | |
| "unique_id": "8a862f18-9332-4d08-90ad-06c070803c05" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "get": { | |
| "tags": [ | |
| "Contact Methods" | |
| ], | |
| "summary": "List all User Contact Method objects", | |
| "description": "Returns a list of User Contact Method objects.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/UserContactMethod" | |
| }, | |
| "example": [ | |
| { | |
| "name": "Primary Email", | |
| "creation_date": "2023-02-14", | |
| "contact_type": 1, | |
| "value": "[email protected]", | |
| "unique_id": "374d3e48-b4bd-438d-8e18-d69ddeadd183" | |
| }, | |
| { | |
| "name": "Primary", | |
| "creation_date": "2023-03-01", | |
| "contact_type": 2, | |
| "value": "+91 86993 62839", | |
| "unique_id": "caabda03-5e15-4cf1-b293-fab41b688ac7" | |
| }, | |
| { | |
| "name": "Secondary Email", | |
| "creation_date": "2023-03-02", | |
| "contact_type": 1, | |
| "value": "[email protected]", | |
| "unique_id": "8a862f18-9332-4d08-90ad-06c070803c05" | |
| } | |
| ] | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/UserContactMethod" | |
| }, | |
| "example": [ | |
| { | |
| "name": "Primary Email", | |
| "creation_date": "2023-02-14", | |
| "contact_type": 1, | |
| "value": "[email protected]", | |
| "unique_id": "374d3e48-b4bd-438d-8e18-d69ddeadd183" | |
| }, | |
| { | |
| "name": "Primary", | |
| "creation_date": "2023-03-01", | |
| "contact_type": 2, | |
| "value": "+91 86993 62839", | |
| "unique_id": "caabda03-5e15-4cf1-b293-fab41b688ac7" | |
| }, | |
| { | |
| "name": "Secondary Email", | |
| "creation_date": "2023-03-02", | |
| "contact_type": 1, | |
| "value": "[email protected]", | |
| "unique_id": "8a862f18-9332-4d08-90ad-06c070803c05" | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/users/{username}/contacts/{contact_id}/": { | |
| "parameters": [ | |
| { | |
| "name": "username", | |
| "in": "path", | |
| "description": "username of the User object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| }, | |
| { | |
| "name": "contact_id", | |
| "in": "path", | |
| "description": "unique_id of the User Contact Methods object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "get": { | |
| "tags": [ | |
| "Contact Methods" | |
| ], | |
| "summary": "Retrieve the User Contact Methods object", | |
| "description": "Retrieve the specified User's Contact Methods object.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/UserContactMethod" | |
| }, | |
| "example": { | |
| "name": "Primary Email", | |
| "creation_date": "2023-02-14", | |
| "contact_type": 1, | |
| "value": "[email protected]", | |
| "unique_id": "374d3e48-b4bd-438d-8e18-d69ddeadd183" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/UserContactMethod" | |
| }, | |
| "example": { | |
| "name": "Primary Email", | |
| "creation_date": "2023-02-14", | |
| "contact_type": 1, | |
| "value": "[email protected]", | |
| "unique_id": "374d3e48-b4bd-438d-8e18-d69ddeadd183" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Contact Methods" | |
| ], | |
| "summary": "Delete the User Contact Methods object", | |
| "description": "Delete the specified User's Contact Methods object permanently.", | |
| "responses": { | |
| "204": { | |
| "description": "Success" | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/teams/": { | |
| "post": { | |
| "tags": [ | |
| "Teams" | |
| ], | |
| "summary": "Create the Team object", | |
| "description": "Create the Team object by setting the values of all the required parameters passed in the request body.", | |
| "requestBody": { | |
| "description": "Request body parameters to create the Team object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TeamPayload" | |
| }, | |
| "example": { | |
| "name": "Production Team" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TeamPayload" | |
| }, | |
| "example": { | |
| "name": "Production Team" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Team" | |
| }, | |
| "example": { | |
| "unique_id": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "name": "Production Team", | |
| "account": "0713dc12-40b0-46ff-b0f9-c6b126399277", | |
| "creation_date": "2022-07-08", | |
| "members": [ | |
| { | |
| "unique_id": "d916157c-ff8b-43be-8e99-4b63699fdf72", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "user": { | |
| "username": "216bba3d-7268-4a8e-89e9-6", | |
| "first_name": "Anshul", | |
| "last_name": "Rajput", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T10:41:36.600148Z", | |
| "role": 1 | |
| } | |
| ], | |
| "owner": "216bba3d-7268-4a8e-89e9-6", | |
| "roles": [ | |
| { | |
| "unique_id": "89752b4a-43df-401d-9dc0-a446690a7a0e", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "title": "Incident Commander", | |
| "description": "The incident commander is the person responsible for all aspects of the incident response, including quickly developing incident objectives, managing all incident operations, application of resources as well as responsibility for all persons involved. The incident commander sets priorities and defines the organization of the incident response teams and the overall incident action plan.", | |
| "creation_date": "2022-07-08T10:41:36.623257Z", | |
| "rank": 1 | |
| } | |
| ] | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Team" | |
| }, | |
| "example": { | |
| "unique_id": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "name": "Production Team", | |
| "account": "0713dc12-40b0-46ff-b0f9-c6b126399277", | |
| "creation_date": "2022-07-08", | |
| "members": [ | |
| { | |
| "unique_id": "d916157c-ff8b-43be-8e99-4b63699fdf72", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "user": { | |
| "username": "216bba3d-7268-4a8e-89e9-6", | |
| "first_name": "Anshul", | |
| "last_name": "Rajput", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T10:41:36.600148Z", | |
| "role": 1 | |
| } | |
| ], | |
| "owner": "216bba3d-7268-4a8e-89e9-6", | |
| "roles": [ | |
| { | |
| "unique_id": "89752b4a-43df-401d-9dc0-a446690a7a0e", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "title": "Incident Commander", | |
| "description": "The incident commander is the person responsible for all aspects of the incident response, including quickly developing incident objectives, managing all incident operations, application of resources as well as responsibility for all persons involved. The incident commander sets priorities and defines the organization of the incident response teams and the overall incident action plan.", | |
| "creation_date": "2022-07-08T10:41:36.623257Z", | |
| "rank": 1 | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "get": { | |
| "tags": [ | |
| "Teams" | |
| ], | |
| "summary": "List all Team objects", | |
| "description": "Returns a list of Team objects. The Team objects are sorted by creation_date, with the most recent Team object appearing last.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Team" | |
| }, | |
| "example": [ | |
| { | |
| "unique_id": "1f1b4d79-ed32-44fc-926d-f794b975200c", | |
| "name": "Operation Team", | |
| "account": "0713dc12-40b0-46ff-b0f9-c6b126399277", | |
| "creation_date": "2022-07-08", | |
| "members": [ | |
| { | |
| "unique_id": "90a97f10-d290-4bd0-9f83-525f130c6399", | |
| "team": "1f1b4d79-ed32-44fc-926d-f794b975200c", | |
| "user": { | |
| "username": "216bba3d-7268-4a8e-89e9-6", | |
| "first_name": "Anshul", | |
| "last_name": "Rajput", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T10:29:36.408864Z", | |
| "role": 1 | |
| }, | |
| { | |
| "unique_id": "4af52265-b69e-4cd0-948a-fba33933588d", | |
| "team": "1f1b4d79-ed32-44fc-926d-f794b975200c", | |
| "user": { | |
| "username": "507dfda0-a1fd-40e5-943a-e", | |
| "first_name": "Mary", | |
| "last_name": "Jane", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T10:31:56.849950Z", | |
| "role": 2 | |
| }, | |
| { | |
| "unique_id": "76e76d20-2c82-49be-b987-244c8c6af57b", | |
| "team": "1f1b4d79-ed32-44fc-926d-f794b975200c", | |
| "user": { | |
| "username": "85b563c8-18d0-4668-9462-9", | |
| "first_name": "Vishwa", | |
| "last_name": "Krishnakumar", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T10:32:42.213487Z", | |
| "role": 2 | |
| } | |
| ], | |
| "owner": "216bba3d-7268-4a8e-89e9-6", | |
| "roles": [ | |
| { | |
| "unique_id": "ce2e4fec-7fb9-440c-b400-9a33639d8ba3", | |
| "team": "1f1b4d79-ed32-44fc-926d-f794b975200c", | |
| "title": "Incident Commander", | |
| "description": "The incident commander is the person responsible for all aspects of the incident response, including quickly developing incident objectives, managing all incident operations, application of resources as well as responsibility for all persons involved. The incident commander sets priorities and defines the organization of the incident response teams and the overall incident action plan.", | |
| "creation_date": "2022-07-08T10:29:36.431801Z", | |
| "rank": 1 | |
| } | |
| ] | |
| }, | |
| { | |
| "unique_id": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "name": "Production Team", | |
| "account": "0713dc12-40b0-46ff-b0f9-c6b126399277", | |
| "creation_date": "2022-07-08", | |
| "members": [ | |
| { | |
| "unique_id": "d916157c-ff8b-43be-8e99-4b63699fdf72", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "user": { | |
| "username": "216bba3d-7268-4a8e-89e9-6", | |
| "first_name": "Anshul", | |
| "last_name": "Rajput", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T10:41:36.600148Z", | |
| "role": 1 | |
| } | |
| ], | |
| "owner": "216bba3d-7268-4a8e-89e9-6", | |
| "roles": [ | |
| { | |
| "unique_id": "89752b4a-43df-401d-9dc0-a446690a7a0e", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "title": "Incident Commander", | |
| "description": "The incident commander is the person responsible for all aspects of the incident response, including quickly developing incident objectives, managing all incident operations, application of resources as well as responsibility for all persons involved. The incident commander sets priorities and defines the organization of the incident response teams and the overall incident action plan.", | |
| "creation_date": "2022-07-08T10:41:36.623257Z", | |
| "rank": 1 | |
| } | |
| ] | |
| } | |
| ] | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Team" | |
| }, | |
| "example": [ | |
| { | |
| "unique_id": "1f1b4d79-ed32-44fc-926d-f794b975200c", | |
| "name": "Operation Team", | |
| "account": "0713dc12-40b0-46ff-b0f9-c6b126399277", | |
| "creation_date": "2022-07-08", | |
| "members": [ | |
| { | |
| "unique_id": "90a97f10-d290-4bd0-9f83-525f130c6399", | |
| "team": "1f1b4d79-ed32-44fc-926d-f794b975200c", | |
| "user": { | |
| "username": "216bba3d-7268-4a8e-89e9-6", | |
| "first_name": "Anshul", | |
| "last_name": "Rajput", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T10:29:36.408864Z", | |
| "role": 1 | |
| }, | |
| { | |
| "unique_id": "4af52265-b69e-4cd0-948a-fba33933588d", | |
| "team": "1f1b4d79-ed32-44fc-926d-f794b975200c", | |
| "user": { | |
| "username": "507dfda0-a1fd-40e5-943a-e", | |
| "first_name": "Mary", | |
| "last_name": "Jane", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T10:31:56.849950Z", | |
| "role": 2 | |
| }, | |
| { | |
| "unique_id": "76e76d20-2c82-49be-b987-244c8c6af57b", | |
| "team": "1f1b4d79-ed32-44fc-926d-f794b975200c", | |
| "user": { | |
| "username": "85b563c8-18d0-4668-9462-9", | |
| "first_name": "Vishwa", | |
| "last_name": "Krishnakumar", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T10:32:42.213487Z", | |
| "role": 2 | |
| } | |
| ], | |
| "owner": "216bba3d-7268-4a8e-89e9-6", | |
| "roles": [ | |
| { | |
| "unique_id": "ce2e4fec-7fb9-440c-b400-9a33639d8ba3", | |
| "team": "1f1b4d79-ed32-44fc-926d-f794b975200c", | |
| "title": "Incident Commander", | |
| "description": "The incident commander is the person responsible for all aspects of the incident response, including quickly developing incident objectives, managing all incident operations, application of resources as well as responsibility for all persons involved. The incident commander sets priorities and defines the organization of the incident response teams and the overall incident action plan.", | |
| "creation_date": "2022-07-08T10:29:36.431801Z", | |
| "rank": 1 | |
| } | |
| ] | |
| }, | |
| { | |
| "unique_id": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "name": "Production Team", | |
| "account": "0713dc12-40b0-46ff-b0f9-c6b126399277", | |
| "creation_date": "2022-07-08", | |
| "members": [ | |
| { | |
| "unique_id": "d916157c-ff8b-43be-8e99-4b63699fdf72", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "user": { | |
| "username": "216bba3d-7268-4a8e-89e9-6", | |
| "first_name": "Anshul", | |
| "last_name": "Rajput", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T10:41:36.600148Z", | |
| "role": 1 | |
| } | |
| ], | |
| "owner": "216bba3d-7268-4a8e-89e9-6", | |
| "roles": [ | |
| { | |
| "unique_id": "89752b4a-43df-401d-9dc0-a446690a7a0e", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "title": "Incident Commander", | |
| "description": "The incident commander is the person responsible for all aspects of the incident response, including quickly developing incident objectives, managing all incident operations, application of resources as well as responsibility for all persons involved. The incident commander sets priorities and defines the organization of the incident response teams and the overall incident action plan.", | |
| "creation_date": "2022-07-08T10:41:36.623257Z", | |
| "rank": 1 | |
| } | |
| ] | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/teams/{team_id}/": { | |
| "parameters": [ | |
| { | |
| "name": "team_id", | |
| "in": "path", | |
| "description": "unique_id of the Team object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "get": { | |
| "tags": [ | |
| "Teams" | |
| ], | |
| "summary": "Retrieve the Team object", | |
| "description": "Retrieve the specified Team object.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Team" | |
| }, | |
| "example": { | |
| "unique_id": "1f1b4d79-ed32-44fc-926d-f794b975200c", | |
| "name": "Operation Team", | |
| "account": "0713dc12-40b0-46ff-b0f9-c6b126399277", | |
| "creation_date": "2022-07-08", | |
| "members": [ | |
| { | |
| "unique_id": "90a97f10-d290-4bd0-9f83-525f130c6399", | |
| "team": "1f1b4d79-ed32-44fc-926d-f794b975200c", | |
| "user": { | |
| "username": "216bba3d-7268-4a8e-89e9-6", | |
| "first_name": "Anshul", | |
| "last_name": "Rajput", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T10:29:36.408864Z", | |
| "role": 1 | |
| }, | |
| { | |
| "unique_id": "4af52265-b69e-4cd0-948a-fba33933588d", | |
| "team": "1f1b4d79-ed32-44fc-926d-f794b975200c", | |
| "user": { | |
| "username": "507dfda0-a1fd-40e5-943a-e", | |
| "first_name": "Mary", | |
| "last_name": "Jane", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T10:31:56.849950Z", | |
| "role": 2 | |
| }, | |
| { | |
| "unique_id": "76e76d20-2c82-49be-b987-244c8c6af57b", | |
| "team": "1f1b4d79-ed32-44fc-926d-f794b975200c", | |
| "user": { | |
| "username": "85b563c8-18d0-4668-9462-9", | |
| "first_name": "Vishwa", | |
| "last_name": "Krishnakumar", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T10:32:42.213487Z", | |
| "role": 2 | |
| } | |
| ], | |
| "owner": "216bba3d-7268-4a8e-89e9-6", | |
| "roles": [ | |
| { | |
| "unique_id": "ce2e4fec-7fb9-440c-b400-9a33639d8ba3", | |
| "team": "1f1b4d79-ed32-44fc-926d-f794b975200c", | |
| "title": "Incident Commander", | |
| "description": "The incident commander is the person responsible for all aspects of the incident response, including quickly developing incident objectives, managing all incident operations, application of resources as well as responsibility for all persons involved. The incident commander sets priorities and defines the organization of the incident response teams and the overall incident action plan.", | |
| "creation_date": "2022-07-08T10:29:36.431801Z", | |
| "rank": 1 | |
| } | |
| ] | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Team" | |
| }, | |
| "example": { | |
| "unique_id": "1f1b4d79-ed32-44fc-926d-f794b975200c", | |
| "name": "Operation Team", | |
| "account": "0713dc12-40b0-46ff-b0f9-c6b126399277", | |
| "creation_date": "2022-07-08", | |
| "members": [ | |
| { | |
| "unique_id": "90a97f10-d290-4bd0-9f83-525f130c6399", | |
| "team": "1f1b4d79-ed32-44fc-926d-f794b975200c", | |
| "user": { | |
| "username": "216bba3d-7268-4a8e-89e9-6", | |
| "first_name": "Anshul", | |
| "last_name": "Rajput", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T10:29:36.408864Z", | |
| "role": 1 | |
| }, | |
| { | |
| "unique_id": "4af52265-b69e-4cd0-948a-fba33933588d", | |
| "team": "1f1b4d79-ed32-44fc-926d-f794b975200c", | |
| "user": { | |
| "username": "507dfda0-a1fd-40e5-943a-e", | |
| "first_name": "Mary", | |
| "last_name": "Jane", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T10:31:56.849950Z", | |
| "role": 2 | |
| }, | |
| { | |
| "unique_id": "76e76d20-2c82-49be-b987-244c8c6af57b", | |
| "team": "1f1b4d79-ed32-44fc-926d-f794b975200c", | |
| "user": { | |
| "username": "85b563c8-18d0-4668-9462-9", | |
| "first_name": "Vishwa", | |
| "last_name": "Krishnakumar", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T10:32:42.213487Z", | |
| "role": 2 | |
| } | |
| ], | |
| "owner": "216bba3d-7268-4a8e-89e9-6", | |
| "roles": [ | |
| { | |
| "unique_id": "ce2e4fec-7fb9-440c-b400-9a33639d8ba3", | |
| "team": "1f1b4d79-ed32-44fc-926d-f794b975200c", | |
| "title": "Incident Commander", | |
| "description": "The incident commander is the person responsible for all aspects of the incident response, including quickly developing incident objectives, managing all incident operations, application of resources as well as responsibility for all persons involved. The incident commander sets priorities and defines the organization of the incident response teams and the overall incident action plan.", | |
| "creation_date": "2022-07-08T10:29:36.431801Z", | |
| "rank": 1 | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": [ | |
| "Teams" | |
| ], | |
| "summary": "Update the Team object", | |
| "description": "Updates the specified Team object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.", | |
| "requestBody": { | |
| "description": "Request body parameters to update the Team object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TeamPayload" | |
| }, | |
| "example": { | |
| "name": "Modified Production Team" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TeamPayload" | |
| }, | |
| "example": { | |
| "name": "Modified Production Team" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Team" | |
| }, | |
| "example": { | |
| "unique_id": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "name": "Modified Production Team", | |
| "account": "0713dc12-40b0-46ff-b0f9-c6b126399277", | |
| "creation_date": "2022-07-08", | |
| "members": [ | |
| { | |
| "unique_id": "d916157c-ff8b-43be-8e99-4b63699fdf72", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "user": { | |
| "username": "216bba3d-7268-4a8e-89e9-6", | |
| "first_name": "Anshul", | |
| "last_name": "Rajput", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T10:41:36.600148Z", | |
| "role": 1 | |
| } | |
| ], | |
| "owner": "216bba3d-7268-4a8e-89e9-6", | |
| "roles": [ | |
| { | |
| "unique_id": "89752b4a-43df-401d-9dc0-a446690a7a0e", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "title": "Incident Commander", | |
| "description": "The incident commander is the person responsible for all aspects of the incident response, including quickly developing incident objectives, managing all incident operations, application of resources as well as responsibility for all persons involved. The incident commander sets priorities and defines the organization of the incident response teams and the overall incident action plan.", | |
| "creation_date": "2022-07-08T10:41:36.623257Z", | |
| "rank": 1 | |
| } | |
| ] | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Team" | |
| }, | |
| "example": { | |
| "unique_id": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "name": "Modified Production Team", | |
| "account": "0713dc12-40b0-46ff-b0f9-c6b126399277", | |
| "creation_date": "2022-07-08", | |
| "members": [ | |
| { | |
| "unique_id": "d916157c-ff8b-43be-8e99-4b63699fdf72", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "user": { | |
| "username": "216bba3d-7268-4a8e-89e9-6", | |
| "first_name": "Anshul", | |
| "last_name": "Rajput", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T10:41:36.600148Z", | |
| "role": 1 | |
| } | |
| ], | |
| "owner": "216bba3d-7268-4a8e-89e9-6", | |
| "roles": [ | |
| { | |
| "unique_id": "89752b4a-43df-401d-9dc0-a446690a7a0e", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "title": "Incident Commander", | |
| "description": "The incident commander is the person responsible for all aspects of the incident response, including quickly developing incident objectives, managing all incident operations, application of resources as well as responsibility for all persons involved. The incident commander sets priorities and defines the organization of the incident response teams and the overall incident action plan.", | |
| "creation_date": "2022-07-08T10:41:36.623257Z", | |
| "rank": 1 | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Teams" | |
| ], | |
| "summary": "Delete the Team object", | |
| "description": "Delete the specified Team object permanently.", | |
| "responses": { | |
| "204": { | |
| "description": "Success" | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/teams/{}/members/": { | |
| "parameters": [ | |
| { | |
| "name": "team_id", | |
| "in": "path", | |
| "description": "unique_id of the Team object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "post": { | |
| "tags": [ | |
| "Team Members" | |
| ], | |
| "summary": "Add user to Team", | |
| "description": "Create the Team Member object by setting the values of all the required parameters passed in the request body.", | |
| "requestBody": { | |
| "description": "Request body parameters to create the Team Member object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TeamMemberPayload" | |
| }, | |
| "example": { | |
| "user": "507dfda0-a1fd-40e5-943a-e" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TeamMemberPayload" | |
| }, | |
| "example": { | |
| "user": "507dfda0-a1fd-40e5-943a-e" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TeamMember" | |
| }, | |
| "example": { | |
| "unique_id": "828e4a7b-bb12-4ffc-baa5-7681634d4f7f", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "user": "507dfda0-a1fd-40e5-943a-e", | |
| "joining_date": "2022-07-08T11:09:38.230395Z", | |
| "role": 2 | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TeamMember" | |
| }, | |
| "example": { | |
| "unique_id": "828e4a7b-bb12-4ffc-baa5-7681634d4f7f", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "user": "507dfda0-a1fd-40e5-943a-e", | |
| "joining_date": "2022-07-08T11:09:38.230395Z", | |
| "role": 2 | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "get": { | |
| "tags": [ | |
| "Team Members" | |
| ], | |
| "summary": "List all Team Member objects", | |
| "description": "Returns a list of Team Member objects. The Team Member objects are sorted by joining_date, with the most recent Team Member object appearing last.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TeamMember" | |
| }, | |
| "example": [ | |
| { | |
| "unique_id": "d916157c-ff8b-43be-8e99-4b63699fdf72", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "user": { | |
| "username": "216bba3d-7268-4a8e-89e9-6", | |
| "first_name": "Anshul", | |
| "last_name": "Rajput", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T10:41:36.600148Z", | |
| "role": 1 | |
| }, | |
| { | |
| "unique_id": "828e4a7b-bb12-4ffc-baa5-7681634d4f7f", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "user": { | |
| "username": "507dfda0-a1fd-40e5-943a-e", | |
| "first_name": "Mary", | |
| "last_name": "Jane", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T11:09:38.230395Z", | |
| "role": 2 | |
| } | |
| ] | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TeamMember" | |
| }, | |
| "example": [ | |
| { | |
| "unique_id": "d916157c-ff8b-43be-8e99-4b63699fdf72", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "user": { | |
| "username": "216bba3d-7268-4a8e-89e9-6", | |
| "first_name": "Anshul", | |
| "last_name": "Rajput", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T10:41:36.600148Z", | |
| "role": 1 | |
| }, | |
| { | |
| "unique_id": "828e4a7b-bb12-4ffc-baa5-7681634d4f7f", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "user": { | |
| "username": "507dfda0-a1fd-40e5-943a-e", | |
| "first_name": "Mary", | |
| "last_name": "Jane", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T11:09:38.230395Z", | |
| "role": 2 | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/teams/{team_id}/members/{member_id}/": { | |
| "parameters": [ | |
| { | |
| "name": "team_id", | |
| "in": "path", | |
| "description": "unique_id of the Team object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| }, | |
| { | |
| "name": "member_id", | |
| "in": "path", | |
| "description": "unique_id of the Team Member object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "get": { | |
| "tags": [ | |
| "Team Members" | |
| ], | |
| "summary": "Retrieve the Team Member object", | |
| "description": "Retrieve the specified Team Member object.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TeamMember" | |
| }, | |
| "example": { | |
| "unique_id": "828e4a7b-bb12-4ffc-baa5-7681634d4f7f", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "user": { | |
| "username": "507dfda0-a1fd-40e5-943a-e", | |
| "first_name": "Mary", | |
| "last_name": "Jane", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T11:09:38.230395Z", | |
| "role": 2 | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TeamMember" | |
| }, | |
| "example": { | |
| "unique_id": "828e4a7b-bb12-4ffc-baa5-7681634d4f7f", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "user": { | |
| "username": "507dfda0-a1fd-40e5-943a-e", | |
| "first_name": "Mary", | |
| "last_name": "Jane", | |
| "email": "[email protected]" | |
| }, | |
| "joining_date": "2022-07-08T11:09:38.230395Z", | |
| "role": 2 | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": [ | |
| "Team Members" | |
| ], | |
| "summary": "Update the Team Member object", | |
| "description": "Updates the specified Team Member object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.", | |
| "requestBody": { | |
| "description": "Request body parameters to update the Team Member object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TeamMemberPayload" | |
| }, | |
| "example": { | |
| "user": "507dfda0-a1fd-40e5-943a-e", | |
| "role": 1 | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TeamMemberPayload" | |
| }, | |
| "example": { | |
| "user": "507dfda0-a1fd-40e5-943a-e", | |
| "role": 1 | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TeamMember" | |
| }, | |
| "example": { | |
| "unique_id": "828e4a7b-bb12-4ffc-baa5-7681634d4f7f", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "user": "507dfda0-a1fd-40e5-943a-e", | |
| "joining_date": "2022-07-08T11:09:38.230395Z", | |
| "role": 1 | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TeamMember" | |
| }, | |
| "example": { | |
| "unique_id": "828e4a7b-bb12-4ffc-baa5-7681634d4f7f", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "user": "507dfda0-a1fd-40e5-943a-e", | |
| "joining_date": "2022-07-08T11:09:38.230395Z", | |
| "role": 1 | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Team Members" | |
| ], | |
| "summary": "Delete the Team Member object", | |
| "description": "Delete the specified Team Member object permanently.", | |
| "responses": { | |
| "204": { | |
| "description": "Success" | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/teams/{}/permissions/": { | |
| "parameters": [ | |
| { | |
| "name": "team_id", | |
| "in": "path", | |
| "description": "unique_id of the Team object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "get": { | |
| "tags": [ | |
| "Team Permissions" | |
| ], | |
| "summary": "Retrieve Team Permission object", | |
| "description": "Returns a particular Team Permission object.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TeamPermission" | |
| }, | |
| "example": { | |
| "unique_id": "5f9a92c2-ddf2-4e71-862c-b4bbe959df24", | |
| "account_permissions": [ | |
| "schedule_read", | |
| "member_read", | |
| "team_read", | |
| "sla_read", | |
| "incident_read", | |
| "incident_role_read", | |
| "escalation_policy_read", | |
| "tag_read", | |
| "service_read", | |
| "task_template_read", | |
| "priority_read" | |
| ] | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TeamPermission" | |
| }, | |
| "example": { | |
| "unique_id": "5f9a92c2-ddf2-4e71-862c-b4bbe959df24", | |
| "account_permissions": [ | |
| "schedule_read", | |
| "member_read", | |
| "team_read", | |
| "sla_read", | |
| "incident_read", | |
| "incident_role_read", | |
| "escalation_policy_read", | |
| "tag_read", | |
| "service_read", | |
| "task_template_read", | |
| "priority_read" | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": [ | |
| "Team Permissions" | |
| ], | |
| "summary": "Update the Team Permission object", | |
| "description": "Update the Team Permission object by setting the values of all the required parameters passed in the request body.", | |
| "requestBody": { | |
| "description": "Request body parameters to update the Team Permission object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TeamPermissionPayload" | |
| }, | |
| "example": { | |
| "account_permissions": [ | |
| "member_read", | |
| "schedule_read", | |
| "team_read", | |
| "sla_read", | |
| "incident_read" | |
| ] | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TeamPermissionPayload" | |
| }, | |
| "example": { | |
| "account_permissions": [ | |
| "member_read", | |
| "schedule_read", | |
| "team_read", | |
| "sla_read", | |
| "incident_read" | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TeamPermission" | |
| }, | |
| "example": { | |
| "unique_id": "5f9a92c2-ddf2-4e71-862c-b4bbe959df24", | |
| "account_permissions": [ | |
| "schedule_read", | |
| "member_read", | |
| "team_read", | |
| "sla_read", | |
| "incident_read", | |
| "incident_role_read", | |
| "escalation_policy_read", | |
| "tag_read", | |
| "service_read", | |
| "task_template_read", | |
| "priority_read" | |
| ] | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TeamPermission" | |
| }, | |
| "example": { | |
| "unique_id": "5f9a92c2-ddf2-4e71-862c-b4bbe959df24", | |
| "account_permissions": [ | |
| "schedule_read", | |
| "member_read", | |
| "team_read", | |
| "sla_read", | |
| "incident_read", | |
| "incident_role_read", | |
| "escalation_policy_read", | |
| "tag_read", | |
| "service_read", | |
| "task_template_read", | |
| "priority_read" | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/teams/{}/schedules/": { | |
| "parameters": [ | |
| { | |
| "name": "team_id", | |
| "in": "path", | |
| "description": "unique_id of the Team object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "post": { | |
| "tags": [ | |
| "Schedules" | |
| ], | |
| "summary": "Create the Schedule object", | |
| "description": "Create the Schedule object by setting the values of all the required parameters passed in the request body.", | |
| "requestBody": { | |
| "description": "Request body parameters to create the Schedule object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/SchedulePayload" | |
| }, | |
| "example": { | |
| "name": "Daily Schedule", | |
| "summary": "Daily on call schedule for modified production team", | |
| "time_zone": "Asia/Kolkata" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/SchedulePayload" | |
| }, | |
| "example": { | |
| "name": "Daily Schedule", | |
| "summary": "Daily on call schedule for modified production team", | |
| "time_zone": "Asia/Kolkata" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Schedule" | |
| }, | |
| "example": { | |
| "name": "Daily Schedule", | |
| "summary": "Daily on call schedule for modified production team", | |
| "description": "", | |
| "time_zone": "Asia/Kolkata", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "layers": [ ], | |
| "overrides": [ ], | |
| "unique_id": "dadcec8e-e4d7-4e76-8a24-d8d6c1278d1f" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Schedule" | |
| }, | |
| "example": { | |
| "name": "Daily Schedule", | |
| "summary": "Daily on call schedule for modified production team", | |
| "description": "", | |
| "time_zone": "Asia/Kolkata", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "layers": [ ], | |
| "overrides": [ ], | |
| "unique_id": "dadcec8e-e4d7-4e76-8a24-d8d6c1278d1f" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "get": { | |
| "tags": [ | |
| "Schedules" | |
| ], | |
| "summary": "List all Schedule objects", | |
| "description": "Returns a list of Schedule objects.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Schedule" | |
| }, | |
| "example": [ | |
| { | |
| "name": "Weekly Schedule", | |
| "summary": "Weekly on call schedule for modified production team.", | |
| "description": "", | |
| "time_zone": "Asia/Calcutta", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "layers": [ | |
| { | |
| "shift_length": 604800, | |
| "restrictions": [ | |
| { | |
| "duration": 14400, | |
| "start_day_of_week": 7, | |
| "start_time_of_day": "00:00:00", | |
| "unique_id": "35199b5e-a4ce-4456-8b97-2f3ee2083a85" | |
| } | |
| ], | |
| "name": "Schedule Layer 1", | |
| "users": [ | |
| { | |
| "user": "216bba3d-7268-4a8e-89e9-6", | |
| "position": 1, | |
| "unique_id": "d8772886-1812-4a03-9a48-051d34547cf4" | |
| }, | |
| { | |
| "user": "507dfda0-a1fd-40e5-943a-e", | |
| "position": 2, | |
| "unique_id": "8c3c8573-3e3c-442d-accd-4a62fee485e9" | |
| } | |
| ], | |
| "rotation_start_time": "2022-07-08T11:26:33Z", | |
| "rotation_end_time": "2023-07-15T11:26:33Z", | |
| "unique_id": "a5ec8d44-572b-4ecd-9935-078aef6a2837", | |
| "last_edited": "2022-07-08T11:28:47.218341Z", | |
| "restriction_type": 1, | |
| "is_active": true | |
| } | |
| ], | |
| "overrides": [ | |
| { | |
| "name": "Override for Anshul", | |
| "user": "507dfda0-a1fd-40e5-943a-e", | |
| "start_time": "2022-07-09T05:57:14Z", | |
| "end_time": "2022-07-10T05:57:14Z", | |
| "unique_id": "b4492ce7-7d6e-4ed1-8f41-e7c8bf4f4dfe" | |
| } | |
| ], | |
| "unique_id": "4a3025f3-836f-4d18-8923-7adfe5690d17" | |
| }, | |
| { | |
| "name": "Daily Schedule", | |
| "summary": "Daily on call schedule for modified production team", | |
| "description": "", | |
| "time_zone": "Asia/Kolkata", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "layers": [ ], | |
| "overrides": [ ], | |
| "unique_id": "dadcec8e-e4d7-4e76-8a24-d8d6c1278d1f" | |
| } | |
| ] | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Schedule" | |
| }, | |
| "example": [ | |
| { | |
| "name": "Weekly Schedule", | |
| "summary": "Weekly on call schedule for modified production team.", | |
| "description": "", | |
| "time_zone": "Asia/Calcutta", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "layers": [ | |
| { | |
| "shift_length": 604800, | |
| "restrictions": [ | |
| { | |
| "duration": 14400, | |
| "start_day_of_week": 7, | |
| "start_time_of_day": "00:00:00", | |
| "unique_id": "35199b5e-a4ce-4456-8b97-2f3ee2083a85" | |
| } | |
| ], | |
| "name": "Schedule Layer 1", | |
| "users": [ | |
| { | |
| "user": "216bba3d-7268-4a8e-89e9-6", | |
| "position": 1, | |
| "unique_id": "d8772886-1812-4a03-9a48-051d34547cf4" | |
| }, | |
| { | |
| "user": "507dfda0-a1fd-40e5-943a-e", | |
| "position": 2, | |
| "unique_id": "8c3c8573-3e3c-442d-accd-4a62fee485e9" | |
| } | |
| ], | |
| "rotation_start_time": "2022-07-08T11:26:33Z", | |
| "rotation_end_time": "2023-07-15T11:26:33Z", | |
| "unique_id": "a5ec8d44-572b-4ecd-9935-078aef6a2837", | |
| "last_edited": "2022-07-08T11:28:47.218341Z", | |
| "restriction_type": 1, | |
| "is_active": true | |
| } | |
| ], | |
| "overrides": [ | |
| { | |
| "name": "Override for Anshul", | |
| "user": "507dfda0-a1fd-40e5-943a-e", | |
| "start_time": "2022-07-09T05:57:14Z", | |
| "end_time": "2022-07-10T05:57:14Z", | |
| "unique_id": "b4492ce7-7d6e-4ed1-8f41-e7c8bf4f4dfe" | |
| } | |
| ], | |
| "unique_id": "4a3025f3-836f-4d18-8923-7adfe5690d17" | |
| }, | |
| { | |
| "name": "Daily Schedule", | |
| "summary": "Daily on call schedule for modified production team", | |
| "description": "", | |
| "time_zone": "Asia/Kolkata", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "layers": [ ], | |
| "overrides": [ ], | |
| "unique_id": "dadcec8e-e4d7-4e76-8a24-d8d6c1278d1f" | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/teams/{team_id}/schedules/{schedule_id}/": { | |
| "parameters": [ | |
| { | |
| "name": "team_id", | |
| "in": "path", | |
| "description": "unique_id of the Team object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| }, | |
| { | |
| "name": "schedule_id", | |
| "in": "path", | |
| "description": "unique_id of the Schedule object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "get": { | |
| "tags": [ | |
| "Schedules" | |
| ], | |
| "summary": "Retrieve the Schedule object", | |
| "description": "Retrieve the specified Schedule object.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Schedule" | |
| }, | |
| "example": { | |
| "name": "Weekly Schedule", | |
| "summary": "Weekly on call schedule for modified production team.", | |
| "description": "", | |
| "time_zone": "Asia/Calcutta", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "layers": [ | |
| { | |
| "shift_length": 604800, | |
| "restrictions": [ | |
| { | |
| "duration": 14400, | |
| "start_day_of_week": 7, | |
| "start_time_of_day": "00:00:00", | |
| "unique_id": "35199b5e-a4ce-4456-8b97-2f3ee2083a85" | |
| } | |
| ], | |
| "name": "Schedule Layer 1", | |
| "users": [ | |
| { | |
| "user": "216bba3d-7268-4a8e-89e9-6", | |
| "position": 1, | |
| "unique_id": "d8772886-1812-4a03-9a48-051d34547cf4" | |
| }, | |
| { | |
| "user": "507dfda0-a1fd-40e5-943a-e", | |
| "position": 2, | |
| "unique_id": "8c3c8573-3e3c-442d-accd-4a62fee485e9" | |
| } | |
| ], | |
| "rotation_start_time": "2022-07-08T11:26:33Z", | |
| "rotation_end_time": "2023-07-15T11:26:33Z", | |
| "unique_id": "a5ec8d44-572b-4ecd-9935-078aef6a2837", | |
| "last_edited": "2022-07-08T11:28:47.218341Z", | |
| "restriction_type": 1, | |
| "is_active": true | |
| } | |
| ], | |
| "overrides": [ | |
| { | |
| "name": "Override for Anshul", | |
| "user": "507dfda0-a1fd-40e5-943a-e", | |
| "start_time": "2022-07-09T05:57:14Z", | |
| "end_time": "2022-07-10T05:57:14Z", | |
| "unique_id": "b4492ce7-7d6e-4ed1-8f41-e7c8bf4f4dfe" | |
| } | |
| ], | |
| "unique_id": "4a3025f3-836f-4d18-8923-7adfe5690d17" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Schedule" | |
| }, | |
| "example": { | |
| "name": "Weekly Schedule", | |
| "summary": "Weekly on call schedule for modified production team.", | |
| "description": "", | |
| "time_zone": "Asia/Calcutta", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "layers": [ | |
| { | |
| "shift_length": 604800, | |
| "restrictions": [ | |
| { | |
| "duration": 14400, | |
| "start_day_of_week": 7, | |
| "start_time_of_day": "00:00:00", | |
| "unique_id": "35199b5e-a4ce-4456-8b97-2f3ee2083a85" | |
| } | |
| ], | |
| "name": "Schedule Layer 1", | |
| "users": [ | |
| { | |
| "user": "216bba3d-7268-4a8e-89e9-6", | |
| "position": 1, | |
| "unique_id": "d8772886-1812-4a03-9a48-051d34547cf4" | |
| }, | |
| { | |
| "user": "507dfda0-a1fd-40e5-943a-e", | |
| "position": 2, | |
| "unique_id": "8c3c8573-3e3c-442d-accd-4a62fee485e9" | |
| } | |
| ], | |
| "rotation_start_time": "2022-07-08T11:26:33Z", | |
| "rotation_end_time": "2023-07-15T11:26:33Z", | |
| "unique_id": "a5ec8d44-572b-4ecd-9935-078aef6a2837", | |
| "last_edited": "2022-07-08T11:28:47.218341Z", | |
| "restriction_type": 1, | |
| "is_active": true | |
| } | |
| ], | |
| "overrides": [ | |
| { | |
| "name": "Override for Anshul", | |
| "user": "507dfda0-a1fd-40e5-943a-e", | |
| "start_time": "2022-07-09T05:57:14Z", | |
| "end_time": "2022-07-10T05:57:14Z", | |
| "unique_id": "b4492ce7-7d6e-4ed1-8f41-e7c8bf4f4dfe" | |
| } | |
| ], | |
| "unique_id": "4a3025f3-836f-4d18-8923-7adfe5690d17" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": [ | |
| "Schedules" | |
| ], | |
| "summary": "Update the Schedule object", | |
| "description": "Updates the specified Schedule object by setting the values of the parameters passed in the request body.", | |
| "requestBody": { | |
| "description": "Schedule update payload", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/SchedulePayload" | |
| }, | |
| "example": { | |
| "name": "Modified weekly Schedule" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/SchedulePayload" | |
| }, | |
| "example": { | |
| "name": "Modified daily Schedule" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Schedule" | |
| }, | |
| "example": { | |
| "name": "Modified daily Schedule", | |
| "summary": "Daily on call schedule for modified production team", | |
| "description": "", | |
| "time_zone": "Asia/Kolkata", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "layers": [ ], | |
| "overrides": [ ], | |
| "unique_id": "dadcec8e-e4d7-4e76-8a24-d8d6c1278d1f" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Schedule" | |
| }, | |
| "example": { | |
| "name": "Modified daily Schedule", | |
| "summary": "Daily on call schedule for modified production team", | |
| "description": "", | |
| "time_zone": "Asia/Kolkata", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "layers": [ ], | |
| "overrides": [ ], | |
| "unique_id": "dadcec8e-e4d7-4e76-8a24-d8d6c1278d1f" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Schedules" | |
| ], | |
| "summary": "Delete the Schedule object", | |
| "description": "Delete the specified Schedule object permanently.", | |
| "responses": { | |
| "204": { | |
| "description": "Success" | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/v2/account/teams/{}/schedules/{}/overrides/": { | |
| "parameters": [ | |
| { | |
| "name": "team_id", | |
| "in": "path", | |
| "description": "unique_id of the Team object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| }, | |
| { | |
| "name": "schedule_id", | |
| "in": "path", | |
| "description": "unique_id of the Schedule object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "post": { | |
| "tags": [ | |
| "Schedule Overrides" | |
| ], | |
| "summary": "Create the Schedule Override object", | |
| "description": "Create the Schedule Override object by setting the values of all the required parameters passed in the request body. (Note - Rate limits are 1/sec and 20/minute)", | |
| "requestBody": { | |
| "description": "Request body parameters to create the Schedule Overrides object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ScheduleOverridePayload" | |
| }, | |
| "example": { | |
| "name": "Override for Michael", | |
| "user": "507dfda0-a1fd-40e5-943a-e", | |
| "start_time": "2022-07-09T05:57:14Z", | |
| "end_time": "2022-07-10T05:57:14Z" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ScheduleOverridePayload" | |
| }, | |
| "example": { | |
| "name": "Override for Michael", | |
| "user": "507dfda0-a1fd-40e5-943a-e", | |
| "start_time": "2022-07-09T05:57:14Z", | |
| "end_time": "2022-07-10T05:57:14Z" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ScheduleOverride" | |
| }, | |
| "example": { | |
| "name": "Override for Michael", | |
| "user": "507dfda0-a1fd-40e5-943a-e", | |
| "start_time": "2022-07-09T05:57:14Z", | |
| "end_time": "2022-07-10T05:57:14Z", | |
| "unique_id": "b4492ce7-7d6e-4ed1-8f41-e7c8bf4f4dfe" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ScheduleOverride" | |
| }, | |
| "example": { | |
| "name": "Override for Michael", | |
| "user": "507dfda0-a1fd-40e5-943a-e", | |
| "start_time": "2022-07-09T05:57:14Z", | |
| "end_time": "2022-07-10T05:57:14Z", | |
| "unique_id": "b4492ce7-7d6e-4ed1-8f41-e7c8bf4f4dfe" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "get": { | |
| "tags": [ | |
| "Schedule Overrides" | |
| ], | |
| "summary": "List all Schedule overrides objects", | |
| "description": "Returns a list of Schedule override objects with overridden users and their respective start and end times. refer to overridden_details object key (Note - Rate limits are 1/sec and 20/minute)", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ScheduleOverrideList" | |
| }, | |
| "example": [ | |
| { | |
| "name": "Override for Michael", | |
| "user": "507dfda0-a1fd-40e5-943a-e", | |
| "start_time": "2022-07-09T05:57:14Z", | |
| "end_time": "2022-07-10T05:57:14Z", | |
| "unique_id": "b4492ce7-7d6e-4ed1-8f41-e7c8bf4f4dfe", | |
| "overridden_details": { | |
| "-\"1e57f783-cbd6-4021-811f-e\"": [ | |
| { | |
| "start_time": 1725349884, | |
| "end_time": 1725388199 | |
| } | |
| ] | |
| } | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/teams/{}/escalation_policies/": { | |
| "parameters": [ | |
| { | |
| "name": "team_id", | |
| "in": "path", | |
| "description": "unique_id of the Team object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "post": { | |
| "tags": [ | |
| "Escalation Policies" | |
| ], | |
| "summary": "Create the Escalation Policy object", | |
| "description": "Create the Escalation Policy object by setting the values of all the required parameters passed in the request body.", | |
| "requestBody": { | |
| "description": "Request body parameters to create the Escalation Policy object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/EPPayload" | |
| }, | |
| "example": { | |
| "name": "Production Escalation Policy", | |
| "rules": [ | |
| { | |
| "delay": 2, | |
| "targets": [ | |
| { | |
| "target_type": 2, | |
| "target_id": "85b563c8-18d0-4668-9462-9" | |
| } | |
| ], | |
| "position": 1 | |
| } | |
| ] | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/EPPayload" | |
| }, | |
| "example": { | |
| "name": "Production Escalation Policy", | |
| "rules": [ | |
| { | |
| "delay": 2, | |
| "targets": [ | |
| { | |
| "target_type": 2, | |
| "target_id": "85b563c8-18d0-4668-9462-9" | |
| } | |
| ], | |
| "position": 1 | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/EP" | |
| }, | |
| "example": { | |
| "name": "Production Escalation Policy", | |
| "summary": "", | |
| "description": "", | |
| "rules": [ | |
| { | |
| "delay": 2, | |
| "targets": [ | |
| { | |
| "target_type": 2, | |
| "target_id": "85b563c8-18d0-4668-9462-9" | |
| } | |
| ], | |
| "position": 1, | |
| "unique_id": "32b594ec-72f6-4eeb-8024-ef25a8b9f97e" | |
| } | |
| ], | |
| "unique_id": "904cfcad-9fe1-4dc7-b578-ad0f5a2950fd", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "repeat_policy": 0, | |
| "move_to_next": true, | |
| "global_ep": false | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/EP" | |
| }, | |
| "example": { | |
| "name": "Production Escalation Policy", | |
| "summary": "", | |
| "description": "", | |
| "rules": [ | |
| { | |
| "delay": 2, | |
| "targets": [ | |
| { | |
| "target_type": 2, | |
| "target_id": "85b563c8-18d0-4668-9462-9" | |
| } | |
| ], | |
| "position": 1, | |
| "unique_id": "32b594ec-72f6-4eeb-8024-ef25a8b9f97e" | |
| } | |
| ], | |
| "unique_id": "904cfcad-9fe1-4dc7-b578-ad0f5a2950fd", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "repeat_policy": 0, | |
| "move_to_next": true, | |
| "global_ep": false | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "get": { | |
| "tags": [ | |
| "Escalation Policies" | |
| ], | |
| "summary": "List all Escalation Policy objects", | |
| "description": "Returns a list of Escalation Policy objects.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/EP" | |
| }, | |
| "example": [ | |
| { | |
| "name": "Default Escalation Policy", | |
| "summary": "This is the default escalation policy for this team", | |
| "description": "", | |
| "rules": [ | |
| { | |
| "delay": 0, | |
| "targets": [ | |
| { | |
| "target_type": 2, | |
| "target_id": "216bba3d-7268-4a8e-89e9-6" | |
| } | |
| ], | |
| "position": 1, | |
| "unique_id": "a857eb8b-28bf-4503-a1d5-a1d737c48fdc" | |
| } | |
| ], | |
| "unique_id": "19fdd4c3-0d4a-4a6e-9885-8c8d33ef1488", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "repeat_policy": 0, | |
| "move_to_next": true, | |
| "global_ep": false | |
| }, | |
| { | |
| "name": "Infra Escalation Policy", | |
| "summary": "", | |
| "description": "", | |
| "rules": [ | |
| { | |
| "delay": 0, | |
| "targets": [ | |
| { | |
| "target_type": 1, | |
| "target_id": "4a3025f3-836f-4d18-8923-7adfe5690d17" | |
| }, | |
| { | |
| "target_type": 2, | |
| "target_id": "507dfda0-a1fd-40e5-943a-e" | |
| }, | |
| { | |
| "target_type": 2, | |
| "target_id": "85b563c8-18d0-4668-9462-9" | |
| } | |
| ], | |
| "position": 1, | |
| "unique_id": "23077ffc-8529-4848-89d0-1a37bdf63d4e" | |
| }, | |
| { | |
| "delay": 4, | |
| "targets": [ | |
| { | |
| "target_type": 2, | |
| "target_id": "216bba3d-7268-4a8e-89e9-6" | |
| } | |
| ], | |
| "position": 2, | |
| "unique_id": "5298ba34-f23d-49a6-a4a2-814a7beb4b54" | |
| } | |
| ], | |
| "unique_id": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "repeat_policy": 2, | |
| "move_to_next": true, | |
| "global_ep": false | |
| }, | |
| { | |
| "name": "Production Escalation Policy", | |
| "summary": "", | |
| "description": "", | |
| "rules": [ | |
| { | |
| "delay": 2, | |
| "targets": [ | |
| { | |
| "target_type": 2, | |
| "target_id": "85b563c8-18d0-4668-9462-9" | |
| } | |
| ], | |
| "position": 1, | |
| "unique_id": "32b594ec-72f6-4eeb-8024-ef25a8b9f97e" | |
| } | |
| ], | |
| "unique_id": "904cfcad-9fe1-4dc7-b578-ad0f5a2950fd", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "repeat_policy": 0, | |
| "move_to_next": true, | |
| "global_ep": false | |
| } | |
| ] | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/EP" | |
| }, | |
| "example": [ | |
| { | |
| "name": "Default Escalation Policy", | |
| "summary": "This is the default escalation policy for this team", | |
| "description": "", | |
| "rules": [ | |
| { | |
| "delay": 0, | |
| "targets": [ | |
| { | |
| "target_type": 2, | |
| "target_id": "216bba3d-7268-4a8e-89e9-6" | |
| } | |
| ], | |
| "position": 1, | |
| "unique_id": "a857eb8b-28bf-4503-a1d5-a1d737c48fdc" | |
| } | |
| ], | |
| "unique_id": "19fdd4c3-0d4a-4a6e-9885-8c8d33ef1488", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "repeat_policy": 0, | |
| "move_to_next": true, | |
| "global_ep": false | |
| }, | |
| { | |
| "name": "Infra Escalation Policy", | |
| "summary": "", | |
| "description": "", | |
| "rules": [ | |
| { | |
| "delay": 0, | |
| "targets": [ | |
| { | |
| "target_type": 1, | |
| "target_id": "4a3025f3-836f-4d18-8923-7adfe5690d17" | |
| }, | |
| { | |
| "target_type": 2, | |
| "target_id": "507dfda0-a1fd-40e5-943a-e" | |
| }, | |
| { | |
| "target_type": 2, | |
| "target_id": "85b563c8-18d0-4668-9462-9" | |
| } | |
| ], | |
| "position": 1, | |
| "unique_id": "23077ffc-8529-4848-89d0-1a37bdf63d4e" | |
| }, | |
| { | |
| "delay": 4, | |
| "targets": [ | |
| { | |
| "target_type": 2, | |
| "target_id": "216bba3d-7268-4a8e-89e9-6" | |
| } | |
| ], | |
| "position": 2, | |
| "unique_id": "5298ba34-f23d-49a6-a4a2-814a7beb4b54" | |
| } | |
| ], | |
| "unique_id": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "repeat_policy": 2, | |
| "move_to_next": true, | |
| "global_ep": false | |
| }, | |
| { | |
| "name": "Production Escalation Policy", | |
| "summary": "", | |
| "description": "", | |
| "rules": [ | |
| { | |
| "delay": 2, | |
| "targets": [ | |
| { | |
| "target_type": 2, | |
| "target_id": "85b563c8-18d0-4668-9462-9" | |
| } | |
| ], | |
| "position": 1, | |
| "unique_id": "32b594ec-72f6-4eeb-8024-ef25a8b9f97e" | |
| } | |
| ], | |
| "unique_id": "904cfcad-9fe1-4dc7-b578-ad0f5a2950fd", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "repeat_policy": 0, | |
| "move_to_next": true, | |
| "global_ep": false | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/teams/{team_id}/escalation_policies/{escalation_policy_id}/": { | |
| "parameters": [ | |
| { | |
| "name": "team_id", | |
| "in": "path", | |
| "description": "unique_id of the Team object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| }, | |
| { | |
| "name": "escalation_policy_id", | |
| "in": "path", | |
| "description": "unique_id of the Escalation Policy object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "get": { | |
| "tags": [ | |
| "Escalation Policies" | |
| ], | |
| "summary": "Retrieve the Escalation Policy object", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/EP" | |
| }, | |
| "example": { | |
| "name": "Production Escalation Policy", | |
| "summary": "", | |
| "description": "", | |
| "rules": [ | |
| { | |
| "delay": 2, | |
| "targets": [ | |
| { | |
| "target_type": 2, | |
| "target_id": "85b563c8-18d0-4668-9462-9" | |
| } | |
| ], | |
| "position": 1, | |
| "unique_id": "32b594ec-72f6-4eeb-8024-ef25a8b9f97e" | |
| } | |
| ], | |
| "unique_id": "904cfcad-9fe1-4dc7-b578-ad0f5a2950fd", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "repeat_policy": 0, | |
| "move_to_next": true, | |
| "global_ep": false | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/EP" | |
| }, | |
| "example": { | |
| "name": "Production Escalation Policy", | |
| "summary": "", | |
| "description": "", | |
| "rules": [ | |
| { | |
| "delay": 2, | |
| "targets": [ | |
| { | |
| "target_type": 2, | |
| "target_id": "85b563c8-18d0-4668-9462-9" | |
| } | |
| ], | |
| "position": 1, | |
| "unique_id": "32b594ec-72f6-4eeb-8024-ef25a8b9f97e" | |
| } | |
| ], | |
| "unique_id": "904cfcad-9fe1-4dc7-b578-ad0f5a2950fd", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "repeat_policy": 0, | |
| "move_to_next": true, | |
| "global_ep": false | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": [ | |
| "Escalation Policies" | |
| ], | |
| "summary": "Update the Escalation Policy object", | |
| "description": "Updates the specified Escalation Policy object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.", | |
| "requestBody": { | |
| "description": "Request body parameters to update the Escalation Policy object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/EPPayload" | |
| }, | |
| "example": { | |
| "name": "Modified Production Escalation Policy", | |
| "rules": [ | |
| { | |
| "delay": 2, | |
| "targets": [ | |
| { | |
| "target_type": 2, | |
| "target_id": "85b563c8-18d0-4668-9462-9" | |
| } | |
| ], | |
| "position": 1 | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/EP" | |
| }, | |
| "example": { | |
| "name": "Modified Production Escalation Policy", | |
| "summary": "", | |
| "description": "", | |
| "rules": [ | |
| { | |
| "delay": 2, | |
| "targets": [ | |
| { | |
| "target_type": 2, | |
| "target_id": "85b563c8-18d0-4668-9462-9" | |
| } | |
| ], | |
| "position": 1, | |
| "unique_id": "f15f0044-25a1-4c60-888a-c7f1a6b7d4ce" | |
| } | |
| ], | |
| "unique_id": "904cfcad-9fe1-4dc7-b578-ad0f5a2950fd", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "repeat_policy": 0, | |
| "move_to_next": true, | |
| "global_ep": false | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/EP" | |
| }, | |
| "example": { | |
| "name": "Modified Production Escalation Policy", | |
| "summary": "", | |
| "description": "", | |
| "rules": [ | |
| { | |
| "delay": 2, | |
| "targets": [ | |
| { | |
| "target_type": 2, | |
| "target_id": "85b563c8-18d0-4668-9462-9" | |
| } | |
| ], | |
| "position": 1, | |
| "unique_id": "f15f0044-25a1-4c60-888a-c7f1a6b7d4ce" | |
| } | |
| ], | |
| "unique_id": "904cfcad-9fe1-4dc7-b578-ad0f5a2950fd", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "repeat_policy": 0, | |
| "move_to_next": true, | |
| "global_ep": false | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Escalation Policies" | |
| ], | |
| "summary": "Delete the Escalation Policy object", | |
| "description": "Delete the specified Escalation Policy object permanently.", | |
| "responses": { | |
| "204": { | |
| "description": "Success" | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/teams/{}/services/": { | |
| "parameters": [ | |
| { | |
| "name": "team_id", | |
| "in": "path", | |
| "description": "unique_id of the Team object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "post": { | |
| "tags": [ | |
| "Services" | |
| ], | |
| "summary": "Create the Service object", | |
| "description": "Create the Service object by setting the values of all the required parameters passed in the request body.", | |
| "requestBody": { | |
| "description": "Request body parameters to create the Service object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ServicePayload" | |
| }, | |
| "example": { | |
| "name": "Production Service", | |
| "description": "This is the description for Production Service", | |
| "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "task_template": "8d2640ca-c6ef-45f0-be5f-61dedcf85032", | |
| "status": 1, | |
| "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ServicePayload" | |
| }, | |
| "example": { | |
| "name": "Production Service", | |
| "description": "This is the description for Production Service", | |
| "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "task_template": "8d2640ca-c6ef-45f0-be5f-61dedcf85032", | |
| "status": 1, | |
| "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ServicePostPut" | |
| }, | |
| "example": { | |
| "name": "Production Service", | |
| "creation_date": "2022-07-08T12:38:50.511179Z", | |
| "summary": "", | |
| "description": "This is the description for Production Service", | |
| "unique_id": "3605fdfb-07fb-4a6c-bd05-9e557dc4ec6e", | |
| "auto_resolve_timeout": 0, | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "task_template": "8d2640ca-c6ef-45f0-be5f-61dedcf85032", | |
| "acknowledgement_timeout": 0, | |
| "acknowledgement_timeout_enabled": false, | |
| "status": 1, | |
| "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "collation_time": 0, | |
| "collation": 0, | |
| "under_maintenance": false | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ServicePostPut" | |
| }, | |
| "example": { | |
| "name": "Production Service", | |
| "creation_date": "2022-07-08T12:38:50.511179Z", | |
| "summary": "", | |
| "description": "This is the description for Production Service", | |
| "unique_id": "3605fdfb-07fb-4a6c-bd05-9e557dc4ec6e", | |
| "auto_resolve_timeout": 0, | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "task_template": "8d2640ca-c6ef-45f0-be5f-61dedcf85032", | |
| "acknowledgement_timeout": 0, | |
| "acknowledgement_timeout_enabled": false, | |
| "status": 1, | |
| "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "collation_time": 0, | |
| "collation": 0, | |
| "under_maintenance": false | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "get": { | |
| "tags": [ | |
| "Services" | |
| ], | |
| "summary": "List all Service objects", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ServiceGet" | |
| }, | |
| "example": [ | |
| { | |
| "name": "Infra Service", | |
| "creation_date": "2022-07-08T12:31:37.429973Z", | |
| "summary": "", | |
| "description": "This is the description for Infra Service", | |
| "unique_id": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "auto_resolve_timeout": 0, | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "task_template": "8d2640ca-c6ef-45f0-be5f-61dedcf85032", | |
| "acknowledgement_timeout": 0, | |
| "acknowledgement_timeout_enabled": false, | |
| "status": 1, | |
| "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "under_maintenance": false, | |
| "collation": 1, | |
| "collation_time": 2 | |
| }, | |
| { | |
| "name": "Production Service", | |
| "creation_date": "2022-07-08T12:38:50.511179Z", | |
| "summary": "", | |
| "description": "This is the description for Production Service", | |
| "unique_id": "3605fdfb-07fb-4a6c-bd05-9e557dc4ec6e", | |
| "auto_resolve_timeout": 0, | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "task_template": "8d2640ca-c6ef-45f0-be5f-61dedcf85032", | |
| "acknowledgement_timeout": 0, | |
| "acknowledgement_timeout_enabled": false, | |
| "status": 1, | |
| "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "under_maintenance": false, | |
| "collation": 0, | |
| "collation_time": 0 | |
| } | |
| ] | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ServiceGet" | |
| }, | |
| "example": [ | |
| { | |
| "name": "Infra Service", | |
| "creation_date": "2022-07-08T12:31:37.429973Z", | |
| "summary": "", | |
| "description": "This is the description for Infra Service", | |
| "unique_id": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "auto_resolve_timeout": 0, | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "task_template": "8d2640ca-c6ef-45f0-be5f-61dedcf85032", | |
| "acknowledgement_timeout": 0, | |
| "acknowledgement_timeout_enabled": false, | |
| "status": 1, | |
| "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "under_maintenance": false, | |
| "collation": 1, | |
| "collation_time": 2 | |
| }, | |
| { | |
| "name": "Production Service", | |
| "creation_date": "2022-07-08T12:38:50.511179Z", | |
| "summary": "", | |
| "description": "This is the description for Production Service", | |
| "unique_id": "3605fdfb-07fb-4a6c-bd05-9e557dc4ec6e", | |
| "auto_resolve_timeout": 0, | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "task_template": "8d2640ca-c6ef-45f0-be5f-61dedcf85032", | |
| "acknowledgement_timeout": 0, | |
| "acknowledgement_timeout_enabled": false, | |
| "status": 1, | |
| "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "under_maintenance": false, | |
| "collation": 0, | |
| "collation_time": 0 | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/teams/{team_id}/services/{service_id}/": { | |
| "parameters": [ | |
| { | |
| "name": "team_id", | |
| "in": "path", | |
| "description": "unique_id of the Team object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| }, | |
| { | |
| "name": "service_id", | |
| "in": "path", | |
| "description": "unique_id of the Service object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "get": { | |
| "tags": [ | |
| "Services" | |
| ], | |
| "summary": "Retrieve the Service object", | |
| "description": "Retrieve the specified Service object.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ServiceGet" | |
| }, | |
| "example": { | |
| "name": "Production Service", | |
| "creation_date": "2022-07-08T12:38:50.511179Z", | |
| "summary": "", | |
| "description": "This is the description for Production Service", | |
| "unique_id": "3605fdfb-07fb-4a6c-bd05-9e557dc4ec6e", | |
| "auto_resolve_timeout": 0, | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "task_template": "8d2640ca-c6ef-45f0-be5f-61dedcf85032", | |
| "acknowledgement_timeout": 0, | |
| "acknowledgement_timeout_enabled": false, | |
| "status": 1, | |
| "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "under_maintenance": false, | |
| "collation": 0, | |
| "collation_time": 0 | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ServiceGet" | |
| }, | |
| "example": { | |
| "name": "Production Service", | |
| "creation_date": "2022-07-08T12:38:50.511179Z", | |
| "summary": "", | |
| "description": "This is the description for Production Service", | |
| "unique_id": "3605fdfb-07fb-4a6c-bd05-9e557dc4ec6e", | |
| "auto_resolve_timeout": 0, | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "task_template": "8d2640ca-c6ef-45f0-be5f-61dedcf85032", | |
| "acknowledgement_timeout": 0, | |
| "status": 1, | |
| "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "under_maintenance": false, | |
| "collation": 0, | |
| "collation_time": 0 | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": [ | |
| "Services" | |
| ], | |
| "summary": "Update the Service object", | |
| "description": "Updates the specified Service object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.", | |
| "requestBody": { | |
| "description": "Request body parameters to update the Service object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ServicePayload" | |
| }, | |
| "example": { | |
| "name": "Modified Production Service", | |
| "description": "This is the description for Production Service", | |
| "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "task_template": "8d2640ca-c6ef-45f0-be5f-61dedcf85032", | |
| "status": 1, | |
| "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ServicePayload" | |
| }, | |
| "example": { | |
| "name": "Modified Production Service", | |
| "description": "This is the description for Production Service", | |
| "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "task_template": "8d2640ca-c6ef-45f0-be5f-61dedcf85032", | |
| "status": 1, | |
| "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ServicePostPut" | |
| }, | |
| "example": { | |
| "name": "Modified Production Service", | |
| "creation_date": "2022-07-08T12:38:50.511179Z", | |
| "summary": "", | |
| "description": "This is the description for Production Service", | |
| "unique_id": "3605fdfb-07fb-4a6c-bd05-9e557dc4ec6e", | |
| "auto_resolve_timeout": 0, | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "task_template": "8d2640ca-c6ef-45f0-be5f-61dedcf85032", | |
| "acknowledgement_timeout": 0, | |
| "status": 1, | |
| "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "collation_time": 0, | |
| "collation": 0, | |
| "under_maintenance": false | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/ServicePostPut" | |
| }, | |
| "example": { | |
| "name": "Modified Production Service", | |
| "creation_date": "2022-07-08T12:38:50.511179Z", | |
| "summary": "", | |
| "description": "This is the description for Production Service", | |
| "unique_id": "3605fdfb-07fb-4a6c-bd05-9e557dc4ec6e", | |
| "auto_resolve_timeout": 0, | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "task_template": "8d2640ca-c6ef-45f0-be5f-61dedcf85032", | |
| "acknowledgement_timeout": 0, | |
| "status": 1, | |
| "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "collation_time": 0, | |
| "collation": 0, | |
| "under_maintenance": false | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Services" | |
| ], | |
| "summary": "Delete the Service object", | |
| "description": "Delete the specified Service object permanently.", | |
| "responses": { | |
| "204": { | |
| "description": "Success" | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/teams/{}/services/{service_id}/integrations/": { | |
| "parameters": [ | |
| { | |
| "name": "team_id", | |
| "in": "path", | |
| "description": "unique_id of the Team object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| }, | |
| { | |
| "name": "service_id", | |
| "in": "path", | |
| "description": "unique_id of the Service object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "post": { | |
| "tags": [ | |
| "Integrations" | |
| ], | |
| "summary": "Create the Integration object", | |
| "description": "Create the Integration object by setting the values of all the required parameters passed in the request body.", | |
| "requestBody": { | |
| "description": "Request body parameters to create the Integration object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IntegrationPayload" | |
| }, | |
| "example": { | |
| "name": "Infra custom Integration", | |
| "summary": "This is the summary for Infra custom Integration", | |
| "application": "07c84d47-7e71-49ec-b781-1cc81a78086e" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IntegrationPayload" | |
| }, | |
| "example": { | |
| "name": "Infra custom Integration", | |
| "summary": "This is the summary for Infra custom Integration", | |
| "application": "07c84d47-7e71-49ec-b781-1cc81a78086e" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Integration" | |
| }, | |
| "example": { | |
| "name": "Infra custom Integration", | |
| "creation_date": "2022-07-08T12:52:22.906327Z", | |
| "summary": "This is the summary for Infra custom Integration", | |
| "unique_id": "72da1133-a471-4e70-95f3-ce3a5650e9fd", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "application": "07c84d47-7e71-49ec-b781-1cc81a78086e", | |
| "application_reference": { | |
| "name": "Cloudwatch V2", | |
| "icon_url": "Cloudwatch V2", | |
| "summary": "Cloudwatch V2", | |
| "description": "Cloudwatch V2", | |
| "unique_id": "07c84d47-7e71-49ec-b781-1cc81a78086e", | |
| "availability_plan_id": 1, | |
| "setup_instructions": "<IntegrationURL/>", | |
| "extension": "cloudwatch_v2", | |
| "application_type": 0, | |
| "categories": "API,Analytics", | |
| "documentation_link": "Cloudwatch V2" | |
| }, | |
| "integration_key": "5f306dae-b327-4ba9-8f3a-ab4cffd57645", | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "is_enabled": true, | |
| "create_incidents_for": 1, | |
| "integration_type": 0, | |
| "default_urgency": 1, | |
| "webhook_url": "https://www.zenduty.com/api/integration/cloudwatch_v2/5f306dae-b327-4ba9-8f3a-ab4cffd57645/" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Integration" | |
| }, | |
| "example": { | |
| "name": "Infra custom Integration", | |
| "creation_date": "2022-07-08T12:52:22.906327Z", | |
| "summary": "This is the summary for Infra custom Integration", | |
| "unique_id": "72da1133-a471-4e70-95f3-ce3a5650e9fd", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "application": "07c84d47-7e71-49ec-b781-1cc81a78086e", | |
| "application_reference": { | |
| "name": "Cloudwatch V2", | |
| "icon_url": "Cloudwatch V2", | |
| "summary": "Cloudwatch V2", | |
| "description": "Cloudwatch V2", | |
| "unique_id": "07c84d47-7e71-49ec-b781-1cc81a78086e", | |
| "availability_plan_id": 1, | |
| "setup_instructions": "<IntegrationURL/>", | |
| "extension": "cloudwatch_v2", | |
| "application_type": 0, | |
| "categories": "API,Analytics", | |
| "documentation_link": "Cloudwatch V2" | |
| }, | |
| "integration_key": "5f306dae-b327-4ba9-8f3a-ab4cffd57645", | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "is_enabled": true, | |
| "create_incidents_for": 1, | |
| "integration_type": 0, | |
| "default_urgency": 1, | |
| "webhook_url": "https://www.zenduty.com/api/integration/cloudwatch_v2/5f306dae-b327-4ba9-8f3a-ab4cffd57645/" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "get": { | |
| "tags": [ | |
| "Integrations" | |
| ], | |
| "summary": "List all Integration objects", | |
| "description": "Returns a list of Integration objects. The Integration objects are sorted by creation_date, with the most recent Integration object appearing last.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Integration" | |
| }, | |
| "example": [ | |
| { | |
| "name": "Cloudwatch V2", | |
| "creation_date": "2022-07-08T12:31:37.435711Z", | |
| "summary": "Edit summary for this integration", | |
| "unique_id": "de8830c5-8596-4ab6-937e-8d5df08499d8", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "application": "07c84d47-7e71-49ec-b781-1cc81a78086e", | |
| "application_reference": { | |
| "name": "Cloudwatch V2", | |
| "icon_url": "Cloudwatch V2", | |
| "summary": "Cloudwatch V2", | |
| "description": "Cloudwatch V2", | |
| "unique_id": "07c84d47-7e71-49ec-b781-1cc81a78086e", | |
| "availability_plan_id": 1, | |
| "setup_instructions": "<IntegrationURL/>", | |
| "extension": "cloudwatch_v2", | |
| "application_type": 0, | |
| "categories": "API,Analytics", | |
| "documentation_link": "Cloudwatch V2" | |
| }, | |
| "integration_key": "bf167d3d-93dc-43b6-9066-a10b0bafcc09", | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "is_enabled": true, | |
| "create_incidents_for": 1, | |
| "integration_type": 0, | |
| "default_urgency": 1, | |
| "webhook_url": "https://www.zenduty.com/api/integration/cloudwatch_v2/bf167d3d-93dc-43b6-9066-a10b0bafcc09/" | |
| }, | |
| { | |
| "name": "Conference bridge", | |
| "creation_date": "2022-07-08T12:31:37.441939Z", | |
| "summary": "Edit summary for this integration", | |
| "unique_id": "38d5f0f9-a2d4-44dd-bc8c-4f2fdeea284e", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "application": "bbfdaa85-a1c1-4d0a-b59a-0e24f081d237", | |
| "application_reference": { | |
| "name": "Conference bridge", | |
| "icon_url": "https://www.softexia.com/wp-content/uploads/2020/03/ZOOM_logo.png", | |
| "summary": "Conference bridge", | |
| "description": "Conference bridge", | |
| "unique_id": "bbfdaa85-a1c1-4d0a-b59a-0e24f081d237", | |
| "availability_plan_id": 1, | |
| "setup_instructions": "Conference bridge", | |
| "extension": "conf", | |
| "application_type": 1, | |
| "categories": "API,Analytics,Collaboration", | |
| "documentation_link": "http://docs.zenduty.com/" | |
| }, | |
| "integration_key": "9efb306f-49b2-4b76-a428-845c7782deed", | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "is_enabled": true, | |
| "create_incidents_for": 1, | |
| "integration_type": 0, | |
| "default_urgency": 1, | |
| "webhook_url": "https://www.zenduty.com/api/integration/conf/9efb306f-49b2-4b76-a428-845c7782deed/" | |
| }, | |
| { | |
| "name": "Jira (2-way)", | |
| "creation_date": "2022-07-08T12:31:37.448374Z", | |
| "summary": "Edit summary for this integration", | |
| "unique_id": "c6a8fdf5-51a5-42a2-b3c9-c2d74b870e71", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "application": "0625ca3a-b064-45d0-9438-ff09953ba7c2", | |
| "application_reference": { | |
| "name": "Jira (2-way)", | |
| "icon_url": "https://images.squarespace-cdn.com/content/v1/5dc1ccd7e0292e070ef93a24/1582586865629-PN8VT9EY3DPJSTYL46AC/jira-small%402x.png?format=300w", | |
| "summary": "Sample jira 2way integration", | |
| "description": "Sample jira 2way integration", | |
| "unique_id": "0625ca3a-b064-45d0-9438-ff09953ba7c2", | |
| "availability_plan_id": 1, | |
| "setup_instructions": "https://docs.zenduty.com/docs/jira", | |
| "extension": "jiracloud", | |
| "application_type": 1, | |
| "categories": "API,Popular", | |
| "documentation_link": "https://docs.zenduty.com/docs/jira" | |
| }, | |
| "integration_key": "5eb0fd9b-da65-4f36-8dff-f32fdd4dfdc9", | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "is_enabled": true, | |
| "create_incidents_for": 1, | |
| "integration_type": 0, | |
| "default_urgency": 1, | |
| "webhook_url": "https://www.zenduty.com/api/integration/jiracloud/5eb0fd9b-da65-4f36-8dff-f32fdd4dfdc9/" | |
| }, | |
| { | |
| "name": "Zoom", | |
| "creation_date": "2022-07-08T12:31:37.453423Z", | |
| "summary": "Edit summary for this integration", | |
| "unique_id": "faa5594e-aea5-4c5a-9d2b-846c02bd8cf9", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "application": "41dc6d06-b33e-406d-a11f-efb11b74243c", | |
| "application_reference": { | |
| "name": "Zoom", | |
| "icon_url": "https://pbs.twimg.com/media/EUjGOkTUEAAeKUL?format=png", | |
| "summary": "Zoom Outgoing", | |
| "description": "Zoom Outgoing", | |
| "unique_id": "41dc6d06-b33e-406d-a11f-efb11b74243c", | |
| "availability_plan_id": 1, | |
| "setup_instructions": "Some setup instructions", | |
| "extension": "zoom", | |
| "application_type": 1, | |
| "categories": "Popular,APM", | |
| "documentation_link": "https://docs.zenduty.com" | |
| }, | |
| "integration_key": "181c2f90-a04a-41e5-a7ca-a16d68296e82", | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "is_enabled": true, | |
| "create_incidents_for": 1, | |
| "integration_type": 0, | |
| "default_urgency": 1, | |
| "webhook_url": "https://www.zenduty.com/api/integration/zoom/181c2f90-a04a-41e5-a7ca-a16d68296e82/" | |
| }, | |
| { | |
| "name": "Infra custom Integration", | |
| "creation_date": "2022-07-08T12:52:22.906327Z", | |
| "summary": "This is the summary for Infra custom Integration", | |
| "unique_id": "72da1133-a471-4e70-95f3-ce3a5650e9fd", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "application": "07c84d47-7e71-49ec-b781-1cc81a78086e", | |
| "application_reference": { | |
| "name": "Cloudwatch V2", | |
| "icon_url": "Cloudwatch V2", | |
| "summary": "Cloudwatch V2", | |
| "description": "Cloudwatch V2", | |
| "unique_id": "07c84d47-7e71-49ec-b781-1cc81a78086e", | |
| "availability_plan_id": 1, | |
| "setup_instructions": "<IntegrationURL/>", | |
| "extension": "cloudwatch_v2", | |
| "application_type": 0, | |
| "categories": "API,Analytics", | |
| "documentation_link": "Cloudwatch V2" | |
| }, | |
| "integration_key": "5f306dae-b327-4ba9-8f3a-ab4cffd57645", | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "is_enabled": true, | |
| "create_incidents_for": 1, | |
| "integration_type": 0, | |
| "default_urgency": 1, | |
| "webhook_url": "https://www.zenduty.com/api/integration/cloudwatch_v2/5f306dae-b327-4ba9-8f3a-ab4cffd57645/" | |
| } | |
| ] | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Integration" | |
| }, | |
| "example": [ | |
| { | |
| "name": "Cloudwatch V2", | |
| "creation_date": "2022-07-08T12:31:37.435711Z", | |
| "summary": "Edit summary for this integration", | |
| "unique_id": "de8830c5-8596-4ab6-937e-8d5df08499d8", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "application": "07c84d47-7e71-49ec-b781-1cc81a78086e", | |
| "application_reference": { | |
| "name": "Cloudwatch V2", | |
| "icon_url": "Cloudwatch V2", | |
| "summary": "Cloudwatch V2", | |
| "description": "Cloudwatch V2", | |
| "unique_id": "07c84d47-7e71-49ec-b781-1cc81a78086e", | |
| "availability_plan_id": 1, | |
| "setup_instructions": "<IntegrationURL/>", | |
| "extension": "cloudwatch_v2", | |
| "application_type": 0, | |
| "categories": "API,Analytics", | |
| "documentation_link": "Cloudwatch V2" | |
| }, | |
| "integration_key": "bf167d3d-93dc-43b6-9066-a10b0bafcc09", | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "is_enabled": true, | |
| "create_incidents_for": 1, | |
| "integration_type": 0, | |
| "default_urgency": 1, | |
| "webhook_url": "https://www.zenduty.com/api/integration/cloudwatch_v2/bf167d3d-93dc-43b6-9066-a10b0bafcc09/" | |
| }, | |
| { | |
| "name": "Conference bridge", | |
| "creation_date": "2022-07-08T12:31:37.441939Z", | |
| "summary": "Edit summary for this integration", | |
| "unique_id": "38d5f0f9-a2d4-44dd-bc8c-4f2fdeea284e", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "application": "bbfdaa85-a1c1-4d0a-b59a-0e24f081d237", | |
| "application_reference": { | |
| "name": "Conference bridge", | |
| "icon_url": "https://www.softexia.com/wp-content/uploads/2020/03/ZOOM_logo.png", | |
| "summary": "Conference bridge", | |
| "description": "Conference bridge", | |
| "unique_id": "bbfdaa85-a1c1-4d0a-b59a-0e24f081d237", | |
| "availability_plan_id": 1, | |
| "setup_instructions": "Conference bridge", | |
| "extension": "conf", | |
| "application_type": 1, | |
| "categories": "API,Analytics,Collaboration", | |
| "documentation_link": "http://docs.zenduty.com/" | |
| }, | |
| "integration_key": "9efb306f-49b2-4b76-a428-845c7782deed", | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "is_enabled": true, | |
| "create_incidents_for": 1, | |
| "integration_type": 0, | |
| "default_urgency": 1, | |
| "webhook_url": "https://www.zenduty.com/api/integration/conf/9efb306f-49b2-4b76-a428-845c7782deed/" | |
| }, | |
| { | |
| "name": "Jira (2-way)", | |
| "creation_date": "2022-07-08T12:31:37.448374Z", | |
| "summary": "Edit summary for this integration", | |
| "unique_id": "c6a8fdf5-51a5-42a2-b3c9-c2d74b870e71", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "application": "0625ca3a-b064-45d0-9438-ff09953ba7c2", | |
| "application_reference": { | |
| "name": "Jira (2-way)", | |
| "icon_url": "https://images.squarespace-cdn.com/content/v1/5dc1ccd7e0292e070ef93a24/1582586865629-PN8VT9EY3DPJSTYL46AC/jira-small%402x.png?format=300w", | |
| "summary": "Sample jira 2way integration", | |
| "description": "Sample jira 2way integration", | |
| "unique_id": "0625ca3a-b064-45d0-9438-ff09953ba7c2", | |
| "availability_plan_id": 1, | |
| "setup_instructions": "https://docs.zenduty.com/docs/jira", | |
| "extension": "jiracloud", | |
| "application_type": 1, | |
| "categories": "API,Popular", | |
| "documentation_link": "https://docs.zenduty.com/docs/jira" | |
| }, | |
| "integration_key": "5eb0fd9b-da65-4f36-8dff-f32fdd4dfdc9", | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "is_enabled": true, | |
| "create_incidents_for": 1, | |
| "integration_type": 0, | |
| "default_urgency": 1, | |
| "webhook_url": "https://www.zenduty.com/api/integration/jiracloud/5eb0fd9b-da65-4f36-8dff-f32fdd4dfdc9/" | |
| }, | |
| { | |
| "name": "Zoom", | |
| "creation_date": "2022-07-08T12:31:37.453423Z", | |
| "summary": "Edit summary for this integration", | |
| "unique_id": "faa5594e-aea5-4c5a-9d2b-846c02bd8cf9", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "application": "41dc6d06-b33e-406d-a11f-efb11b74243c", | |
| "application_reference": { | |
| "name": "Zoom", | |
| "icon_url": "https://pbs.twimg.com/media/EUjGOkTUEAAeKUL?format=png", | |
| "summary": "Zoom Outgoing", | |
| "description": "Zoom Outgoing", | |
| "unique_id": "41dc6d06-b33e-406d-a11f-efb11b74243c", | |
| "availability_plan_id": 1, | |
| "setup_instructions": "Some setup instructions", | |
| "extension": "zoom", | |
| "application_type": 1, | |
| "categories": "Popular,APM", | |
| "documentation_link": "https://docs.zenduty.com" | |
| }, | |
| "integration_key": "181c2f90-a04a-41e5-a7ca-a16d68296e82", | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "is_enabled": true, | |
| "create_incidents_for": 1, | |
| "integration_type": 0, | |
| "default_urgency": 1, | |
| "webhook_url": "https://www.zenduty.com/api/integration/zoom/181c2f90-a04a-41e5-a7ca-a16d68296e82/" | |
| }, | |
| { | |
| "name": "Infra custom Integration", | |
| "creation_date": "2022-07-08T12:52:22.906327Z", | |
| "summary": "This is the summary for Infra custom Integration", | |
| "unique_id": "72da1133-a471-4e70-95f3-ce3a5650e9fd", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "application": "07c84d47-7e71-49ec-b781-1cc81a78086e", | |
| "application_reference": { | |
| "name": "Cloudwatch V2", | |
| "icon_url": "Cloudwatch V2", | |
| "summary": "Cloudwatch V2", | |
| "description": "Cloudwatch V2", | |
| "unique_id": "07c84d47-7e71-49ec-b781-1cc81a78086e", | |
| "availability_plan_id": 1, | |
| "setup_instructions": "<IntegrationURL/>", | |
| "extension": "cloudwatch_v2", | |
| "application_type": 0, | |
| "categories": "API,Analytics", | |
| "documentation_link": "Cloudwatch V2" | |
| }, | |
| "integration_key": "5f306dae-b327-4ba9-8f3a-ab4cffd57645", | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "is_enabled": true, | |
| "create_incidents_for": 1, | |
| "integration_type": 0, | |
| "default_urgency": 1, | |
| "webhook_url": "https://www.zenduty.com/api/integration/cloudwatch_v2/5f306dae-b327-4ba9-8f3a-ab4cffd57645/" | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/teams/{team_id}/services/{service_id}/integrations/{integration_id}/": { | |
| "parameters": [ | |
| { | |
| "name": "team_id", | |
| "in": "path", | |
| "description": "unique_id of the Team object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| }, | |
| { | |
| "name": "service_id", | |
| "in": "path", | |
| "description": "unique_id of the Service object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| }, | |
| { | |
| "name": "integration_id", | |
| "in": "path", | |
| "description": "unique_id of the Integration object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "get": { | |
| "tags": [ | |
| "Integrations" | |
| ], | |
| "summary": "Retrieve the Integration object", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Integration" | |
| }, | |
| "example": { | |
| "name": "Infra custom Integration", | |
| "creation_date": "2022-07-08T12:52:22.906327Z", | |
| "summary": "This is the summary for Infra custom Integration", | |
| "unique_id": "72da1133-a471-4e70-95f3-ce3a5650e9fd", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "application": "07c84d47-7e71-49ec-b781-1cc81a78086e", | |
| "application_reference": { | |
| "name": "Cloudwatch V2", | |
| "icon_url": "Cloudwatch V2", | |
| "summary": "Cloudwatch V2", | |
| "description": "Cloudwatch V2", | |
| "unique_id": "07c84d47-7e71-49ec-b781-1cc81a78086e", | |
| "availability_plan_id": 1, | |
| "setup_instructions": "<IntegrationURL/>", | |
| "extension": "cloudwatch_v2", | |
| "application_type": 0, | |
| "categories": "API,Analytics", | |
| "documentation_link": "Cloudwatch V2" | |
| }, | |
| "integration_key": "5f306dae-b327-4ba9-8f3a-ab4cffd57645", | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "is_enabled": true, | |
| "create_incidents_for": 1, | |
| "integration_type": 0, | |
| "default_urgency": 1, | |
| "webhook_url": "https://www.zenduty.com/api/integration/cloudwatch_v2/5f306dae-b327-4ba9-8f3a-ab4cffd57645/" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Integration" | |
| }, | |
| "example": { | |
| "name": "Infra custom Integration", | |
| "creation_date": "2022-07-08T12:52:22.906327Z", | |
| "summary": "This is the summary for Infra custom Integration", | |
| "unique_id": "72da1133-a471-4e70-95f3-ce3a5650e9fd", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "application": "07c84d47-7e71-49ec-b781-1cc81a78086e", | |
| "application_reference": { | |
| "name": "Cloudwatch V2", | |
| "icon_url": "Cloudwatch V2", | |
| "summary": "Cloudwatch V2", | |
| "description": "Cloudwatch V2", | |
| "unique_id": "07c84d47-7e71-49ec-b781-1cc81a78086e", | |
| "availability_plan_id": 1, | |
| "setup_instructions": "<IntegrationURL/>", | |
| "extension": "cloudwatch_v2", | |
| "application_type": 0, | |
| "categories": "API,Analytics", | |
| "documentation_link": "Cloudwatch V2" | |
| }, | |
| "integration_key": "5f306dae-b327-4ba9-8f3a-ab4cffd57645", | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "is_enabled": true, | |
| "create_incidents_for": 1, | |
| "integration_type": 0, | |
| "default_urgency": 1, | |
| "webhook_url": "https://www.zenduty.com/api/integration/cloudwatch_v2/5f306dae-b327-4ba9-8f3a-ab4cffd57645/" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": [ | |
| "Integrations" | |
| ], | |
| "summary": "Update the Integration object", | |
| "description": "Updates the specified Integration object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.", | |
| "requestBody": { | |
| "description": "Request body parameters to update the Integration object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IntegrationPayload" | |
| }, | |
| "example": { | |
| "name": "Modified Infra custom Integration", | |
| "application": "07c84d47-7e71-49ec-b781-1cc81a78086e" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Integration" | |
| }, | |
| "example": { | |
| "name": "Modified Infra custom Integration", | |
| "creation_date": "2022-07-08T12:52:22.906327Z", | |
| "summary": "This is the summary for Infra custom Integration", | |
| "unique_id": "72da1133-a471-4e70-95f3-ce3a5650e9fd", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "application": "07c84d47-7e71-49ec-b781-1cc81a78086e", | |
| "application_reference": { | |
| "name": "Cloudwatch V2", | |
| "icon_url": "Cloudwatch V2", | |
| "summary": "Cloudwatch V2", | |
| "description": "Cloudwatch V2", | |
| "unique_id": "07c84d47-7e71-49ec-b781-1cc81a78086e", | |
| "availability_plan_id": 1, | |
| "setup_instructions": "<IntegrationURL/>", | |
| "extension": "cloudwatch_v2", | |
| "application_type": 0, | |
| "categories": "API,Analytics", | |
| "documentation_link": "Cloudwatch V2" | |
| }, | |
| "integration_key": "5f306dae-b327-4ba9-8f3a-ab4cffd57645", | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "is_enabled": true, | |
| "create_incidents_for": 1, | |
| "integration_type": 0, | |
| "default_urgency": 1, | |
| "webhook_url": "https://www.zenduty.com/api/integration/cloudwatch_v2/5f306dae-b327-4ba9-8f3a-ab4cffd57645/" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Integration" | |
| }, | |
| "example": { | |
| "name": "Modified Infra custom Integration", | |
| "creation_date": "2022-07-08T12:52:22.906327Z", | |
| "summary": "This is the summary for Infra custom Integration", | |
| "unique_id": "72da1133-a471-4e70-95f3-ce3a5650e9fd", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "application": "07c84d47-7e71-49ec-b781-1cc81a78086e", | |
| "application_reference": { | |
| "name": "Cloudwatch V2", | |
| "icon_url": "Cloudwatch V2", | |
| "summary": "Cloudwatch V2", | |
| "description": "Cloudwatch V2", | |
| "unique_id": "07c84d47-7e71-49ec-b781-1cc81a78086e", | |
| "availability_plan_id": 1, | |
| "setup_instructions": "<IntegrationURL/>", | |
| "extension": "cloudwatch_v2", | |
| "application_type": 0, | |
| "categories": "API,Analytics", | |
| "documentation_link": "Cloudwatch V2" | |
| }, | |
| "integration_key": "5f306dae-b327-4ba9-8f3a-ab4cffd57645", | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "is_enabled": true, | |
| "create_incidents_for": 1, | |
| "integration_type": 0, | |
| "default_urgency": 1, | |
| "webhook_url": "https://www.zenduty.com/api/integration/cloudwatch_v2/5f306dae-b327-4ba9-8f3a-ab4cffd57645/" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Integrations" | |
| ], | |
| "summary": "Delete the Integration object", | |
| "description": "Delete the specified Integration object permanently", | |
| "responses": { | |
| "204": { | |
| "description": "Success" | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/regenerate_integration_key/": { | |
| "post": { | |
| "tags": [ | |
| "Integrations" | |
| ], | |
| "summary": "Regenerate the Integration key", | |
| "description": "Regenerates the integration key.", | |
| "requestBody": { | |
| "description": "The integration's unique ID", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IntegrationKeyRegenerationPayload" | |
| }, | |
| "example": { | |
| "integration_unique_id": "84753076-129d-4706-a957-a7c751ca7ab1" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Integration" | |
| }, | |
| "example": { | |
| "name": "AWS GuardDuty", | |
| "creation_date": "2024-07-01T10:16:32.036085Z", | |
| "summary": "AWS GuardDuty Integration", | |
| "unique_id": "84753076-129d-4706-a957-a7c751ca7ab1", | |
| "service": "34da0237-9825-454a-9297-3a23a4b78795", | |
| "application": "bb399bc6-9098-4afd-91d7-3cec4d8282eb", | |
| "application_reference": { | |
| "name": "AWS GuardDuty", | |
| "icon_url": "https://media-assets-cdn.zenduty.com/assets/integrations/new_logos/guardduty.png", | |
| "summary": "AWS GuardDuty Integration", | |
| "description": "AWS GuardDuty Integration", | |
| "unique_id": "bb399bc6-9098-4afd-91d7-3cec4d8282eb", | |
| "availability_plan_id": 4, | |
| "setup_instructions": "To integrate Zenduty with AWS GuardDuty, follow the steps below...", | |
| "extension": "guardduty", | |
| "application_type": 0, | |
| "categories": "Cloud Monitoring,Server/Network Monitoring", | |
| "documentation_link": "https://docs.zenduty.com/docs/guardduty", | |
| "is_active": 1 | |
| }, | |
| "integration_key": "c89e320f-a975-47e4-8437-1169e91eeed7", | |
| "created_by": "39569d4b-6540-4b64-a086-6", | |
| "is_enabled": true, | |
| "create_incidents_for": 1, | |
| "integration_type": 0, | |
| "default_urgency": 1, | |
| "webhook_url": "https://www.zenduty.com/api/integration/guardduty/c89e320f-a975-47e4-8437-1169e91eeed7/" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Integration" | |
| }, | |
| "example": { | |
| "name": "AWS GuardDuty", | |
| "creation_date": "2024-07-01T10:16:32.036085Z", | |
| "summary": "AWS GuardDuty Integration", | |
| "unique_id": "84753076-129d-4706-a957-a7c751ca7ab1", | |
| "service": "34da0237-9825-454a-9297-3a23a4b78795", | |
| "application": "bb399bc6-9098-4afd-91d7-3cec4d8282eb", | |
| "application_reference": { | |
| "name": "AWS GuardDuty", | |
| "icon_url": "https://media-assets-cdn.zenduty.com/assets/integrations/new_logos/guardduty.png", | |
| "summary": "AWS GuardDuty Integration", | |
| "description": "AWS GuardDuty Integration", | |
| "unique_id": "bb399bc6-9098-4afd-91d7-3cec4d8282eb", | |
| "availability_plan_id": 4, | |
| "setup_instructions": "To integrate Zenduty with AWS GuardDuty, follow the steps below...", | |
| "extension": "guardduty", | |
| "application_type": 0, | |
| "categories": "Cloud Monitoring,Server/Network Monitoring", | |
| "documentation_link": "https://docs.zenduty.com/docs/guardduty", | |
| "is_active": 1 | |
| }, | |
| "integration_key": "c89e320f-a975-47e4-8437-1169e91eeed7", | |
| "created_by": "39569d4b-6540-4b64-a086-6", | |
| "is_enabled": true, | |
| "create_incidents_for": 1, | |
| "integration_type": 0, | |
| "default_urgency": 1, | |
| "webhook_url": "https://www.zenduty.com/api/integration/guardduty/c89e320f-a975-47e4-8437-1169e91eeed7/" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "error": "User does not have permission to regenerate integration key" | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "error": "User does not have permission to regenerate integration key" | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/teams/{team_id}/services/{service_id}/integrations/{integration_id}/alerts/": { | |
| "parameters": [ | |
| { | |
| "name": "team_id", | |
| "in": "path", | |
| "description": "unique_id of the Team object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| }, | |
| { | |
| "name": "service_id", | |
| "in": "path", | |
| "description": "unique_id of the Service object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| }, | |
| { | |
| "name": "integration_id", | |
| "in": "path", | |
| "description": "unique_id of the Integration object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "get": { | |
| "tags": [ | |
| "Integration Alerts" | |
| ], | |
| "summary": "List all Integration Alerts objects", | |
| "description": "Returns a list of Integration Alerts objects. The Integration Alerts objects are sorted by creation_date, with the most recent Integration Alerts object appearing last.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IntegrationAlert" | |
| }, | |
| "example": [ | |
| { | |
| "integration_object": { | |
| "name": "Modified Infra custom Integration", | |
| "creation_date": "2022-07-08T12:52:22.906327Z", | |
| "summary": "This is the summary for Infra custom Integration", | |
| "unique_id": "72da1133-a471-4e70-95f3-ce3a5650e9fd", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "integration_key": "5f306dae-b327-4ba9-8f3a-ab4cffd57645", | |
| "is_enabled": true, | |
| "integration_type": 0 | |
| }, | |
| "summary": "", | |
| "incident": null, | |
| "creation_date": "2022-07-08T13:14:45.556654Z", | |
| "message": "Infra Integration Alert 1", | |
| "integration": "72da1133-a471-4e70-95f3-ce3a5650e9fd", | |
| "suppressed": false, | |
| "entity_id": "bbd1951b-2a99-4c5e-8f6b-4cce4ef3", | |
| "alert_type": "0", | |
| "unique_id": "hCGwjDmKZvQz2MzNsyKmu2", | |
| "images": [ ], | |
| "urls": [ ], | |
| "notes": [ ] | |
| }, | |
| { | |
| "integration_object": { | |
| "name": "Modified Infra custom Integration", | |
| "creation_date": "2022-07-08T12:52:22.906327Z", | |
| "summary": "This is the summary for Infra custom Integration", | |
| "unique_id": "72da1133-a471-4e70-95f3-ce3a5650e9fd", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "integration_key": "5f306dae-b327-4ba9-8f3a-ab4cffd57645", | |
| "is_enabled": true, | |
| "integration_type": 0 | |
| }, | |
| "summary": "", | |
| "incident": 2, | |
| "creation_date": "2022-07-08T13:14:31.300448Z", | |
| "message": "Infra Integration Alert", | |
| "integration": "72da1133-a471-4e70-95f3-ce3a5650e9fd", | |
| "suppressed": false, | |
| "entity_id": "de8cf7fc-08ee-4966-b8d3-b6b631da", | |
| "alert_type": "3", | |
| "unique_id": "xc6qbUftpzkQ28f2MxpRxh", | |
| "images": [ ], | |
| "urls": [ ], | |
| "notes": [ ] | |
| } | |
| ] | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IntegrationAlert" | |
| }, | |
| "example": [ | |
| { | |
| "integration_object": { | |
| "name": "Modified Infra custom Integration", | |
| "creation_date": "2022-07-08T12:52:22.906327Z", | |
| "summary": "This is the summary for Infra custom Integration", | |
| "unique_id": "72da1133-a471-4e70-95f3-ce3a5650e9fd", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "integration_key": "5f306dae-b327-4ba9-8f3a-ab4cffd57645", | |
| "is_enabled": true, | |
| "integration_type": 0 | |
| }, | |
| "summary": "", | |
| "incident": null, | |
| "creation_date": "2022-07-08T13:14:45.556654Z", | |
| "message": "Infra Integration Alert 1", | |
| "integration": "72da1133-a471-4e70-95f3-ce3a5650e9fd", | |
| "suppressed": false, | |
| "entity_id": "bbd1951b-2a99-4c5e-8f6b-4cce4ef3", | |
| "alert_type": "0", | |
| "unique_id": "hCGwjDmKZvQz2MzNsyKmu2", | |
| "images": [ ], | |
| "urls": [ ], | |
| "notes": [ ] | |
| }, | |
| { | |
| "integration_object": { | |
| "name": "Modified Infra custom Integration", | |
| "creation_date": "2022-07-08T12:52:22.906327Z", | |
| "summary": "This is the summary for Infra custom Integration", | |
| "unique_id": "72da1133-a471-4e70-95f3-ce3a5650e9fd", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "integration_key": "5f306dae-b327-4ba9-8f3a-ab4cffd57645", | |
| "is_enabled": true, | |
| "integration_type": 0 | |
| }, | |
| "summary": "", | |
| "incident": 2, | |
| "creation_date": "2022-07-08T13:14:31.300448Z", | |
| "message": "Infra Integration Alert", | |
| "integration": "72da1133-a471-4e70-95f3-ce3a5650e9fd", | |
| "suppressed": false, | |
| "entity_id": "de8cf7fc-08ee-4966-b8d3-b6b631da", | |
| "alert_type": "3", | |
| "unique_id": "xc6qbUftpzkQ28f2MxpRxh", | |
| "images": [ ], | |
| "urls": [ ], | |
| "notes": [ ] | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/incidents/filter/": { | |
| "post": { | |
| "parameters": [ | |
| { | |
| "in": "query", | |
| "name": "page", | |
| "description": "pagination page number. example - `page=1`", | |
| "schema": { | |
| "type": "integer" | |
| } | |
| } | |
| ], | |
| "tags": [ | |
| "Incidents" | |
| ], | |
| "summary": "List all Incident objects(filtered)", | |
| "description": "Returns a list of filtered Incident objects. The Incident objects are sorted by creation_date, with the most recent Incident object appearing last. for pagination please use 'next' and 'previous' links in the response.", | |
| "requestBody": { | |
| "description": "Request body parameters to filter the Incident objects", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentFilterPayload" | |
| }, | |
| "example": { | |
| "status": 1, | |
| "team_ids": [ | |
| "4cce18ea-57c5-4beb-bca8-60dc7a68ae3a", | |
| "91fd3cc0-ebd6-43b8-aab3-67a05762ba0c" | |
| ], | |
| "all_teams": 1, | |
| "service_ids": [ | |
| "32a7c77f-aa0a-49de-ab52-e52f0aa77888" | |
| ], | |
| "user_ids": [ | |
| "7e26fed1-f11c-4e78-afc6-a" | |
| ], | |
| "priority_name": "", | |
| "priority_ids": [ | |
| "7064efff-55f2-448b-92e5-a3a53179aa76" | |
| ], | |
| "tag_ids": [ | |
| "bc56a5d1-3ec3-4802-9f6a-3f93519ec2a4" | |
| ], | |
| "sla_ids": [ | |
| "f14a16aa-15d1-49a1-be27-0c266b15c7fa" | |
| ], | |
| "from_date": [ ], | |
| "to_date": [ ], | |
| "postmortem_filter": -1, | |
| "escalation_policy_ids": [ | |
| "52fe68d3-cead-40b3-b0ac-d616d38d8e32" | |
| ] | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentFilterPayload" | |
| }, | |
| "example": { | |
| "status": 1, | |
| "team_ids": [ | |
| "4cce18ea-57c5-4beb-bca8-60dc7a68ae3a", | |
| "91fd3cc0-ebd6-43b8-aab3-67a05762ba0c" | |
| ], | |
| "all_teams": 1, | |
| "service_ids": [ | |
| "32a7c77f-aa0a-49de-ab52-e52f0aa77888" | |
| ], | |
| "user_ids": [ | |
| "7e26fed1-f11c-4e78-afc6-a" | |
| ], | |
| "priority_name": "", | |
| "priority_ids": [ | |
| "7064efff-55f2-448b-92e5-a3a53179aa76" | |
| ], | |
| "tag_ids": [ | |
| "bc56a5d1-3ec3-4802-9f6a-3f93519ec2a4" | |
| ], | |
| "sla_ids": [ | |
| "f14a16aa-15d1-49a1-be27-0c266b15c7fa" | |
| ], | |
| "from_date": [ ], | |
| "to_date": [ ], | |
| "postmortem_filter": -1, | |
| "escalation_policy_ids": [ | |
| "52fe68d3-cead-40b3-b0ac-d616d38d8e32" | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentFilter" | |
| }, | |
| "example": { | |
| "next": "https://www.zenduty.com/api/incidents/filter/?page=4&page_size=10", | |
| "previous": "https://www.zenduty.com/api/incidents/filter/?page=2&page_size=10", | |
| "results": [ | |
| { | |
| "incident_number": 255, | |
| "creation_date": "2023-10-26T14:22:56.338690Z", | |
| "status": 1, | |
| "unique_id": "aYfQPqqEUGvoMPftRAMSaB", | |
| "sla": "f14a16aa-15d1-49a1-be27-0c266b15c7fa", | |
| "service_object": { | |
| "name": "Main", | |
| "unique_id": "32a7c77f-aa0a-49de-ab52-e52f0aa77888", | |
| "team": "91fd3cc0-ebd6-43b8-aab3-67a05762ba0c", | |
| "team_name": "Backend" | |
| }, | |
| "title": "[P-21041]Browser monitor global outage", | |
| "assigned_to_name": "Michael Scott", | |
| "tags": [ | |
| { | |
| "unique_id": "4b2634c6-2c7c-40ea-9a30-020dfddee187", | |
| "incident": 255, | |
| "creation_date": "2023-10-26T14:22:56.475799Z", | |
| "name": "TAG", | |
| "color": "magenta", | |
| "tag_id": "bc56a5d1-3ec3-4802-9f6a-3f93519ec2a4", | |
| "team_tag": "bc56a5d1-3ec3-4802-9f6a-3f93519ec2a4" | |
| } | |
| ], | |
| "sla_object": { | |
| "unique_id": "f14a16aa-15d1-49a1-be27-0c266b15c7fa", | |
| "name": "SLA", | |
| "is_active": true, | |
| "acknowledge_time": 5, | |
| "resolve_time": 30, | |
| "creation_date": "2022-10-11T11:42:46.438776Z" | |
| }, | |
| "team_priority_object": { | |
| "unique_id": "7064efff-55f2-448b-92e5-a3a53179aa76", | |
| "name": "P1", | |
| "description": "P1 - high priority incidents", | |
| "color": "magenta" | |
| }, | |
| "is_child_incident": false, | |
| "postmortems": [ ], | |
| "is_parent_incident": false, | |
| "assigned_to": "7e26fed1-f11c-4e78-afc6-a", | |
| "acknowledged_date": null, | |
| "resolved_date": null, | |
| "snooze_time": null, | |
| "snoozed_till": null | |
| }, | |
| { | |
| "incident_number": 254, | |
| "creation_date": "2023-10-26T14:21:28.828936Z", | |
| "status": 1, | |
| "unique_id": "7ze6Q9YAgvVTUAkQntrViC", | |
| "sla": "f14a16aa-15d1-49a1-be27-0c266b15c7fa", | |
| "service_object": { | |
| "name": "Main", | |
| "unique_id": "32a7c77f-aa0a-49de-ab52-e52f0aa77888", | |
| "team": "91fd3cc0-ebd6-43b8-aab3-67a05762ba0c", | |
| "team_name": "Backend" | |
| }, | |
| "title": "[P-21041]Browser monitor global outage", | |
| "assigned_to_name": "Michael Scott", | |
| "tags": [ | |
| { | |
| "unique_id": "93f008cf-f55d-4348-9091-f1e70e3a92a6", | |
| "incident": 254, | |
| "creation_date": "2023-10-26T14:21:29.017156Z", | |
| "name": "TAG", | |
| "color": "magenta", | |
| "tag_id": "bc56a5d1-3ec3-4802-9f6a-3f93519ec2a4", | |
| "team_tag": "bc56a5d1-3ec3-4802-9f6a-3f93519ec2a4" | |
| } | |
| ], | |
| "sla_object": { | |
| "unique_id": "f14a16aa-15d1-49a1-be27-0c266b15c7fa", | |
| "name": "SLA", | |
| "is_active": true, | |
| "acknowledge_time": 5, | |
| "resolve_time": 30, | |
| "creation_date": "2022-10-11T11:42:46.438776Z" | |
| }, | |
| "team_priority_object": { | |
| "unique_id": "7064efff-55f2-448b-92e5-a3a53179aa76", | |
| "name": "P1", | |
| "description": "P1 - high priority incidents", | |
| "color": "magenta" | |
| }, | |
| "is_child_incident": false, | |
| "postmortems": [ ], | |
| "is_parent_incident": false, | |
| "assigned_to": "7e26fed1-f11c-4e78-afc6-a", | |
| "acknowledged_date": null, | |
| "resolved_date": null, | |
| "snooze_time": null, | |
| "snoozed_till": null | |
| }, | |
| { | |
| "incident_number": 253, | |
| "creation_date": "2023-10-26T14:20:18.980264Z", | |
| "status": 1, | |
| "unique_id": "fAe5HrVSR8JfigxvB5p9eF", | |
| "sla": "f14a16aa-15d1-49a1-be27-0c266b15c7fa", | |
| "service_object": { | |
| "name": "Main", | |
| "unique_id": "32a7c77f-aa0a-49de-ab52-e52f0aa77888", | |
| "team": "91fd3cc0-ebd6-43b8-aab3-67a05762ba0c", | |
| "team_name": "Backend" | |
| }, | |
| "title": "[P-21041]Browser monitor global outage", | |
| "assigned_to_name": "Michael Scott", | |
| "tags": [ | |
| { | |
| "unique_id": "6d2dadec-69a7-45f7-a2fb-99cc32a38419", | |
| "incident": 253, | |
| "creation_date": "2023-10-26T14:20:19.168974Z", | |
| "name": "TAG", | |
| "color": "magenta", | |
| "tag_id": "bc56a5d1-3ec3-4802-9f6a-3f93519ec2a4", | |
| "team_tag": "bc56a5d1-3ec3-4802-9f6a-3f93519ec2a4" | |
| } | |
| ], | |
| "sla_object": { | |
| "unique_id": "f14a16aa-15d1-49a1-be27-0c266b15c7fa", | |
| "name": "SLA", | |
| "is_active": true, | |
| "acknowledge_time": 5, | |
| "resolve_time": 30, | |
| "creation_date": "2022-10-11T11:42:46.438776Z" | |
| }, | |
| "team_priority_object": { | |
| "unique_id": "7064efff-55f2-448b-92e5-a3a53179aa76", | |
| "name": "P1", | |
| "description": "P1 - high priority incidents", | |
| "color": "magenta" | |
| }, | |
| "is_child_incident": false, | |
| "postmortems": [ ], | |
| "is_parent_incident": false, | |
| "assigned_to": "7e26fed1-f11c-4e78-afc6-a", | |
| "acknowledged_date": null, | |
| "resolved_date": null, | |
| "snooze_time": null, | |
| "snoozed_till": null | |
| } | |
| ] | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentFilter" | |
| }, | |
| "example": { | |
| "next": "https://www.zenduty.com/api/incidents/filter/?page=4&page_size=10", | |
| "previous": "https://www.zenduty.com/api/incidents/filter/?page=2&page_size=10", | |
| "results": [ | |
| { | |
| "incident_number": 255, | |
| "creation_date": "2023-10-26T14:22:56.338690Z", | |
| "status": 1, | |
| "unique_id": "aYfQPqqEUGvoMPftRAMSaB", | |
| "sla": "f14a16aa-15d1-49a1-be27-0c266b15c7fa", | |
| "service_object": { | |
| "name": "Main", | |
| "unique_id": "32a7c77f-aa0a-49de-ab52-e52f0aa77888", | |
| "team": "91fd3cc0-ebd6-43b8-aab3-67a05762ba0c", | |
| "team_name": "Backend" | |
| }, | |
| "title": "[P-21041]Browser monitor global outage", | |
| "assigned_to_name": "Michael Scott", | |
| "tags": [ | |
| { | |
| "unique_id": "4b2634c6-2c7c-40ea-9a30-020dfddee187", | |
| "incident": 255, | |
| "creation_date": "2023-10-26T14:22:56.475799Z", | |
| "name": "TAG", | |
| "color": "magenta", | |
| "tag_id": "bc56a5d1-3ec3-4802-9f6a-3f93519ec2a4", | |
| "team_tag": "bc56a5d1-3ec3-4802-9f6a-3f93519ec2a4" | |
| } | |
| ], | |
| "sla_object": { | |
| "unique_id": "f14a16aa-15d1-49a1-be27-0c266b15c7fa", | |
| "name": "SLA", | |
| "is_active": true, | |
| "acknowledge_time": 5, | |
| "resolve_time": 30, | |
| "creation_date": "2022-10-11T11:42:46.438776Z" | |
| }, | |
| "team_priority_object": { | |
| "unique_id": "7064efff-55f2-448b-92e5-a3a53179aa76", | |
| "name": "P1", | |
| "description": "P1 - high priority incidents", | |
| "color": "magenta" | |
| }, | |
| "is_child_incident": false, | |
| "postmortems": [ ], | |
| "is_parent_incident": false, | |
| "assigned_to": "7e26fed1-f11c-4e78-afc6-a", | |
| "acknowledged_date": null, | |
| "resolved_date": null, | |
| "snooze_time": null, | |
| "snoozed_till": null | |
| }, | |
| { | |
| "incident_number": 254, | |
| "creation_date": "2023-10-26T14:21:28.828936Z", | |
| "status": 1, | |
| "unique_id": "7ze6Q9YAgvVTUAkQntrViC", | |
| "sla": "f14a16aa-15d1-49a1-be27-0c266b15c7fa", | |
| "service_object": { | |
| "name": "Main", | |
| "unique_id": "32a7c77f-aa0a-49de-ab52-e52f0aa77888", | |
| "team": "91fd3cc0-ebd6-43b8-aab3-67a05762ba0c", | |
| "team_name": "Backend" | |
| }, | |
| "title": "[P-21041]Browser monitor global outage", | |
| "assigned_to_name": "Michael Scott", | |
| "tags": [ | |
| { | |
| "unique_id": "93f008cf-f55d-4348-9091-f1e70e3a92a6", | |
| "incident": 254, | |
| "creation_date": "2023-10-26T14:21:29.017156Z", | |
| "name": "TAG", | |
| "color": "magenta", | |
| "tag_id": "bc56a5d1-3ec3-4802-9f6a-3f93519ec2a4", | |
| "team_tag": "bc56a5d1-3ec3-4802-9f6a-3f93519ec2a4" | |
| } | |
| ], | |
| "sla_object": { | |
| "unique_id": "f14a16aa-15d1-49a1-be27-0c266b15c7fa", | |
| "name": "SLA", | |
| "is_active": true, | |
| "acknowledge_time": 5, | |
| "resolve_time": 30, | |
| "creation_date": "2022-10-11T11:42:46.438776Z" | |
| }, | |
| "team_priority_object": { | |
| "unique_id": "7064efff-55f2-448b-92e5-a3a53179aa76", | |
| "name": "P1", | |
| "description": "P1 - high priority incidents", | |
| "color": "magenta" | |
| }, | |
| "is_child_incident": false, | |
| "postmortems": [ ], | |
| "is_parent_incident": false, | |
| "assigned_to": "7e26fed1-f11c-4e78-afc6-a", | |
| "acknowledged_date": null, | |
| "resolved_date": null, | |
| "snooze_time": null, | |
| "snoozed_till": null | |
| }, | |
| { | |
| "incident_number": 253, | |
| "creation_date": "2023-10-26T14:20:18.980264Z", | |
| "status": 1, | |
| "unique_id": "fAe5HrVSR8JfigxvB5p9eF", | |
| "sla": "f14a16aa-15d1-49a1-be27-0c266b15c7fa", | |
| "service_object": { | |
| "name": "Main", | |
| "unique_id": "32a7c77f-aa0a-49de-ab52-e52f0aa77888", | |
| "team": "91fd3cc0-ebd6-43b8-aab3-67a05762ba0c", | |
| "team_name": "Backend" | |
| }, | |
| "title": "[P-21041]Browser monitor global outage", | |
| "assigned_to_name": "Michael Scott", | |
| "tags": [ | |
| { | |
| "unique_id": "6d2dadec-69a7-45f7-a2fb-99cc32a38419", | |
| "incident": 253, | |
| "creation_date": "2023-10-26T14:20:19.168974Z", | |
| "name": "TAG", | |
| "color": "magenta", | |
| "tag_id": "bc56a5d1-3ec3-4802-9f6a-3f93519ec2a4", | |
| "team_tag": "bc56a5d1-3ec3-4802-9f6a-3f93519ec2a4" | |
| } | |
| ], | |
| "sla_object": { | |
| "unique_id": "f14a16aa-15d1-49a1-be27-0c266b15c7fa", | |
| "name": "SLA", | |
| "is_active": true, | |
| "acknowledge_time": 5, | |
| "resolve_time": 30, | |
| "creation_date": "2022-10-11T11:42:46.438776Z" | |
| }, | |
| "team_priority_object": { | |
| "unique_id": "7064efff-55f2-448b-92e5-a3a53179aa76", | |
| "name": "P1", | |
| "description": "P1 - high priority incidents", | |
| "color": "magenta" | |
| }, | |
| "is_child_incident": false, | |
| "postmortems": [ ], | |
| "is_parent_incident": false, | |
| "assigned_to": "7e26fed1-f11c-4e78-afc6-a", | |
| "acknowledged_date": null, | |
| "resolved_date": null, | |
| "snooze_time": null, | |
| "snoozed_till": null | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/incidents/": { | |
| "post": { | |
| "tags": [ | |
| "Incidents" | |
| ], | |
| "summary": "Create the Incident object", | |
| "description": "Create the Incident object by setting the values of all the required parameters passed in the request body.", | |
| "requestBody": { | |
| "description": "Request body parameters to create the Incident object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentPayload" | |
| }, | |
| "example": { | |
| "title": "Production Incident", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentPayload" | |
| }, | |
| "example": { | |
| "title": "Production Incident", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Incident" | |
| }, | |
| "example": { | |
| "summary": "", | |
| "incident_number": 3, | |
| "creation_date": "2022-07-08T13:21:25.846623Z", | |
| "status": 1, | |
| "unique_id": "uJVWfdAeoPDm3pk2gG2URn", | |
| "service_object": { | |
| "name": "Infra Service", | |
| "creation_date": "2022-07-08T12:31:37.429973Z", | |
| "summary": "", | |
| "description": "This is the description for Infra Service", | |
| "unique_id": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "auto_resolve_timeout": 0, | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "task_template": "8d2640ca-c6ef-45f0-be5f-61dedcf85032", | |
| "acknowledgement_timeout": 0, | |
| "status": 1, | |
| "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "collation_time": 2, | |
| "collation": 1, | |
| "under_maintenance": false | |
| }, | |
| "title": "Production Incident", | |
| "incident_key": "Q5NmEbsgc4ZjLknsw97VZJ", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "urgency": 1, | |
| "merged_with": null, | |
| "assigned_to": null, | |
| "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "escalation_policy_object": { | |
| "unique_id": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "name": "Infra Escalation Policy" | |
| }, | |
| "assigned_to_name": "", | |
| "resolved_date": null, | |
| "acknowledged_date": null, | |
| "context_window_start": null, | |
| "context_window_end": null, | |
| "tags": [ ], | |
| "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "sla_object": { | |
| "unique_id": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "name": "Infra SLA", | |
| "is_active": true, | |
| "acknowledge_time": 30, | |
| "resolve_time": 60, | |
| "creation_date": "2022-07-08T12:29:08.545605Z" | |
| }, | |
| "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "team_priority_object": { | |
| "unique_id": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "name": "Infra Priority", | |
| "description": "This is the description for Infra Priority", | |
| "color": "orange" | |
| } | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Incident" | |
| }, | |
| "example": { | |
| "summary": "", | |
| "incident_number": 3, | |
| "creation_date": "2022-07-08T13:21:25.846623Z", | |
| "status": 1, | |
| "unique_id": "uJVWfdAeoPDm3pk2gG2URn", | |
| "service_object": { | |
| "name": "Infra Service", | |
| "creation_date": "2022-07-08T12:31:37.429973Z", | |
| "summary": "", | |
| "description": "This is the description for Infra Service", | |
| "unique_id": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "auto_resolve_timeout": 0, | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "task_template": "8d2640ca-c6ef-45f0-be5f-61dedcf85032", | |
| "acknowledgement_timeout": 0, | |
| "status": 1, | |
| "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "collation_time": 2, | |
| "collation": 1, | |
| "under_maintenance": false | |
| }, | |
| "title": "Production Incident", | |
| "incident_key": "Q5NmEbsgc4ZjLknsw97VZJ", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "urgency": 1, | |
| "merged_with": null, | |
| "assigned_to": null, | |
| "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "escalation_policy_object": { | |
| "unique_id": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "name": "Infra Escalation Policy" | |
| }, | |
| "assigned_to_name": "", | |
| "resolved_date": null, | |
| "acknowledged_date": null, | |
| "context_window_start": null, | |
| "context_window_end": null, | |
| "tags": [ ], | |
| "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "sla_object": { | |
| "unique_id": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "name": "Infra SLA", | |
| "is_active": true, | |
| "acknowledge_time": 30, | |
| "resolve_time": 60, | |
| "creation_date": "2022-07-08T12:29:08.545605Z" | |
| }, | |
| "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "team_priority_object": { | |
| "unique_id": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "name": "Infra Priority", | |
| "description": "This is the description for Infra Priority", | |
| "color": "orange" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/incidents/{unique_id}/": { | |
| "patch": { | |
| "parameters": [ | |
| { | |
| "name": "unique_id", | |
| "in": "path", | |
| "description": "A system-generated string that represents the Incident object's unique ID", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "tags": [ | |
| "Incidents" | |
| ], | |
| "summary": "Update the Incident object", | |
| "description": "Updates the specified Incident object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.", | |
| "requestBody": { | |
| "description": "Request body parameters to update the Incident object", | |
| "required": false, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentPayload" | |
| }, | |
| "example": { | |
| "status": 2 | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentPayload" | |
| }, | |
| "example": { | |
| "status": 2 | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Incident" | |
| }, | |
| "example": { | |
| "summary": "", | |
| "incident_number": 3, | |
| "creation_date": "2022-07-08T13:21:25.846623Z", | |
| "status": 2, | |
| "unique_id": "uJVWfdAeoPDm3pk2gG2URn", | |
| "service_object": { | |
| "name": "Infra Service", | |
| "creation_date": "2022-07-08T12:31:37.429973Z", | |
| "summary": "", | |
| "description": "This is the description for Infra Service", | |
| "unique_id": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "auto_resolve_timeout": 0, | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "task_template": "8d2640ca-c6ef-45f0-be5f-61dedcf85032", | |
| "acknowledgement_timeout": 0, | |
| "status": 1, | |
| "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "collation_time": 2, | |
| "collation": 1, | |
| "under_maintenance": false | |
| }, | |
| "title": "Modified Production Incident", | |
| "incident_key": "Q5NmEbsgc4ZjLknsw97VZJ", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "urgency": 1, | |
| "merged_with": null, | |
| "assigned_to": "507dfda0-a1fd-40e5-943a-e", | |
| "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "escalation_policy_object": { | |
| "unique_id": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "name": "Infra Escalation Policy" | |
| }, | |
| "assigned_to_name": "Mary Jane", | |
| "resolved_date": null, | |
| "acknowledged_date": null, | |
| "context_window_start": null, | |
| "context_window_end": null, | |
| "tags": [ ], | |
| "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "sla_object": { | |
| "unique_id": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "name": "Infra SLA", | |
| "is_active": true, | |
| "acknowledge_time": 30, | |
| "resolve_time": 60, | |
| "creation_date": "2022-07-08T12:29:08.545605Z" | |
| }, | |
| "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "team_priority_object": { | |
| "unique_id": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "name": "Infra Priority", | |
| "description": "This is the description for Infra Priority", | |
| "color": "orange" | |
| } | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Incident" | |
| }, | |
| "example": { | |
| "summary": "", | |
| "incident_number": 3, | |
| "creation_date": "2022-07-08T13:21:25.846623Z", | |
| "status": 2, | |
| "unique_id": "uJVWfdAeoPDm3pk2gG2URn", | |
| "service_object": { | |
| "name": "Infra Service", | |
| "creation_date": "2022-07-08T12:31:37.429973Z", | |
| "summary": "", | |
| "description": "This is the description for Infra Service", | |
| "unique_id": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "auto_resolve_timeout": 0, | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "task_template": "8d2640ca-c6ef-45f0-be5f-61dedcf85032", | |
| "acknowledgement_timeout": 0, | |
| "status": 1, | |
| "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "collation_time": 2, | |
| "collation": 1, | |
| "under_maintenance": false | |
| }, | |
| "title": "Modified Production Incident", | |
| "incident_key": "Q5NmEbsgc4ZjLknsw97VZJ", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "urgency": 1, | |
| "merged_with": null, | |
| "assigned_to": "507dfda0-a1fd-40e5-943a-e", | |
| "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "escalation_policy_object": { | |
| "unique_id": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "name": "Infra Escalation Policy" | |
| }, | |
| "assigned_to_name": "Mary Jane", | |
| "resolved_date": null, | |
| "acknowledged_date": null, | |
| "context_window_start": null, | |
| "context_window_end": null, | |
| "tags": [ ], | |
| "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "sla_object": { | |
| "unique_id": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "name": "Infra SLA", | |
| "is_active": true, | |
| "acknowledge_time": 30, | |
| "resolve_time": 60, | |
| "creation_date": "2022-07-08T12:29:08.545605Z" | |
| }, | |
| "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "team_priority_object": { | |
| "unique_id": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "name": "Infra Priority", | |
| "description": "This is the description for Infra Priority", | |
| "color": "orange" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/incidents/{incident_number}/": { | |
| "parameters": [ | |
| { | |
| "name": "incident_number", | |
| "in": "path", | |
| "description": "incident_number of the Incident object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "get": { | |
| "deprecated": true, | |
| "tags": [ | |
| "Incidents (Deprecated)" | |
| ], | |
| "summary": "Retrieve the Incident object", | |
| "description": "Retrieves the specified Incident object.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Incident" | |
| }, | |
| "example": { | |
| "summary": "", | |
| "incident_number": 3, | |
| "creation_date": "2022-07-08T13:21:25.846623Z", | |
| "status": 1, | |
| "unique_id": "uJVWfdAeoPDm3pk2gG2URn", | |
| "service_object": { | |
| "name": "Infra Service", | |
| "creation_date": "2022-07-08T12:31:37.429973Z", | |
| "summary": "", | |
| "description": "This is the description for Infra Service", | |
| "unique_id": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "auto_resolve_timeout": 0, | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "task_template": "8d2640ca-c6ef-45f0-be5f-61dedcf85032", | |
| "acknowledgement_timeout": 0, | |
| "status": 1, | |
| "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "collation_time": 2, | |
| "collation": 1, | |
| "under_maintenance": false | |
| }, | |
| "title": "Production Incident", | |
| "incident_key": "Q5NmEbsgc4ZjLknsw97VZJ", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "urgency": 1, | |
| "merged_with": null, | |
| "assigned_to": "507dfda0-a1fd-40e5-943a-e", | |
| "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "escalation_policy_object": { | |
| "unique_id": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "name": "Infra Escalation Policy" | |
| }, | |
| "assigned_to_name": "Mary Jane", | |
| "resolved_date": null, | |
| "acknowledged_date": null, | |
| "context_window_start": null, | |
| "context_window_end": null, | |
| "tags": [ ], | |
| "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "sla_object": { | |
| "unique_id": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "name": "Infra SLA", | |
| "is_active": true, | |
| "acknowledge_time": 30, | |
| "resolve_time": 60, | |
| "creation_date": "2022-07-08T12:29:08.545605Z" | |
| }, | |
| "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "team_priority_object": { | |
| "unique_id": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "name": "Infra Priority", | |
| "description": "This is the description for Infra Priority", | |
| "color": "orange" | |
| } | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Incident" | |
| }, | |
| "example": { | |
| "summary": "", | |
| "incident_number": 3, | |
| "creation_date": "2022-07-08T13:21:25.846623Z", | |
| "status": 1, | |
| "unique_id": "uJVWfdAeoPDm3pk2gG2URn", | |
| "service_object": { | |
| "name": "Infra Service", | |
| "creation_date": "2022-07-08T12:31:37.429973Z", | |
| "summary": "", | |
| "description": "This is the description for Infra Service", | |
| "unique_id": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "auto_resolve_timeout": 0, | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "task_template": "8d2640ca-c6ef-45f0-be5f-61dedcf85032", | |
| "acknowledgement_timeout": 0, | |
| "status": 1, | |
| "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "collation_time": 2, | |
| "collation": 1, | |
| "under_maintenance": false | |
| }, | |
| "title": "Production Incident", | |
| "incident_key": "Q5NmEbsgc4ZjLknsw97VZJ", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "urgency": 1, | |
| "merged_with": null, | |
| "assigned_to": "507dfda0-a1fd-40e5-943a-e", | |
| "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "escalation_policy_object": { | |
| "unique_id": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "name": "Infra Escalation Policy" | |
| }, | |
| "assigned_to_name": "Mary Jane", | |
| "resolved_date": null, | |
| "acknowledged_date": null, | |
| "context_window_start": null, | |
| "context_window_end": null, | |
| "tags": [ ], | |
| "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "sla_object": { | |
| "unique_id": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "name": "Infra SLA", | |
| "is_active": true, | |
| "acknowledge_time": 30, | |
| "resolve_time": 60, | |
| "creation_date": "2022-07-08T12:29:08.545605Z" | |
| }, | |
| "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "team_priority_object": { | |
| "unique_id": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "name": "Infra Priority", | |
| "description": "This is the description for Infra Priority", | |
| "color": "orange" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "deprecated": true, | |
| "tags": [ | |
| "Incidents (Deprecated)" | |
| ], | |
| "summary": "Update the Incident object", | |
| "description": "Updates the specified Incident object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.", | |
| "requestBody": { | |
| "description": "Request body parameters to update the Incident object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentPayload" | |
| }, | |
| "example": { | |
| "title": "Modified Production Incident", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentPayload" | |
| }, | |
| "example": { | |
| "title": "Modified Production Incident", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Incident" | |
| }, | |
| "example": { | |
| "summary": "", | |
| "incident_number": 3, | |
| "creation_date": "2022-07-08T13:21:25.846623Z", | |
| "status": 1, | |
| "unique_id": "uJVWfdAeoPDm3pk2gG2URn", | |
| "service_object": { | |
| "name": "Infra Service", | |
| "creation_date": "2022-07-08T12:31:37.429973Z", | |
| "summary": "", | |
| "description": "This is the description for Infra Service", | |
| "unique_id": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "auto_resolve_timeout": 0, | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "task_template": "8d2640ca-c6ef-45f0-be5f-61dedcf85032", | |
| "acknowledgement_timeout": 0, | |
| "status": 1, | |
| "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "collation_time": 2, | |
| "collation": 1, | |
| "under_maintenance": false | |
| }, | |
| "title": "Modified Production Incident", | |
| "incident_key": "Q5NmEbsgc4ZjLknsw97VZJ", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "urgency": 1, | |
| "merged_with": null, | |
| "assigned_to": "507dfda0-a1fd-40e5-943a-e", | |
| "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "escalation_policy_object": { | |
| "unique_id": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "name": "Infra Escalation Policy" | |
| }, | |
| "assigned_to_name": "Mary Jane", | |
| "resolved_date": null, | |
| "acknowledged_date": null, | |
| "context_window_start": null, | |
| "context_window_end": null, | |
| "tags": [ ], | |
| "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "sla_object": { | |
| "unique_id": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "name": "Infra SLA", | |
| "is_active": true, | |
| "acknowledge_time": 30, | |
| "resolve_time": 60, | |
| "creation_date": "2022-07-08T12:29:08.545605Z" | |
| }, | |
| "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "team_priority_object": { | |
| "unique_id": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "name": "Infra Priority", | |
| "description": "This is the description for Infra Priority", | |
| "color": "orange" | |
| } | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Incident" | |
| }, | |
| "example": { | |
| "summary": "", | |
| "incident_number": 3, | |
| "creation_date": "2022-07-08T13:21:25.846623Z", | |
| "status": 1, | |
| "unique_id": "uJVWfdAeoPDm3pk2gG2URn", | |
| "service_object": { | |
| "name": "Infra Service", | |
| "creation_date": "2022-07-08T12:31:37.429973Z", | |
| "summary": "", | |
| "description": "This is the description for Infra Service", | |
| "unique_id": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "auto_resolve_timeout": 0, | |
| "created_by": "216bba3d-7268-4a8e-89e9-6", | |
| "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "task_template": "8d2640ca-c6ef-45f0-be5f-61dedcf85032", | |
| "acknowledgement_timeout": 0, | |
| "status": 1, | |
| "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "collation_time": 2, | |
| "collation": 1, | |
| "under_maintenance": false | |
| }, | |
| "title": "Modified Production Incident", | |
| "incident_key": "Q5NmEbsgc4ZjLknsw97VZJ", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "urgency": 1, | |
| "merged_with": null, | |
| "assigned_to": "507dfda0-a1fd-40e5-943a-e", | |
| "escalation_policy": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "escalation_policy_object": { | |
| "unique_id": "9ea1f98d-b5a3-4d72-8057-2f5f3d743a44", | |
| "name": "Infra Escalation Policy" | |
| }, | |
| "assigned_to_name": "Mary Jane", | |
| "resolved_date": null, | |
| "acknowledged_date": null, | |
| "context_window_start": null, | |
| "context_window_end": null, | |
| "tags": [ ], | |
| "sla": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "sla_object": { | |
| "unique_id": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "name": "Infra SLA", | |
| "is_active": true, | |
| "acknowledge_time": 30, | |
| "resolve_time": 60, | |
| "creation_date": "2022-07-08T12:29:08.545605Z" | |
| }, | |
| "team_priority": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "team_priority_object": { | |
| "unique_id": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "name": "Infra Priority", | |
| "description": "This is the description for Infra Priority", | |
| "color": "orange" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/teams/{}/roles/": { | |
| "parameters": [ | |
| { | |
| "name": "team_id", | |
| "in": "path", | |
| "description": "unique_id of the Team object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "post": { | |
| "tags": [ | |
| "Incident Roles" | |
| ], | |
| "summary": "Create the Incident Role object", | |
| "description": "Create the Incident Role object by setting the values of all the required parameters passed in the request body.", | |
| "requestBody": { | |
| "description": "Request body parameters to create the Incident Role object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IRPayload" | |
| }, | |
| "example": { | |
| "title": "Infra Incident Role", | |
| "rank": 1 | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IRPayload" | |
| }, | |
| "example": { | |
| "title": "Infra Incident Role", | |
| "rank": 1 | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentRolePostPut" | |
| }, | |
| "example": { | |
| "unique_id": "33994f75-c917-46c4-a367-e05ad7f893a9", | |
| "title": "Infra Incident Role", | |
| "description": "", | |
| "creation_date": "2022-07-08T13:37:07.405199Z", | |
| "rank": 1 | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentRolePostPut" | |
| }, | |
| "example": { | |
| "unique_id": "33994f75-c917-46c4-a367-e05ad7f893a9", | |
| "title": "Infra Incident Role", | |
| "description": "", | |
| "creation_date": "2022-07-08T13:37:07.405199Z", | |
| "rank": 1 | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "get": { | |
| "tags": [ | |
| "Incident Roles" | |
| ], | |
| "summary": "List all Incident Role objects", | |
| "description": "Returns a list of Incident Role objects. The Incident Role objects are sorted by creation_date, with the most recent Incident Role object appearing last.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentRoleGet" | |
| }, | |
| "example": [ | |
| { | |
| "unique_id": "89752b4a-43df-401d-9dc0-a446690a7a0e", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "title": "Incident Commander", | |
| "description": "The incident commander is the person responsible for all aspects of the incident response, including quickly developing incident objectives, managing all incident operations, application of resources as well as responsibility for all persons involved. The incident commander sets priorities and defines the organization of the incident response teams and the overall incident action plan.", | |
| "creation_date": "2022-07-08T10:41:36.623257Z", | |
| "rank": 1 | |
| }, | |
| { | |
| "unique_id": "33994f75-c917-46c4-a367-e05ad7f893a9", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "title": "Infra Incident Role", | |
| "description": "", | |
| "creation_date": "2022-07-08T13:37:07.405199Z", | |
| "rank": 1 | |
| } | |
| ] | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentRoleGet" | |
| }, | |
| "example": [ | |
| { | |
| "unique_id": "89752b4a-43df-401d-9dc0-a446690a7a0e", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "title": "Incident Commander", | |
| "description": "The incident commander is the person responsible for all aspects of the incident response, including quickly developing incident objectives, managing all incident operations, application of resources as well as responsibility for all persons involved. The incident commander sets priorities and defines the organization of the incident response teams and the overall incident action plan.", | |
| "creation_date": "2022-07-08T10:41:36.623257Z", | |
| "rank": 1 | |
| }, | |
| { | |
| "unique_id": "33994f75-c917-46c4-a367-e05ad7f893a9", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "title": "Infra Incident Role", | |
| "description": "", | |
| "creation_date": "2022-07-08T13:37:07.405199Z", | |
| "rank": 1 | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/teams/{team_id}/roles/{incident_role_id}/": { | |
| "parameters": [ | |
| { | |
| "name": "team_id", | |
| "in": "path", | |
| "description": "unique_id of the Team object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| }, | |
| { | |
| "name": "incident_role_id", | |
| "in": "path", | |
| "description": "unique_id of the Incident Role object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "get": { | |
| "tags": [ | |
| "Incident Roles" | |
| ], | |
| "summary": "Retrieve the Incident Role object", | |
| "description": "Retrieve the specified Incident Role object.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentRoleGet" | |
| }, | |
| "example": { | |
| "unique_id": "33994f75-c917-46c4-a367-e05ad7f893a9", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "title": "Infra Incident Role", | |
| "description": "", | |
| "creation_date": "2022-07-08T13:37:07.405199Z", | |
| "rank": 1 | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentRoleGet" | |
| }, | |
| "example": { | |
| "unique_id": "33994f75-c917-46c4-a367-e05ad7f893a9", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "title": "Infra Incident Role", | |
| "description": "", | |
| "creation_date": "2022-07-08T13:37:07.405199Z", | |
| "rank": 1 | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": [ | |
| "Incident Roles" | |
| ], | |
| "summary": "Update the Incident Role object", | |
| "description": "Updates the specified Incident Role object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.", | |
| "requestBody": { | |
| "description": "Request body parameters to update the Incident Role object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IRPayload" | |
| }, | |
| "example": { | |
| "title": "Modified Infra Incident Role" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IRPayload" | |
| }, | |
| "example": { | |
| "title": "Modified Infra Incident Role" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentRolePostPut" | |
| }, | |
| "example": { | |
| "unique_id": "33994f75-c917-46c4-a367-e05ad7f893a9", | |
| "title": "Modified Infra Incident Role", | |
| "description": "", | |
| "creation_date": "2022-07-08T13:37:07.405199Z", | |
| "rank": 1 | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentRolePostPut" | |
| }, | |
| "example": { | |
| "unique_id": "33994f75-c917-46c4-a367-e05ad7f893a9", | |
| "title": "Modified Infra Incident Role", | |
| "description": "", | |
| "creation_date": "2022-07-08T13:37:07.405199Z", | |
| "rank": 1 | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Incident Roles" | |
| ], | |
| "summary": "Delete the Incident Role object", | |
| "description": "Delete the specified Incident Role object permanently.", | |
| "responses": { | |
| "204": { | |
| "description": "Success" | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/incidents/{incident_number}/note/": { | |
| "parameters": [ | |
| { | |
| "name": "incident_number", | |
| "in": "path", | |
| "description": "incident_number of the Incident object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "post": { | |
| "tags": [ | |
| "Incident Notes" | |
| ], | |
| "summary": "Create the Incident Note object", | |
| "description": "Create the Incident Note object by setting the values of all the required parameters passed in the request body.", | |
| "requestBody": { | |
| "description": "Request body parameters to create the Incident Note object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentNotePayload" | |
| }, | |
| "example": { | |
| "note": "This is new Infra Incident Note data" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentNotePayload" | |
| }, | |
| "example": { | |
| "note": "This is new Infra Incident Note data" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentNote" | |
| }, | |
| "example": { | |
| "unique_id": "KCfA6tgiQTQrQVYuLVx2AK", | |
| "incident": 1, | |
| "user": "216bba3d-7268-4a8e-89e9-6", | |
| "note": "This is new Infra Incident Note data", | |
| "user_name": "Anshul Rajput", | |
| "creation_date": "2022-07-08T13:50:37.581269Z" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentNote" | |
| }, | |
| "example": { | |
| "unique_id": "KCfA6tgiQTQrQVYuLVx2AK", | |
| "incident": 1, | |
| "user": "216bba3d-7268-4a8e-89e9-6", | |
| "note": "This is new Infra Incident Note data", | |
| "user_name": "Anshul Rajput", | |
| "creation_date": "2022-07-08T13:50:37.581269Z" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "get": { | |
| "tags": [ | |
| "Incident Notes" | |
| ], | |
| "summary": "List all Incident Note objects", | |
| "description": "Returns a list of Incident Note objects. The Incident Note objects are sorted by creation_date, with the most recent Incident Note object appearing last.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentNote" | |
| }, | |
| "example": [ | |
| { | |
| "unique_id": "sEeKz4WibyGzvLfoRUoMCk", | |
| "incident": 1, | |
| "user": "216bba3d-7268-4a8e-89e9-6", | |
| "note": "This is Infra Incident Note data", | |
| "user_name": "Anshul Rajput", | |
| "creation_date": "2022-07-08T12:33:02.593351Z" | |
| }, | |
| { | |
| "unique_id": "KCfA6tgiQTQrQVYuLVx2AK", | |
| "incident": 1, | |
| "user": "216bba3d-7268-4a8e-89e9-6", | |
| "note": "This is new Infra Incident Note data", | |
| "user_name": "Anshul Rajput", | |
| "creation_date": "2022-07-08T13:50:37.581269Z" | |
| } | |
| ] | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentNote" | |
| }, | |
| "example": [ | |
| { | |
| "unique_id": "sEeKz4WibyGzvLfoRUoMCk", | |
| "incident": 1, | |
| "user": "216bba3d-7268-4a8e-89e9-6", | |
| "note": "This is Infra Incident Note data", | |
| "user_name": "Anshul Rajput", | |
| "creation_date": "2022-07-08T12:33:02.593351Z" | |
| }, | |
| { | |
| "unique_id": "KCfA6tgiQTQrQVYuLVx2AK", | |
| "incident": 1, | |
| "user": "216bba3d-7268-4a8e-89e9-6", | |
| "note": "This is new Infra Incident Note data", | |
| "user_name": "Anshul Rajput", | |
| "creation_date": "2022-07-08T13:50:37.581269Z" | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/incidents/{incident_number}/note/{note_unique_id}/": { | |
| "parameters": [ | |
| { | |
| "name": "incident_number", | |
| "in": "path", | |
| "description": "incident_number of the Incident object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| }, | |
| { | |
| "name": "note_unique_id", | |
| "in": "path", | |
| "description": "unique_id of the Incident Note object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "get": { | |
| "tags": [ | |
| "Incident Notes" | |
| ], | |
| "summary": "Retrieve the Incident Note object", | |
| "description": "Retrieve the specified Incident Note object.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentNote" | |
| }, | |
| "example": { | |
| "unique_id": "KCfA6tgiQTQrQVYuLVx2AK", | |
| "incident": 1, | |
| "user": "216bba3d-7268-4a8e-89e9-6", | |
| "note": "This is new Infra Incident Note data", | |
| "user_name": "Anshul Rajput", | |
| "creation_date": "2022-07-08T13:50:37.581269Z" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentNote" | |
| }, | |
| "example": { | |
| "unique_id": "KCfA6tgiQTQrQVYuLVx2AK", | |
| "incident": 1, | |
| "user": "216bba3d-7268-4a8e-89e9-6", | |
| "note": "This is new Infra Incident Note data", | |
| "user_name": "Anshul Rajput", | |
| "creation_date": "2022-07-08T13:50:37.581269Z" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": [ | |
| "Incident Notes" | |
| ], | |
| "summary": "Update the Incident Note object", | |
| "description": "Updates the specified Incident Note object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.", | |
| "requestBody": { | |
| "description": "Incident Note update payload", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentNotePayload" | |
| }, | |
| "example": { | |
| "note": "This is modified Infra Incident Note data" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentNotePayload" | |
| }, | |
| "example": { | |
| "note": "This is modified Infra Incident Note data" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentNote" | |
| }, | |
| "example": { | |
| "unique_id": "KCfA6tgiQTQrQVYuLVx2AK", | |
| "incident": 1, | |
| "user": "216bba3d-7268-4a8e-89e9-6", | |
| "note": "This is modified Infra Incident Note data", | |
| "user_name": "Anshul Rajput", | |
| "creation_date": "2022-07-08T13:50:37.581269Z" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentNote" | |
| }, | |
| "example": { | |
| "unique_id": "KCfA6tgiQTQrQVYuLVx2AK", | |
| "incident": 1, | |
| "user": "216bba3d-7268-4a8e-89e9-6", | |
| "note": "This is modified Infra Incident Note data", | |
| "user_name": "Anshul Rajput", | |
| "creation_date": "2022-07-08T13:50:37.581269Z" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Incident Notes" | |
| ], | |
| "summary": "Delete the Incident Note object", | |
| "description": "Delete the specified Incident Note object permanently.", | |
| "responses": { | |
| "204": { | |
| "description": "Success" | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/incidents/{incident_number}/tags/": { | |
| "parameters": [ | |
| { | |
| "name": "incident_number", | |
| "in": "path", | |
| "description": "incident_number of the Incident object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "post": { | |
| "tags": [ | |
| "Incident Tags" | |
| ], | |
| "summary": "Create the Incident Tag object", | |
| "description": "Create the Incident Tag object by setting the values of all the required parameters passed in the request body.", | |
| "requestBody": { | |
| "description": "Request body parameters to create the Incident Tag object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentTagPayload" | |
| }, | |
| "example": { | |
| "team_tag": "bc56a5d1-3ec3-4802-9f6a-3f93519ec2a4" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentTagPayload" | |
| }, | |
| "example": { | |
| "team_tag": "bc56a5d1-3ec3-4802-9f6a-3f93519ec2a4" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentTag" | |
| }, | |
| "example": { | |
| "unique_id": "6dba6488-d330-4cbc-bd1b-5a6d912464f8", | |
| "incident": 27, | |
| "team_tag": "bc56a5d1-3ec3-4802-9f6a-3f93519ec2a4", | |
| "name": "Team 1 Tag 1", | |
| "color": "magenta", | |
| "tag_id": "bc56a5d1-3ec3-4802-9f6a-3f93519ec2a4", | |
| "creation_date": "2022-12-22T08:33:22.130596Z" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentTag" | |
| }, | |
| "example": { | |
| "unique_id": "6dba6488-d330-4cbc-bd1b-5a6d912464f8", | |
| "incident": 27, | |
| "team_tag": "bc56a5d1-3ec3-4802-9f6a-3f93519ec2a4", | |
| "name": "Team 1 Tag 1", | |
| "color": "magenta", | |
| "tag_id": "bc56a5d1-3ec3-4802-9f6a-3f93519ec2a4", | |
| "creation_date": "2022-12-22T08:33:22.130596Z" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "get": { | |
| "tags": [ | |
| "Incident Tags" | |
| ], | |
| "summary": "List all Incident Tag objects", | |
| "description": "Returns a list of Incident Tag objects. The Incident Tag objects are sorted by creation_date, with the most recent Incident Note object appearing last.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentTag" | |
| }, | |
| "example": [ | |
| { | |
| "unique_id": "749d39aa-59c5-4719-b300-0c04ad677af5", | |
| "incident": 27, | |
| "creation_date": "2022-12-22T08:23:10.905923Z", | |
| "name": "Team 1 Tag 4", | |
| "color": "cyan", | |
| "tag_id": "2778cd89-fa68-42bd-8bac-2cdcc569b8bb", | |
| "team_tag": "2778cd89-fa68-42bd-8bac-2cdcc569b8bb" | |
| }, | |
| { | |
| "unique_id": "6dba6488-d330-4cbc-bd1b-5a6d912464f8", | |
| "incident": 27, | |
| "creation_date": "2022-12-22T08:33:22.130596Z", | |
| "name": "Team 1 Tag 1", | |
| "color": "magenta", | |
| "tag_id": "bc56a5d1-3ec3-4802-9f6a-3f93519ec2a4", | |
| "team_tag": "bc56a5d1-3ec3-4802-9f6a-3f93519ec2a4" | |
| } | |
| ] | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentTag" | |
| }, | |
| "example": [ | |
| { | |
| "unique_id": "749d39aa-59c5-4719-b300-0c04ad677af5", | |
| "incident": 27, | |
| "creation_date": "2022-12-22T08:23:10.905923Z", | |
| "name": "Team 1 Tag 4", | |
| "color": "cyan", | |
| "tag_id": "2778cd89-fa68-42bd-8bac-2cdcc569b8bb", | |
| "team_tag": "2778cd89-fa68-42bd-8bac-2cdcc569b8bb" | |
| }, | |
| { | |
| "unique_id": "6dba6488-d330-4cbc-bd1b-5a6d912464f8", | |
| "incident": 27, | |
| "creation_date": "2022-12-22T08:33:22.130596Z", | |
| "name": "Team 1 Tag 1", | |
| "color": "magenta", | |
| "tag_id": "bc56a5d1-3ec3-4802-9f6a-3f93519ec2a4", | |
| "team_tag": "bc56a5d1-3ec3-4802-9f6a-3f93519ec2a4" | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/incidents/{incident_number}/tags/{tag_unique_id}/": { | |
| "parameters": [ | |
| { | |
| "name": "incident_number", | |
| "in": "path", | |
| "description": "incident_number of the Incident object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| }, | |
| { | |
| "name": "tag_unique_id", | |
| "in": "path", | |
| "description": "unique_id of the Incident Tag object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "get": { | |
| "tags": [ | |
| "Incident Tags" | |
| ], | |
| "summary": "Retrieve the Incident Tag object", | |
| "description": "Retrieve the specified Incident Tag object.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentTag" | |
| }, | |
| "example": { | |
| "unique_id": "6dba6488-d330-4cbc-bd1b-5a6d912464f8", | |
| "incident": 27, | |
| "creation_date": "2022-12-22T08:33:22.130596Z", | |
| "name": "Team 1 Tag 1", | |
| "color": "magenta", | |
| "tag_id": "bc56a5d1-3ec3-4802-9f6a-3f93519ec2a4", | |
| "team_tag": "bc56a5d1-3ec3-4802-9f6a-3f93519ec2a4" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentTag" | |
| }, | |
| "example": { | |
| "unique_id": "6dba6488-d330-4cbc-bd1b-5a6d912464f8", | |
| "incident": 27, | |
| "creation_date": "2022-12-22T08:33:22.130596Z", | |
| "name": "Team 1 Tag 1", | |
| "color": "magenta", | |
| "tag_id": "bc56a5d1-3ec3-4802-9f6a-3f93519ec2a4", | |
| "team_tag": "bc56a5d1-3ec3-4802-9f6a-3f93519ec2a4" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Incident Tags" | |
| ], | |
| "summary": "Delete the Incident Tag object", | |
| "description": "Delete the specified Incident Tag object permanently.", | |
| "responses": { | |
| "204": { | |
| "description": "Success" | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/events/{integration_key}/": { | |
| "parameters": [ | |
| { | |
| "name": "integration_key", | |
| "in": "path", | |
| "description": "integration_key of the Integration object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "post": { | |
| "deprecated": true, | |
| "tags": [ | |
| "Events" | |
| ], | |
| "summary": "Create the Event object", | |
| "description": "Create the Event object by setting the values of all the required parameters passed in the request body.", | |
| "requestBody": { | |
| "description": "Request body parameters to create the Event object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/EventPayload" | |
| }, | |
| "example": { | |
| "alert_type": "info", | |
| "message": "This is info alert", | |
| "summary": "This is the incident summary", | |
| "entity_id": 12345, | |
| "payload": { | |
| "status": "ACME Payments are failing", | |
| "severity": "1", | |
| "project": "kubeprod" | |
| }, | |
| "urls": [ | |
| { | |
| "link_url": "https://www.example.com/alerts/12345/", | |
| "link_text": "Alert URL" | |
| } | |
| ] | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/EventPayload" | |
| }, | |
| "example": { | |
| "alert_type": "info", | |
| "message": "This is info alert", | |
| "summary": "This is the incident summary", | |
| "entity_id": 12345, | |
| "payload": { | |
| "status": "ACME Payments are failing", | |
| "severity": "1", | |
| "project": "kubeprod" | |
| }, | |
| "urls": [ | |
| { | |
| "link_url": "https://www.example.com/alerts/1234/", | |
| "link_text": "Alert URL" | |
| } | |
| ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Event" | |
| }, | |
| "example": { | |
| "integration_object": { | |
| "name": "API", | |
| "creation_date": "2022-11-14T14:08:56.089450Z", | |
| "summary": "Zenduty API integration", | |
| "unique_id": "828361de-681f-4f00-9420-07a185a83e46", | |
| "service": "1587103f-6ed2-4eac-8a56-866128df036f", | |
| "team": "db61f7ed-ba78-4536-9b2d-256b135a731d", | |
| "integration_key": "082a1af8-064c-40a2-a99c-bc9c27d2042d", | |
| "is_enabled": true, | |
| "integration_type": 0 | |
| }, | |
| "summary": "This is the incident summary", | |
| "incident": null, | |
| "creation_date": "2023-04-05T12:40:35.405170Z", | |
| "message": "This is info alert", | |
| "integration": "828361de-681f-4f00-9420-07a185a83e46", | |
| "suppressed": false, | |
| "entity_id": "12345", | |
| "payload": { }, | |
| "alert_type": "0", | |
| "unique_id": "hD5dKNDyFDVADEYdrLViM7", | |
| "images": [ ], | |
| "urls": [ | |
| { | |
| "unique_id": "b7cc93a2-6f64-46c6-bed7-2dd0504917f6", | |
| "link_url": "https://www.example.com/alerts/1234/", | |
| "link_text": "Alert URL" | |
| } | |
| ], | |
| "notes": [ ], | |
| "incident_created": false | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/Event" | |
| }, | |
| "example": { | |
| "integration_object": { | |
| "name": "API", | |
| "creation_date": "2022-11-14T14:08:56.089450Z", | |
| "summary": "Zenduty API integration", | |
| "unique_id": "828361de-681f-4f00-9420-07a185a83e46", | |
| "service": "1587103f-6ed2-4eac-8a56-866128df036f", | |
| "team": "db61f7ed-ba78-4536-9b2d-256b135a731d", | |
| "integration_key": "082a1af8-064c-40a2-a99c-bc9c27d2042d", | |
| "is_enabled": true, | |
| "integration_type": 0 | |
| }, | |
| "summary": "This is the incident summary", | |
| "incident": null, | |
| "creation_date": "2023-04-05T12:40:35.405170Z", | |
| "message": "This is info alert", | |
| "integration": "828361de-681f-4f00-9420-07a185a83e46", | |
| "suppressed": false, | |
| "entity_id": "12345", | |
| "payload": { }, | |
| "alert_type": "0", | |
| "unique_id": "hD5dKNDyFDVADEYdrLViM7", | |
| "images": [ ], | |
| "urls": [ | |
| { | |
| "unique_id": "b7cc93a2-6f64-46c6-bed7-2dd0504917f6", | |
| "link_url": "https://www.example.com/alerts/1234/", | |
| "link_text": "Alert URL" | |
| } | |
| ], | |
| "notes": [ ], | |
| "incident_created": false | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/integration/{account_id}/generic/{integration_key}/": { | |
| "servers": [ | |
| { | |
| "url": "https://events.zenduty.com" | |
| } | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "account_id", | |
| "in": "path", | |
| "description": "5 character long account identifier", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| }, | |
| { | |
| "name": "integration_key", | |
| "in": "path", | |
| "description": "integration_key of the Integration object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "post": { | |
| "tags": [ | |
| "Events" | |
| ], | |
| "summary": "Create the Event object", | |
| "description": "Create the Event object by setting the values of all the required parameters passed in the request body.", | |
| "requestBody": { | |
| "description": "Request body parameters to create the Event object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/GenericEventPayload" | |
| }, | |
| "example": { | |
| "alert_type": "info", | |
| "message": "This is info alert", | |
| "summary": "This is the incident summary", | |
| "entity_id": 12345, | |
| "payload": { | |
| "status": "ACME Payments are failing", | |
| "severity": "1", | |
| "project": "kubeprod" | |
| }, | |
| "urls": [ | |
| { | |
| "link_url": "https://www.example.com/alerts/12345/", | |
| "link_text": "Alert URL" | |
| } | |
| ], | |
| "sla": "cfb927ec-8316-4464-8770-deca07f75b49", | |
| "escalation_policy": "272841e2-2cbf-40a8-9a9a-64227fd3d722", | |
| "priority": "b535c8c0-7c75-4911-a9c6-27a3be2f2da9", | |
| "stakeholders": { | |
| "users": [ | |
| "85e1569d-79a4-4205-850f-a", | |
| "b80daf25-8a47-4365-baa4-0" | |
| ], | |
| "teams": [ | |
| "4a106e05-09af-4aef-9439-40c6f4aaff0f", | |
| "c1de7905-352f-424a-b8d0-f84406f76314" | |
| ], | |
| "emails": [ | |
| "[email protected]" | |
| ] | |
| }, | |
| "tags": [ | |
| "bdb4f470-b04b-4036-b8a4-5b66d9097b25", | |
| "ee99cc9c-a8ef-4a69-937c-07379e99d853" | |
| ], | |
| "stakeholder_comms": { | |
| "subject": "New incident #12345 triggered", | |
| "body": "We’re currently experiencing an incident affecting billing. Our team is actively working on it, and we’ll provide updates as soon as we have more information.", | |
| "timezone": "UTC", | |
| "created_by": "85e1569d-79a4-4205-850f-a" | |
| } | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/GenericEventPayload" | |
| }, | |
| "example": { | |
| "alert_type": "info", | |
| "message": "This is info alert", | |
| "summary": "This is the incident summary", | |
| "entity_id": 12345, | |
| "payload": { | |
| "status": "ACME Payments are failing", | |
| "severity": "1", | |
| "project": "kubeprod" | |
| }, | |
| "urls": [ | |
| { | |
| "link_url": "https://www.example.com/alerts/1234/", | |
| "link_text": "Alert URL" | |
| } | |
| ], | |
| "sla": "cfb927ec-8316-4464-8770-deca07f75b49", | |
| "escalation_policy": "272841e2-2cbf-40a8-9a9a-64227fd3d722", | |
| "priority": "b535c8c0-7c75-4911-a9c6-27a3be2f2da9", | |
| "stakeholders": { | |
| "users": [ | |
| "85e1569d-79a4-4205-850f-a", | |
| "b80daf25-8a47-4365-baa4-0" | |
| ], | |
| "teams": [ | |
| "4a106e05-09af-4aef-9439-40c6f4aaff0f", | |
| "c1de7905-352f-424a-b8d0-f84406f76314" | |
| ], | |
| "emails": [ | |
| "[email protected]" | |
| ] | |
| }, | |
| "tags": [ | |
| "bdb4f470-b04b-4036-b8a4-5b66d9097b25", | |
| "ee99cc9c-a8ef-4a69-937c-07379e99d853" | |
| ], | |
| "stakeholder_comms": { | |
| "subject": "New incident #12345 triggered", | |
| "body": "We’re currently experiencing an incident affecting billing. Our team is actively working on it, and we’ll provide updates as soon as we have more information.", | |
| "timezone": "UTC", | |
| "created_by": "85e1569d-79a4-4205-850f-a" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/EventV3" | |
| }, | |
| "example": { | |
| "message": "success", | |
| "trace_id": "2f7c427c-3dd4-4bfc-84c5-74a1fb936df7" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/EventV3" | |
| }, | |
| "example": { | |
| "message": "success", | |
| "trace_id": "174f924aeb6ef4c944e20ebb9d71c2db" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "error": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "error": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/alert/status/{trace_id}/": { | |
| "servers": [ | |
| { | |
| "url": "https://events.zenduty.com" | |
| } | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "trace_id", | |
| "in": "path", | |
| "description": "trace id of the alert object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "get": { | |
| "tags": [ | |
| "Events" | |
| ], | |
| "summary": "Get the status of an Alert", | |
| "description": "Get the Alert object for specific trace id.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AlertStatus" | |
| }, | |
| "example": { | |
| "status": "completed", | |
| "alert": "JVPDBpGdpBQgRKdTGz2Qir", | |
| "integration": { | |
| "name": "API" | |
| }, | |
| "incident": { | |
| "incident_number": 123, | |
| "unique_id": "22cWPt3h3REvZCkHVHNsfm" | |
| }, | |
| "suppressed": false, | |
| "is_incident_created": false | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/AlertStatus" | |
| }, | |
| "example": { | |
| "status": "completed", | |
| "alert": "JVPDBpGdpBQgRKdTGz2Qir", | |
| "integration": { | |
| "name": "API" | |
| }, | |
| "incident": { | |
| "incident_number": 123, | |
| "unique_id": "22cWPt3h3REvZCkHVHNsfm" | |
| }, | |
| "suppressed": false, | |
| "is_incident_created": false | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/incidents/{incident_number}/alerts/": { | |
| "parameters": [ | |
| { | |
| "name": "incident_number", | |
| "in": "path", | |
| "description": "incident_number of the Incident object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "get": { | |
| "tags": [ | |
| "Incident Alerts" | |
| ], | |
| "summary": "List all Incident Alert objects", | |
| "description": "Returns a list of Incident Alert objects. The Incident Alert objects are sorted by creation_date, with the most recent Incident Alert object appearing last.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentAlert" | |
| }, | |
| "example": [ | |
| { | |
| "integration_object": { | |
| "name": "Modified Infra custom Integration", | |
| "creation_date": "2022-07-08T12:52:22.906327Z", | |
| "summary": "This is the summary for Infra custom Integration", | |
| "unique_id": "72da1133-a471-4e70-95f3-ce3a5650e9fd", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "integration_key": "5f306dae-b327-4ba9-8f3a-ab4cffd57645", | |
| "is_enabled": true, | |
| "integration_type": 0 | |
| }, | |
| "summary": "", | |
| "incident": 2, | |
| "creation_date": "2022-07-08T13:14:31.300448Z", | |
| "message": "Infra Integration Alert", | |
| "integration": "72da1133-a471-4e70-95f3-ce3a5650e9fd", | |
| "suppressed": false, | |
| "entity_id": "de8cf7fc-08ee-4966-b8d3-b6b631da", | |
| "alert_type": "3", | |
| "unique_id": "xc6qbUftpzkQ28f2MxpRxh", | |
| "images": [ ], | |
| "urls": [ ], | |
| "notes": [ ] | |
| } | |
| ] | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/IncidentAlert" | |
| }, | |
| "example": [ | |
| { | |
| "integration_object": { | |
| "name": "Modified Infra custom Integration", | |
| "creation_date": "2022-07-08T12:52:22.906327Z", | |
| "summary": "This is the summary for Infra custom Integration", | |
| "unique_id": "72da1133-a471-4e70-95f3-ce3a5650e9fd", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "integration_key": "5f306dae-b327-4ba9-8f3a-ab4cffd57645", | |
| "is_enabled": true, | |
| "integration_type": 0 | |
| }, | |
| "summary": "", | |
| "incident": 2, | |
| "creation_date": "2022-07-08T13:14:31.300448Z", | |
| "message": "Infra Integration Alert", | |
| "integration": "72da1133-a471-4e70-95f3-ce3a5650e9fd", | |
| "suppressed": false, | |
| "entity_id": "de8cf7fc-08ee-4966-b8d3-b6b631da", | |
| "alert_type": "3", | |
| "unique_id": "xc6qbUftpzkQ28f2MxpRxh", | |
| "images": [ ], | |
| "urls": [ ], | |
| "notes": [ ] | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/teams/{}/tags/": { | |
| "parameters": [ | |
| { | |
| "name": "team_id", | |
| "in": "path", | |
| "description": "unique_id of the Team object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "post": { | |
| "tags": [ | |
| "Tags" | |
| ], | |
| "summary": "Create the Tag object", | |
| "description": "Create the Tag object by setting the values of all the required parameters passed in the request body.", | |
| "requestBody": { | |
| "description": "Request body parameters to create the Tag object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TagPayload" | |
| }, | |
| "example": { | |
| "name": "New Infra Tag", | |
| "color": "red" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TagPayload" | |
| }, | |
| "example": { | |
| "name": "New Infra Tag", | |
| "color": "red" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TagPostPut" | |
| }, | |
| "example": { | |
| "unique_id": "fbdd8538-8651-4684-bb5e-7cc4b0c7528d", | |
| "name": "New Infra Tag", | |
| "creation_date": "2022-07-08T14:11:20.697785Z", | |
| "color": "red", | |
| "team": 3674 | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TagPostPut" | |
| }, | |
| "example": { | |
| "unique_id": "fbdd8538-8651-4684-bb5e-7cc4b0c7528d", | |
| "name": "New Infra Tag", | |
| "creation_date": "2022-07-08T14:11:20.697785Z", | |
| "color": "red", | |
| "team": 3674 | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "get": { | |
| "tags": [ | |
| "Tags" | |
| ], | |
| "summary": "List all Tag objects", | |
| "description": "Returns a list of Tag objects. The Tag objects are sorted by creation_date, with the most recent Tag object appearing last.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TagGet" | |
| }, | |
| "example": [ | |
| { | |
| "unique_id": "b89de69e-3f7b-4425-a19e-9a56b1e9dbf4", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "name": "Infra Tag", | |
| "creation_date": "2022-07-08T12:29:58.621021Z", | |
| "color": "volcano" | |
| }, | |
| { | |
| "unique_id": "fbdd8538-8651-4684-bb5e-7cc4b0c7528d", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "name": "New Infra Tag", | |
| "creation_date": "2022-07-08T14:11:20.697785Z", | |
| "color": "red" | |
| } | |
| ] | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TagGet" | |
| }, | |
| "example": [ | |
| { | |
| "unique_id": "b89de69e-3f7b-4425-a19e-9a56b1e9dbf4", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "name": "Infra Tag", | |
| "creation_date": "2022-07-08T12:29:58.621021Z", | |
| "color": "volcano" | |
| }, | |
| { | |
| "unique_id": "fbdd8538-8651-4684-bb5e-7cc4b0c7528d", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "name": "New Infra Tag", | |
| "creation_date": "2022-07-08T14:11:20.697785Z", | |
| "color": "red" | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/teams/{team_id}/tags/{tag_id}/": { | |
| "parameters": [ | |
| { | |
| "name": "team_id", | |
| "in": "path", | |
| "description": "unique_id of the Team object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| }, | |
| { | |
| "name": "tag_id", | |
| "in": "path", | |
| "description": "unique_id of the Tag object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "get": { | |
| "tags": [ | |
| "Tags" | |
| ], | |
| "summary": "Retrieve the Tag object", | |
| "description": "Retrieve the specified Tag object.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TagGet" | |
| }, | |
| "example": { | |
| "unique_id": "fbdd8538-8651-4684-bb5e-7cc4b0c7528d", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "name": "New Infra Tag", | |
| "creation_date": "2022-07-08T14:11:20.697785Z", | |
| "color": "red" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TagGet" | |
| }, | |
| "example": { | |
| "unique_id": "fbdd8538-8651-4684-bb5e-7cc4b0c7528d", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "name": "New Infra Tag", | |
| "creation_date": "2022-07-08T14:11:20.697785Z", | |
| "color": "red" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": [ | |
| "Tags" | |
| ], | |
| "summary": "Update the Tag object", | |
| "description": "Updates the specified Tag object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.", | |
| "requestBody": { | |
| "description": "Request body parameters to update the Tag object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TagPayload" | |
| }, | |
| "example": { | |
| "name": "Modified Infra Tag", | |
| "color": "orange" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TagPayload" | |
| }, | |
| "example": { | |
| "name": "Modified Infra Tag", | |
| "color": "orange" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TagPostPut" | |
| }, | |
| "example": { | |
| "unique_id": "fbdd8538-8651-4684-bb5e-7cc4b0c7528d", | |
| "name": "Modified Infra Tag", | |
| "creation_date": "2022-07-08T14:11:20.697785Z", | |
| "color": "orange", | |
| "team": 3674 | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TagPostPut" | |
| }, | |
| "example": { | |
| "unique_id": "fbdd8538-8651-4684-bb5e-7cc4b0c7528d", | |
| "name": "Modified Infra Tag", | |
| "creation_date": "2022-07-08T14:11:20.697785Z", | |
| "color": "orange", | |
| "team": 3674 | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Tags" | |
| ], | |
| "summary": "Delete the Tag object", | |
| "description": "Delete the specified Tag object permanently.", | |
| "responses": { | |
| "204": { | |
| "description": "Success" | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/teams/{}/task_templates/": { | |
| "parameters": [ | |
| { | |
| "name": "team_id", | |
| "in": "path", | |
| "description": "unique_id of the Team object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "post": { | |
| "tags": [ | |
| "Task Templates" | |
| ], | |
| "summary": "Create the Task Template object", | |
| "description": "Create the Template object object by setting the values of all the required parameters passed in the request body.", | |
| "requestBody": { | |
| "description": "Request body parameters to create the Task Template object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TTPayload" | |
| }, | |
| "example": { | |
| "name": "New Infra Task Template", | |
| "summary": "This is the summary for New Infra Task Template" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TTPayload" | |
| }, | |
| "example": { | |
| "name": "New Infra Task Template", | |
| "summary": "This is the summary for New Infra Task Template" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TaskTemplatePostPut" | |
| }, | |
| "example": { | |
| "unique_id": "94d836f1-4fda-4124-a339-ba7975a15559", | |
| "name": "New Infra Task Template", | |
| "creation_date": "2022-07-08T14:22:08.597518Z", | |
| "summary": "This is the summary for New Infra Task Template", | |
| "due_immediately": 0 | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TaskTemplatePostPut" | |
| }, | |
| "example": { | |
| "unique_id": "94d836f1-4fda-4124-a339-ba7975a15559", | |
| "name": "New Infra Task Template", | |
| "creation_date": "2022-07-08T14:22:08.597518Z", | |
| "summary": "This is the summary for New Infra Task Template", | |
| "due_immediately": 0 | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "get": { | |
| "tags": [ | |
| "Task Templates" | |
| ], | |
| "summary": "List all Task Template objects", | |
| "description": "Returns a list of Task Templat objects. The Task Templat objects are sorted by creation_date, with the most recent Task Templat object appearing last.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TaskTemplateGet" | |
| }, | |
| "example": [ | |
| { | |
| "unique_id": "8d2640ca-c6ef-45f0-be5f-61dedcf85032", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "name": "Infra Task Template", | |
| "creation_date": "2022-07-08T12:26:47.700733Z", | |
| "summary": "This is the summary for Infra Task Template", | |
| "due_immediately": 0 | |
| }, | |
| { | |
| "unique_id": "94d836f1-4fda-4124-a339-ba7975a15559", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "name": "New Infra Task Template", | |
| "creation_date": "2022-07-08T14:22:08.597518Z", | |
| "summary": "This is the summary for New Infra Task Template", | |
| "due_immediately": 0 | |
| } | |
| ] | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TaskTemplateGet" | |
| }, | |
| "example": [ | |
| { | |
| "unique_id": "8d2640ca-c6ef-45f0-be5f-61dedcf85032", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "name": "Infra Task Template", | |
| "creation_date": "2022-07-08T12:26:47.700733Z", | |
| "summary": "This is the summary for Infra Task Template", | |
| "due_immediately": 0 | |
| }, | |
| { | |
| "unique_id": "94d836f1-4fda-4124-a339-ba7975a15559", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "name": "New Infra Task Template", | |
| "creation_date": "2022-07-08T14:22:08.597518Z", | |
| "summary": "This is the summary for New Infra Task Template", | |
| "due_immediately": 0 | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/teams/{team_id}/task_templates/{task_template_id}/": { | |
| "parameters": [ | |
| { | |
| "name": "team_id", | |
| "in": "path", | |
| "description": "unique_id of the Team object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| }, | |
| { | |
| "name": "task_template_id", | |
| "in": "path", | |
| "description": "unique_id of the Task Template object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "get": { | |
| "tags": [ | |
| "Task Templates" | |
| ], | |
| "summary": "Retrieve the Task Template object", | |
| "description": "Retrieve the specified Task Template object.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TaskTemplateGet" | |
| }, | |
| "example": { | |
| "unique_id": "94d836f1-4fda-4124-a339-ba7975a15559", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "name": "New Infra Task Template", | |
| "creation_date": "2022-07-08T14:22:08.597518Z", | |
| "summary": "This is the summary for New Infra Task Template", | |
| "due_immediately": 0 | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TaskTemplateGet" | |
| }, | |
| "example": { | |
| "unique_id": "94d836f1-4fda-4124-a339-ba7975a15559", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "name": "New Infra Task Template", | |
| "creation_date": "2022-07-08T14:22:08.597518Z", | |
| "summary": "This is the summary for New Infra Task Template", | |
| "due_immediately": 0 | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": [ | |
| "Task Templates" | |
| ], | |
| "summary": "Update the Task Template object", | |
| "requestBody": { | |
| "description": "Request body parameters to update the Task Template object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TTPayload" | |
| }, | |
| "example": { | |
| "name": "Modified Infra Task Template", | |
| "summary": "This is the summary for Modified Infra Task Template" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TTPayload" | |
| }, | |
| "example": { | |
| "name": "Modified Infra Task Template", | |
| "summary": "This is the summary for Modified Infra Task Template" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TaskTemplatePostPut" | |
| }, | |
| "example": { | |
| "unique_id": "94d836f1-4fda-4124-a339-ba7975a15559", | |
| "name": "Modified Infra Task Template", | |
| "creation_date": "2022-07-08T14:22:08.597518Z", | |
| "summary": "This is the summary for Modified Infra Task Template", | |
| "due_immediately": 0 | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TaskTemplatePostPut" | |
| }, | |
| "example": { | |
| "unique_id": "94d836f1-4fda-4124-a339-ba7975a15559", | |
| "name": "Modified Infra Task Template", | |
| "creation_date": "2022-07-08T14:22:08.597518Z", | |
| "summary": "This is the summary for Modified Infra Task Template", | |
| "due_immediately": 0 | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Task Templates" | |
| ], | |
| "summary": "Delete the Task Template object", | |
| "description": "Delete the specified Task Template object permanently.", | |
| "responses": { | |
| "204": { | |
| "description": "Success" | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/teams/{}/priority/": { | |
| "parameters": [ | |
| { | |
| "name": "team_id", | |
| "in": "path", | |
| "description": "unique_id of the Team object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "post": { | |
| "tags": [ | |
| "Priorities" | |
| ], | |
| "summary": "Create the Priority object", | |
| "description": "Create the Priority object by setting the values of all the required parameters passed in the request body.", | |
| "requestBody": { | |
| "description": "Request body parameters to create the Priority object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PriorityPayload" | |
| }, | |
| "example": { | |
| "name": "New Infra Priority" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PriorityPayload" | |
| }, | |
| "example": { | |
| "name": "New Infra Priority" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PriorityPostPut" | |
| }, | |
| "example": { | |
| "unique_id": "88519afe-3409-4f96-b9de-4464908f6e88", | |
| "name": "New Infra Priority", | |
| "description": "", | |
| "creation_date": "2022-07-08T14:33:05.609863Z", | |
| "color": "", | |
| "team": 3674 | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PriorityPostPut" | |
| }, | |
| "example": { | |
| "unique_id": "88519afe-3409-4f96-b9de-4464908f6e88", | |
| "name": "New Infra Priority", | |
| "description": "", | |
| "creation_date": "2022-07-08T14:33:05.609863Z", | |
| "color": "", | |
| "team": 3674 | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "get": { | |
| "tags": [ | |
| "Priorities" | |
| ], | |
| "summary": "List all Priority objects", | |
| "description": "Returns a list of Priority objects. The Priority objects are sorted by creation_date, with the most recent Priority object appearing last.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PriorityGet" | |
| }, | |
| "example": [ | |
| { | |
| "unique_id": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "description": "This is the description for Infra Priority", | |
| "name": "Infra Priority", | |
| "creation_date": "2022-07-08T12:29:45.895959Z", | |
| "color": "orange" | |
| }, | |
| { | |
| "unique_id": "88519afe-3409-4f96-b9de-4464908f6e88", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "description": "", | |
| "name": "New Infra Priority", | |
| "creation_date": "2022-07-08T14:33:05.609863Z", | |
| "color": "" | |
| } | |
| ] | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PriorityGet" | |
| }, | |
| "example": [ | |
| { | |
| "unique_id": "6d100d52-998b-41c8-8928-a7e3aa68e329", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "description": "This is the description for Infra Priority", | |
| "name": "Infra Priority", | |
| "creation_date": "2022-07-08T12:29:45.895959Z", | |
| "color": "orange" | |
| }, | |
| { | |
| "unique_id": "88519afe-3409-4f96-b9de-4464908f6e88", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "description": "", | |
| "name": "New Infra Priority", | |
| "creation_date": "2022-07-08T14:33:05.609863Z", | |
| "color": "" | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/teams/{team_id}/priority/{priority_id}/": { | |
| "parameters": [ | |
| { | |
| "name": "team_id", | |
| "in": "path", | |
| "description": "unique_id of the Team object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| }, | |
| { | |
| "name": "priority_id", | |
| "in": "path", | |
| "description": "unique_id of the Priority object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "get": { | |
| "tags": [ | |
| "Priorities" | |
| ], | |
| "summary": "Retrieve the Priority object", | |
| "description": "Retrieve the specified Priority object.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PriorityGet" | |
| }, | |
| "example": { | |
| "unique_id": "88519afe-3409-4f96-b9de-4464908f6e88", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "description": "", | |
| "name": "New Infra Priority", | |
| "creation_date": "2022-07-08T14:33:05.609863Z", | |
| "color": "" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PriorityGet" | |
| }, | |
| "example": { | |
| "unique_id": "88519afe-3409-4f96-b9de-4464908f6e88", | |
| "team": "61010821-08aa-4098-94f8-f88f1990b54a", | |
| "description": "", | |
| "name": "New Infra Priority", | |
| "creation_date": "2022-07-08T14:33:05.609863Z", | |
| "color": "" | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": [ | |
| "Priorities" | |
| ], | |
| "summary": "Update the Priority object", | |
| "description": "Updates the specified Priority object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.", | |
| "requestBody": { | |
| "description": "Request body parameters to update the Priority object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PriorityPayload" | |
| }, | |
| "example": { | |
| "name": "Modified Infra Priority" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PriorityPayload" | |
| }, | |
| "example": { | |
| "name": "Modified Infra Priority" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PriorityPostPut" | |
| }, | |
| "example": { | |
| "unique_id": "88519afe-3409-4f96-b9de-4464908f6e88", | |
| "name": "Modified Infra Priority", | |
| "description": "", | |
| "creation_date": "2022-07-08T14:33:05.609863Z", | |
| "color": "", | |
| "team": 3674 | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PriorityPostPut" | |
| }, | |
| "example": { | |
| "unique_id": "88519afe-3409-4f96-b9de-4464908f6e88", | |
| "name": "Modified Infra Priority", | |
| "description": "", | |
| "creation_date": "2022-07-08T14:33:05.609863Z", | |
| "color": "", | |
| "team": 3674 | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Priorities" | |
| ], | |
| "summary": "Delete the Priority object", | |
| "description": "Delete the specified Priority object permanently.", | |
| "responses": { | |
| "204": { | |
| "description": "Success" | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/teams/{}/sla/": { | |
| "parameters": [ | |
| { | |
| "name": "team_id", | |
| "in": "path", | |
| "description": "unique_id of the Team object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "post": { | |
| "tags": [ | |
| "SLA" | |
| ], | |
| "summary": "Create the SLA object", | |
| "description": "Create the SLA object by setting the values of all the required parameters passed in the request body.", | |
| "requestBody": { | |
| "description": "Request body parameters to create the SLA object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/SLAPayload" | |
| }, | |
| "example": { | |
| "name": "New Infra SLA", | |
| "escalations": [ ] | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/SLAPayload" | |
| }, | |
| "example": { | |
| "name": "New Infra SLA", | |
| "escalations": [ ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/SLAPostPut" | |
| }, | |
| "example": { | |
| "escalations": [ ], | |
| "unique_id": "010bc17d-f688-403d-b762-f039fb6f5ad9", | |
| "name": "New Infra SLA", | |
| "description": "", | |
| "is_active": true, | |
| "conditions": "{}", | |
| "acknowledge_time": null, | |
| "resolve_time": null, | |
| "team": 3674 | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/SLAPostPut" | |
| }, | |
| "example": { | |
| "escalations": [ ], | |
| "unique_id": "010bc17d-f688-403d-b762-f039fb6f5ad9", | |
| "name": "New Infra SLA", | |
| "description": "", | |
| "is_active": true, | |
| "conditions": "{}", | |
| "acknowledge_time": null, | |
| "resolve_time": null, | |
| "team": 3674 | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "get": { | |
| "tags": [ | |
| "SLA" | |
| ], | |
| "summary": "List all SLA objects", | |
| "description": "Returns a list of SLA objects.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/SLAGet" | |
| }, | |
| "example": [ | |
| { | |
| "unique_id": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "name": "Infra SLA", | |
| "is_active": true, | |
| "acknowledge_time": 30, | |
| "resolve_time": 60, | |
| "creation_date": "2022-07-08T12:29:08.545605Z" | |
| }, | |
| { | |
| "unique_id": "010bc17d-f688-403d-b762-f039fb6f5ad9", | |
| "name": "New Infra SLA", | |
| "is_active": true, | |
| "acknowledge_time": null, | |
| "resolve_time": null, | |
| "creation_date": "2022-07-08T14:45:21.096085Z" | |
| } | |
| ] | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/SLAGet" | |
| }, | |
| "example": [ | |
| { | |
| "unique_id": "b3c6af23-2b9e-414e-9706-bbf3af76828c", | |
| "name": "Infra SLA", | |
| "is_active": true, | |
| "acknowledge_time": 30, | |
| "resolve_time": 60, | |
| "creation_date": "2022-07-08T12:29:08.545605Z" | |
| }, | |
| { | |
| "unique_id": "010bc17d-f688-403d-b762-f039fb6f5ad9", | |
| "name": "New Infra SLA", | |
| "is_active": true, | |
| "acknowledge_time": null, | |
| "resolve_time": null, | |
| "creation_date": "2022-07-08T14:45:21.096085Z" | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/teams/{team_id}/sla/{sla_id}/": { | |
| "parameters": [ | |
| { | |
| "name": "team_id", | |
| "in": "path", | |
| "description": "unique_id of the Team object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| }, | |
| { | |
| "name": "sla_id", | |
| "in": "path", | |
| "description": "unique_id of the SLA object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "get": { | |
| "tags": [ | |
| "SLA" | |
| ], | |
| "summary": "Retrieve the SLA object", | |
| "description": "Retrieve the specified SLA object.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/SLAGet" | |
| }, | |
| "example": { | |
| "escalations": [ ], | |
| "unique_id": "010bc17d-f688-403d-b762-f039fb6f5ad9", | |
| "name": "New Infra SLA", | |
| "description": "", | |
| "is_active": true, | |
| "conditions": "{}", | |
| "acknowledge_time": null, | |
| "resolve_time": null, | |
| "team": 3674 | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/SLAGet" | |
| }, | |
| "example": { | |
| "escalations": [ ], | |
| "unique_id": "010bc17d-f688-403d-b762-f039fb6f5ad9", | |
| "name": "New Infra SLA", | |
| "description": "", | |
| "is_active": true, | |
| "conditions": "{}", | |
| "acknowledge_time": null, | |
| "resolve_time": null, | |
| "team": 3674 | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": [ | |
| "SLA" | |
| ], | |
| "summary": "Update the SLA object", | |
| "description": "Updates the specified SLA object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.", | |
| "requestBody": { | |
| "description": "Request body parameters to update the SLA object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/SLAPayload" | |
| }, | |
| "example": { | |
| "name": "Modified Infra SLA", | |
| "escalations": [ ] | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/SLAPayload" | |
| }, | |
| "example": { | |
| "name": "Modified Infra SLA", | |
| "escalations": [ ] | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/SLAPostPut" | |
| }, | |
| "example": { | |
| "escalations": [ ], | |
| "unique_id": "010bc17d-f688-403d-b762-f039fb6f5ad9", | |
| "name": "Modified Infra SLA", | |
| "description": "", | |
| "is_active": true, | |
| "conditions": "{}", | |
| "acknowledge_time": null, | |
| "resolve_time": null, | |
| "team": 3674 | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/SLAPostPut" | |
| }, | |
| "example": { | |
| "escalations": [ ], | |
| "unique_id": "010bc17d-f688-403d-b762-f039fb6f5ad9", | |
| "name": "Modified Infra SLA", | |
| "description": "", | |
| "is_active": true, | |
| "conditions": "{}", | |
| "acknowledge_time": null, | |
| "resolve_time": null, | |
| "team": 3674 | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "SLA" | |
| ], | |
| "summary": "Delete the SLA object", | |
| "description": "Delete the specified SLA object permanently.", | |
| "responses": { | |
| "204": { | |
| "description": "Success" | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/teams/{}/maintenance/": { | |
| "parameters": [ | |
| { | |
| "name": "team_id", | |
| "in": "path", | |
| "description": "unique_id of the Team object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "post": { | |
| "tags": [ | |
| "Team Maintenance Mode" | |
| ], | |
| "summary": "Create the Team Maintenance Mode object", | |
| "description": "Create the Team Maintenance Mode object by setting the values of all the required parameters passed in the request body.", | |
| "requestBody": { | |
| "description": "Request body parameters to create the Team Maintenance Mode object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TMMPayload" | |
| }, | |
| "example": { | |
| "name": "New Infra Team Maintenance", | |
| "services": [ | |
| { | |
| "unique_id": "9b5a0301-3325-49b6-b54c-71d79a50c82d", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f" | |
| } | |
| ], | |
| "start_time": "2022-07-08T18:06:00Z", | |
| "end_time": "2022-07-15T18:06:00Z" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TMMPayload" | |
| }, | |
| "example": { | |
| "name": "New Infra Team Maintenance", | |
| "services": [ | |
| { | |
| "unique_id": "9b5a0301-3325-49b6-b54c-71d79a50c82d", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f" | |
| } | |
| ], | |
| "start_time": "2022-07-08T18:06:00Z", | |
| "end_time": "2022-07-15T18:06:00Z" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TMM" | |
| }, | |
| "example": { | |
| "unique_id": "162055d5-9646-43df-95cb-2ac511bf34ef", | |
| "start_time": "2022-07-08T18:06:00Z", | |
| "end_time": "2022-07-15T18:06:00Z", | |
| "repeat_interval": 0, | |
| "services": [ | |
| { | |
| "unique_id": "5390bdd2-8e97-44cb-9d48-db32364511b1", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f" | |
| } | |
| ], | |
| "creation_date": "2022-07-08T14:55:46.681634Z", | |
| "name": "New Infra Team Maintenance", | |
| "time_zone": "UTC", | |
| "repeat_until": null | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TMM" | |
| }, | |
| "example": { | |
| "unique_id": "162055d5-9646-43df-95cb-2ac511bf34ef", | |
| "start_time": "2022-07-08T18:06:00Z", | |
| "end_time": "2022-07-15T18:06:00Z", | |
| "repeat_interval": 0, | |
| "services": [ | |
| { | |
| "unique_id": "5390bdd2-8e97-44cb-9d48-db32364511b1", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f" | |
| } | |
| ], | |
| "creation_date": "2022-07-08T14:55:46.681634Z", | |
| "name": "New Infra Team Maintenance", | |
| "time_zone": "UTC", | |
| "repeat_until": null | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "get": { | |
| "tags": [ | |
| "Team Maintenance Mode" | |
| ], | |
| "summary": "List all Team Maintenance Mode objects", | |
| "description": "Returns a list of Team Maintenance Mode objects. The Team Maintenance Mode objects are sorted by creation_date, with the most recent Team Maintenance Mode object appearing last.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TMM" | |
| }, | |
| "example": [ | |
| { | |
| "unique_id": "de38ec19-283f-4501-90df-1e7eb74191cb", | |
| "start_time": "2022-07-08T18:06:00Z", | |
| "end_time": "2022-07-15T18:06:00Z", | |
| "repeat_interval": 4, | |
| "services": [ | |
| { | |
| "unique_id": "9b5a0301-3325-49b6-b54c-71d79a50c82d", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f" | |
| } | |
| ], | |
| "creation_date": "2022-07-08T12:36:43.932588Z", | |
| "name": "Infra Team Maintenance", | |
| "time_zone": "UTC", | |
| "repeat_until": "2022-07-12T12:36:42.137000Z" | |
| }, | |
| { | |
| "unique_id": "162055d5-9646-43df-95cb-2ac511bf34ef", | |
| "start_time": "2022-07-08T18:06:00Z", | |
| "end_time": "2022-07-15T18:06:00Z", | |
| "repeat_interval": 0, | |
| "services": [ | |
| { | |
| "unique_id": "5390bdd2-8e97-44cb-9d48-db32364511b1", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f" | |
| } | |
| ], | |
| "creation_date": "2022-07-08T14:55:46.681634Z", | |
| "name": "New Infra Team Maintenance", | |
| "time_zone": "UTC", | |
| "repeat_until": null | |
| } | |
| ] | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TMM" | |
| }, | |
| "example": [ | |
| { | |
| "unique_id": "de38ec19-283f-4501-90df-1e7eb74191cb", | |
| "start_time": "2022-07-08T18:06:00Z", | |
| "end_time": "2022-07-15T18:06:00Z", | |
| "repeat_interval": 4, | |
| "services": [ | |
| { | |
| "unique_id": "9b5a0301-3325-49b6-b54c-71d79a50c82d", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f" | |
| } | |
| ], | |
| "creation_date": "2022-07-08T12:36:43.932588Z", | |
| "name": "Infra Team Maintenance", | |
| "time_zone": "UTC", | |
| "repeat_until": "2022-07-12T12:36:42.137000Z" | |
| }, | |
| { | |
| "unique_id": "162055d5-9646-43df-95cb-2ac511bf34ef", | |
| "start_time": "2022-07-08T18:06:00Z", | |
| "end_time": "2022-07-15T18:06:00Z", | |
| "repeat_interval": 0, | |
| "services": [ | |
| { | |
| "unique_id": "5390bdd2-8e97-44cb-9d48-db32364511b1", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f" | |
| } | |
| ], | |
| "creation_date": "2022-07-08T14:55:46.681634Z", | |
| "name": "New Infra Team Maintenance", | |
| "time_zone": "UTC", | |
| "repeat_until": null | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/teams/{team_id}/maintenance/{maintenance_id}/": { | |
| "parameters": [ | |
| { | |
| "name": "team_id", | |
| "in": "path", | |
| "description": "unique_id of the Team object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| }, | |
| { | |
| "name": "maintenance_id", | |
| "in": "path", | |
| "description": "unique_id of the Team Maintenance Mode object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "get": { | |
| "tags": [ | |
| "Team Maintenance Mode" | |
| ], | |
| "summary": "Retrieve the Team Maintenance Mode object", | |
| "description": "Retrieve the specified Team Maintenance Mode object.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TMM" | |
| }, | |
| "example": { | |
| "unique_id": "162055d5-9646-43df-95cb-2ac511bf34ef", | |
| "start_time": "2022-07-08T18:06:00Z", | |
| "end_time": "2022-07-15T18:06:00Z", | |
| "repeat_interval": 0, | |
| "services": [ | |
| { | |
| "unique_id": "5390bdd2-8e97-44cb-9d48-db32364511b1", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f" | |
| } | |
| ], | |
| "creation_date": "2022-07-08T14:55:46.681634Z", | |
| "name": "New Infra Team Maintenance", | |
| "time_zone": "UTC", | |
| "repeat_until": null | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TMM" | |
| }, | |
| "example": { | |
| "unique_id": "162055d5-9646-43df-95cb-2ac511bf34ef", | |
| "start_time": "2022-07-08T18:06:00Z", | |
| "end_time": "2022-07-15T18:06:00Z", | |
| "repeat_interval": 0, | |
| "services": [ | |
| { | |
| "unique_id": "5390bdd2-8e97-44cb-9d48-db32364511b1", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f" | |
| } | |
| ], | |
| "creation_date": "2022-07-08T14:55:46.681634Z", | |
| "name": "New Infra Team Maintenance", | |
| "time_zone": "UTC", | |
| "repeat_until": null | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "put": { | |
| "tags": [ | |
| "Team Maintenance Mode" | |
| ], | |
| "summary": "Update Team Maintenance Mode object", | |
| "description": "Updates the specified Team Maintenance Mode object by setting the values of the parameters passed in the request body. Any parameters not provided will be left unchanged.", | |
| "requestBody": { | |
| "description": "Request body parameters to update the Team Maintenance Mode object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TMMPayload" | |
| }, | |
| "example": { | |
| "name": "Modified Infra Team Maintenance", | |
| "services": [ | |
| { | |
| "unique_id": "9b5a0301-3325-49b6-b54c-71d79a50c82d", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f" | |
| } | |
| ], | |
| "start_time": "2022-07-08T18:06:00Z", | |
| "end_time": "2022-07-15T18:06:00Z" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TMM" | |
| }, | |
| "example": { | |
| "unique_id": "162055d5-9646-43df-95cb-2ac511bf34ef", | |
| "start_time": "2022-07-08T18:06:00Z", | |
| "end_time": "2022-07-15T18:06:00Z", | |
| "repeat_interval": null, | |
| "services": [ | |
| { | |
| "unique_id": "5390bdd2-8e97-44cb-9d48-db32364511b1", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f" | |
| } | |
| ], | |
| "creation_date": "2022-07-08T14:55:46.681634Z", | |
| "name": "Modified Infra Team Maintenance", | |
| "time_zone": null, | |
| "repeat_until": null | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/TMM" | |
| }, | |
| "example": { | |
| "unique_id": "162055d5-9646-43df-95cb-2ac511bf34ef", | |
| "start_time": "2022-07-08T18:06:00Z", | |
| "end_time": "2022-07-15T18:06:00Z", | |
| "repeat_interval": null, | |
| "services": [ | |
| { | |
| "unique_id": "5390bdd2-8e97-44cb-9d48-db32364511b1", | |
| "service": "191f5e2c-515e-4ee0-b501-3a292f8dae2f" | |
| } | |
| ], | |
| "creation_date": "2022-07-08T14:55:46.681634Z", | |
| "name": "Modified Infra Team Maintenance", | |
| "time_zone": null, | |
| "repeat_until": null | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "delete": { | |
| "tags": [ | |
| "Team Maintenance Mode" | |
| ], | |
| "summary": "Delete the Team Maintenance Mode object", | |
| "description": "Delete the specified Team Maintenance Mode object permanently.", | |
| "responses": { | |
| "204": { | |
| "description": "Success" | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/teams/{}/postmortem/": { | |
| "parameters": [ | |
| { | |
| "name": "team_id", | |
| "in": "path", | |
| "description": "unique_id of the Team object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "post": { | |
| "tags": [ | |
| "Postmortem" | |
| ], | |
| "summary": "Create the Postmortem object", | |
| "description": "Create the Postmortem object by setting the values of all the required parameters passed in the request body.", | |
| "requestBody": { | |
| "description": "Request body parameters to create the Postmortem object", | |
| "required": true, | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PostmortemPayload" | |
| }, | |
| "example": { | |
| "author": "85b563c8-18d0-4668-9462-9", | |
| "incidents": [ | |
| { | |
| "incident": "U2gGkyJnLQLkX2zQnvkpLW" | |
| } | |
| ], | |
| "title": "New Infra Postmortem" | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PostmortemPayload" | |
| }, | |
| "example": { | |
| "author": "85b563c8-18d0-4668-9462-9", | |
| "incidents": [ | |
| { | |
| "incident": "U2gGkyJnLQLkX2zQnvkpLW" | |
| } | |
| ], | |
| "title": "New Infra Postmortem" | |
| } | |
| } | |
| } | |
| }, | |
| "responses": { | |
| "201": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PostmortemPostPut" | |
| }, | |
| "example": { | |
| "unique_id": "f6778c71-eba2-49da-b226-ca27172d7303", | |
| "author": "85b563c8-18d0-4668-9462-9", | |
| "status": "", | |
| "incidents": [ | |
| { | |
| "unique_id": "80673be0-aa18-4f70-ae92-dec403dfc32e", | |
| "incident": "U2gGkyJnLQLkX2zQnvkpLW" | |
| } | |
| ], | |
| "author_name": "Vishwa Krishnakumar", | |
| "title": "New Infra Postmortem", | |
| "postmortem_data": "", | |
| "download_status": 0 | |
| } | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PostmortemPostPut" | |
| }, | |
| "example": { | |
| "unique_id": "f6778c71-eba2-49da-b226-ca27172d7303", | |
| "author": "85b563c8-18d0-4668-9462-9", | |
| "status": "", | |
| "incidents": [ | |
| { | |
| "unique_id": "80673be0-aa18-4f70-ae92-dec403dfc32e", | |
| "incident": "U2gGkyJnLQLkX2zQnvkpLW" | |
| } | |
| ], | |
| "author_name": "Vishwa Krishnakumar", | |
| "title": "New Infra Postmortem", | |
| "postmortem_data": "", | |
| "download_status": 0 | |
| } | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "get": { | |
| "tags": [ | |
| "Postmortem" | |
| ], | |
| "summary": "List all Postmortem objects", | |
| "description": "Returns a list of Postmortem objects.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PostmortemGet" | |
| }, | |
| "example": [ | |
| { | |
| "unique_id": "4d0726ca-664f-4d07-8005-a9ba2c654cc9", | |
| "author": "85b563c8-18d0-4668-9462-9", | |
| "status": "Critical", | |
| "postmortem_data": "<p>This is the Infra Postmortem data</p>", | |
| "incidents": [ | |
| { | |
| "unique_id": "d86daf72-a2f2-4d54-adec-19f4380ada48", | |
| "incident": { | |
| "unique_id": "U2gGkyJnLQLkX2zQnvkpLW", | |
| "title": "Infra Incident", | |
| "incident_number": 1 | |
| } | |
| } | |
| ], | |
| "author_name": "Vishwa Krishnakumar", | |
| "title": "Infra Postmortem", | |
| "download_status": 1, | |
| "amazon_link": "https://zenduty-dev-report.s3.amazonaws.com/", | |
| "creation_date": "2022-07-08T12:35:38.234310Z" | |
| }, | |
| { | |
| "unique_id": "f6778c71-eba2-49da-b226-ca27172d7303", | |
| "author": "85b563c8-18d0-4668-9462-9", | |
| "status": "", | |
| "postmortem_data": "", | |
| "incidents": [ | |
| { | |
| "unique_id": "80673be0-aa18-4f70-ae92-dec403dfc32e", | |
| "incident": { | |
| "unique_id": "U2gGkyJnLQLkX2zQnvkpLW", | |
| "title": "Infra Incident", | |
| "incident_number": 1 | |
| } | |
| } | |
| ], | |
| "author_name": "Vishwa Krishnakumar", | |
| "title": "New Infra Postmortem", | |
| "download_status": 0, | |
| "amazon_link": "https://zenduty-dev-report.s3.amazonaws.com/", | |
| "creation_date": "2022-07-08T15:08:01.521494Z" | |
| } | |
| ] | |
| }, | |
| "application/xml": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PostmortemGet" | |
| }, | |
| "example": [ | |
| { | |
| "unique_id": "4d0726ca-664f-4d07-8005-a9ba2c654cc9", | |
| "author": "85b563c8-18d0-4668-9462-9", | |
| "status": "Critical", | |
| "postmortem_data": "<p>This is the Infra Postmortem data</p>", | |
| "incidents": [ | |
| { | |
| "unique_id": "d86daf72-a2f2-4d54-adec-19f4380ada48", | |
| "incident": { | |
| "unique_id": "U2gGkyJnLQLkX2zQnvkpLW", | |
| "title": "Infra Incident", | |
| "incident_number": 1 | |
| } | |
| } | |
| ], | |
| "author_name": "Vishwa Krishnakumar", | |
| "title": "Infra Postmortem", | |
| "download_status": 1, | |
| "amazon_link": "https://zenduty-dev-report.s3.amazonaws.com/", | |
| "creation_date": "2022-07-08T12:35:38.234310Z" | |
| }, | |
| { | |
| "unique_id": "f6778c71-eba2-49da-b226-ca27172d7303", | |
| "author": "85b563c8-18d0-4668-9462-9", | |
| "status": "", | |
| "postmortem_data": "", | |
| "incidents": [ | |
| { | |
| "unique_id": "80673be0-aa18-4f70-ae92-dec403dfc32e", | |
| "incident": { | |
| "unique_id": "U2gGkyJnLQLkX2zQnvkpLW", | |
| "title": "Infra Incident", | |
| "incident_number": 1 | |
| } | |
| } | |
| ], | |
| "author_name": "Vishwa Krishnakumar", | |
| "title": "New Infra Postmortem", | |
| "download_status": 0, | |
| "amazon_link": "https://zenduty-dev-report.s3.amazonaws.com/", | |
| "creation_date": "2022-07-08T15:08:01.521494Z" | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad Request", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "This request can not be processed." | |
| } | |
| } | |
| } | |
| }, | |
| "403": { | |
| "description": "Forbidden", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "You do not have permission to perform this action." | |
| } | |
| } | |
| } | |
| }, | |
| "404": { | |
| "description": "Not Found", | |
| "content": { | |
| "application/json": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| }, | |
| "application/xml": { | |
| "example": { | |
| "detail": "Not Found." | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "/api/account/teams/{team_id}/postmortem/{postmortem_id}/": { | |
| "parameters": [ | |
| { | |
| "name": "team_id", | |
| "in": "path", | |
| "description": "unique_id of the Team object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| }, | |
| { | |
| "name": "postmortem_id", | |
| "in": "path", | |
| "description": "unique_id of the Postmortem object", | |
| "schema": { | |
| "type": "string" | |
| }, | |
| "required": true | |
| } | |
| ], | |
| "get": { | |
| "tags": [ | |
| "Postmortem" | |
| ], | |
| "summary": "Retrieve the Postmortem object", | |
| "description": "Retrieve the specified Postmortem object.", | |
| "responses": { | |
| "200": { | |
| "description": "OK", | |
| "content": { | |
| "application/json": { | |
| "schema": { | |
| "$ref": "#/components/schemas/PostmortemGet" | |
| }, | |
| "example": { | |
| "unique_id": "f6778c71-eba2-49da-b226-ca27172d7303", | |
| "author": "85b563c8-18d0-4668-9462-9", | |
| "status": "", | |
| "postmortem_data": "", | |
| "incidents": [ | |
| { | |
| "unique_id": "80673be0-aa18-4f70-ae92-dec403dfc32e", | |
| "incident": { | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment