Ballerina library

jira.servicemanagement

Module jira.servicemanagement

OverviewPrerequisitesQuickstart

API

Client

Definitions

AdditionalCommentDTO
ApprovalDecisionRequestDTO
ApprovalDTO
ApproverDTO
ArticleDTO
AttachmentCreateDTO
AttachmentCreateResultDTO
AttachmentDTO
AttachmentLinkDTO
AvatarUrlsBean
ChangeDetails
Changelog
ClientHttp1Settings
CommentCreateDTO
CommentDTO
ConnectionConfig
ContentDTO
CSATFeedbackFullDTO
CustomerCreateDTO
CustomerRequestActionDTO
CustomerRequestActionsDTO
CustomerRequestCreateMetaDTO
CustomerRequestDTO
CustomerRequestFieldValueDTO
CustomerRequestLinkDTO
CustomerRequestStatusDTO
CustomerTransitionDTO
CustomerTransitionExecutionDTO
DateDTO
DurationDTO
EntityProperty
ErrorResponse
Expandable
FieldMetadata
HistoryMetadata
HistoryMetadataParticipant
I18nErrorMessage
IncludedFields
InsightWorkspaceDTO
IssueBean
IssueTransition
IssueUpdateMetadata
JsonTypeBean
Linkable
LinkableAttachmentLinkDTO
LinkableCustomerRequestLinkDTO
LinkableUserLinkDTO
LinkGroup
OAuth2RefreshTokenGrantConfig
Operations
OrganizationCreateDTO
OrganizationDTO
OrganizationServiceDeskUpdateDTO
PagedDTOApprovalDTO
PagedDTOArticleDTO
PagedDTOAttachmentDTO
PagedDTOCommentDTO
PagedDTOCustomerRequestDTO
PagedDTOCustomerRequestStatusDTO
PagedDTOCustomerTransitionDTO
PagedDTOInsightWorkspaceDTO
PagedDTOIssueBean
PagedDTOOrganizationDTO
PagedDTOQueueDTO
PagedDTORequestTypeDTO
PagedDTORequestTypeGroupDTO
PagedDTOServiceDeskDTO
PagedDTOSlaInformationDTO
PagedDTOUserDTO
PagedLinkDTO
PageOfChangelogs
PropertyKey
PropertyKeys
ProxyConfig
QueueDTO
RenderedValueDTO
RequestCreateDTO
RequestNotificationSubscriptionDTO
RequestParticipantUpdateDTO
RequestTypeCreateDTO
RequestTypeDTO
RequestTypeFieldDTO
RequestTypeFieldValueDTO
RequestTypeGroupDTO
RequestTypeIconDTO
RequestTypeIconLinkDTO
SelfLinkDTO
ServiceDeskCustomerDTO
ServiceDeskDTO
SimpleLinkSlaInformationCompletedCycleDTO
SlaInformationDTO
SlaInformationOngoingCycleDTO
SoftwareInfoDTO
SourceDTO
StatusCategory
StatusDetails
UserDetails
UserDTO
UserLinkDTO
UsersOrganizationUpdateDTO

ballerinax/jira.servicemanagement Ballerina library

1.3.1

Overview

This is a generated connector for Jira Service Management Cloud REST API OpenAPI specification.

The Jira Service Management Cloud REST APIs are for developers who want to integrate Jira Service Management with other applications or administrators that want to automate their workflows and processes.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

  • Create Atlassian Account
  • Obtaining tokens
    1. Log into Atlassian Account
    2. If you are using basic authentication navigate to Account Settings -> Security and click -> Create and manage API tokens and create API token. If you are using OAuth authentication navigate to Account Settings -> Security and click -> Manage two-step verification and create and obtain client credentials

Quickstart

Step 1: Import Jira module

First, import the ballerinax/jira.servicemanagement module into the Ballerina project.

Copy
import ballerinax/jira.servicemanagement as jira;

Step 2: Configure the connection credentials.

Copy
jira:ClientConfig clientConfig = {
    auth : { 
        username : "<your_atlassian_account_email>", 
        password : "<atlassian_account_api_key>"
    }
};

jira:Client myclient = check new (clientConfig, "https://<your_domain>.atlassian.net");

Step 3: Invoke connector operation

  1. You can use this function to get customers by providing service desk Id as a parameter. 
    Copy
    jira:PagedDTOUserDTO result = check myclient->getCustomers("<ServiceDeskId>");
log:printInfo(result.toString());
  2. Use bal run command to compile and run the Ballerina program

Clients

jira.servicemanagement: Client

Isolated

This is a generated connector for Jira Service Management Cloud REST API OpenAPI specification. The Jira Service Management Cloud REST APIs are for developers who want to integrate Jira Service Management with other applications or administrators that want to automate their workflows and processes.

Constructor

Gets invoked to initialize the connector. The connector initialization requires setting the API credentials. Create an Atlassian Account and obtain tokens by following this guide.

init (ConnectionConfig config, string serviceUrl)
  • config ConnectionConfig - The configurations to be used when initializing the connector
  • serviceUrl string - URL of the target service

createCustomer

Isolated FunctionRemote Function
function createCustomer(CustomerCreateDTO payload) returns UserDTO|error

Create customer

Parameters
Return Type

getInfo

Isolated FunctionRemote Function
function getInfo() returns SoftwareInfoDTO|error

Get info

Return Type

getInsightWorkspaces

Isolated FunctionRemote Function
function getInsightWorkspaces(int 'start, int 'limit) returns PagedDTOInsightWorkspaceDTO|error

Get insight workspaces

Parameters
  • 'start int (default 0) - The starting index of the returned workspace IDs. Base index: 0 See the Pagination section for more details.
  • 'limit int (default 50) - The maximum number of workspace IDs to return per page. Default: 50 See the Pagination section for more details.
Return Type

getArticles

Isolated FunctionRemote Function
function getArticles(string? query, boolean highlight, int? 'start, int? 'limit) returns PagedDTOArticleDTO|error

Get articles

Parameters
  • query string? (default ()) - The string used to filter the articles (required).
  • highlight boolean (default false) - If set to true matching query term in the title and excerpt will be highlighted using the {@code @@@hl@@@term@@@endhl@@@} syntax. Default: false.
  • 'start int? (default ()) - The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
  • 'limit int? (default ()) - The maximum number of items to return per page. Default: 100. See the Pagination section for more details.
Return Type

getOrganizations

Isolated FunctionRemote Function
function getOrganizations(int? 'start, int? 'limit, string? accountId) returns PagedDTOOrganizationDTO|error

Get organizations

Parameters
  • 'start int? (default ()) - The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
  • 'limit int? (default ()) - The maximum number of organizations to return per page. Default: 50. See the Pagination section for more details.
  • accountId string? (default ()) - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
