fetch-jsd

A simple and typed library, based on OpenAPI spec from developer.atlassian.com, for accessing product APIs.

Fetch Jsd - Documentation

CustomerApi
InfoApi
KnowledgebaseApi
OrganizationApi
RequestApi
RequesttypeApi
ServicedeskApi

Methods

The CustomerApi object

`createCustomer()` - Create customer

This method adds a customer to the Jira Service Desk 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.

Usage:

import { CustomerApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new CustomerApi(config).createCustomer({
  CustomerCreateDTO: { ... }
});

The InfoApi object

`getInfo()` - Get info

This method retrieves information about the Jira Service Desk instance such as software version, builds, and related links.

Usage:

import { InfoApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new InfoApi(config).getInfo({ ...args });

The KnowledgebaseApi object

`getArticles()` - Get articles

Returns articles which match the given query string across all service desks.

Usage:

import { KnowledgebaseApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new KnowledgebaseApi(config).getArticles({ ...args });

The OrganizationApi object

`addOrganization()` - 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.

Usage:

import { OrganizationApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new OrganizationApi(config).addOrganization({
  serviceDeskId: integer
  OrganizationServiceDeskUpdateDTO: { ... }
});

`addUsersToOrganization()` - Add users to organization

This method adds users to an organization.

Usage:

import { OrganizationApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new OrganizationApi(config).addUsersToOrganization({
  organizationId: integer
  UsersOrganizationUpdateDTO: { ... }
});

`createOrganization()` - Create organization

This method creates an organization by passing the name of the organization.

Usage:

import { OrganizationApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new OrganizationApi(config).createOrganization({
  OrganizationCreateDTO: { ... }
});

`deleteOrganization()` - 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.

Usage:

import { OrganizationApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new OrganizationApi(config).deleteOrganization({ ...args });

`deleteProperty()` - Delete property

Removes a property from an organization.

Usage:

import { OrganizationApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new OrganizationApi(config).deleteProperty({ ...args });

`getOrganization()` - 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.

Usage:

import { OrganizationApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new OrganizationApi(config).getOrganization({ ...args });

`getOrganizations()` - Get organizations

This method returns a list of organizations in the Jira Service Desk instance. Use this method when you want to present a list of organizations or want to locate an organization by name.

Usage:

import { OrganizationApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new OrganizationApi(config).getOrganizations({ ...args });

`getOrganizations1()` - Get organizations

This method returns a list of all organizations associated with a service desk.

Usage:

import { OrganizationApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new OrganizationApi(config).getOrganizations1({ ...args });

`getPropertiesKeys()` - Get 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.

Usage:

import { OrganizationApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new OrganizationApi(config).getPropertiesKeys({ ...args });

`getProperty()` - Get property

Returns the value of a property from an organization. Use this method to obtain the JSON content for an organization's property.

Usage:

import { OrganizationApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new OrganizationApi(config).getProperty({ ...args });

`getUsersInOrganization()` - 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.

Usage:

import { OrganizationApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new OrganizationApi(config).getUsersInOrganization({ ...args });

`removeOrganization()` - 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.

Usage:

import { OrganizationApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new OrganizationApi(config).removeOrganization({
  serviceDeskId: integer
  OrganizationServiceDeskUpdateDTO: { ... }
});

`removeUsersFromOrganization()` - Remove users from organization

This method removes users from an organization.

Usage:

import { OrganizationApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new OrganizationApi(config).removeUsersFromOrganization({
  organizationId: integer
  UsersOrganizationUpdateDTO: { ... }
});

`setProperty()` - Set property

Sets the value of a property for an organization. Use this resource to store custom data against an organization.

Usage:

import { OrganizationApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new OrganizationApi(config).setProperty({ ...args });

The RequestApi object

`addRequestParticipants()` - Add request participants

This method adds participants to a customer request.

Usage:

import { RequestApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new RequestApi(config).addRequestParticipants({
  issueIdOrKey: string
  RequestParticipantUpdateDTO: { ... }
});

`answerApproval()` - 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.

Usage:

import { RequestApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new RequestApi(config).answerApproval({
  issueIdOrKey: string
  approvalId: integer
  ApprovalDecisionRequestDTO: { ... }
});

`createAttachment()` - 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.

Usage:

import { RequestApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new RequestApi(config).createAttachment({
  issueIdOrKey: string
  AttachmentCreateDTO: { ... }
});

`createCustomerRequest()` - Create customer request

This method creates a customer request in a service desk.

Usage:

import { RequestApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new RequestApi(config).createCustomerRequest({
  RequestCreateDTO: { ... }
});

`createRequestComment()` - 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.

Usage:

import { RequestApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new RequestApi(config).createRequestComment({
  issueIdOrKey: string
  CommentCreateDTO: { ... }
});

`deleteFeedback()` - Delete feedback

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

Usage:

import { RequestApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new RequestApi(config).deleteFeedback({ ...args });

`getApprovalById()` - Get approval by id

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

Usage:

import { RequestApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new RequestApi(config).getApprovalById({ ...args });

`getApprovals()` - Get approvals

This method returns all approvals on a customer request.

Usage:

import { RequestApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new RequestApi(config).getApprovals({ ...args });

`getAttachmentsForRequest()` - Get attachments for request

This method returns all the attachments for a customer requests.

Usage:

import { RequestApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new RequestApi(config).getAttachmentsForRequest({ ...args });

`getCommentAttachments()` - Get comment attachments

This method returns the attachments referenced in a comment.

Usage:

import { RequestApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new RequestApi(config).getCommentAttachments({ ...args });

`getCustomerRequestByIdOrKey()` - Get customer request by id or key

This method returns a customer request.

Usage:

import { RequestApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new RequestApi(config).getCustomerRequestByIdOrKey({ ...args });

`getCustomerRequestStatus()` - 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.

Usage:

import { RequestApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new RequestApi(config).getCustomerRequestStatus({ ...args });

`getCustomerRequests()` - Get customer requests

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

Usage:

import { RequestApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new RequestApi(config).getCustomerRequests({ ...args });

`getCustomerTransitions()` - 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.

Usage:

import { RequestApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new RequestApi(config).getCustomerTransitions({ ...args });

`getFeedback()` - Get feedback

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

Usage:

import { RequestApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new RequestApi(config).getFeedback({ ...args });

`getRequestCommentById()` - Get request comment by id

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

Usage:

import { RequestApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new RequestApi(config).getRequestCommentById({ ...args });

`getRequestComments()` - Get 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.

Usage:

import { RequestApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new RequestApi(config).getRequestComments({ ...args });

`getRequestParticipants()` - Get request participants

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

Usage:

import { RequestApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new RequestApi(config).getRequestParticipants({ ...args });

`getSlaInformation()` - Get 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.

Usage:

import { RequestApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new RequestApi(config).getSlaInformation({ ...args });

`getSlaInformationById()` - Get sla information by id

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

Usage:

import { RequestApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new RequestApi(config).getSlaInformationById({ ...args });

`getSubscriptionStatus()` - 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.

Usage:

import { RequestApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new RequestApi(config).getSubscriptionStatus({ ...args });

`performCustomerTransition()` - 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.

Usage:

import { RequestApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new RequestApi(config).performCustomerTransition({
  issueIdOrKey: string
  CustomerTransitionExecutionDTO: { ... }
});

`postFeedback()` - Post feedback

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

Usage:

import { RequestApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new RequestApi(config).postFeedback({
  requestIdOrKey: string
  CSATFeedbackFullDTO: { ... }
});

`removeRequestParticipants()` - Remove request participants

This method removes participants from a customer request.

Usage:

import { RequestApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new RequestApi(config).removeRequestParticipants({
  issueIdOrKey: string
  RequestParticipantUpdateDTO: { ... }
});

`subscribe()` - Subscribe

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

Usage:

import { RequestApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new RequestApi(config).subscribe({ ...args });

`unsubscribe()` - Unsubscribe

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

Usage:

import { RequestApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new RequestApi(config).unsubscribe({ ...args });

The RequesttypeApi object

`getAllRequestTypes()` - Get all request types

This method returns all customer request types used in the Jira Service Desk instance, optionally filtered by a query string.

Usage:

import { RequesttypeApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new RequesttypeApi(config).getAllRequestTypes({ ...args });

The ServicedeskApi object

`addCustomers()` - 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.

Usage:

import { ServicedeskApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ServicedeskApi(config).addCustomers({
  serviceDeskId: integer
  ServiceDeskCustomerDTO: { ... }
});

`attachTemporaryFile()` - Attach temporary file

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.

Usage:

import { ServicedeskApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ServicedeskApi(config).attachTemporaryFile({
  serviceDeskId: integer
  bodies_attachTemporaryFile: { ... }
});

`createRequestType()` - 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:

Usage:

import { ServicedeskApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ServicedeskApi(config).createRequestType({
  serviceDeskId: integer
  RequestTypeCreateDTO: { ... }
});

`deleteProperty1()` - Delete property

Removes a property from a request type.

Usage:

import { ServicedeskApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ServicedeskApi(config).deleteProperty1({ ...args });

`getArticles1()` - Get articles

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

Usage:

import { ServicedeskApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ServicedeskApi(config).getArticles1({ ...args });

`getCustomers()` - Get customers

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

Usage:

import { ServicedeskApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ServicedeskApi(config).getCustomers({ ...args });

`getIssuesInQueue()` - 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.

Usage:

import { ServicedeskApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ServicedeskApi(config).getIssuesInQueue({ ...args });

`getPropertiesKeys1()` - Get properties keys

Returns the keys of all properties for a request type.

Usage:

import { ServicedeskApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ServicedeskApi(config).getPropertiesKeys1({ ...args });

`getProperty1()` - Get property

Returns the value of the property from a request type.

Usage:

import { ServicedeskApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ServicedeskApi(config).getProperty1({ ...args });

`getQueue()` - 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).

Usage:

import { ServicedeskApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ServicedeskApi(config).getQueue({ ...args });

`getQueues()` - Get 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).

Usage:

import { ServicedeskApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ServicedeskApi(config).getQueues({ ...args });

`getRequestTypeById()` - Get request type by id

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

Usage:

import { ServicedeskApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ServicedeskApi(config).getRequestTypeById({ ...args });

`getRequestTypeFields()` - Get request type fields

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

Usage:

import { ServicedeskApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ServicedeskApi(config).getRequestTypeFields({ ...args });

`getRequestTypeGroups()` - Get request type groups

This method returns a service desk's customer request type groups. Jira Service Desk 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.

Usage:

import { ServicedeskApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ServicedeskApi(config).getRequestTypeGroups({ ...args });

`getRequestTypes()` - Get request types

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

Usage:

import { ServicedeskApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ServicedeskApi(config).getRequestTypes({ ...args });

`getServiceDeskById()` - Get service desk by id

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.

Usage:

import { ServicedeskApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ServicedeskApi(config).getServiceDeskById({ ...args });

`getServiceDesks()` - Get service desks

This method returns all the service desks in the Jira Service Desk 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.

Usage:

import { ServicedeskApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ServicedeskApi(config).getServiceDesks({ ...args });

`removeCustomers()` - 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.

Usage:

import { ServicedeskApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ServicedeskApi(config).removeCustomers({
  serviceDeskId: integer
  ServiceDeskCustomerDTO: { ... }
});

`setProperty1()` - Set property

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

Usage:

import { ServicedeskApi, Configuration } from 'fetch-jsd';

const config: Configuration = new Configuration({
  fetchApi: yourFetchClient,
  basePath: "<your base path>"
});

const responsePromise = new ServicedeskApi(config).setProperty1({ ...args });

References

IncludedFields

{
  "type": "object",
  "properties": {
    "included": {
      "uniqueItems": true,
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "actuallyIncluded": {
      "uniqueItems": true,
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "excluded": {
      "uniqueItems": true,
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "additionalProperties": false
}

CustomerRequestActionsDTO

{
  "type": "object",
  "properties": {
    "addAttachment": {
      "description": "Action of adding attachments to a request.",
      "allOf": [
        {
          "$ref": "#/components/schemas/CustomerRequestActionDTO"
        }
      ]
    },
    "addComment": {
      "description": "Action of adding comments to a request.",
      "allOf": [
        {
          "$ref": "#/components/schemas/CustomerRequestActionDTO"
        }
      ]
    },
    "addParticipant": {
      "description": "Action of adding participants to a request.",
      "allOf": [
        {
          "$ref": "#/components/schemas/CustomerRequestActionDTO"
        }
      ]
    },
    "removeParticipant": {
      "description": "Action of removing participants from a request.",
      "allOf": [
        {
          "$ref": "#/components/schemas/CustomerRequestActionDTO"
        }
      ]
    }
  },
  "additionalProperties": false
}

PagedDTOOrganizationDTO

{
  "type": "object",
  "properties": {
    "size": {
      "type": "integer",
      "description": "Number of items returned in the page.",
      "format": "int32"
    },
    "start": {
      "type": "integer",
      "description": "Index of the first item returned in the page.",
      "format": "int32"
    },
    "limit": {
      "type": "integer",
      "description": "Number of items to be returned per page, up to the maximum set for these objects in the current implementation.",
      "format": "int32"
    },
    "isLastPage": {
      "type": "boolean",
      "description": "Indicates if this is the last page of records (true) or not (false)."
    },
    "values": {
      "type": "array",
      "description": "Details of the items included in the page.",
      "items": {
        "$ref": "#/components/schemas/OrganizationDTO"
      }
    },
    "_expands": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "_links": {
      "description": "List of the links relating to the page.",
      "allOf": [
        {
          "$ref": "#/components/schemas/PagedLinkDTO"
        }
      ]
    }
  },
  "additionalProperties": false
}

FieldMetadata

{
  "required": [
    "key",
    "name",
    "operations",
    "required"
  ],
  "type": "object",
  "properties": {
    "required": {
      "type": "boolean",
      "description": "Indicates whether the field is required.",
      "readOnly": true
    },
    "schema": {
      "description": "The data type of the field.",
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/JsonTypeBean"
        }
      ]
    },
    "name": {
      "type": "string",
      "description": "The name of the field.",
      "readOnly": true
    },
    "key": {
      "type": "string",
      "description": "The key of the field.",
      "readOnly": true
    },
    "autoCompleteUrl": {
      "type": "string",
      "description": "The URL that can be used to automatically complete the field.",
      "readOnly": true
    },
    "hasDefaultValue": {
      "type": "boolean",
      "description": "Indicates whether the field has a default value.",
      "readOnly": true
    },
    "operations": {
      "type": "array",
      "description": "The list of operations that can be performed on the field.",
      "readOnly": true,
      "items": {
        "type": "string",
        "readOnly": true
      }
    },
    "allowedValues": {
      "type": "array",
      "description": "The list of values allowed in the field.",
      "readOnly": true,
      "items": {
        "readOnly": true
      }
    },
    "defaultValue": {
      "description": "The default value of the field.",
      "readOnly": true
    }
  },
  "additionalProperties": false,
  "description": "The metadata describing an issue field.",
  "xml": {
    "name": "availableField"
  }
}

CommentCreateDTO

{
  "type": "object",
  "properties": {
    "body": {
      "type": "string",
      "description": "Content of the comment."
    },
    "public": {
      "type": "boolean",
      "description": "Indicates whether the comment is public (true) or private/internal (false)."
    }
  },
  "additionalProperties": false,
  "title": "CommentCreateDTO"
}

PageOfChangelogs

{
  "type": "object",
  "properties": {
    "startAt": {
      "type": "integer",
      "description": "The index of the first item returned on the page.",
      "format": "int32",
      "readOnly": true
    },
    "maxResults": {
      "type": "integer",
      "description": "The maximum number of results that could be on the page.",
      "format": "int32",
      "readOnly": true
    },
    "total": {
      "type": "integer",
      "description": "The number of results on the page.",
      "format": "int32",
      "readOnly": true
    },
    "histories": {
      "type": "array",
      "description": "The list of changelogs.",
      "readOnly": true,
      "items": {
        "$ref": "#/components/schemas/Changelog"
      }
    }
  },
  "additionalProperties": false,
  "description": "A page of changelogs."
}

SelfLinkDTO

{
  "type": "object",
  "properties": {
    "self": {
      "type": "string",
      "format": "uri"
    }
  },
  "additionalProperties": false
}

HistoryMetadata

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The type of the history record."
    },
    "description": {
      "type": "string",
      "description": "The description of the history record."
    },
    "descriptionKey": {
      "type": "string",
      "description": "The description key of the history record."
    },
    "activityDescription": {
      "type": "string",
      "description": "The activity described in the history record."
    },
    "activityDescriptionKey": {
      "type": "string",
      "description": "The key of the activity described in the history record."
    },
    "emailDescription": {
      "type": "string",
      "description": "The description of the email address associated the history record."
    },
    "emailDescriptionKey": {
      "type": "string",
      "description": "The description key of the email address associated the history record."
    },
    "actor": {
      "description": "Details of the user whose action created the history record.",
      "allOf": [
        {
          "$ref": "#/components/schemas/HistoryMetadataParticipant"
        }
      ]
    },
    "generator": {
      "description": "Details of the system that generated the history record.",
      "allOf": [
        {
          "$ref": "#/components/schemas/HistoryMetadataParticipant"
        }
      ]
    },
    "cause": {
      "description": "Details of the cause that triggered the creation the history record.",
      "allOf": [
        {
          "$ref": "#/components/schemas/HistoryMetadataParticipant"
        }
      ]
    },
    "extraData": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Additional arbitrary information about the history record."
    }
  },
  "additionalProperties": true,
  "description": "Details of issue history metadata."
}

UsersOrganizationUpdateDTO

{
  "type": "object",
  "properties": {
    "usernames": {
      "type": "array",
      "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. Use `accountIds` instead.",
      "items": {
        "type": "string"
      }
    },
    "accountIds": {
      "type": "array",
      "description": "List of customers, specific by account IDs, to add to or remove from the organization.",
      "items": {
        "type": "string"
      }
    }
  },
  "additionalProperties": false,
  "title": "UsersOrganizationUpdateDTO"
}

CustomerRequestFieldValueDTO

{
  "type": "object",
  "properties": {
    "fieldId": {
      "type": "string",
      "description": "ID of the field."
    },
    "label": {
      "type": "string",
      "description": "Text label for the field."
    },
    "value": {
      "description": "Value of the field."
    },
    "renderedValue": {
      "type": "object",
      "description": "Value of the field rendered in the UI."
    }
  },
  "additionalProperties": false
}

UserDTO

{
  "type": "object",
  "properties": {
    "accountId": {
      "type": "string",
      "description": "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*."
    },
    "name": {
      "type": "string",
      "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
    },
    "key": {
      "type": "string",
      "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details."
    },
    "emailAddress": {
      "type": "string",
      "description": "Customer's email address. Depending on the customer’s privacy settings, this may be returned as null."
    },
    "displayName": {
      "type": "string",
      "description": "Customer's name for display in a UI. Depending on the customer’s privacy settings, this may return an alternative value."
    },
    "active": {
      "type": "boolean",
      "description": "Indicates if the customer is active (true) or inactive (false)"
    },
    "timeZone": {
      "type": "string",
      "description": "Customer time zone. Depending on the customer’s privacy settings, this may be returned as null."
    },
    "_links": {
      "description": "URLs for the customer record and related items.",
      "allOf": [
        {
          "$ref": "#/components/schemas/UserLinkDTO"
        }
      ]
    }
  },
  "additionalProperties": false
}

PagedDTOUserDTO

{
  "type": "object",
  "properties": {
    "size": {
      "type": "integer",
      "description": "Number of items returned in the page.",
      "format": "int32"
    },
    "start": {
      "type": "integer",
      "description": "Index of the first item returned in the page.",
      "format": "int32"
    },
    "limit": {
      "type": "integer",
      "description": "Number of items to be returned per page, up to the maximum set for these objects in the current implementation.",
      "format": "int32"
    },
    "isLastPage": {
      "type": "boolean",
      "description": "Indicates if this is the last page of records (true) or not (false)."
    },
    "values": {
      "type": "array",
      "description": "Details of the items included in the page.",
      "items": {
        "$ref": "#/components/schemas/UserDTO"
      }
    },
    "_expands": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "_links": {
      "description": "List of the links relating to the page.",
      "allOf": [
        {
          "$ref": "#/components/schemas/PagedLinkDTO"
        }
      ]
    }
  },
  "additionalProperties": false
}

DateDTO

{
  "type": "object",
  "properties": {
    "iso8601": {
      "type": "string",
      "description": "Date in ISO8601 format."
    },
    "jira": {
      "type": "string",
      "description": "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": {
      "type": "string",
      "description": "Date in a user-friendly text format."
    },
    "epochMillis": {
      "type": "integer",
      "description": "Date as the number of milliseconds that have elapsed since 00:00:00 Coordinated Universal Time (UTC), 1 January 1970.",
      "format": "int64"
    }
  },
  "additionalProperties": false
}

SlaInformationDTO

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of the Service Level Agreement (SLA)."
    },
    "name": {
      "type": "string",
      "description": "Description of the SLA."
    },
    "completedCycles": {
      "type": "array",
      "description": "List of completed cycles for the SLA.",
      "items": {
        "$ref": "#/components/schemas/SlaInformationCompletedCycleDTO"
      }
    },
    "ongoingCycle": {
      "description": "Details of the active cycle for the SLA.",
      "allOf": [
        {
          "$ref": "#/components/schemas/SlaInformationOngoingCycleDTO"
        }
      ]
    },
    "_links": {
      "description": "REST API URL for the SLA.",
      "allOf": [
        {
          "$ref": "#/components/schemas/SelfLinkDTO"
        }
      ]
    }
  },
  "additionalProperties": false
}

ArticleDTO

{
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "description": "Title of the article."
    },
    "excerpt": {
      "type": "string",
      "description": "Excerpt of the article which matches the given query string."
    },
    "source": {
      "description": "Source of the article.",
      "allOf": [
        {
          "$ref": "#/components/schemas/SourceDTO"
        }
      ]
    },
    "content": {
      "$ref": "#/components/schemas/ContentDTO"
    }
  },
  "additionalProperties": false
}

SourceDTO

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "Type of the knowledge base source",
      "enum": [
        "confluence"
      ]
    }
  },
  "additionalProperties": true
}

UserDetails

{
  "type": "object",
  "properties": {
    "self": {
      "type": "string",
      "description": "The URL of the user.",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.",
      "readOnly": true
    },
    "key": {
      "type": "string",
      "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.",
      "readOnly": true
    },
    "accountId": {
      "type": "string",
      "description": "The accountId of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*."
    },
    "emailAddress": {
      "type": "string",
      "description": "The email address of the user. Depending on the user’s privacy settings, this may be returned as null.",
      "readOnly": true
    },
    "avatarUrls": {
      "description": "The avatars of the user.",
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/AvatarUrlsBean"
        }
      ]
    },
    "displayName": {
      "type": "string",
      "description": "The display name of the user. Depending on the user’s privacy settings, this may return an alternative value.",
      "readOnly": true
    },
    "active": {
      "type": "boolean",
      "description": "Whether the user is active.",
      "readOnly": true
    },
    "timeZone": {
      "type": "string",
      "description": "The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.",
      "readOnly": true
    },
    "accountType": {
      "type": "string",
      "description": "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)",
      "readOnly": true
    }
  },
  "additionalProperties": false,
  "description": "User details."
}

SimpleLink

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "styleClass": {
      "type": "string"
    },
    "iconClass": {
      "type": "string"
    },
    "label": {
      "type": "string"
    },
    "title": {
      "type": "string"
    },
    "href": {
      "type": "string"
    },
    "weight": {
      "type": "integer",
      "format": "int32"
    }
  },
  "additionalProperties": false,
  "description": "Details about the operations available in this version.",
  "xml": {
    "name": "link"
  }
}

RenderedValueDTO

{
  "type": "object",
  "properties": {
    "html": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

SlaInformationCompletedCycleDTO

{
  "type": "object",
  "properties": {
    "startTime": {
      "description": "Time and date at which the SLA cycle started.",
      "allOf": [
        {
          "$ref": "#/components/schemas/DateDTO"
        }
      ]
    },
    "stopTime": {
      "description": "Time and date at which the SLA cycle completed.",
      "allOf": [
        {
          "$ref": "#/components/schemas/DateDTO"
        }
      ]
    },
    "breached": {
      "type": "boolean",
      "description": "Indicates if the SLA (duration) was exceeded (true) or not (false)."
    },
    "goalDuration": {
      "description": "Duration within which the service should have been completed.",
      "allOf": [
        {
          "$ref": "#/components/schemas/DurationDTO"
        }
      ]
    },
    "elapsedTime": {
      "description": "Duration in which the service was completed.",
      "allOf": [
        {
          "$ref": "#/components/schemas/DurationDTO"
        }
      ]
    },
    "remainingTime": {
      "description": "Duration remaining after the service was completed.",
      "allOf": [
        {
          "$ref": "#/components/schemas/DurationDTO"
        }
      ]
    }
  },
  "additionalProperties": false
}

PagedDTOArticleDTO

{
  "type": "object",
  "properties": {
    "size": {
      "type": "integer",
      "description": "Number of items returned in the page.",
      "format": "int32"
    },
    "start": {
      "type": "integer",
      "description": "Index of the first item returned in the page.",
      "format": "int32"
    },
    "limit": {
      "type": "integer",
      "description": "Number of items to be returned per page, up to the maximum set for these objects in the current implementation.",
      "format": "int32"
    },
    "isLastPage": {
      "type": "boolean",
      "description": "Indicates if this is the last page of records (true) or not (false)."
    },
    "values": {
      "type": "array",
      "description": "Details of the items included in the page.",
      "items": {
        "$ref": "#/components/schemas/ArticleDTO"
      }
    },
    "_expands": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "_links": {
      "description": "List of the links relating to the page.",
      "allOf": [
        {
          "$ref": "#/components/schemas/PagedLinkDTO"
        }
      ]
    }
  },
  "additionalProperties": false
}

PagedDTOIssueBean

{
  "type": "object",
  "properties": {
    "size": {
      "type": "integer",
      "description": "Number of items returned in the page.",
      "format": "int32"
    },
    "start": {
      "type": "integer",
      "description": "Index of the first item returned in the page.",
      "format": "int32"
    },
    "limit": {
      "type": "integer",
      "description": "Number of items to be returned per page, up to the maximum set for these objects in the current implementation.",
      "format": "int32"
    },
    "isLastPage": {
      "type": "boolean",
      "description": "Indicates if this is the last page of records (true) or not (false)."
    },
    "values": {
      "type": "array",
      "description": "Details of the items included in the page.",
      "items": {
        "$ref": "#/components/schemas/IssueBean"
      }
    },
    "_expands": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "_links": {
      "description": "List of the links relating to the page.",
      "allOf": [
        {
          "$ref": "#/components/schemas/PagedLinkDTO"
        }
      ]
    }
  },
  "additionalProperties": false
}

RequestTypeDTO

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "ID for the request type."
    },
    "name": {
      "type": "string",
      "description": "Short name for the request type."
    },
    "description": {
      "type": "string",
      "description": "Description of the request type."
    },
    "helpText": {
      "type": "string",
      "description": "Help text for the request type."
    },
    "issueTypeId": {
      "type": "string",
      "description": "ID of the issue type the request type is based upon."
    },
    "serviceDeskId": {
      "type": "string",
      "description": "ID of the service desk the request type belongs to."
    },
    "groupIds": {
      "type": "array",
      "description": "List of the request type groups the request type belongs to.",
      "items": {
        "type": "string"
      }
    },
    "icon": {
      "description": "Links to the request type's icons.",
      "allOf": [
        {
          "$ref": "#/components/schemas/RequestTypeIconDTO"
        }
      ]
    },
    "fields": {
      "description": "Fields and additional metadata for creating a request that uses the request type",
      "allOf": [
        {
          "$ref": "#/components/schemas/CustomerRequestCreateMetaDTO"
        }
      ]
    },
    "_expands": {
      "type": "array",
      "description": "List of items that can be expanded in the response by specifying the expand query parameter.",
      "items": {
        "type": "string"
      }
    },
    "_links": {
      "description": "REST API URL for the request type.",
      "allOf": [
        {
          "$ref": "#/components/schemas/SelfLinkDTO"
        }
      ]
    }
  },
  "additionalProperties": false
}

Operations

{
  "type": "object",
  "properties": {
    "linkGroups": {
      "type": "array",
      "description": "Details of the link groups defining issue operations.",
      "readOnly": true,
      "items": {
        "$ref": "#/components/schemas/LinkGroup"
      }
    }
  },
  "additionalProperties": true,
  "description": "Details of the operations that can be performed on the issue."
}

CustomerTransitionDTO

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of the transition."
    },
    "name": {
      "type": "string",
      "description": "Name of the transition."
    }
  },
  "additionalProperties": false
}

HistoryMetadataParticipant

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the user or system associated with a history record."
    },
    "displayName": {
      "type": "string",
      "description": "The display name of the user or system associated with a history record."
    },
    "displayNameKey": {
      "type": "string",
      "description": "The key of the display name of the user or system associated with a history record."
    },
    "type": {
      "type": "string",
      "description": "The type of the user or system associated with a history record."
    },
    "avatarUrl": {
      "type": "string",
      "description": "The URL to an avatar for the user or system associated with a history record."
    },
    "url": {
      "type": "string",
      "description": "The URL of the user or system associated with a history record."
    }
  },
  "additionalProperties": true,
  "description": "Details of user or system associated with a issue history metadata item."
}

PagedDTOCustomerRequestStatusDTO

{
  "type": "object",
  "properties": {
    "size": {
      "type": "integer",
      "description": "Number of items returned in the page.",
      "format": "int32"
    },
    "start": {
      "type": "integer",
      "description": "Index of the first item returned in the page.",
      "format": "int32"
    },
    "limit": {
      "type": "integer",
      "description": "Number of items to be returned per page, up to the maximum set for these objects in the current implementation.",
      "format": "int32"
    },
    "isLastPage": {
      "type": "boolean",
      "description": "Indicates if this is the last page of records (true) or not (false)."
    },
    "values": {
      "type": "array",
      "description": "Details of the items included in the page.",
      "items": {
        "$ref": "#/components/schemas/CustomerRequestStatusDTO"
      }
    },
    "_expands": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "_links": {
      "description": "List of the links relating to the page.",
      "allOf": [
        {
          "$ref": "#/components/schemas/PagedLinkDTO"
        }
      ]
    }
  },
  "additionalProperties": false
}

OrganizationCreateDTO

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the organization."
    }
  },
  "additionalProperties": false,
  "title": "OrganizationCreateDTO"
}

ServiceDeskDTO

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of the service desk."
    },
    "projectId": {
      "type": "string",
      "description": "ID of the peer project for the service desk."
    },
    "projectName": {
      "type": "string",
      "description": "Name of the project and service desk."
    },
    "projectKey": {
      "type": "string",
      "description": "Key of the peer project of the service desk."
    },
    "_links": {
      "description": "REST API URL to the service desk.",
      "allOf": [
        {
          "$ref": "#/components/schemas/SelfLinkDTO"
        }
      ]
    }
  },
  "additionalProperties": false
}

RequestParticipantUpdateDTO

{
  "type": "object",
  "properties": {
    "usernames": {
      "type": "array",
      "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. Use `accountIds` instead.",
      "items": {
        "type": "string"
      }
    },
    "accountIds": {
      "type": "array",
      "description": "List of users, specified by account IDs, to add to or remove as participants in the request.",
      "items": {
        "type": "string"
      }
    }
  },
  "additionalProperties": false,
  "title": "RequestParticipantUpdateDTO"
}

SoftwareInfoDTO

{
  "type": "object",
  "properties": {
    "version": {
      "type": "string",
      "description": "Jira Service Desk version."
    },
    "platformVersion": {
      "type": "string",
      "description": "Jira Platform version upon which Service Desk is based."
    },
    "buildDate": {
      "description": "Date of the current build.",
      "allOf": [
        {
          "$ref": "#/components/schemas/DateDTO"
        }
      ]
    },
    "buildChangeSet": {
      "type": "string",
      "description": "Reference of the change set included in the build."
    },
    "isLicensedForUse": {
      "type": "boolean",
      "description": "Indicates whether the instance is licensed (true) or not (false)."
    },
    "_links": {
      "description": "REST API URL of the instance.",
      "allOf": [
        {
          "$ref": "#/components/schemas/SelfLinkDTO"
        }
      ]
    }
  },
  "additionalProperties": false
}

ApprovalDecisionRequestDTO

{
  "type": "object",
  "properties": {
    "decision": {
      "type": "string",
      "description": "Response to the approval request.",
      "enum": [
        "approve",
        "decline"
      ]
    }
  },
  "additionalProperties": false,
  "title": "ApprovalDecisionRequestDTO"
}

RequestTypeGroupDTO

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of the request type group"
    },
    "name": {
      "type": "string",
      "description": "Name of the request type group."
    }
  },
  "additionalProperties": false
}

OrganizationDTO

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "A unique system generated ID for the organization."
    },
    "name": {
      "type": "string",
      "description": "Name of the organization."
    },
    "_links": {
      "description": "REST API URL to the organization.",
      "allOf": [
        {
          "$ref": "#/components/schemas/SelfLinkDTO"
        }
      ]
    }
  },
  "additionalProperties": false
}

RequestTypeIconDTO

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of the request type icon."
    },
    "_links": {
      "description": "Map of the URLs for the request type icons.",
      "allOf": [
        {
          "$ref": "#/components/schemas/RequestTypeIconLinkDTO"
        }
      ]
    }
  },
  "additionalProperties": false
}

AvatarUrlsBean

{
  "type": "object",
  "properties": {
    "16x16": {
      "type": "string",
      "description": "The URL of the item's 16x16 pixel avatar.",
      "format": "uri"
    },
    "24x24": {
      "type": "string",
      "description": "The URL of the item's 24x24 pixel avatar.",
      "format": "uri"
    },
    "32x32": {
      "type": "string",
      "description": "The URL of the item's 32x32 pixel avatar.",
      "format": "uri"
    },
    "48x48": {
      "type": "string",
      "description": "The URL of the item's 48x48 pixel avatar.",
      "format": "uri"
    }
  },
  "additionalProperties": false
}

PagedDTOSlaInformationDTO

{
  "type": "object",
  "properties": {
    "size": {
      "type": "integer",
      "description": "Number of items returned in the page.",
      "format": "int32"
    },
    "start": {
      "type": "integer",
      "description": "Index of the first item returned in the page.",
      "format": "int32"
    },
    "limit": {
      "type": "integer",
      "description": "Number of items to be returned per page, up to the maximum set for these objects in the current implementation.",
      "format": "int32"
    },
    "isLastPage": {
      "type": "boolean",
      "description": "Indicates if this is the last page of records (true) or not (false)."
    },
    "values": {
      "type": "array",
      "description": "Details of the items included in the page.",
      "items": {
        "$ref": "#/components/schemas/SlaInformationDTO"
      }
    },
    "_expands": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "_links": {
      "description": "List of the links relating to the page.",
      "allOf": [
        {
          "$ref": "#/components/schemas/PagedLinkDTO"
        }
      ]
    }
  },
  "additionalProperties": false
}

RequestNotificationSubscriptionDTO

{
  "type": "object",
  "properties": {
    "subscribed": {
      "type": "boolean",
      "description": "Indicates whether the user is subscribed (true) or not (false) to the request's notifications."
    }
  },
  "additionalProperties": false
}

PropertyKeys

{
  "type": "object",
  "properties": {
    "keys": {
      "type": "array",
      "description": "Property key details.",
      "readOnly": true,
      "items": {
        "$ref": "#/components/schemas/PropertyKey"
      }
    }
  },
  "additionalProperties": false,
  "description": "List of property keys."
}

RequestTypeCreateDTO

{
  "type": "object",
  "properties": {
    "issueTypeId": {
      "type": "string",
      "description": "ID of the request type to add to the service desk."
    },
    "name": {
      "type": "string",
      "description": "Name of the request type on the service desk."
    },
    "description": {
      "type": "string",
      "description": "Description of the request type on the service desk."
    },
    "helpText": {
      "type": "string",
      "description": "Help text for the request type on the service desk."
    }
  },
  "additionalProperties": false,
  "title": "RequestTypeCreateDTO"
}

AdditionalCommentDTO

{
  "type": "object",
  "properties": {
    "body": {
      "type": "string",
      "description": "Content of the comment."
    }
  },
  "additionalProperties": false
}

RequestTypeFieldDTO

{
  "type": "object",
  "properties": {
    "fieldId": {
      "type": "string",
      "description": "ID of the field."
    },
    "name": {
      "type": "string",
      "description": "Name of the field."
    },
    "description": {
      "type": "string",
      "description": "Description of the field."
    },
    "required": {
      "type": "boolean",
      "description": "Indicates if the field is required (true) or not (false)."
    },
    "defaultValues": {
      "type": "array",
      "description": "List of default values for the field.",
      "items": {
        "$ref": "#/components/schemas/RequestTypeFieldValueDTO"
      }
    },
    "validValues": {
      "type": "array",
      "description": "List of valid values for the field.",
      "items": {
        "$ref": "#/components/schemas/RequestTypeFieldValueDTO"
      }
    },
    "jiraSchema": {
      "description": "Jira specific implementation details for the field in the UI.",
      "allOf": [
        {
          "$ref": "#/components/schemas/JsonTypeBean"
        }
      ]
    }
  },
  "additionalProperties": false
}

StatusDetails

{
  "type": "object",
  "properties": {
    "self": {
      "type": "string",
      "description": "The URL of the status.",
      "readOnly": true
    },
    "description": {
      "type": "string",
      "description": "The description of the status.",
      "readOnly": true
    },
    "iconUrl": {
      "type": "string",
      "description": "The URL of the icon used to represent the status.",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "description": "The name of the status.",
      "readOnly": true
    },
    "id": {
      "type": "string",
      "description": "The ID of the status.",
      "readOnly": true
    },
    "statusCategory": {
      "description": "The category assigned to the status.",
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/StatusCategory"
        }
      ]
    }
  },
  "additionalProperties": true,
  "description": "A status."
}

PagedDTOAttachmentDTO

{
  "type": "object",
  "properties": {
    "size": {
      "type": "integer",
      "description": "Number of items returned in the page.",
      "format": "int32"
    },
    "start": {
      "type": "integer",
      "description": "Index of the first item returned in the page.",
      "format": "int32"
    },
    "limit": {
      "type": "integer",
      "description": "Number of items to be returned per page, up to the maximum set for these objects in the current implementation.",
      "format": "int32"
    },
    "isLastPage": {
      "type": "boolean",
      "description": "Indicates if this is the last page of records (true) or not (false)."
    },
    "values": {
      "type": "array",
      "description": "Details of the items included in the page.",
      "items": {
        "$ref": "#/components/schemas/AttachmentDTO"
      }
    },
    "_expands": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "_links": {
      "description": "List of the links relating to the page.",
      "allOf": [
        {
          "$ref": "#/components/schemas/PagedLinkDTO"
        }
      ]
    }
  },
  "additionalProperties": false
}

PagedLinkDTO

{
  "type": "object",
  "properties": {
    "self": {
      "type": "string",
      "description": "REST API URL for the current page.",
      "format": "uri"
    },
    "base": {
      "type": "string",
      "description": "Base URL for the REST API calls.",
      "format": "uri"
    },
    "context": {
      "type": "string"
    },
    "next": {
      "type": "string",
      "description": "REST API URL for the next page, if there is one.",
      "format": "uri"
    },
    "prev": {
      "type": "string",
      "description": "REST API URL for the previous page, if there is one.",
      "format": "uri"
    }
  },
  "additionalProperties": false
}

RequestTypeIconLinkDTO

{
  "type": "object",
  "properties": {
    "iconUrls": {
      "type": "object",
      "additionalProperties": {
        "type": "string",
        "format": "uri"
      },
      "description": "URLs for the request type icons."
    }
  },
  "additionalProperties": false
}

CustomerRequestDTO

{
  "type": "object",
  "properties": {
    "issueId": {
      "type": "string",
      "description": "ID of the request, as the peer issue ID."
    },
    "issueKey": {
      "type": "string",
      "description": "Key of the request, as the peer issue key."
    },
    "requestTypeId": {
      "type": "string",
      "description": "ID of the request type for the request."
    },
    "requestType": {
      "description": "Expandable details of the request type.",
      "allOf": [
        {
          "$ref": "#/components/schemas/RequestTypeDTO"
        }
      ]
    },
    "serviceDeskId": {
      "type": "string",
      "description": "ID of the service desk the request belongs to."
    },
    "serviceDesk": {
      "description": "Expandable details of the service desk.",
      "allOf": [
        {
          "$ref": "#/components/schemas/ServiceDeskDTO"
        }
      ]
    },
    "createdDate": {
      "description": "Date on which the request was created.",
      "allOf": [
        {
          "$ref": "#/components/schemas/DateDTO"
        }
      ]
    },
    "reporter": {
      "description": "Details of the customer reporting the request.",
      "allOf": [
        {
          "$ref": "#/components/schemas/UserDTO"
        }
      ]
    },
    "requestFieldValues": {
      "type": "array",
      "description": "JSON map of Jira field IDs and their values representing the content of the request.",
      "items": {
        "$ref": "#/components/schemas/CustomerRequestFieldValueDTO"
      }
    },
    "currentStatus": {
      "description": "Status of the request.",
      "allOf": [
        {
          "$ref": "#/components/schemas/CustomerRequestStatusDTO"
        }
      ]
    },
    "status": {
      "description": "Expandable details of the request's status history.",
      "allOf": [
        {
          "$ref": "#/components/schemas/PagedDTOCustomerRequestStatusDTO"
        }
      ]
    },
    "participants": {
      "description": "Expandable details of the customers participating in the request.",
      "allOf": [
        {
          "$ref": "#/components/schemas/PagedDTOUserDTO"
        }
      ]
    },
    "sla": {
      "description": "Expandable details of the SLAs relating to the request.",
      "allOf": [
        {
          "$ref": "#/components/schemas/PagedDTOSlaInformationDTO"
        }
      ]
    },
    "attachments": {
      "description": "List of attachments included with the request.",
      "allOf": [
        {
          "$ref": "#/components/schemas/PagedDTOAttachmentDTO"
        }
      ]
    },
    "comments": {
      "description": "List of comments included with the request.",
      "allOf": [
        {
          "$ref": "#/components/schemas/PagedDTOCommentDTO"
        }
      ]
    },
    "actions": {
      "description": "List of actions that the user can take on the request.",
      "allOf": [
        {
          "$ref": "#/components/schemas/CustomerRequestActionsDTO"
        }
      ]
    },
    "_expands": {
      "type": "array",
      "description": "List of items that can be expanded in the response by specifying the expand query parameter.",
      "items": {
        "type": "string"
      }
    },
    "_links": {
      "description": "List of links associated with the request.",
      "allOf": [
        {
          "$ref": "#/components/schemas/CustomerRequestLinkDTO"
        }
      ]
    }
  },
  "additionalProperties": false
}

CustomerRequestLinkDTO

{
  "type": "object",
  "properties": {
    "self": {
      "type": "string",
      "format": "uri"
    },
    "jiraRest": {
      "type": "string",
      "description": "REST API URL for the request.",
      "format": "uri"
    },
    "web": {
      "type": "string",
      "description": "Web URL for the request.",
      "format": "uri"
    }
  },
  "additionalProperties": false
}

CSATFeedbackFullDTO

{
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "Indicates the type of feedback, supported values: `csat`."
    },
    "rating": {
      "type": "integer",
      "description": "A numeric representation of the rating, this must be an integer value between 1 and 5.",
      "format": "int32"
    },
    "comment": {
      "description": "(Optional) The comment provided with this feedback.",
      "allOf": [
        {
          "$ref": "#/components/schemas/AdditionalCommentDTO"
        }
      ]
    }
  },
  "additionalProperties": false,
  "title": "CSATFeedbackFullDTO"
}

CustomerRequestStatusDTO

{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "description": "Name of the status condition."
    },
    "statusCategory": {
      "type": "string",
      "description": "Status category the status belongs to.",
      "enum": [
        "UNDEFINED",
        "NEW",
        "INDETERMINATE",
        "DONE"
      ]
    },
    "statusDate": {
      "description": "Date on which the status was attained.",
      "allOf": [
        {
          "$ref": "#/components/schemas/DateDTO"
        }
      ]
    }
  },
  "additionalProperties": false
}

PagedDTOCommentDTO

{
  "type": "object",
  "properties": {
    "size": {
      "type": "integer",
      "description": "Number of items returned in the page.",
      "format": "int32"
    },
    "start": {
      "type": "integer",
      "description": "Index of the first item returned in the page.",
      "format": "int32"
    },
    "limit": {
      "type": "integer",
      "description": "Number of items to be returned per page, up to the maximum set for these objects in the current implementation.",
      "format": "int32"
    },
    "isLastPage": {
      "type": "boolean",
      "description": "Indicates if this is the last page of records (true) or not (false)."
    },
    "values": {
      "type": "array",
      "description": "Details of the items included in the page.",
      "items": {
        "$ref": "#/components/schemas/CommentDTO"
      }
    },
    "_expands": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "_links": {
      "description": "List of the links relating to the page.",
      "allOf": [
        {
          "$ref": "#/components/schemas/PagedLinkDTO"
        }
      ]
    }
  },
  "additionalProperties": false
}

CustomerCreateDTO

{
  "type": "object",
  "properties": {
    "email": {
      "type": "string",
      "description": "Customer's email address."
    },
    "fullName": {
      "type": "string",
      "description": "Deprecated, please use 'displayName'."
    },
    "displayName": {
      "type": "string",
      "description": "Customer's name for display in the UI."
    }
  },
  "additionalProperties": false,
  "title": "CustomerCreateDTO"
}

CommentDTO

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of the comment."
    },
    "body": {
      "type": "string",
      "description": "Content of the comment."
    },
    "renderedBody": {
      "description": "The rendered body of the comment.",
      "allOf": [
        {
          "$ref": "#/components/schemas/RenderedValueDTO"
        }
      ]
    },
    "author": {
      "description": "Details of the customer who authored the comment.",
      "allOf": [
        {
          "$ref": "#/components/schemas/UserDTO"
        }
      ]
    },
    "created": {
      "description": "Date the comment was created.",
      "allOf": [
        {
          "$ref": "#/components/schemas/DateDTO"
        }
      ]
    },
    "attachments": {
      "description": "List of the attachments included in the comment.",
      "allOf": [
        {
          "$ref": "#/components/schemas/PagedDTOAttachmentDTO"
        }
      ]
    },
    "_expands": {
      "type": "array",
      "description": "List of items that can be expanded in the response by specifying the expand query parameter.",
      "items": {
        "type": "string"
      }
    },
    "public": {
      "type": "boolean",
      "description": "Indicates whether the comment is public (true) or private/internal (false)."
    },
    "_links": {
      "description": "REST API URL link to the comment.",
      "allOf": [
        {
          "$ref": "#/components/schemas/SelfLinkDTO"
        }
      ]
    }
  },
  "additionalProperties": false
}

PagedDTOApprovalDTO

{
  "type": "object",
  "properties": {
    "size": {
      "type": "integer",
      "description": "Number of items returned in the page.",
      "format": "int32"
    },
    "start": {
      "type": "integer",
      "description": "Index of the first item returned in the page.",
      "format": "int32"
    },
    "limit": {
      "type": "integer",
      "description": "Number of items to be returned per page, up to the maximum set for these objects in the current implementation.",
      "format": "int32"
    },
    "isLastPage": {
      "type": "boolean",
      "description": "Indicates if this is the last page of records (true) or not (false)."
    },
    "values": {
      "type": "array",
      "description": "Details of the items included in the page.",
      "items": {
        "$ref": "#/components/schemas/ApprovalDTO"
      }
    },
    "_expands": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "_links": {
      "description": "List of the links relating to the page.",
      "allOf": [
        {
          "$ref": "#/components/schemas/PagedLinkDTO"
        }
      ]
    }
  },
  "additionalProperties": false
}

PagedDTOQueueDTO

{
  "type": "object",
  "properties": {
    "size": {
      "type": "integer",
      "description": "Number of items returned in the page.",
      "format": "int32"
    },
    "start": {
      "type": "integer",
      "description": "Index of the first item returned in the page.",
      "format": "int32"
    },
    "limit": {
      "type": "integer",
      "description": "Number of items to be returned per page, up to the maximum set for these objects in the current implementation.",
      "format": "int32"
    },
    "isLastPage": {
      "type": "boolean",
      "description": "Indicates if this is the last page of records (true) or not (false)."
    },
    "values": {
      "type": "array",
      "description": "Details of the items included in the page.",
      "items": {
        "$ref": "#/components/schemas/QueueDTO"
      }
    },
    "_expands": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "_links": {
      "description": "List of the links relating to the page.",
      "allOf": [
        {
          "$ref": "#/components/schemas/PagedLinkDTO"
        }
      ]
    }
  },
  "additionalProperties": false
}

IssueUpdateMetadata

{
  "type": "object",
  "properties": {
    "fields": {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/FieldMetadata"
      },
      "description": "A list of editable field details.",
      "readOnly": true
    }
  },
  "description": "A list of editable field details."
}

LinkGroup

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "styleClass": {
      "type": "string"
    },
    "header": {
      "$ref": "#/components/schemas/SimpleLink"
    },
    "weight": {
      "type": "integer",
      "format": "int32"
    },
    "links": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/SimpleLink"
      }
    },
    "groups": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/LinkGroup"
      }
    }
  },
  "additionalProperties": false,
  "description": "Details a link group, which defines issue operations."
}

OrganizationServiceDeskUpdateDTO

{
  "type": "object",
  "properties": {
    "organizationId": {
      "type": "integer",
      "description": "List of organizations, specified by 'ID' field values, to add to or remove from the service desk.",
      "format": "int32"
    }
  },
  "additionalProperties": false,
  "title": "OrganizationServiceDeskUpdateDTO"
}

ChangeDetails

{
  "type": "object",
  "properties": {
    "field": {
      "type": "string",
      "description": "The name of the field changed.",
      "readOnly": true
    },
    "fieldtype": {
      "type": "string",
      "description": "The type of the field changed.",
      "readOnly": true
    },
    "fieldId": {
      "type": "string",
      "description": "The ID of the field changed.",
      "readOnly": true
    },
    "from": {
      "type": "string",
      "description": "The details of the original value.",
      "readOnly": true
    },
    "fromString": {
      "type": "string",
      "description": "The details of the original value as a string.",
      "readOnly": true
    },
    "to": {
      "type": "string",
      "description": "The details of the new value.",
      "readOnly": true
    },
    "toString": {
      "type": "string",
      "description": "The details of the new value as a string.",
      "readOnly": true
    }
  },
  "additionalProperties": false,
  "description": "A change item."
}

ContentDTO

{
  "type": "object",
  "properties": {
    "iframeSrc": {
      "type": "string",
      "description": "Url containing the body of the article (without title), suitable for rendering in an iframe"
    }
  },
  "additionalProperties": false
}

EntityProperty

{
  "type": "object",
  "properties": {
    "key": {
      "type": "string",
      "description": "The key of the property. Required on create and update."
    },
    "value": {
      "description": "The value of the property. Required on create and update."
    }
  },
  "additionalProperties": false,
  "description": "An entity property, for more information see [Entity properties](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/)."
}

AttachmentDTO

{
  "type": "object",
  "properties": {
    "filename": {
      "type": "string",
      "description": "Filename of the item attached."
    },
    "author": {
      "description": "Details of the user who attached the file.",
      "allOf": [
        {
          "$ref": "#/components/schemas/UserDTO"
        }
      ]
    },
    "created": {
      "description": "Date the attachment was added.",
      "allOf": [
        {
          "$ref": "#/components/schemas/DateDTO"
        }
      ]
    },
    "size": {
      "type": "integer",
      "description": "Size of the attachment in bytes.",
      "format": "int64"
    },
    "mimeType": {
      "type": "string",
      "description": "MIME type of the attachment."
    },
    "_links": {
      "description": "Various URLs for the attachment.",
      "allOf": [
        {
          "$ref": "#/components/schemas/AttachmentLinkDTO"
        }
      ]
    }
  },
  "additionalProperties": false
}

StatusCategory

{
  "type": "object",
  "properties": {
    "self": {
      "type": "string",
      "description": "The URL of the status category.",
      "readOnly": true
    },
    "id": {
      "type": "integer",
      "description": "The ID of the status category.",
      "format": "int64",
      "readOnly": true
    },
    "key": {
      "type": "string",
      "description": "The key of the status category.",
      "readOnly": true
    },
    "colorName": {
      "type": "string",
      "description": "The name of the color used to represent the status category.",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "description": "The name of the status category.",
      "readOnly": true
    }
  },
  "additionalProperties": true,
  "description": "A status category."
}

RequestCreateDTO

{
  "type": "object",
  "properties": {
    "serviceDeskId": {
      "type": "string",
      "description": "ID of the service desk in which to create the request."
    },
    "requestTypeId": {
      "type": "string",
      "description": "ID of the request type for the request."
    },
    "requestFieldValues": {
      "type": "object",
      "additionalProperties": {},
      "description": "JSON map of Jira field IDs and their values representing the content of the request."
    },
    "requestParticipants": {
      "type": "array",
      "description": "List of customers to participate in the request, as a list of `accountId` values.",
      "items": {
        "type": "string"
      }
    },
    "raiseOnBehalfOf": {
      "type": "string",
      "description": "The `accountId` of the customer that the request is being raised on behalf of."
    },
    "channel": {
      "type": "string",
      "description": "(Experimental) Shows extra information for the request channel."
    }
  },
  "additionalProperties": false,
  "title": "RequestCreateDTO"
}

CustomerRequestCreateMetaDTO

{
  "type": "object",
  "properties": {
    "requestTypeFields": {
      "type": "array",
      "description": "List of the fields included in this request.",
      "items": {
        "$ref": "#/components/schemas/RequestTypeFieldDTO"
      }
    },
    "canRaiseOnBehalfOf": {
      "type": "boolean",
      "description": "Flag indicating if a request can be raised on behalf of another user (true) or not."
    },
    "canAddRequestParticipants": {
      "type": "boolean",
      "description": "Flag indicating if participants can be added to a request (true) or not."
    }
  },
  "additionalProperties": false
}

AttachmentLinkDTO

{
  "type": "object",
  "properties": {
    "self": {
      "type": "string",
      "format": "uri"
    },
    "jiraRest": {
      "type": "string",
      "description": "REST API URL for the attachment",
      "format": "uri"
    },
    "content": {
      "type": "string",
      "description": "URL for the attachment.",
      "format": "uri"
    },
    "thumbnail": {
      "type": "string",
      "description": "URL for the attachment's thumbnail image.",
      "format": "uri"
    }
  },
  "additionalProperties": false
}

I18nErrorMessage

{
  "type": "object",
  "properties": {
    "i18nKey": {
      "type": "string"
    },
    "parameters": {
      "type": "array",
      "items": {
        "type": "string"
      }
    }
  },
  "additionalProperties": false
}

AttachmentCreateDTO

{
  "type": "object",
  "properties": {
    "temporaryAttachmentIds": {
      "type": "array",
      "description": "List of IDs for the temporary attachments to be added to the customer request.",
      "items": {
        "type": "string"
      }
    },
    "additionalComment": {
      "description": "Comment about the attachments.",
      "allOf": [
        {
          "$ref": "#/components/schemas/AdditionalCommentDTO"
        }
      ]
    },
    "public": {
      "type": "boolean",
      "description": "Indicates whether the attachments are to be public (true) or private/internal (false)."
    }
  },
  "additionalProperties": false,
  "title": "AttachmentCreateDTO"
}

CustomerRequestActionDTO

{
  "type": "object",
  "properties": {
    "allowed": {
      "type": "boolean",
      "description": "Indicates whether the user can undertake the action (true) or not (false)."
    }
  },
  "additionalProperties": false
}

PagedDTORequestTypeGroupDTO

{
  "type": "object",
  "properties": {
    "size": {
      "type": "integer",
      "description": "Number of items returned in the page.",
      "format": "int32"
    },
    "start": {
      "type": "integer",
      "description": "Index of the first item returned in the page.",
      "format": "int32"
    },
    "limit": {
      "type": "integer",
      "description": "Number of items to be returned per page, up to the maximum set for these objects in the current implementation.",
      "format": "int32"
    },
    "isLastPage": {
      "type": "boolean",
      "description": "Indicates if this is the last page of records (true) or not (false)."
    },
    "values": {
      "type": "array",
      "description": "Details of the items included in the page.",
      "items": {
        "$ref": "#/components/schemas/RequestTypeGroupDTO"
      }
    },
    "_expands": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "_links": {
      "description": "List of the links relating to the page.",
      "allOf": [
        {
          "$ref": "#/components/schemas/PagedLinkDTO"
        }
      ]
    }
  },
  "additionalProperties": false
}

PagedDTOCustomerRequestDTO

{
  "type": "object",
  "properties": {
    "size": {
      "type": "integer",
      "description": "Number of items returned in the page.",
      "format": "int32"
    },
    "start": {
      "type": "integer",
      "description": "Index of the first item returned in the page.",
      "format": "int32"
    },
    "limit": {
      "type": "integer",
      "description": "Number of items to be returned per page, up to the maximum set for these objects in the current implementation.",
      "format": "int32"
    },
    "isLastPage": {
      "type": "boolean",
      "description": "Indicates if this is the last page of records (true) or not (false)."
    },
    "values": {
      "type": "array",
      "description": "Details of the items included in the page.",
      "items": {
        "$ref": "#/components/schemas/CustomerRequestDTO"
      }
    },
    "_expands": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "_links": {
      "description": "List of the links relating to the page.",
      "allOf": [
        {
          "$ref": "#/components/schemas/PagedLinkDTO"
        }
      ]
    }
  },
  "additionalProperties": false
}

Changelog

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the changelog.",
      "readOnly": true
    },
    "author": {
      "description": "The user who made the change.",
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/UserDetails"
        }
      ]
    },
    "created": {
      "type": "string",
      "description": "The date on which the change took place.",
      "format": "date-time",
      "readOnly": true
    },
    "items": {
      "type": "array",
      "description": "The list of items changed.",
      "readOnly": true,
      "items": {
        "$ref": "#/components/schemas/ChangeDetails"
      }
    },
    "historyMetadata": {
      "description": "The history metadata associated with the changed.",
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/HistoryMetadata"
        }
      ]
    }
  },
  "additionalProperties": false,
  "description": "A changelog."
}

AttachmentCreateResultDTO

{
  "type": "object",
  "properties": {
    "comment": {
      "description": "Details of the comment included with the attachments.",
      "allOf": [
        {
          "$ref": "#/components/schemas/CommentDTO"
        }
      ]
    },
    "attachments": {
      "description": "List of the attachments added.",
      "allOf": [
        {
          "$ref": "#/components/schemas/PagedDTOAttachmentDTO"
        }
      ]
    }
  },
  "additionalProperties": false
}

ApprovalDTO

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of the approval."
    },
    "name": {
      "type": "string",
      "description": "Description of the approval being sought or provided."
    },
    "finalDecision": {
      "type": "string",
      "description": "Outcome of the approval, based on the approvals provided by all approvers.",
      "enum": [
        "approved",
        "declined",
        "pending"
      ]
    },
    "canAnswerApproval": {
      "type": "boolean",
      "description": "Indicates whether the user making the request is one of the approvers and can respond to the approval (true) or not (false)."
    },
    "approvers": {
      "type": "array",
      "description": "Detailed list of the users who must provide a response to the approval.",
      "items": {
        "$ref": "#/components/schemas/ApproverDTO"
      }
    },
    "createdDate": {
      "description": "Date the approval was created.",
      "allOf": [
        {
          "$ref": "#/components/schemas/DateDTO"
        }
      ]
    },
    "completedDate": {
      "description": "Date the approval was completed.",
      "allOf": [
        {
          "$ref": "#/components/schemas/DateDTO"
        }
      ]
    },
    "_links": {
      "description": "The REST API URL of the approval.",
      "allOf": [
        {
          "$ref": "#/components/schemas/SelfLinkDTO"
        }
      ]
    }
  },
  "additionalProperties": false
}

QueueDTO

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "ID for the queue."
    },
    "name": {
      "type": "string",
      "description": "Short name for the queue."
    },
    "jql": {
      "type": "string",
      "description": "JQL query that filters reqeusts for the queue."
    },
    "fields": {
      "type": "array",
      "description": "Fields returned for each request in the queue.",
      "items": {
        "type": "string"
      }
    },
    "issueCount": {
      "type": "integer",
      "description": "The count of customer requests in the queue.",
      "format": "int64"
    },
    "_links": {
      "description": "REST API URL to the queue.",
      "allOf": [
        {
          "$ref": "#/components/schemas/SelfLinkDTO"
        }
      ]
    }
  },
  "additionalProperties": false
}

DurationDTO

{
  "type": "object",
  "properties": {
    "millis": {
      "type": "integer",
      "description": "Duration in milliseconds.",
      "format": "int64"
    },
    "friendly": {
      "type": "string",
      "description": "Duration in a user-friendly text format."
    }
  },
  "additionalProperties": false
}

UserLinkDTO

{
  "type": "object",
  "properties": {
    "self": {
      "type": "string",
      "format": "uri"
    },
    "jiraRest": {
      "type": "string",
      "description": "REST API URL for the customer.",
      "format": "uri"
    },
    "avatarUrls": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Links to the various sizes of the customer's avatar. Note that this property is deprecated, and will be removed in future versions."
    }
  },
  "additionalProperties": false
}

ServiceDeskCustomerDTO

{
  "type": "object",
  "properties": {
    "usernames": {
      "uniqueItems": true,
      "type": "array",
      "description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details. Use `accountIds` instead.",
      "items": {
        "type": "string"
      }
    },
    "accountIds": {
      "uniqueItems": true,
      "type": "array",
      "description": "List of users, specified by account IDs, to add to or remove from a service desk.",
      "items": {
        "type": "string"
      }
    }
  },
  "additionalProperties": false,
  "title": "ServiceDeskCustomerDTO"
}

RequestTypeFieldValueDTO

{
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "Value of the field."
    },
    "label": {
      "type": "string",
      "description": "Label for the field."
    },
    "children": {
      "type": "array",
      "description": "List of child fields.",
      "items": {
        "$ref": "#/components/schemas/RequestTypeFieldValueDTO"
      }
    }
  },
  "additionalProperties": false
}

IssueBean

{
  "type": "object",
  "properties": {
    "expand": {
      "type": "string",
      "description": "Expand options that include additional issue details in the response.",
      "readOnly": true,
      "xml": {
        "attribute": true
      }
    },
    "id": {
      "type": "string",
      "description": "The ID of the issue.",
      "readOnly": true
    },
    "self": {
      "type": "string",
      "description": "The URL of the issue details.",
      "format": "uri",
      "readOnly": true
    },
    "key": {
      "type": "string",
      "description": "The key of the issue.",
      "readOnly": true
    },
    "renderedFields": {
      "type": "object",
      "additionalProperties": {
        "readOnly": true
      },
      "description": "The rendered value of each field present on the issue.",
      "readOnly": true
    },
    "properties": {
      "type": "object",
      "additionalProperties": {
        "readOnly": true
      },
      "description": "Details of the issue properties identified in the request.",
      "readOnly": true
    },
    "names": {
      "type": "object",
      "additionalProperties": {
        "type": "string",
        "readOnly": true
      },
      "description": "The ID and name of each field present on the issue.",
      "readOnly": true
    },
    "schema": {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/JsonTypeBean"
      },
      "description": "The schema describing each field present on the issue.",
      "readOnly": true
    },
    "transitions": {
      "type": "array",
      "description": "The transitions that can be performed on the issue.",
      "readOnly": true,
      "items": {
        "$ref": "#/components/schemas/IssueTransition"
      }
    },
    "operations": {
      "description": "The operations that can be performed on the issue.",
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/Operations"
        }
      ]
    },
    "editmeta": {
      "description": "The metadata for the fields on the issue that can be amended.",
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/IssueUpdateMetadata"
        }
      ]
    },
    "changelog": {
      "description": "Details of changelogs associated with the issue.",
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/PageOfChangelogs"
        }
      ]
    },
    "versionedRepresentations": {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "additionalProperties": {
          "readOnly": true
        },
        "readOnly": true
      },
      "description": "The versions of each field on the issue.",
      "readOnly": true
    },
    "fieldsToInclude": {
      "$ref": "#/components/schemas/IncludedFields"
    },
    "fields": {
      "type": "object",
      "additionalProperties": {}
    }
  },
  "additionalProperties": false,
  "xml": {
    "name": "issue"
  }
}

