add_customers
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.
Permissions required: Service desk administrator
Parameters
cloudid (required)
Type: string
serviceDeskId (required)
The ID of the service desk the customer list should be returned from. This can alternatively be a project identifier.
Type: integer
$body
Type: object
{
"accountIds" : [ "string" ],
"usernames" : [ "string" ]
}
add_organization
This method adds an organization to a service desk. If the organization ID is already associated with the service desk, no change is made and the resource returns a 204 success code.
Permissions required: Service desk's agent.
Parameters
cloudid (required)
Type: string
serviceDeskId (required)
The ID of the service desk to which the organization will be added. This can alternatively be a project identifier.
Type: integer
$body
Type: object
{
"organizationId" : "List of organizations, specified by 'ID' field values, to add to or remove from the service desk."
}
add_request_participants
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.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the customer request to have participants added.
Type: string
$body
Type: object
{
"accountIds" : [ "string" ],
"usernames" : [ "string" ]
}
add_users_to_organization
This method adds users to an organization.
Permissions required: Service desk administrator or agent. Note: Permission to add users to an organization can be switched to users with the Jira administrator permission, using the Organization management feature.
Parameters
cloudid (required)
Type: string
organizationId (required)
The ID of the organization.
Type: integer
$body
Type: object
{
"accountIds" : [ "string" ],
"usernames" : [ "string" ]
}
answer_approval
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.
Parameters
approvalId (required)
The ID of the approval to be updated.
Type: integer
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the customer request to be updated.
Type: string
$body
Type: object
{
"decision" : "Response to the approval request."
}
create_attachment
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.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the customer request to which the attachment will be added.
Type: string
$body
Type: object
{
"temporaryAttachmentIds" : [ "string" ],
"public" : "Indicates whether the attachments are to be public (true) or private/internal (false).",
"additionalComment" : {
"body" : "Content of the comment."
}
}
create_customer
This method adds a customer to the Jira Service Management instance by passing a JSON file including an email address and display name. The display name does not need to be unique. The record's identifiers, name
and key
, are automatically generated from the request details.
Permissions required: Jira Administrator Global permission
Parameters
cloudid (required)
Type: string
$body
Type: object
{
"displayName" : "Customer's name for display in the UI.",
"fullName" : "Deprecated, please use 'displayName'.",
"email" : "Customer's email address."
}
create_customer_request
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.
Parameters
cloudid (required)
Type: string
$body
Type: object
{
"requestParticipants" : [ "string" ],
"raiseOnBehalfOf" : "The `accountId` of the customer that the request is being raised on behalf of.",
"serviceDeskId" : "ID of the service desk in which to create the request.",
"requestTypeId" : "ID of the request type for the request.",
"channel" : "(Experimental) Shows extra information for the request channel.",
"requestFieldValues" : { }
}
create_organization
This method creates an organization by passing the name of the organization.
Permissions required: Service desk administrator or agent. Note: Permission to create organizations can be switched to users with the Jira administrator permission, using the Organization management feature.
Parameters
cloudid (required)
Type: string
$body
Type: object
{
"name" : "Name of the organization."
}
create_request_comment
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.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the customer request to which the comment will be added.
Type: string
$body
Type: object
{
"public" : "Indicates whether the comment is public (true) or private/internal (false).",
"body" : "Content of the comment."
}
create_request_type
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:
- Request type icon is given the headset icon.
- Request type groups is left empty, which means this customer request type will not be visible on the customer portal.
- Request type status mapping is left empty, so the request type has no custom status mapping but inherits the status map from the issue type upon which it is based.
- Request type field mapping is set to show the required fields as specified by the issue type used to create the customer request type.
These fields can be updated by a service desk administrator using the Request types option in Project settings.
Request Types are created in next-gen projects by creating Issue Types. Please use the Jira Cloud Platform Create issue type endpoint instead.
Permissions required: Service desk's administrator
Parameters
X-ExperimentalApi (required)
Type: string
cloudid (required)
Type: string
serviceDeskId (required)
The ID of the service desk where the customer request type is to be created. This can alternatively be a project identifier.
Type: integer
$body
Type: object
{
"issueTypeId" : "ID of the request type to add to the service desk.",
"helpText" : "Help text for the request type on the service desk.",
"name" : "Name of the request type on the service desk.",
"description" : "Description of the request type on the service desk."
}
delete_feedback
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.
Parameters
X-ExperimentalApi (required)
Type: string
cloudid (required)
Type: string
requestIdOrKey (required)
The id or the key of the request to post the feedback on
Type: string
delete_organization
This method deletes an organization. Note that the organization is deleted regardless of other associations it may have. For example, associations with service desks.
Permissions required: Jira administrator.
Parameters
cloudid (required)
Type: string
organizationId (required)
The ID of the organization.
Type: integer
delete_organization_property
Removes a property from an organization.
Permissions required: Service Desk Administrator or Agent.
Note: Permission to manage organizations can be switched to users with the Jira administrator permission, using the Organization management feature.
Parameters
cloudid (required)
Type: string
organizationId (required)
The ID of the organization from which the property will be removed.
Type: string
propertyKey (required)
The key of the property to remove.
Type: string
delete_request_type
This method deletes a customer request type from a service desk, and removes it from all customer requests.
This only supports classic projects.
Permissions required: Service desk administrator.
Parameters
X-ExperimentalApi (required)
Type: string
cloudid (required)
Type: string
requestTypeId (required)
The ID of the request type.
Type: integer
serviceDeskId (required)
The ID or project identifier of the service desk.
Type: integer
delete_request_type_property
Removes a property from a request type.
Properties for a Request Type in next-gen are stored as Issue Type properties and therefore can also be deleted by calling the Jira Cloud Platform Delete issue type property endpoint.
Permissions required: Jira project administrator with a Jira Service Management agent license.
Parameters
X-ExperimentalApi (required)
Type: string
cloudid (required)
Type: string
propertyKey (required)
The key of the property to remove.
Type: string
requestTypeId (required)
The ID of the request type for which the property will be removed.
Type: integer
serviceDeskId (required)
The ID of the service desk which contains the request type. This can alternatively be a project identifier.
Type: integer
get_approval
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.
Parameters
approvalId (required)
The ID of the approval to be returned.
Type: integer
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the customer request the approval is on.
Type: string
get_articles_for_service_desk
Returns articles which match the given query and belong to the knowledge base linked to the service desk.
Permissions required: Permission to access the service desk.
Parameters
X-ExperimentalApi (required)
Type: string
cloudid (required)
Type: string
serviceDeskId (required)
Type: integer
highlight
If set to true matching query term in the title and excerpt will be highlighted using the {@code
Type: boolean
query
The string used to filter the articles (required).
Type: string
get_attachments_for_request
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.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the customer request from which the attachments will be listed.
Type: string
get_cloud_id
This operation has no parameters
get_comment_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.
Parameters
X-ExperimentalApi (required)
Type: string
cloudid (required)
Type: string
commentId (required)
The ID of the comment.
Type: integer
issueIdOrKey (required)
The ID or key of the customer request that contains the comment.
Type: string
get_customer_request
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.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or Key of the customer request to be returned
Type: string
expand
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.
Type: array
[ "string" ]
get_customer_request_status
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.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the customer request to be retrieved.
Type: string
get_customer_transitions
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.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the customer request whose transitions will be retrieved.
Type: string
get_feedback
This method retrieves a feedback of a request using it's requestKey
or requestId
Permissions required: User has view request permissions.
Parameters
X-ExperimentalApi (required)
Type: string
cloudid (required)
Type: string
requestIdOrKey (required)
The id or the key of the request to post the feedback on
Type: string
get_info
This method retrieves information about the Jira Service Management instance such as software version, builds, and related links.
Permissions required: None, the user does not need to be logged in.
Parameters
cloudid (required)
Type: string
get_issues_in_queue
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.
Permissions required: Service desk's agent.
Parameters
cloudid (required)
Type: string
queueId (required)
The ID of the queue whose customer requests will be returned.
Type: integer
serviceDeskId (required)
The ID of the service desk containing the queue to be queried. This can alternatively be a project identifier.
Type: integer
get_organization
This method returns details of an organization. Use this method to get organization details whenever your application component is passed an organization ID but needs to display other organization details.
Permissions required: Any
Response limitations: Customers can only retrieve organization of which they are members.
Parameters
cloudid (required)
Type: string
organizationId (required)
The ID of the organization.
Type: integer
get_organization_properties_keys
Returns the keys of all properties for an organization. Use this resource when you need to find out what additional properties items have been added to an organization.
Permissions required: Any
Response limitations: Customers can only access properties of organizations of which they are members.
Parameters
cloudid (required)
Type: string
organizationId (required)
The ID of the organization from which keys will be returned.
Type: string
get_organization_property
Returns the value of a property from an organization. Use this method to obtain the JSON content for an organization's property.
Permissions required: Any
Response limitations: Customers can only access properties of organizations of which they are members.
Parameters
cloudid (required)
Type: string
organizationId (required)
The ID of the organization from which the property will be returned.
Type: string
propertyKey (required)
The key of the property to return.
Type: string
get_organizations_for_service_desk
This method returns a list of all organizations associated with a service desk.
Permissions required: Service desk's agent.
Parameters
cloudid (required)
Type: string
serviceDeskId (required)
The ID of the service desk from which the organization list will be returned. This can alternatively be a project identifier.
Type: integer
accountId
The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
Type: string
get_queue
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).
Permissions required: service desk's Agent.
Parameters
cloudid (required)
Type: string
queueId (required)
ID of the required queue.
Type: integer
serviceDeskId (required)
ID of the service desk whose queues will be returned. This can alternatively be a project identifier.
Type: integer
includeCount
Specifies whether to include each queue's customer request (issue) count in the response.
Type: boolean
get_request_comment
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.
Parameters
cloudid (required)
Type: string
commentId (required)
The ID of the comment to retrieve.
Type: integer
issueIdOrKey (required)
The ID or key of the customer request that contains the comment.
Type: string
expand
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.
Type: array
[ "string" ]
get_request_type
This method returns a customer request type from a service desk.
Permissions required: Permission to access the service desk.
Parameters
cloudid (required)
Type: string
requestTypeId (required)
The ID of the customer request type to be returned.
Type: integer
serviceDeskId (required)
The ID of the service desk whose customer request type is to be returned. This can alternatively be a project identifier.
Type: integer
expand
Type: array
[ "string" ]
get_request_type_fields
This method returns the fields for a service desk's customer request type.
Also, the following information about the user's permissions for the request type is returned:
canRaiseOnBehalfOf
returnstrue
if the user has permission to raise customer requests on behalf of other customers. Otherwise, returnsfalse
.canAddRequestParticipants
returnstrue
if the user can add customer request participants. Otherwise, returnsfalse
.
Permissions required: Permission to view the Service Desk. However, hidden fields would be visible to only Service desk's Administrator.
Parameters
cloudid (required)
Type: string
requestTypeId (required)
The ID of the request types whose fields are to be returned.
Type: integer
serviceDeskId (required)
The ID of the service desk containing the request types whose fields are to be returned. This can alternatively be a project identifier.
Type: integer
expand
Use expand to include additional information in the response. This parameter accepts hiddenFields
that returns hidden fields associated with the request type.
Type: array
[ "string" ]
get_request_type_groups
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.
Permissions required: Permission to view the service desk.
Parameters
cloudid (required)
Type: string
serviceDeskId (required)
The ID of the service desk whose customer request type groups are to be returned. This can alternatively be a project identifier.
Type: integer
get_request_type_properties_keys
Returns the keys of all properties for a request type.
Properties for a Request Type in next-gen are stored as Issue Type properties and therefore the keys of all properties for a request type are also available by calling the Jira Cloud Platform Get issue type property keys endpoint.
Permissions required: The user must have permission to view the request type.
Parameters
X-ExperimentalApi (required)
Type: string
cloudid (required)
Type: string
requestTypeId (required)
The ID of the request type for which keys will be retrieved.
Type: integer
serviceDeskId (required)
The ID of the service desk which contains the request type. This can alternatively be a project identifier.
Type: integer
get_request_type_property
Returns the value of the property from a request type.
Properties for a Request Type in next-gen are stored as Issue Type properties and therefore also available by calling the Jira Cloud Platform Get issue type property endpoint.
Permissions required: User must have permission to view the request type.
Parameters
X-ExperimentalApi (required)
Type: string
cloudid (required)
Type: string
propertyKey (required)
The key of the property to return.
Type: string
requestTypeId (required)
The ID of the request type from which the property will be retrieved.
Type: integer
serviceDeskId (required)
The ID of the service desk which contains the request type. This can alternatively be a project identifier.
Type: integer
get_service_desk
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.
Permissions required: Permission to access the Service Desk. For example, being the Service Desk's Administrator or one of its Agents or Users.
Parameters
cloudid (required)
Type: string
serviceDeskId (required)
The ID of the service desk to return. This can alternatively be a project identifier.
Type: integer
get_sla_information
This method returns the details for an SLA on a customer request.
Permissions required: Agent for the Service Desk containing the queried customer request.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the customer request whose SLAs will be retrieved.
Type: string
slaMetricId (required)
The ID or key of the SLAs metric to be retrieved.
Type: integer
get_subscription_status
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.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the customer request to be queried for subscription status.
Type: string
get_users_in_organization
This method returns all the users associated with an organization. Use this method where you want to provide a list of users for an organization or determine if a user is associated with an organization.
Permissions required: Service desk administrator or agent.
Parameters
cloudid (required)
Type: string
organizationId (required)
The ID of the organization.
Type: integer
list_all_request_types
This method returns all customer request types used in the Jira Service Management instance, optionally filtered by a query string.
Use servicedeskapi/servicedesk/{serviceDeskId}/requesttype to find the customer request types supported by a specific service desk.
The returned list of customer request types can be filtered using the query
parameter. The parameter is matched against the customer request types' name
or description
. For example, searching for "Install", "Inst", "Equi", or "Equipment" will match a customer request type with the name "Equipment Installation Request".
Permissions required: Any
Parameters
X-ExperimentalApi (required)
Type: string
cloudid (required)
Type: string
expand
Type: array
[ "string" ]
searchQuery
String to be used to filter the results.
Type: string
serviceDeskId
Type: array
[ "integer" ]
list_approvals
This method returns all approvals on a customer request.
Permissions required: Permission to view the customer request.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the customer request to be queried for its approvals.
Type: string
list_articles
Returns articles which match the given query string across all service desks.
Permissions required: Permission to access the customer portal.
Parameters
X-ExperimentalApi (required)
Type: string
cloudid (required)
Type: string
highlight
If set to true matching query term in the title and excerpt will be highlighted using the {@code @@@hl@@@term@@@endhl@@@} syntax. Default: false.
Type: boolean
query
The string used to filter the articles (required).
Type: string
list_customer_requests
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.
Parameters
cloudid (required)
Type: string
approvalStatus
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.
Type: string
expand
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.
Type: array
[ "string" ]
organizationId
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.
Type: integer
requestOwnership
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 withorganizationId
.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 withapprovalStatus
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
.
Type: array
[ "string" ]
requestStatus
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.
Type: string
requestTypeId
Filters customer requests by request type. Note that the serviceDeskId
must be specified for the service desk in which the request type belongs.
Type: integer
searchTerm
Filters customer requests where the request summary matches the searchTerm
. Wildcards can be used in the searchTerm
parameter.
Type: string
serviceDeskId
Filters customer requests by service desk.
Type: integer
list_customers
This method returns a list of the customers on a service desk.
The returned list of customers can be filtered using the query
parameter. The parameter is matched against customers' displayName
, name
, or email
. For example, searching for "John", "Jo", "Smi", or "Smith" will match a user with display name "John Smith".
Permissions required: Permission to view this Service Desk's customers.
Parameters
X-ExperimentalApi (required)
Type: string
cloudid (required)
Type: string
serviceDeskId (required)
The ID of the service desk the customer list should be returned from. This can alternatively be a project identifier.
Type: integer
query
The string used to filter the customer list.
Type: string
list_organizations
This method returns a list of organizations in the Jira Service Management instance. Use this method when you want to present a list of organizations or want to locate an organization by name.
Permissions required: Any. However, to fetch organizations based on accountId
the user must have a Service Desk agent license.
Response limitations: If the user is a customer, only those organizations of which the customer is a member are listed.
Parameters
cloudid (required)
Type: string
accountId
The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
Type: string
list_queues
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).
Permissions required: service desk's Agent.
Parameters
cloudid (required)
Type: string
serviceDeskId (required)
ID of the service desk whose queues will be returned. This can alternatively be a project identifier.
Type: integer
includeCount
Specifies whether to include each queue's customer request (issue) count in the response.
Type: boolean
list_request_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.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the customer request whose comments will be retrieved.
Type: string
expand
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.
Type: array
[ "string" ]
internal
Specifies whether to return internal comments or not. Default: true.
Type: boolean
public
Specifies whether to return public comments or not. Default: true.
Type: boolean
list_request_participants
This method returns a list of all the participants on a customer request.
Permissions required: Permission to view the customer request.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the customer request to be queried for its participants.
Type: string
list_request_types
This method returns all customer request types from a service desk. There are two parameters for filtering the returned list:
groupId
which filters the results to items in the customer request type group.searchQuery
which is matched against request types'name
ordescription
. For example, the strings "Install", "Inst", "Equi", or "Equipment" will match a request type with the name "Equipment Installation Request".
Permissions required: Permission to access the service desk.
Parameters
cloudid (required)
Type: string
serviceDeskId (required)
The ID of the service desk whose customer request types are to be returned. This can alternatively be a project identifier.
Type: integer
expand
Type: array
[ "string" ]
groupId
Filters results to those in a customer request type group.
Type: integer
searchQuery
The string to be used to filter the results.
Type: string
list_service_desks
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.
Permissions required: Any
Parameters
cloudid (required)
Type: string
list_sla_information
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.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the customer request whose SLAs will be retrieved.
Type: string
perform_customer_transition
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.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
ID or key of the issue to transition
Type: string
$body
Type: object
{
"id" : "ID of the transition to be performed.",
"additionalComment" : {
"body" : "Content of the comment."
}
}
post_feedback
This method adds a feedback on an request using it's requestKey
or requestId
Permissions required: User must be the reporter or an Atlassian Connect app.
Parameters
X-ExperimentalApi (required)
Type: string
cloudid (required)
Type: string
requestIdOrKey (required)
The id or the key of the request to post the feedback on
Type: string
$body
The feedback to be added on the request
Type: object
{
"rating" : "A numeric representation of the rating, this must be an integer value between 1 and 5.",
"comment" : {
"body" : "Content of the comment."
},
"type" : "Indicates the type of feedback, supported values: `csat`."
}
remove_customers
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.
Permissions required: Services desk administrator
Parameters
X-ExperimentalApi (required)
Type: string
cloudid (required)
Type: string
serviceDeskId (required)
The ID of the service desk the customers should be removed from. This can alternatively be a project identifier.
Type: integer
$body
Type: object
{
"accountIds" : [ "string" ],
"usernames" : [ "string" ]
}
remove_organization
This method removes an organization from a service desk. If the organization ID does not match an organization associated with the service desk, no change is made and the resource returns a 204 success code.
Permissions required: Service desk's agent.
Parameters
cloudid (required)
Type: string
serviceDeskId (required)
The ID of the service desk from which the organization will be removed. This can alternatively be a project identifier.
Type: integer
$body
Type: object
{
"organizationId" : "List of organizations, specified by 'ID' field values, to add to or remove from the service desk."
}
remove_request_participants
This method removes participants from a customer request.
Permissions required: Permission to manage participants on the customer request.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the customer request to have participants removed.
Type: string
$body
Type: object
{
"accountIds" : [ "string" ],
"usernames" : [ "string" ]
}
remove_users_from_organization
This method removes users from an organization.
Permissions required: Service desk administrator or agent. Note: Permission to delete users from an organization can be switched to users with the Jira administrator permission, using the Organization management feature.
Parameters
cloudid (required)
Type: string
organizationId (required)
The ID of the organization.
Type: integer
$body
Type: object
{
"accountIds" : [ "string" ],
"usernames" : [ "string" ]
}
set_organization_property
Sets the value of a property for an organization. Use this resource to store custom data against an organization.
Permissions required: Service Desk Administrator or Agent.
Note: Permission to manage organizations can be switched to users with the Jira administrator permission, using the Organization management feature.
Parameters
cloudid (required)
Type: string
organizationId (required)
The ID of the organization on which the property will be set.
Type: string
propertyKey (required)
The key of the organization's property. The maximum length of the key is 255 bytes.
Type: string
set_request_type_property
Sets the value of a request type property. Use this resource to store custom data against a request type.
Properties for a Request Type in next-gen are stored as Issue Type properties and therefore can also be set by calling the Jira Cloud Platform Set issue type property endpoint.
Permissions required: Jira project administrator with a Jira Service Management agent license.
Parameters
X-ExperimentalApi (required)
Type: string
cloudid (required)
Type: string
propertyKey (required)
The key of the request type property. The maximum length of the key is 255 bytes.
Type: string
requestTypeId (required)
The ID of the request type on which the property will be set.
Type: integer
serviceDeskId (required)
The ID of the service desk which contains the request type. This can alternatively be a project identifier.
Type: integer
subscribe
This method subscribes the user to receiving notifications from a customer request.
Permissions required: Permission to view the customer request.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the customer request to be subscribed to.
Type: string
unsubscribe
This method unsubscribes the user from notifications from a customer request.
Permissions required: Permission to view the customer request.
Parameters
cloudid (required)
Type: string
issueIdOrKey (required)
The ID or key of the customer request to be unsubscribed from.
Type: string