ServicedeskApi class

Public REST API for Jira Service Management

Constructors

ServicedeskApi(ApiClient _client)

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

addCustomers({required String serviceDeskId, required ServiceDeskCustomerDTO body}) → Future<void>

Adds one or more customers to a service desk. If any of the passed customers are associated with the service desk, no changes will be made for those customers and the resource returns a 204 success code.

attachTemporaryFile({required String serviceDeskId, required MultipartFile file}) → Future<TemporaryAttachments>

This method adds one or more temporary attachments to a service desk, which can then be permanently attached to a customer request using servicedeskapi/request/{issueIdOrKey}/attachment.

createRequestType({required String serviceDeskId, required RequestTypeCreateDTO body}) → Future<RequestTypeDTO>

This method enables a customer request type to be added to a service desk based on an issue type. Note that not all customer request type fields can be specified in the request and these fields are given the following default values:

deleteProperty({required String serviceDeskId, required int requestTypeId, required String propertyKey}) → Future<void>

Removes a property from a request type.

deleteRequestType({required String serviceDeskId, required int requestTypeId}) → Future<void>

This method deletes a customer request type from a service desk, and removes it from all customer requests. This only supports classic projects.

getArticles({required String serviceDeskId, String? query, bool? highlight, int? start, int? limit}) → Future<PagedDTOArticleDTO>

Returns articles which match the given query and belong to the knowledge base linked to the service desk.

getCustomers({required String serviceDeskId, String? query, int? start, int? limit}) → Future<PagedDTOUserDTO>

This method returns a list of the customers on a service desk.

getIssuesInQueue({required String serviceDeskId, required int queueId, int? start, int? limit}) → Future<PagedDTOIssueBean>

This method returns the customer requests in a queue. Only fields that the queue is configured to show are returned. For example, if a queue is configured to show description and due date, then only those two fields are returned for each customer request in the queue.

getPropertiesKeys({required int requestTypeId, required String serviceDeskId}) → Future<PropertyKeys>

Returns the keys of all properties for a request type.

getProperty({required String serviceDeskId, required int requestTypeId, required String propertyKey}) → Future<EntityProperty>

Returns the value of the property from a request type.

getQueue({required String serviceDeskId, required int queueId, bool? includeCount}) → Future<QueueDTO>

This method returns a specific queues in a service desk. To include a customer request count for the queue (in the issueCount field) in the response, set the query parameter includeCount to true (its default is false).

getQueues({required String serviceDeskId, bool? includeCount, int? start, int? limit}) → Future<PagedDTOQueueDTO>

This method returns the queues in a service desk. To include a customer request count for each queue (in the issueCount field) in the response, set the query parameter includeCount to true (its default is false).

getRequestTypeById({required String serviceDeskId, required String requestTypeId, List<String>? expand}) → Future<RequestTypeDTO>

This method returns a customer request type from a service desk.

getRequestTypeFields({required String serviceDeskId, required int requestTypeId, List<String>? expand}) → Future<CustomerRequestCreateMetaDTO>

This method returns the fields for a service desk's customer request type.

getRequestTypeGroups({required String serviceDeskId, int? start, int? limit}) → Future<PagedDTORequestTypeGroupDTO>

This method returns a service desk's customer request type groups. Jira Service Management administrators can arrange the customer request type groups in an arbitrary order for display on the customer portal; the groups are returned in this order.

getRequestTypes({required String serviceDeskId, int? groupId, List<String>? expand, String? searchQuery, int? start, int? limit}) → Future<PagedDTORequestTypeDTO>

This method returns all customer request types from a service desk. There are two parameters for filtering the returned list:

getServiceDeskById(String serviceDeskId) → Future<ServiceDeskDTO>

This method returns a service desk. Use this method to get service desk details whenever your application component is passed a service desk ID but needs to display other service desk details.

getServiceDesks({int? start, int? limit}) → Future<PagedDTOServiceDeskDTO>

This method returns all the service desks in the Jira Service Management instance that the user has permission to access. Use this method where you need a list of service desks or need to locate a service desk by name or keyword.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

removeCustomers({required String serviceDeskId, required ServiceDeskCustomerDTO body}) → Future<void>

This method removes one or more customers from a service desk. The service desk must have closed access. If any of the passed customers are not associated with the service desk, no changes will be made for those customers and the resource returns a 204 success code.

setProperty({required String serviceDeskId, required int requestTypeId, required String propertyKey}) → Future

Sets the value of a request type property. Use this resource to store custom data against a request type.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited