Jira Service Management REST API

The first-party Jira Service Management REST API at /rest/servicedeskapi — 75 operations covering service desks, customer requests, request types, queues, SLAs, organizations, customers and the knowledge base. Harvested verbatim from Atlassian.

Operations 75

GET /rest/servicedeskapi/assets/workspace Get assets workspaces #
POST /rest/servicedeskapi/customer Create customer #
POST /rest/servicedeskapi/customer/skip-permission-check Create customer #
PUT /rest/servicedeskapi/customer/user/{accountId}/revoke-portal-only-access Revoke portal only access for user #
GET /rest/servicedeskapi/info Get info #
GET /rest/servicedeskapi/insight/workspace Get insight workspaces #
GET /rest/servicedeskapi/knowledgebase/article Get articles #
GET /rest/servicedeskapi/knowledgebase/article/view/{pageId} View knowledge base article #
GET /rest/servicedeskapi/organization Get organizations #
POST /rest/servicedeskapi/organization Create organization #
DELETE /rest/servicedeskapi/organization/{organizationId} Delete organization #
GET /rest/servicedeskapi/organization/{organizationId} Get organization #
GET /rest/servicedeskapi/organization/{organizationId}/property Get properties keys #
DELETE /rest/servicedeskapi/organization/{organizationId}/property/{propertyKey} Delete property #
GET /rest/servicedeskapi/organization/{organizationId}/property/{propertyKey} Get property #
PUT /rest/servicedeskapi/organization/{organizationId}/property/{propertyKey} Set property #
DELETE /rest/servicedeskapi/organization/{organizationId}/user Remove users from organization #
GET /rest/servicedeskapi/organization/{organizationId}/user Get users in organization #
POST /rest/servicedeskapi/organization/{organizationId}/user Add users to organization #
GET /rest/servicedeskapi/request Get customer requests #
POST /rest/servicedeskapi/request Create customer request #
POST /rest/servicedeskapi/request/validate Validate customer request #
GET /rest/servicedeskapi/request/{issueIdOrKey} Get customer request by id or key #
GET /rest/servicedeskapi/request/{issueIdOrKey}/approval Get approvals #
GET /rest/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId} Get approval by id #
POST /rest/servicedeskapi/request/{issueIdOrKey}/approval/{approvalId} Answer approval #
GET /rest/servicedeskapi/request/{issueIdOrKey}/attachment Get attachments for request #
POST /rest/servicedeskapi/request/{issueIdOrKey}/attachment Create comment with attachment #
GET /rest/servicedeskapi/request/{issueIdOrKey}/attachment/{attachmentId} Get attachment content #
GET /rest/servicedeskapi/request/{issueIdOrKey}/attachment/{attachmentId}/thumbnail Get attachment thumbnail #
GET /rest/servicedeskapi/request/{issueIdOrKey}/comment Get request comments #
POST /rest/servicedeskapi/request/{issueIdOrKey}/comment Create request comment #
GET /rest/servicedeskapi/request/{issueIdOrKey}/comment/{commentId} Get request comment by id #
GET /rest/servicedeskapi/request/{issueIdOrKey}/comment/{commentId}/attachment Get comment attachments #
DELETE /rest/servicedeskapi/request/{issueIdOrKey}/notification Unsubscribe #
GET /rest/servicedeskapi/request/{issueIdOrKey}/notification Get subscription status #
PUT /rest/servicedeskapi/request/{issueIdOrKey}/notification Subscribe #
DELETE /rest/servicedeskapi/request/{issueIdOrKey}/participant Remove request participants #
GET /rest/servicedeskapi/request/{issueIdOrKey}/participant Get request participants #
POST /rest/servicedeskapi/request/{issueIdOrKey}/participant Add request participants #
GET /rest/servicedeskapi/request/{issueIdOrKey}/sla Get sla information #
GET /rest/servicedeskapi/request/{issueIdOrKey}/sla/{slaMetricId} Get sla information by id #
GET /rest/servicedeskapi/request/{issueIdOrKey}/status Get customer request status #
GET /rest/servicedeskapi/request/{issueIdOrKey}/transition Get customer transitions #
POST /rest/servicedeskapi/request/{issueIdOrKey}/transition Perform customer transition #
DELETE /rest/servicedeskapi/request/{requestIdOrKey}/feedback Delete feedback #
GET /rest/servicedeskapi/request/{requestIdOrKey}/feedback Get feedback #
POST /rest/servicedeskapi/request/{requestIdOrKey}/feedback Post feedback #
GET /rest/servicedeskapi/requesttype Get all request types #
GET /rest/servicedeskapi/servicedesk Get service desks #
GET /rest/servicedeskapi/servicedesk/{serviceDeskId} Get service desk by id #
POST /rest/servicedeskapi/servicedesk/{serviceDeskId}/attachTemporaryFile Attach temporary file #
DELETE /rest/servicedeskapi/servicedesk/{serviceDeskId}/customer Remove customers #
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/customer Get customers #
POST /rest/servicedeskapi/servicedesk/{serviceDeskId}/customer Add customers #
POST /rest/servicedeskapi/servicedesk/{serviceDeskId}/customer/invite Invite customer #
POST /rest/servicedeskapi/servicedesk/{serviceDeskId}/customer/skip-permission-check Add customers #
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/knowledgebase/article Get articles #
DELETE /rest/servicedeskapi/servicedesk/{serviceDeskId}/organization Remove organization #
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/organization Get organizations #
POST /rest/servicedeskapi/servicedesk/{serviceDeskId}/organization Add organization #
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/queue Get queues #
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/queue/{queueId} Get queue #
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/queue/{queueId}/issue Get issues in queue #
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype Get request types #
POST /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype Create request type #
POST /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/permissions/check Check request type permissions #
DELETE /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId} Delete request type #
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId} Get request type by id #
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/field Get request type fields #
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/property Get properties keys #
DELETE /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/property/{propertyKey} Delete property #
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/property/{propertyKey} Get property #
PUT /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/property/{propertyKey} Set property #
GET /rest/servicedeskapi/servicedesk/{serviceDeskId}/requesttypegroup Get request type groups #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/atlassian-jira-service-management-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