CustomerTransitionExecutionDTO

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of the transition to be performed."
    },
    "additionalComment": {
      "description": "Comment explaining the reason for the transition.",
      "allOf": [
        {
          "$ref": "#/components/schemas/AdditionalCommentDTO"
        }
      ]
    }
  },
  "additionalProperties": false,
  "title": "CustomerTransitionExecutionDTO"
}

ApproverDTO

{
  "type": "object",
  "properties": {
    "approver": {
      "description": "Details of the User who is providing approval.",
      "allOf": [
        {
          "$ref": "#/components/schemas/UserDTO"
        }
      ]
    },
    "approverDecision": {
      "type": "string",
      "description": "Decision made by the approver.",
      "enum": [
        "approved",
        "declined",
        "pending"
      ]
    }
  },
  "additionalProperties": false
}

IssueTransition

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The ID of the issue transition. Required when specifying a transition to undertake."
    },
    "name": {
      "type": "string",
      "description": "The name of the issue transition.",
      "readOnly": true
    },
    "to": {
      "description": "Details of the issue status after the transition.",
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/StatusDetails"
        }
      ]
    },
    "hasScreen": {
      "type": "boolean",
      "description": "Indicates whether there is a screen associated with the issue transition.",
      "readOnly": true
    },
    "isGlobal": {
      "type": "boolean",
      "description": "Indicates whether the issue transition is global, that is, the transition is applied to issues regardless of their status.",
      "readOnly": true
    },
    "isInitial": {
      "type": "boolean",
      "description": "Indicates whether this is the initial issue transition for the workflow.",
      "readOnly": true
    },
    "isConditional": {
      "type": "boolean",
      "description": "Indicates whether the issue has to meet certain criteria before the issue transition is applied.",
      "readOnly": true
    },
    "fields": {
      "type": "object",
      "additionalProperties": {
        "$ref": "#/components/schemas/FieldMetadata"
      },
      "description": "Details of the fields associated with the issue transition screen. Use this information to populate `fields` and `update` in a transition request.",
      "readOnly": true
    },
    "expand": {
      "type": "string",
      "description": "Expand options that include additional transition details in the response.",
      "readOnly": true
    }
  },
  "additionalProperties": true,
  "description": "Details of an issue transition."
}

JsonTypeBean

{
  "required": [
    "type"
  ],
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "description": "The data type of the field.",
      "readOnly": true
    },
    "items": {
      "type": "string",
      "description": "When the data type is an array, the name of the field items within the array.",
      "readOnly": true
    },
    "system": {
      "type": "string",
      "description": "If the field is a system field, the name of the field.",
      "readOnly": true
    },
    "custom": {
      "type": "string",
      "description": "If the field is a custom field, the URI of the field.",
      "readOnly": true
    },
    "customId": {
      "type": "integer",
      "description": "If the field is a custom field, the custom ID of the field.",
      "format": "int64",
      "readOnly": true
    },
    "configuration": {
      "type": "object",
      "additionalProperties": {
        "readOnly": true
      },
      "description": "If the field is a custom field, the configuration of the field.",
      "readOnly": true
    }
  },
  "additionalProperties": false,
  "description": "The schema of a field."
}

PagedDTOServiceDeskDTO

{
  "type": "object",
  "properties": {
    "size": {
      "type": "integer",
      "description": "Number of items returned in the page.",
      "format": "int32"
    },
    "start": {
      "type": "integer",
      "description": "Index of the first item returned in the page.",
      "format": "int32"
    },
    "limit": {
      "type": "integer",
      "description": "Number of items to be returned per page, up to the maximum set for these objects in the current implementation.",
      "format": "int32"
    },
    "isLastPage": {
      "type": "boolean",
      "description": "Indicates if this is the last page of records (true) or not (false)."
    },
    "values": {
      "type": "array",
      "description": "Details of the items included in the page.",
      "items": {
        "$ref": "#/components/schemas/ServiceDeskDTO"
      }
    },
    "_expands": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "_links": {
      "description": "List of the links relating to the page.",
      "allOf": [
        {
          "$ref": "#/components/schemas/PagedLinkDTO"
        }
      ]
    }
  },
  "additionalProperties": false
}

SlaInformationOngoingCycleDTO

{
  "type": "object",
  "properties": {
    "startTime": {
      "description": "Time and date at which the SLA cycle started.",
      "allOf": [
        {
          "$ref": "#/components/schemas/DateDTO"
        }
      ]
    },
    "breachTime": {
      "description": "Time and date at which the SLA cycle would have breached its limit.",
      "allOf": [
        {
          "$ref": "#/components/schemas/DateDTO"
        }
      ]
    },
    "breached": {
      "type": "boolean",
      "description": "Indicates whether the SLA has been breached (true) or not (false)."
    },
    "paused": {
      "type": "boolean",
      "description": "Indicates whether the SLA is paused (true) or not (false)."
    },
    "withinCalendarHours": {
      "type": "boolean",
      "description": "Indicates whether the SLA it timed during calendared working hours only (true) or not (false)."
    },
    "goalDuration": {
      "description": "Duration within which the service should be completed.",
      "allOf": [
        {
          "$ref": "#/components/schemas/DurationDTO"
        }
      ]
    },
    "elapsedTime": {
      "description": "Duration of the service.",
      "allOf": [
        {
          "$ref": "#/components/schemas/DurationDTO"
        }
      ]
    },
    "remainingTime": {
      "description": "Duration remaining in which to complete the service.",
      "allOf": [
        {
          "$ref": "#/components/schemas/DurationDTO"
        }
      ]
    }
  },
  "additionalProperties": false
}

PagedDTORequestTypeDTO

{
  "type": "object",
  "properties": {
    "size": {
      "type": "integer",
      "description": "Number of items returned in the page.",
      "format": "int32"
    },
    "start": {
      "type": "integer",
      "description": "Index of the first item returned in the page.",
      "format": "int32"
    },
    "limit": {
      "type": "integer",
      "description": "Number of items to be returned per page, up to the maximum set for these objects in the current implementation.",
      "format": "int32"
    },
    "isLastPage": {
      "type": "boolean",
      "description": "Indicates if this is the last page of records (true) or not (false)."
    },
    "values": {
      "type": "array",
      "description": "Details of the items included in the page.",
      "items": {
        "$ref": "#/components/schemas/RequestTypeDTO"
      }
    },
    "_expands": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "_links": {
      "description": "List of the links relating to the page.",
      "allOf": [
        {
          "$ref": "#/components/schemas/PagedLinkDTO"
        }
      ]
    }
  },
  "additionalProperties": false
}

PagedDTOCustomerTransitionDTO

{
  "type": "object",
  "properties": {
    "size": {
      "type": "integer",
      "description": "Number of items returned in the page.",
      "format": "int32"
    },
    "start": {
      "type": "integer",
      "description": "Index of the first item returned in the page.",
      "format": "int32"
    },
    "limit": {
      "type": "integer",
      "description": "Number of items to be returned per page, up to the maximum set for these objects in the current implementation.",
      "format": "int32"
    },
    "isLastPage": {
      "type": "boolean",
      "description": "Indicates if this is the last page of records (true) or not (false)."
    },
    "values": {
      "type": "array",
      "description": "Details of the items included in the page.",
      "items": {
        "$ref": "#/components/schemas/CustomerTransitionDTO"
      }
    },
    "_expands": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "_links": {
      "description": "List of the links relating to the page.",
      "allOf": [
        {
          "$ref": "#/components/schemas/PagedLinkDTO"
        }
      ]
    }
  },
  "additionalProperties": false
}

ErrorResponse

{
  "type": "object",
  "properties": {
    "errorMessage": {
      "type": "string"
    },
    "i18nErrorMessage": {
      "$ref": "#/components/schemas/I18nErrorMessage"
    }
  },
  "additionalProperties": false
}

PropertyKey

{
  "type": "object",
  "properties": {
    "self": {
      "type": "string",
      "description": "The URL of the property.",
      "readOnly": true
    },
    "key": {
      "type": "string",
      "description": "The key of the property.",
      "readOnly": true
    }
  },
  "additionalProperties": false,
  "description": "Property key details."
}

bodies_attachTemporaryFile

{
  "type": "string",
  "format": "binary"
}

fetch-jsd

fetch-jsd

Fetch Jsd - Documentation

Contents

Methods

The CustomerApi object

createCustomer() - Create customer

The InfoApi object

getInfo() - Get info

The KnowledgebaseApi object

getArticles() - Get articles

The OrganizationApi object

addOrganization() - Add organization

addUsersToOrganization() - Add users to organization

createOrganization() - Create organization

deleteOrganization() - Delete organization

deleteProperty() - Delete property

getOrganization() - Get organization

getOrganizations() - Get organizations

getOrganizations1() - Get organizations

getPropertiesKeys() - Get properties keys

getProperty() - Get property

getUsersInOrganization() - Get users in organization

removeOrganization() - Remove organization

removeUsersFromOrganization() - Remove users from organization

setProperty() - Set property

The RequestApi object

addRequestParticipants() - Add request participants

answerApproval() - Answer approval

createAttachment() - Create attachment

createCustomerRequest() - Create customer request

createRequestComment() - Create request comment

deleteFeedback() - Delete feedback

getApprovalById() - Get approval by id

getApprovals() - Get approvals

getAttachmentsForRequest() - Get attachments for request

getCommentAttachments() - Get comment attachments

getCustomerRequestByIdOrKey() - Get customer request by id or key

getCustomerRequestStatus() - Get customer request status

getCustomerRequests() - Get customer requests

getCustomerTransitions() - Get customer transitions

getFeedback() - Get feedback

getRequestCommentById() - Get request comment by id

getRequestComments() - Get request comments

getRequestParticipants() - Get request participants

getSlaInformation() - Get sla information

getSlaInformationById() - Get sla information by id

getSubscriptionStatus() - Get subscription status

performCustomerTransition() - Perform customer transition

postFeedback() - Post feedback

removeRequestParticipants() - Remove request participants

subscribe() - Subscribe

unsubscribe() - Unsubscribe

The RequesttypeApi object

getAllRequestTypes() - Get all request types

The ServicedeskApi object

addCustomers() - Add customers

attachTemporaryFile() - Attach temporary file

createRequestType() - Create request type

deleteProperty1() - Delete property

getArticles1() - Get articles

getCustomers() - Get customers

getIssuesInQueue() - Get issues in queue

getPropertiesKeys1() - Get properties keys

getProperty1() - Get property

getQueue() - Get queue

getQueues() - Get queues

getRequestTypeById() - Get request type by id

getRequestTypeFields() - Get request type fields

getRequestTypeGroups() - Get request type groups

getRequestTypes() - Get request types

getServiceDeskById() - Get service desk by id

getServiceDesks() - Get service desks

removeCustomers() - Remove customers

setProperty1() - Set property

References

IncludedFields

CustomerRequestActionsDTO

PagedDTOOrganizationDTO

FieldMetadata

`createCustomer()` - Create customer

`getInfo()` - Get info

`getArticles()` - Get articles

`addOrganization()` - Add organization

`addUsersToOrganization()` - Add users to organization

`createOrganization()` - Create organization

`deleteOrganization()` - Delete organization

`deleteProperty()` - Delete property

`getOrganization()` - Get organization

`getOrganizations()` - Get organizations

`getOrganizations1()` - Get organizations

`getPropertiesKeys()` - Get properties keys

`getProperty()` - Get property

`getUsersInOrganization()` - Get users in organization

`removeOrganization()` - Remove organization

`removeUsersFromOrganization()` - Remove users from organization

`setProperty()` - Set property

`addRequestParticipants()` - Add request participants

`answerApproval()` - Answer approval

`createAttachment()` - Create attachment

`createCustomerRequest()` - Create customer request

`createRequestComment()` - Create request comment

`deleteFeedback()` - Delete feedback

`getApprovalById()` - Get approval by id

`getApprovals()` - Get approvals

`getAttachmentsForRequest()` - Get attachments for request

`getCommentAttachments()` - Get comment attachments

`getCustomerRequestByIdOrKey()` - Get customer request by id or key

`getCustomerRequestStatus()` - Get customer request status

`getCustomerRequests()` - Get customer requests

`getCustomerTransitions()` - Get customer transitions

`getFeedback()` - Get feedback

`getRequestCommentById()` - Get request comment by id

`getRequestComments()` - Get request comments

`getRequestParticipants()` - Get request participants

`getSlaInformation()` - Get sla information

`getSlaInformationById()` - Get sla information by id

`getSubscriptionStatus()` - Get subscription status

`performCustomerTransition()` - Perform customer transition

`postFeedback()` - Post feedback

`removeRequestParticipants()` - Remove request participants

`subscribe()` - Subscribe

`unsubscribe()` - Unsubscribe

`getAllRequestTypes()` - Get all request types

`addCustomers()` - Add customers

`attachTemporaryFile()` - Attach temporary file

`createRequestType()` - Create request type

`deleteProperty1()` - Delete property

`getArticles1()` - Get articles

`getCustomers()` - Get customers

`getIssuesInQueue()` - Get issues in queue

`getPropertiesKeys1()` - Get properties keys

`getProperty1()` - Get property

`getQueue()` - Get queue

`getQueues()` - Get queues

`getRequestTypeById()` - Get request type by id

`getRequestTypeFields()` - Get request type fields

`getRequestTypeGroups()` - Get request type groups

`getRequestTypes()` - Get request types

`getServiceDeskById()` - Get service desk by id

`getServiceDesks()` - Get service desks

`removeCustomers()` - Remove customers

`setProperty1()` - Set property