{"openapi":"3.0.1","info":{"contact":{"url":"http://go.atlassian.com/agni","name":"ITOps Agni"},"description":"Incident Management APIs for Jira Service Management","title":"JSM Incident API","version":"1"},"tags":[{"name":"Affected Services","description":"This resource represents affected services of a Jira Service Management Incident. Use this resource to get, add and remove affected services to an incident issue."},{"name":"Linked alerts","description":"This resource represents Linked alerts to a Jira Service Management Incident. Use this resource to helps you manage linked alerts to a Jira Service Management Incident. Use this resource to add, remove and fetch linked alerts to an Incident. See [What are linked alerts?](https://support.atlassian.com/jira-service-management-cloud/docs/what-are-linked-alerts/) for details."},{"name":"Request status","description":"This resource represents request status of Jira Service Management Incident API asynchronous actions. Use this resource to fetch request status of Jira Service Management Incident API asynchronous actions."},{"name":"Chat tools","description":"This resource represents chat tools to a Jira Service Management Incident. Use this resource to create, remove and fetch chat channels to an Incident. See how to [Connect Slack with Jira Service Management](https://support.atlassian.com/jira-service-management-cloud/docs/connect-a-new-slack-workspace-to-your-service-project/) for details. One you've connected Slack, you can use this resource to create Slack channel to the Incident. Once a Slack channel has been created, you can perform several [incident actions](https://support.atlassian.com/jira-service-management-cloud/docs/create-a-chat-channel-from-an-incident/) through that channel."},{"name":"Incident bulk actions","description":"This resource represents bulk actions to a Jira Service Management Incident"},{"name":"Incident","description":"This resource represents Jira Service Management Incident. Use this resource to create, delete and fetch an Incident."},{"name":"Major Incident","description":"This resource represents Major Incidents in Jira Service Management. Use this resource to escalate / de-escalator a Jira Service Management Incident as a major incident. See [What are major incidents?](https://support.atlassian.com/jira-service-management-cloud/docs/what-are-major-incidents/) for details."},{"name":"Post-incident review","description":"This resource represents Post-incident review of a Jira Service Management Incident. Use this resource to get, link and unlink an incident to a Post-incident review. See [Post-incident review](https://support.atlassian.com/jira-service-management-cloud/docs/what-are-post-incident-reviews/) for details."},{"name":"Responders","description":"This resource represents Responders to a Jira Service Management Incident. Use this resource to add, remove and fetch responders to an Incident. See [Incident responders](https://support.atlassian.com/jira-service-management-cloud/docs/add-and-manage-incident-responders/) for details."},{"name":"Stakeholders","description":"This resource represents Stakeholders to a Jira Service Management Incident. Use this resource to add, remove and fetch stakeholders to an Incident. See [Incident stakeholders](https://support.atlassian.com/jira-service-management-cloud/docs/how-can-i-add-and-manage-internal-stakeholders/) for details."}],"paths":{"/jsm/incidents/cloudId/{cloudId}/v1/post-incident-review/{issueID}/primary-incident":{"get":{"tags":["Post-incident review"],"summary":"Get primary incident","description":"Returns primary incident to a Jira Service Management Post-incident review\n            <br><br>**License required:** Premium or Enterprise","operationId":"getPrimaryIncidentOfPIR","parameters":[{"name":"issueID","in":"path","description":"JSM Post-incident review Issue ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returned if the request is successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncidentDTO"}}}},"400":{"description":"Returned if the Jira issue corresponding to the given issue Id is not of type Post-incident review."},"401":{"description":"Returned if the authentication credentials are incorrect."},"404":{"description":"Returned if the Post-incident review is not found or the user does not have permission to view the Post-incident review."}},"security":[{"OAuth2":["read:incident:jira-service-management"]}],"x-experimental":"true"}},"/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/affected-service/add":{"post":{"tags":["Affected Services"],"summary":"Add affected services","description":"Adds affected services to a Jira Service Management Incident","operationId":"addAffectedServices","parameters":[{"name":"issueID","in":"path","description":"The ID of the incident issue.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddAffectedServicesRequest"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful."},"400":{"description":"Returned if the Jira issue corresponding to the given issue Id is not of type incident."},"401":{"description":"Returned if the authentication credentials are incorrect."},"404":{"description":"Returned if the incident is not found or the user does not have permission to view the incident."}},"security":[{"OAuth2":["read:incident:jira-service-management","write:incident:jira-service-management"]}],"x-experimental":"true"}},"/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/stakeholder/add":{"post":{"tags":["Stakeholders"],"summary":"Add stakeholders","description":"Adds stakeholders to a Jira Service Management Incident.","operationId":"addStakeholders","parameters":[{"name":"issueID","in":"path","description":"The ID of the incident issue.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddStakeholdersRequest"}}},"required":true},"responses":{"204":{"description":"Add stakeholders will be performed"},"400":{"description":"Returned if the Jira issue corresponding to the given issue Id is not of type incident."},"401":{"description":"Returned if the authentication credentials are incorrect."},"404":{"description":"Returned if the incident is not found or the user does not have permission to view the incident."}},"security":[{"OAuth2":["read:incident:jira-service-management","write:incident:jira-service-management"]}],"x-experimental":"true"}},"/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/alert":{"get":{"tags":["Linked alerts"],"summary":"Get linked alerts","description":"Returns linked alerts to a Jira Service Management Incident.","operationId":"getAssociatedAlerts","parameters":[{"name":"issueID","in":"path","description":"The ID of the incident issue.","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"startKey","in":"query","description":"Pagination parameter for the next page.","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAssociatedAlertsResponse"}}}},"400":{"description":"Returned if the Jira issue corresponding to the given issue Id is not of type incident."},"401":{"description":"Returned if the authentication credentials are incorrect."},"404":{"description":"Returned if the incident is not found or the user does not have permission to view the incident."}},"security":[{"OAuth2":["read:incident:jira-service-management"]}],"x-experimental":"true"}},"/jsm/incidents/cloudId/{cloudId}/v1/request/{requestId}":{"get":{"tags":["Request status"],"summary":"Get request status","description":"Returns request status for asynchronous operations, which return HTTP status <code>202 - Accepted</code> and a <code>requestId</code> attribute in response payload. ","operationId":"getRequestStatus","parameters":[{"name":"requestId","in":"path","description":"Unique ID returned by API that returns <code>202 - Accepted</code>.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncRequestStatusResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect."}},"security":[{"OAuth2":["read:incident:jira-service-management"]}],"x-experimental":"true"}},"/jsm/incidents/cloudId/{cloudId}/v1/post-incident-review/{issueID}/primary-incident/remove":{"delete":{"tags":["Post-incident review"],"summary":"Remove primary incident","description":"\"Remove primary incident to a Jira Service Management Post-incident review\n            <br><br>**License required:** Premium or Enterprise","operationId":"removePrimaryIncidentFromPIR","parameters":[{"name":"issueID","in":"path","description":"JSM Post-incident review Issue ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Returned if the request is successful."},"400":{"description":"Returned if the Jira issue corresponding to the given issue Id is not of type Post-incident review"},"401":{"description":"Returned if the authentication credentials are incorrect."},"404":{"description":"Returned if the Post-incident review is not found or the user does not have permission to view the Post-incident review."}},"security":[{"OAuth2":["read:incident:jira-service-management","write:incident:jira-service-management"]}],"x-experimental":"true"}},"/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/affected-service":{"get":{"tags":["Affected Services"],"summary":"Get affected services","description":"Returns affected services to a Jira Service Management Incident.","operationId":"getAffectedServices","parameters":[{"name":"issueID","in":"path","description":"The ID of the incident issue.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAffectedServicesResponse"}}}},"400":{"description":"Returned if the Jira issue corresponding to the given issue Id is not of type incident."},"401":{"description":"Returned if the authentication credentials are incorrect."},"404":{"description":"Returned if the incident is not found or the user does not have permission to view the incident."}},"security":[{"OAuth2":["read:incident:jira-service-management"]}],"x-experimental":"true"}},"/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/chat/channel":{"get":{"tags":["Chat tools"],"summary":"Get chat channels","description":"Returns all chat channels available to a Jira Service Management Incident.\n            <br><br>**License required:** Premium or Enterprise","operationId":"getChatChannels","parameters":[{"name":"issueID","in":"path","description":"The ID of the incident issue.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetChatChannelResponse"}}}},"400":{"description":"Returned if the Jira issue corresponding to the given issue Id is not of type incident."},"401":{"description":"Returned if the authentication credentials are incorrect."},"404":{"description":"Returned if the incident is not found or the user does not have permission to view the incident."}},"security":[{"OAuth2":["read:incident:jira-service-management"]}],"x-experimental":"true"}},"/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/responder/remove":{"post":{"tags":["Responders"],"summary":"Remove responders","description":"Removes responders to a Jira Service Management Incident. Note that responders can be both user and team responders.","operationId":"removeResponders","parameters":[{"name":"issueID","in":"path","description":"The ID of the incident issue.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RespondersDTO"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful."},"400":{"description":"Returned if the Jira issue corresponding to the given issue Id is not of type incident."},"401":{"description":"Returned if the authentication credentials are incorrect."},"404":{"description":"Returned if the incident is not found or the user does not have permission to view the incident."}},"security":[{"OAuth2":["read:incident:jira-service-management","write:incident:jira-service-management"]}],"x-experimental":"true"}},"/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/stakeholder/remove":{"post":{"tags":["Stakeholders"],"summary":"Remove stakeholders","description":"Removes stakeholders to a Jira Service Management Incident.","operationId":"removeStakeholders","parameters":[{"name":"issueID","in":"path","description":"The ID of the incident issue.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveStakeholdersRequest"}}},"required":true},"responses":{"204":{"description":"Remove stakeholders will be performed"},"400":{"description":"Returned if the Jira issue corresponding to the given issue Id is not of type incident."},"401":{"description":"Returned if the authentication credentials are incorrect."},"404":{"description":"Returned if the incident is not found or the user does not have permission to view the incident."}},"security":[{"OAuth2":["read:incident:jira-service-management","write:incident:jira-service-management"]}],"x-experimental":"true"}},"/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}":{"get":{"tags":["Incident"],"summary":"Get incident","description":"Returns a Jira Service Management Incident.","operationId":"getIncident","parameters":[{"name":"issueID","in":"path","description":"The ID of the incident issue.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncidentDTO"}}}},"400":{"description":"Returned if the Jira issue corresponding to the given issue Id is not of type incident."},"401":{"description":"Returned if the authentication credentials are incorrect."},"404":{"description":"Returned if the incident is not found or the user does not have permission to view the incident."}},"security":[{"OAuth2":["read:incident:jira-service-management"]}],"x-experimental":"true"},"delete":{"tags":["Incident"],"summary":"Delete Incident","description":"Deletes a Jira Service Management Incident.","operationId":"deleteIncident","parameters":[{"name":"issueID","in":"path","description":"The ID of the incident issue.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Returned if the request is successful."},"400":{"description":"Returned if the Jira issue corresponding to the given issue Id is not of type incident."},"401":{"description":"Returned if the authentication credentials are incorrect."},"404":{"description":"Returned if the incident is not found or the user does not have permission to view the incident."}},"security":[{"OAuth2":["read:incident:jira-service-management","write:incident:jira-service-management"]}],"x-experimental":"true"}},"/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/stakeholder":{"get":{"tags":["Stakeholders"],"summary":"Get stakeholders","description":"Returns stakeholders to a Jira Service Management Incident.","operationId":"getStakeholders","parameters":[{"name":"issueID","in":"path","description":"The ID of the incident issue.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStakeholdersResponse"}}}},"400":{"description":"Returned if the Jira issue corresponding to the given issue Id is not of type incident."},"401":{"description":"Returned if the authentication credentials are incorrect."},"404":{"description":"Returned if the incident is not found or the user does not have permission to view the incident."}},"security":[{"OAuth2":["read:incident:jira-service-management"]}],"x-experimental":"true"}},"/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/alert/remove":{"post":{"tags":["Linked alerts"],"summary":"Remove linked alerts","description":"Removes linked alerts to a Jira Service Management Incident.","operationId":"removeAssociatedAlerts","parameters":[{"name":"issueID","in":"path","description":"The ID of the incident issue.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveAssociatedAlertsRequestDTO"}}},"required":true},"responses":{"202":{"description":"Alert unlinking will be enqueued and performed asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncSuccessResponse"}}}},"400":{"description":"Returned if the Jira issue corresponding to the given issue Id is not of type incident."},"401":{"description":"Returned if the authentication credentials are incorrect."},"404":{"description":"Returned if the incident is not found or the user does not have permission to view the incident."}},"security":[{"OAuth2":["read:incident:jira-service-management","write:incident:jira-service-management"]}],"x-experimental":"true"}},"/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/chat/channel/create":{"post":{"tags":["Chat tools"],"summary":"Create chat channel","description":"Create a new chat channel to a Jira Service Management Incident.\n            <br><br>**License required:** Premium or Enterprise","operationId":"createChatChannel","parameters":[{"name":"issueID","in":"path","description":"The ID of the incident issue.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateChatChannelRequest"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful."},"400":{"description":"Returned if the Jira issue corresponding to the given issue Id is not of type incident."},"401":{"description":"Returned if the authentication credentials are incorrect."},"404":{"description":"Returned if the incident is not found or the user does not have permission to view the incident."},"422":{"description":"Returned if the incident already has a linked slack channel or if a channel with the name already exists"}},"security":[{"OAuth2":["read:incident:jira-service-management","write:incident:jira-service-management"]}],"x-experimental":"true"}},"/jsm/incidents/cloudId/{cloudId}/v1/post-incident-review/{issueID}/primary-incident/add":{"post":{"tags":["Post-incident review"],"summary":"Add primary incident","description":"Add primary incident to a Jira Service Management Post-incident review.\n            <br><br>**License required:** Premium or Enterprise","operationId":"addPrimaryIncidentToPIR","parameters":[{"name":"issueID","in":"path","description":"JSM Post-incident review Issue ID.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrimaryIncident"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful."},"400":{"description":"Returned if the Jira issue corresponding to the given issue Id is not of type Post-incident review."},"401":{"description":"Returned if the authentication credentials are incorrect."},"404":{"description":"Returned if the Post-incident review is not found or the user does not have permission to view the Post-incident review."}},"security":[{"OAuth2":["read:incident:jira-service-management","write:incident:jira-service-management"]}],"x-experimental":"true"}},"/jsm/incidents/cloudId/{cloudId}/v1/incident":{"post":{"tags":["Incident"],"summary":"Create Incident","description":"Creates a new Incident in a service desk. ","operationId":"createIncident","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIncidentRequestDTO"}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIncidentResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect."}},"security":[{"OAuth2":["write:incident:jira-service-management"]}],"x-experimental":"true"}},"/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/major":{"get":{"tags":["Major Incident"],"summary":"Major incident status","description":"Returns the major incident status of a Jira Service Management Incident.\n            <br><br>**License required:** Premium or Enterprise","operationId":"getMajorIncident","parameters":[{"name":"issueID","in":"path","description":"The ID of the incident issue.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MajorIncidentDTO"}}}},"400":{"description":"Returned if the Jira issue corresponding to the given issue Id is not of type incident."},"401":{"description":"Returned if the authentication credentials are incorrect."},"404":{"description":"Returned if the incident is not found or the user does not have permission to view the incident."}},"security":[{"OAuth2":["read:incident:jira-service-management"]}],"x-experimental":"true"},"post":{"tags":["Major Incident"],"summary":"Update major incident status","description":"\"Updates the major incident status of a Jira Service Management Incident.\n            <br><br>**License required:** Premium or Enterprise","operationId":"updateMajorIncident","parameters":[{"name":"issueID","in":"path","description":"The ID of the incident issue.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MajorIncidentDTO"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful."},"400":{"description":"Returned if the Jira issue corresponding to the given issue Id is not of type incident."},"401":{"description":"Returned if the authentication credentials are incorrect."},"404":{"description":"Returned if the incident is not found or the user does not have permission to view the incident."}},"security":[{"OAuth2":["read:incident:jira-service-management","write:incident:jira-service-management"]}],"x-experimental":"true"}},"/jsm/incidents/cloudId/{cloudId}/v1/incident/bulk/link-alerts":{"post":{"tags":["Incident bulk actions"],"summary":"Add linked alerts","description":"Adds linked alerts to multiple Jira Service Management Incidents. See [What are linked alerts?](https://support.atlassian.com/jira-service-management-cloud/docs/what-are-linked-alerts/) for details.","operationId":"linkAlertsToIncidents","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkAlertsToIncidentsDTO"}}}},"responses":{"202":{"description":"Alerts linking request will be enqueued and performed asynchronously","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LinkAlertsToIncidentsDTO"}}}},"401":{"description":"Returned if the authentication credentials are incorrect."},"404":{"description":"Returned if the incidents are not found or the user does not have permission to view the incidents."}},"security":[{"OAuth2":["read:incident:jira-service-management","write:incident:jira-service-management"]}],"x-experimental":"true"}},"/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/responder":{"get":{"tags":["Responders"],"summary":"Get responders","description":"Returns responders to a Jira Service Management Incident. Note that responders can be both user and team responders.","operationId":"getResponders","parameters":[{"name":"issueID","in":"path","description":"The ID of the incident issue.","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"description":"Returned if the request is successful.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RespondersDTO"}}}},"400":{"description":"Returned if the Jira issue corresponding to the given issue Id is not of type incident."},"401":{"description":"Returned if the authentication credentials are incorrect."},"404":{"description":"Returned if the incident is not found or the user does not have permission to view the incident."}},"security":[{"OAuth2":["read:incident:jira-service-management"]}],"x-experimental":"true"}},"/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/responder/add":{"post":{"tags":["Responders"],"summary":"Add responders","description":"Adds responders to a Jira Service Management Incident. Note that responders can be both user and team responders.","operationId":"addResponders","parameters":[{"name":"issueID","in":"path","description":"The ID of the incident issue.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RespondersDTO"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful."},"400":{"description":"Returned if the Jira issue corresponding to the given issue Id is not of type incident."},"401":{"description":"Returned if the authentication credentials are incorrect."},"404":{"description":"Returned if the incident is not found or the user does not have permission to view the incident."}},"security":[{"OAuth2":["read:incident:jira-service-management","write:incident:jira-service-management"]}],"x-experimental":"true"}},"/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/chat/channel/unlink":{"delete":{"tags":["Chat tools"],"summary":"Unlink chat channel","description":"Unlinks the chat channel from the Jira Service Management Incident.\n            <br><br>**License required:** Premium or Enterprise","operationId":"unlinkChatChannel","parameters":[{"name":"issueID","in":"path","description":"The ID of the incident issue.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnlinkChatChannelRequest"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful."},"400":{"description":"Returned if the Jira issue corresponding to the given issue Id is not of type incident."},"401":{"description":"Returned if the authentication credentials are incorrect."},"404":{"description":"Returned if the incident is not found or the user does not have permission to view the incident."}},"security":[{"OAuth2":["read:incident:jira-service-management","write:incident:jira-service-management"]}],"x-experimental":"true"}},"/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/affected-service/remove":{"post":{"tags":["Affected Services"],"summary":"Remove affected services","description":"Removes affected services to a Jira Service Management Incident","operationId":"removeAffectedServices","parameters":[{"name":"issueID","in":"path","description":"The ID of the incident issue.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RemoveAffectedServicesRequest"}}},"required":true},"responses":{"204":{"description":"Returned if the request is successful."},"400":{"description":"Returned if the Jira issue corresponding to the given issue Id is not of type incident."},"401":{"description":"Returned if the authentication credentials are incorrect."},"404":{"description":"Returned if the incident is not found or the user does not have permission to view the incident."}},"security":[{"OAuth2":["read:incident:jira-service-management","write:incident:jira-service-management"]}],"x-experimental":"true"}},"/jsm/incidents/cloudId/{cloudId}/v1/incident/{issueID}/alert/add":{"post":{"tags":["Linked alerts"],"summary":"Add linked alerts","description":"Adds linked alerts to a Jira Service Management Incident.","operationId":"addAssociatedAlerts","parameters":[{"name":"issueID","in":"path","description":"The ID of the incident issue.","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddAssociatedAlertsRequestDTO"}}},"required":true},"responses":{"202":{"description":"Alert linking will be enqueued and performed asynchronously.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AsyncSuccessResponse"}}}},"400":{"description":"Returned if the Jira issue corresponding to the given issue Id is not of type incident."},"401":{"description":"Returned if the authentication credentials are incorrect."},"404":{"description":"Returned if the incident is not found or the user does not have permission to view the incident."}},"security":[{"OAuth2":["read:incident:jira-service-management","write:incident:jira-service-management"]}],"x-experimental":"true"}},"/jsm/incidents/cloudId/{cloudId}/v1/post-incident-review":{"post":{"tags":["Post-incident review"],"summary":"Create Post-incident review","description":"Creates a Post-incident review to a Jira Service Management Incident.\n            <br><br>**License required:** Premium or Enterprise","operationId":"createPostIncidentReview","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePostIncidentReviewRequest"}}},"required":true},"responses":{"201":{"description":"Returned if the request is successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateIssueResponse"}}}},"401":{"description":"Returned if the authentication credentials are incorrect."}},"security":[{"OAuth2":["read:incident:jira-service-management","write:incident:jira-service-management"]}],"x-experimental":"true"}}},"components":{"schemas":{"AddAffectedServicesRequest":{"required":["affectedServices"],"type":"object","properties":{"affectedServices":{"maxItems":20,"minItems":1,"type":"array","description":"List of Affected Services ARI of a JSM Incident","items":{"$ref":"#/components/schemas/AffectedServicesAri"}}},"example":{"affectedServices":[{"ari":"ari:cloud:graph::service/88b53f41-0fa3-4371-95f7-ef8e65910943/4f302e3a-b39c-11ee-8d82-0e3e7a21a911"}]}},"AffectedServicesAri":{"type":"object","properties":{"ari":{"type":"string"}},"description":"List of Affected Services ARI of a JSM Incident"},"GetAffectedServicesResponse":{"type":"object","properties":{"affectedServices":{"type":"array","description":"List of Affected Services ARI of a JSM Incident","items":{"$ref":"#/components/schemas/AffectedServicesAri"}}},"example":{"affectedServices":[{"ari":"ari:cloud:graph::service/88b53f41-0fa3-4371-95f7-ef8e65910943/4f302e3a-b39c-11ee-8d82-0e3e7a21a911"}]}},"RemoveAffectedServicesRequest":{"required":["affectedServices"],"type":"object","properties":{"affectedServices":{"maxItems":20,"minItems":1,"type":"array","description":"List of Affected Services ARI of a JSM Incident","items":{"$ref":"#/components/schemas/AffectedServicesAri"}}},"example":{"affectedServices":[{"ari":"ari:cloud:graph::service/88b53f41-0fa3-4371-95f7-ef8e65910943/4f302e3a-b39c-11ee-8d82-0e3e7a21a911"}]}},"AsyncSuccessResponse":{"type":"object","properties":{"requestID":{"type":"string","description":"The ID of async operation request."},"message":{"type":"string","description":"Message for async operation request."}},"example":{"requestID":"dc84ac4e-c5dc-4330-a3e9-fca23326cdc9","message":"Linked alerts action will be performed"}},"AddAssociatedAlertsRequestDTO":{"required":["alertIds"],"type":"object","properties":{"alertIds":{"maxItems":25,"minItems":1,"type":"array","description":"List of alert IDs to be linked to the Incident.","items":{"type":"string","description":"List of alert IDs to be linked to the Incident."}}},"example":{"alertIds":["8dd24912-a0ad-41cd-ac80-535eaf649ed7"]}},"AlertIds":{"type":"object","properties":{"alertIds":{"type":"array","items":{"type":"string"}}},"description":"List of alert IDs linked to an incident."},"GetAssociatedAlertsResponse":{"type":"object","properties":{"values":{"$ref":"#/components/schemas/AlertIds"},"startKey":{"type":"integer","description":"The cursor to the first item on the next page of results.","format":"int64"}},"example":{"values":{"alertIds":["8dd24912-a0ad-41cd-ac80-535eaf649ed7"]},"startKey":null}},"RemoveAssociatedAlertsRequestDTO":{"type":"object","properties":{"alertIds":{"maxItems":25,"minItems":1,"type":"array","description":"List of alert IDs to be unlinked from the Incident.","items":{"type":"string","description":"List of alert IDs to be unlinked from the Incident."}}},"example":{"alertIds":["8dd24912-a0ad-41cd-ac80-535eaf649ed7"]}},"AsyncRequestStatusResponse":{"type":"object","properties":{"requestId":{"type":"string","description":"Request Id of operation that returns HTTP status <code>202 - Accepted</code>."},"success":{"type":"boolean","description":"Whether the operation requested has been processed successfully."},"result":{"type":"string","description":"Result of the asynchronous operation."},"processedAt":{"type":"string","description":"Time at which the request was processed."}},"example":{"requestId":"dc84ac4e-c5dc-4330-a3e9-fca23326cdc9","success":true,"result":"Async operations has been performed successfully","processedAt":"2023-05-02T10:05:33.527Z"}},"CreateChatChannelRequest":{"required":["channelDescription","channelName","channelType","connectionId"],"type":"object","properties":{"connectionId":{"type":"string","description":"ID of the chat connection with which to create the channel."},"channelType":{"type":"string","description":"Type of the channel to be created","enum":["slack"]},"channelName":{"type":"string","description":"Name of the slack channel to be created"},"channelDescription":{"type":"string","description":"Description of the slack channel to be created"}},"example":{"connectionId":"e3cc821f-cd95-4cc7-a24f-fa855dd19677","channelType":"slack","channelName":"foo-channel-5","channelDescription":"good-channel"}},"Channel":{"type":"object","properties":{"active":{"type":"boolean"},"connectionId":{"type":"string"},"channelType":{"type":"string"},"name":{"type":"string"}},"example":{"active":true,"connectionId":"e3cc821f-cd95-4cc7-a24f-fa855dd19677","channelType":"slack","name":"sip-0"}},"GetChatChannelResponse":{"type":"object","properties":{"channels":{"type":"array","items":{"$ref":"#/components/schemas/Channel"}}}},"UnlinkChatChannelRequest":{"required":["channelType","connectionId"],"type":"object","properties":{"connectionId":{"type":"string","description":"ID of the chat connection with which to unlink the channel."},"channelType":{"type":"string","description":"Type of the channel to be unlinked","enum":["slack"]}},"example":{"connectionId":"e3cc821f-cd95-4cc7-a24f-fa855dd19677","channelType":"slack"}},"LinkAlertsToIncidentsDTO":{"required":["alertIds","issueIds"],"type":"object","properties":{"issueIds":{"maxItems":50,"minItems":1,"type":"array","description":"List of Incident Issue IDs.","items":{"type":"string","description":"List of Incident Issue IDs."}},"alertIds":{"maxItems":100,"minItems":1,"type":"array","description":"List of alert IDs to be linked to the Incidents.","items":{"type":"string","description":"List of alert IDs to be linked to the Incidents."}}},"example":{"issueIds":["10005","10006"],"alertIds":["8dd24912-a0ad-41cd-ac80-535eaf649ed7"]}},"CreateIncidentResponse":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the incident issue."},"key":{"type":"string","description":"The key of the incident issue."},"self":{"type":"string","description":"The URL to the incident issue uri.","format":"uri"}},"example":{"id":"10050","key":"ITSM-30","self":"http://your-domain.atlassian.net/rest/api/3/issue/10050"}},"CreateIncidentRequestDTO":{"required":["requestTypeId","serviceDeskId"],"type":"object","properties":{"serviceDeskId":{"type":"string","description":"ID of the service desk in which to create the Incident."},"requestTypeId":{"type":"string","description":"ID of the request type for Incident."},"fields":{"type":"object","additionalProperties":{"type":"object","description":"List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use <code>update</code>. Fields included here can't be included in <code>update</code>."},"description":"List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use <code>update</code>. Fields included here can't be included in <code>update</code>."},"update":{"type":"object","additionalProperties":{"type":"object","description":"A Map containing the field name and a list of operations to perform on the issue screen field. Note that fields included here can't be included in <code>fields</code>."},"description":"A Map containing the field name and a list of operations to perform on the issue screen field. Note that fields included here can't be included in <code>fields</code>."},"alertIds":{"maxItems":25,"minItems":1,"type":"array","description":"List of alert IDs to be linked to the Incident.","items":{"type":"string","description":"List of alert IDs to be linked to the Incident."}}},"example":{"requestTypeId":"75","serviceDeskId":"6","fields":{"summary":"Incident with alerts from JSM Incidents APIs","customfield_10002":[{"ari":"ari:cloud:identity::user/99:27935d01-92a7-4687-8272-a9b8d3b2ae2e"}]},"alertIds":["8dd24912-a0ad-41cd-ac80-535eaf649ed7"]}},"AffectedServiceAri":{"type":"object","properties":{"id":{"type":"string"}}},"AffectedServicesField":{"type":"object","properties":{"fieldId":{"type":"string"},"value":{"type":"array","items":{"$ref":"#/components/schemas/AffectedServiceAri"}}}},"Assignee":{"type":"object","properties":{"accountId":{"type":"string"},"accountType":{"type":"string","enum":["ATLASSIAN_ACCOUNT","CUSTOMER_ACCOUNT","APP","ANONYMOUS"]},"displayName":{"type":"string"}}},"IncidentDTO":{"type":"object","properties":{"summary":{"type":"string"},"description":{"type":"string"},"reporter":{"$ref":"#/components/schemas/Reporter"},"assignee":{"$ref":"#/components/schemas/Assignee"},"priority":{"$ref":"#/components/schemas/JiraPriority"},"status":{"$ref":"#/components/schemas/Status"},"participants":{"$ref":"#/components/schemas/ParticipantsField"},"labels":{"type":"array","items":{"type":"string"}},"issueLinks":{"type":"array","items":{"$ref":"#/components/schemas/IssueLink"}},"majorIncident":{"$ref":"#/components/schemas/MajorIncidentField"},"responders":{"$ref":"#/components/schemas/RespondersField"},"affectedServices":{"$ref":"#/components/schemas/AffectedServicesField"},"linkedAlerts":{"type":"array","items":{"type":"string"}}},"example":{"summary":"Mia create this incident","reporter":{"accountId":"99:27935d01-92a7-4687-8272-a9b8d3b2ae2e","accountType":"ATLASSIAN_ACCOUNT","displayName":"Mia Krystof"},"priority":{"name":"Medium","id":"3"},"status":{"id":"1","name":"Open","statusCategory":{"id":2,"key":"new","name":"To Do"}},"participants":{"fieldId":"customfield_10000","value":[]},"majorIncident":{"fieldId":"customfield_10001","value":null},"responders":{"fieldId":"customfield_10002","value":[{"ari":"ari:cloud:identity::user/99:27935d01-92a7-4687-8272-a9b8d3b2ae2e","name":"Mia Krystof","type":"user"}]},"affectedServices":{"fieldId":"customfield_10003","value":[]}}},"IssueLink":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/IssueLinktype"},"outwardIssue":{"$ref":"#/components/schemas/IssueLinkObject"},"inwardIssue":{"$ref":"#/components/schemas/IssueLinkObject"}}},"IssueLinkObject":{"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"}}},"IssueLinktype":{"type":"object","properties":{"id":{"type":"string"}}},"JiraPriority":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"}}},"MajorIncidentField":{"type":"object","properties":{"fieldId":{"type":"string"},"value":{"type":"string"}}},"Participant":{"type":"object","properties":{"accountId":{"type":"string"},"accountType":{"type":"string","enum":["ATLASSIAN_ACCOUNT","CUSTOMER_ACCOUNT","APP","ANONYMOUS"]},"displayName":{"type":"string"}}},"ParticipantsField":{"type":"object","properties":{"fieldId":{"type":"string"},"value":{"type":"array","items":{"$ref":"#/components/schemas/Participant"}}}},"Reporter":{"type":"object","properties":{"accountId":{"type":"string"},"accountType":{"type":"string","enum":["ATLASSIAN_ACCOUNT","CUSTOMER_ACCOUNT","APP","ANONYMOUS"]},"displayName":{"type":"string"}}},"Responder":{"type":"object","properties":{"ari":{"type":"string"}},"description":"List of responder ARIs that represents user or team responders."},"RespondersField":{"type":"object","properties":{"fieldId":{"type":"string"},"value":{"type":"array","items":{"$ref":"#/components/schemas/Responder"}}}},"Status":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"statusCategory":{"$ref":"#/components/schemas/StatusCategory"}}},"StatusCategory":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"key":{"type":"string"},"name":{"type":"string"}}},"MajorIncidentDTO":{"required":["majorIncident"],"type":"object","properties":{"majorIncident":{"type":"boolean","description":"Whether the Jira Service Management Incident is Major Incident. [Learn more about major incidents](https://support.atlassian.com/jira-service-management-cloud/docs/what-are-major-incidents/)."}},"example":{"majorIncident":true}},"PrimaryIncident":{"required":["issueID"],"type":"object","properties":{"issueID":{"type":"integer","description":"JSM Incident Issue ID","format":"int64"}},"example":{"issueID":10050}},"CreateIssueResponse":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the jira issue."},"key":{"type":"string","description":"The key of the jira issue."},"self":{"type":"string","description":"The URL to the jira issue uri.","format":"uri"}},"example":{"id":"10050","key":"ITSM-30","self":"http://your-domain.atlassian.net/rest/api/3/issue/10050"}},"CreatePostIncidentReviewRequest":{"required":["issueID","requestTypeId","serviceDeskId"],"type":"object","properties":{"issueID":{"type":"integer","description":"JSM Incident Issue ID","format":"int64"},"serviceDeskId":{"type":"string","description":"ID of the service desk in which to create the Post-incident review."},"requestTypeId":{"type":"string","description":"ID of the request type for Post-incident review."},"fields":{"type":"object","additionalProperties":{"type":"object","description":"List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use <code>update</code>. Fields included here can't be included in <code>update</code>."},"description":"List of issue screen fields to update, specifying the sub-field to update and its value for each field. This field provides a straightforward option when setting a sub-field. When multiple sub-fields or other operations are required, use <code>update</code>. Fields included here can't be included in <code>update</code>."}},"example":{"incidentIssueId":10075,"requestTypeId":"20","serviceDeskId":"3","fields":{"summary":"PIRfromJSMIncidentsAPIs"}}},"RespondersDTO":{"required":["responders"],"type":"object","properties":{"responders":{"maxItems":25,"minItems":1,"type":"array","description":"List of responder ARIs that represents user or team responders.","items":{"$ref":"#/components/schemas/Responder"}}},"example":{"responders":[{"ari":"ari:cloud:identity::user/99:27935d01-92a7-4687-8272-a9b8d3b2ae2e"}]}},"AddStakeholdersRequest":{"required":["stakeholders"],"type":"object","properties":{"stakeholders":{"maxItems":25,"minItems":1,"type":"array","description":"List of stakeholder ARIs that represent stakeholder users","items":{"$ref":"#/components/schemas/Stakeholders"}}},"example":{"stakeholders":[{"ari":"ari:cloud:identity::user/627bf6c6a20bd0006fda4da3"}]}},"Stakeholders":{"type":"object","properties":{"ari":{"type":"string"}},"description":"List of stakeholder ARIs that represent stakeholder users"},"GetStakeholdersResponse":{"type":"object","properties":{"stakeholders":{"type":"array","description":"List of stakeholder ARIs that represent stakeholder users","items":{"$ref":"#/components/schemas/Stakeholders"}}},"example":{"stakeholders":[{"ari":"ari:cloud:identity::user/627bf6c6a20bd0006fda4da3"}]}},"RemoveStakeholdersRequest":{"required":["stakeholders"],"type":"object","properties":{"stakeholders":{"maxItems":25,"minItems":1,"type":"array","description":"List of stakeholder ARIs that represent stakeholder users","items":{"$ref":"#/components/schemas/Stakeholders"}}},"example":{"stakeholders":[{"ari":"ari:cloud:identity::user/627bf6c6a20bd0006fda4da3"}]}}},"securitySchemes":{"OAuth2":{"type":"oauth2","description":"JSM Incident API endpoints with authorised issuer 'micros/edge-authenticator' are accessible via stargate with OAuth","flows":{"authorizationCode":{"authorizationUrl":"https://auth.atlassian.com/authorize","tokenUrl":"https://auth.atlassian.com/oauth/token","scopes":{"read:incident:jira-service-management":"Get read incident capabilities","write:incident:jira-service-management":"Get write incident capabilities"}}}}}},"servers":[{"url":"https://api.atlassian.com"}],"x-atlassian-narrative":{"documents":[{"title":"About","anchor":"about","body":"This is the reference for the Jira Service Management Incident REST API. The REST API is for developers who want to integrate JSM Incident with other applications or administrators that want to automate their workflows and processes."},{"title":"Version","anchor":"version","body":"This documentation is for **version 1** of the Jira Service Management Incident REST API, which is the latest version but is in **beta**.\n\nHowever, these new features are under development and may change."},{"title":"Jira Cloud Platform APIs","anchor":"jira-cloud-platform-apis","body":"Jira Service Management is built upon the Jira platform. As such, in Jira Service Management you have access to the Jira platform REST APIs.\n - [Browse the Jira platform REST APIs](https://developer.atlassian.com/cloud/jira/platform/rest/)"},{"title":"Authentication and authorization","anchor":"authentication","body":"### Forge apps\nFor Forge apps, the following JSM Incident scopes are used when authenticating with Jira Cloud platform:\n\n`read:incident:jira-service-management`\n\n`write:incident:jira-service-management`\n\nSee [Add scopes to call an JSM Incident REST API](https://developer.atlassian.com/platform/forge/add-scopes-to-call-an-atlassian-rest-api/) for more details.\n\nThe URIs for Forge app REST API calls have this structure:\n\n`/jsm/incidents/cloudId/<cloudId>/v1/incidents/<issueID>`\n\nFor example, `/jsm/incidents/cloudId/35273b54-3f06-40d2-880f-dd28cf8daafa/v1/incidents/10014`\n### Other integrations\nFor integrations that are not Forge apps, use OAuth 2.0 authorization code grants (3LO) for security (3LO scopes are shown as for operations OAuth scopes required). See [OAuth 2.0 (3LO) apps](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps/) for details.\n\nThe URIs for OAuth 2.0 (3LO) app REST API calls have this structure:\n\n`https://api.atlassian.com/ex/jira/incidents/cloudId/<cloudId>/v1/incidents/<issueID>`\n\nFor example, `https://api.atlassian.com/ex/jira/incidents/cloudId/35273b54-3f06-40d2-880f-dd28cf8daafa/v1/incidents/10014`\n### Ad-hoc API calls\nFor personal scripts, bots, and ad-hoc execution of the REST APIs use basic authentication. See [Basic auth for JSM Incident REST APIs](https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/) for details.\n\nThe URIs for basic authentication REST API calls have this structure:\n\n`https://<site-url>/jsm/incidents/cloudId/<cloudId>/v1/incidents/<issueID>`\n\nFor example, `https://your-domain.atlassian.net/jsm/incidents/cloudId/35273b54-3f06-40d2-880f-dd28cf8daafa/v1/incidents/10014`"},{"title":"Experimental methods","anchor":"experimental-methods","body":"Methods marked as <span class=\"aui-lozenge aui-lozenge-current\">EXPERIMENTAL</span> may change without notice. To use experimental methods, you must include the <code>X-ExperimentalApi: opt-in</code> header in your requests. This header indicates that you are opting into the experimental preview. Once a resource or method moves out of the experimental phase, the header will no longer be required or checked.\n\nFeedback on the experimental APIs is welcome and can be provided by submitting a feature request or suggestion through the [Atlassian Ecosystem Help Center](https://ecosystem.atlassian.net/servicedesk/customer/portals) or the [Jira Service Management Ecosystem](https://ecosystem.atlassian.net/browse/JSDECO)."},{"title":"Status codes and responses","anchor":"status-codes-and-responses","body":"Jira Service Management Incident API uses the [standard HTTP status codes](https://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).\n\n - <span class=\"aui-lozenge aui-lozenge-success\">STATUS 200</span>\nReturned if the requested content (GET) is returned or content is updated (POST).\n\n - <span class=\"aui-lozenge aui-lozenge-success\">STATUS 201</span>\nReturned if new records are created (POST).\n\n - <span class=\"aui-lozenge aui-lozenge-success\">STATUS 202</span>\nReturned if update or create operations on new or existing records are accepted to be processed asynchronously (PUT or POST).\n\n - <span class=\"aui-lozenge aui-lozenge-success\">STATUS 204</span>\nReturned where the request has been successfully processed, the outcome is as expected. For example, the request to delete an Incident, and Incident is successfully deleted .\n\n - <span class=\"aui-lozenge aui-lozenge-removed\">STATUS 400</span>\nReturned if the request was invalid.\n\n - <span class=\"aui-lozenge aui-lozenge-removed\">STATUS 403</span>\nReturned if the user does not have the necessary permission to access the resource or run the method.\n\n - <span class=\"aui-lozenge aui-lozenge-removed\">STATUS 404</span>\nReturned if the (object) is not found, for example, no Incident exists for the given Issue ID.\n\n - <span class=\"aui-lozenge aui-lozenge-removed\">STATUS 412</span>\nReturned if the API is experimental but the X-ExperimentalApi: opt-in header was not passed. For more details, see [Experimental methods](#experimental-methods).\n\nOperations that return an error status code may also return a response body containing details of the error or errors. The schema for the response body is shown below:\n\n```json\n{\n  \"errors\": [\n    {\n      \"code\": \"USER_NOT_FOUND\",\n      \"title\": \"Actual reason why user was not found\",\n      \"detail\": \"Optional detail of the error\"\n    }, \n    {\n      ...\n    }\n  ]\n}\n```"},{"title":"Pagination","anchor":"pagination","body":"The JSM Incident API uses pagination to conserve server resources and limit the size of responses. Pagination is enforced for methods that could return a large collection. When you make a request to a paginated API, the response will wrap the returned values in a JSON object with paging metadata, as follows:\n\n#### Request\n\n```\nhttp://host:port/context/rest/api-name/resource-name?startKey=<cursor_of_resource>\n```\n#### Response\n\n```json\n{\n    \"startKey\" : <cursor_of_the_first_resouce_in_next_page>,\n    \"values\": [\n        { /* result 0 */ },\n        { /* result 1 */ },\n        { /* result 2 */ }\n        { /* result 3 */ }\n        { /* result 4 */ }\n        { /* result 5 */ }\n        { /* result 6 */ }\n    ]\n}\n```\n\nWhere:\n\n - <code>startKey</code> is the cursor to the first item on the next page of results. If next page does not exist then the <code>startKey</code> will be null.\n\nThe page limit set for each resource’s method are an implementation detail and may change in future."}]}}