{ "info": { "_postman_id": "1fe35c84-a7b8-47ff-820e-7eba8648516d", "name": "JSM Operations API", "description": "Operations APIs for Jira Service Management", "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json" }, "item": [ { "name": "Alerts", "description": "The Alerts API is designed to manage alerts which provide critical context and enable teams to manage incidents effectively. This resource represents the all contracts of alerts in Jira Service Management.", "item": [ { "name": "Get request status", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/alerts/requests/:id", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Identifier of the questioned request. Please note that ID of the request was provided within response.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Alert creation, deletion, and action requests are processed asynchronously to provide higher availability and scalability. This endpoint is used to track the status and alert details (if any) of the request whose identifier is given.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "List alerts", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/alerts", "query": [ { "key": "size", "value": "{{size}}", "disabled": true, "description": "Maximum number of items to provide in the result." }, { "key": "sort", "value": "{{sort}}", "disabled": true, "description": "Name of the field that result set will be sorted by." }, { "key": "offset", "value": "{{offset}}", "disabled": true, "description": "The offset parameter controls the starting point within the collection of resource results." }, { "key": "order", "value": "{{order}}", "disabled": true, "description": "Sorting order of the result set." }, { "key": "query", "value": "{{query}}", "disabled": true, "description": "This parameter is used to filter the alerts based on specified criteria. It accepts a string value that represents the search query. This parameter provides a powerful way to retrieve alerts that meet certain conditions or contain specific information. You can refer Alerts Search Query Help for further information about search queries." }, { "key": "from", "value": "{{from}}", "disabled": true, "description": "The starting date-time to consider while filtering the alerts. It helps in narrowing down the list of alerts to a specific time frame." }, { "key": "to", "value": "{{to}}", "disabled": true, "description": "The ending date-time to consider while filtering the alerts. Used in conjunction with 'from', it defines the specific time window to focus on for the alert listing." } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This endpoint is designed to provide a comprehensive view of all alerts in your system. This API supports pagination and filtering with allowing you to customize the view based on your specific needs. More than 20000 alerts cannot be retrieved. Sum of offset and size should be lower than 20K.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Create alert", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/alerts", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "The endpoint allows users to programmatically generate alerts with customized parameters. It integrates with existing systems to transform raw data into actionable alerts, ensuring timely notifications for incident management.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get alert", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/alerts/:id", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Identifier of the alert.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This endpoint provides users the ability to retrieve comprehensive details of a specific alert using its unique id.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Delete alert", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/alerts/:id", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Identifier of the alert.", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "This endpoint is utilized to delete alerts, along with the unique identifier of the alert.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Acknowledge alert", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/alerts/:id/acknowledge", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Identifier of the alert.", "disabled": false } ] }, "method": "POST", "header": [], "description": "This endpoint is used to acknowledge an existing alert. Acknowledging an alert indicates that it has been received and is being acted upon, preventing duplicate efforts and coordinating response actions.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Assign alert", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/alerts/:id/assign", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Identifier of the alert.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "This endpoint is used to assign an existing alert to a user or a group. Assigning an alert ensures that responsibility for addressing the alert is clearly established, promoting efficient alert management and quicker resolution times. It is a crucial operation for coordinating incident response efforts effectively.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Add responder to alert", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/alerts/:id/responders", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Identifier of the alert.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "This endpoint is used to assign a responder to an existing alert. The responder is the individual or team responsible for addressing the alert. This operation streamlines the alert management process by ensuring that alerts are directed to the correct parties for timely resolution.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Add extra properties to alert", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/alerts/:id/extra-properties", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Identifier of the alert.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "This endpoint is used to enrich existing alerts with additional information to provide more detailed context.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Delete extra properties from alert", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/alerts/:id/extra-properties", "query": [], "variable": [ { "key": "alertId", "value": "{{alertId}}", "description": "Identifier of the alert.", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "This endpoint is used to delete the multiple extra properties.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Add tags to alert", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/alerts/:id/tags", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Identifier of the alert.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "This endpoint is used to add tags to an existing alert. Tags provide a means to categorize and manage alerts more effectively, enabling quick identification and sorting of related alerts based on the assigned tags.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Delete tags from alert", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/alerts/:id/tags", "query": [], "variable": [ { "key": "alertId", "value": "{{alertId}}", "description": "Identifier of the alert.", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "This endpoint is used to remove tags from an existing alert. This operation allows for the modification of alert categorization and can aid in the management process by enabling alerts to be unlinked from certain categories or groups, as represented by their tags.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Close alert", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/alerts/:id/close", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Identifier of the alert.", "disabled": false } ] }, "method": "POST", "header": [], "description": "This endpoint is used to close an existing alert. Closing an alert indicates that the issue has been resolved and no further action is necessary. This operation is essential for maintaining an accurate overview of the operational status and for ensuring that only active, unresolved issues remain open.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Escalate alert to next", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/alerts/:id/escalate", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Identifier of the alert.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "This endpoint is used to escalate an existing alert. Escalation triggers the defined escalation policies which could involve notifying additional users or teams, or increasing the frequency of notifications for the alert. This operation is particularly useful in situations where an alert requires urgent attention or has not been addressed within a certain timeframe according to the pre-set escalation paths.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Execute custom action", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/alerts/:id/action", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "This endpoint is used to execute custom actions on an existing alert. Custom actions allow for more flexible and specific responses to alerts, including integrations with external systems or triggering complex workflows. This operation is a powerful tool for extending the capabilities of the alert management process beyond predefined actions.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Snooze alert", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/alerts/:id/snooze", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Identifier of the alert.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "This endpoint is used to snooze an existing alert. The snooze operation temporarily silences the alert, preventing it from triggering notifications for a specified period. This is particularly useful for managing alerts that require attention at a later time or to reduce noise from non-critical alerts.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Unacknowledge alert", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/alerts/:id/unacknowledge", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Identifier of the alert.", "disabled": false } ] }, "method": "POST", "header": [], "description": "This endpoint is used to set the 'acknowledged' property of an existing alert as 'false', effectively marking it's status as 'open'. This allows for better tracking and management of alerts by indicating that an alert has not yet been acknowledged or addressed.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "List alert notes", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/alerts/:id/notes", "query": [ { "key": "after", "value": "{{after}}", "disabled": true, "description": "This parameter is used in pagination for the alert notes. It accepts a string key of the last record from the previous page. The system will return the next page of notes that come after this specified key. This is useful for fetching subsequent segments of data when there are more notes than the size specified." }, { "key": "size", "value": "{{size}}", "disabled": true, "description": "This parameter is used to limit the number of alert notes returned by the system. It accepts an integer that specifies the maximum number of notes to be retrieved." } ], "variable": [ { "key": "id", "value": "{{id}}", "description": "Identifier of the alert.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This endpoint is used to retrieve a list of notes for a specified alert. Notes provide additional information or context about an alert, helping to enhance the understanding and management of alerts.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Add alert note", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/alerts/:id/notes", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Identifier of the alert.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This endpoint is used to add a note to an existing alert.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Delete alert note", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/alerts/:alertId/notes/:id", "query": [], "variable": [ { "key": "alertId", "value": "{{alertId}}", "description": "Identifier of the alert.", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Identifier of the note.", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "This endpoint is used to delete a note from an existing alert.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Update alert note", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/alerts/:alertId/notes/:id", "query": [], "variable": [ { "key": "alertId", "value": "{{alertId}}", "description": "Identifier of the alert.", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Identifier of the note.", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This endpoint is used to update a note associated with a specific alert.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Update alert priority", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/alerts/:id/priority", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Identifier of the alert.", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "This endpoint is used to modify the priority level of an existing alert. This endpoint allows for dynamic control over alert urgency. This aids in effective incident management by ensuring the most critical issues are addressed first.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Update alert message", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/alerts/:id/message", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Identifier of the alert.", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "This endpoint is used to update the message of an existing alert. This endpoint plays a crucial role in ensuring that alert messages remain accurate and up-to-date, aiding in the effective management and resolution of incidents.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Update alert description", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/alerts/:id/description", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Identifier of the alert.", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "This endpoint is used to update the description of an existing alert. This endpoint plays a crucial role in ensuring that team members have the most current details for incident response.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "List alert logs", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/alerts/:id/logs", "query": [ { "key": "after", "value": "{{after}}", "disabled": true, "description": "This parameter is used in pagination for the alert logs retrieved by the system. It accepts a string key of the last record from the previous page. The system will return the next page of logs that come after this specified key. This is useful for fetching subsequent segments of data when there are more logs than the limit specified." }, { "key": "size", "value": "{{size}}", "disabled": true, "description": "This parameter is used to limit the number of alert logs returned by the system. It accepts an integer that specifies the maximum number of logs to be retrieved." } ], "variable": [ { "key": "id", "value": "{{id}}", "description": "Identifier of the alert.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This endpoint is used to retrieve a paginated list of alert logs which provides users to obtain a comprehensive record of alert activities. This includes alert creation, acknowledgment, assignment, and closure details. This endpoint is crucial for audit purposes, incident reviews, and enhancing the overall incident management process by providing complete visibility into alert history.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] } ] }, { "name": "Audit Logs", "description": "The Audit Logs API is designed to help you access the operations audit logs which capture the key changes and activities in Jira Service Management. The activities include alerting, on-call, incident management, and other operation features.", "item": [ { "name": "Get audit Logs", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/logs", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Maximum number of items to return in the response." }, { "key": "pageToken", "value": "{{pageToken}}", "disabled": true, "description": "Token for fetching the next set of paginated results. The page token can be retrieved from the `links.next` key in each API response." }, { "key": "category", "value": "{{category}}", "disabled": true, "description": "Filter the audit logs based on the event category. Multiple categories can be passed by providing a comma-separated list of values." }, { "key": "level", "value": "{{level}}", "disabled": true, "description": "Filter the audit logs based on the log level. Multiple log levels can be passed by providing a comma-separated list of values." }, { "key": "startTime", "value": "{{startTime}}", "disabled": false, "description": "The starting date-time after which returned audit logs must have been created. Accepts the ISO format **(yyyy-MM-dd'T'HH:mm:ssZ)** (e.g. 2024-01-15T08:00:00+02:00)." }, { "key": "endTime", "value": "{{endTime}}", "disabled": false, "description": "The ending date-time before which returned audit logs must have been created. Accepts the ISO format **(yyyy-MM-dd'T'HH:mm:ssZ)** (e.g. 2024-01-15T08:00:00+02:00)." } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This endpoint returns all operations audit logs in Jira Service Management, allowing retrieval of logs in a specified time range and filtering based on log level and category. **Permissions required:** Permission to view Jira Service Management Audit logs using a JSM Org/Site/Product admin role ", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] } ] }, { "name": "Contacts", "description": "This resource represents the contract to create/update/delete alert notification contacts in Jira Service Management.", "item": [ { "name": "List contacts", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/users/contacts", "query": [ { "key": "offset", "value": "{{offset}}", "disabled": true }, { "key": "size", "value": "{{size}}", "disabled": true } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns the list of the contacts of a user.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Create contact", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/users/contacts", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Creates a new contact for a user.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Activate contact", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/users/contacts/:id/activate", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Activates a contact of a user.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Deactivate contact", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/users/contacts/:id/deactivate", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Deactivates a contact of a user.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get contact", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/users/contacts/:id", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns the details of a contact.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Delete contact", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/users/contacts/:id", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Delete a contact of a user.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Update contact", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/users/contacts/:id", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Update the details of a contact of a user. This method can be applied only to email contacts.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Custom user roles", "item": [ { "name": "Get custom user role", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/roles/:identifier", "query": [ { "key": "identifierType", "value": "{{identifierType}}", "disabled": true, "description": "Type of the identifier." } ], "variable": [ { "key": "identifier", "value": "{{identifier}}", "description": "Id of the custom user role.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns details of a custom user role. \n - The user should have admin role and custom user role right.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Update custom user role", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/roles/:identifier", "query": [ { "key": "identifierType", "value": "{{identifierType}}", "disabled": true, "description": "Type of the identifier." } ], "variable": [ { "key": "identifier", "value": "{{identifier}}", "description": "Id of the custom user role.", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Updates the details of a custom user role. \n - The user should have admin role and custom user role right.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Delete custom user role.", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/roles/:identifier", "query": [ { "key": "identifierType", "value": "{{identifierType}}", "disabled": true, "description": "Type of the identifier." } ], "variable": [ { "key": "identifier", "value": "{{identifier}}", "description": "Id of the custom user role.", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Deletes a custom user role. \n - The user should have admin role and custom user role right.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Assign custom user role", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/roles/assign", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Assignes a custom user role to a user. \n - The user should have admin role and custom user role right. \n - Assignment on the admin roles can be done through Atlassian Administration.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "List custom user roles", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/roles", "query": [ { "key": "offset", "value": "{{offset}}", "disabled": true }, { "key": "size", "value": "{{size}}", "disabled": true } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns the list of the custom user roles. \n - The user should have admin role and custom user role right.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Create custom user role", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/roles", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Creates a new custom user role. \n - The user should have admin role and custom user role right.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Escalations", "description": "Escalation policies can be used to notify multiple users/teams/schedules in order till the alert is acknowledged by someone. This resource represents the contract to create/update/delete/get of escalations in Jira Service Management.", "item": [ { "name": "List escalations", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/teams/:teamId/escalations", "query": [ { "key": "offset", "value": "{{offset}}", "disabled": true, "description": "The offset parameter controls the starting point within the collection of resource results." }, { "key": "size", "value": "{{size}}", "disabled": true, "description": "The limit parameter controls the maximum number of items that may be returned for a single request." } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Identifier of the escalation owning team.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Lists all escalations under given team. It optionally takes two parameters - offset and size.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Create escalation", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/teams/:teamId/escalations", "query": [], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Identifier of the escalation owning team.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Creates an escalation with the given properties.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "{\n \"name\": \"FE Daily On-call Escalation\",\n \"description\": \"\",\n \"rules\": [\n {\n \"condition\": \"if-not-acked\",\n \"notifyType\": \"default\",\n \"delay\": 5,\n \"recipient\": {\n \"id\": \"f0f07a3d-bde8-4b2a-8d3e-f97020a51e32\",\n \"type\": \"team\"\n }\n }\n ],\n \"enabled\": true,\n \"repeat\": {\n \"waitInterval\": 10,\n \"count\": 5,\n \"resetRecipientStates\": true,\n \"closeAlertAfterAll\": true\n }\n}" } }, "response": [] }, { "name": "Get escalation", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/teams/:teamId/escalations/:id", "query": [], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Identifier of the escalation owning team.", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Identifier of the escalation.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Gets an escalation with given id in the request.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Delete escalation", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/teams/:teamId/escalations/:id", "query": [], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Identifer of the escalation owning team.", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Identifier of the escalation.", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Deletes an escalation with given id in the request.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Update escalation", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/teams/:teamId/escalations/:id", "query": [], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Identifier of the escalation owning team.", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Identifier of the escalation.", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Updates an escalation with given id in the request.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Forwarding rules", "description": "This resource represents the contract to create/update/delete/get of forwarding-rules in Jira Service Management. Forwarding rules are used for forwarding the incoming notification to another user.", "item": [ { "name": "List forwarding rules", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/forwarding-rules", "query": [ { "key": "showAll", "value": "{{showAll}}", "disabled": true, "description": "Display all forwardings of the account." }, { "key": "offset", "value": "{{offset}}", "disabled": true, "description": "The offset parameter controls the starting point within the collection of resource results." }, { "key": "size", "value": "{{size}}", "disabled": true, "description": "The limit parameter controls the maximum number of items that may be returned for a single request." } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Lists the all forwarding rules user can view. It optionally takes three parameters - offset, size and showAll.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Create forwarding rule", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/forwarding-rules", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Creates a forwarding rule with the given properties.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get forwarding rule", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/forwarding-rules/:id", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Identifier of the forwarding rule.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Gets a forwarding rule with given id in the request.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Update forwarding rule", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/forwarding-rules/:id", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Identifier of the forwarding rule.", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Updates a forwaring rule with given id in the request.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Delete forwarding rule", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/forwarding-rules/:id", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Identifier of the forwarding rule.", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Deletes a forwarding rule with given id in the request.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] } ] }, { "name": "Heartbeats", "description": "This resource represents the contract to create/update/delete/get of heartbeats in Jira Service Management.", "item": [ { "name": "List heartbeats", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/teams/:teamId/heartbeats", "query": [ { "key": "name", "value": "{{name}}", "disabled": true, "description": "Name of the heartbeat for identification." }, { "key": "offset", "value": "{{offset}}", "disabled": true, "description": "The offset parameter controls the starting point within the collection of resource results." }, { "key": "size", "value": "{{size}}", "disabled": true, "description": "The limit parameter controls the maximum number of items that may be returned for a single request." } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Identifier of the heartbeat owning team.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Lists the all heartbeats user can view. If a heartbeatName is passed, it filters out given heartbeat and only return given heartbeat.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Create heartbeat", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/teams/:teamId/heartbeats", "query": [], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Identifier of the heartbeat owning team.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Create heartbeat request is used to define heartbeats in Jira Service Management. A heartbeat needs to be added, before sending heartbeat messages to JSM", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Delete heartbeat", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/teams/:teamId/heartbeats", "query": [ { "key": "name", "value": "{{name}}", "disabled": false, "description": "Name of the heartbeat for identification." } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Identifier of the heartbeat owning team.", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Deletes the heartbeat with given name in the request.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Update heartbeat", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/teams/:teamId/heartbeats", "query": [ { "key": "name", "value": "{{name}}", "disabled": false, "description": "Name of the heartbeat for identification." } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Identifier of the heartbeat owning team.", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Updates the heartbeat with the given name. Name of a heartbeat cannot be changed", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Ping Heartbeat", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/teams/:teamId/heartbeats/ping", "query": [ { "key": "name", "value": "{{name}}", "disabled": false, "description": "Name of the heartbeat for identification." } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Identifier of the heartbeat owning team.", "disabled": false } ] }, "method": "POST", "header": [], "description": "Pings the heartbeat with given name. Heartbeat ping requests processed asynchronously, it does not check if the heartbeat exists or not before responding. Please note that receiving a PONG response does not necessarily mean that the heartbeat exists.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] } ] }, { "name": "Integrations", "description": "This resource represents Integrations in Jira Service Management. Use it to get, list, create, update, or delete integrations.", "item": [ { "name": "List integrations", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/integrations", "query": [ { "key": "type", "value": "{{type}}", "disabled": true, "description": "Type of the integration." }, { "key": "teamId", "value": "{{teamId}}", "disabled": true, "description": "ID of the team that integration belongs to." }, { "key": "name", "value": "{{name}}", "disabled": true, "description": "Name of the integration." }, { "key": "offset", "value": "{{offset}}", "disabled": true, "description": "The index of the first item to return in a page of results." }, { "key": "size", "value": "{{size}}", "disabled": true, "description": "The maximum number of items to return per page." } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns all integrations that user can view. **Permissions required:** Permission to access Jira Service Management; however, the list contains an integration if: \n - the user has read-only administrative right. \n - the integration's assigned team is one of the teams that the user belongs to.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Create integration", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/integrations", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Creates an integration. It can be team or global integration by using teamId in the payload.\n \n **Permissions required:** Permission to create an integration:\n - the user has edit configuration right. \n - the user is the admin of the team that the integration belongs to. \n \n *Slack* and *Microsoft Teams* types of integration are not supported for this operation.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get integration", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/integrations/:id", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "ID of the integration.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns the integration details. **Permissions required:** Permission to access to the integration: \n - the user has read-only administrative right. \n - the integration's assigned team is one of the teams that the user belongs to.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Delete integration", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/integrations/:id", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Deletes an integration. **Permissions required:** Permission to delete the integration:\n - the user has read-only administrative right. \n - the user is the admin of the team that the integration belongs to.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Update integration", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/integrations/:id", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Updates an integration. **Permissions required:** Permission to update the integration:\n - the user has read-only administrative right. \n - the user is the admin of the team that the integration belongs to.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Integration actions", "description": "This resource represents Integration Actions in Jira Service Management. Use it to get, list, create, update, delete or reorder of actions of an integration.", "item": [ { "name": "List integration actions", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/integrations/:integrationId/actions", "query": [ { "key": "type", "value": "{{type}}", "disabled": true, "description": "Type of the integration action." }, { "key": "direction", "value": "{{direction}}", "disabled": true, "description": "Direction of the action. It can be *incoming* or *outgoing*" }, { "key": "domain", "value": "{{domain}}", "disabled": true, "description": "Domain of the action. It can be *alert*" }, { "key": "name", "value": "{{name}}", "disabled": true, "description": "Name of the integration action." }, { "key": "offset", "value": "{{offset}}", "disabled": true, "description": "The index of the first item to return in a page of results." }, { "key": "size", "value": "{{size}}", "disabled": true, "description": "The maximum number of items to return per page." } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Lists integration actions of an integration that user can view. **Permissions required:** Permission to get the integration action: \n - the user has read-only administrative right. \n - the integration's assigned team is one of the teams that the user belongs to.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Create integration action", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/integrations/:integrationId/actions", "query": [], "variable": [ { "key": "integrationId", "value": "{{integrationId}}", "description": "ID of the integration", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Creates an integration action. **Permissions required:** Permission to create an integration action: \n - the user has read-only administrative right. \n - the user is the admin of the team that the integration belongs to.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get integration action", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/integrations/:integrationId/actions/:id", "query": [], "variable": [ { "key": "integrationId", "value": "{{integrationId}}", "description": "ID of the integration.", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "ID of the integration action.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns the action of an integration. **Permissions required:** Permission to access to the integration action: \n - the user has read-only administrative right. \n - the integration's assigned team is one of the teams that the user belongs to.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Delete integration action", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/integrations/:integrationId/actions/:id", "query": [], "variable": [ { "key": "integrationId", "value": "{{integrationId}}", "description": "ID of the integration.", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "ID of the integration action.", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Deletes an integration action. **Permissions required:** Permission to update integration alert filter:\n - the user has read-only administrative right. \n - the user is the admin of the team that the integration belongs to.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Update integration action", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/integrations/:integrationId/actions/:id", "query": [], "variable": [ { "key": "integrationId", "value": "{{integrationId}}", "description": "ID of the integration.", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "ID of the integration action.", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Updates an integration action. **Permissions required:** Permission to update the integration action:\n - the user has read-only administrative right. \n - the user is the admin of the team that the integration belongs to.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Reorder integration action", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/integrations/:integrationId/actions/:id/order", "query": [], "variable": [ { "key": "integrationId", "value": "{{integrationId}}", "description": "ID of the integration.", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "ID of the integration action.", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Reorders an integration action. **Permissions required:** Permission to reorder the integration action:\n - the user has read-only administrative right. \n - the user is the admin of the team that the integration belongs to.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Integration outgoing filters", "description": "This resource represents Alert Filters of an Integration in Jira Service Management. Use it to get or update alert filters of an integration.", "item": [ { "name": "Get integration alert filter", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/integrations/:integrationId/outgoing/alert-filter/main", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "ID of the integration.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns the outgoing alert filter details of an integration. **Permissions required:** Permission to access to the integration outgoing alert filter: \n - the user has read-only administrative right. \n - the integration's assigned team is one of the teams that the user belongs to.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Update integration alert filter", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/integrations/:integrationId/outgoing/alert-filter/main", "query": [], "variable": [] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Updates Integration outgoing alert filter. **Permissions required:** Permission to update integration alert filter:\n - the user has read-only administrative right. \n - the user is the admin of the team that the integration belongs to.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "{\n \"conditionMatchType\": \"match-all\",\n \"conditions\": []\n}" } }, "response": [] } ] }, { "name": "Maintenances", "description": "A set of rules that can be added to enable or disable multiple policies, integrations or syncs with a single entry. This resource represents the all contracts of maintenance plans in Jira Service Management.", "item": [ { "name": "List global maintenances", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/maintenances", "query": [ { "key": "type", "value": "{{type}}", "disabled": true, "description": "Defines which maintenance will be listed according to maintenance status." }, { "key": "offset", "value": "{{offset}}", "disabled": true, "description": "The offset parameter controls the starting point within the collection of resource results." }, { "key": "size", "value": "{{size}}", "disabled": true, "description": "The limit parameter controls the maximum number of items that may be returned for a single request." } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This endpoint is used to retrieve a list of maintenance that have been created within your organization's account in the Jira Service Management system. It optionally takes three parameters - offset, size and type.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Create global maintenance", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/maintenances", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "This endpoint is used to create a new maintenance which applies rules to all teams across your organization in Jira Service Management. The maintenance plan can include various rules that enable or disable multiple entities like policies, integrations or syncs. Please note that integrations and syncs cannot be enabled via a maintenance plan but policies can.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get global maintenance", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/maintenances/:id", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Identifier of the maintenance.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Gets an account based global maintenance with given id in the request.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Deletes global maintenance", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/maintenances/:id", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Identifier of the maintenance.", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "This request is used to delete a global maintenance.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Update global maintenance", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/maintenances/:id", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Identifier of the maintenance.", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This endpoint is used to update a global maintenance in Jira Service Management.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Cancel global maintenance", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/maintenances/:id/cancel", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Identifier of the maintenance.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This endpoint is used to stop an ongoing maintenance plan early. The functionality allows you to end the maintenance plan before the initially set end time.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "List team maintenances", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/teams/:teamId/maintenances", "query": [ { "key": "type", "value": "{{type}}", "disabled": true, "description": "Defines which maintenance will be listed according to maintenance status." }, { "key": "offset", "value": "{{offset}}", "disabled": true, "description": "The offset parameter controls the starting point within the collection of resource results." }, { "key": "size", "value": "{{size}}", "disabled": true, "description": "The limit parameter controls the maximum number of items that may be returned for a single request." } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Identifier of the maintenance owning team.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This endpoint is used to retrieve a list of maintenance associated with a specific team in the Jira Service Management system. It optionally takes three parameters - offset, size and type.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Create team maintenance", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/teams/:teamId/maintenances", "query": [], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Identifier of the maintenance owning team.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "This endpoint is used to create a new maintenance for a specific team in Jira Service Management. The maintenance plan can include various rules that enable or disable multiple entities like policies, integrations or syncs. Please note that integrations and syncs cannot be enabled via a maintenance plan but policies can.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get team maintenance", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/teams/:teamId/maintenances/:id", "query": [], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Identifier of the maintenance owning team.", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Identifier of the maintenance.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This request is used to retrieve a specific maintenance of a specific team.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Delete team maintenance", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/teams/:teamId/maintenances/:id", "query": [], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Identifier of the maintenance owning team.", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Identifier of the maintenance.", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Deletes a maintenance with given id in the request.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Update team maintenance", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/teams/:teamId/maintenances/:id", "query": [], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Identifier of the maintenance owning team.", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Identifier of the maintenance.", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Updates a team maintenance with given id in the request.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Cancel team maintenance", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/teams/:teamId/maintenances/:id/cancel", "query": [], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Identifier of the maintenance owning team.", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Identifier of the maintenance.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This endpoint is used to stop an ongoing maintenance plan of a specific team early. The functionality allows you to end the maintenance period before the initially set end time. ", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] } ] }, { "name": "Notification rules", "description": "Notification rules allow users to configure notification steps that use their existing contact methods and define conditions & time constraints on them. This resource represents the contract to create/get/update/delete/list of notification-rules in Jira Service Management.", "item": [ { "name": "List notification rules", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/notification-rules", "query": [ { "key": "offset", "value": "{{offset}}", "disabled": true, "description": "The offset parameter controls the starting point within the collection of resource results." }, { "key": "size", "value": "{{size}}", "disabled": true, "description": "The size parameter controls the maximum number of items that may be returned for a single request." } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Lists all notification rules for the user. It optionally takes two parameters - offset and size.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Create notification rule", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/notification-rules", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Creates a notification rule with the given properties for the user.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get notification rule", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/notification-rules/:id", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Identifier of the notification rule", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Gets a notification rule with given id in the request.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Delete notification rule", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/notification-rules/:id", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Identifier of the notification rule", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Deletes a notification rule with given id in the request.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Update notification rule", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/notification-rules/:id", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Identifier of the notification rule", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Updates a notification rule with given id in the request.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Notification rule steps", "description": "Notification rule steps allow users to define how they want to be notified. This resource represents the all contracts of notification rule steps in Jira Service Management.", "item": [ { "name": "List notification rule steps", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/notification-rules/:ruleId/steps", "query": [ { "key": "offset", "value": "{{offset}}", "disabled": true, "description": "The offset parameter controls the starting point within the collection of resource results." }, { "key": "size", "value": "{{size}}", "disabled": true, "description": "The size parameter controls the maximum number of items that may be returned for a single request." } ], "variable": [ { "key": "ruleId", "value": "{{ruleId}}", "description": "Identifier of the notification rule", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Lists all notifaction rule steps for the user. It optionally takes two parameters - offset and size.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Create notification rule step", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/notification-rules/:ruleId/steps", "query": [], "variable": [ { "key": "ruleId", "value": "{{ruleId}}", "description": "Identifier of the notification rule.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Creates a notification rule step with the given properties.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get notification rule step", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/notification-rules/:ruleId/steps/:id", "query": [], "variable": [ { "key": "ruleId", "value": "{{ruleId}}", "description": "Identifier of the notification rule.", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Identifier of the notification rule step which belongs to given notification rule.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Gets a notification rule step with given id in the request.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Delete notification rule step", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/notification-rules/:ruleId/steps/:id", "query": [], "variable": [ { "key": "ruleId", "value": "{{ruleId}}", "description": "Identifier of the notification rule.", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Identifier of the notification rule step which belongs to given notification rule.", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Deletes a notification rule step with given id in the request.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Update notification rule step", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/notification-rules/:ruleId/steps/:id", "query": [], "variable": [ { "key": "ruleId", "value": "{{ruleId}}", "description": "Identifier of the notification rule.", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Identifier of the notification rule step which belongs to given notification rule.", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Updates a notification rule step with given id in the request.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Routing rules", "description": "This resource represents the contract to create/read/update/delete of routing rules in Jira Service Management.", "item": [ { "name": "List routing rules", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/teams/:teamId/routing-rules", "query": [ { "key": "offset", "value": "{{offset}}", "disabled": true, "description": "The offset parameter controls the starting point within the collection of resource results." }, { "key": "size", "value": "{{size}}", "disabled": true, "description": "The limit parameter controls the maximum number of items that may be returned for a single request." } ], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Identifier of the routing rules owning team.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Lists all routing rules of given team. It optionally takes two parameters - offset and size.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Create routing rule", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/teams/:teamId/routing-rules", "query": [], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Identifier of the routing rules owning team.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Creates a routing rule with the given properties.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get routing rule", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/teams/:teamId/routing-rules/:id", "query": [], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Identifier of the routing rules owning team.", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Identifier of the routing rule.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Gets a routing rule with given id in the request.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Delete routing rule", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/teams/:teamId/routing-rules/:id", "query": [], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Identifier of the routing rules owning team.", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Identifier of the routing rule.", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Deletes a routing rule with given id in the request.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Update routing rule", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/teams/:teamId/routing-rules/:id", "query": [], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Identifier of the routing rules owning team.", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Identifier of the routing rule.", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Updates a routing rule with given id in the request.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Change routing rule order", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/teams/:teamId/routing-rules/:id/change-order", "query": [], "variable": [ { "key": "teamId", "value": "{{teamId}}", "description": "Identifier of the routing rules owning team.", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Identifier of the routing rule.", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Changes routing rule's order with given id in the request.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Schedules", "description": "This resource represents schedules in Jira Service Management. Use it to:\n - create a new schedule. \n - list all schedules. \n - get a schedule. \n - update a schedule. \n - delete a schedule.", "item": [ { "name": "List schedules", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/schedules", "query": [ { "key": "query", "value": "{{query}}", "disabled": true, "description": "The query keyword to filter schedules by name." }, { "key": "size", "value": "{{size}}", "disabled": true, "description": "The limit parameter controls the maximum number of items that may be returned for a single request." }, { "key": "offset", "value": "{{offset}}", "disabled": true, "description": "The offset parameter controls the starting point within the collection of resource results." }, { "key": "expand", "value": "{{expand}}", "disabled": true, "description": "The list of possible expansions in the response. Possible values: `rotation`." } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Lists all schedules that user can view. It optionally takes two parameters - offset and size. **Permissions required:** Permission to access Jira Service Management; however, the list contains a schedule if: \n - the user has read-only administrative right. \n - the schedule's assigned team is one of the teams that the user belongs to. \n - the user is added to a rotation of the schedule as a responder. \n - a team is added to a rotation of the schedule as a responder, and the user is a member of this team. \n - an escalation is added to a rotation of the schedule as a responder, and the user is a member of this escalation. \n - there is an override to the user in the schedule.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Create schedule", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/schedules", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Creates a schedule with given properties. **Permissions required:** Permission to create a schedule: \n - the user has edit configuration right. \n - the user is the admin of the team that the schedule belongs to.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get schedule", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/schedules/:id", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "ID of the schedule.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns the details of the schedule with given id in the request. **Permissions required:** Permission to access to the schedule: \n - the user has read-only administrative right. \n - the schedule's assigned team is one of the teams that the user belongs to. \n - the user is added to a rotation of the schedule as a responder. \n - a team is added to a rotation of the schedule as a responder, and the user is a member of this team. \n - an escalation is added to a rotation of the schedule as a responder, and the user is a member of this escalation. \n - there is an override to the user in the schedule.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Delete schedule", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/schedules/:id", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "ID of the schedule.", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Deletes the schedule with given id in the request. **Permissions required:** Permission to delete the schedule: \n - the user has delete configuration right. \n - the user is the admin of the team that the schedule belongs to.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Update schedule", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/schedules/:id", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Updates the schedule with given id in the request. **Permissions required:** Permission to update the schedule: \n - the user has edit configuration right. \n - the user is the admin of the team that the schedule belongs to.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Schedule on-calls", "description": "This resource represents schedule on-calls in Jira Service Management. Use it to:\n - list on-call responders on a schedule.\n - list the next on-call responders on a schedule.\n - export on-call responders on a schedule in calendar format.", "item": [ { "name": "List on-call responders", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/schedules/:scheduleId/on-calls", "query": [ { "key": "flat", "value": "{{flat}}", "disabled": true, "description": "When enabled, returns only the user names of the on-call participants in user type. Otherwise, returns the complete flattening tree for on-calls." }, { "key": "date", "value": "{{date}}", "disabled": true, "description": "The date for which the schedule's on-calls are requested." } ], "variable": [ { "key": "scheduleId", "value": "{{scheduleId}}", "description": "ID of the schedule.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Lists the on-call responders at a specific time for the schedule with given id in the request. **Permissions required:** Permission to access to the schedule: \n - the user has read-only administrative right. \n - the schedule's assigned team is one of the teams that the user belongs to. \n - the user is added to a rotation of the schedule as a responder. \n - a team is added to a rotation of the schedule as a responder, and the user is a member of this team. \n - an escalation is added to a rotation of the schedule as a responder, and the user is a member of this escalation. \n - there is an override to the user in the schedule.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "List next on-call responders", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/schedules/:scheduleId/next-on-calls", "query": [ { "key": "flat", "value": "{{flat}}", "disabled": true, "description": "When enabled, returns only the user names of all next on-call participants in user type. Otherwise, returns the complete flattening tree for next on-calls." }, { "key": "date", "value": "{{date}}", "disabled": true, "description": "The date for which the schedule's next on-calls are requested." } ], "variable": [ { "key": "scheduleId", "value": "{{scheduleId}}", "description": "ID of the schedule.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Lists the next on-call responders at a specific time for the schedule with given id in the request. **Permissions required:** Permission to access to the schedule: \n - the user has read-only administrative right. \n - the schedule's assigned team is one of the teams that the user belongs to. \n - the user is added to a rotation of the schedule as a responder. \n - a team is added to a rotation of the schedule as a responder, and the user is a member of this team. \n - an escalation is added to a rotation of the schedule as a responder, and the user is a member of this escalation. \n - there is an override to the user in the schedule.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Export on-call responders", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/schedules/on-calls/:userIdentifier.ics", "query": [], "variable": [ { "key": "userIdentifier", "value": "{{userIdentifier}}", "description": "ID of the user whose on-call calendar to be exported.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "text/calendar" } ], "description": "Exports the on-call periods in the calendar (.ics) format for the user with given id in the request.\n \n **Permissions required:** Permission to export to the user on-calls: \n - the user exports the on-call calendar for themselves. \n - the user exports the on-call calendar for another user, and the requesting user is the admin. \n - the user exports the on-call calendar for another user, and the requesting user is the team admin in one of the teams of the requested user. \n", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] } ] }, { "name": "Schedule overrides", "description": "This resource represents schedule overrides in Jira Service Management. Use it to:\n - list all overrides of a schedule. \n - create a new override. \n - get an override. \n - update an override. \n - delete an override.", "item": [ { "name": "List overrides", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/schedules/:scheduleId/overrides", "query": [ { "key": "size", "value": "{{size}}", "disabled": true, "description": "The limit parameter controls the maximum number of items that may be returned for a single request." }, { "key": "offset", "value": "{{offset}}", "disabled": true, "description": "The offset parameter controls the starting point within the collection of resource results." } ], "variable": [ { "key": "scheduleId", "value": "{{scheduleId}}", "description": "ID of the schedule.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Lists all ongoing and future overrides of the schedule with given id in the request. It optionally takes two parameters - offset and size. **Permissions required:** Permission to access to the schedule: \n - the user has read-only administrative right. \n - the schedule's assigned team is one of the teams that the user belongs to. \n - the user is added to a rotation of the schedule as a responder. \n - a team is added to a rotation of the schedule as a responder, and the user is a member of this team. \n - an escalation is added to a rotation of the schedule as a responder, and the user is a member of this escalation. \n - there is an override to the user in the schedule.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Create override", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/schedules/:scheduleId/overrides", "query": [], "variable": [ { "key": "scheduleId", "value": "{{scheduleId}}", "description": "ID of the schedule.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Creates a new override for the schedule with given id and properties. **Permissions required:** Permission to create an override: \n - the user has edit configuration right. \n - the user is a member of the team that the schedule belongs to. \n - the user is adding override to themself. \n - the user exists in the schedule directly or indirectly.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get override", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/schedules/:scheduleId/overrides/:alias", "query": [], "variable": [ { "key": "scheduleId", "value": "{{scheduleId}}", "description": "ID of the schedule.", "disabled": false }, { "key": "alias", "value": "{{alias}}", "description": "Alias of the override.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns the details of the override of a schedule with given IDs in the request. **Permissions required:** Permission to access to the schedule: \n - the user has read-only administrative right. \n - the schedule's assigned team is one of the teams that the user belongs to. \n - the user is added to a rotation of the schedule as a responder. \n - a team is added to a rotation of the schedule as a responder, and the user is a member of this team. \n - an escalation is added to a rotation of the schedule as a responder, and the user is a member of this escalation. \n - there is an override to the user in the schedule.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Update override", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/schedules/:scheduleId/overrides/:alias", "query": [], "variable": [ { "key": "scheduleId", "value": "{{scheduleId}}", "description": "ID of the schedule.", "disabled": false }, { "key": "alias", "value": "{{alias}}", "description": "Alias of the override.", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Updates the override of a schedule with given IDs in the request. **Permissions required:** Permission to update an override: \n - the user has edit configuration right. \n - the user is a member of the team that the schedule belongs to. \n - the user is adding override to themself. \n - the user exists in the schedule directly or indirectly by flattening.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Delete override", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/schedules/:scheduleId/overrides/:alias", "query": [], "variable": [ { "key": "scheduleId", "value": "{{scheduleId}}", "description": "ID of the schedule.", "disabled": false }, { "key": "alias", "value": "{{alias}}", "description": "Alias of the override.", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Deletes the override of a schedule with given IDs in the request. **Permissions required:** Permission to delete the override: \n - the user is the responder of the override. \n - the user has edit configuration right. \n - the user is the admin of the team that the schedule belongs to.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] } ] }, { "name": "Schedule rotations", "description": "This resource represents on-call schedule rotations in Jira Service Management. Use it to:\n - list all rotations of a schedule. \n - create a new rotation. \n - get a rotation. \n - update a rotation. \n - delete a rotation.", "item": [ { "name": "List rotations", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/schedules/:scheduleId/rotations", "query": [ { "key": "size", "value": "{{size}}", "disabled": true, "description": "The limit parameter controls the maximum number of items that may be returned for a single request." }, { "key": "offset", "value": "{{offset}}", "disabled": true, "description": "The offset parameter controls the starting point within the collection of resource results." } ], "variable": [ { "key": "scheduleId", "value": "{{scheduleId}}", "description": "ID of the schedule.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Lists all rotations of the schedule with given id in the request. It optionally takes two parameters - offset and size. **Permissions required:** Permission to access to the schedule: \n - the user has read-only administrative right. \n - the schedule's assigned team is one of the teams that the user belongs to. \n - the user is added to a rotation of the schedule as a responder. \n - a team is added to a rotation of the schedule as a responder, and the user is a member of this team. \n - an escalation is added to a rotation of the schedule as a responder, and the user is a member of this escalation. \n - there is an override to the user in the schedule.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Create rotation", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/schedules/:scheduleId/rotations", "query": [], "variable": [ { "key": "scheduleId", "value": "{{scheduleId}}", "description": "ID of the schedule.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Creates a new rotation for the schedule with given id and properties. **Permissions required:** Permission to edit a schedule: \n - the user has edit configuration right. \n - the user is the admin of the team that the schedule belongs to.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get rotation", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/schedules/:scheduleId/rotations/:id", "query": [], "variable": [ { "key": "scheduleId", "value": "{{scheduleId}}", "description": "ID of the schedule.", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "ID of the rotation.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns the details of the rotation of a schedule with given IDs in the request. **Permissions required:** Permission to access to the schedule: \n - the user has read-only administrative right. \n - the schedule's assigned team is one of the teams that the user belongs to. \n - the user is added to a rotation of the schedule as a responder. \n - a team is added to a rotation of the schedule as a responder, and the user is a member of this team. \n - an escalation is added to a rotation of the schedule as a responder, and the user is a member of this escalation. \n - there is an override to the user in the schedule.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Delete rotation", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/schedules/:scheduleId/rotations/:id", "query": [], "variable": [ { "key": "scheduleId", "value": "{{scheduleId}}", "description": "ID of the schedule.", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "ID of the rotation.", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Deletes the rotation of a schedule with given IDs in the request. **Permissions required:** Permission to delete the rotation: \n - the user has delete configuration right. \n - the user is the admin of the team that rotation's schedule belongs to.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Update rotation", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/schedules/:scheduleId/rotations/:id", "query": [], "variable": [ { "key": "scheduleId", "value": "{{scheduleId}}", "description": "ID of the schedule.", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "ID of the rotation.", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Updates the rotation of a schedule with given IDs in the request. **Permissions required:** Permission to edit a schedule: \n - the user has edit configuration right. \n - the user is the admin of the team that the schedule belongs to.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Schedule timelines", "description": "This resource represents schedule timelines in Jira Service Management. Use it to:\n - calculate the timeline of a schedule. \n - export the timeline of a schedule in calendar format. \n", "item": [ { "name": "Get schedule timeline", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/schedules/:scheduleId/timeline", "query": [ { "key": "interval", "value": "{{interval}}", "disabled": true, "description": "The length of the timeline calculation time range as an integer in `intervalUnits`." }, { "key": "intervalUnit", "value": "{{intervalUnit}}", "disabled": true, "description": "The unit of the timeline calculation time range." }, { "key": "date", "value": "{{date}}", "disabled": true, "description": "The date to calculate timeline according to. The `interval`, `intervalUnit`, and this field are combined to calculate to time range of the timeline. The start of the time range is the point of time that is the beginning of the `intervalUnit` containing this date. The end of the time range is the point of time `intervalUnit` * `interval` time is added to the start of the time range. For example, for the parameters `interval = 2`, `intervalUnit = months`, `date = '2023-12-15T15:20:25+00:00'`, the time range of the timeline is (`2023-12-01T00:00:00+00:00`, `2024-02-01T00:00:00+00:00`)." }, { "key": "expand", "value": "{{expand}}", "disabled": true, "description": "The list of possible expansions in the response. The default response only contains the timeline of the final layer. With these expansions, timeline of base, forwarding, and override layers can also be calculated. Possible values: `base`, `forwarding`, `override`." } ], "variable": [ { "key": "scheduleId", "value": "{{scheduleId}}", "description": "ID of the schedule.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns the timeline of the schedule with given id in the request. The time range of the timeline can go back at most one year from today and as far as two years from today. Therefore, query parameters should be given accordingly. **Permissions required:** Permission to access to the schedule: \n - the user has read-only administrative right. \n - the schedule's assigned team is one of the teams that the user belongs to. \n - the user is added to a rotation of the schedule as a responder. \n - a team is added to a rotation of the schedule as a responder, and the user is a member of this team. \n - an escalation is added to a rotation of the schedule as a responder, and the user is a member of this escalation. \n - there is an override to the user in the schedule.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Export schedule timeline", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/schedules/:scheduleId.ics", "query": [], "variable": [ { "key": "scheduleId", "value": "{{scheduleId}}", "description": "ID of the schedule.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "text/calendar" } ], "description": "Exports the timeline in the calendar (.ics) format for the schedule with given id in the request. The time range of the export starts from the beginning of the current month and ends one year after the start date. **Permissions required:** Permission to access to the schedule: \n - the user has read-only administrative right. \n - the schedule's assigned team is one of the teams that the user belongs to. \n - the user is added to a rotation of the schedule as a responder. \n - a team is added to a rotation of the schedule as a responder, and the user is a member of this team. \n - an escalation is added to a rotation of the schedule as a responder, and the user is a member of this escalation. \n - there is an override to the user in the schedule.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] } ] }, { "name": "Syncs", "description": "This resource represents Syncs in Jira Service Management. Use it to get, list, create, update, or delete syncs.", "item": [ { "name": "List syncs", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/syncs", "query": [ { "key": "type", "value": "{{type}}", "disabled": true, "description": "Type of the sync. (For instance, \"jira-software-cloud\" for Jira Software Cloud Sync.)" }, { "key": "teamId", "value": "{{teamId}}", "disabled": true, "description": "Id of the team that the syncs belongs to." }, { "key": "offset", "value": "{{offset}}", "disabled": true, "description": "The offset parameter controls the starting point within the collection of resource results." }, { "key": "size", "value": "{{size}}", "disabled": true, "description": "The limit parameter controls the maximum number of items that may be returned for a single request." } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Lists syncs according to the provided filters.\n- The user should have view permission for syncs.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Create sync", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/syncs", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Creates a sync for syncing alerts created and issues in a selected project. \n- The user should have sync creation permission.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get sync", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/syncs/:id", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Id of the sync.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns the sync.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Delete sync", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/syncs/:id", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Deletes a sync. \n- The user should have delete permission for sync.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Update sync", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/syncs/:id", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Id of the sync.", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Updates a sync. \n- The user should have edit permission for sync.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Sync actions", "description": "This resource represents Sync Actions in Jira Service Management. Use it to get, list, create, update, delete or reorder of actions of a sync.", "item": [ { "name": "List sync actions", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/syncs/:syncId/actions", "query": [ { "key": "type", "value": "{{type}}", "disabled": true, "description": "Type of the action." }, { "key": "direction", "value": "{{direction}}", "disabled": true, "description": "Direction of the action." }, { "key": "groupId", "value": "{{groupId}}", "disabled": true, "description": "Id of the action group that the action belongs to." }, { "key": "name", "value": "{{name}}", "disabled": true, "description": "Name of the action." }, { "key": "offset", "value": "{{offset}}", "disabled": true, "description": "The offset parameter controls the starting point within the collection of resource results." }, { "key": "size", "value": "{{size}}", "disabled": true, "description": "The limit parameter controls the maximum number of items that may be returned for a single request." } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Lists sync actions of a sync", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Create sync action", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/syncs/:syncId/actions", "query": [], "variable": [ { "key": "syncId", "value": "{{syncId}}", "description": "Id of the sync.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Creates a sync action", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get sync action", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/syncs/:syncId/actions/:id", "query": [], "variable": [ { "key": "syncId", "value": "{{syncId}}", "description": "Id of the sync.", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Id of the sync action.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Gets a sync action. ", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Delete sync action", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/syncs/:syncId/actions/:id", "query": [], "variable": [ { "key": "syncId", "value": "{{syncId}}", "description": "Id of the sync.", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Id of the sync action.", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Deletes a sync action.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Update sync action", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/syncs/:syncId/actions/:id", "query": [], "variable": [ { "key": "syncId", "value": "{{syncId}}", "description": "Id of the sync.", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Id of the sync action.", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Updates a sync action.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Reorder sync action", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/syncs/:syncId/actions/:id/order", "query": [], "variable": [ { "key": "syncId", "value": "{{syncId}}", "description": "Id of the sync.", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Id of the sync action.", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Reorders a sync action. ", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Sync action groups", "description": "This resource represents Sync Action Groups in Jira Service Management. Use it to get, list, create, update, delete or reorder of action groups of a sync.", "item": [ { "name": "List sync action groups", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/syncs/:syncId/action-groups", "query": [ { "key": "type", "value": "{{type}}", "disabled": true, "description": "Type of the action group." } ], "variable": [ { "key": "syncId", "value": "{{syncId}}", "description": "Id of the sync", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Lists sync action groups of a sync", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Create sync action group", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/syncs/:syncId/action-groups", "query": [], "variable": [ { "key": "syncId", "value": "{{syncId}}", "description": "Id of the sync", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Creates a sync action group", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get sync action group", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/syncs/:syncId/action-groups/:id", "query": [], "variable": [ { "key": "syncId", "value": "{{syncId}}", "description": "Id of the sync", "disabled": false }, { "key": "actionGroupId", "value": "{{actionGroupId}}", "description": "Id of the action group", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Gets a sync action group. ", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Delete sync action group", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/syncs/:syncId/action-groups/:id", "query": [], "variable": [ { "key": "syncId", "value": "{{syncId}}", "description": "Id of the sync", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Id of the action group", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Deletes a sync action group.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Update sync action group", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/syncs/:syncId/action-groups/:id", "query": [], "variable": [ { "key": "syncId", "value": "{{syncId}}", "description": "Id of the sync", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Id of the action group", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Updates a sync action group.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Reorder sync action group", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}v1/syncs/:syncId/action-groups/:id/order", "query": [], "variable": [ { "key": "syncId", "value": "{{syncId}}", "description": "Id of the sync", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Id of the action group", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Reorders a sync action group. ", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] } ] } ], "variable": [ { "key": "protocol", "name": "Protocol", "description": "The HTTP Protocol that should be used for this REST API.", "type": "string", "value": "https" }, { "key": "host", "name": "Host", "description": "The HTTP host that should be used for this REST API.", "type": "string", "value": "api.atlassian.com" }, { "key": "basePath", "name": "Base Path", "description": "The path, after the host, of the base of the REST API.", "type": "string", "value": "jsm/ops/api/%7BcloudId%7D/" } ] }