Return Type

createOrganization

Isolated FunctionRemote Function
function createOrganization(OrganizationCreateDTO payload) returns OrganizationDTO|error

Create organization

Parameters
Return Type
  • OrganizationDTO|error - Returns the created organization or the existing organization if name already exists.

getOrganization

Isolated FunctionRemote Function
function getOrganization(int organizationId) returns OrganizationDTO|error

Get organization

Parameters
  • organizationId int - The ID of the organization.
Return Type

deleteOrganization

Isolated FunctionRemote Function
function deleteOrganization(int organizationId) returns Response|error

Delete organization

Parameters
  • organizationId int - The ID of the organization.
Return Type

getPropertiesKeys

Isolated FunctionRemote Function
function getPropertiesKeys(string organizationId) returns PropertyKeys|error

Get properties keys

Parameters
  • organizationId string - The ID of the organization from which keys will be returned.
Return Type

getProperty

Isolated FunctionRemote Function
function getProperty(string organizationId, string propertyKey) returns EntityProperty|error

Get 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

setProperty

Isolated FunctionRemote Function
function setProperty(string organizationId, string propertyKey) returns json|error

Set 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.
Return Type
  • json|error - Returned if the organization property was updated.

deleteProperty

Isolated FunctionRemote Function
function deleteProperty(string organizationId, string propertyKey) returns Response|error

Delete 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
  • Response|error - Returned if the organization property was removed.

getUsersInOrganization

Isolated FunctionRemote Function
function getUsersInOrganization(int organizationId, int? 'start, int? 'limit) returns PagedDTOUserDTO|error

Get users in organization

Parameters
  • organizationId int - The ID of the organization.
  • 'start int? (default ()) - The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
  • 'limit int? (default ()) - The maximum number of users to return per page. Default: 50. See the Pagination section for more details.
Return Type
  • PagedDTOUserDTO|error - Returns a paged list of users associated with the organization, ordered by their accountId.

addUsersToOrganization

Isolated FunctionRemote Function
function addUsersToOrganization(int organizationId, UsersOrganizationUpdateDTO payload) returns Response|error

Add users to organization

Parameters
  • organizationId int - The ID of the organization.
Return Type
  • Response|error - Returned if all the users were valid and added to the organization, no response payload is provided.

getCustomerRequests

Isolated FunctionRemote Function
function getCustomerRequests(string? searchTerm, string[]? requestOwnership, string? requestStatus, string? approvalStatus, int? organizationId, int? serviceDeskId, int? requestTypeId, string[]? expand, int? 'start, int? 'limit) returns PagedDTOCustomerRequestDTO|error

Get customer requests

Parameters
  • searchTerm string? (default ()) - Filters customer requests where the request summary matches the searchTerm. Wildcards can be used in the searchTerm parameter.
  • requestOwnership string[]? (default ()) - Filters customer requests using the following values: * OWNED_REQUESTS returns customer requests where the user is the creator. * PARTICIPATED_REQUESTS returns customer requests where the user is a participant. * ORGANIZATION returns customer requests for an organization of which the user is a member when used in conjunction with organizationId. * ALL_ORGANIZATIONS returns customer requests that belong to all organizations of which the user is a member. * APPROVER returns customer requests where the user is an approver. Can be used in conjunction with approvalStatus to filter pending or complete approvals. * ALL_REQUESTS returns 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. Multiple values of the query parameter are supported. For example, requestOwnership=OWNED_REQUESTS&requestOwnership=PARTICIPATED_REQUESTS will only return customer requests where the user is the creator or a participant. If not specified, filtering defaults to OWNED_REQUESTS, PARTICIPATED_REQUESTS, and ALL_ORGANIZATIONS.
  • requestStatus string? (default ()) - Filters customer requests where the request is closed, open, or either of the two where: * CLOSED_REQUESTS returns customer requests that are closed. * OPEN_REQUESTS returns customer requests that are open. * ALL_REQUESTS returns all customer requests.
  • approvalStatus string? (default ()) - Filters results to customer requests based on their approval status: * MY_PENDING_APPROVAL returns customer requests pending the user's approval. * MY_HISTORY_APPROVAL returns customer requests where the user was an approver. Note: Valid only when used with requestOwnership=APPROVER.
  • organizationId int? (default ()) - 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.
  • serviceDeskId int? (default ()) - Filters customer requests by service desk.
  • requestTypeId int? (default ()) - Filters customer requests by request type. Note that the serviceDeskId must be specified for the service desk in which the request type belongs.
  • expand string[]? (default ()) - A multi-value parameter indicating which properties of the customer request to expand, where: * serviceDesk returns additional details for each service desk. * requestType returns additional details for each request type. * participant returns the participant details, if any, for each customer request. * sla returns the SLA information on each customer request. * status returns the status transitions, in chronological order, for each customer request. * attachment returns the attachments for the customer request. * action returns the actions that the user can or cannot perform on this customer request. * comment returns the comments, if any, for each customer request. * comment.attachment returns 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.
  • 'start int? (default ()) - The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
  • 'limit int? (default ()) - The maximum number of items to return per page. Default: 50. See the Pagination section for more details.
Return Type

createCustomerRequest

Isolated FunctionRemote Function
function createCustomerRequest(RequestCreateDTO payload) returns CustomerRequestDTO|error

Create customer request

Parameters
Return Type

getCustomerRequestByIdOrKey

Isolated FunctionRemote Function
function getCustomerRequestByIdOrKey(string issueIdOrKey, string[]? expand) returns CustomerRequestDTO|error

Get customer request by id or key

Parameters
  • issueIdOrKey string - The ID or Key of the customer request to be returned
  • expand string[]? (default ()) - A multi-value parameter indicating which properties of the customer request to expand, where: * serviceDesk returns additional service desk details. * requestType returns additional customer request type details. * participant returns the participant details. * sla returns the SLA information. * status returns the status transitions, in chronological order. * attachment returns the attachments. * action returns the actions that the user can or cannot perform. * comment returns the comments. * comment.attachment returns 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.
Return Type

getApprovals

Isolated FunctionRemote Function
function getApprovals(string issueIdOrKey, int? 'start, int? 'limit) returns PagedDTOApprovalDTO|error

Get approvals

Parameters
  • issueIdOrKey string - The ID or key of the customer request to be queried for its approvals.
  • 'start int? (default ()) - The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
  • 'limit int? (default ()) - The maximum number of approvals to return per page. Default: 50. See the Pagination section for more details.
Return Type

getApprovalById

Isolated FunctionRemote Function
function getApprovalById(string issueIdOrKey, int approvalId) returns ApprovalDTO|error

Get approval by id

Parameters
  • issueIdOrKey string - The ID or key of the customer request the approval is on.
  • approvalId int - The ID of the approval to be returned.