atlassian-jira-service-management-openapi.json Raw ↑
{"components":{"parameters":{"x-b3-parentspanid":{"description":"B3 parent span ID for distributed tracing. Used internally by jsd-nutmeg for request correlation.","explode":false,"in":"header","name":"x-b3-parentspanid","required":false,"schema":{"type":"string"},"style":"simple"},"x-b3-sampled":{"description":"B3 sampling decision for distributed tracing (0 or 1). Used internally by jsd-nutmeg.","explode":false,"in":"header","name":"x-b3-sampled","required":false,"schema":{"enum":["0","1"],"type":"string"},"style":"simple"},"x-b3-spanid":{"description":"B3 span ID for distributed tracing. Used internally by jsd-nutmeg for request correlation.","explode":false,"in":"header","name":"x-b3-spanid","required":false,"schema":{"type":"string"},"style":"simple"},"x-b3-traceid":{"description":"B3 trace ID for distributed tracing. Used internally by jsd-nutmeg for request correlation.","explode":false,"in":"header","name":"x-b3-traceid","required":false,"schema":{"type":"string"},"style":"simple"}},"schemas":{"AdditionalCommentDTO":{"additionalProperties":false,"properties":{"body":{"description":"Content of the comment.","type":"string"}},"type":"object"},"ApprovalDTO":{"additionalProperties":false,"properties":{"_links":{"allOf":[{"$ref":"#/components/schemas/SelfLinkDTO"}],"description":"The REST API URL of the approval."},"approvers":{"description":"Detailed list of the users who must provide a response to the approval.","items":{"$ref":"#/components/schemas/ApproverDTO"},"type":"array"},"canAnswerApproval":{"description":"Indicates whether the user making the request is one of the approvers and can respond to the approval (true) or not (false).","type":"boolean"},"completedDate":{"allOf":[{"$ref":"#/components/schemas/DateDTO"}],"description":"Date the approval was completed."},"createdDate":{"allOf":[{"$ref":"#/components/schemas/DateDTO"}],"description":"Date the approval was created."},"finalDecision":{"description":"Outcome of the approval, based on the approvals provided by all approvers.","enum":["approved","declined","pending"],"type":"string"},"id":{"description":"ID of the approval.","type":"string"},"name":{"description":"Description of the approval being sought or provided.","type":"string"}},"type":"object"},"ApprovalDecisionRequestDTO":{"additionalProperties":false,"properties":{"decision":{"description":"Response to the approval request.","enum":["approve","decline"],"type":"string"}},"type":"object"},"ApproverDTO":{"additionalProperties":false,"properties":{"approver":{"allOf":[{"$ref":"#/components/schemas/UserDTO"}],"description":"Details of the User who is providing approval."},"approverDecision":{"description":"Decision made by the approver.","enum":["approved","declined","pending"],"type":"string"}},"type":"object"},"ArticleDTO":{"additionalProperties":false,"properties":{"content":{"$ref":"#/components/schemas/ContentDTO"},"excerpt":{"description":"Excerpt of the article which matches the given query string.","type":"string"},"source":{"allOf":[{"$ref":"#/components/schemas/SourceDTO"}],"description":"Source of the article."},"title":{"description":"Title of the article.","type":"string"}},"type":"object"},"AssetsWorkspaceDTO":{"additionalProperties":false,"description":"Details of an Assets workspace ID.","properties":{"workspaceId":{"description":"The workspace ID used as the identifier to access the Assets REST API.","type":"string"}},"type":"object"},"AttachmentCreateDTO":{"additionalProperties":false,"properties":{"additionalComment":{"allOf":[{"$ref":"#/components/schemas/AdditionalCommentDTO"}],"description":"Additional content of the comment"},"public":{"description":"Controls whether the comment and its attachments are visible to customers","type":"boolean"},"temporaryAttachmentIds":{"description":"List of IDs for the temporary attachments to be added to the customer request.","items":{"type":"string"},"type":"array"}},"type":"object"},"AttachmentCreateResultDTO":{"additionalProperties":false,"properties":{"attachments":{"allOf":[{"$ref":"#/components/schemas/PagedDTOAttachmentDTO"}],"description":"List of the attachments added."},"comment":{"allOf":[{"$ref":"#/components/schemas/CommentDTO"}],"description":"Details of the comment included with the attachments."}},"type":"object"},"AttachmentDTO":{"additionalProperties":false,"properties":{"_links":{"allOf":[{"$ref":"#/components/schemas/AttachmentLinkDTO"}],"description":"Various URLs for the attachment."},"author":{"allOf":[{"$ref":"#/components/schemas/UserDTO"}],"description":"Details of the user who attached the file."},"created":{"allOf":[{"$ref":"#/components/schemas/DateDTO"}],"description":"Date the attachment was added."},"filename":{"description":"Filename of the item attached.","type":"string"},"mimeType":{"description":"MIME type of the attachment.","type":"string"},"size":{"description":"Size of the attachment in bytes.","format":"int64","type":"integer"}},"type":"object"},"AttachmentLinkDTO":{"additionalProperties":false,"properties":{"content":{"description":"URL for the attachment.","format":"uri","type":"string"},"jiraRest":{"description":"REST API URL for the attachment","format":"uri","type":"string"},"self":{"format":"uri","type":"string"},"thumbnail":{"description":"URL for the attachment's thumbnail image.","format":"uri","type":"string"}},"type":"object"},"AvatarUrlsBean":{"additionalProperties":false,"properties":{"16x16":{"description":"The URL of the item's 16x16 pixel avatar.","format":"uri","type":"string"},"24x24":{"description":"The URL of the item's 24x24 pixel avatar.","format":"uri","type":"string"},"32x32":{"description":"The URL of the item's 32x32 pixel avatar.","format":"uri","type":"string"},"48x48":{"description":"The URL of the item's 48x48 pixel avatar.","format":"uri","type":"string"}},"type":"object"},"CSATFeedbackFullDTO":{"additionalProperties":false,"properties":{"comment":{"allOf":[{"$ref":"#/components/schemas/AdditionalCommentDTO"}],"description":"(Optional) The comment provided with this feedback."},"rating":{"description":"A numeric representation of the rating, this must be an integer value between 1 and 5.","format":"int32","type":"integer"},"type":{"description":"Indicates the type of feedback, supported values: `csat`.","type":"string"}},"type":"object"},"ChangeDetails":{"additionalProperties":false,"description":"A change item.","properties":{"field":{"description":"The name of the field changed.","readOnly":true,"type":"string"},"fieldId":{"description":"The ID of the field changed.","readOnly":true,"type":"string"},"fieldtype":{"description":"The type of the field changed.","readOnly":true,"type":"string"},"from":{"description":"The details of the original value.","readOnly":true,"type":"string"},"fromString":{"description":"The details of the original value as a string.","readOnly":true,"type":"string"},"to":{"description":"The details of the new value.","readOnly":true,"type":"string"},"toString":{"description":"The details of the new value as a string.","readOnly":true,"type":"string"}},"type":"object"},"Changelog":{"additionalProperties":false,"description":"A log of changes made to issue fields. Changelogs related to workflow associations are currently being deprecated.","properties":{"author":{"allOf":[{"$ref":"#/components/schemas/UserDetails"}],"description":"The user who made the change.","readOnly":true},"created":{"description":"The date on which the change took place.","format":"date-time","readOnly":true,"type":"string"},"historyMetadata":{"allOf":[{"$ref":"#/components/schemas/HistoryMetadata"}],"description":"The history metadata associated with the changed.","readOnly":true},"id":{"description":"The ID of the changelog.","readOnly":true,"type":"string"},"items":{"description":"The list of items changed.","items":{"$ref":"#/components/schemas/ChangeDetails"},"readOnly":true,"type":"array"}},"type":"object"},"CommentCreateDTO":{"additionalProperties":false,"properties":{"body":{"description":"Content of the comment.","type":"string"},"public":{"description":"Indicates whether the comment is public (true) or private/internal (false).","type":"boolean"}},"type":"object"},"CommentDTO":{"additionalProperties":false,"properties":{"_expands":{"description":"List of items that can be expanded in the response by specifying the expand query parameter.","items":{"type":"string"},"type":"array"},"_links":{"allOf":[{"$ref":"#/components/schemas/SelfLinkDTO"}],"description":"REST API URL link to the comment."},"attachments":{"allOf":[{"$ref":"#/components/schemas/PagedDTOAttachmentDTO"}],"description":"List of the attachments included in the comment."},"author":{"allOf":[{"$ref":"#/components/schemas/UserDTO"}],"description":"Details of the customer who authored the comment."},"body":{"description":"Content of the comment.","type":"string"},"created":{"allOf":[{"$ref":"#/components/schemas/DateDTO"}],"description":"Date the comment was created."},"id":{"description":"ID of the comment.","type":"string"},"public":{"description":"Indicates whether the comment is public (true) or private/internal (false).","type":"boolean"},"renderedBody":{"allOf":[{"$ref":"#/components/schemas/RenderedValueDTO"}],"description":"The rendered body of the comment."}},"type":"object"},"ContentDTO":{"additionalProperties":false,"properties":{"iframeSrc":{"description":"Url containing the body of the article (without title), suitable for rendering in an iframe","type":"string"}},"type":"object"},"CustomerCreateDTO":{"additionalProperties":false,"properties":{"displayName":{"description":"Customer's name for display in the UI.","type":"string"},"email":{"description":"Customer's email address.","type":"string"},"fullName":{"description":"Deprecated, please use 'displayName'.","type":"string"}},"type":"object"},"CustomerRequestActionDTO":{"additionalProperties":false,"properties":{"allowed":{"description":"Indicates whether the user can undertake the action (true) or not (false).","type":"boolean"}},"type":"object"},"CustomerRequestActionsDTO":{"additionalProperties":false,"properties":{"addAttachment":{"allOf":[{"$ref":"#/components/schemas/CustomerRequestActionDTO"}],"description":"Action of adding attachments to a request."},"addComment":{"allOf":[{"$ref":"#/components/schemas/CustomerRequestActionDTO"}],"description":"Action of adding comments to a request."},"addParticipant":{"allOf":[{"$ref":"#/components/schemas/CustomerRequestActionDTO"}],"description":"Action of adding participants to a request."},"removeParticipant":{"allOf":[{"$ref":"#/components/schemas/CustomerRequestActionDTO"}],"description":"Action of removing participants from a request."}},"type":"object"},"CustomerRequestCreateMetaDTO":{"additionalProperties":false,"properties":{"canAddRequestParticipants":{"description":"Flag indicating if participants can be added to a request (true) or not.","type":"boolean"},"canRaiseOnBehalfOf":{"description":"Flag indicating if a request can be raised on behalf of another user (true) or not.","type":"boolean"},"requestTypeFields":{"description":"List of the fields included in this request.","items":{"$ref":"#/components/schemas/RequestTypeFieldDTO"},"type":"array"}},"type":"object"},"CustomerRequestDTO":{"additionalProperties":false,"properties":{"_expands":{"description":"List of items that can be expanded in the response by specifying the expand query parameter.","items":{"type":"string"},"type":"array"},"_links":{"allOf":[{"$ref":"#/components/schemas/CustomerRequestLinkDTO"}],"description":"List of links associated with the request."},"actions":{"allOf":[{"$ref":"#/components/schemas/CustomerRequestActionsDTO"}],"description":"List of actions that the user can take on the request."},"attachments":{"allOf":[{"$ref":"#/components/schemas/PagedDTOAttachmentDTO"}],"description":"List of attachments included with the request."},"comments":{"allOf":[{"$ref":"#/components/schemas/PagedDTOCommentDTO"}],"description":"List of comments included with the request."},"createdDate":{"allOf":[{"$ref":"#/components/schemas/DateDTO"}],"description":"Date on which the request was created."},"currentStatus":{"allOf":[{"$ref":"#/components/schemas/CustomerRequestStatusDTO"}],"description":"Status of the request."},"issueId":{"description":"ID of the request, as the peer issue ID.","type":"string"},"issueKey":{"description":"Key of the request, as the peer issue key.","type":"string"},"participants":{"allOf":[{"$ref":"#/components/schemas/PagedDTOUserDTO"}],"description":"Expandable details of the customers participating in the request."},"reporter":{"allOf":[{"$ref":"#/components/schemas/UserDTO"}],"description":"Details of the customer reporting the request."},"requestFieldValues":{"description":"JSON map of Jira field IDs and their values representing the content of the request. This list does not include hidden fields.","items":{"$ref":"#/components/schemas/CustomerRequestFieldValueDTO"},"type":"array"},"requestType":{"allOf":[{"$ref":"#/components/schemas/RequestTypeDTO"}],"description":"Expandable details of the request type."},"requestTypeId":{"description":"ID of the request type for the request.","type":"string"},"serviceDesk":{"allOf":[{"$ref":"#/components/schemas/ServiceDeskDTO"}],"description":"Expandable details of the service desk."},"serviceDeskId":{"description":"ID of the service desk the request belongs to.","type":"string"},"sla":{"allOf":[{"$ref":"#/components/schemas/PagedDTOSlaInformationDTO"}],"description":"Expandable details of the SLAs relating to the request."},"status":{"allOf":[{"$ref":"#/components/schemas/PagedDTOCustomerRequestStatusDTO"}],"description":"Expandable details of the request's status history."},"summary":{"description":"Summary of the request created","type":"string"}},"type":"object"},"CustomerRequestFieldValueDTO":{"additionalProperties":false,"properties":{"fieldId":{"description":"ID of the field.","type":"string"},"label":{"description":"Text label for the field.","type":"string"},"renderedValue":{"description":"Value of the field rendered in the UI.","type":"object"},"value":{"description":"Value of the field."}},"type":"object"},"CustomerRequestLinkDTO":{"additionalProperties":false,"properties":{"agent":{"description":"Jira agent view URL for the request.","format":"uri","type":"string"},"jiraRest":{"description":"REST API URL for the request.","format":"uri","type":"string"},"self":{"format":"uri","type":"string"},"web":{"description":"Web URL for the request.","format":"uri","type":"string"}},"type":"object"},"CustomerRequestStatusDTO":{"additionalProperties":false,"properties":{"status":{"description":"Name of the status condition.","type":"string"},"statusCategory":{"description":"Status category the status belongs to.","enum":["UNDEFINED","NEW","INDETERMINATE","DONE"],"type":"string"},"statusDate":{"allOf":[{"$ref":"#/components/schemas/DateDTO"}],"description":"Date on which the status was attained."}},"type":"object"},"CustomerTransitionDTO":{"additionalProperties":false,"properties":{"id":{"description":"ID of the transition.","type":"string"},"name":{"description":"Name of the transition.","type":"string"}},"type":"object"},"CustomerTransitionExecutionDTO":{"additionalProperties":false,"properties":{"additionalComment":{"allOf":[{"$ref":"#/components/schemas/AdditionalCommentDTO"}],"description":"Comment explaining the reason for the transition."},"id":{"description":"ID of the transition to be performed.","type":"string"}},"type":"object"},"DateDTO":{"additionalProperties":false,"properties":{"epochMillis":{"description":"Date as the number of milliseconds that have elapsed since 00:00:00 Coordinated Universal Time (UTC), 1 January 1970.","format":"int64","type":"integer"},"friendly":{"description":"Date in a user-friendly text format.","type":"string"},"iso8601":{"description":"Date in ISO8601 format.","type":"string"},"jira":{"description":"Date in the format used in the Jira REST APIs, which is ISO8601 format but extended with milliseconds. For example, 2016-09-28T23:08:32.097+1000.","type":"string"}},"type":"object"},"DurationDTO":{"additionalProperties":false,"properties":{"friendly":{"description":"Duration in a user-friendly text format.","type":"string"},"millis":{"description":"Duration in milliseconds.","format":"int64","type":"integer"}},"type":"object"},"EntityProperty":{"additionalProperties":false,"description":"An entity property, for more information see [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).","properties":{"key":{"description":"The key of the property. Required on create and update.","type":"string"},"value":{"description":"The value of the property. Required on create and update."}},"type":"object"},"ErrorResponse":{"additionalProperties":false,"properties":{"errorMessage":{"type":"string"},"i18nErrorMessage":{"$ref":"#/components/schemas/I18nErrorMessage"}},"type":"object"},"Expandable":{"additionalProperties":false,"properties":{"_expands":{"items":{"type":"string"},"type":"array"}},"type":"object"},"FieldMetadata":{"additionalProperties":false,"description":"The metadata describing an issue field.","properties":{"allowedValues":{"description":"The list of values allowed in the field.","items":{"readOnly":true},"readOnly":true,"type":"array"},"autoCompleteUrl":{"description":"The URL that can be used to automatically complete the field.","readOnly":true,"type":"string"},"configuration":{"additionalProperties":{"readOnly":true},"description":"The configuration properties.","readOnly":true,"type":"object"},"defaultValue":{"description":"The default value of the field.","readOnly":true},"hasDefaultValue":{"description":"Whether the field has a default value.","readOnly":true,"type":"boolean"},"key":{"description":"The key of the field.","readOnly":true,"type":"string"},"name":{"description":"The name of the field.","readOnly":true,"type":"string"},"operations":{"description":"The list of operations that can be performed on the field.","items":{"readOnly":true,"type":"string"},"readOnly":true,"type":"array"},"required":{"description":"Whether the field is required.","readOnly":true,"type":"boolean"},"schema":{"allOf":[{"$ref":"#/components/schemas/JsonTypeBean"}],"description":"The data type of the field.","readOnly":true}},"required":["key","name","operations","required","schema"],"type":"object","xml":{"name":"availableField"}},"Form":{"additionalProperties":true,"properties":{"answers":{"additionalProperties":{"$ref":"#/components/schemas/FormAnswer"},"description":"JSON mapping of form field answers containing form field IDs and corresponding values.","type":"object"}},"type":"object"},"FormAnswer":{"additionalProperties":false,"properties":{"adf":{"allOf":[{"$ref":"#/components/schemas/JsonNode"}],"description":"Answer in Atlassian Document Format (ADF)"},"choices":{"description":"IDs of selected choices","items":{"type":"string"},"type":"array"},"date":{"description":"Answer in date format (yyyy-MM-dd)","type":"string"},"files":{"description":"The IDs of files to be attached to the form that are obtained by calling the ‘attach temporary file’ endpoint on the corresponding service desk.","items":{"type":"string"},"type":"array"},"text":{"description":"Answer in free text format","type":"string"},"time":{"description":"Answer in timestamp format (HH:mm)","type":"string"},"users":{"description":"IDs of selected users","items":{"type":"string"},"type":"array"}},"type":"object"},"FormValidationErrorContextDTO":{"additionalProperties":false,"properties":{"id":{"description":"ID of the form entity related to the validation error.","type":"string"},"type":{"description":"Type of form entity related to the validation error.","type":"string"}},"type":"object"},"FormValidationErrorDTO":{"additionalProperties":false,"properties":{"code":{"description":"Machine-readable validation error code.","type":"string"},"context":{"description":"Identifies the form entity that caused the validation error.","items":{"$ref":"#/components/schemas/FormValidationErrorContextDTO"},"type":"array"},"detail":{"description":"Detailed validation error message.","type":"string"},"status":{"description":"The HTTP status code.","format":"int32","type":"integer"},"title":{"description":"Short summary of the validation error.","type":"string"}},"type":"object"},"FormValidationErrorResponseDTO":{"additionalProperties":false,"properties":{"errorMessage":{"description":"Description of the error.","type":"string"},"errors":{"description":"A list of validation errors.","items":{"$ref":"#/components/schemas/FormValidationErrorDTO"},"type":"array"},"i18nErrorMessage":{"allOf":[{"$ref":"#/components/schemas/I18nErrorMessageDTO"}],"description":"Internationalized error message details."}},"type":"object"},"HistoryMetadata":{"additionalProperties":true,"description":"Details of issue history metadata.","properties":{"activityDescription":{"description":"The activity described in the history record.","type":"string"},"activityDescriptionKey":{"description":"The key of the activity described in the history record.","type":"string"},"actor":{"allOf":[{"$ref":"#/components/schemas/HistoryMetadataParticipant"}],"description":"Details of the user whose action created the history record."},"cause":{"allOf":[{"$ref":"#/components/schemas/HistoryMetadataParticipant"}],"description":"Details of the cause that triggered the creation the history record."},"description":{"description":"The description of the history record.","type":"string"},"descriptionKey":{"description":"The description key of the history record.","type":"string"},"emailDescription":{"description":"The description of the email address associated the history record.","type":"string"},"emailDescriptionKey":{"description":"The description key of the email address associated the history record.","type":"string"},"extraData":{"additionalProperties":{"type":"string"},"description":"Additional arbitrary information about the history record.","type":"object"},"generator":{"allOf":[{"$ref":"#/components/schemas/HistoryMetadataParticipant"}],"description":"Details of the system that generated the history record."},"type":{"description":"The type of the history record.","type":"string"}},"type":"object"},"HistoryMetadataParticipant":{"additionalProperties":true,"description":"Details of user or system associated with a issue history metadata item.","properties":{"avatarUrl":{"description":"The URL to an avatar for the user or system associated with a history record.","type":"string"},"displayName":{"description":"The display name of the user or system associated with a history record.","type":"string"},"displayNameKey":{"description":"The key of the display name of the user or system associated with a history record.","type":"string"},"id":{"description":"The ID of the user or system associated with a history record.","type":"string"},"type":{"description":"The type of the user or system associated with a history record.","type":"string"},"url":{"description":"The URL of the user or system associated with a history record.","type":"string"}},"type":"object"},"I18nErrorMessage":{"additionalProperties":false,"properties":{"i18nKey":{"type":"string"},"parameters":{"items":{"type":"string"},"type":"array"}},"type":"object"},"I18nErrorMessageDTO":{"additionalProperties":false,"properties":{"i18nKey":{"description":"Internationalization key for the error message.","type":"string"},"parameters":{"description":"Parameters used to render the internationalized error message.","items":{"type":"string"},"type":"array"}},"type":"object"},"IncludedFields":{"additionalProperties":false,"properties":{"actuallyIncluded":{"items":{"type":"string"},"type":"array","uniqueItems":true},"excluded":{"items":{"type":"string"},"type":"array","uniqueItems":true},"included":{"items":{"type":"string"},"type":"array","uniqueItems":true}},"type":"object"},"InputStreamSource":{"additionalProperties":false,"properties":{"inputStream":{"type":"object"}},"type":"object"},"InsightWorkspaceDTO":{"additionalProperties":false,"description":"Details of an insight workspace ID.","properties":{"workspaceId":{"description":"The workspace ID used as the identifier to access the Insight REST API.","type":"string"}},"type":"object"},"IssueBean":{"additionalProperties":false,"description":"Details about an issue.","properties":{"changelog":{"allOf":[{"$ref":"#/components/schemas/PageOfChangelogs"}],"description":"Details of changelogs associated with the issue.","readOnly":true},"editmeta":{"allOf":[{"$ref":"#/components/schemas/IssueUpdateMetadata"}],"description":"The metadata for the fields on the issue that can be amended.","readOnly":true},"expand":{"description":"Expand options that include additional issue details in the response.","readOnly":true,"type":"string","xml":{"attribute":true}},"fields":{"additionalProperties":{},"type":"object"},"fieldsToInclude":{"$ref":"#/components/schemas/IncludedFields"},"id":{"description":"The ID of the issue.","readOnly":true,"type":"string"},"key":{"description":"The key of the issue.","readOnly":true,"type":"string"},"names":{"additionalProperties":{"readOnly":true,"type":"string"},"description":"The ID and name of each field present on the issue.","readOnly":true,"type":"object"},"operations":{"allOf":[{"$ref":"#/components/schemas/Operations"}],"description":"The operations that can be performed on the issue.","readOnly":true},"properties":{"additionalProperties":{"readOnly":true},"description":"Details of the issue properties identified in the request.","readOnly":true,"type":"object"},"renderedFields":{"additionalProperties":{"readOnly":true},"description":"The rendered value of each field present on the issue.","readOnly":true,"type":"object"},"schema":{"additionalProperties":{"$ref":"#/components/schemas/JsonTypeBean"},"description":"The schema describing each field present on the issue.","readOnly":true,"type":"object"},"self":{"description":"The URL of the issue details.","format":"uri","readOnly":true,"type":"string"},"transitions":{"description":"The transitions that can be performed on the issue.","items":{"$ref":"#/components/schemas/IssueTransition"},"readOnly":true,"type":"array"},"versionedRepresentations":{"additionalProperties":{"additionalProperties":{"readOnly":true},"readOnly":true,"type":"object"},"description":"The versions of each field on the issue.","readOnly":true,"type":"object"}},"type":"object","xml":{"name":"issue"}},"IssueTransition":{"additionalProperties":true,"description":"Details of an issue transition.","properties":{"expand":{"description":"Expand options that include additional transition details in the response.","readOnly":true,"type":"string"},"fields":{"additionalProperties":{"$ref":"#/components/schemas/FieldMetadata"},"description":"Details of the fields associated with the issue transition screen. Use this information to populate `fields` and `update` in a transition request.","readOnly":true,"type":"object"},"hasScreen":{"description":"Whether there is a screen associated with the issue transition.","readOnly":true,"type":"boolean"},"id":{"description":"The ID of the issue transition. Required when specifying a transition to undertake.","type":"string"},"isAvailable":{"description":"Whether the transition is available to be performed.","readOnly":true,"type":"boolean"},"isConditional":{"description":"Whether the issue has to meet criteria before the issue transition is applied.","readOnly":true,"type":"boolean"},"isGlobal":{"description":"Whether the issue transition is global, that is, the transition is applied to issues regardless of their status.","readOnly":true,"type":"boolean"},"isInitial":{"description":"Whether this is the initial issue transition for the workflow.","readOnly":true,"type":"boolean"},"looped":{"type":"boolean"},"name":{"description":"The name of the issue transition.","readOnly":true,"type":"string"},"to":{"allOf":[{"$ref":"#/components/schemas/StatusDetails"}],"description":"Details of the issue status after the transition.","readOnly":true}},"type":"object"},"IssueUpdateMetadata":{"description":"A list of editable field details.","properties":{"fields":{"additionalProperties":{"$ref":"#/components/schemas/FieldMetadata"},"readOnly":true,"type":"object"}},"type":"object"},"JsonNode":{"additionalProperties":false,"properties":{"array":{"type":"boolean"},"bigDecimal":{"type":"boolean"},"bigInteger":{"type":"boolean"},"bigIntegerValue":{"type":"integer"},"binary":{"type":"boolean"},"binaryValue":{"items":{"format":"byte","type":"string"},"type":"array"},"boolean":{"type":"boolean"},"booleanValue":{"type":"boolean"},"containerNode":{"type":"boolean"},"decimalValue":{"type":"number"},"double":{"type":"boolean"},"doubleValue":{"format":"double","type":"number"},"elements":{"type":"object"},"fieldNames":{"type":"object"},"fields":{"type":"object"},"floatingPointNumber":{"type":"boolean"},"int":{"type":"boolean"},"intValue":{"format":"int32","type":"integer"},"integralNumber":{"type":"boolean"},"long":{"type":"boolean"},"longValue":{"format":"int64","type":"integer"},"missingNode":{"type":"boolean"},"null":{"type":"boolean"},"number":{"type":"boolean"},"numberType":{"enum":["INT","LONG","BIG_INTEGER","FLOAT","DOUBLE","BIG_DECIMAL"],"type":"string"},"numberValue":{"type":"number"},"object":{"type":"boolean"},"pojo":{"type":"boolean"},"textValue":{"type":"string"},"textual":{"type":"boolean"},"valueAsBoolean":{"type":"boolean"},"valueAsDouble":{"format":"double","type":"number"},"valueAsInt":{"format":"int32","type":"integer"},"valueAsLong":{"format":"int64","type":"integer"},"valueAsText":{"type":"string"},"valueNode":{"type":"boolean"}},"type":"object"},"JsonTypeBean":{"additionalProperties":false,"description":"The schema of a field.","properties":{"configuration":{"additionalProperties":{"readOnly":true},"description":"If the field is a custom field, the configuration of the field.","readOnly":true,"type":"object"},"custom":{"description":"If the field is a custom field, the URI of the field.","readOnly":true,"type":"string"},"customId":{"description":"If the field is a custom field, the custom ID of the field.","format":"int64","readOnly":true,"type":"integer"},"items":{"description":"When the data type is an array, the name of the field items within the array.","readOnly":true,"type":"string"},"system":{"description":"If the field is a system field, the name of the field.","readOnly":true,"type":"string"},"type":{"description":"The data type of the field.","readOnly":true,"type":"string"}},"required":["type"],"type":"object"},"LinkGroup":{"additionalProperties":false,"description":"Details a link group, which defines issue operations.","properties":{"groups":{"items":{"$ref":"#/components/schemas/LinkGroup"},"type":"array"},"header":{"$ref":"#/components/schemas/SimpleLink"},"id":{"type":"string"},"links":{"items":{"$ref":"#/components/schemas/SimpleLink"},"type":"array"},"styleClass":{"type":"string"},"weight":{"format":"int32","type":"integer"}},"type":"object"},"Linkable":{"additionalProperties":false,"properties":{"_links":{"$ref":"#/components/schemas/SelfLinkDTO"}},"type":"object"},"LinkableAttachmentLinkDTO":{"additionalProperties":false,"properties":{"_links":{"$ref":"#/components/schemas/AttachmentLinkDTO"}},"type":"object"},"LinkableCustomerRequestLinkDTO":{"additionalProperties":false,"properties":{"_links":{"$ref":"#/components/schemas/CustomerRequestLinkDTO"}},"type":"object"},"LinkableUserLinkDTO":{"additionalProperties":false,"properties":{"_links":{"$ref":"#/components/schemas/UserLinkDTO"}},"type":"object"},"MultipartFile":{"additionalProperties":false,"properties":{"bytes":{"items":{"format":"byte","type":"string"},"type":"array"},"contentType":{"type":"string"},"empty":{"type":"boolean"},"inputStream":{"type":"object"},"name":{"type":"string"},"originalFilename":{"type":"string"},"resource":{"$ref":"#/components/schemas/Resource"},"size":{"format":"int64","type":"integer"}},"type":"object"},"Operations":{"additionalProperties":true,"description":"Details of the operations that can be performed on the issue.","properties":{"linkGroups":{"description":"Details of the link groups defining issue operations.","items":{"$ref":"#/components/schemas/LinkGroup"},"readOnly":true,"type":"array"}},"type":"object"},"OrganizationCreateDTO":{"additionalProperties":false,"properties":{"name":{"description":"Name of the organization. Must contain 1-200 characters.","type":"string"}},"required":["name"],"type":"object"},"OrganizationDTO":{"additionalProperties":false,"properties":{"_links":{"allOf":[{"$ref":"#/components/schemas/SelfLinkDTO"}],"description":"REST API URL to the organization."},"created":{"allOf":[{"$ref

# --- truncated at 32 KB (361 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/atlassian-jira/refs/heads/main/openapi/atlassian-jira-service-management-openapi.json