{ "info": { "_postman_id": "9ae8aaa6-570d-4a83-bbb9-a9706aea4a07", "name": "Service Management Public REST API", "description": "Public REST API for Jira Service Management", "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json" }, "item": [ { "name": "Assets", "item": [ { "name": "Get assets workspaces", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/assets/workspace", "query": [ { "key": "start", "value": "{{start}}", "disabled": true, "description": "The starting index of the returned workspace IDs. Base index: 0 See the [Pagination](#pagination) section for more details." }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "The maximum number of workspace IDs to return per page. Default: 50 See the [Pagination](#pagination) section for more details." } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns a list of Assets workspace IDs. Include a workspace ID in the path to access the [Assets REST APIs](https://developer.atlassian.com/cloud/assets/rest).\n\n**[Permissions](#permissions) required**: Any" }, "response": [] }, { "name": "Get insight workspaces", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/insight/workspace", "query": [ { "key": "start", "value": "{{start}}", "disabled": true }, { "key": "limit", "value": "{{limit}}", "disabled": true } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This endpoint is deprecated, please use /assets/workspace/." }, "response": [] } ] }, { "name": "Customer", "item": [ { "name": "Create customer", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/customer", "query": [ { "key": "strictConflictStatusCode", "value": "{{strictConflictStatusCode}}", "disabled": true, "description": "Optional boolean flag to return 409 Conflict status code for duplicate customer creation request" } ], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "This method adds a customer to the Jira Service Management instance by passing a JSON file including an email address and display name. The display name does not need to be unique. The record's identifiers, `name` and `key`, are automatically generated from the request details.\n\n**[Permissions](#permissions) required**: Jira Administrator Global permission", "body": { "mode": "raw", "raw": "{\n \"displayName\": \"Fred F. User\",\n \"email\": \"fred@example.com\"\n}" } }, "response": [] } ] }, { "name": "Info", "item": [ { "name": "Get info", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/info", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This method retrieves information about the Jira Service Management instance such as software version, builds, and related links.\n\n**[Permissions](#permissions) required**: None, the user does not need to be logged in." }, "response": [] } ] }, { "name": "Knowledgebase", "item": [ { "name": "Get articles", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/knowledgebase/article", "query": [ { "key": "query", "value": "{{query}}", "disabled": false, "description": "The string used to filter the articles (required)." }, { "key": "highlight", "value": "{{highlight}}", "disabled": false, "description": "If set to true matching query term in the title and excerpt will be highlighted using the `@@@hl@@@term@@@endhl@@@` syntax. Default: false." }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details." }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "The maximum number of items to return per page. Default: 50. See the [Pagination](#pagination) section for more details." } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "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)." }, "response": [] } ] }, { "name": "Organization", "item": [ { "name": "Get organizations", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/organization", "query": [ { "key": "start", "value": "{{start}}", "disabled": true, "description": "The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details." }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "The maximum number of organizations to return per page. Default: 50. See the [Pagination](#pagination) section for more details." }, { "key": "accountId", "value": "{{accountId}}", "disabled": true, "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*." } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This method returns a list of organizations in the Jira Service Management instance. Use this method when you want to present a list of organizations or want to locate an organization by name.\n\n**[Permissions](#permissions) required**: Any. However, to fetch organizations based on `accountId` the user must have a Service Desk agent license.\n\n**Response limitations**: If the user is a customer, only those organizations of which the customer is a member are listed." }, "response": [] }, { "name": "Create organization", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/organization", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "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.", "body": { "mode": "raw", "raw": "{\n \"name\": \"Charlie Cakes Franchises\"\n}" } }, "response": [] }, { "name": "Get organization", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/organization/:organizationId", "query": [], "variable": [ { "key": "organizationId", "value": "{{organizationId}}", "description": "The ID of the organization.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "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\nTo get organization detail field values which are visible in Jira Service Management, see the [Customer Service Management REST API](https://developer.atlassian.com/cloud/customer-service-management/rest/v1/api-group-organization/#api-group-organization).\n\n**[Permissions](#permissions) required**: Any\n\n**Response limitations**: Customers can only retrieve organization of which they are members." }, "response": [] }, { "name": "Delete organization", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/organization/:organizationId", "query": [], "variable": [ { "key": "organizationId", "value": "{{organizationId}}", "description": "The ID of the organization.", "disabled": false } ] }, "method": "DELETE", "header": [], "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." }, "response": [] }, { "name": "Get properties keys", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/organization/:organizationId/property", "query": [], "variable": [ { "key": "organizationId", "value": "{{organizationId}}", "description": "The ID of the organization from which keys will be returned.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns the keys of all organization properties. Organization properties are a type of entity property which are available to the API only, and not shown in Jira Service Management. [Learn more](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).\n\nTo get organization detail field values which are visible in Jira Service Management, see the [Customer Service Management REST API](https://developer.atlassian.com/cloud/customer-service-management/rest/v1/api-group-organization/#api-group-organization).\n\n**[Permissions](#permissions) required**: Any\n\n**Response limitations**: Customers can only access properties of organizations of which they are members." }, "response": [] }, { "name": "Get property", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/organization/:organizationId/property/:propertyKey", "query": [], "variable": [ { "key": "organizationId", "value": "{{organizationId}}", "description": "The ID of the organization from which the property will be returned.", "disabled": false }, { "key": "propertyKey", "value": "{{propertyKey}}", "description": "The key of the property to return.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns the value of an organization property. Use this method to obtain the JSON content for an organization's property. Organization properties are a type of entity property which are available to the API only, and not shown in Jira Service Management. [Learn more](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).\n\nTo get organization detail field values which are visible in Jira Service Management, see the [Customer Service Management REST API](https://developer.atlassian.com/cloud/customer-service-management/rest/v1/api-group-organization/#api-group-organization).\n\n**[Permissions](#permissions) required**: Any\n\n**Response limitations**: Customers can only access properties of organizations of which they are members." }, "response": [] }, { "name": "Set property", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/organization/:organizationId/property/:propertyKey", "query": [], "variable": [ { "key": "organizationId", "value": "{{organizationId}}", "description": "The ID of the organization on which the property will be set.", "disabled": false }, { "key": "propertyKey", "value": "{{propertyKey}}", "description": "The key of the organization's property. The maximum length of the key is 255 bytes.", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Sets the value of an organization property. Use this resource to store custom data against an organization. Organization properties are a type of entity property which are available to the API only, and not shown in Jira Service Management. [Learn more](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).\n\nTo store organization detail field values which are visible in Jira Service Management, see the [Customer Service Management REST API](https://developer.atlassian.com/cloud/customer-service-management/rest/v1/api-group-organization/#api-group-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.", "body": { "mode": "raw", "raw": "{\n \"mail\": \"charlie@example.com\",\n \"phone\": \"0800-1233456789\"\n}" } }, "response": [] }, { "name": "Delete property", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/organization/:organizationId/property/:propertyKey", "query": [], "variable": [ { "key": "organizationId", "value": "{{organizationId}}", "description": "The ID of the organization from which the property will be removed.", "disabled": false }, { "key": "propertyKey", "value": "{{propertyKey}}", "description": "The key of the property to remove.", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Removes an organization property. Organization properties are a type of entity property which are available to the API only, and not shown in Jira Service Management. [Learn more](https://developer.atlassian.com/cloud/jira/platform/jira-entity-properties/).\n\nFor operations relating to organization detail field values which are visible in Jira Service Management, see the [Customer Service Management REST API](https://developer.atlassian.com/cloud/customer-service-management/rest/v1/api-group-organization/#api-group-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." }, "response": [] }, { "name": "Get users in organization", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/organization/:organizationId/user", "query": [ { "key": "start", "value": "{{start}}", "disabled": true, "description": "The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details." }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "The maximum number of users to return per page. Default: 50. See the [Pagination](#pagination) section for more details." } ], "variable": [ { "key": "organizationId", "value": "{{organizationId}}", "description": "The ID of the organization.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "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." }, "response": [] }, { "name": "Add users to organization", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/organization/:organizationId/user", "query": [], "variable": [ { "key": "organizationId", "value": "{{organizationId}}", "description": "The ID of the organization.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "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.", "body": { "mode": "raw", "raw": "{\n \"accountIds\": [\n \"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\",\n \"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3a01db05e2a66fa80bd\"\n ],\n \"usernames\": []\n}" } }, "response": [] }, { "name": "Remove users from organization", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/organization/:organizationId/user", "query": [], "variable": [ { "key": "organizationId", "value": "{{organizationId}}", "description": "The ID of the organization.", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "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.", "body": { "mode": "raw", "raw": "{\n \"accountIds\": [\n \"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\",\n \"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3a01db05e2a66fa80bd\"\n ],\n \"usernames\": []\n}" } }, "response": [] }, { "name": "Get organizations", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/servicedesk/:serviceDeskId/organization", "query": [ { "key": "start", "value": "{{start}}", "disabled": true, "description": "The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details." }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "The maximum number of items to return per page. Default: 50. See the [Pagination](#pagination) section for more details." }, { "key": "accountId", "value": "{{accountId}}", "disabled": true, "description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*." } ], "variable": [ { "key": "serviceDeskId", "value": "{{serviceDeskId}}", "description": "The ID of the service desk from which the organization list will be returned. This can alternatively be a [project identifier.](#project-identifiers)", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This method returns a list of all organizations associated with a service desk.\n\n**[Permissions](#permissions) required**: Service desk's agent." }, "response": [] }, { "name": "Add organization", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/servicedesk/:serviceDeskId/organization", "query": [], "variable": [ { "key": "serviceDeskId", "value": "{{serviceDeskId}}", "description": "The ID of the service desk to which the organization will be added. This can alternatively be a [project identifier.](#project-identifiers)", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "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.\n\n**[Permissions](#permissions) required**: Service desk's agent.", "body": { "mode": "raw", "raw": "{\n \"organizationId\": 1\n}" } }, "response": [] }, { "name": "Remove organization", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/servicedesk/:serviceDeskId/organization", "query": [], "variable": [ { "key": "serviceDeskId", "value": "{{serviceDeskId}}", "description": "The ID of the service desk from which the organization will be removed. This can alternatively be a [project identifier.](#project-identifiers)", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "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.\n\n**[Permissions](#permissions) required**: Service desk's agent.", "body": { "mode": "raw", "raw": "{\n \"organizationId\": 1\n}" } }, "response": [] } ] }, { "name": "Request", "item": [ { "name": "Get customer requests", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/request", "query": [ { "key": "searchTerm", "value": "{{searchTerm}}", "disabled": true, "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." }, { "key": "requestOwnership", "value": "{{requestOwnership}}", "disabled": true, "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`." }, { "key": "requestStatus", "value": "{{requestStatus}}", "disabled": true, "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." }, { "key": "approvalStatus", "value": "{{approvalStatus}}", "disabled": true, "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." }, { "key": "organizationId", "value": "{{organizationId}}", "disabled": true, "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." }, { "key": "serviceDeskId", "value": "{{serviceDeskId}}", "disabled": true, "description": "Filters customer requests by service desk." }, { "key": "requestTypeId", "value": "{{requestTypeId}}", "disabled": true, "description": "Filters customer requests by request type. Note that the `serviceDeskId` must be specified for the service desk in which the request type belongs." }, { "key": "expand", "value": "{{expand}}", "disabled": true, "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." }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details." }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "The maximum number of items to return per page. Default: 50. See the [Pagination](#pagination) section for more details." } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "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." }, "response": [] }, { "name": "Create customer request", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/request", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "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.", "body": { "mode": "raw", "raw": "{\n \"form\": {\n \"answers\": {\n \"1\": {\n \"text\": \"Answer to a text form field\"\n },\n \"2\": {\n \"date\": \"2023-07-06\"\n },\n \"3\": {\n \"time\": \"14:35\"\n },\n \"4\": {\n \"choices\": [\n \"5\"\n ]\n },\n \"5\": {\n \"users\": [\n \"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d69abfa3980ce712caae\"\n ]\n }\n }\n },\n \"isAdfRequest\": false,\n \"requestFieldValues\": {\n \"description\": \"I need a new *mouse* for my Mac\",\n \"summary\": \"Request JSD help via REST\"\n },\n \"requestParticipants\": [\n \"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d69abfa3980ce712caae\"\n ],\n \"requestTypeId\": \"25\",\n \"serviceDeskId\": \"10\"\n}" } }, "response": [] }, { "name": "Get customer request by id or key", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/request/:issueIdOrKey", "query": [ { "key": "expand", "value": "{{expand}}", "disabled": true, "description": "A multi-value parameter indicating which properties of the customer request to expand, where:\n\n * `serviceDesk` returns additional service desk details.\n * `requestType` returns additional customer request type details.\n * `participant` returns the participant details.\n * `sla` returns the SLA information.\n * `status` returns the status transitions, in chronological order.\n * `attachment` returns the attachments.\n * `action` returns the actions that the user can or cannot perform.\n * `comment` returns the comments.\n * `comment.attachment` returns the attachment details for each comment.\n * `comment.renderedBody` (Experimental) return the rendered body in HTML format (in addition to the raw body) for each comment." } ], "variable": [ { "key": "issueIdOrKey", "value": "{{issueIdOrKey}}", "description": "The ID or Key of the customer request to be returned", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This method returns a customer request.\n\n**[Permissions](#permissions) required**: Permission to access the specified service desk.\n\n**Response limitations**: For customers, only a request they created, was created on their behalf, or they are participating in will be returned.\n\n**Note:** `requestFieldValues` does not include hidden fields. To get a list of request type fields that includes hidden fields, see [/rest/servicedeskapi/servicedesk/\\{serviceDeskId\\}/requesttype/\\{requestTypeId\\}/field](https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk/#api-rest-servicedeskapi-servicedesk-servicedeskid-requesttype-requesttypeid-field-get)" }, "response": [] }, { "name": "Get approvals", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/request/:issueIdOrKey/approval", "query": [ { "key": "start", "value": "{{start}}", "disabled": true, "description": "The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details." }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "The maximum number of approvals to return per page. Default: 50. See the [Pagination](#pagination) section for more details." } ], "variable": [ { "key": "issueIdOrKey", "value": "{{issueIdOrKey}}", "description": "The ID or key of the customer request to be queried for its approvals.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This method returns all approvals on a customer request.\n\n**[Permissions](#permissions) required**: Permission to view the customer request." }, "response": [] }, { "name": "Get approval by id", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/request/:issueIdOrKey/approval/:approvalId", "query": [], "variable": [ { "key": "issueIdOrKey", "value": "{{issueIdOrKey}}", "description": "The ID or key of the customer request the approval is on.", "disabled": false }, { "key": "approvalId", "value": "{{approvalId}}", "description": "The ID of the approval to be returned.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This method returns an approval. Use this method to determine the status of an approval and the list of approvers.\n\n**[Permissions](#permissions) required**: Permission to view the customer request." }, "response": [] }, { "name": "Answer approval", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/request/:issueIdOrKey/approval/:approvalId", "query": [], "variable": [ { "key": "issueIdOrKey", "value": "{{issueIdOrKey}}", "description": "The ID or key of the customer request to be updated.", "disabled": false }, { "key": "approvalId", "value": "{{approvalId}}", "description": "The ID of the approval to be updated.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "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.\n\n**[Permissions](#permissions) required**: User is assigned to the approval request.", "body": { "mode": "raw", "raw": "{\n \"decision\": \"approve\"\n}" } }, "response": [] }, { "name": "Get attachments for request", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/request/:issueIdOrKey/attachment", "query": [ { "key": "start", "value": "{{start}}", "disabled": false, "description": "The starting index of the returned attachment. Base index: 0. See the [Pagination](#pagination) section for more details." }, { "key": "limit", "value": "{{limit}}", "disabled": false, "description": "The maximum number of comments to return per page. Default: 50. See the [Pagination](#pagination) section for more details." } ], "variable": [ { "key": "issueIdOrKey", "value": "{{issueIdOrKey}}", "description": "The ID or key of the customer request from which the attachments will be listed.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This method returns all the attachments for a customer requests.\n\n**[Permissions](#permissions) required**: Permission to view the customer request.\n\n**Response limitations**: Customers will only get a list of public attachments." }, "response": [] }, { "name": "Create comment with attachment", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/request/:issueIdOrKey/attachment", "query": [], "variable": [ { "key": "issueIdOrKey", "value": "{{issueIdOrKey}}", "description": "The ID or key of the customer request to which the attachment will be added.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "This method creates a comment on a customer request using one or more attachment files (uploaded using [servicedeskapi/servicedesk/\\{serviceDeskId\\}/attachTemporaryFile](https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk/#api-rest-servicedeskapi-servicedesk-servicedeskid-attachtemporaryfile-post)), with the visibility set by `public`. See\n\n * GET [servicedeskapi/request/\\{issueIdOrKey\\}/attachment](./#api-rest-servicedeskapi-request-issueidorkey-attachment-get)\n * GET [servicedeskapi/request/\\{issueIdOrKey\\}/comment/\\{commentId\\}/attachment](./#api-rest-servicedeskapi-request-issueidorkey-comment-commentid-attachment-get)\n\n**[Permissions](#permissions) required**: Permission to add an attachment.\n\n**Request limitations**: Customers can set public visibility only.", "body": { "mode": "raw", "raw": "{\n \"additionalComment\": {\n \"body\": \"Please find the screenshot and the log file attached.\"\n },\n \"public\": true,\n \"temporaryAttachmentIds\": [\n \"temp910441317820424274\",\n \"temp3600755449679003114\"\n ]\n}" } }, "response": [] }, { "name": "Get attachment content", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/request/:issueIdOrKey/attachment/:attachmentId", "query": [], "variable": [ { "key": "issueIdOrKey", "value": "{{issueIdOrKey}}", "description": "The ID or key for the customer request the attachment is associated with", "disabled": false }, { "key": "attachmentId", "value": "{{attachmentId}}", "description": "The ID for the attachment", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns the contents of an attachment.\n\nTo return a thumbnail of the attachment, use [servicedeskapi/request/\\{issueIdOrKey\\}/attachment/\\{attachmentId\\}/thumbnail](./#api-rest-servicedeskapi-request-issueidorkey-attachment-attachmentid-thumbnail-get).\n\n**[Permissions](#permissions) required:** For the issue containing the attachment:\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue." }, "response": [] }, { "name": "Get attachment thumbnail", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/request/:issueIdOrKey/attachment/:attachmentId/thumbnail", "query": [], "variable": [ { "key": "issueIdOrKey", "value": "{{issueIdOrKey}}", "description": "The ID or key for the customer request the attachment is associated with", "disabled": false }, { "key": "attachmentId", "value": "{{attachmentId}}", "description": "The ID of the attachment.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns the thumbnail of an attachment.\n\nTo return the attachment contents, use [servicedeskapi/request/\\{issueIdOrKey\\}/attachment/\\{attachmentId\\}](#api-rest-servicedeskapi-request-issueidorkey-attachment-attachmentid-get).\n\n**[Permissions](#permissions) required:** For the issue containing the attachment:\n\n * *Browse projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project that the issue is in.\n * If [issue-level security](https://confluence.atlassian.com/x/J4lKLg) is configured, issue-level security permission to view the issue." }, "response": [] }, { "name": "Get request comments", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/request/:issueIdOrKey/comment", "query": [ { "key": "public", "value": "{{public}}", "disabled": true, "description": "Specifies whether to return public comments or not. Default: true." }, { "key": "internal", "value": "{{internal}}", "disabled": true, "description": "Specifies whether to return internal comments or not. Default: true." }, { "key": "expand", "value": "{{expand}}", "disabled": true, "description": "A multi-value parameter indicating which properties of the comment to expand:\n\n * `attachment` returns the attachment details, if any, for each comment. (If you want to get all attachments for a request, use [servicedeskapi/request/\\{issueIdOrKey\\}/attachment](#api-request-issueIdOrKey-attachment-get).)\n * `renderedBody` (Experimental) returns the rendered body in HTML format (in addition to the raw body) for each comment." }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "The starting index of the returned comments. Base index: 0. See the [Pagination](#pagination) section for more details." }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "The maximum number of comments to return per page. Default: 50. See the [Pagination](#pagination) section for more details." } ], "variable": [ { "key": "issueIdOrKey", "value": "{{issueIdOrKey}}", "description": "The ID or key of the customer request whose comments will be retrieved.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "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.\n\n**[Permissions](#permissions) required**: Permission to view the customer request.\n\n**Response limitations**: Customers are returned public comments only." }, "response": [] }, { "name": "Create request comment", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/request/:issueIdOrKey/comment", "query": [], "variable": [ { "key": "issueIdOrKey", "value": "{{issueIdOrKey}}", "description": "The ID or key of the customer request to which the comment will be added.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "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.\n\n**[Permissions](#permissions) required**: User has Add Comments permission.\n\n**Request limitations**: Customers can set comments to public visibility only.", "body": { "mode": "raw", "raw": "{\n \"body\": \"Hello there\",\n \"public\": true\n}" } }, "response": [] }, { "name": "Get request comment by id", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/request/:issueIdOrKey/comment/:commentId", "query": [ { "key": "expand", "value": "{{expand}}", "disabled": true, "description": "A multi-value parameter indicating which properties of the comment to expand:\n\n * `attachment` returns the attachment details, if any, for the comment. (If you want to get all attachments for a request, use [servicedeskapi/request/\\{issueIdOrKey\\}/attachment](#api-request-issueIdOrKey-attachment-get).)\n * `renderedBody` (Experimental) returns the rendered body in HTML format (in addition to the raw body) of the comment." } ], "variable": [ { "key": "issueIdOrKey", "value": "{{issueIdOrKey}}", "description": "The ID or key of the customer request that contains the comment.", "disabled": false }, { "key": "commentId", "value": "{{commentId}}", "description": "The ID of the comment to retrieve.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This method returns details of a customer request's comment.\n\n**[Permissions](#permissions) required**: Permission to view the customer request.\n\n**Response limitations**: Customers can only view public comments on requests where they are the reporter or a participant whereas agents can see both internal and public comments." }, "response": [] }, { "name": "Get comment attachments", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/request/:issueIdOrKey/comment/:commentId/attachment", "query": [ { "key": "start", "value": "{{start}}", "disabled": true, "description": "The starting index of the returned comments. Base index: 0. See the [Pagination](#pagination) section for more details." }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "The maximum number of comments to return per page. Default: 50. See the [Pagination](#pagination) section for more details." } ], "variable": [ { "key": "issueIdOrKey", "value": "{{issueIdOrKey}}", "description": "The ID or key of the customer request that contains the comment.", "disabled": false }, { "key": "commentId", "value": "{{commentId}}", "description": "The ID of the comment.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This method returns the attachments referenced in a comment.\n\n**[Permissions](#permissions) required**: Permission to view the customer request.\n\n**Response limitations**: Customers can only view public comments, and retrieve their attachments, on requests where they are the reporter or a participant whereas agents can see both internal and public comments." }, "response": [] }, { "name": "Get subscription status", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/request/:issueIdOrKey/notification", "query": [], "variable": [ { "key": "issueIdOrKey", "value": "{{issueIdOrKey}}", "description": "The ID or key of the customer request to be queried for subscription status.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "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.\n\n**[Permissions](#permissions) required**: Permission to view the customer request." }, "response": [] }, { "name": "Subscribe", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/request/:issueIdOrKey/notification", "query": [], "variable": [ { "key": "issueIdOrKey", "value": "{{issueIdOrKey}}", "description": "The ID or key of the customer request to be subscribed to.", "disabled": false } ] }, "method": "PUT", "header": [], "description": "This method subscribes the user to receiving notifications from a customer request.\n\n**[Permissions](#permissions) required**: Permission to view the customer request." }, "response": [] }, { "name": "Unsubscribe", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/request/:issueIdOrKey/notification", "query": [], "variable": [ { "key": "issueIdOrKey", "value": "{{issueIdOrKey}}", "description": "The ID or key of the customer request to be unsubscribed from.", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "This method unsubscribes the user from notifications from a customer request.\n\n**[Permissions](#permissions) required**: Permission to view the customer request." }, "response": [] }, { "name": "Get request participants", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/request/:issueIdOrKey/participant", "query": [ { "key": "start", "value": "{{start}}", "disabled": true, "description": "The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details." }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "The maximum number of request types to return per page. Default: 50. See the [Pagination](#pagination) section for more details." } ], "variable": [ { "key": "issueIdOrKey", "value": "{{issueIdOrKey}}", "description": "The ID or key of the customer request to be queried for its participants.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This method returns a list of all the participants on a customer request.\n\n**[Permissions](#permissions) required**: Permission to view the customer request." }, "response": [] }, { "name": "Add request participants", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/request/:issueIdOrKey/participant", "query": [], "variable": [ { "key": "issueIdOrKey", "value": "{{issueIdOrKey}}", "description": "The ID or key of the customer request to have participants added.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This method adds participants to a customer request.\n\n**[Permissions](#permissions) required**: Permission to manage participants on the customer request.\n\nNote, participants can be added when creating a customer request using the [request](#api-request-post) resource, by defining the participants in the `requestParticipants` field.", "body": { "mode": "raw", "raw": "{\n \"accountIds\": [],\n \"usernames\": [\n \"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\",\n \"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3a01db05e2a66fa80bd\",\n \"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d69abfa3980ce712caae\"\n ]\n}" } }, "response": [] }, { "name": "Remove request participants", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/request/:issueIdOrKey/participant", "query": [], "variable": [ { "key": "issueIdOrKey", "value": "{{issueIdOrKey}}", "description": "The ID or key of the customer request to have participants removed.", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This method removes participants from a customer request.\n\n**[Permissions](#permissions) required**: Permission to manage participants on the customer request.", "body": { "mode": "raw", "raw": "{\n \"accountIds\": [],\n \"usernames\": [\n \"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\",\n \"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3a01db05e2a66fa80bd\",\n \"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d69abfa3980ce712caae\"\n ]\n}" } }, "response": [] }, { "name": "Get sla information", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/request/:issueIdOrKey/sla", "query": [ { "key": "start", "value": "{{start}}", "disabled": true, "description": "The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details." }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "The maximum number of request types to return per page. Default: 50. See the [Pagination](#pagination) section for more details." } ], "variable": [ { "key": "issueIdOrKey", "value": "{{issueIdOrKey}}", "description": "The ID or key of the customer request whose SLAs will be retrieved.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "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.\n\n**[Permissions](#permissions) required**: Agent for the Service Desk containing the queried customer request." }, "response": [] }, { "name": "Get sla information by id", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/request/:issueIdOrKey/sla/:slaMetricId", "query": [], "variable": [ { "key": "issueIdOrKey", "value": "{{issueIdOrKey}}", "description": "The ID or key of the customer request whose SLAs will be retrieved.", "disabled": false }, { "key": "slaMetricId", "value": "{{slaMetricId}}", "description": "The ID or key of the SLAs metric to be retrieved.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This method returns the details for an SLA on a customer request.\n\n**[Permissions](#permissions) required**: Agent for the Service Desk containing the queried customer request." }, "response": [] }, { "name": "Get customer request status", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/request/:issueIdOrKey/status", "query": [ { "key": "start", "value": "{{start}}", "disabled": true, "description": "The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details." }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "The maximum number of items to return per page. Default: 50. See the [Pagination](#pagination) section for more details." } ], "variable": [ { "key": "issueIdOrKey", "value": "{{issueIdOrKey}}", "description": "The ID or key of the customer request to be retrieved.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "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.\n\n**[Permissions](#permissions) required**: Permission to view the customer request." }, "response": [] }, { "name": "Get customer transitions", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/request/:issueIdOrKey/transition", "query": [ { "key": "start", "value": "{{start}}", "disabled": true, "description": "The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details." }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "The maximum number of items to return per page. Default: 50. See the [Pagination](#pagination) section for more details." } ], "variable": [ { "key": "issueIdOrKey", "value": "{{issueIdOrKey}}", "description": "The ID or key of the customer request whose transitions will be retrieved.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "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.\n\n**[Permissions](#permissions) required**: Permission to view the customer request." }, "response": [] }, { "name": "Perform customer transition", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/request/:issueIdOrKey/transition", "query": [], "variable": [ { "key": "issueIdOrKey", "value": "{{issueIdOrKey}}", "description": "ID or key of the issue to transition", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "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.\n\n**[Permissions](#permissions) required**: The user must be able to view the request and have the Transition Issues permission. If a comment is passed the user must have the Add Comments permission.", "body": { "mode": "raw", "raw": "{\n \"additionalComment\": {\n \"body\": \"I have fixed the problem.\"\n },\n \"id\": \"1\"\n}" } }, "response": [] }, { "name": "Get feedback", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/request/:requestIdOrKey/feedback", "query": [], "variable": [ { "key": "requestIdOrKey", "value": "{{requestIdOrKey}}", "description": "The id or the key of the request to post the feedback on", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This method retrieves a feedback of a request using it's `requestKey` or `requestId`\n\n**[Permissions](#permissions) required**: User has view request permissions." }, "response": [] }, { "name": "Post feedback", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/request/:requestIdOrKey/feedback", "query": [], "variable": [ { "key": "requestIdOrKey", "value": "{{requestIdOrKey}}", "description": "The id or the key of the request to post the feedback on", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "This method adds a feedback on an request using it's `requestKey` or `requestId`\n\n**[Permissions](#permissions) required**: User must be the reporter or an Atlassian Connect app.", "body": { "mode": "raw", "raw": "{\n \"comment\": {\n \"body\": \"Great work!\"\n },\n \"rating\": 4,\n \"type\": \"csat\"\n}" } }, "response": [] }, { "name": "Delete feedback", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/request/:requestIdOrKey/feedback", "query": [], "variable": [ { "key": "requestIdOrKey", "value": "{{requestIdOrKey}}", "description": "The id or the key of the request to post the feedback on", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "This method deletes the feedback of request using it's `requestKey` or `requestId`\n\n**[Permissions](#permissions) required**: User must be the reporter or an Atlassian Connect app." }, "response": [] } ] }, { "name": "Requesttype", "item": [ { "name": "Get all request types", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/requesttype", "query": [ { "key": "searchQuery", "value": "{{searchQuery}}", "disabled": true, "description": "String to be used to filter the results." }, { "key": "serviceDeskId", "value": "{{serviceDeskId}}", "disabled": true, "description": "Filter the request types by service desk Ids provided. Multiple values of the query parameter are supported. For example, `serviceDeskId=1&serviceDeskId=2` will return request types only for service desks 1 and 2." }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details." }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "The maximum number of items to return per page. Default: 50. See the [Pagination](#pagination) section for more details." }, { "key": "expand", "value": "{{expand}}", "disabled": true }, { "key": "includeHiddenRequestTypesInSearch", "value": "{{includeHiddenRequestTypesInSearch}}", "disabled": true, "description": "Whether to include hidden request types when searching with `searchQuery`." }, { "key": "restrictionStatus", "value": "{{restrictionStatus}}", "disabled": true, "description": "Request type restriction status (`open` or `restricted`) used to filter the results." } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This method returns all customer request types used in the Jira Service Management instance, optionally filtered by a query string.\n\nUse [servicedeskapi/servicedesk/\\{serviceDeskId\\}/requesttype](#api-servicedesk-serviceDeskId-requesttype-get) to find the customer request types supported by a specific service desk.\n\nThe returned list of customer request types can be filtered using the `searchQuery` parameter. The parameter is matched against the customer request types' `name` or `description`. For example, searching for \"Install\", \"Inst\", \"Equi\", or \"Equipment\" will match a customer request type with the *name* \"Equipment Installation Request\".\n\n**Note:** This API by default will filter out request types hidden in the portal (i.e. request types without groups and request types where a user doesn't have permission) when `searchQuery` is provided, unless `includeHiddenRequestTypesInSearch` is set to true. Restricted request types will not be returned for those who aren't admins.\n\n**[Permissions](#permissions) required**: Any" }, "response": [] } ] }, { "name": "Servicedesk", "item": [ { "name": "Get service desks", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/servicedesk", "query": [ { "key": "start", "value": "{{start}}", "disabled": true, "description": "The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details." }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "The maximum number of items to return per page. Default: 50. See the [Pagination](#pagination) section for more details." } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This method returns all the service desks in the Jira Service Management instance that the user has permission to access. Use this method where you need a list of service desks or need to locate a service desk by name or keyword.\n\n**Note:** This method will be slow if the instance has hundreds of service desks. If you want to fetch a single service desk by its ID, use [/rest/servicedeskapi/servicedesk/\\{serviceDeskId\\}](./#api-rest-servicedeskapi-servicedesk-servicedeskid-get) instead.\n\n**[Permissions](#permissions) required**: Any" }, "response": [] }, { "name": "Get service desk by id", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/servicedesk/:serviceDeskId", "query": [], "variable": [ { "key": "serviceDeskId", "value": "{{serviceDeskId}}", "description": "The ID of the service desk to return. This can alternatively be a [project identifier.](#project-identifiers)", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "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.\n\n**[Permissions](#permissions) required**: Permission to access the Service Desk. For example, being the Service Desk's Administrator or one of its Agents or Users." }, "response": [] }, { "name": "Attach temporary file", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/servicedesk/:serviceDeskId/attachTemporaryFile", "query": [], "variable": [ { "key": "serviceDeskId", "value": "{{serviceDeskId}}", "description": "The ID of the Service Desk to which the file will be attached. This can alternatively be a [project identifier.](#project-identifiers)", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "multipart/form-data" } ], "description": "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](#api-request-issueIdOrKey-attachment-post).\n\n**Note**: It is possible for a service desk administrator to turn off the ability to add attachments to a service desk.\n\nThis method expects a multipart request. The media-type multipart/form-data is defined in RFC 1867. Most client libraries have classes that make dealing with multipart posts simple. For instance, in Java the Apache HTTP Components library provides [MultiPartEntity](http://hc.apache.org/httpcomponents-client-ga/httpmime/apidocs/org/apache/http/entity/mime/MultipartEntity.html).\n\nBecause this method accepts multipart/form-data, it has XSRF protection on it. This means you must submit a header of X-Atlassian-Token: no-check with the request or it will be blocked.\n\nThe name of the multipart/form-data parameter that contains the attachments must be `file`.\n\nFor example, to upload a file called `myfile.txt` in the Service Desk with ID 10001 use\n\n curl -D- -u customer:customer -X POST -H \"X-ExperimentalApi: opt-in\" -H \"X-Atlassian-Token: no-check\" -F \"file=@myfile.txt\" https://your-domain.atlassian.net/rest/servicedeskapi/servicedesk/10001/attachTemporaryFile\n\n**[Permissions](#permissions) required**: Permission to add attachments in this Service Desk.", "body": { "mode": "raw" } }, "response": [] }, { "name": "Get customers", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/servicedesk/:serviceDeskId/customer", "query": [ { "key": "query", "value": "{{query}}", "disabled": true, "description": "The string used to filter the customer list." }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details." }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "The maximum number of users to return per page. Default: 50. See the [Pagination](#pagination) section for more details." } ], "variable": [ { "key": "serviceDeskId", "value": "{{serviceDeskId}}", "description": "The ID of the service desk the customer list should be returned from. This can alternatively be a [project identifier.](#project-identifiers)", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This method returns a list of the customers on a service desk.\n\nThe returned list of customers can be filtered using the `query` parameter. The parameter is matched against customers' `displayName`, `name`, or `email`. For example, searching for \"John\", \"Jo\", \"Smi\", or \"Smith\" will match a user with display name \"John Smith\".\n\n**[Permissions](#permissions) required**: Permission to view this Service Desk's customers." }, "response": [] }, { "name": "Add customers", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/servicedesk/:serviceDeskId/customer", "query": [], "variable": [ { "key": "serviceDeskId", "value": "{{serviceDeskId}}", "description": "The ID of the service desk the customer list should be returned from. This can alternatively be a [project identifier.](#project-identifiers)", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "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.\n\n**[Permissions](#permissions) required**: Service desk administrator", "body": { "mode": "raw", "raw": "{\n \"accountIds\": [\n \"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\",\n \"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3a01db05e2a66fa80bd\",\n \"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d69abfa3980ce712caae\"\n ],\n \"usernames\": [\n \"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\",\n \"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3a01db05e2a66fa80bd\",\n \"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d69abfa3980ce712caae\"\n ]\n}" } }, "response": [] }, { "name": "Remove customers", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/servicedesk/:serviceDeskId/customer", "query": [], "variable": [ { "key": "serviceDeskId", "value": "{{serviceDeskId}}", "description": "The ID of the service desk the customers should be removed from. This can alternatively be a [project identifier.](#project-identifiers)", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "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.\n\n**[Permissions](#permissions) required**: Services desk administrator", "body": { "mode": "raw", "raw": "{\n \"accountIds\": [\n \"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\",\n \"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3a01db05e2a66fa80bd\",\n \"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d69abfa3980ce712caae\"\n ],\n \"usernames\": [\n \"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3581db05e2a66fa80b\",\n \"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d3a01db05e2a66fa80bd\",\n \"qm:a713c8ea-1075-4e30-9d96-891a7d181739:5ad6d69abfa3980ce712caae\"\n ]\n}" } }, "response": [] }, { "name": "Get articles", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/servicedesk/:serviceDeskId/knowledgebase/article", "query": [ { "key": "query", "value": "{{query}}", "disabled": false, "description": "The string used to filter the articles (required)." }, { "key": "highlight", "value": "{{highlight}}", "disabled": true, "description": "If set to true matching query term in the title and excerpt will be highlighted using the `@@@hl@@@term@@@endhl@@@` syntax. Default: false." }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details." }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "The maximum number of items to return per page. Default: 50. See the [Pagination](#pagination) section for more details." } ], "variable": [ { "key": "serviceDeskId", "value": "{{serviceDeskId}}", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns articles which match the given query and belong to the knowledge base linked to the service desk.\n\n**[Permissions](#permissions) required**: Permission to access the service desk." }, "response": [] }, { "name": "Get queues", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/servicedesk/:serviceDeskId/queue", "query": [ { "key": "includeCount", "value": "{{includeCount}}", "disabled": true, "description": "Specifies whether to include each queue's customer request (issue) count in the response." }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details." }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "The maximum number of items to return per page. Default: 50. See the [Pagination](#pagination) section for more details." } ], "variable": [ { "key": "serviceDeskId", "value": "{{serviceDeskId}}", "description": "ID of the service desk whose queues will be returned. This can alternatively be a [project identifier.](#project-identifiers)", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "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).\n\n**[Permissions](#permissions) required**: service desk's Agent." }, "response": [] }, { "name": "Get queue", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/servicedesk/:serviceDeskId/queue/:queueId", "query": [ { "key": "includeCount", "value": "{{includeCount}}", "disabled": true, "description": "Specifies whether to include each queue's customer request (issue) count in the response." } ], "variable": [ { "key": "serviceDeskId", "value": "{{serviceDeskId}}", "description": "ID of the service desk whose queues will be returned. This can alternatively be a [project identifier.](#project-identifiers)", "disabled": false }, { "key": "queueId", "value": "{{queueId}}", "description": "ID of the required queue.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "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).\n\n**[Permissions](#permissions) required**: service desk's Agent." }, "response": [] }, { "name": "Get issues in queue", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/servicedesk/:serviceDeskId/queue/:queueId/issue", "query": [ { "key": "start", "value": "{{start}}", "disabled": true, "description": "The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details." }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "The maximum number of items to return per page. Default: 50. See the [Pagination](#pagination) section for more details." } ], "variable": [ { "key": "serviceDeskId", "value": "{{serviceDeskId}}", "description": "The ID of the service desk containing the queue to be queried. This can alternatively be a [project identifier.](#project-identifiers)", "disabled": false }, { "key": "queueId", "value": "{{queueId}}", "description": "The ID of the queue whose customer requests will be returned.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "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.\n\n**[Permissions](#permissions) required**: Service desk's agent." }, "response": [] }, { "name": "Get request types", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/servicedesk/:serviceDeskId/requesttype", "query": [ { "key": "groupId", "value": "{{groupId}}", "disabled": true, "description": "Filters results to those in a customer request type group." }, { "key": "expand", "value": "{{expand}}", "disabled": true }, { "key": "searchQuery", "value": "{{searchQuery}}", "disabled": true, "description": "The string to be used to filter the results." }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details." }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "The maximum number of items to return per page. Default: 50. See the [Pagination](#pagination) section for more details." }, { "key": "includeHiddenRequestTypesInSearch", "value": "{{includeHiddenRequestTypesInSearch}}", "disabled": true, "description": "Whether to include hidden request types when searching with `searchQuery`." }, { "key": "restrictionStatus", "value": "{{restrictionStatus}}", "disabled": true, "description": "Request type restriction status (`open` or `restricted`) used to filter the results." } ], "variable": [ { "key": "serviceDeskId", "value": "{{serviceDeskId}}", "description": "The ID of the service desk whose customer request types are to be returned. This can alternatively be a [project identifier.](#project-identifiers)", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This method returns all customer request types from a service desk. There are two parameters for filtering the returned list:\n\n * `groupId` which filters the results to items in the customer request type group.\n * `searchQuery` which is matched against request types' `name` or `description`. For example, the strings \"Install\", \"Inst\", \"Equi\", or \"Equipment\" will match a request type with the *name* \"Equipment Installation Request\".\n\n**Note:** This API by default will filter out request types hidden in the portal (i.e. request types without groups and request types where a user doesn't have permission) when `searchQuery` is provided, unless `includeHiddenRequestTypesInSearch` is set to true. Restricted request types will not be returned for those who aren't admins.\n\n**[Permissions](#permissions) required**: Permission to access the service desk." }, "response": [] }, { "name": "Create request type", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/servicedesk/:serviceDeskId/requesttype", "query": [], "variable": [ { "key": "serviceDeskId", "value": "{{serviceDeskId}}", "description": "The ID of the service desk where the customer request type is to be created. This can alternatively be a [project identifier.](#project-identifiers)", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "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:\n\n * Request type icon is given the headset icon.\n * Request type groups is left empty, which means this customer request type will not be visible on the [customer portal](https://confluence.atlassian.com/servicedeskcloud/configuring-the-customer-portal-732528918.html).\n * Request type status mapping is left empty, so the request type has no custom status mapping but inherits the status map from the issue type upon which it is based.\n * Request type field mapping is set to show the required fields as specified by the issue type used to create the customer request type.\n\n \nThese fields can be updated by a service desk administrator using the **Request types** option in **Project settings**. \nRequest Types are created in next-gen projects by creating Issue Types. Please use the Jira Cloud Platform Create issue type endpoint instead.\n\n**[Permissions](#permissions) required**: Service desk's administrator", "body": { "mode": "raw", "raw": "{\n \"description\": \"Get IT Help\",\n \"helpText\": \"Please tell us clearly the problem you have within 100 words.\",\n \"issueTypeId\": \"12345\",\n \"name\": \"Get IT Help\"\n}" } }, "response": [] }, { "name": "Get request type by id", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/servicedesk/:serviceDeskId/requesttype/:requestTypeId", "query": [ { "key": "expand", "value": "{{expand}}", "disabled": true } ], "variable": [ { "key": "serviceDeskId", "value": "{{serviceDeskId}}", "description": "The ID of the service desk whose customer request type is to be returned. This can alternatively be a [project identifier.](#project-identifiers)", "disabled": false }, { "key": "requestTypeId", "value": "{{requestTypeId}}", "description": "The ID of the customer request type to be returned.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This method returns a customer request type from a service desk.\n\nThis operation can be accessed anonymously.\n\n**[Permissions](#permissions) required**: Permission to access the service desk." }, "response": [] }, { "name": "Delete request type", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/servicedesk/:serviceDeskId/requesttype/:requestTypeId", "query": [], "variable": [ { "key": "serviceDeskId", "value": "{{serviceDeskId}}", "description": "The ID or [project identifier](#project-identifiers) of the service desk.", "disabled": false }, { "key": "requestTypeId", "value": "{{requestTypeId}}", "description": "The ID of the request type.", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "This method deletes a customer request type from a service desk, and removes it from all customer requests. \nThis only supports classic projects.\n\n**[Permissions](#permissions) required**: Service desk administrator." }, "response": [] }, { "name": "Get request type fields", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/servicedesk/:serviceDeskId/requesttype/:requestTypeId/field", "query": [ { "key": "expand", "value": "{{expand}}", "disabled": true, "description": "Use [expand](#expansion) to include additional information in the response. This parameter accepts `hiddenFields` that returns hidden fields associated with the request type." } ], "variable": [ { "key": "serviceDeskId", "value": "{{serviceDeskId}}", "description": "The ID of the service desk containing the request types whose fields are to be returned. This can alternatively be a [project identifier.](#project-identifiers)", "disabled": false }, { "key": "requestTypeId", "value": "{{requestTypeId}}", "description": "The ID of the request types whose fields are to be returned.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This method returns the fields for a service desk's customer request type.\n\nAlso, the following information about the user's permissions for the request type is returned:\n\n * `canRaiseOnBehalfOf` returns `true` if the user has permission to raise customer requests on behalf of other customers. Otherwise, returns `false`.\n * `canAddRequestParticipants` returns `true` if the user can add customer request participants. Otherwise, returns `false`.\n\n**[Permissions](#permissions) required**: Permission to view the Service Desk. However, hidden fields would be visible to only Service desk's Administrator." }, "response": [] }, { "name": "Get properties keys", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/servicedesk/:serviceDeskId/requesttype/:requestTypeId/property", "query": [], "variable": [ { "key": "requestTypeId", "value": "{{requestTypeId}}", "description": "The ID of the request type for which keys will be retrieved.", "disabled": false }, { "key": "serviceDeskId", "value": "{{serviceDeskId}}", "description": "The ID of the service desk which contains the request type. This can alternatively be a [project identifier.](#project-identifiers)", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns the keys of all properties for a request type.\n\nProperties for a Request Type in next-gen are stored as Issue Type properties and therefore the keys of all properties for a request type are also available by calling the Jira Cloud Platform [Get issue type property keys](https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issuetype-issueTypeId-properties-get) endpoint.\n\n**[Permissions](#permissions) required**: The user must have permission to view the request type." }, "response": [] }, { "name": "Get property", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/servicedesk/:serviceDeskId/requesttype/:requestTypeId/property/:propertyKey", "query": [], "variable": [ { "key": "serviceDeskId", "value": "{{serviceDeskId}}", "description": "The ID of the service desk which contains the request type. This can alternatively be a [project identifier.](#project-identifiers)", "disabled": false }, { "key": "requestTypeId", "value": "{{requestTypeId}}", "description": "The ID of the request type from which the property will be retrieved.", "disabled": false }, { "key": "propertyKey", "value": "{{propertyKey}}", "description": "The key of the property to return.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns the value of the property from a request type.\n\nProperties for a Request Type in next-gen are stored as Issue Type properties and therefore also available by calling the Jira Cloud Platform [Get issue type property](https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issuetype-issueTypeId-properties-propertyKey-get) endpoint.\n\n**[Permissions](#permissions) required**: User must have permission to view the request type." }, "response": [] }, { "name": "Set property", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/servicedesk/:serviceDeskId/requesttype/:requestTypeId/property/:propertyKey", "query": [], "variable": [ { "key": "serviceDeskId", "value": "{{serviceDeskId}}", "description": "The ID of the service desk which contains the request type. This can alternatively be a [project identifier.](#project-identifiers)", "disabled": false }, { "key": "requestTypeId", "value": "{{requestTypeId}}", "description": "The ID of the request type on which the property will be set.", "disabled": false }, { "key": "propertyKey", "value": "{{propertyKey}}", "description": "The key of the request type property. The maximum length of the key is 255 bytes.", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Sets the value of a request type property. Use this resource to store custom data against a request type.\n\nProperties for a Request Type in next-gen are stored as Issue Type properties and therefore can also be set by calling the Jira Cloud Platform [Set issue type property](https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issuetype-issueTypeId-properties-propertyKey-put) endpoint.\n\n**[Permissions](#permissions) required**: Jira project administrator with a Jira Service Management agent license." }, "response": [] }, { "name": "Delete property", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/servicedesk/:serviceDeskId/requesttype/:requestTypeId/property/:propertyKey", "query": [], "variable": [ { "key": "serviceDeskId", "value": "{{serviceDeskId}}", "description": "The ID of the service desk which contains the request type. This can alternatively be a [project identifier.](#project-identifiers)", "disabled": false }, { "key": "requestTypeId", "value": "{{requestTypeId}}", "description": "The ID of the request type for which the property will be removed.", "disabled": false }, { "key": "propertyKey", "value": "{{propertyKey}}", "description": "The key of the property to remove.", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Removes a property from a request type.\n\nProperties for a Request Type in next-gen are stored as Issue Type properties and therefore can also be deleted by calling the Jira Cloud Platform [Delete issue type property](https://developer.atlassian.com/cloud/jira/platform/rest/v3/#api-rest-api-3-issuetype-issueTypeId-properties-propertyKey-delete) endpoint.\n\n**[Permissions](#permissions) required**: Jira project administrator with a Jira Service Management agent license." }, "response": [] }, { "name": "Get request type groups", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}rest/servicedeskapi/servicedesk/:serviceDeskId/requesttypegroup", "query": [ { "key": "start", "value": "{{start}}", "disabled": true, "description": "The starting index of the returned objects. Base index: 0. See the [Pagination](#pagination) section for more details." }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "The maximum number of items to return per page. Default: 50. See the [Pagination](#pagination) section for more details." } ], "variable": [ { "key": "serviceDeskId", "value": "{{serviceDeskId}}", "description": "The ID of the service desk whose customer request type groups are to be returned. This can alternatively be a [project identifier.](#project-identifiers)", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This method returns a service desk's customer request type groups. Jira Service Management administrators can arrange the customer request type groups in an arbitrary order for display on the customer portal; the groups are returned in this order.\n\n**[Permissions](#permissions) required**: Permission to view the service desk." }, "response": [] } ] } ], "variable": [ { "key": "protocol", "name": "Protocol", "description": "The HTTP Protocol that should be used for this REST API.", "type": "string", "value": "https" }, { "key": "host", "name": "Host", "description": "The HTTP host that should be used for this REST API.", "type": "string", "value": "your-domain.atlassian.net" }, { "key": "basePath", "name": "Base Path", "description": "The path, after the host, of the base of the REST API.", "type": "string", "value": "" } ] }