Return Type

answerApproval

Isolated FunctionRemote Function
function answerApproval(string issueIdOrKey, int approvalId, ApprovalDecisionRequestDTO payload) returns ApprovalDTO|error

Answer approval

Parameters
  • issueIdOrKey string - The ID or key of the customer request to be updated.
  • approvalId int - The ID of the approval to be updated.
Return Type

getAttachmentsForRequest

Isolated FunctionRemote Function
function getAttachmentsForRequest(string issueIdOrKey, int? 'start, int? 'limit) returns PagedDTOAttachmentDTO|error

Get attachments for request

Parameters
  • issueIdOrKey string - The ID or key of the customer request from which the attachments will be listed.
  • 'start int? (default ()) - The starting index of the returned attachment. Base index: 0. See the Pagination section for more details.
  • 'limit int? (default ()) - The maximum number of comments to return per page. Default: 50. See the Pagination section for more details.
Return Type

createAttachment

Isolated FunctionRemote Function
function createAttachment(string issueIdOrKey, AttachmentCreateDTO payload) returns AttachmentCreateResultDTO|error

Create attachment

Parameters
  • issueIdOrKey string - The ID or key of the customer request to which the attachment will be added.
Return Type

getRequestComments

Isolated FunctionRemote Function
function getRequestComments(string issueIdOrKey, boolean? 'public, boolean? internal, string[]? expand, int? 'start, int? 'limit) returns PagedDTOCommentDTO|error

Get request comments

Parameters
  • issueIdOrKey string - The ID or key of the customer request whose comments will be retrieved.
  • 'public boolean? (default ()) - Specifies whether to return public comments or not. Default: true.
  • internal boolean? (default ()) - Specifies whether to return internal comments or not. Default: true.
  • expand string[]? (default ()) - A multi-value parameter indicating which properties of the comment to expand: * attachment returns 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.
  • 'start int? (default ()) - The starting index of the returned comments. Base index: 0. See the Pagination section for more details.
  • 'limit int? (default ()) - The maximum number of comments to return per page. Default: 50. See the Pagination section for more details.
Return Type

createRequestComment

Isolated FunctionRemote Function
function createRequestComment(string issueIdOrKey, CommentCreateDTO payload) returns CommentDTO|error

Create request comment

Parameters
  • issueIdOrKey string - The ID or key of the customer request to which the comment will be added.
Return Type

getRequestCommentById

Isolated FunctionRemote Function
function getRequestCommentById(string issueIdOrKey, int commentId, string[]? expand) returns CommentDTO|error

Get 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.
  • expand string[]? (default ()) - A multi-value parameter indicating which properties of the comment to expand: * attachment returns 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.
Return Type

getCommentAttachments

Isolated FunctionRemote Function
function getCommentAttachments(string issueIdOrKey, int commentId, int? 'start, int? 'limit) returns PagedDTOAttachmentDTO|error

Get comment attachments

Parameters
  • issueIdOrKey string - The ID or key of the customer request that contains the comment.
  • commentId int - The ID of the comment.
  • 'start int? (default ()) - The starting index of the returned comments. Base index: 0. See the Pagination section for more details.
  • 'limit int? (default ()) - The maximum number of comments to return per page. Default: 50. See the Pagination section for more details.
Return Type

getSubscriptionStatus

Isolated FunctionRemote Function
function getSubscriptionStatus(string issueIdOrKey) returns RequestNotificationSubscriptionDTO|error

Get subscription status

Parameters
  • issueIdOrKey string - The ID or key of the customer request to be queried for subscription status.
Return Type

subscribe

Isolated FunctionRemote Function
function subscribe(string issueIdOrKey) returns Response|error

Subscribe

Parameters
  • issueIdOrKey string - The ID or key of the customer request to be subscribed to.
Return Type

unsubscribe

Isolated FunctionRemote Function
function unsubscribe(string issueIdOrKey) returns Response|error

Unsubscribe

Parameters
  • issueIdOrKey string - The ID or key of the customer request to be unsubscribed from.
Return Type

getRequestParticipants

Isolated FunctionRemote Function
function getRequestParticipants(string issueIdOrKey, int? 'start, int? 'limit) returns PagedDTOUserDTO|error

Get request participants

Parameters
  • issueIdOrKey string - The ID or key of the customer request to be queried for its participants.
  • 'start int? (default ()) - The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
  • 'limit int? (default ()) - The maximum number of request types to return per page. Default: 50. See the Pagination section for more details.
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) returns PagedDTOUserDTO|error

Add request participants

Parameters
  • issueIdOrKey string - The ID or key of the customer request to have participants added.
Return Type

getSlaInformation

Isolated FunctionRemote Function
function getSlaInformation(string issueIdOrKey, int? 'start, int? 'limit) returns PagedDTOSlaInformationDTO|error

Get sla information

Parameters
  • issueIdOrKey string - The ID or key of the customer request whose SLAs will be retrieved.
  • 'start int? (default ()) - The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
  • 'limit int? (default ()) - The maximum number of request types to return per page. Default: 50. See the Pagination section for more details.
Return Type

getSlaInformationById

Isolated FunctionRemote Function
function getSlaInformationById(string issueIdOrKey, int slaMetricId) returns SlaInformationDTO|error

Get 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

getCustomerRequestStatus

Isolated FunctionRemote Function
function getCustomerRequestStatus(string issueIdOrKey, int? 'start, int? 'limit) returns PagedDTOCustomerRequestStatusDTO|error

Get customer request status

Parameters
  • issueIdOrKey string - The ID or key of the customer request to be retrieved.
  • 'start int? (default ()) - The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
  • 'limit int? (default ()) - The maximum number of items to return per page. Default: 50. See the Pagination section for more details.
Return Type

getCustomerTransitions

Isolated FunctionRemote Function
function getCustomerTransitions(string issueIdOrKey, int? 'start, int? 'limit) returns PagedDTOCustomerTransitionDTO|error

Get customer transitions

Parameters
  • issueIdOrKey string - The ID or key of the customer request whose transitions will be retrieved.
  • 'start int? (default ()) - The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
  • 'limit int? (default ()) - The maximum number of items to return per page. Default: 100. See the Pagination section for more details.
Return Type

performCustomerTransition

Isolated FunctionRemote Function
function performCustomerTransition(string issueIdOrKey, CustomerTransitionExecutionDTO payload) returns Response|error

Perform customer transition

Parameters
  • issueIdOrKey string - ID or key of the issue to transition
Return Type

getFeedback

Isolated FunctionRemote Function
function getFeedback(string requestIdOrKey) returns CSATFeedbackFullDTO|error

Get feedback

Parameters
  • requestIdOrKey string - The id or the key of the request to post the feedback on
