RequestApi class

Public REST API for Jira Service Management

Constructors

RequestApi(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

addRequestParticipants({required String issueIdOrKey, required RequestParticipantUpdateDTO body}) → Future<PagedDTOUserDTO>

This method adds participants to a customer request.

answerApproval({required String issueIdOrKey, required int approvalId, required ApprovalDecisionRequestDTO body}) → Future<ApprovalDTO>

This method enables a user to Approve or Decline an approval on a customer request. The approval is assumed to be owned by the user making the call.

createAttachment({required String issueIdOrKey, required AttachmentCreateDTO body}) → Future<AttachmentCreateResultDTO>

This method adds one or more temporary files (attached to the request's service desk using servicedesk/{serviceDeskId}/attachTemporaryFile) as attachments to a customer request and set the attachment visibility using the public flag. Also, it is possible to include a comment with the attachments.

createCustomerRequest({required RequestCreateDTO body}) → Future<CustomerRequestDTO>

This method creates a customer request in a service desk.

createRequestComment({required String issueIdOrKey, required CommentCreateDTO body}) → Future<CommentDTO>

This method creates a public or private (internal) comment on a customer request, with the comment visibility set by public. The user recorded as the author of the comment.

deleteFeedback(String requestIdOrKey) → Future

This method deletes the feedback of request using it's requestKey or requestId

getApprovalById({required String issueIdOrKey, required int approvalId}) → Future<ApprovalDTO>

This method returns an approval. Use this method to determine the status of an approval and the list of approvers.

getApprovals({int? start, int? limit, required String issueIdOrKey}) → Future<PagedDTOApprovalDTO>

This method returns all approvals on a customer request.

getAttachmentContent({required String issueIdOrKey, required int attachmentId}) → Future

Returns the contents of an attachment.

getAttachmentsForRequest({required String issueIdOrKey, int? start, int? limit}) → Future<PagedDTOAttachmentDTO>

This method returns all the attachments for a customer requests.

getAttachmentThumbnail({required String issueIdOrKey, required int attachmentId}) → Future

Returns the thumbnail of an attachment.

getCommentAttachments({required String issueIdOrKey, required int commentId, int? start, int? limit}) → Future<PagedDTOAttachmentDTO>

This method returns the attachments referenced in a comment.

getCustomerRequestByIdOrKey({required String issueIdOrKey, List<String>? expand}) → Future<CustomerRequestDTO>

This method returns a customer request.

getCustomerRequests({String? searchTerm, List<String>? requestOwnership, String? requestStatus, String? approvalStatus, int? organizationId, int? serviceDeskId, int? requestTypeId, List<String>? expand, int? start, int? limit}) → Future<PagedDTOCustomerRequestDTO>

This method returns all customer requests for the user executing the query.

getCustomerRequestStatus({required String issueIdOrKey, int? start, int? limit}) → Future<PagedDTOCustomerRequestStatusDTO>

This method returns a list of all the statuses a customer Request has achieved. A status represents the state of an issue in its workflow. An issue can have one active status only. The list returns the status history in chronological order, most recent (current) status first.

getCustomerTransitions({required String issueIdOrKey, int? start, int? limit}) → Future<PagedDTOCustomerTransitionDTO>

This method returns a list of transitions, the workflow processes that moves a customer request from one status to another, that the user can perform on a request. Use this method to provide a user with a list if the actions they can take on a customer request.

getFeedback(String requestIdOrKey) → Future<CSATFeedbackFullDTO>

This method retrieves a feedback of a request using it's requestKey or requestId

getRequestCommentById({required String issueIdOrKey, required int commentId, List<String>? expand}) → Future<CommentDTO>

This method returns details of a customer request's comment.

getRequestComments({required String issueIdOrKey, bool? public, bool? internal, List<String>? expand, int? start, int? limit}) → Future<PagedDTOCommentDTO>

This method returns all comments on a customer request. No permissions error is provided if, for example, the user doesn't have access to the service desk or request, the method simply returns an empty response.

getRequestParticipants({required String issueIdOrKey, int? start, int? limit}) → Future<PagedDTOUserDTO>

This method returns a list of all the participants on a customer request.

getSlaInformation({required String issueIdOrKey, int? start, int? limit}) → Future<PagedDTOSlaInformationDTO>

This method returns all the SLA records on a customer request. A customer request can have zero or more SLAs. Each SLA can have recordings for zero or more "completed cycles" and zero or 1 "ongoing cycle". Each cycle includes information on when it started and stopped, and whether it breached the SLA goal.

getSlaInformationById({required String issueIdOrKey, required int slaMetricId}) → Future<SlaInformationDTO>

This method returns the details for an SLA on a customer request.

getSubscriptionStatus(String issueIdOrKey) → Future<RequestNotificationSubscriptionDTO>

This method returns the notification subscription status of the user making the request. Use this method to determine if the user is subscribed to a customer request's notifications.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

performCustomerTransition({required String issueIdOrKey, required CustomerTransitionExecutionDTO body}) → Future<void>

This method performs a customer transition for a given request and transition. An optional comment can be included to provide a reason for the transition.

postFeedback({required String requestIdOrKey, required CSATFeedbackFullDTO body}) → Future<CSATFeedbackFullDTO>

This method adds a feedback on an request using it's requestKey or requestId

removeRequestParticipants({required String issueIdOrKey, required RequestParticipantUpdateDTO body}) → Future<PagedDTOUserDTO>

This method removes participants from a customer request.

subscribe(String issueIdOrKey) → Future<void>

This method subscribes the user to receiving notifications from a customer request.

toString() → String

A string representation of this object.

inherited

unsubscribe(String issueIdOrKey) → Future<void>

This method unsubscribes the user from notifications from a customer request.

Operators

operator ==(Object other) → bool

The equality operator.

inherited