Module jira.servicemanagement
ballerinax/jira.servicemanagement Ballerina library
2.0.0
Overview
Jira Service Management is Atlassian's IT service management platform. Teams use it to run service desks where customers raise requests through a help-center portal, and agents triage those requests through queues, SLAs and approvals.
The Jira Service Management connector lets Ballerina applications work with the Jira Service Management Cloud REST API. It can raise and track customer requests, manage service desks, request types, queues, customers and organizations, and search the knowledge base. It supports the servicedeskapi REST API of Jira Service Management Cloud.
Key features
- Raise customer requests, validate them before submission, and follow their status, SLAs and approvals
- Comment on requests, attach files, manage participants and move requests through their workflow
- Manage customers and organizations, and control which of them can use each service desk
- Browse service desks, queues and the issues waiting in them, and configure request types and their fields
- Search the knowledge base and store custom properties on organizations and request types
Setup guide
The connector authenticates to Jira Service Management Cloud with either an Atlassian API token (HTTP basic authentication) or an OAuth 2.0 access token. An API token is the quickest way to start.
Step 1: Get access to a Jira Service Management site
You need a Jira Service Management Cloud site, such as https://your-domain.atlassian.net, and an account on it. If you do not have one, start a free trial. Operations run with that account's permissions: most read and create operations need an agent or customer account on the service desk, while managing request types, customers and organizations needs a service desk administrator or agent.
Step 2: Create an API token
- Sign in to your Atlassian account and open API tokens.
- Select Create API token, give it a label, choose an expiry date, and select Create.
- Copy the token and store it securely. You cannot view it again after you close the dialog.
Use the email address of your Atlassian account as the username and the API token as the password.
Step 3 (optional): Use OAuth 2.0 instead
To act on behalf of other users, create an OAuth 2.0 (3LO) app in the Atlassian developer console:
- Select Create > OAuth 2.0 integration, and name the app.
- Under Permissions, add the Jira Service Management API and select the scopes your application needs, such as
read:servicedesk-requestandwrite:servicedesk-request. - Under Authorization, set a callback URL, then follow Atlassian's OAuth 2.0 (3LO) guide to obtain an access token and a refresh token. Add the
offline_accessscope to receive a refresh token. - Find your site's cloud ID from
https://your-domain.atlassian.net/_edge/tenant_info.
OAuth 2.0 requests go through the Atlassian API gateway, so the service URL is https://api.atlassian.com/ex/jira/<cloud-id> rather than your site URL.
Quickstart
To use the Jira Service Management connector in your Ballerina application, update the .bal file as follows:
Step 1: Import the module
Import the jira.servicemanagement module.
import ballerinax/jira.servicemanagement as jsm;
Step 2: Instantiate a new connector
-
Create a
Config.tomlfile and configure the obtained credentials and your site URL:serviceUrl = "https://your-domain.atlassian.net" email = "<your-atlassian-account-email>" apiToken = "<your-api-token>" -
Create a
jsm:Clientwith the credentials:configurable string serviceUrl = ?; configurable string email = ?; configurable string apiToken = ?; final jsm:Client jira = check new ({auth: {username: email, password: apiToken}}, serviceUrl);To use OAuth 2.0 instead, pass
auth: {token: "<access-token>"}and setserviceUrltohttps://api.atlassian.com/ex/jira/<cloud-id>.
Step 3: Invoke the connector operation
Now, use the connector to call Jira Service Management. The following lists the service desks the account can see:
public function main() returns error? { jsm:PagedDTOServiceDeskDTO _ = check jira->getServiceDesks(); }
Step 4: Run the Ballerina application
bal run
Examples
The Jira Service Management connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:
-
Service request intake - Find a request type by name, check its fields, raise a customer request and attach a supporting file to it.
-
Customer organization onboarding - Create an organization for a new client company, give it access to a service desk, create its first customer and add them to the organization.
Clients
jira.servicemanagement: Client
Isolated
Public REST API for Jira Service Management
Constructor
Gets invoked to initialize the connector.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://your-domain.atlassian.net" - URL of the target service
getAssetsWorkspaces
Isolated FunctionRemote Function
function getAssetsWorkspaces(map<string|string[]> headers, *GetAssetsWorkspacesQueries queries) returns PagedDTOAssetsWorkspaceDTO|errorGet assets workspaces
Parameters
- queries *GetAssetsWorkspacesQueries - Queries to be sent with the request
Return Type
- PagedDTOAssetsWorkspaceDTO|error - Returned if the request is successful
createCustomer
Isolated FunctionRemote Function
function createCustomer(CustomerCreateDTO payload, map<string|string[]> headers, *CreateCustomerQueries queries) returns UserDTO|errorCreate customer
Parameters
- payload CustomerCreateDTO - Email address and display name of the customer to create
- queries *CreateCustomerQueries - Queries to be sent with the request
createCustomerSkipPermissionCheck
Isolated FunctionRemote Function
function createCustomerSkipPermissionCheck(CustomerCreateDTO payload, map<string|string[]> headers, *CreateCustomerSkipPermissionCheckQueries queries) returns UserDTO|errorCreate customer without permission check
Parameters
- payload CustomerCreateDTO - JSON body containing the email address and display name of the customer to create
- queries *CreateCustomerSkipPermissionCheckQueries - Queries to be sent with the request
revokePortalOnlyAccessForUser
Isolated FunctionRemote Function
function revokePortalOnlyAccessForUser(string accountId, map<string|string[]> headers) returns error?Revoke portal only access for user
Parameters
- accountId string - The account ID of the user, which uniquely identifies the portal-only account. For example, qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b
Return Type
- error? - Returned if the request is successful
getInfo
Isolated FunctionRemote Function
function getInfo(map<string|string[]> headers) returns SoftwareInfoDTO|errorGet Jira Service Management instance info
Return Type
- SoftwareInfoDTO|error - Returns the runtime information for the Jira Service Management instance
getInsightWorkspaces
Isolated FunctionRemote Function
function getInsightWorkspaces(map<string|string[]> headers, *GetInsightWorkspacesQueries queries) returns PagedDTOInsightWorkspaceDTO|errorGet insight workspaces
Parameters
- queries *GetInsightWorkspacesQueries - Queries to be sent with the request
Return Type
- PagedDTOInsightWorkspaceDTO|error - Returns a page of Insight workspace IDs
getArticles
Isolated FunctionRemote Function
function getArticles(map<string|string[]> headers, *GetArticlesQueries queries) returns PagedDTOArticleDTO|errorGet articles
Parameters
- queries *GetArticlesQueries - Queries to be sent with the request
Return Type
- PagedDTOArticleDTO|error - Returns the articles, on the specified page of the results
viewArticle
Isolated FunctionRemote Function
View knowledge base article
Parameters
- pageId int - The ID of the knowledge base article page
getOrganizations
Isolated FunctionRemote Function
function getOrganizations(map<string|string[]> headers, *GetOrganizationsQueries queries) returns PagedDTOOrganizationDTO|errorGet organizations
Parameters
- queries *GetOrganizationsQueries - Queries to be sent with the request
Return Type
- PagedDTOOrganizationDTO|error - Returns paginated list of organizations
createOrganization
Isolated FunctionRemote Function
function createOrganization(OrganizationCreateDTO payload, map<string|string[]> headers) returns OrganizationDTO|errorCreate organization
Parameters
- payload OrganizationCreateDTO - Name of the organization to create
Return Type
- OrganizationDTO|error - Returns the created organization or the existing organization if name already exists
getOrganization
Isolated FunctionRemote Function
function getOrganization(Signed32 organizationId, map<string|string[]> headers) returns OrganizationDTO|errorGet organization
Parameters
- organizationId Signed32 - The ID of the organization
Return Type
- OrganizationDTO|error - Returns the requested organization
deleteOrganization
Isolated FunctionRemote Function
Delete organization
Parameters
- organizationId Signed32 - The ID of the organization
Return Type
- error? - Returned if the organization was deleted
getPropertiesKeys
Isolated FunctionRemote Function
function getPropertiesKeys(string organizationId, map<string|string[]> headers) returns PropertyKeys|errorGet organization property keys
Parameters
- organizationId string - The ID of the organization from which keys will be returned
Return Type
- PropertyKeys|error - Returned if the organization was found
getProperty
Isolated FunctionRemote Function
function getProperty(string organizationId, string propertyKey, map<string|string[]> headers) returns EntityProperty|errorGet organization property
Parameters
- organizationId string - The ID of the organization from which the property will be returned
- propertyKey string - The key of the property to return
Return Type
- EntityProperty|error - Returns the organization's property
setProperty
Isolated FunctionRemote Function
function setProperty(string organizationId, string propertyKey, json payload, map<string|string[]> headers) returns json|errorSet organization property
Parameters
- organizationId string - The ID of the organization on which the property will be set
- propertyKey string - The key of the organization's property. The maximum length of the key is 255 bytes
- payload json - The value of the property. The value has to be a valid, non-empty JSON value. The maximum length of the property value is 32768 bytes
Return Type
- json|error - Returned if the organization property was updated
deleteProperty
Isolated FunctionRemote Function
function deleteProperty(string organizationId, string propertyKey, map<string|string[]> headers) returns error?Delete organization property
Parameters
- organizationId string - The ID of the organization from which the property will be removed
- propertyKey string - The key of the property to remove
Return Type
- error? - Returned if the organization property was removed
getUsersInOrganization
Isolated FunctionRemote Function
function getUsersInOrganization(Signed32 organizationId, map<string|string[]> headers, *GetUsersInOrganizationQueries queries) returns PagedDTOUserDTO|errorGet users in organization
Parameters
- organizationId Signed32 - The ID of the organization
- queries *GetUsersInOrganizationQueries - Queries to be sent with the request
Return Type
- PagedDTOUserDTO|error - Returns a paged list of users associated with the organization, ordered by their accountId
addUsersToOrganization
Isolated FunctionRemote Function
function addUsersToOrganization(Signed32 organizationId, UsersOrganizationUpdateDTO payload, map<string|string[]> headers) returns error?Add users to organization
Parameters
- organizationId Signed32 - The ID of the organization
- payload UsersOrganizationUpdateDTO - Account IDs of the users to add to the organization
Return Type
- error? - Returned if all the users were valid and added to the organization, no response payload is provided
removeUsersFromOrganization
Isolated FunctionRemote Function
function removeUsersFromOrganization(Signed32 organizationId, UsersOrganizationUpdateDTO payload, map<string|string[]> headers) returns error?Remove users from organization
Parameters
- organizationId Signed32 - The ID of the organization
- payload UsersOrganizationUpdateDTO - Account IDs of the users to remove from the organization
Return Type
- error? - The request completed successfully. No additional content will be sent in the response
getCustomerRequests
Isolated FunctionRemote Function
function getCustomerRequests(map<string|string[]> headers, *GetCustomerRequestsQueries queries) returns PagedDTOCustomerRequestDTO|errorGet customer requests
Parameters
- queries *GetCustomerRequestsQueries - Queries to be sent with the request
Return Type
- PagedDTOCustomerRequestDTO|error - Returns the customer requests, on the specified page of the results
createCustomerRequest
Isolated FunctionRemote Function
function createCustomerRequest(RequestCreateDTO payload, map<string|string[]> headers) returns CustomerRequestDTO|errorCreate customer request
Parameters
- payload RequestCreateDTO - Service desk, request type and field values of the customer request to create
Return Type
- CustomerRequestDTO|error - Returned if the customer request was created
validateCustomerRequest
Isolated FunctionRemote Function
function validateCustomerRequest(RequestCreateDTO payload, map<string|string[]> headers) returns RequestValidationResultDTO|errorValidate customer request
Parameters
- payload RequestCreateDTO - Service desk, request type and field values of the customer request to validate
Return Type
- RequestValidationResultDTO|error - Returned with the validation result. {@code valid} is true when the payload is valid
getCustomerRequestByIdOrKey
Isolated FunctionRemote Function
function getCustomerRequestByIdOrKey(string issueIdOrKey, map<string|string[]> headers, *GetCustomerRequestByIdOrKeyQueries queries) returns CustomerRequestDTO|errorGet customer request by id or key
Parameters
- issueIdOrKey string - The ID or Key of the customer request to be returned
- queries *GetCustomerRequestByIdOrKeyQueries - Queries to be sent with the request
Return Type
- CustomerRequestDTO|error - Returns the customer request
getApprovals
Isolated FunctionRemote Function
function getApprovals(string issueIdOrKey, map<string|string[]> headers, *GetApprovalsQueries queries) returns PagedDTOApprovalDTO|errorGet approvals
Parameters
- issueIdOrKey string - The ID or key of the customer request to be queried for its approvals
- queries *GetApprovalsQueries - Queries to be sent with the request
Return Type
- PagedDTOApprovalDTO|error - Returns the customer request's approvals
getApprovalById
Isolated FunctionRemote Function
function getApprovalById(string issueIdOrKey, Signed32 approvalId, map<string|string[]> headers) returns ApprovalDTO|errorGet approval by id
Parameters
- issueIdOrKey string - The ID or key of the customer request the approval is on
- approvalId Signed32 - The ID of the approval to be returned
Return Type
- ApprovalDTO|error - Returns the requested approval
answerApproval
Isolated FunctionRemote Function
function answerApproval(string issueIdOrKey, Signed32 approvalId, ApprovalDecisionRequestDTO payload, map<string|string[]> headers) returns ApprovalDTO|errorAnswer approval
Parameters
- issueIdOrKey string - The ID or key of the customer request to be updated
- approvalId Signed32 - The ID of the approval to be updated
- payload ApprovalDecisionRequestDTO - Approve or decline decision to record on the approval
Return Type
- ApprovalDTO|error - Returns the updated approval
getAttachmentsForRequest
Isolated FunctionRemote Function
function getAttachmentsForRequest(string issueIdOrKey, map<string|string[]> headers, *GetAttachmentsForRequestQueries queries) returns PagedDTOAttachmentDTO|errorGet attachments for request
Parameters
- issueIdOrKey string - The ID or key of the customer request from which the attachments will be listed
- queries *GetAttachmentsForRequestQueries - Queries to be sent with the request
Return Type
- PagedDTOAttachmentDTO|error - Returns the visible attachments from the customer request
createAttachment
Isolated FunctionRemote Function
function createAttachment(string issueIdOrKey, AttachmentCreateDTO payload, map<string|string[]> headers) returns AttachmentCreateResultDTO|errorCreate comment with attachment
Parameters
- issueIdOrKey string - The ID or key of the customer request to which the attachment will be added
- payload AttachmentCreateDTO - Temporary attachment IDs to attach, their visibility and an optional comment
Return Type
- AttachmentCreateResultDTO|error - Returns the attachments and comment
getAttachmentContent
Isolated FunctionRemote Function
function getAttachmentContent(string issueIdOrKey, int attachmentId, map<string|string[]> headers) returns byte[]|error?Get attachment content
Parameters
- issueIdOrKey string - The ID or key for the customer request the attachment is associated with
- attachmentId int - The ID for the attachment
Return Type
- byte[]|error? - The attachment content
getAttachmentThumbnail
Isolated FunctionRemote Function
function getAttachmentThumbnail(string issueIdOrKey, int attachmentId, map<string|string[]> headers) returns byte[]|error?Get attachment thumbnail
Parameters
- issueIdOrKey string - The ID or key for the customer request the attachment is associated with
- attachmentId int - The ID of the attachment
Return Type
- byte[]|error? - The attachment thumbnail image
getRequestComments
Isolated FunctionRemote Function
function getRequestComments(string issueIdOrKey, map<string|string[]> headers, *GetRequestCommentsQueries queries) returns PagedDTOCommentDTO|errorGet request comments
Parameters
- issueIdOrKey string - The ID or key of the customer request whose comments will be retrieved
- queries *GetRequestCommentsQueries - Queries to be sent with the request
Return Type
- PagedDTOCommentDTO|error - Returns the comments, on the specified page of the results
createRequestComment
Isolated FunctionRemote Function
function createRequestComment(string issueIdOrKey, CommentCreateDTO payload, map<string|string[]> headers) returns CommentDTO|errorCreate request comment
Parameters
- issueIdOrKey string - The ID or key of the customer request to which the comment will be added
- payload CommentCreateDTO - Body and visibility of the comment to add to the request
Return Type
- CommentDTO|error - Returns the comment
getRequestCommentById
Isolated FunctionRemote Function
function getRequestCommentById(string issueIdOrKey, int commentId, map<string|string[]> headers, *GetRequestCommentByIdQueries queries) returns CommentDTO|errorGet request comment by id
Parameters
- issueIdOrKey string - The ID or key of the customer request that contains the comment
- commentId int - The ID of the comment to retrieve
- queries *GetRequestCommentByIdQueries - Queries to be sent with the request
Return Type
- CommentDTO|error - Returns the comment
getCommentAttachments
Isolated FunctionRemote Function
function getCommentAttachments(string issueIdOrKey, int commentId, map<string|string[]> headers, *GetCommentAttachmentsQueries queries) returns PagedDTOAttachmentDTO|errorGet comment attachments
Parameters
- issueIdOrKey string - The ID or key of the customer request that contains the comment
- commentId int - The ID of the comment
- queries *GetCommentAttachmentsQueries - Queries to be sent with the request
Return Type
- PagedDTOAttachmentDTO|error - Returns the attachments, on the specified page of the results
getSubscriptionStatus
Isolated FunctionRemote Function
function getSubscriptionStatus(string issueIdOrKey, map<string|string[]> headers) returns RequestNotificationSubscriptionDTO|errorGet subscription status
Parameters
- issueIdOrKey string - The ID or key of the customer request to be queried for subscription status
Return Type
- RequestNotificationSubscriptionDTO|error - Returns the status of the notification subscription
subscribe
Isolated FunctionRemote Function
Subscribe to request notifications
Parameters
- issueIdOrKey string - The ID or key of the customer request to be subscribed to
Return Type
- error? - Returns if the user was subscribed
unsubscribe
Isolated FunctionRemote Function
Unsubscribe
Parameters
- issueIdOrKey string - The ID or key of the customer request to be unsubscribed from
Return Type
- error? - Returns if the user was unsubscribed
getRequestParticipants
Isolated FunctionRemote Function
function getRequestParticipants(string issueIdOrKey, map<string|string[]> headers, *GetRequestParticipantsQueries queries) returns PagedDTOUserDTO|errorGet request participants
Parameters
- issueIdOrKey string - The ID or key of the customer request to be queried for its participants
- queries *GetRequestParticipantsQueries - Queries to be sent with the request
Return Type
- PagedDTOUserDTO|error - Returns the customer request's participants, on the specified page of the results
addRequestParticipants
Isolated FunctionRemote Function
function addRequestParticipants(string issueIdOrKey, RequestParticipantUpdateDTO payload, map<string|string[]> headers) returns PagedDTOUserDTO|errorAdd request participants
Parameters
- issueIdOrKey string - The ID or key of the customer request to have participants added
- payload RequestParticipantUpdateDTO - Account IDs of the users to add as request participants
Return Type
- PagedDTOUserDTO|error - Returns the participants added to the customer request
removeRequestParticipants
Isolated FunctionRemote Function
function removeRequestParticipants(string issueIdOrKey, RequestParticipantUpdateDTO payload, map<string|string[]> headers) returns PagedDTOUserDTO|errorRemove request participants
Parameters
- issueIdOrKey string - The ID or key of the customer request to have participants removed
- payload RequestParticipantUpdateDTO - Account IDs of the users to remove as request participants
Return Type
- PagedDTOUserDTO|error - Returns the first page of the customer request's participants (after removal of the users)
getSlaInformation
Isolated FunctionRemote Function
function getSlaInformation(string issueIdOrKey, map<string|string[]> headers, *GetSlaInformationQueries queries) returns PagedDTOSlaInformationDTO|errorGet sla information
Parameters
- issueIdOrKey string - The ID or key of the customer request whose SLAs will be retrieved
- queries *GetSlaInformationQueries - Queries to be sent with the request
Return Type
- PagedDTOSlaInformationDTO|error - Returns the SLA records on the customer request, on the specified page of the results
getSlaInformationById
Isolated FunctionRemote Function
function getSlaInformationById(string issueIdOrKey, int slaMetricId, map<string|string[]> headers) returns SlaInformationDTO|errorGet sla information by id
Parameters
- issueIdOrKey string - The ID or key of the customer request whose SLAs will be retrieved
- slaMetricId int - The ID or key of the SLAs metric to be retrieved
Return Type
- SlaInformationDTO|error - Returns the SLA record, on the specified page of the results
getCustomerRequestStatus
Isolated FunctionRemote Function
function getCustomerRequestStatus(string issueIdOrKey, map<string|string[]> headers, *GetCustomerRequestStatusQueries queries) returns PagedDTOCustomerRequestStatusDTO|errorGet customer request status
Parameters
- issueIdOrKey string - The ID or key of the customer request to be retrieved
- queries *GetCustomerRequestStatusQueries - Queries to be sent with the request
Return Type
- PagedDTOCustomerRequestStatusDTO|error - Returns the customer request's status history, on the specified page of the results
getCustomerTransitions
Isolated FunctionRemote Function
function getCustomerTransitions(string issueIdOrKey, map<string|string[]> headers, *GetCustomerTransitionsQueries queries) returns PagedDTOCustomerTransitionDTO|errorGet customer transitions
Parameters
- issueIdOrKey string - The ID or key of the customer request whose transitions will be retrieved
- queries *GetCustomerTransitionsQueries - Queries to be sent with the request
Return Type
- PagedDTOCustomerTransitionDTO|error - Returns the transitions available to the user on the customer request
performCustomerTransition
Isolated FunctionRemote Function
function performCustomerTransition(string issueIdOrKey, CustomerTransitionExecutionDTO payload, map<string|string[]> headers) returns error?Perform customer transition
Parameters
- issueIdOrKey string - ID or key of the issue to transition
- payload CustomerTransitionExecutionDTO - ID of the transition to perform and an optional comment
Return Type
- error? - Returned if the request is transitioned
getFeedback
Isolated FunctionRemote Function
function getFeedback(string requestIdOrKey, map<string|string[]> headers) returns CSATFeedbackFullDTO|errorGet feedback
Parameters
- requestIdOrKey string - The id or the key of the request to post the feedback on
Return Type
- CSATFeedbackFullDTO|error - Returns the comment
postFeedback
Isolated FunctionRemote Function
function postFeedback(string requestIdOrKey, CSATFeedbackFullDTO payload, map<string|string[]> headers) returns CSATFeedbackFullDTO|errorPost feedback
Parameters
- requestIdOrKey string - The id or the key of the request to post the feedback on
- payload CSATFeedbackFullDTO - The feedback to be added on the request
Return Type
- CSATFeedbackFullDTO|error - Returns the comment
deleteFeedback
Isolated FunctionRemote Function
Delete feedback
Parameters
- requestIdOrKey string - The id or the key of the request to post the feedback on
Return Type
- error? - No content
getAllRequestTypes
Isolated FunctionRemote Function
function getAllRequestTypes(map<string|string[]> headers, *GetAllRequestTypesQueries queries) returns PagedDTORequestTypeDTO|errorGet all request types
Parameters
- queries *GetAllRequestTypesQueries - Queries to be sent with the request
Return Type
- PagedDTORequestTypeDTO|error - Returns the request types, on the specified page of the results
getServiceDesks
Isolated FunctionRemote Function
function getServiceDesks(map<string|string[]> headers, *GetServiceDesksQueries queries) returns PagedDTOServiceDeskDTO|errorGet service desks
Parameters
- queries *GetServiceDesksQueries - Queries to be sent with the request
Return Type
- PagedDTOServiceDeskDTO|error - Returns the service desks, on the specified page of the results
getServiceDeskById
Isolated FunctionRemote Function
function getServiceDeskById(string serviceDeskId, map<string|string[]> headers) returns ServiceDeskDTO|errorGet service desk by id
Parameters
- serviceDeskId string - The ID of the service desk to return. This can alternatively be a project identifier.
Return Type
- ServiceDeskDTO|error - Returns the requested service desk
attachTemporaryFile
Isolated FunctionRemote Function
function attachTemporaryFile(string serviceDeskId, AttachTemporaryFileRequest payload, AttachTemporaryFileHeaders headers) returns TemporaryAttachments|errorAttach temporary file
Parameters
- serviceDeskId string - The ID of the Service Desk to which the file will be attached. This can alternatively be a project identifier.
- payload AttachTemporaryFileRequest - Files to upload as temporary attachments, as multipart form data
- headers AttachTemporaryFileHeaders (default {}) - Headers to be sent with the request
Return Type
- TemporaryAttachments|error - Returns if the file(s) were attached
getCustomers
Isolated FunctionRemote Function
function getCustomers(string serviceDeskId, map<string|string[]> headers, *GetCustomersQueries queries) returns PagedDTOUserDTO|errorGet customers
Parameters
- serviceDeskId string - The ID of the service desk the customer list should be returned from. This can alternatively be a project identifier.
- queries *GetCustomersQueries - Queries to be sent with the request
Return Type
- PagedDTOUserDTO|error - Returns the service desk's customer list
addCustomers
Isolated FunctionRemote Function
function addCustomers(string serviceDeskId, ServiceDeskCustomerDTO payload, map<string|string[]> headers) returns error?Add customers
Parameters
- serviceDeskId string - The ID of the service desk the customer list should be returned from. This can alternatively be a project identifier.
- payload ServiceDeskCustomerDTO - Account IDs of the customers to add to the service desk
Return Type
- error? - Returned if all the customers were added to the service desk or were already associated with the service desk
removeCustomers
Isolated FunctionRemote Function
function removeCustomers(string serviceDeskId, ServiceDeskCustomerDTO payload, map<string|string[]> headers) returns error?Remove customers
Parameters
- serviceDeskId string - The ID of the service desk the customers should be removed from. This can alternatively be a project identifier.
- payload ServiceDeskCustomerDTO - Account IDs of the customers to remove from the service desk
Return Type
- error? - Returned if the customers were removed from the service desk, or any of the customers were not associated with the service desk
inviteCustomer
Isolated FunctionRemote Function
function inviteCustomer(string serviceDeskId, ServiceDeskCustomerInviteDTO payload, map<string|string[]> headers, *InviteCustomerQueries queries) returns json|errorInvite customer
Parameters
- serviceDeskId string - The ID of the service desk to which the newly created customer should be added
- payload ServiceDeskCustomerInviteDTO - Email address and display name of the customer to invite
- queries *InviteCustomerQueries - Queries to be sent with the request
Return Type
- json|error - Returns the customer details
addCustomersSkipPermissionCheck
Isolated FunctionRemote Function
function addCustomersSkipPermissionCheck(string serviceDeskId, ServiceDeskCustomerDTO payload, map<string|string[]> headers) returns error?Add customers without permission check
Parameters
- serviceDeskId string - The ID of the service desk to add customers to. This can alternatively be a project identifier
- payload ServiceDeskCustomerDTO - JSON body containing the account IDs of customers to add
Return Type
- error? - The request completed successfully. No additional content will be sent in the response
getArticlesByServiceDeskId
Isolated FunctionRemote Function
function getArticlesByServiceDeskId(string serviceDeskId, map<string|string[]> headers, *GetArticlesByServiceDeskIdQueries queries) returns PagedDTOArticleDTO|errorGet articles of a service desk
Parameters
- serviceDeskId string - The ID of the service desk
- queries *GetArticlesByServiceDeskIdQueries - Queries to be sent with the request
Return Type
- PagedDTOArticleDTO|error - Returns the articles, on the specified page of the results
getOrganizationsByServiceDeskId
Isolated FunctionRemote Function
function getOrganizationsByServiceDeskId(string serviceDeskId, map<string|string[]> headers, *GetOrganizationsByServiceDeskIdQueries queries) returns PagedDTOOrganizationDTO|errorGet organizations of a service desk
Parameters
- serviceDeskId string - The ID of the service desk from which the organization list will be returned. This can alternatively be a project identifier.
- queries *GetOrganizationsByServiceDeskIdQueries - Queries to be sent with the request
Return Type
- PagedDTOOrganizationDTO|error - Returns the requested organizations list
addOrganization
Isolated FunctionRemote Function
function addOrganization(string serviceDeskId, OrganizationServiceDeskUpdateDTO payload, map<string|string[]> headers) returns error?Add organization
Parameters
- serviceDeskId string - The ID of the service desk to which the organization will be added. This can alternatively be a project identifier.
- payload OrganizationServiceDeskUpdateDTO - ID of the organization to add to the service desk
Return Type
- error? - Returned if the organization was added or the organization was already associated with the service desk
removeOrganization
Isolated FunctionRemote Function
function removeOrganization(string serviceDeskId, OrganizationServiceDeskUpdateDTO payload, map<string|string[]> headers) returns error?Remove organization
Parameters
- serviceDeskId string - The ID of the service desk from which the organization will be removed. This can alternatively be a project identifier.
- payload OrganizationServiceDeskUpdateDTO - ID of the organization to remove from the service desk
Return Type
- error? - Returned if the organization was removed from the service desk or no such organization was associated with the service desk
getQueues
Isolated FunctionRemote Function
function getQueues(string serviceDeskId, map<string|string[]> headers, *GetQueuesQueries queries) returns PagedDTOQueueDTO|errorGet queues
Parameters
- serviceDeskId string - ID of the service desk whose queues will be returned. This can alternatively be a project identifier.
- queries *GetQueuesQueries - Queries to be sent with the request
Return Type
- PagedDTOQueueDTO|error - Returns the queues of the service desk, on the specified page of the results
getQueue
Isolated FunctionRemote Function
function getQueue(string serviceDeskId, int queueId, map<string|string[]> headers, *GetQueueQueries queries) returns QueueDTO|errorGet a service desk queue
Parameters
- serviceDeskId string - ID of the service desk whose queues will be returned. This can alternatively be a project identifier.
- queueId int - ID of the required queue
- queries *GetQueueQueries - Queries to be sent with the request
getIssuesInQueue
Isolated FunctionRemote Function
function getIssuesInQueue(string serviceDeskId, int queueId, map<string|string[]> headers, *GetIssuesInQueueQueries queries) returns PagedDTOIssueBean|errorGet issues in queue
Parameters
- serviceDeskId string - The ID of the service desk containing the queue to be queried. This can alternatively be a project identifier.
- queueId int - The ID of the queue whose customer requests will be returned
- queries *GetIssuesInQueueQueries - Queries to be sent with the request
Return Type
- PagedDTOIssueBean|error - Returns the customer requests belonging to the queue, on the specified page of the results
getRequestTypes
Isolated FunctionRemote Function
function getRequestTypes(string serviceDeskId, map<string|string[]> headers, *GetRequestTypesQueries queries) returns PagedDTORequestTypeDTO|errorGet request types
Parameters
- serviceDeskId string - The ID of the service desk whose customer request types are to be returned. This can alternatively be a project identifier.
- queries *GetRequestTypesQueries - Queries to be sent with the request
Return Type
- PagedDTORequestTypeDTO|error - Returns the requested customer request types, on the specified page of the results
createRequestType
Isolated FunctionRemote Function
function createRequestType(string serviceDeskId, RequestTypeCreateDTO payload, map<string|string[]> headers) returns RequestTypeDTO|errorCreate request type
Parameters
- serviceDeskId string - The ID of the service desk where the customer request type is to be created. This can alternatively be a project identifier.
- payload RequestTypeCreateDTO - Issue type, name and help text of the request type to create
Return Type
- RequestTypeDTO|error - Returns the customer request type created
checkRequestTypePermissions
Isolated FunctionRemote Function
function checkRequestTypePermissions(string serviceDeskId, RequestTypePermissionCheckRequestDTO payload, map<string|string[]> headers) returns RequestTypePermissionCheckResponse|errorCheck request type permissions
Parameters
- serviceDeskId string - The ID of the service desk
- payload RequestTypePermissionCheckRequestDTO - Details of the permissions to check
Return Type
- RequestTypePermissionCheckResponse|error - Returned if the request is successful
getRequestTypeById
Isolated FunctionRemote Function
function getRequestTypeById(string serviceDeskId, string requestTypeId, map<string|string[]> headers, *GetRequestTypeByIdQueries queries) returns RequestTypeDTO|errorGet request type by id
Parameters
- serviceDeskId string - The ID of the service desk whose customer request type is to be returned. This can alternatively be a project identifier.
- requestTypeId string - The ID of the customer request type to be returned
- queries *GetRequestTypeByIdQueries - Queries to be sent with the request
Return Type
- RequestTypeDTO|error - Returns the customer request type item
deleteRequestType
Isolated FunctionRemote Function
function deleteRequestType(string serviceDeskId, Signed32 requestTypeId, map<string|string[]> headers) returns error?Delete request type
Parameters
- serviceDeskId string - The ID or project identifier of the service desk
- requestTypeId Signed32 - The ID of the request type
Return Type
- error? - Returned if the request type is deleted
getRequestTypeFields
Isolated FunctionRemote Function
function getRequestTypeFields(string serviceDeskId, Signed32 requestTypeId, map<string|string[]> headers, *GetRequestTypeFieldsQueries queries) returns CustomerRequestCreateMetaDTO|errorGet request type fields
Parameters
- serviceDeskId string - The ID of the service desk containing the request types whose fields are to be returned. This can alternatively be a project identifier.
- requestTypeId Signed32 - The ID of the request types whose fields are to be returned
- queries *GetRequestTypeFieldsQueries - Queries to be sent with the request
Return Type
- CustomerRequestCreateMetaDTO|error - Returns the request type's fields and user permission details, on the specified page of the results
getPropertiesKeysByServiceDeskId
Isolated FunctionRemote Function
function getPropertiesKeysByServiceDeskId(Signed32 requestTypeId, string serviceDeskId, map<string|string[]> headers) returns PropertyKeys|errorGet request type property keys
Parameters
- requestTypeId Signed32 - The ID of the request type for which keys will be retrieved
- serviceDeskId string - The ID of the service desk which contains the request type. This can alternatively be a project identifier.
Return Type
- PropertyKeys|error - Returned if the request type was found
getPropertyByServiceDeskId
Isolated FunctionRemote Function
function getPropertyByServiceDeskId(string serviceDeskId, Signed32 requestTypeId, string propertyKey, map<string|string[]> headers) returns EntityProperty|errorGet request type property
Parameters
- serviceDeskId string - The ID of the service desk which contains the request type. This can alternatively be a project identifier.
- requestTypeId Signed32 - The ID of the request type from which the property will be retrieved
- propertyKey string - The key of the property to return
Return Type
- EntityProperty|error - Returned if the request type property was returned
setPropertyByServiceDeskId
Isolated FunctionRemote Function
function setPropertyByServiceDeskId(string serviceDeskId, Signed32 requestTypeId, string propertyKey, json payload, map<string|string[]> headers) returns json|errorSet request type property
Parameters
- serviceDeskId string - The ID of the service desk which contains the request type. This can alternatively be a project identifier.
- requestTypeId Signed32 - The ID of the request type on which the property will be set
- propertyKey string - The key of the request type property. The maximum length of the key is 255 bytes
- payload json - The value of the request type property. The value has to be a valid, non-empty JSON value. The maximum length of the property value is 32768 bytes
Return Type
- json|error - Returned if the request type property is updated
deletePropertyByServiceDeskId
Isolated FunctionRemote Function
function deletePropertyByServiceDeskId(string serviceDeskId, Signed32 requestTypeId, string propertyKey, map<string|string[]> headers) returns error?Delete request type property
Parameters
- serviceDeskId string - The ID of the service desk which contains the request type. This can alternatively be a project identifier.
- requestTypeId Signed32 - The ID of the request type for which the property will be removed
- propertyKey string - The key of the property to remove
Return Type
- error? - Returned if the request type property was removed
getRequestTypeGroups
Isolated FunctionRemote Function
function getRequestTypeGroups(string serviceDeskId, map<string|string[]> headers, *GetRequestTypeGroupsQueries queries) returns PagedDTORequestTypeGroupDTO|errorGet request type groups
Parameters
- serviceDeskId string - The ID of the service desk whose customer request type groups are to be returned. This can alternatively be a project identifier.
- queries *GetRequestTypeGroupsQueries - Queries to be sent with the request
Return Type
- PagedDTORequestTypeGroupDTO|error - Returns the service desk's customer request type groups, on the specified page of the results
Records
jira.servicemanagement: AdditionalCommentDTO
Closed record
A comment to add alongside another action
Fields
- body? string - Content of the comment
jira.servicemanagement: ApprovalDecisionRequestDTO
Closed record
Decision to record against an approval
Fields
- decision? "approve"|"decline" - Response to the approval request
jira.servicemanagement: ApprovalDTO
Closed record
An approval on a customer request
Fields
- createdDate? DateDTO - Date the approval was created
- links? SelfLinkDTO - The REST API URL of the approval
- canAnswerApproval? boolean - Indicates whether the user making the request is one of the approvers and can respond to the approval (true) or not (false)
- name? string - Description of the approval being sought or provided
- approvers? ApproverDTO[] - Detailed list of the users who must provide a response to the approval
- finalDecision? "approved"|"declined"|"pending" - Outcome of the approval, based on the approvals provided by all approvers
- id? string - ID of the approval
- completedDate? DateDTO - Date the approval was completed
jira.servicemanagement: ApproverDTO
Closed record
An approver and their decision
Fields
- approver? UserDTO - Details of the User who is providing approval
- approverDecision? "approved"|"declined"|"pending" - Decision made by the approver
jira.servicemanagement: ArticleDTO
Closed record
A knowledge base article
Fields
- 'source? SourceDTO - Source of the article
- excerpt? string - Excerpt of the article which matches the given query string
- title? string - Title of the article
- content? ContentDTO - Location of the rendered article content
jira.servicemanagement: AssetsWorkspaceDTO
Closed record
Details of an Assets workspace ID
Fields
- workspaceId? string - The workspace ID used as the identifier to access the Assets REST API
jira.servicemanagement: AttachmentCreateDTO
Closed record
Temporary attachments to add to a request, with an optional comment
Fields
- temporaryAttachmentIds? string[] - List of IDs for the temporary attachments to be added to the customer request
- 'public? boolean - Controls whether the comment and its attachments are visible to customers
- additionalComment? AdditionalCommentDTO - Additional content of the comment
jira.servicemanagement: AttachmentCreateResultDTO
Closed record
Attachments and comment created on a request
Fields
- attachments? PagedDTOAttachmentDTO - List of the attachments added
- comment? CommentDTO - Details of the comment included with the attachments
jira.servicemanagement: AttachmentDTO
Closed record
An attachment on a customer request
Fields
- filename? string - Filename of the item attached
- size? int - Size of the attachment in bytes
- links? AttachmentLinkDTO - Various URLs for the attachment
- created? DateDTO - Date the attachment was added
- mimeType? string - MIME type of the attachment
jira.servicemanagement: AttachmentLinkDTO
Closed record
Links to an attachment, its content and its thumbnail
Fields
- thumbnail? string - URL for the attachment's thumbnail image
- jiraRest? string - REST API URL for the attachment
- self? string - REST API URL of the attachment
- content? string - URL for the attachment
jira.servicemanagement: AttachTemporaryFileHeaders
Represents the Headers record for the operation: attachTemporaryFile
Fields
- xAtlassianToken string(default "no-check") - XSRF protection bypass that Jira requires on multipart requests. Must be
no-check
jira.servicemanagement: AttachTemporaryFileRequest
Multipart form carrying the file to upload as a temporary attachment
Fields
- file record { fileContent byte[], fileName string } - The file to upload. The multipart field must be named
file
jira.servicemanagement: AvatarUrlsBean
Closed record
URLs of a user avatar in different sizes
Fields
- param48x48? string - The URL of the item's 48x48 pixel avatar
- param24x24? string - The URL of the item's 24x24 pixel avatar
- param16x16? string - The URL of the item's 16x16 pixel avatar
- param32x32? string - The URL of the item's 32x32 pixel avatar
jira.servicemanagement: ChangeDetails
Closed record
A change item
Fields
- 'field? string - The name of the field changed
- 'from? string - The details of the original value
- toString? string - The details of the new value as a string
- fromString? string - The details of the original value as a string
- to? string - The details of the new value
- fieldtype? string - The type of the field changed
- fieldId? string - The ID of the field changed
jira.servicemanagement: Changelog
Closed record
A log of changes made to issue fields. Changelogs related to workflow associations are currently being deprecated
Fields
- historyMetadata? HistoryMetadata - The history metadata associated with the changed
- created? string - The date on which the change took place
- id? string - The ID of the changelog
- items? ChangeDetails[] - The list of items changed
jira.servicemanagement: CommentCreateDTO
Closed record
Details of a comment to add to a request
Fields
- 'public? boolean - Indicates whether the comment is public (true) or private/internal (false)
- body? string - Content of the comment
jira.servicemanagement: CommentDTO
Closed record
A comment on a customer request
Fields
- renderedBody? RenderedValueDTO - The rendered body of the comment
- attachments? PagedDTOAttachmentDTO - List of the attachments included in the comment
- 'public? boolean - Indicates whether the comment is public (true) or private/internal (false)
- links? SelfLinkDTO - REST API URL link to the comment
- created? DateDTO - Date the comment was created
- expands? string[] - List of items that can be expanded in the response by specifying the expand query parameter
- id? string - ID of the comment
- body? string - Content of the comment
jira.servicemanagement: ConnectionConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig|OAuth2RefreshTokenGrantConfig|CredentialsConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- followRedirects? FollowRedirects - Configurations associated with Redirection
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache CacheConfig(default {}) - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
- laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. Enabled by default.
jira.servicemanagement: ContentDTO
Closed record
Location of the rendered content of a knowledge base article
Fields
- iframeSrc? string - Url containing the body of the article (without title), suitable for rendering in an iframe
jira.servicemanagement: CreateCustomerQueries
Represents the Queries record for the operation: createCustomer
Fields
- strictConflictStatusCode? boolean - Optional boolean flag to return 409 Conflict status code for duplicate customer creation request
jira.servicemanagement: CreateCustomerSkipPermissionCheckQueries
Represents the Queries record for the operation: createCustomerSkipPermissionCheck
Fields
- strictConflictStatusCode? boolean - Optional boolean flag; when {@code true}, returns 409 Conflict for duplicate email instead of the default 400
jira.servicemanagement: CSATFeedbackFullDTO
Closed record
Customer satisfaction (CSAT) feedback on a request
Fields
- rating? Signed32 - A numeric representation of the rating, this must be an integer value between 1 and 5
- comment? AdditionalCommentDTO - (Optional) The comment provided with this feedback
- 'type? string - Indicates the type of feedback, supported values:
csat
jira.servicemanagement: CustomerCreateDTO
Closed record
Details of a customer to create
Fields
- displayName? string - Customer's name for display in the UI
- fullName? string - Deprecated, please use 'displayName'
- email? string - Customer's email address
jira.servicemanagement: CustomerRequestActionDTO
Closed record
Whether an action is allowed on a customer request
Fields
- allowed? boolean - Indicates whether the user can undertake the action (true) or not (false)
jira.servicemanagement: CustomerRequestActionsDTO
Closed record
Actions the calling user can perform on a customer request
Fields
- removeParticipant? CustomerRequestActionDTO - Action of removing participants from a request
- addParticipant? CustomerRequestActionDTO - Action of adding participants to a request
- addAttachment? CustomerRequestActionDTO - Action of adding attachments to a request
- addComment? CustomerRequestActionDTO - Action of adding comments to a request
jira.servicemanagement: CustomerRequestCreateMetaDTO
Closed record
Fields and options available when creating a request of a request type
Fields
- canRaiseOnBehalfOf? boolean - Flag indicating if a request can be raised on behalf of another user (true) or not
- canAddRequestParticipants? boolean - Flag indicating if participants can be added to a request (true) or not
- requestTypeFields? RequestTypeFieldDTO[] - List of the fields included in this request
jira.servicemanagement: CustomerRequestDTO
Closed record
A customer request
Fields
- summary? string - Summary of the request created
- issueId? string - ID of the request, as the peer issue ID
- attachments? PagedDTOAttachmentDTO - List of attachments included with the request
- comments? PagedDTOCommentDTO - List of comments included with the request
- issueKey? string - Key of the request, as the peer issue key
- requestType? RequestTypeDTO - Expandable details of the request type
- serviceDeskId? string - ID of the service desk the request belongs to
- links? CustomerRequestLinkDTO - List of links associated with the request
- currentStatus? CustomerRequestStatusDTO - Status of the request
- requestTypeId? string - ID of the request type for the request
- serviceDesk? ServiceDeskDTO - Expandable details of the service desk
- sla? PagedDTOSlaInformationDTO - Expandable details of the SLAs relating to the request
- reporter? UserDTO - Details of the customer reporting the request
- requestFieldValues? CustomerRequestFieldValueDTO[] - JSON map of Jira field IDs and their values representing the content of the request. This list does not include hidden fields
- createdDate? DateDTO - Date on which the request was created
- expands? string[] - List of items that can be expanded in the response by specifying the expand query parameter
- actions? CustomerRequestActionsDTO - List of actions that the user can take on the request
- participants? PagedDTOUserDTO - Expandable details of the customers participating in the request
- status? PagedDTOCustomerRequestStatusDTO - Expandable details of the request's status history
jira.servicemanagement: CustomerRequestFieldValueDTO
Closed record
The value of a field on a customer request
Fields
- renderedValue? record {} - Value of the field rendered in the UI
- label? string - Text label for the field
- value? anydata - Value of the field
- fieldId? string - ID of the field
jira.servicemanagement: CustomerRequestLinkDTO
Closed record
Links to a customer request in the agent view, the portal and the REST API
Fields
- agent? string - Jira agent view URL for the request
- jiraRest? string - REST API URL for the request
- web? string - Web URL for the request
- self? string - REST API URL of the customer request
jira.servicemanagement: CustomerRequestStatusDTO
Closed record
A status of a customer request and when it was set
Fields
- statusDate? DateDTO - Date on which the status was attained
- statusCategory? "UNDEFINED"|"NEW"|"INDETERMINATE"|"DONE" - Status category the status belongs to
- status? string - Name of the status condition
jira.servicemanagement: CustomerTransitionDTO
Closed record
A workflow transition available to the customer on a request
Fields
- name? string - Name of the transition
- id? string - ID of the transition
jira.servicemanagement: CustomerTransitionExecutionDTO
Closed record
Transition to perform on a customer request, with an optional comment
Fields
- id? string - ID of the transition to be performed
- additionalComment? AdditionalCommentDTO - Comment explaining the reason for the transition
jira.servicemanagement: DateDTO
Closed record
A date and time rendered in several formats
Fields
- friendly? string - Date in a user-friendly text format
- iso8601? string - Date in ISO8601 format
- epochMillis? int - Date as the number of milliseconds that have elapsed since 00:00:00 Coordinated Universal Time (UTC), 1 January 1970
- jira? string - 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
jira.servicemanagement: DurationDTO
Closed record
A duration in milliseconds and in a human-readable form
Fields
- friendly? string - Duration in a user-friendly text format
- millis? int - Duration in milliseconds
jira.servicemanagement: EntityProperty
Closed record
An entity property, for more information see Entity properties
Fields
- value? anydata - The value of the property. Required on create and update
- 'key? string - The key of the property. Required on create and update
jira.servicemanagement: FieldMetadata
Closed record
The metadata describing an issue field
Fields
- allowedValues? anydata[] - The list of values allowed in the field
- hasDefaultValue? boolean - Whether the field has a default value
- schema JsonTypeBean - The data type of the field
- operations string[] - The list of operations that can be performed on the field
- configuration? record {} - The configuration properties
- defaultValue? anydata - The default value of the field
- name string - The name of the field
- autoCompleteUrl? string - The URL that can be used to automatically complete the field
- 'key string - The key of the field
- required boolean - Whether the field is required
jira.servicemanagement: Form
Answers to a request type form, keyed by question ID
Fields
- answers? record { FormAnswer... } - JSON mapping of form field answers containing form field IDs and corresponding values.
jira.servicemanagement: FormAnswer
Closed record
An answer to a form question
Fields
- date? string - Answer in date format (yyyy-MM-dd)
- adf? JsonNode - Answer in Atlassian Document Format (ADF)
- files? string[] - 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
- text? string - Answer in free text format
- time? string - Answer in timestamp format (HH:mm)
- choices? string[] - IDs of selected choices
- users? string[] - IDs of selected users
jira.servicemanagement: FormValidationErrorContextDTO
Closed record
Context of a form validation error
Fields
- id? string - ID of the form entity related to the validation error
- 'type? string - Type of form entity related to the validation error
jira.servicemanagement: FormValidationErrorDTO
Closed record
A single validation error reported for a form
Fields
- code? string - Machine-readable validation error code
- context? FormValidationErrorContextDTO[] - Identifies the form entity that caused the validation error
- detail? string - Detailed validation error message
- title? string - Short summary of the validation error
- status? Signed32 - The HTTP status code
jira.servicemanagement: GetAllRequestTypesQueries
Represents the Queries record for the operation: getAllRequestTypes
Fields
- expand? string[] - Comma-separated list of entities to expand in the response
- serviceDeskId? Signed32[] - Filter the request types by service desk Ids provided. Multiple values of the query parameter are supported. For example,
serviceDeskId=1&serviceDeskId=2will return request types only for service desks 1 and 2
- searchQuery? string - String to be used to filter the results
- 'start? Signed32 - The starting index of the returned objects. Base index: 0. See the Pagination section for more details
- 'limit? Signed32 - The maximum number of items to return per page. Default: 50. See the Pagination section for more details
- includeHiddenRequestTypesInSearch boolean(default false) - Whether to include hidden request types when searching with
searchQuery
- restrictionStatus? string - Request type restriction status (
openorrestricted) used to filter the results
jira.servicemanagement: GetApprovalsQueries
Represents the Queries record for the operation: getApprovals
Fields
- 'start? Signed32 - The starting index of the returned objects. Base index: 0. See the Pagination section for more details
- 'limit? Signed32 - The maximum number of approvals to return per page. Default: 50. See the Pagination section for more details
jira.servicemanagement: GetArticlesByServiceDeskIdQueries
Represents the Queries record for the operation: getArticlesByServiceDeskId
Fields
- cursor? string - Pointer to a set of search results, returned as part of the next or prev URL from the previous search call
- highlight boolean(default false) - If set to true matching query term in the title and excerpt will be highlighted using the
@@@hl@@@term@@@endhl@@@syntax. Default: false
- query string - The string used to filter the articles (required)
- prev boolean(default false) - Should navigate to the previous page. Defaulted to false. Set to true as part of prev URL from the previous search call
- 'start? Signed32 - (Deprecated) The starting index of the returned objects. Base index: 0
- 'limit? Signed32 - The maximum number of items to return per page. Default: 50. See the section for more details
jira.servicemanagement: GetArticlesQueries
Represents the Queries record for the operation: getArticles
Fields
- cursor? string - Pointer to a set of search results, returned as part of the next or prev URL from the previous search call
- highlight boolean(default false) - If set to true matching query term in the title and excerpt will be highlighted using the
@@@hl@@@term@@@endhl@@@syntax. Default: false
- query string - The string used to filter the articles (required)
- prev boolean(default false) - Should navigate to the previous page. Defaulted to false. Set to true as part of prev URL from the previous search call
- 'start? Signed32 - (Deprecated) The starting index of the returned objects. Base index: 0
- 'limit? Signed32 - The maximum number of items to return per page. Default: 50
jira.servicemanagement: GetAssetsWorkspacesQueries
Represents the Queries record for the operation: getAssetsWorkspaces
Fields
- 'start Signed32(default 0) - The starting index of the returned workspace IDs. Base index: 0 See the Pagination section for more details
- 'limit Signed32(default 50) - The maximum number of workspace IDs to return per page. Default: 50 See the Pagination section for more details
jira.servicemanagement: GetAttachmentsForRequestQueries
Represents the Queries record for the operation: getAttachmentsForRequest
Fields
- 'start Signed32(default 0) - The starting index of the returned attachment. Base index: 0. See the Pagination section for more details
- 'limit Signed32(default 50) - The maximum number of comments to return per page. Default: 50. See the Pagination section for more details
jira.servicemanagement: GetCommentAttachmentsQueries
Represents the Queries record for the operation: getCommentAttachments
Fields
- 'start? Signed32 - The starting index of the returned comments. Base index: 0. See the Pagination section for more details
- 'limit? Signed32 - The maximum number of comments to return per page. Default: 50. See the Pagination section for more details
jira.servicemanagement: GetCustomerRequestByIdOrKeyQueries
Represents the Queries record for the operation: getCustomerRequestByIdOrKey
Fields
- expand? string[] - A multi-value parameter indicating which properties of the customer request to expand, where:
serviceDeskreturns additional service desk details.requestTypereturns additional customer request type details.participantreturns the participant details.slareturns the SLA information.statusreturns the status transitions, in chronological order.attachmentreturns the attachments.actionreturns the actions that the user can or cannot perform.commentreturns the comments.comment.attachmentreturns the attachment details for each comment.comment.renderedBody(Experimental) return the rendered body in HTML format (in addition to the raw body) for each comment
jira.servicemanagement: GetCustomerRequestsQueries
Represents the Queries record for the operation: getCustomerRequests
Fields
- approvalStatus? string - Filters results to customer requests based on their approval status:
MY_PENDING_APPROVALreturns customer requests pending the user's approval.MY_HISTORY_APPROVALreturns customer requests where the user was an approver.
- organizationId? Signed32 - Filters customer requests that belong to a specific organization (note that the user must be a member of that organization). Note: Valid only when used with requestOwnership=ORGANIZATION
- expand? string[] - A multi-value parameter indicating which properties of the customer request to expand, where:
serviceDeskreturns additional details for each service desk.requestTypereturns additional details for each request type.participantreturns the participant details, if any, for each customer request.slareturns the SLA information on each customer request.statusreturns the status transitions, in chronological order, for each customer request.attachmentreturns the attachments for the customer request.actionreturns the actions that the user can or cannot perform on this customer request.commentreturns the comments, if any, for each customer request.comment.attachmentreturns the attachment details, if any, for each comment.comment.renderedBody(Experimental) returns the rendered body in HTML format (in addition to the raw body) for each comment
- requestOwnership? string[] - Filters customer requests using the following values:
OWNED_REQUESTSreturns customer requests where the user is the creator.PARTICIPATED_REQUESTSreturns customer requests where the user is a participant.ORGANIZATIONreturns customer requests for an organization of which the user is a member when used in conjunction withorganizationId.ALL_ORGANIZATIONSreturns customer requests that belong to all organizations of which the user is a member.APPROVERreturns customer requests where the user is an approver. Can be used in conjunction withapprovalStatusto filter pending or complete approvals.ALL_REQUESTSreturns all customer requests. Deprecated and will be removed, as the returned requests may change if more values are added in the future. Instead, explicitly list the desired filtering strategies.
requestOwnership=OWNED_REQUESTS&requestOwnership=PARTICIPATED_REQUESTSwill only return customer requests where the user is the creator or a participant. If not specified, filtering defaults toOWNED_REQUESTS,PARTICIPATED_REQUESTS, andALL_ORGANIZATIONS
- serviceDeskId? Signed32 - Filters customer requests by service desk
- requestTypeId? Signed32 - Filters customer requests by request type. Note that the
serviceDeskIdmust be specified for the service desk in which the request type belongs
- 'start? Signed32 - The starting index of the returned objects. Base index: 0. See the Pagination section for more details
- 'limit? Signed32 - The maximum number of items to return per page. Default: 50. See the Pagination section for more details
- requestStatus? string - Filters customer requests where the request is closed, open, or either of the two where:
CLOSED_REQUESTSreturns customer requests that are closed.OPEN_REQUESTSreturns customer requests that are open.ALL_REQUESTSreturns all customer requests
jira.servicemanagement: GetCustomerRequestStatusQueries
Represents the Queries record for the operation: getCustomerRequestStatus
Fields
- 'start? Signed32 - The starting index of the returned objects. Base index: 0. See the Pagination section for more details
- 'limit? Signed32 - The maximum number of items to return per page. Default: 50. See the Pagination section for more details
jira.servicemanagement: GetCustomersQueries
Represents the Queries record for the operation: getCustomers
Fields
- query? string - The string used to filter the customer list
- 'start? Signed32 - The starting index of the returned objects. Base index: 0. See the Pagination section for more details
- 'limit? Signed32 - The maximum number of users to return per page. Default: 50. See the Pagination section for more details
jira.servicemanagement: GetCustomerTransitionsQueries
Represents the Queries record for the operation: getCustomerTransitions
Fields
- 'start? Signed32 - The starting index of the returned objects. Base index: 0. See the Pagination section for more details
- 'limit? Signed32 - The maximum number of items to return per page. Default: 50. See the Pagination section for more details
jira.servicemanagement: GetInsightWorkspacesQueries
Represents the Queries record for the operation: getInsightWorkspaces
Fields
- 'start Signed32(default 0) - The starting index of the returned objects. Base index: 0
- 'limit Signed32(default 50) - The maximum number of objects to return per page
jira.servicemanagement: GetIssuesInQueueQueries
Represents the Queries record for the operation: getIssuesInQueue
Fields
- 'start? Signed32 - The starting index of the returned objects. Base index: 0. See the Pagination section for more details
- 'limit? Signed32 - The maximum number of items to return per page. Default: 50. See the Pagination section for more details
jira.servicemanagement: GetOrganizationsByServiceDeskIdQueries
Represents the Queries record for the operation: getOrganizationsByServiceDeskId
Fields
- accountId? string - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5
- 'start? Signed32 - The starting index of the returned objects. Base index: 0. See the Pagination section for more details
- 'limit? Signed32 - The maximum number of items to return per page. Default: 50. See the Pagination section for more details
jira.servicemanagement: GetOrganizationsQueries
Represents the Queries record for the operation: getOrganizations
Fields
- accountId? string - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5
- 'start? Signed32 - The starting index of the returned objects. Base index: 0. See the Pagination section for more details
- 'limit? Signed32 - The maximum number of organizations to return per page. Default: 50. See the Pagination section for more details
jira.servicemanagement: GetQueueQueries
Represents the Queries record for the operation: getQueue
Fields
- includeCount boolean(default false) - Specifies whether to include each queue's customer request (issue) count in the response
jira.servicemanagement: GetQueuesQueries
Represents the Queries record for the operation: getQueues
Fields
- 'start? Signed32 - The starting index of the returned objects. Base index: 0. See the Pagination section for more details
- 'limit? Signed32 - The maximum number of items to return per page. Default: 50. See the Pagination section for more details
- includeCount boolean(default false) - Specifies whether to include each queue's customer request (issue) count in the response
jira.servicemanagement: GetRequestCommentByIdQueries
Represents the Queries record for the operation: getRequestCommentById
Fields
- expand? string[] - A multi-value parameter indicating which properties of the comment to expand:
attachmentreturns the attachment details, if any, for the comment. (If you want to get all attachments for a request, use servicedeskapi/request/{issueIdOrKey}/attachment.)renderedBody(Experimental) returns the rendered body in HTML format (in addition to the raw body) of the comment
jira.servicemanagement: GetRequestCommentsQueries
Represents the Queries record for the operation: getRequestComments
Fields
- internal? boolean - Specifies whether to return internal comments or not. Default: true
- expand? string[] - A multi-value parameter indicating which properties of the comment to expand:
attachmentreturns the attachment details, if any, for each comment. (If you want to get all attachments for a request, use servicedeskapi/request/{issueIdOrKey}/attachment.)renderedBody(Experimental) returns the rendered body in HTML format (in addition to the raw body) for each comment
- 'public? boolean - Specifies whether to return public comments or not. Default: true
- 'start? Signed32 - The starting index of the returned comments. Base index: 0. See the Pagination section for more details
- 'limit? Signed32 - The maximum number of comments to return per page. Default: 50. See the Pagination section for more details
jira.servicemanagement: GetRequestParticipantsQueries
Represents the Queries record for the operation: getRequestParticipants
Fields
- 'start? Signed32 - The starting index of the returned objects. Base index: 0. See the Pagination section for more details
- 'limit? Signed32 - The maximum number of request types to return per page. Default: 50. See the Pagination section for more details
jira.servicemanagement: GetRequestTypeByIdQueries
Represents the Queries record for the operation: getRequestTypeById
Fields
- expand? string[] - Comma-separated list of entities to expand in the response
jira.servicemanagement: GetRequestTypeFieldsQueries
Represents the Queries record for the operation: getRequestTypeFields
Fields
jira.servicemanagement: GetRequestTypeGroupsQueries
Represents the Queries record for the operation: getRequestTypeGroups
Fields
- 'start? Signed32 - The starting index of the returned objects. Base index: 0. See the Pagination section for more details
- 'limit? Signed32 - The maximum number of items to return per page. Default: 50. See the Pagination section for more details
jira.servicemanagement: GetRequestTypesQueries
Represents the Queries record for the operation: getRequestTypes
Fields
- expand? string[] - Comma-separated list of entities to expand in the response
- groupId? Signed32 - Filters results to those in a customer request type group
- searchQuery? string - The string to be used to filter the results
- 'start? Signed32 - The starting index of the returned objects. Base index: 0. See the Pagination section for more details
- 'limit? Signed32 - The maximum number of items to return per page. Default: 50. See the Pagination section for more details
- includeHiddenRequestTypesInSearch boolean(default false) - Whether to include hidden request types when searching with
searchQuery
- restrictionStatus? string - Request type restriction status (
openorrestricted) used to filter the results
jira.servicemanagement: GetServiceDesksQueries
Represents the Queries record for the operation: getServiceDesks
Fields
- 'start? Signed32 - The starting index of the returned objects. Base index: 0. See the Pagination section for more details
- 'limit? Signed32 - The maximum number of items to return per page. Default: 50. See the Pagination section for more details
jira.servicemanagement: GetSlaInformationQueries
Represents the Queries record for the operation: getSlaInformation
Fields
- 'start? Signed32 - The starting index of the returned objects. Base index: 0. See the Pagination section for more details
- 'limit? Signed32 - The maximum number of request types to return per page. Default: 50. See the Pagination section for more details
jira.servicemanagement: GetUsersInOrganizationQueries
Represents the Queries record for the operation: getUsersInOrganization
Fields
- 'start? Signed32 - The starting index of the returned objects. Base index: 0. See the Pagination section for more details
- 'limit? Signed32 - The maximum number of users to return per page. Default: 50. See the Pagination section for more details
jira.servicemanagement: HistoryMetadata
Details of issue history metadata
Fields
- activityDescription? string - The activity described in the history record.
- activityDescriptionKey? string - The key of the activity described in the history record.
- actor? HistoryMetadataParticipant - Details of the user whose action created the history record.
- cause? HistoryMetadataParticipant - Details of the cause that triggered the creation the history record.
- description? string - The description of the history record.
- descriptionKey? string - The description key of the history record.
- emailDescription? string - The description of the email address associated the history record.
- emailDescriptionKey? string - The description key of the email address associated the history record.
- extraData? record { string... } - Additional arbitrary information about the history record.
- generator? HistoryMetadataParticipant - Details of the system that generated the history record.
- 'type? string - The type of the history record.
jira.servicemanagement: HistoryMetadataParticipant
Details of user or system associated with a issue history metadata item
Fields
- avatarUrl? string - The URL to an avatar for the user or system associated with a history record.
- displayName? string - The display name of the user or system associated with a history record.
- displayNameKey? string - The key of the display name of the user or system associated with a history record.
- id? string - The ID of the user or system associated with a history record.
- 'type? string - The type of the user or system associated with a history record.
- url? string - The URL of the user or system associated with a history record.
jira.servicemanagement: IncludedFields
Closed record
Fields included in or excluded from an issue response
Fields
- excluded? string[] - Fields explicitly excluded from the response
- actuallyIncluded? string[] - Fields actually included in the response
- included? string[] - Fields explicitly requested in the response
jira.servicemanagement: InsightWorkspaceDTO
Closed record
Details of an insight workspace ID
Fields
- workspaceId? string - The workspace ID used as the identifier to access the Insight REST API
jira.servicemanagement: InviteCustomerQueries
Represents the Queries record for the operation: inviteCustomer
Fields
- strictConflictStatusCode? boolean - Optional boolean flag to return 409 Conflict status code when a customer with the same email already exists
jira.servicemanagement: IssueBean
Closed record
Details about an issue
Fields
- schema? record { JsonTypeBean... } - The schema describing each field present on the issue
- editmeta? IssueUpdateMetadata - The metadata for the fields on the issue that can be amended
- fieldsToInclude? IncludedFields - Fields to include in the issue response
- changelog? PageOfChangelogs - Details of changelogs associated with the issue
- transitions? IssueTransition[] - The transitions that can be performed on the issue
- renderedFields? record {} - The rendered value of each field present on the issue
- expand? string - Expand options that include additional issue details in the response
- names? record { string... } - The ID and name of each field present on the issue
- operations? Operations - The operations that can be performed on the issue
- versionedRepresentations? record { record {}... } - The versions of each field on the issue
- self? string - The URL of the issue details
- id? string - The ID of the issue
- fields? record {} - Issue fields, keyed by field ID
- 'key? string - The key of the issue
- properties? record {} - Details of the issue properties identified in the request
jira.servicemanagement: IssueTransition
Details of an issue transition
Fields
- expand? string - Expand options that include additional transition details in the response.
- fields? record { FieldMetadata... } - Details of the fields associated with the issue transition screen. Use this information to populate
fieldsandupdatein a transition request.
- hasScreen? boolean - Whether there is a screen associated with the issue transition.
- id? string - The ID of the issue transition. Required when specifying a transition to undertake.
- isAvailable? boolean - Whether the transition is available to be performed.
- isConditional? boolean - Whether the issue has to meet criteria before the issue transition is applied.
- isGlobal? boolean - Whether the issue transition is global, that is, the transition is applied to issues regardless of their status.
- isInitial? boolean - Whether this is the initial issue transition for the workflow.
- looped? boolean - Whether the transition loops back to the same status
- name? string - The name of the issue transition.
- to? StatusDetails - Details of the issue status after the transition.
jira.servicemanagement: IssueUpdateMetadata
A list of editable field details
Fields
- fields? record { FieldMetadata... } - Metadata of the editable fields, keyed by field ID
jira.servicemanagement: JsonNode
Closed record
Generic JSON value node as serialized by the Jira backend
Fields
- valueAsDouble? decimal - Node value as a double
- numberType? "INT"|"LONG"|"BIG_INTEGER"|"FLOAT"|"DOUBLE"|"BIG_DECIMAL" - Numeric type of the node
- fieldNames? record {} - Names of the fields of an object node
- decimalValue? decimal - Node value as a decimal
- valueAsBoolean? boolean - Node value as a boolean
- valueNode? boolean - Whether the node is a value node
- long? boolean - Whether the node holds a long
- longValue? int - Node value as a long
- valueAsInt? Signed32 - Node value as an integer
- missingNode? boolean - Whether the node is missing
- number? boolean - Whether the node holds a number
- valueAsText? string - Node value as text
- array? boolean - Whether the node is an array
- containerNode? boolean - Whether the node is a container node
- numberValue? decimal - Numeric value of the node
- bigDecimal? boolean - Whether the node holds a big decimal
- valueAsLong? int - Node value as a long
- integralNumber? boolean - Whether the node holds an integral number
- textValue? string - Text value of the node
- double? boolean - Whether the node holds a double
- intValue? Signed32 - Node value as an integer
- bigInteger? boolean - Whether the node holds a big integer
- doubleValue? decimal - Node value as a double
- floatingPointNumber? boolean - Whether the node holds a floating-point number
- 'int? boolean - Whether the node holds an integer
- textual? boolean - Whether the node holds text
- pojo? boolean - Whether the node wraps a plain Java object
- bigIntegerValue? int - Node value as a big integer
- 'boolean? boolean - Whether the node holds a boolean
- 'null? boolean - Whether the node is null
- binary? boolean - Whether the node holds binary data
- elements? record {} - Elements of an array node
- booleanValue? boolean - Boolean value of the node
- fields? record {} - Fields of an object node
- binaryValue? string[] - Binary value of the node
- 'object? boolean - Whether the node is an object
jira.servicemanagement: JsonTypeBean
Closed record
The schema of a field
Fields
- system? string - If the field is a system field, the name of the field
- configuration? record {} - If the field is a custom field, the configuration of the field
- custom? string - If the field is a custom field, the URI of the field
- 'type string - The data type of the field
- customId? int - If the field is a custom field, the custom ID of the field
- items? string - When the data type is an array, the name of the field items within the array
jira.servicemanagement: LinkGroup
Closed record
Details a link group, which defines issue operations
Fields
- groups? LinkGroup[] - Nested link groups
- header? SimpleLink - Header link of the group
- weight? Signed32 - Sort weight of the group
- links? SimpleLink[] - Links in the group
- id? string - ID of the link group
- styleClass? string - CSS style class of the group
jira.servicemanagement: OAuth2RefreshTokenGrantConfig
Closed record
OAuth2 Refresh Token Grant Configs
Fields
- Fields Included from *OAuth2RefreshTokenGrantConfig
- refreshUrl string(default "https://auth.atlassian.com/oauth/token") - Refresh URL
jira.servicemanagement: Operations
Details of the operations that can be performed on the issue
Fields
- linkGroups? LinkGroup[] - Details of the link groups defining issue operations.
jira.servicemanagement: OrganizationCreateDTO
Closed record
Details of an organization to create
Fields
- name string - Name of the organization. Must contain 1-200 characters
jira.servicemanagement: OrganizationDTO
Closed record
A Jira Service Management organization
Fields
- links? SelfLinkDTO - REST API URL to the organization
- created? DateDTO - Date the organization was created. This field may not be present in some older organizations
- name? string - Name of the organization
- id? string - A unique system generated ID for the organization
- scimManaged? boolean - Returns if an organization is managed by scim. This field may not be present in some older organizations
- uuid? string - A unique system generated ID for the organization. This is identity from the group directory id
jira.servicemanagement: OrganizationServiceDeskUpdateDTO
Organization to add to or remove from a service desk
Fields
- organizationId Signed32 - List of organizations, specified by 'ID' field values, to add to or remove from the service desk.
- serviceDeskId? string - Service desk Id for which, organization needs to be updated
jira.servicemanagement: PagedDTOApprovalDTO
Closed record
A page of approval results
Fields
- size? Signed32 - Number of items returned in the page
- links? PagedLinkDTO - List of the links relating to the page
- isLastPage? boolean - Indicates if this is the last page of records (true) or not (false)
- values? ApprovalDTO[] - Details of the items included in the page
- expands? string[] - Fields that can be expanded in the response
- 'limit? Signed32 - Number of items to be returned per page, up to the maximum set for these objects in the current implementation
- 'start? Signed32 - Index of the first item returned in the page
jira.servicemanagement: PagedDTOArticleDTO
Closed record
A page of article results
Fields
- size? Signed32 - Number of items returned in the page
- links? PagedLinkDTO - List of the links relating to the page
- isLastPage? boolean - Indicates if this is the last page of records (true) or not (false)
- values? ArticleDTO[] - Details of the items included in the page
- expands? string[] - Fields that can be expanded in the response
- 'limit? Signed32 - Number of items to be returned per page, up to the maximum set for these objects in the current implementation
- 'start? Signed32 - Index of the first item returned in the page
jira.servicemanagement: PagedDTOAssetsWorkspaceDTO
Closed record
A page of assets workspace results
Fields
- size? Signed32 - Number of items returned in the page
- links? PagedLinkDTO - List of the links relating to the page
- isLastPage? boolean - Indicates if this is the last page of records (true) or not (false)
- values? AssetsWorkspaceDTO[] - Details of the items included in the page
- expands? string[] - Fields that can be expanded in the response
- 'limit? Signed32 - Number of items to be returned per page, up to the maximum set for these objects in the current implementation
- 'start? Signed32 - Index of the first item returned in the page
jira.servicemanagement: PagedDTOAttachmentDTO
Closed record
A page of attachment results
Fields
- size? Signed32 - Number of items returned in the page
- links? PagedLinkDTO - List of the links relating to the page
- isLastPage? boolean - Indicates if this is the last page of records (true) or not (false)
- values? AttachmentDTO[] - Details of the items included in the page
- expands? string[] - Fields that can be expanded in the response
- 'limit? Signed32 - Number of items to be returned per page, up to the maximum set for these objects in the current implementation
- 'start? Signed32 - Index of the first item returned in the page
jira.servicemanagement: PagedDTOCommentDTO
Closed record
A page of comment results
Fields
- size? Signed32 - Number of items returned in the page
- links? PagedLinkDTO - List of the links relating to the page
- isLastPage? boolean - Indicates if this is the last page of records (true) or not (false)
- values? CommentDTO[] - Details of the items included in the page
- expands? string[] - Fields that can be expanded in the response
- 'limit? Signed32 - Number of items to be returned per page, up to the maximum set for these objects in the current implementation
- 'start? Signed32 - Index of the first item returned in the page
jira.servicemanagement: PagedDTOCustomerRequestDTO
Closed record
A page of customer request results
Fields
- size? Signed32 - Number of items returned in the page
- links? PagedLinkDTO - List of the links relating to the page
- isLastPage? boolean - Indicates if this is the last page of records (true) or not (false)
- values? CustomerRequestDTO[] - Details of the items included in the page
- expands? string[] - Fields that can be expanded in the response
- 'limit? Signed32 - Number of items to be returned per page, up to the maximum set for these objects in the current implementation
- 'start? Signed32 - Index of the first item returned in the page
jira.servicemanagement: PagedDTOCustomerRequestStatusDTO
Closed record
A page of customer request status results
Fields
- size? Signed32 - Number of items returned in the page
- links? PagedLinkDTO - List of the links relating to the page
- isLastPage? boolean - Indicates if this is the last page of records (true) or not (false)
- values? CustomerRequestStatusDTO[] - Details of the items included in the page
- expands? string[] - Fields that can be expanded in the response
- 'limit? Signed32 - Number of items to be returned per page, up to the maximum set for these objects in the current implementation
- 'start? Signed32 - Index of the first item returned in the page
jira.servicemanagement: PagedDTOCustomerTransitionDTO
Closed record
A page of customer transition results
Fields
- size? Signed32 - Number of items returned in the page
- links? PagedLinkDTO - List of the links relating to the page
- isLastPage? boolean - Indicates if this is the last page of records (true) or not (false)
- values? CustomerTransitionDTO[] - Details of the items included in the page
- expands? string[] - Fields that can be expanded in the response
- 'limit? Signed32 - Number of items to be returned per page, up to the maximum set for these objects in the current implementation
- 'start? Signed32 - Index of the first item returned in the page
jira.servicemanagement: PagedDTOInsightWorkspaceDTO
Closed record
A page of insight workspace results
Fields
- size? Signed32 - Number of items returned in the page
- links? PagedLinkDTO - List of the links relating to the page
- isLastPage? boolean - Indicates if this is the last page of records (true) or not (false)
- values? InsightWorkspaceDTO[] - Details of the items included in the page
- expands? string[] - Fields that can be expanded in the response
- 'limit? Signed32 - Number of items to be returned per page, up to the maximum set for these objects in the current implementation
- 'start? Signed32 - Index of the first item returned in the page
jira.servicemanagement: PagedDTOIssueBean
Closed record
A page of issue bean results
Fields
- size? Signed32 - Number of items returned in the page
- links? PagedLinkDTO - List of the links relating to the page
- isLastPage? boolean - Indicates if this is the last page of records (true) or not (false)
- values? IssueBean[] - Details of the items included in the page
- expands? string[] - Fields that can be expanded in the response
- 'limit? Signed32 - Number of items to be returned per page, up to the maximum set for these objects in the current implementation
- 'start? Signed32 - Index of the first item returned in the page
jira.servicemanagement: PagedDTOOrganizationDTO
Closed record
A page of organization results
Fields
- size? Signed32 - Number of items returned in the page
- links? PagedLinkDTO - List of the links relating to the page
- isLastPage? boolean - Indicates if this is the last page of records (true) or not (false)
- values? OrganizationDTO[] - Details of the items included in the page
- expands? string[] - Fields that can be expanded in the response
- 'limit? Signed32 - Number of items to be returned per page, up to the maximum set for these objects in the current implementation
- 'start? Signed32 - Index of the first item returned in the page
jira.servicemanagement: PagedDTOQueueDTO
Closed record
A page of queue results
Fields
- size? Signed32 - Number of items returned in the page
- links? PagedLinkDTO - List of the links relating to the page
- isLastPage? boolean - Indicates if this is the last page of records (true) or not (false)
- values? QueueDTO[] - Details of the items included in the page
- expands? string[] - Fields that can be expanded in the response
- 'limit? Signed32 - Number of items to be returned per page, up to the maximum set for these objects in the current implementation
- 'start? Signed32 - Index of the first item returned in the page
jira.servicemanagement: PagedDTORequestTypeDTO
Closed record
A page of request type results
Fields
- size? Signed32 - Number of items returned in the page
- links? PagedLinkDTO - List of the links relating to the page
- isLastPage? boolean - Indicates if this is the last page of records (true) or not (false)
- values? RequestTypeDTO[] - Details of the items included in the page
- expands? string[] - Fields that can be expanded in the response
- 'limit? Signed32 - Number of items to be returned per page, up to the maximum set for these objects in the current implementation
- 'start? Signed32 - Index of the first item returned in the page
jira.servicemanagement: PagedDTORequestTypeGroupDTO
Closed record
A page of request type group results
Fields
- size? Signed32 - Number of items returned in the page
- links? PagedLinkDTO - List of the links relating to the page
- isLastPage? boolean - Indicates if this is the last page of records (true) or not (false)
- values? RequestTypeGroupDTO[] - Details of the items included in the page
- expands? string[] - Fields that can be expanded in the response
- 'limit? Signed32 - Number of items to be returned per page, up to the maximum set for these objects in the current implementation
- 'start? Signed32 - Index of the first item returned in the page
jira.servicemanagement: PagedDTOServiceDeskDTO
Closed record
A page of service desk results
Fields
- size? Signed32 - Number of items returned in the page
- links? PagedLinkDTO - List of the links relating to the page
- isLastPage? boolean - Indicates if this is the last page of records (true) or not (false)
- values? ServiceDeskDTO[] - Details of the items included in the page
- expands? string[] - Fields that can be expanded in the response
- 'limit? Signed32 - Number of items to be returned per page, up to the maximum set for these objects in the current implementation
- 'start? Signed32 - Index of the first item returned in the page
jira.servicemanagement: PagedDTOSlaInformationDTO
Closed record
A page of sla information results
Fields
- size? Signed32 - Number of items returned in the page
- links? PagedLinkDTO - List of the links relating to the page
- isLastPage? boolean - Indicates if this is the last page of records (true) or not (false)
- values? SlaInformationDTO[] - Details of the items included in the page
- expands? string[] - Fields that can be expanded in the response
- 'limit? Signed32 - Number of items to be returned per page, up to the maximum set for these objects in the current implementation
- 'start? Signed32 - Index of the first item returned in the page
jira.servicemanagement: PagedDTOUserDTO
Closed record
A page of user results
Fields
- size? Signed32 - Number of items returned in the page
- links? PagedLinkDTO - List of the links relating to the page
- isLastPage? boolean - Indicates if this is the last page of records (true) or not (false)
- values? UserDTO[] - Details of the items included in the page
- expands? string[] - Fields that can be expanded in the response
- 'limit? Signed32 - Number of items to be returned per page, up to the maximum set for these objects in the current implementation
- 'start? Signed32 - Index of the first item returned in the page
jira.servicemanagement: PagedLinkDTO
Closed record
Pagination links of a paged response
Fields
- next? string - REST API URL for the next page, if there is one
- prev? string - REST API URL for the previous page, if there is one
- context? string - Context path of the paged resource
- self? string - REST API URL for the current page
- base? string - Base URL for the REST API calls
jira.servicemanagement: PageOfChangelogs
Closed record
A page of changelogs
Fields
- total? Signed32 - The number of results on the page
- maxResults? Signed32 - The maximum number of results that could be on the page
- histories? Changelog[] - The list of changelogs
- startAt? Signed32 - The index of the first item returned on the page
jira.servicemanagement: ProjectDetails
Closed record
Details about a project
Fields
- simplified? boolean - Whether or not the project is simplified
- avatarUrls? AvatarUrlsBean - The URLs of the project's avatars
- projectCategory? UpdatedProjectCategory - The category the project belongs to
- name? string - The name of the project
- self? string - The URL of the project details
- id? string - The ID of the project
- projectTypeKey? "software"|"service_desk"|"business"|"product_discovery" - The project type of the project
- 'key? string - The key of the project
jira.servicemanagement: PropertyKey
Closed record
Property key details
Fields
- self? string - The URL of the property
- 'key? string - The key of the property
jira.servicemanagement: PropertyKeys
Closed record
List of property keys
Fields
- keys? PropertyKey[] - Property key details
jira.servicemanagement: QueueDTO
Closed record
A queue of a service desk
Fields
- jql? string - JQL query that filters reqeusts for the queue
- links? SelfLinkDTO - REST API URL to the queue
- name? string - Short name for the queue
- id? string - ID for the queue
- fields? string[] - Fields returned for each request in the queue
- issueCount? int - The count of customer requests in the queue
jira.servicemanagement: RenderedValueDTO
Closed record
The HTML rendering of a field value
Fields
- html? string - HTML rendering of the field value
jira.servicemanagement: RequestCreateDTO
Closed record
Details of a customer request to create
Fields
- requestParticipants? string[] - List of customers to participate in the request, as a list of
accountIdvalues
- raiseOnBehalfOf? string - The
accountIdof the customer that the request is being raised on behalf of
- form? Form - Provides answers to the form associated with a request type. Omit Jira fields from
requestFieldValuesif they're linked to form answers. For form answers in ADF format, setisAdfRequestto true
- serviceDeskId? string - ID of the service desk in which to create the request
- requestTypeId? string - ID of the request type for the request
- channel? string - (Experimental) Shows extra information for the request channel
- requestFieldValues? record {} - JSON map of Jira field IDs and their values representing the content of the request
- isAdfRequest? boolean - (Experimental) Whether to accept rich text fields in Atlassian Document Format (ADF)
jira.servicemanagement: RequestFieldValidationErrorDTO
Closed record
A validation error on a request field
Fields
- 'field? string - The id of the request field that failed validation (matches a key in 'requestFieldValues')
- message? string - A human-readable explanation of why this field failed validation
jira.servicemanagement: RequestNotificationSubscriptionDTO
Closed record
Whether the user is subscribed to notifications for a request
Fields
- subscribed? boolean - Indicates whether the user is subscribed (true) or not (false) to the request's notifications
jira.servicemanagement: RequestParticipantUpdateDTO
Closed record
Participants to add to or remove from a request
Fields
- accountIds? string[] - List of users, specified by account IDs, to add to or remove as participants in the request
- usernames? string[] - This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details. Use
accountIdsinstead
jira.servicemanagement: RequestTypeCreateDTO
Closed record
Details of a request type to create
Fields
- issueTypeId? string - ID of the request type to add to the service desk
- helpText? string - Help text for the request type on the service desk
- name? string - Name of the request type on the service desk
- description? string - Description of the request type on the service desk
jira.servicemanagement: RequestTypeDTO
Closed record
A request type of a service desk
Fields
- practice? string - The request type's practice
- helpText? string - Help text for the request type
- serviceDeskId? string - ID of the service desk the request type belongs to
- links? SelfLinkDTO - REST API URL for the request type
- icon? RequestTypeIconDTO - Links to the request type's icons
- description? string - Description of the request type
- canCreateRequest? boolean - Whether the user has permission to create a request with this request type
- issueTypeId? string - ID of the issue type the request type is based upon
- groupIds? string[] - List of the request type groups the request type belongs to
- portalId? string - ID of the customer portal associated with the service desk project
- expands? string[] - List of items that can be expanded in the response by specifying the expand query parameter
- name? string - Short name for the request type
- id? string - ID for the request type
- fields? CustomerRequestCreateMetaDTO - Fields and additional metadata for creating a request that uses the request type
- restrictionStatus? "OPEN"|"RESTRICTED" - Whether request type is restricted or not
jira.servicemanagement: RequestTypeFieldDTO
Closed record
A field of a request type
Fields
- visible? boolean - Whether the field is shown on the portal
- name? string - Name of the field
- defaultValues? RequestTypeFieldValueDTO[] - List of default values for the field
- description? string - Description of the field
- presetValues? string[] - List of preset values for the field
- validValues? RequestTypeFieldValueDTO[] - List of valid values for the field
- jiraSchema? JsonTypeBean - Jira specific implementation details for the field in the UI
- required? boolean - Indicates if the field is required (true) or not (false)
- fieldId? string - ID of the field
jira.servicemanagement: RequestTypeFieldValueDTO
Closed record
A valid or preset value of a request type field
Fields
- children? RequestTypeFieldValueDTO[] - List of child fields
- label? string - Label for the field
- value? string - Value of the field
jira.servicemanagement: RequestTypeGroupDTO
Closed record
A group of request types in a service desk portal
Fields
- name? string - Name of the request type group
- id? string - ID of the request type group
jira.servicemanagement: RequestTypeIconDTO
Closed record
The icon of a request type
Fields
- links? RequestTypeIconLinkDTO - Map of the URLs for the request type icons
- id? string - ID of the request type icon
jira.servicemanagement: RequestTypeIconLinkDTO
Closed record
Links to the images of a request type icon
Fields
- iconUrls? record { string... } - URLs for the request type icons
jira.servicemanagement: RequestTypePermissionCheckRequestDTO
Closed record
Request types and permissions to check for a user
Fields
- accountId? string - The account ID of a user
- permissions? ("canCreateRequest"|"canAdminister")[] - List of requested permissions
- requestTypeIds? Signed32[] - List of request type IDs
jira.servicemanagement: RequestTypePermissionCheckResponse
Closed record
Permissions the user holds on a request type
Fields
- canAdminister? Signed32[] - List of request type IDs for which the user has permission to administer
- canCreateRequest? Signed32[] - List of request type IDs for which the user can create requests
jira.servicemanagement: RequestValidationResultDTO
Closed record
Result of validating a customer request before it is created
Fields
- valid? boolean - True when the payload is both structurally and semantically valid and safe to create
- errorMessages? string[] - General validation errors that are not attributable to a single field. Empty when valid
- reasonKey? string - A machine-readable reason key categorising the overall failure. Null when valid
- fieldErrors? RequestFieldValidationErrorDTO[] - Field-level validation errors, keyed by the failing request field id. Empty when valid
- errorMessage? string - A single, human-readable summary describing why validation failed. Null when valid
- formErrors? FormValidationErrorDTO[] - ProForma form validation errors, if a form was supplied. Empty when valid or no form was present
jira.servicemanagement: Scope
The projects the item is associated with. Indicated for items associated with next-gen projects
Fields
- project? ProjectDetails - The project the item has scope in.
- 'type? "PROJECT"|"TEMPLATE" - The type of scope.
jira.servicemanagement: SelfLinkDTO
Closed record
Link to the REST resource itself
Fields
- self? string - URL of the resource
jira.servicemanagement: ServiceDeskCustomerDTO
Closed record
Customers to add to or remove from a service desk
Fields
- accountIds? string[] - List of users, specified by account IDs, to add to or remove from a service desk
- usernames? string[] - This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details. Use
accountIdsinstead
jira.servicemanagement: ServiceDeskCustomerInviteDTO
Closed record
Details of a customer to invite to a service desk
Fields
- displayName? string - Customer's name for display in the UI
- email? string - Customer's email address
jira.servicemanagement: ServiceDeskDTO
Closed record
A service desk
Fields
- projectKey? string - Key of the peer project of the service desk
- links? SelfLinkDTO - REST API URL to the service desk
- id? string - ID of the service desk
- projectName? string - Name of the project and service desk
- projectId? string - ID of the peer project for the service desk
- projectTypeKey? string - Key of the project type
jira.servicemanagement: SimpleLink
Closed record
Details about the operations available in this version
Fields
- weight? Signed32 - Sort weight of the link
- href? string - Target URL of the link
- id? string - ID of the link
- label? string - Display label of the link
- styleClass? string - CSS style class of the link
- title? string - Title (tooltip) of the link
- iconClass? string - CSS class of the link icon
jira.servicemanagement: SlaInformationCompletedCycleDTO
Closed record
A completed cycle of an SLA metric
Fields
- goalDuration? DurationDTO - Duration within which the service should have been completed
- breachTime? DateDTO - Time and date at which the SLA cycle breached in case of completed breached cycle or would have breached in case of non-breached completed cycle
- breached? boolean - Indicates if the SLA (duration) was exceeded (true) or not (false)
- startTime? DateDTO - Time and date at which the SLA cycle started
- stopTime? DateDTO - Time and date at which the SLA cycle completed
- elapsedTime? DurationDTO - Duration in which the service was completed
- remainingTime? DurationDTO - Duration remaining after the service was completed
jira.servicemanagement: SlaInformationDTO
Closed record
SLA metric of a customer request, with its ongoing and completed cycles
Fields
- slaDisplayFormat? string - Format in which SLA is to be displayed in the UI
- ongoingCycle? SlaInformationOngoingCycleDTO - Details of the active cycle for the SLA
- links? SelfLinkDTO - REST API URL for the SLA
- completedCycles? SlaInformationCompletedCycleDTO[] - List of completed cycles for the SLA
- name? string - Description of the SLA
- id? string - ID of the Service Level Agreement (SLA)
jira.servicemanagement: SlaInformationOngoingCycleDTO
Closed record
The ongoing cycle of an SLA metric
Fields
- paused? boolean - Indicates whether the SLA is paused (true) or not (false)
- goalDuration? DurationDTO - Duration within which the service should be completed
- breachTime? DateDTO - Time and date at which the SLA cycle would have breached its limit
- breached? boolean - Indicates whether the SLA has been breached (true) or not (false)
- startTime? DateDTO - Time and date at which the SLA cycle started
- withinCalendarHours? boolean - Indicates whether the SLA it timed during calendared working hours only (true) or not (false)
- elapsedTime? DurationDTO - Duration of the service
- remainingTime? DurationDTO - Duration remaining in which to complete the service
jira.servicemanagement: SoftwareInfoDTO
Closed record
Version and build information about the Jira Service Management instance
Fields
- links? SelfLinkDTO - REST API URL of the instance
- buildChangeSet? string - Reference of the change set included in the build
- isLicensedForUse? boolean - Indicates whether the instance is licensed (true) or not (false)
- platformVersion? string - Jira Platform version upon which Service Desk is based
- buildDate? DateDTO - Date of the current build
- version? string - Jira Service Management version
jira.servicemanagement: SourceDTO
Source of a knowledge base article
Fields
- 'type? "confluence" - Type of the knowledge base source
jira.servicemanagement: StatusCategory
A status category
Fields
- colorName? string - The name of the color used to represent the status category.
- id? int - The ID of the status category.
- 'key? string - The key of the status category.
- name? string - The name of the status category.
- self? string - The URL of the status category.
jira.servicemanagement: StatusDetails
Details of an issue status
Fields
- description? string - The description of the status.
- iconUrl? string - The URL of the icon used to represent the status.
- id? string - The ID of the status.
- name? string - The name of the status.
- scope? Scope - The scope of the field.
- self? string - The URL of the status.
- statusCategory? StatusCategory - The category assigned to the status.
jira.servicemanagement: TemporaryAttachment
A file uploaded as a temporary attachment
Fields
- fileName? string - Name of the uploaded file
- temporaryAttachmentId? string - ID of the temporary attachment, used to attach it to a request
jira.servicemanagement: TemporaryAttachments
Temporary attachments created by an upload
Fields
- temporaryAttachments? TemporaryAttachment[] - The uploaded temporary attachments
jira.servicemanagement: UpdatedProjectCategory
Closed record
A project category
Fields
- name? string - The description of the project category
- description? string - The name of the project category
- self? string - The URL of the project category
- id? string - The ID of the project category
jira.servicemanagement: UserDetails
Closed record
User details permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions:
- User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case,
displayNameprovides an indication and other parameters have default values or are blank (for example, email is blank). - User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case,
accountIdreturns unknown and all other parameters have fallback values. - User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values
Fields
- accountId? string - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5
- emailAddress? string - The email address of the user. Depending on the user’s privacy settings, this may be returned as null
- avatarUrls? AvatarUrlsBean - The avatars of the user
- displayName? string - The display name of the user. Depending on the user’s privacy settings, this may return an alternative value
- accountType? string - The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)
- name? string - This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details
- active? boolean - Whether the user is active
- self? string - The URL of the user
- timeZone? string - The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null
- 'key? string - This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details
jira.servicemanagement: UserDTO
Closed record
A Jira user
Fields
- accountId? string - The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5
- emailAddress? string - Customer's email address. Depending on the customer’s privacy settings, this may be returned as null
- links? UserLinkDTO - URLs for the customer record and related items
- displayName? string - Customer's name for display in a UI. Depending on the customer’s privacy settings, this may return an alternative value
- name? string - This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details
- active? boolean - Indicates if the customer is active (true) or inactive (false)
- timeZone? string - Customer time zone. Depending on the customer’s privacy settings, this may be returned as null
- 'key? string - This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details
jira.servicemanagement: UserLinkDTO
Closed record
Links to a user in the REST API and to their avatars
Fields
- jiraRest? string - REST API URL for the customer
- avatarUrls? record { string... } - Links to the various sizes of the customer's avatar. Note that this property is deprecated, and will be removed in future versions
- self? string - REST API URL of the user
jira.servicemanagement: UsersOrganizationUpdateDTO
Users to add to or remove from an organization
Fields
- accountIds? string[] - List of customers, specific by account IDs, to add to or remove from the organization.
- organizationId? Signed32 - The organizationId in which users need to be added
- usernames? string[] - This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details. Use
accountIdsinstead.