Return Type

postFeedback

Isolated FunctionRemote Function
function postFeedback(string requestIdOrKey, CSATFeedbackFullDTO payload) returns CSATFeedbackFullDTO|error

Post feedback

Parameters
  • requestIdOrKey string - The id or the key of the request to post the feedback on
Return Type

deleteFeedback

Isolated FunctionRemote Function
function deleteFeedback(string requestIdOrKey) returns json|error

Delete feedback

Parameters
  • requestIdOrKey string - The id or the key of the request to post the feedback on
Return Type
  • json|error - No content.

getAllRequestTypes

Isolated FunctionRemote Function
function getAllRequestTypes(string? searchQuery, int[]? serviceDeskId, int? 'start, int? 'limit, string[]? expand) returns PagedDTORequestTypeDTO|error

Get all request types

Parameters
  • searchQuery string? (default ()) - String to be used to filter the results.
  • serviceDeskId int[]? (default ()) - Filter the request types by service desk Ids provided. Multiple values of the query parameter are supported. For example, serviceDeskId=1&serviceDeskId=2 will return request types only for service desks 1 and 2.
  • 'start int? (default ()) - The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
  • 'limit int? (default ()) - The maximum number of items to return per page. Default: 100. See the Pagination section for more details.
  • expand string[]? (default ()) - Expand
Return Type

getServiceDesks

Isolated FunctionRemote Function
function getServiceDesks(int? 'start, int? 'limit) returns PagedDTOServiceDeskDTO|error

Get service desks

Parameters
  • 'start int? (default ()) - The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
  • 'limit int? (default ()) - The maximum number of items to return per page. Default: 100. See the Pagination section for more details.
Return Type

getServiceDeskById

Isolated FunctionRemote Function
function getServiceDeskById(string serviceDeskId) returns ServiceDeskDTO|error

Get service desk by id

Parameters
Return Type

attachTemporaryFile

Isolated FunctionRemote Function
function attachTemporaryFile(string serviceDeskId, byte[] payload) returns json|error

Attach 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 byte[] - The attachments in a RFC 1867 multipart/form-data format.
Return Type
  • json|error - Returns if the file(s) were attached.

getCustomers

Isolated FunctionRemote Function
function getCustomers(string serviceDeskId, string? query, int? 'start, int? 'limit) returns PagedDTOUserDTO|error

Get customers

Parameters
  • serviceDeskId string - The ID of the service desk the customer list should be returned from. This can alternatively be a project identifier.
  • query string? (default ()) - The string used to filter the customer list.
  • 'start int? (default ()) - The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
  • 'limit int? (default ()) - The maximum number of users to return per page. Default: 50. See the Pagination section for more details.
Return Type

addCustomers

Isolated FunctionRemote Function
function addCustomers(string serviceDeskId, ServiceDeskCustomerDTO payload) returns Response|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.
Return Type
  • Response|error - Returned if all the customers were added to the service desk or were already associated with the service desk.

getArticlesByServiceDeskId

Isolated FunctionRemote Function
function getArticlesByServiceDeskId(string serviceDeskId, string? query, boolean highlight, int? 'start, int? 'limit) returns PagedDTOArticleDTO|error

Get articles

Parameters
  • serviceDeskId string - Servicedesk Id
  • query string? (default ()) - The string used to filter the articles (required).
  • highlight boolean (default false) - If set to true matching query term in the title and excerpt will be highlighted using the {@code
  • 'start int? (default ()) - The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
  • 'limit int? (default ()) - The maximum number of items to return per page. Default: 100. See the Pagination section for more details.
Return Type

getOrganizationsByServiceDeskId

Isolated FunctionRemote Function
function getOrganizationsByServiceDeskId(string serviceDeskId, int? 'start, int? 'limit, string? accountId) returns PagedDTOOrganizationDTO|error

Get organizations

Parameters
  • serviceDeskId string - The ID of the service desk from which the organization list will be returned. This can alternatively be a project identifier.
  • 'start int? (default ()) - The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
  • 'limit int? (default ()) - The maximum number of items to return per page. Default: 50. See the Pagination section for more details.
  • accountId string? (default ()) - The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
Return Type

addOrganization

Isolated FunctionRemote Function
function addOrganization(string serviceDeskId, OrganizationServiceDeskUpdateDTO payload) returns Response|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.
Return Type
  • Response|error - Returned if the organization was added or the organization was already associated with the service desk.

getQueues

Isolated FunctionRemote Function
function getQueues(string serviceDeskId, boolean includeCount, int? 'start, int? 'limit) returns PagedDTOQueueDTO|error

Get queues

Parameters
  • serviceDeskId string - ID of the service desk whose queues will be returned. This can alternatively be a project identifier.
  • includeCount boolean (default false) - Specifies whether to include each queue's customer request (issue) count in the response.
  • 'start int? (default ()) - The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
  • 'limit int? (default ()) - The maximum number of items to return per page. Default: 50. See the Pagination section for more details.
Return Type

getQueue

Isolated FunctionRemote Function
function getQueue(string serviceDeskId, int queueId, boolean includeCount) returns QueueDTO|error

Get 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.
  • includeCount boolean (default false) - Specifies whether to include each queue's customer request (issue) count in the response.
Return Type
  • QueueDTO|error - Returns the specific queue of the service desk.

getIssuesInQueue

Isolated FunctionRemote Function
function getIssuesInQueue(string serviceDeskId, int queueId, int? 'start, int? 'limit) returns PagedDTOIssueBean|error

Get 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.
  • 'start int? (default ()) - The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
  • 'limit int? (default ()) - The maximum number of items to return per page. Default: 50. See the Pagination section for more details.
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, int? groupId, string[]? expand, string? searchQuery, int? 'start, int? 'limit) returns PagedDTORequestTypeDTO|error

Get 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.
  • groupId int? (default ()) - Filters results to those in a customer request type group.
  • expand string[]? (default ()) - Expand
  • searchQuery string? (default ()) - The string to be used to filter the results.
  • 'start int? (default ()) - The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
  • 'limit int? (default ()) - The maximum number of items to return per page. Default: 100. See the Pagination section for more details.
Return Type

createRequestType

Isolated FunctionRemote Function
function createRequestType(string serviceDeskId, RequestTypeCreateDTO payload) returns RequestTypeDTO|error

Create 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.
Return Type

getRequestTypeById

Isolated FunctionRemote Function
function getRequestTypeById(string serviceDeskId, int requestTypeId, string[]? expand) returns RequestTypeDTO|error

Get 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 int - The ID of the customer request type to be returned.
  • expand string[]? (default ()) - Expand
Return Type

deleteRequestType

Isolated FunctionRemote Function
function deleteRequestType(string serviceDeskId, int requestTypeId) returns Response|error

