Class Request

This method adds participants to a customer request.

Permissions required: Permission to manage participants on the customer request.

Note, participants can be added when creating a customer request using the request resource, by defining the participants in the requestParticipants field.

This method adds participants to a customer request.

Permissions required: Permission to manage participants on the customer request.

Note, participants can be added when creating a customer request using the request resource, by defining the participants in the requestParticipants field.

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.

Permissions required: User is assigned to the approval request.

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.

Permissions required: User is assigned to the approval request.

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.

To get a list of attachments for a comment on the request use servicedeskapi/request/{issueIdOrKey}/comment/{commentId}/attachment.

Permissions required: Permission to add an attachment.

Request limitations: Customers can set attachments to public visibility only.

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.

To get a list of attachments for a comment on the request use servicedeskapi/request/{issueIdOrKey}/comment/{commentId}/attachment.

Permissions required: Permission to add an attachment.

Request limitations: Customers can set attachments to public visibility only.

This method creates a customer request in a service desk.

The JSON request must include the service desk and customer request type, as well as any fields that are required for the request type. A list of the fields required by a customer request type can be obtained using servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/field.

The fields required for a customer request type depend on the user's permissions:

• raiseOnBehalfOf is not available to Users who have the customer permission only.
• requestParticipants is not available to Users who have the customer permission only or if the feature is turned off for customers.

requestFieldValues is a map of Jira field IDs and their values. See Field input formats, for details of each field's JSON semantics and the values they can take.

Permissions required: Permission to create requests in the specified service desk.

This method creates a customer request in a service desk.

The JSON request must include the service desk and customer request type, as well as any fields that are required for the request type. A list of the fields required by a customer request type can be obtained using servicedesk/{serviceDeskId}/requesttype/{requestTypeId}/field.

The fields required for a customer request type depend on the user's permissions:

• raiseOnBehalfOf is not available to Users who have the customer permission only.
• requestParticipants is not available to Users who have the customer permission only or if the feature is turned off for customers.

requestFieldValues is a map of Jira field IDs and their values. See Field input formats, for details of each field's JSON semantics and the values they can take.

Permissions required: Permission to create requests in the specified service desk.

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.

Permissions required: User has Add Comments permission.

Request limitations: Customers can set comments to public visibility only.

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.

Permissions required: User has Add Comments permission.

Request limitations: Customers can set comments to public visibility only.

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

Permissions required: User must be the reporter or an Atlassian Connect app.

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

Permissions required: User must be the reporter or an Atlassian Connect app.

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

Permissions required: Permission to view the customer request.

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

Permissions required: Permission to view the customer request.

This method returns all approvals on a customer request.

Permissions required: Permission to view the customer request.

This method returns all approvals on a customer request.

Permissions required: Permission to view the customer request.

Returns the contents of an attachment.

To return a thumbnail of the attachment, use servicedeskapi/request/{issueIdOrKey}/attachment/{attachmentId}/thumbnail.

Permissions required: For the issue containing the attachment:

• Browse projects project permission for the project that the issue is in.
• If issue-level security is configured, issue-level security permission to view the issue.

Returns the contents of an attachment.

To return a thumbnail of the attachment, use servicedeskapi/request/{issueIdOrKey}/attachment/{attachmentId}/thumbnail.

Permissions required: For the issue containing the attachment:

• Browse projects project permission for the project that the issue is in.
• If issue-level security is configured, issue-level security permission to view the issue.

Returns the thumbnail of an attachment.

To return the attachment contents, use servicedeskapi/request/{issueIdOrKey}/attachment/{attachmentId}.

Permissions required: For the issue containing the attachment:

• Browse projects project permission for the project that the issue is in.
• If issue-level security is configured, issue-level security permission to view the issue.

Returns the thumbnail of an attachment.

To return the attachment contents, use servicedeskapi/request/{issueIdOrKey}/attachment/{attachmentId}.

Permissions required: For the issue containing the attachment:

• Browse projects project permission for the project that the issue is in.
• If issue-level security is configured, issue-level security permission to view the issue.

This method returns all the attachments for a customer requests.

Permissions required: Permission to view the customer request.

Response limitations: Customers will only get a list of public attachments.

This method returns all the attachments for a customer requests.

Permissions required: Permission to view the customer request.

Response limitations: Customers will only get a list of public attachments.

This method returns the attachments referenced in a comment.

Permissions required: Permission to view the customer request.

Response limitations: Customers can only view public comments, and retrieve their attachments, on requests where they are the reporter or a participant whereas agents can see both internal and public comments.

This method returns the attachments referenced in a comment.

Permissions required: Permission to view the customer request.

Response limitations: Customers can only view public comments, and retrieve their attachments, on requests where they are the reporter or a participant whereas agents can see both internal and public comments.

This method returns a customer request.

Permissions required: Permission to access the specified service desk.

Response limitations: For customers, only a request they created, was created on their behalf, or they are participating in will be returned.

This method returns a customer request.

Permissions required: Permission to access the specified service desk.

Response limitations: For customers, only a request they created, was created on their behalf, or they are participating in will be returned.

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.

Permissions required: Permission to view the customer request.

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.

Permissions required: Permission to view the customer request.

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

The returned customer requests are ordered chronologically by the latest activity on each request. For example, the latest status transition or comment.

Permissions required: Permission to access the specified service desk.

Response limitations: For customers, the list returned will include request they created (or were created on their behalf) or are participating in only.

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

The returned customer requests are ordered chronologically by the latest activity on each request. For example, the latest status transition or comment.

Permissions required: Permission to access the specified service desk.

Response limitations: For customers, the list returned will include request they created (or were created on their behalf) or are participating in only.

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.

Permissions required: Permission to view the customer request.

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.

Permissions required: Permission to view the customer request.

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

Permissions required: User has view request permissions.

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

Permissions required: User has view request permissions.

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

Permissions required: Permission to view the customer request.

Response limitations: Customers can only view public comments on requests where they are the reporter or a participant whereas agents can see both internal and public comments.

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

Permissions required: Permission to view the customer request.

Response limitations: Customers can only view public comments on requests where they are the reporter or a participant whereas agents can see both internal and public comments.

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.

Permissions required: Permission to view the customer request.

Response limitations: Customers are returned public comments only.

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.

Permissions required: Permission to view the customer request.

Response limitations: Customers are returned public comments only.

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

Permissions required: Permission to view the customer request.

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

Permissions required: Permission to view the customer request.

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.

Permissions required: Agent for the Service Desk containing the queried customer request.

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.

Permissions required: Agent for the Service Desk containing the queried customer request.

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

Permissions required: Agent for the Service Desk containing the queried customer request.

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

Permissions required: Agent for the Service Desk containing the queried customer request.

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.

Permissions required: Permission to view the customer request.

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.

Permissions required: Permission to view the customer request.

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.

Permissions required: The user must be able to view the request and have the Transition Issues permission. If a comment is passed the user must have the Add Comments permission.

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.

Permissions required: The user must be able to view the request and have the Transition Issues permission. If a comment is passed the user must have the Add Comments permission.

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

Permissions required: User must be the reporter or an Atlassian Connect app.

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

Permissions required: User must be the reporter or an Atlassian Connect app.

This method removes participants from a customer request.

Permissions required: Permission to manage participants on the customer request.

This method removes participants from a customer request.

Permissions required: Permission to manage participants on the customer request.

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

Permissions required: Permission to view the customer request.

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

Permissions required: Permission to view the customer request.

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

Permissions required: Permission to view the customer request.

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

Permissions required: Permission to view the customer request.