fetch-jsd/openapi.json

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

{"openapi":"3.0.1","info":{"title":"Service Desk Public REST API","description":"Public REST API for Jira Service Desk","termsOfService":"https://www.atlassian.com/legal/customer-agreement","version":"1001.0.0-SNAPSHOT"},"servers":[{"url":"https://your-domain.atlassian.net"}],"tags":[{"name":"Customer"},{"name":"Info"},{"name":"Knowledgebase"},{"name":"Organization"},{"name":"Request"},{"name":"Requesttype"},{"name":"Servicedesk"}],"paths":{"/rest/servicedeskapi/customer":{"post":{"tags":["Customer"],"summary":"Create customer","description":"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.\n\n**[Permissions](#permissions) required**: Jira Administrator Global permission","operationId":"com.atlassian.servicedesk.api.rest.resource.CustomerResource.createCustomer_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerCreateDTO"},"example":{"displayName":"Fred F. User","email":"fred@example.com"}}},"required":true},"responses":{"201":{"description":"Returns the customer details.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDTO"},"example":"{\"accountId\":\"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\",\"name\":\"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\",\"key\":\"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\",\"emailAddress\":\"fred@example.com\",\"displayName\":\"Fred F. User\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"_links\":{\"jiraRest\":\"https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\",\"avatarUrls\":{\"48x48\":\"https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue\",\"24x24\":\"https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue\",\"16x16\":\"https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue\",\"32x32\":\"https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue\"},\"self\":\"https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\"}}"}}},"400":{"description":"Returned if the request is invalid, either because the email address is incorrectly formed or already exists in the database.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Returned if the user is not logged in.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Returned if the user does not have permission to complete this request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"deprecated":false,"security":[{"OAuth2":["manage:servicedesk-customer"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/servicedeskapi/info":{"get":{"tags":["Info"],"summary":"Get info","description":"This method retrieves information about the Jira Service Desk instance such as software version, builds, and related links.\n\n**[Permissions](#permissions) required**: None, the user does not need to be logged in.","operationId":"com.atlassian.servicedesk.api.rest.resource.SoftwareInfoResource.getInfo_get","responses":{"200":{"description":"Returns the runtime information for the Jira Service Desk instance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SoftwareInfoDTO"},"example":"{\"version\":\"3.0.1\",\"platformVersion\":\"7.0.1\",\"buildDate\":{\"iso8601\":\"2015-09-15T02:34:00+0700\",\"jira\":\"2015-09-15T02:34:00.000+0700\",\"friendly\":\"Monday 02:34 AM\",\"epochMillis\":1442259240000},\"buildChangeSet\":\"c6679417c550918e7c94a9eaaada133f15dc8ff0\",\"isLicensedForUse\":true,\"_links\":{\"self\":\"https://your-domain.atlassian.net/rest/servicedeskapi/info\"}}"}}},"500":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"deprecated":false,"x-atlassian-connect-scope":"READ"}},"/rest/servicedeskapi/knowledgebase/article":{"get":{"tags":["Knowledgebase"],"summary":"Get articles","description":"Returns articles which match the given query string across all service desks.\n\n**[Permissions](#permissions) required**: Permission to access the [customer portal](https://confluence.atlassian.com/servicedeskcloud/configuring-the-customer-portal-732528918.html).","operationId":"com.atlassian.servicedesk.api.rest.resource.KBResource.getArticles_get","parameters":[{"name":"query","in":"query","description":"The string used to filter the articles (required).","schema":{"type":"string"}},{"name":"highlight","in":"query","description":"If set to true matching query term in the title and excerpt will be highlighted using the \\{@code @@@hl@@@term@@@endhl@@@\\} syntax. Default: false.","schema":{"type":"boolean","default":false}},{"name":"start","in":"query","description":"The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details.","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"The maximum number of items to return per page. Default: 100. See the [Pagination](#pagination) section for more details.","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the articles, on the specified page of the results.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedDTOArticleDTO"},"example":"{\"_expands\":[],\"size\":2,\"start\":2,\"limit\":2,\"isLastPage\":false,\"_links\":{\"base\":\"https://your-domain.atlassian.net/rest/servicedeskapi\",\"context\":\"context\",\"next\":\"https://your-domain.atlassian.net/rest/servicedeskapi/knowledgebase/article?start=4&limit=2\",\"prev\":\"https://your-domain.atlassian.net/rest/servicedeskapi/knowledgebase/article?start=0&limit=2\"},\"values\":[{\"title\":\"Stolen computer\",\"excerpt\":\"assuming your computer was stolen\",\"source\":{\"type\":\"confluence\",\"pageId\":\"8786177\",\"spaceKey\":\"IT\"},\"content\":{\"iframeSrc\":\"https://your-domain.atlassian.net/rest/servicedeskapi/knowledgebase/article/view/8786177\"}},{\"title\":\"Upgrading computer\",\"excerpt\":\"each computer older then 3 years can be upgraded\",\"source\":{\"type\":\"confluence\",\"pageId\":\"8785228\",\"spaceKey\":\"IT\"},\"content\":{\"iframeSrc\":\"https://your-domain.atlassian.net/rest/servicedeskapi/knowledgebase/article/view/8785228\"}}]}"}}},"400":{"description":"Returned if the request is invalid. For example: missing query parameter.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Returned if the user is not logged in.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Returned if the user does not have permission to complete this request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"deprecated":false,"x-experimental":true,"x-atlassian-connect-scope":"READ"}},"/rest/servicedeskapi/organization":{"get":{"tags":["Organization"],"summary":"Get organizations","description":"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.\n\n**[Permissions](#permissions) required**: Any\n\n**Response limitations**: If the user is a customer, only those organizations of which the customer is a member are listed.","operationId":"com.atlassian.servicedesk.api.rest.resource.OrganizationResource.getOrganizations_get","parameters":[{"name":"start","in":"query","description":"The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details.","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"The maximum number of organizations to return per page. Default: 50. See the [Pagination](#pagination) section for more details.","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns paginated list of organizations.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedDTOOrganizationDTO"},"example":"{\"_expands\":[],\"size\":1,\"start\":1,\"limit\":1,\"isLastPage\":false,\"_links\":{\"base\":\"https://your-domain.atlassian.net/rest/servicedeskapi\",\"context\":\"context\",\"next\":\"https://your-domain.atlassian.net/rest/servicedeskapi/organization?start=2&limit=1\",\"prev\":\"https://your-domain.atlassian.net/rest/servicedeskapi/organization?start=0&limit=1\"},\"values\":[{\"id\":\"1\",\"name\":\"Charlie Cakes Franchises\",\"_links\":{\"self\":\"https://your-domain.atlassian.net/rest/servicedeskapi/organization/1\"}}]}"}}},"401":{"description":"Returned if the user is not logged in.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"deprecated":false,"security":[{"OAuth2":["manage:servicedesk-customer"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Organization"],"summary":"Create organization","description":"This method creates an organization by passing the name of the organization.\n\n**[Permissions](#permissions) required**: Service desk administrator or agent. Note: Permission to create organizations can be switched to users with the Jira administrator permission, using the **[Organization management](https://confluence.atlassian.com/servicedeskcloud/setting-up-service-desk-users-732528877.html#Settingupservicedeskusers-manageorgsManageorganizations)** feature.","operationId":"com.atlassian.servicedesk.api.rest.resource.OrganizationResource.createOrganization_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationCreateDTO"},"example":{"name":"Charlie Cakes Franchises"}}},"required":true},"responses":{"201":{"description":"Returns the created organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationDTO"},"example":"{\"id\":\"1\",\"name\":\"Charlie Cakes Franchises\",\"_links\":{\"self\":\"https://your-domain.atlassian.net/rest/servicedeskapi/organization/1\"}}"}}},"400":{"description":"Returned if the HTTP request is invalid, which if the HTTP request was correctly formed means that the organization name already exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Returned if the user is not logged in.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Returned if the user does not have permission to complete this request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"deprecated":false,"security":[{"OAuth2":["manage:servicedesk-customer"]}],"x-atlassian-connect-scope":"ADMIN"}},"/rest/servicedeskapi/organization/{organizationId}":{"get":{"tags":["Organization"],"summary":"Get organization","description":"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.\n\n**[Permissions](#permissions) required**: Any\n\n**Response limitations**: Customers can only retrieve organization of which they are members.","operationId":"com.atlassian.servicedesk.api.rest.resource.OrganizationResource.getOrganization_get","parameters":[{"name":"organizationId","in":"path","description":"The ID of the organization.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the requested organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationDTO"},"example":"{\"id\":\"1\",\"name\":\"Charlie Cakes Franchises\",\"_links\":{\"self\":\"https://your-domain.atlassian.net/rest/servicedeskapi/organization/1\"}}"}}},"401":{"description":"Returned if the user is not logged in.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Returned if the user does not have permission to complete this request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Returned if the organization does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"deprecated":false,"security":[{"OAuth2":["manage:servicedesk-customer"]}],"x-atlassian-connect-scope":"READ"},"delete":{"tags":["Organization"],"summary":"Delete organization","description":"This method deletes an organization. Note that the organization is deleted regardless of other associations it may have. For example, associations with service desks.\n\n**[Permissions](#permissions) required**: Jira administrator.","operationId":"com.atlassian.servicedesk.api.rest.resource.OrganizationResource.deleteOrganization_delete","parameters":[{"name":"organizationId","in":"path","description":"The ID of the organization.","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"Returned if the organization was deleted."},"401":{"description":"Returned if the user is not logged in.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Returned if the user does not have permission to complete this request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Returned if the organization does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"deprecated":false,"security":[{"OAuth2":["manage:servicedesk-customer"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/servicedeskapi/organization/{organizationId}/property":{"get":{"tags":["Organization"],"summary":"Get properties keys","description":"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.\n\n**[Permissions](#permissions) required**: Any\n\n**Response limitations**: Customers can only access properties of organizations of which they are members.","operationId":"com.atlassian.servicedesk.api.rest.resource.OrganizationPropertyResource.getPropertiesKeys_get","parameters":[{"name":"organizationId","in":"path","description":"The ID of the organization from which keys will be returned.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the organization was found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyKeys"},"example":"{\"keys\":[{\"self\":\"/rest/servicedeskapi/organization/1/property/propertyKey\",\"key\":\"organization.attributes\"}]}"}}},"400":{"description":"Returned if the organization ID is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Returned if the user is not logged in.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Returned if the user does not have permission to complete this request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Returned if the organization does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"deprecated":false,"security":[{"OAuth2":["manage:servicedesk-customer"]}],"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/servicedeskapi/organization/{organizationId}/property/{propertyKey}":{"get":{"tags":["Organization"],"summary":"Get property","description":"Returns the value of a property from an organization. Use this method to obtain the JSON content for an organization's property.\n\n**[Permissions](#permissions) required**: Any\n\n**Response limitations**: Customers can only access properties of organizations of which they are members.","operationId":"com.atlassian.servicedesk.api.rest.resource.OrganizationPropertyResource.getProperty_get","parameters":[{"name":"organizationId","in":"path","description":"The ID of the organization from which the property will be returned.","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the property to return.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns the organization's property.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityProperty"},"example":"{\"key\":\"organization.attributes\",\"value\":{\"phone\":\"0800-1233456789\",\"mail\":\"charlie@example.com\"}}"}}},"400":{"description":"Returned if the organization ID is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Returned if the user is not logged in.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Returned if the user does not have permission to complete this request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Returned if the organization or property do not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"deprecated":false,"security":[{"OAuth2":["manage:servicedesk-customer"]}],"x-atlassian-connect-scope":"INACCESSIBLE"},"put":{"tags":["Organization"],"summary":"Set property","description":"Sets the value of a property for an organization. Use this resource to store custom data against an organization.\n\n**[Permissions](#permissions) required**: Service Desk Administrator or Agent.\n\nNote: Permission to manage organizations can be switched to users with the Jira administrator permission, using the **[Organization management](https://confluence.atlassian.com/servicedeskcloud/setting-up-service-desk-users-732528877.html#Settingupservicedeskusers-manageorgsManageorganizations)** feature.","operationId":"com.atlassian.servicedesk.api.rest.resource.OrganizationPropertyResource.setProperty_put","parameters":[{"name":"organizationId","in":"path","description":"The ID of the organization on which the property will be set.","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the organization's property. The maximum length of the key is 255 bytes.","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returned if the organization property was updated.","content":{"application/json":{"schema":{"type":"object"}}}},"201":{"description":"Returned if the organization property was created.","content":{"application/json":{"schema":{"type":"object"}}}},"400":{"description":"Returned if the organization ID is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Returned if the user is not logged in.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Returned if the user does not have permission to complete this request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Returned if the organization does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"deprecated":false,"security":[{"OAuth2":["manage:servicedesk-customer"]}],"x-atlassian-connect-scope":"INACCESSIBLE"},"delete":{"tags":["Organization"],"summary":"Delete property","description":"Removes a property from an organization.\n\n**[Permissions](#permissions) required**: Service Desk Administrator or Agent.\n\nNote: Permission to manage organizations can be switched to users with the Jira administrator permission, using the **[Organization management](https://confluence.atlassian.com/servicedeskcloud/setting-up-service-desk-users-732528877.html#Settingupservicedeskusers-manageorgsManageorganizations)** feature.","operationId":"com.atlassian.servicedesk.api.rest.resource.OrganizationPropertyResource.deleteProperty_delete","parameters":[{"name":"organizationId","in":"path","description":"The ID of the organization from which the property will be removed.","required":true,"schema":{"type":"string"}},{"name":"propertyKey","in":"path","description":"The key of the property to remove.","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Returned if the organization property was removed."},"400":{"description":"Returned if the organization ID is invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Returned if the user is not logged in.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Returned if the user does not have permission to complete this request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Returned if the organization or property do not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"deprecated":false,"security":[{"OAuth2":["manage:servicedesk-customer"]}],"x-atlassian-connect-scope":"INACCESSIBLE"}},"/rest/servicedeskapi/organization/{organizationId}/user":{"get":{"tags":["Organization"],"summary":"Get users in organization","description":"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.\n\n**[Permissions](#permissions) required**: Service desk administrator or agent.","operationId":"com.atlassian.servicedesk.api.rest.resource.OrganizationResource.getUsersInOrganization_get","parameters":[{"name":"organizationId","in":"path","description":"The ID of the organization.","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"start","in":"query","description":"The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details.","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"The maximum number of users to return per page. Default: 50. See the [Pagination](#pagination) section for more details.","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns a paged list of users associated with the organization, ordered by their accountId.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedDTOUserDTO"},"example":"{\"_expands\":[],\"size\":1,\"start\":1,\"limit\":1,\"isLastPage\":false,\"_links\":{\"base\":\"https://your-domain.atlassian.net/rest/servicedeskapi\",\"context\":\"context\",\"next\":\"https://your-domain.atlassian.net/rest/servicedeskapi/organization/1/user?start=2&limit=1\",\"prev\":\"https://your-domain.atlassian.net/rest/servicedeskapi/organization/1/user?start=0&limit=1\"},\"values\":[{\"accountId\":\"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\",\"name\":\"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\",\"key\":\"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\",\"emailAddress\":\"fred@example.com\",\"displayName\":\"Fred F. User\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"_links\":{\"jiraRest\":\"https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\",\"avatarUrls\":{\"48x48\":\"https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue\",\"24x24\":\"https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue\",\"16x16\":\"https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue\",\"32x32\":\"https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue\"},\"self\":\"https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\"}},{\"accountId\":\"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3a01db05e2a66fa80bd\",\"name\":\"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3a01db05e2a66fa80bd\",\"key\":\"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3a01db05e2a66fa80bd\",\"emailAddress\":\"bob@example.com\",\"displayName\":\"Bob D. Builder\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"_links\":{\"jiraRest\":\"https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3a01db05e2a66fa80bd\",\"avatarUrls\":{\"48x48\":\"https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue\",\"24x24\":\"https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue\",\"16x16\":\"https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue\",\"32x32\":\"https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue\"},\"self\":\"https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3a01db05e2a66fa80bd\"}}]}"}}},"401":{"description":"Returned if the user is not logged in.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Returned if the user does not have permission to complete this request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Returned if the organization does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"deprecated":false,"security":[{"OAuth2":["manage:servicedesk-customer"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Organization"],"summary":"Add users to organization","description":"This method adds users to an organization.\n\n**[Permissions](#permissions) required**: Service desk administrator or agent. Note: Permission to add users to an organization can be switched to users with the Jira administrator permission, using the **[Organization management](https://confluence.atlassian.com/servicedeskcloud/setting-up-service-desk-users-732528877.html#Settingupservicedeskusers-manageorgsManageorganizations)** feature.","operationId":"com.atlassian.servicedesk.api.rest.resource.OrganizationResource.addUsersToOrganization_post","parameters":[{"name":"organizationId","in":"path","description":"The ID of the organization.","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsersOrganizationUpdateDTO"},"example":{"accountIds":["qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b","qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3a01db05e2a66fa80bd"],"usernames":[]}}},"required":true},"responses":{"204":{"description":"Returned if all the users were valid and added to the organization, no response payload is provided."},"400":{"description":"Returned if one or more usernames are unknown.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Returned if the user is not logged in.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Returned if the user does not have permission to complete this request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Returned if the organization does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"deprecated":false,"security":[{"OAuth2":["manage:servicedesk-customer"]}],"x-atlassian-connect-scope":"ADMIN"},"delete":{"tags":["Organization"],"summary":"Remove users from organization","description":"This method removes users from an organization.\n\n**[Permissions](#permissions) required**: Service desk administrator or agent. Note: Permission to delete users from an organization can be switched to users with the Jira administrator permission, using the **[Organization management](https://confluence.atlassian.com/servicedeskcloud/setting-up-service-desk-users-732528877.html#Settingupservicedeskusers-manageorgsManageorganizations)** feature.","operationId":"com.atlassian.servicedesk.api.rest.resource.OrganizationResource.removeUsersFromOrganization_delete","parameters":[{"name":"organizationId","in":"path","description":"The ID of the organization.","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UsersOrganizationUpdateDTO"},"example":{"accountIds":["qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b","qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3a01db05e2a66fa80bd"],"usernames":[]}}},"required":true},"responses":{"204":{"description":"The request completed successfully. No additional content will be sent in the response."},"400":{"description":"Returned if one or more user names are invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Returned if the user is not logged in.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Returned if the user does not have permission to complete this request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Returned if the organization does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"deprecated":false,"security":[{"OAuth2":["manage:servicedesk-customer"]}],"x-atlassian-connect-scope":"DELETE"}},"/rest/servicedeskapi/request":{"get":{"tags":["Request"],"summary":"Get customer requests","description":"This method returns all customer requests for the user executing the query.\n\nThe returned customer requests are ordered chronologically by the latest activity on each request. For example, the latest status transition or comment.\n\n**[Permissions](#permissions) required**: Permission to access the specified service desk.\n\n**Response limitations**: For customers, the list returned will include request they created (or were created on their behalf) or are participating in only.","operationId":"com.atlassian.servicedesk.api.rest.resource.CustomerRequestResource.getCustomerRequests_get","parameters":[{"name":"searchTerm","in":"query","description":"Filters customer requests where the request summary matches the `searchTerm`. [Wildcards](https://confluence.atlassian.com/display/JIRACORECLOUD/Search+syntax+for+text+fields) can be used in the `searchTerm` parameter.","schema":{"type":"string"}},{"name":"requestOwnership","in":"query","description":"Filters customer requests using the following values:\n\n *  `OWNED_REQUESTS` returns customer requests where the user is the creator.\n *  `PARTICIPATED_REQUESTS` returns customer requests where the user is a participant.\n *  `ORGANIZATION` returns customer requests for an organization of which the user is a member when used in conjunction with `organizationId`.\n *  `ALL_ORGANIZATIONS` returns customer requests that belong to all organizations of which the user is a member.\n *  `APPROVER` returns customer requests where the user is an approver. Can be used in conjunction with `approvalStatus` to filter pending or complete approvals.\n *  `ALL_REQUESTS` returns all customer requests. **Deprecated and will be removed, as the returned requests may change if more values are added in the future. Instead, explicitly list the desired filtering strategies.**\n\nMultiple values of the query parameter are supported. For example, `requestOwnership=OWNED_REQUESTS&requestOwnership=PARTICIPATED_REQUESTS` will only return customer requests where the user is the creator or a participant. If not specified, filtering defaults to `OWNED_REQUESTS`, `PARTICIPATED_REQUESTS`, and `ALL_ORGANIZATIONS`.","schema":{"type":"array","items":{"type":"string"}}},{"name":"requestStatus","in":"query","description":"Filters customer requests where the request is closed, open, or either of the two where:\n\n *  `CLOSED_REQUESTS` returns customer requests that are closed.\n *  `OPEN_REQUESTS` returns customer requests that are open.\n *  `ALL_REQUESTS` returns all customer requests.","schema":{"type":"string"}},{"name":"approvalStatus","in":"query","description":"Filters results to customer requests based on their approval status:\n\n *  `MY_PENDING_APPROVAL` returns customer requests pending the user's approval.\n *  `MY_HISTORY_APPROVAL` returns customer requests where the user was an approver.\n\n**Note**: Valid only when used with requestOwnership=APPROVER.","schema":{"type":"string"}},{"name":"organizationId","in":"query","description":"Filters customer requests that belong to a specific organization (note that the user must be a member of that organization). **Note**: Valid only when used with requestOwnership=ORGANIZATION.","schema":{"type":"integer","format":"int32"}},{"name":"serviceDeskId","in":"query","description":"Filters customer requests by service desk.","schema":{"type":"integer","format":"int32"}},{"name":"requestTypeId","in":"query","description":"Filters customer requests by request type. Note that the `serviceDeskId` must be specified for the service desk in which the request type belongs.","schema":{"type":"integer","format":"int32"}},{"name":"expand","in":"query","description":"A multi-value parameter indicating which properties of the customer request to expand, where:\n\n *  `serviceDesk` returns additional details for each service desk.\n *  `requestType` returns additional details for each request type.\n *  `participant` returns the participant details, if any, for each customer request.\n *  `sla` returns the SLA information on each customer request.\n *  `status` returns the status transitions, in chronological order, for each customer request.\n *  `attachment` returns the attachments for the customer request.\n *  `action` returns the actions that the user can or cannot perform on this customer request.\n *  `comment` returns the comments, if any, for each customer request.\n *  `comment.attachment` returns the attachment details, if any, for each comment.\n *  `comment.renderedBody` (Experimental) returns the rendered body in HTML format (in addition to the raw body) for each comment.","schema":{"type":"array","items":{"type":"string"}}},{"name":"start","in":"query","description":"The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details.","schema":{"type":"integer","format":"int32"}},{"name":"limit","in":"query","description":"The maximum number of items to return per page. Default: 50. See the [Pagination](#pagination) section for more details.","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Returns the customer requests, on the specified page of the results.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedDTOCustomerRequestDTO"},"example":"{\"_expands\":[\"participant\",\"status\",\"sla\",\"requestType\",\"serviceDesk\",\"attachment\",\"action\",\"comment\"],\"size\":3,\"start\":3,\"limit\":3,\"isLastPage\":false,\"_links\":{\"base\":\"https://your-domain.atlassian.net/rest/servicedeskapi\",\"context\":\"context\",\"next\":\"https://your-domain.atlassian.net/rest/servicedeskapi/request?start=6&limit=3\",\"prev\":\"https://your-domain.atlassian.net/rest/servicedeskapi/request?start=0&limit=3\"},\"values\":[{\"_expands\":[\"participant\",\"status\",\"sla\",\"requestType\",\"serviceDesk\",\"attachment\",\"action\",\"comment\"],\"issueId\":\"107001\",\"issueKey\":\"HELPDESK-1\",\"requestTypeId\":\"25\",\"serviceDeskId\":\"10\",\"createdDate\":{\"iso8601\":\"2015-10-08T14:42:00+0700\",\"jira\":\"2015-10-08T14:42:00.000+0700\",\"friendly\":\"Monday 14:42 PM\",\"epochMillis\":1444290120000},\"reporter\":{\"accountId\":\"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\",\"name\":\"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\",\"key\":\"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\",\"emailAddress\":\"fred@example.com\",\"displayName\":\"Fred F. User\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"_links\":{\"jiraRest\":\"https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\",\"avatarUrls\":{\"48x48\":\"https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue\",\"24x24\":\"https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue\",\"16x16\":\"https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue\",\"32x32\":\"https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue\"},\"self\":\"https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\"}},\"requestFieldValues\":[{\"fieldId\":\"summary\",\"label\":\"What do you need?\",\"value\":\"Request JSD help via REST\"},{\"fieldId\":\"description\",\"label\":\"Why do you need this?\",\"value\":\"I need a new *mouse* for my Mac\",\"renderedValue\":{\"html\":\"<p>I need a new <b>mouse</b> for my Mac</p>\"}}],\"currentStatus\":{\"status\":\"Waiting for Support\",\"statusCategory\":\"NEW\",\"statusDate\":{\"iso8601\":\"2015-10-08T14:01:00+0700\",\"jira\":\"2015-10-08T14:01:00.000+0700\",\"friendly\":\"Today 14:01 PM\",\"epochMillis\":1444287660000}},\"_links\":{\"jiraRest\":\"https://your-domain.atlassian.net/rest/api/2/issue/107001\",\"web\":\"https://your-domain.atlassian.net/servicedesk/customer/portal/10/HELPDESK-1\",\"self\":\"https://your-domain.atlassian.net/rest/servicedeskapi/request/107001\"}},{\"_expands\":[\"participant\",\"status\",\"sla\",\"requestType\",\"serviceDesk\",\"attachment\",\"action\",\"comment\"],\"issueId\":\"107002\",\"issueKey\":\"HELPDESK-2\",\"requestTypeId\":\"25\",\"serviceDeskId\":\"10\",\"createdDate\":{\"iso8601\":\"2015-10-08T14:30:00+0700\",\"jira\":\"2015-10-08T14:30:00.000+0700\",\"friendly\":\"Monday 14:30 PM\",\"epochMillis\":1444289400000},\"reporter\":{\"accountId\":\"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\",\"name\":\"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\",\"key\":\"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\",\"emailAddress\":\"fred@example.com\",\"displayName\":\"Fred F. User\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"_links\":{\"jiraRest\":\"https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\",\"avatarUrls\":{\"48x48\":\"https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue\",\"24x24\":\"https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue\",\"16x16\":\"https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue\",\"32x32\":\"https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue\"},\"self\":\"https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\"}},\"requestFieldValues\":[{\"fieldId\":\"summary\",\"label\":\"What do you need?\",\"value\":\"Request a new account\"},{\"fieldId\":\"description\",\"label\":\"Why do you need this?\",\"value\":\"Create an account on Jira\"}],\"currentStatus\":{\"status\":\"Waiting for Support\",\"statusCategory\":\"NEW\",\"statusDate\":{\"iso8601\":\"2015-10-08T14:01:00+0700\",\"jira\":\"2015-10-08T14:01:00.000+0700\",\"friendly\":\"Today 14:01 PM\",\"epochMillis\":1444287660000}},\"_links\":{\"jiraRest\":\"https://your-domain.atlassian.net/rest/api/2/issue/107002\",\"web\":\"https://your-domain.atlassian.net/servicedesk/customer/portal/10/HELPDESK-2\",\"self\":\"https://your-domain.atlassian.net/rest/servicedeskapi/request/107002\"}},{\"_expands\":[\"participant\",\"status\",\"sla\",\"requestType\",\"serviceDesk\",\"attachment\",\"action\",\"comment\"],\"issueId\":\"109006\",\"issueKey\":\"SIMPLEDESK-6\",\"requestTypeId\":\"33\",\"serviceDeskId\":\"12\",\"createdDate\":{\"iso8601\":\"2015-10-05T14:30:00+0700\",\"jira\":\"2015-10-05T14:30:00.000+0700\",\"friendly\":\"Monday 14:30 PM\",\"epochMillis\":1444030200000},\"reporter\":{\"accountId\":\"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\",\"name\":\"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\",\"key\":\"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\",\"emailAddress\":\"fred@example.com\",\"displayName\":\"Fred F. User\",\"active\":true,\"timeZone\":\"Australia/Sydney\",\"_links\":{\"jiraRest\":\"https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\",\"avatarUrls\":{\"48x48\":\"https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=48&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D48%26noRedirect%3Dtrue\",\"24x24\":\"https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=24&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D24%26noRedirect%3Dtrue\",\"16x16\":\"https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=16&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D16%26noRedirect%3Dtrue\",\"32x32\":\"https://avatar-cdn.atlassian.com/9bc3b5bcb0db050c6d7660b28a5b86c9?s=32&d=https%3A%2F%2Fsecure.gravatar.com%2Favatar%2F9bc3b5bcb0db050c6d7660b28a5b86c9%3Fd%3Dmm%26s%3D32%26noRedirect%3Dtrue\"},\"self\":\"https://your-domain.atlassian.net/rest/api/2/user?username=qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\"}},\"requestFieldValues\":[{\"fieldId\":\"summary\",\"label\":\"Summarize the problem\",\"value\":\"Printer on level 3 did not work\"},{\"fieldId\":\"description\",\"value\":\"Ink cartridge is empty\"}],\"currentStatus\":{\"status\":\"Waiting for Support\",\"statusCategory\":\"NEW\",\"statusDate\":{\"iso8601\":\"2015-10-08T14:00:00+0700\",\"jira\":\"2015-10-08T14:00:00.000+0700\",\"friendly\":\"Today 14:00 PM\",\"epochMillis\":1444287600000}},\"_links\":{\"jiraRest\":\"https://your-domain.atlassian.net/rest/api/2/issue/109006\",\"web\":\"https://your-domain.atlassian.net/servicedesk/customer/portal/12/SIMPLEDESK-6\",\"self\":\"https://your-domain.atlassian.net/rest/servicedeskapi/request/109006\"}}]}"}}},"401":{"description":"Returned if the user is not logged in.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Returned if the user does not have permission to access the service desk, the service desk does not exist, or the service desk does not support the request type.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"deprecated":false,"security":[{"OAuth2":["read:servicedesk-request"]}],"x-atlassian-connect-scope":"READ"},"post":{"tags":["Request"],"summary":"Create customer request","description":"This method creates a customer request in a service desk.\n\nThe JSON request must include the service desk and customer request type, as well as any fields that are required for the request type. A list of the fields required by a customer request type can be obtained using [servicedesk/\\{serviceDeskId\\}/requesttype/\\{requestTypeId\\}/field](#api-servicedesk-serviceDeskId-requesttype-requestTypeId-field-get).\n\nThe fields required for a customer request type depend on the user's permissions:\n\n *  `raiseOnBehalfOf` is not available to Users who have the customer permission only.\n *  `requestParticipants` is not available to Users who have the customer permission only or if the feature is turned off for customers.\n\n`requestFieldValues` is a map of Jira field IDs and their values. See [Field input formats](#fieldformats), for details of each field's JSON semantics and the values they can take.\n\n**[Permissions](#permissions) required**: Permission to create requests in the specified service desk.","operationId":"com.atlassian.servicedesk.api.rest.resource.CustomerRequestResource.createCustomerRequest_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestCreateDTO"},"example":{"requestParticipants":["qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d69abfa3980ce712caae"],"serviceDeskId":"10","requestTypeId":"25","requestFieldValues":{"summary":"Request JSD help via REST","description":"I need a new *mouse* for my Mac"}}}},"required":true},"responses":{"201":{"description":"Returned if the customer request was created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerRequestDTO"},"example":"{\"_expands\":[\"participant\",\"status\",\"sla\",\"requestType\",\"serviceDesk\",\"attachment\",\"action\",\"comment\"],\"issueId\":\"107001\",\"issueKey\":\"HELPDESK-1\",\"requestTypeId\":\"25\",\"serviceDeskId\":\"10\",\"createdDate\":{\"iso8601\":\"2015-10-08T14:42:00+0700\",\"jira\":\"2015-10-08T14:42:00.000+0700\",\"friendly\":\"Monday 14:42 PM\",\"epochMillis\":1444290120000},\"reporter\":{\"accountId\":\"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\",\"name\":\"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5a