Delete request type

Parameters
  • requestTypeId int - The ID of the request type.
Return Type

getRequestTypeFields

Isolated FunctionRemote Function
function getRequestTypeFields(string serviceDeskId, int requestTypeId, string[]? expand) returns CustomerRequestCreateMetaDTO|error

Get 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 int - The ID of the request types whose fields are to be returned.
  • expand string[]? (default ()) - Use expand to include additional information in the response. This parameter accepts hiddenFields that returns hidden fields associated with the request type.
Return Type

getPropertiesKeysByServiceDeskId

Isolated FunctionRemote Function
function getPropertiesKeysByServiceDeskId(int requestTypeId, string serviceDeskId) returns PropertyKeys|error

Get properties keys

Parameters
  • requestTypeId int - 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

getPropertyByServiceDeskId

Isolated FunctionRemote Function
function getPropertyByServiceDeskId(string serviceDeskId, int requestTypeId, string propertyKey) returns EntityProperty|error

Get property

Parameters
  • serviceDeskId string - The ID of the service desk which contains the request type. This can alternatively be a project identifier.
  • requestTypeId int - The ID of the request type from which the property will be retrieved.
  • propertyKey string - The key of the property to return.
Return Type

setPropertyByServiceDeskId

Isolated FunctionRemote Function
function setPropertyByServiceDeskId(string serviceDeskId, int requestTypeId, string propertyKey) returns json|error

Set property

Parameters
  • serviceDeskId string - The ID of the service desk which contains the request type. This can alternatively be a project identifier.
  • requestTypeId int - 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.
Return Type
  • json|error - Returned if the request type property is updated.

deletePropertyByServiceDeskId

Isolated FunctionRemote Function
function deletePropertyByServiceDeskId(string serviceDeskId, int requestTypeId, string propertyKey) returns Response|error

Delete property

Parameters
  • serviceDeskId string - The ID of the service desk which contains the request type. This can alternatively be a project identifier.
  • requestTypeId int - The ID of the request type for which the property will be removed.
  • propertyKey string - The key of the property to remove.
Return Type
  • Response|error - Returned if the request type property was removed.

getRequestTypeGroups

Isolated FunctionRemote Function
function getRequestTypeGroups(string serviceDeskId, int? 'start, int? 'limit) returns PagedDTORequestTypeGroupDTO|error

Get 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.
  • 'start int? (default ()) - The starting index of the returned objects. Base index: 0. See the Pagination section for more details.
  • 'limit int? (default ()) - The maximum number of items to return per page. Default: 100. See the Pagination section for more details.
Return Type

Records

jira.servicemanagement: AdditionalCommentDTO

Fields
  • body string? - Content of the comment.

jira.servicemanagement: ApprovalDecisionRequestDTO

Fields
  • decision string? - Response to the approval request.

jira.servicemanagement: ApprovalDTO

Fields
  • id string? - ID of the approval.
  • name string? - Description of the approval being sought or provided.
  • finalDecision string? - Outcome of the approval, based on the approvals provided by all approvers.
  • canAnswerApproval boolean? - Indicates whether the user making the request is one of the approvers and can respond to the approval (true) or not (false).
  • approvers ApproverDTO[]? - Detailed list of the users who must provide a response to the approval.
  • createdDate DateDTO? - Date the approval was created.
  • completedDate DateDTO? - Date the approval was completed.
  • _links SelfLinkDTO? - The REST API URL of the approval.

jira.servicemanagement: ApproverDTO

Fields
  • approver UserDTO? - Details of the User who is providing approval.
  • approverDecision string? - Decision made by the approver.

jira.servicemanagement: ArticleDTO

Fields
  • title string? - Title of the article.
  • excerpt string? - Excerpt of the article which matches the given query string.

jira.servicemanagement: AttachmentCreateDTO

Fields
  • temporaryAttachmentIds string[]? - List of IDs for the temporary attachments to be added to the customer request.
  • 'public boolean? - Indicates whether the attachments are to be public (true) or private/internal (false).

jira.servicemanagement: AttachmentCreateResultDTO

Fields
  • comment CommentDTO? - Details of the comment included with the attachments.

jira.servicemanagement: AttachmentDTO

Fields
  • filename string? - Filename of the item attached.
  • author UserDTO? - Details of the user who attached the file.
  • created DateDTO? - Date the attachment was added.
  • size int? - Size of the attachment in bytes.
  • mimeType string? - MIME type of the attachment.

jira.servicemanagement: AttachmentLinkDTO

Fields
  • jiraRest string? - REST API URL for the attachment
  • content string? - URL for the attachment.
  • thumbnail string? - URL for the attachment's thumbnail image.

jira.servicemanagement: AvatarUrlsBean

Fields
  • '16x16 string? - The URL of the item's 16x16 pixel avatar.
  • '24x24 string? - The URL of the item's 24x24 pixel avatar.
  • '32x32 string? - The URL of the item's 32x32 pixel avatar.
  • '48x48 string? - The URL of the item's 48x48 pixel avatar.

jira.servicemanagement: ChangeDetails

A change item.

Fields
  • 'field string? - The name of the field changed.
  • fieldtype string? - The type of the field changed.
  • fieldId string? - The ID of the field changed.
  • 'from string? - The details of the original value.
  • fromString string? - The details of the original value as a string.
  • to string? - The details of the new value.
  • toString string? - The details of the new value as a string.

jira.servicemanagement: Changelog

A changelog.

Fields
  • id string? - The ID of the changelog.
  • created string? - The date on which the change took place.
  • historyMetadata HistoryMetadata? - The history metadata associated with the changed.

jira.servicemanagement: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields
  • keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
  • chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

jira.servicemanagement: CommentCreateDTO

Fields
  • body string? - Content of the comment.
  • 'public boolean? - Indicates whether the comment is public (true) or private/internal (false).

jira.servicemanagement: CommentDTO

Fields
  • id string? - ID of the comment.
  • body string? - Content of the comment.
  • author UserDTO? - Details of the customer who authored 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.
  • 'public boolean? - Indicates whether the comment is public (true) or private/internal (false).
  • _links SelfLinkDTO? - REST API URL link to the comment.

jira.servicemanagement: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields
  • httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
  • timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
  • forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header
  • cache CacheConfig? - 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
  • validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

jira.servicemanagement: ContentDTO

Fields
  • iframeSrc string? - Url containing the body of the article (without title), suitable for rendering in an iframe

jira.servicemanagement: CSATFeedbackFullDTO

Fields
  • 'type string? - Indicates the type of feedback, supported values: csat.
  • rating int? - A numeric representation of the rating, this must be an integer value between 1 and 5.

jira.servicemanagement: CustomerCreateDTO

Fields
  • email string? - Customer's email address.
  • fullName string? - Deprecated, please use 'displayName'.
  • displayName string? - Customer's name for display in the UI.

jira.servicemanagement: CustomerRequestActionDTO

Fields
  • allowed boolean? - Indicates whether the user can undertake the action (true) or not (false).

jira.servicemanagement: CustomerRequestActionsDTO

Fields

jira.servicemanagement: CustomerRequestCreateMetaDTO

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.

jira.servicemanagement: CustomerRequestDTO

Fields
  • issueId string? - ID of the request, as the peer issue ID.
  • issueKey string? - Key of the request, as the peer issue key.
  • requestTypeId string? - ID of the request type for the request.
  • serviceDeskId string? - ID of the service desk the request belongs to.
  • createdDate DateDTO? - Date on which the request was created.
  • reporter UserDTO? - Details of the customer reporting the request.
  • participants PagedDTOUserDTO? - Expandable details of the customers participating in the request.
  • _expands string[]? - List of items that can be expanded in the response by specifying the expand query parameter.

jira.servicemanagement: CustomerRequestFieldValueDTO

Fields
  • fieldId string? - ID of the field.
  • label string? - Text label for the field.
  • value anydata? - Value of the field.
  • renderedValue record {}? - Value of the field rendered in the UI.

jira.servicemanagement: CustomerRequestLinkDTO

Fields
  • jiraRest string? - REST API URL for the request.
  • web string? - Web URL for the request.
  • agent string? - Jira agent view URL for the request.

jira.servicemanagement: CustomerRequestStatusDTO

Fields
  • status string? - Name of the status condition.
  • statusCategory string? - Status category the status belongs to.
  • statusDate DateDTO? - Date on which the status was attained.

jira.servicemanagement: CustomerTransitionDTO

Fields
  • id string? - ID of the transition.
  • name string? - Name of the transition.

jira.servicemanagement: CustomerTransitionExecutionDTO

Fields
  • id string? - ID of the transition to be performed.

jira.servicemanagement: DateDTO

Fields
  • iso8601 string? - Date in ISO8601 format.
  • 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.
  • friendly string? - Date in a user-friendly text format.
  • epochMillis int? - Date as the number of milliseconds that have elapsed since 00:00:00 Coordinated Universal Time (UTC), 1 January 1970.

jira.servicemanagement: DurationDTO

Fields
  • millis int? - Duration in milliseconds.
  • friendly string? - Duration in a user-friendly text format.

jira.servicemanagement: EntityProperty

An entity property, for more information see Entity properties.

Fields
  • 'key string? - The key of the property. Required on create and update.
  • value anydata? - The value of the property. Required on create and update.

jira.servicemanagement: ErrorResponse

Fields

jira.servicemanagement: Expandable

Fields

jira.servicemanagement: FieldMetadata

The metadata describing an issue field.

Fields
  • required boolean - Whether the field is required.
  • name string - The name of the field.
  • 'key string - The key of the field.
  • autoCompleteUrl string? - The URL that can be used to automatically complete the field.
  • hasDefaultValue boolean? - Whether the field has a default value.
  • operations string[] - The list of operations that can be performed on the field.
  • allowedValues anydata[]? - The list of values allowed in the field.
  • defaultValue anydata? - The default value of the field.

jira.servicemanagement: HistoryMetadata

Details of issue history metadata.

Fields
  • 'type string? - The type of the history record.
  • description string? - The description of the history record.
  • descriptionKey string? - The description key of the history record.
  • activityDescription string? - The activity described in the history record.
  • activityDescriptionKey string? - The key of the activity described in 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 {}? - Additional arbitrary information about the history record.

jira.servicemanagement: HistoryMetadataParticipant

Details of user or system associated with a issue history metadata item.

Fields
  • id string? - The ID of 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.
  • 'type string? - The type of the user or system associated with a history record.
  • avatarUrl string? - The URL to an avatar for 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: I18nErrorMessage

Fields

jira.servicemanagement: IncludedFields

Fields

jira.servicemanagement: InsightWorkspaceDTO

Details of an insight workspace ID.

Fields
  • workspaceId string? - The workspace ID used as the identifier to access the Insight REST API.

jira.servicemanagement: IssueBean

Details about an issue.

Fields
  • expand string? - Expand options that include additional issue details in the response.
  • id string? - The ID of the issue.
  • self string? - The URL of the issue details.
  • 'key string? - The key of the issue.
  • renderedFields record {}? - The rendered value of each field present on the issue.
  • properties record {}? - Details of the issue properties identified in the request.
  • names record {}? - The ID and name of each field present on the issue.
  • schema record {}? - The schema describing each field present on the issue.
  • transitions IssueTransition[]? - The transitions that can be performed on the issue.
  • operations Operations? - The operations that can be performed on the issue.
  • versionedRepresentations record {}? - The versions of each field on the issue.
  • fields record {}? -

jira.servicemanagement: IssueTransition

Details of an issue transition.

Fields
  • id string? - The ID of the issue transition. Required when specifying a transition to undertake.
  • name string? - The name of the issue transition.
  • to StatusDetails? - Details of the issue status after the transition.
  • hasScreen boolean? - Whether there is a screen associated with the issue transition.
  • 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.
  • 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.
  • fields record {}? - Details of the fields associated with the issue transition screen. Use this information to populate fields and update in a transition request.
  • expand string? - Expand options that include additional transition details in the response.

jira.servicemanagement: IssueUpdateMetadata

A list of editable field details.

Fields
  • fields record {}? -

jira.servicemanagement: JsonTypeBean

The schema of a field.

Fields
  • 'type string - The data type of the field.
  • items string? - When the data type is an array, the name of the field items within the array.
  • system string? - If the field is a system field, the name of the field.
  • custom string? - If the field is a custom field, the URI of the field.
  • customId int? - If the field is a custom field, the custom ID of the field.
  • configuration record {}? - If the field is a custom field, the configuration of the field.

jira.servicemanagement: Linkable

Fields

jira.servicemanagement: LinkableAttachmentLinkDTO

Fields

jira.servicemanagement: LinkableCustomerRequestLinkDTO

Fields

jira.servicemanagement: LinkableUserLinkDTO

Fields

jira.servicemanagement: LinkGroup

Details a link group, which defines issue operations.

Fields

jira.servicemanagement: OAuth2RefreshTokenGrantConfig

Closed record

OAuth2 Refresh Token Grant Configs

Fields
  • 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

Fields
  • name string - Name of the organization.

jira.servicemanagement: OrganizationDTO

Fields
  • id string? - A unique system generated ID for the organization.
  • name string? - Name of the organization.
  • _links SelfLinkDTO? - REST API URL to the organization.

jira.servicemanagement: OrganizationServiceDeskUpdateDTO

Fields
  • organizationId int - List of organizations, specified by 'ID' field values, to add to or remove from the service desk.

jira.servicemanagement: PagedDTOApprovalDTO

Fields
  • size int? - Number of items returned in the page.
  • 'start int? - Index of the first item returned in the page.
  • 'limit int? - Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
  • 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.
  • _links PagedLinkDTO? - List of the links relating to the page.

jira.servicemanagement: PagedDTOArticleDTO

Fields
  • size int? - Number of items returned in the page.
  • 'start int? - Index of the first item returned in the page.
  • 'limit int? - Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
  • 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.
  • _links PagedLinkDTO? - List of the links relating to the page.

jira.servicemanagement: PagedDTOAttachmentDTO

Fields
  • size int? - Number of items returned in the page.
  • 'start int? - Index of the first item returned in the page.
  • 'limit int? - Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
  • 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.
  • _links PagedLinkDTO? - List of the links relating to the page.

jira.servicemanagement: PagedDTOCommentDTO

Fields
  • size int? - Number of items returned in the page.
  • 'start int? - Index of the first item returned in the page.
  • 'limit int? - Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
  • 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.
  • _links PagedLinkDTO? - List of the links relating to the page.

jira.servicemanagement: PagedDTOCustomerRequestDTO

Fields
  • size int? - Number of items returned in the page.
  • 'start int? - Index of the first item returned in the page.
  • 'limit int? - Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
  • isLastPage boolean? - Indicates if this is the last page of records (true) or not (false).
  • _links PagedLinkDTO? - List of the links relating to the page.

jira.servicemanagement: PagedDTOCustomerRequestStatusDTO

Fields
  • size int? - Number of items returned in the page.
  • 'start int? - Index of the first item returned in the page.
  • 'limit int? - Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
  • isLastPage boolean? - Indicates if this is the last page of records (true) or not (false).
  • _links PagedLinkDTO? - List of the links relating to the page.

jira.servicemanagement: PagedDTOCustomerTransitionDTO

Fields
  • size int? - Number of items returned in the page.
  • 'start int? - Index of the first item returned in the page.
  • 'limit int? - Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
  • isLastPage boolean? - Indicates if this is the last page of records (true) or not (false).
  • _links PagedLinkDTO? - List of the links relating to the page.

jira.servicemanagement: PagedDTOInsightWorkspaceDTO

Fields
  • size int? - Number of items returned in the page.
  • 'start int? - Index of the first item returned in the page.
  • 'limit int? - Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
  • isLastPage boolean? - Indicates if this is the last page of records (true) or not (false).
  • _links PagedLinkDTO? - List of the links relating to the page.

jira.servicemanagement: PagedDTOIssueBean

Fields
  • size int? - Number of items returned in the page.
  • 'start int? - Index of the first item returned in the page.
  • 'limit int? - Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
  • 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.
  • _links PagedLinkDTO? - List of the links relating to the page.

jira.servicemanagement: PagedDTOOrganizationDTO

Fields
  • size int? - Number of items returned in the page.
  • 'start int? - Index of the first item returned in the page.
  • 'limit int? - Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
  • isLastPage boolean? - Indicates if this is the last page of records (true) or not (false).
  • _links PagedLinkDTO? - List of the links relating to the page.

jira.servicemanagement: PagedDTOQueueDTO

Fields
  • size int? - Number of items returned in the page.
  • 'start int? - Index of the first item returned in the page.
  • 'limit int? - Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
  • 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.
  • _links PagedLinkDTO? - List of the links relating to the page.

jira.servicemanagement: PagedDTORequestTypeDTO

Fields
  • size int? - Number of items returned in the page.
  • 'start int? - Index of the first item returned in the page.
  • 'limit int? - Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
  • isLastPage boolean? - Indicates if this is the last page of records (true) or not (false).
  • _links PagedLinkDTO? - List of the links relating to the page.

jira.servicemanagement: PagedDTORequestTypeGroupDTO

Fields
  • size int? - Number of items returned in the page.
  • 'start int? - Index of the first item returned in the page.
  • 'limit int? - Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
  • isLastPage boolean? - Indicates if this is the last page of records (true) or not (false).
  • _links PagedLinkDTO? - List of the links relating to the page.

jira.servicemanagement: PagedDTOServiceDeskDTO

Fields
  • size int? - Number of items returned in the page.
  • 'start int? - Index of the first item returned in the page.
  • 'limit int? - Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
  • isLastPage boolean? - Indicates if this is the last page of records (true) or not (false).
  • _links PagedLinkDTO? - List of the links relating to the page.

jira.servicemanagement: PagedDTOSlaInformationDTO

Fields
  • size int? - Number of items returned in the page.
  • 'start int? - Index of the first item returned in the page.
  • 'limit int? - Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
  • isLastPage boolean? - Indicates if this is the last page of records (true) or not (false).
  • _links PagedLinkDTO? - List of the links relating to the page.

jira.servicemanagement: PagedDTOUserDTO

Fields
  • size int? - Number of items returned in the page.
  • 'start int? - Index of the first item returned in the page.
  • 'limit int? - Number of items to be returned per page, up to the maximum set for these objects in the current implementation.
  • 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.
  • _links PagedLinkDTO? - List of the links relating to the page.

jira.servicemanagement: PagedLinkDTO

Fields
  • self string? - REST API URL for the current page.
  • base string? - Base URL for the REST API calls.
  • 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.

jira.servicemanagement: PageOfChangelogs

A page of changelogs.

Fields
  • startAt int? - The index of the first item returned on the page.
  • maxResults int? - The maximum number of results that could be on the page.
  • total int? - The number of results on the page.
  • histories Changelog[]? - The list of changelogs.

jira.servicemanagement: PropertyKey

Property key details.

Fields
  • self string? - The URL of the property.
  • 'key string? - The key of the property.

jira.servicemanagement: PropertyKeys

List of property keys.

Fields

jira.servicemanagement: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields
  • host string(default "") - Host name of the proxy server
  • port int(default 0) - Proxy server port
  • userName string(default "") - Proxy server username
  • password string(default "") - Proxy server password

jira.servicemanagement: QueueDTO

Fields
  • id string? - ID for the queue.
  • name string? - Short name for the queue.
  • jql string? - JQL query that filters reqeusts 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

Fields

jira.servicemanagement: RequestCreateDTO

Fields
  • serviceDeskId string? - ID of the service desk in which to create the request.
  • requestTypeId string? - ID of the request type for the request.
  • requestFieldValues record {}? - JSON map of Jira field IDs and their values representing the content of the request.
  • requestParticipants string[]? - List of customers to participate in the request, as a list of accountId values.
  • raiseOnBehalfOf string? - The accountId of the customer that the request is being raised on behalf of.
  • channel string? - (Experimental) Shows extra information for the request channel.

jira.servicemanagement: RequestNotificationSubscriptionDTO

Fields
  • subscribed boolean? - Indicates whether the user is subscribed (true) or not (false) to the request's notifications.

jira.servicemanagement: RequestParticipantUpdateDTO

Fields
  • usernames string[]? - This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details. Use accountIds instead.
  • accountIds string[]? - List of users, specified by account IDs, to add to or remove as participants in the request.

jira.servicemanagement: RequestTypeCreateDTO

Fields
  • issueTypeId string? - ID of the request type to add to 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.
  • helpText string? - Help text for the request type on the service desk.

jira.servicemanagement: RequestTypeDTO

Fields
  • id string? - ID for the request type.
  • name string? - Short name for the request type.
  • description string? - Description of the request type.
  • helpText string? - Help text for the request type.
  • issueTypeId string? - ID of the issue type the request type is based upon.
  • serviceDeskId string? - ID of the service desk the request type belongs to.
  • groupIds string[]? - List of the request type groups the request type belongs to.
  • practice string? - The request type's practice
  • _expands string[]? - List of items that can be expanded in the response by specifying the expand query parameter.
  • _links SelfLinkDTO? - REST API URL for the request type.

jira.servicemanagement: RequestTypeFieldDTO

Fields
  • fieldId string? - ID of the field.
  • name string? - Name of the field.
  • description string? - Description of the field.
  • required boolean? - Indicates if the field is required (true) or not (false).
  • presetValues string[]? - List of preset values for the field.
  • jiraSchema JsonTypeBean? - Jira specific implementation details for the field in the UI.

jira.servicemanagement: RequestTypeFieldValueDTO

Fields
  • value string? - Value of the field.
  • label string? - Label for the field.

jira.servicemanagement: RequestTypeGroupDTO

Fields
  • id string? - ID of the request type group
  • name string? - Name of the request type group.

jira.servicemanagement: RequestTypeIconDTO

Fields
  • id string? - ID of the request type icon.

jira.servicemanagement: RequestTypeIconLinkDTO

Fields
  • iconUrls record {}? - URLs for the request type icons.

jira.servicemanagement: SelfLinkDTO

Fields

jira.servicemanagement: ServiceDeskCustomerDTO

Fields
  • usernames string[]? - This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details. Use accountIds instead.
  • accountIds string[]? - List of users, specified by account IDs, to add to or remove from a service desk.

jira.servicemanagement: ServiceDeskDTO

Fields
  • id string? - ID of the service desk.
  • projectId string? - ID of the peer project for the service desk.
  • projectName string? - Name of the project and service desk.
  • projectKey string? - Key of the peer project of the service desk.
  • _links SelfLinkDTO? - REST API URL to the service desk.

Details about the operations available in this version.

Fields

jira.servicemanagement: SlaInformationCompletedCycleDTO

Fields
  • startTime DateDTO? - Time and date at which the SLA cycle started.
  • stopTime DateDTO? - Time and date at which the SLA cycle 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).
  • goalDuration DurationDTO? - Duration within which the service should have been completed.
  • elapsedTime DurationDTO? - Duration in which the service was completed.
  • remainingTime DurationDTO? - Duration remaining after the service was completed.

jira.servicemanagement: SlaInformationDTO

Fields
  • id string? - ID of the Service Level Agreement (SLA).
  • name string? - Description of the SLA.

jira.servicemanagement: SlaInformationOngoingCycleDTO

Fields
  • startTime DateDTO? - Time and date at which the SLA cycle started.
  • 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).
  • paused boolean? - Indicates whether the SLA is paused (true) or not (false).
  • withinCalendarHours boolean? - Indicates whether the SLA it timed during calendared working hours only (true) or not (false).
  • goalDuration DurationDTO? - Duration within which the service should be completed.
  • remainingTime DurationDTO? - Duration remaining in which to complete the service.

jira.servicemanagement: SoftwareInfoDTO

Fields
  • 'version string? - Jira Service Management version.
  • platformVersion string? - Jira Platform version upon which Service Desk is based.
  • buildDate DateDTO? - Date of the current build.
  • buildChangeSet string? - Reference of the change set included in the build.
  • isLicensedForUse boolean? - Indicates whether the instance is licensed (true) or not (false).

jira.servicemanagement: SourceDTO

Fields
  • 'type string? - Type of the knowledge base source

jira.servicemanagement: StatusCategory

A status category.

Fields
  • self string? - The URL of the status category.
  • id int? - The ID of the status category.
  • 'key string? - The key of the status category.
  • colorName string? - The name of the color used to represent the status category.
  • name string? - The name of the status category.

jira.servicemanagement: StatusDetails

A status.

Fields
  • self string? - The URL of the status.
  • description string? - The description of the status.
  • iconUrl string? - The URL of the icon used to represent the status.
  • name string? - The name of the status.
  • id string? - The ID of the status.

jira.servicemanagement: UserDetails

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, displayName provides 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, accountId returns 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
  • self string? - The URL of the user.
  • name string? - This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
  • 'key string? - This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
  • 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.
  • displayName string? - The display name of the user. Depending on the user’s privacy settings, this may return an alternative value.
  • active boolean? - Whether the user is active.
  • timeZone string? - The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.
  • 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)

jira.servicemanagement: UserDTO

Fields
  • accountId string? - The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
  • name string? - This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
  • 'key string? - This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details.
  • emailAddress string? - Customer's email address. Depending on the customer’s privacy settings, this may be returned as null.
  • displayName string? - Customer's name for display in a UI. Depending on the customer’s privacy settings, this may return an alternative value.
  • 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.
  • _links UserLinkDTO? - URLs for the customer record and related items.

jira.servicemanagement: UserLinkDTO

Fields
  • jiraRest string? - REST API URL for the customer.
  • avatarUrls record {}? - Links to the various sizes of the customer's avatar. Note that this property is deprecated, and will be removed in future versions.

jira.servicemanagement: UsersOrganizationUpdateDTO

Fields
  • usernames string[]? - This property is no longer available and will be removed from the documentation soon. See the deprecation notice for details. Use accountIds instead.
  • accountIds string[]? - List of customers, specific by account IDs, to add to or remove from the organization.

Import

import ballerinax/jira.servicemanagement;Copy

Metadata

Released date: over 1 year ago

Version: 1.3.1

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 2

Current verison: 2

Weekly downloads

Source repository

Keywords

Support//Customer Support

Cost/Freemium

Contributors

Other versions

1.3.1

1.3.01.2.01.0.0

Dependencies

ballerina/url/2.2.3ballerina/constraint/1.1.0ballerina/http/2.6.0

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2025 WSO2 LLC