### Get All Boards Response Example Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-board Example JSON response for a successful retrieval of board information. ```json { "id": 10001, "name": "Scrum Board", "self": "http://www.example.com/jira/rest/agile/1.0/board/10001", "type": "scrum" } ``` -------------------------------- ### Example 200 OK Response for Get Users Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-group This is an example of a successful response when retrieving users from a group. ```json { "active": true, "avatarUrls": {}, "displayName": "Fred F. User", "emailAddress": "fred@example.com", "key": "fred", "name": "Fred", "self": "http://www.example.com/jira/rest/api/2/user?username=fred", "timeZone": "Australia/Sydney" } ``` -------------------------------- ### Example JSON Response for Get Remote Version Link Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-version An example of a successful JSON response when retrieving a remote version link. ```json { "link": "{\"rel\":\"issue\",\"url\":\"http://www.example.com/jira/rest/api/2/issue/10000\"}", "name": "Issue 10000", "self": "http://www.example.com/jira/rest/api/2/issue/10000" } ``` -------------------------------- ### Example Response for Get All Fields Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-field An example of the JSON response when retrieving all fields. It includes details about the field's properties such as name, ID, and schema. ```json { "clauseNames": [ "[description]" ], "custom": false, "id": "description", "name": "Description", "navigable": true, "orderable": true, "schema": {}, "searchable": true } ``` -------------------------------- ### Example JSON Response for Get All Issue Types Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-issuetype An example of the JSON response when successfully retrieving a list of issue types. ```json { "avatarId": 10002, "description": "A problem which impairs or prevents the functions of the product.", "iconUrl": "http://www.example.com/jira/images/icons/issuetypes/bug.png", "id": "1", "name": "Bug", "self": "http://www.example.com/jira/rest/api/2/issuetype/1", "subtask": false } ``` -------------------------------- ### Pagination Request Example Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/intro/#gettingstarted Example of a GET request to a paged API resource, specifying the starting item and maximum results per page. ```http http://host:port/context/rest/api-name/api-version/resource-name?startAt=0&maxResults=10 ``` -------------------------------- ### Example response for getting comment property keys Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-comment This is an example of the JSON response when successfully retrieving the keys of all properties for a comment. ```json { "keys": [ { "key": "issue.support", "self": "http://www.example.com/jira/rest/api/2/issue/EX-2/properties/issue.support" } ] } ``` -------------------------------- ### Upgrade Result Bean Example Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-upgrade This is an example of the JSON response structure for a successful upgrade task, showing duration, message, outcome, and start time. ```json { "duration": 2001, "message": "", "outcome": "SUCCESS", "startTime": "" } ``` -------------------------------- ### Get Board Backlog Response Example Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-board Example JSON response for retrieving issues from a board's backlog, including changelog and fields like watchers and attachments. ```json { "changelog": { "histories": [ { "author": {}, "created": "", "historyMetadata": {}, "id": "", "items": [ {} ] } ], "maxResults": 2154, "startAt": 2154, "total": 2154 }, "editmeta": {}, "fields": { "watcher": { "self": "http://www.example.com/jira/rest/api/2/issue/EX-1/watchers", "isWatching": false, "watchCount": 1, "watchers": [ { "self": "http://www.example.com/jira/rest/api/2/user?username=fred", "name": "fred", "displayName": "Fred F. User", "active": false } ] }, "attachment": [ { "self": "http://www.example.com/jira/rest/api/2.0/attachments/10000", "filename": "picture.jpg", "author": { "self": "http://www.example.com/jira/rest/api/2/user?username=fred", "key": "JIRAUSER10100", "name": "fred", "emailAddress": "fred@example.com", "avatarUrls": { "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred", "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred", "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred", "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred" }, "displayName": "Fred F. ``` -------------------------------- ### Project Picker Response Example Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-projects A sample JSON response for the GET /api/2/projects/picker endpoint, illustrating the structure of the returned project data, including header information and individual project details. ```json { "header": "Showing 2 of 5 matching projects", "projects": [ { "avatar": "http://www.example.com/jira/secure/projectavatar?size=xsmall&pid=10000", "html": "Example project name (EXAM)", "id": "10000", "key": "EXAM", "name": "Example project name" } ], "total": 5 } ``` -------------------------------- ### Example Response for Get All Statuses Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-status A sample JSON response for the 'Get all statuses' endpoint, illustrating the structure of a single status object. ```json { "description": "The issue is currently being worked on.", "iconUrl": "http://localhost:8090/jira/images/icons/progress.gif", "id": "10000", "name": "In Progress", "self": "http://localhost:8090/jira/rest/api/2.0/status/10000", "statusCategory": { "colorName": "blue-gray", "id": 1, "key": "new", "name": "To Do", "self": "http://localhost:8090/jira/rest/api/2.0/statuscategory/1" }, "statusColor": "green" } ``` -------------------------------- ### GET /api/2/groupuserpicker JSON Response Example Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-groupuserpicker Example of a successful JSON response from the group user picker API, showing matching groups with highlighting. ```json { "groups": { "groups": [ { "html": "jdog-developers", "labels": [ {} ], "name": "jdog-developers" } ], "header": "Showing 20 of 25 matching groups", "total": 25 }, "users": {} } ``` -------------------------------- ### Get All Project Categories Response (JSON) Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-projectcategory Example JSON response when successfully retrieving all project categories. It includes the description, ID, name, and self URL for each category. ```json { "description": "This is a project category", "id": "10000", "name": "My Project Category", "self": "http://www.example.com/jira/rest/api/2/projectCategory/10000" } ``` -------------------------------- ### All dashboards response example Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-dashboard Example JSON response for the 'Get all dashboards' endpoint, showing a list of dashboards with their IDs, names, and URLs, along with pagination information. ```json { "dashboards": [ { "id": "10000", "name": "System Dashboard", "self": "http://localhost:8090/jira/rest/api/2.0/dashboard/10000", "view": "http://localhost:8090/jira/secure/Dashboard.jspa?selectPageId=10000" } ], "maxResults": 10, "next": "http://localhost:8090/jira/rest/api/2.0/dashboard?startAt=10", "prev": "http://localhost:8090/jira/rest/api/2.0/dashboard?startAt=0", "startAt": 10, "total": 143 } ``` -------------------------------- ### Start Exposing JMX Metrics Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-monitoring Starts exposing JMX metrics. ```APIDOC ## POST /rest/api/2/monitoring/jmx/start ### Description Starts exposing JMX metrics. ### Method POST ### Endpoint /rest/api/2/monitoring/jmx/start ``` -------------------------------- ### Get all properties keys for a board (Response) Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-board Example JSON response when successfully retrieving property keys for a Jira board. ```json { "keys": [ { "key": "issue.support", "self": "http://www.example.com/jira/rest/api/2/issue/EX-2/properties/issue.support" } ] } ``` -------------------------------- ### Get Projects Picker (cURL) Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-projects Example of how to retrieve a list of projects visible to the user that match a given query using cURL. This request requires authentication with an email and API token. ```curl curl --request GET \ --url 'http://{baseurl}/rest/api/2/projects/picker' \ --user 'email@example.com:' \ --header 'Accept: application/json' ``` -------------------------------- ### Application Role Response Example Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-applicationrole Example JSON response for an ApplicationRole, showing details like default groups, defined status, and seat information. This is returned upon a successful GET request. ```json { "defaultGroups": [ "jira-software-users" ], "defined": false, "groups": [ "jira-software-users", "jira-testers" ], "hasUnlimitedSeats": false, "key": "jira-software", "name": "Jira Software", "numberOfSeats": 10, "platform": false, "remainingSeats": 5, "selectedByDefault": false, "userCount": 5, "userCountDescription": "5 developers" } ``` -------------------------------- ### Get All Application Properties Response Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-application-properties Example response for retrieving application properties, showing the structure of property objects including id, key, value, name, description, type, and defaultValue. This response is returned when a property exists and the user has view permissions. ```json [ { "id": "jira.home", "key": "jira.home", "value": "/var/jira/jira-home", "name": "jira.home", "desc": "Jira home directory", "type": "string", "defaultValue": "" }, { "id": "jira.clone.prefix", "key": "jira.clone.prefix", "value": "CLONE -", "name": "The prefix added to the Summary field of cloned issues", "type": "string", "defaultValue": "CLONE -" } ] ``` -------------------------------- ### Response for Get all defined names Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-terminology Example JSON response when retrieving all defined names for 'epic' and 'sprint'. ```json { "isDefault": true, "newName": "", "newNamePlural": "", "originalName": "", "originalNamePlural": "" } ``` -------------------------------- ### Reindex Request Progress Response Example Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-reindex An example of the JSON response when retrieving the progress of reindex requests. It includes details such as completion time, request ID, start time, status, and type. ```json { "completionTime": "", "id": 10500, "requestTime": "", "startTime": "", "status": "PENDING", "type": "IMMEDIATE" } ``` -------------------------------- ### Get All Permission Schemes Response Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-permissionscheme This is an example of a successful JSON response when retrieving all permission schemes. It includes details like scheme ID, name, description, and associated permissions. ```json { "permissionSchemes": [ { "description": "description", "expand": "", "id": 10100, "name": "permission scheme name", "permissions": [ { "holder": {}, "id": 10100, "permission": "permission scheme name", "self": "http://www.example.com/jira/rest/api/2/permissionscheme/10100" } ], "self": "http://www.example.com/jira/rest/api/2/permissionscheme/10100" } ] } ``` -------------------------------- ### Example Version Response (JSON) Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-version This is an example of a successful JSON response when retrieving version information. It includes details such as version ID, name, description, release date, and associated project. ```json { "archived": false, "description": "An excellent version", "expand": "10000", "id": "10000", "moveUnfixedIssuesTo": "http://localhost:8090/jira/rest/api/2/version/10000/move", "name": "New Version 1", "overdue": true, "project": "PXA", "projectId": 10000, "releaseDate": "", "releaseDateSet": false, "released": true, "self": "http://localhost:8090/jira/rest/api/2/version/10000", "startDate": "", "startDateSet": false, "userReleaseDate": "2012-09-15T21:11:01.834+0000", "userStartDate": "2012-08-15T21:11:01.834+0000" } ``` -------------------------------- ### Project Role Response Example Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-role Example of a successful JSON response when retrieving project role details. ```json { "actors": [ { "name": "jira-developers" } ], "description": "A project role that represents developers in a project", "id": 10360, "name": "Developers", "self": "http://www.example.com/jira/rest/api/2/project/MKY/role/10360" } ``` -------------------------------- ### Example JSON response for getting a property Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-dashboard This is an example of a successful JSON response when retrieving a dashboard item property. ```json { "key": "issue.support", "value": "{\"hipchat.room.id\":\"support-123\",\"support.time\":\"1m\"}" } ``` -------------------------------- ### Example Response for List All Users Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-user A sample JSON response structure for the list all users endpoint, including pagination details. ```json { "isLast": true, "maxResults": 2154, "nextCursor": "", "nextPage": "", "self": "", "values": [ {} ] } ``` -------------------------------- ### Example response for available fields Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-screens Illustrates the structure of the JSON response when successfully retrieving available fields for a screen. ```json { "id": "summary", "name": "Summary", "showWhenEmpty": false, "type": "The type of the field. One of: 'system', 'custom', 'jira'." } ``` -------------------------------- ### Example JSON response for board versions Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-board This is an example of the JSON response when successfully retrieving versions from a board. It includes details about each version such as its ID, name, and release status. ```json { "archived": false, "description": "An excellent version", "expand": "10000", "id": "10000", "moveUnfixedIssuesTo": "http://localhost:8090/jira/rest/api/2/version/10000/move", "name": "New Version 1", "overdue": true, "project": "PXA", "projectId": 10000, "releaseDate": "", "releaseDateSet": false, "released": true, "self": "http://localhost:8090/rest/api/2/version/10000", "startDate": "", "startDateSet": false, "userReleaseDate": "2012-09-15T21:11:01.834+0000", "userStartDate": "2012-08-15T21:11:01.834+0000" } ``` -------------------------------- ### Example Project Type JSON Response Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-project This is an example of the JSON response when successfully retrieving a project type. It includes details like color, description, formatted key, and icon. ```json { "color": "#FFFFFF", "descriptionI18nKey": "Project type for software projects", "formattedKey": "Software", "icon": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAxOC4xLjEsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApIC0tPg0KPHN2ZyB2ZXJzaW9uPSIxLjEiIGlkPSJMYXllcl8xIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB4PSIwcHgiIHk9IjBweCINCgkJdmlld0JveD0iMCAwIDMyIDMyIiBlbmFibGUtYmFja2dyb3VuZD0ibmV3IDAgMCAzMiAzMiIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI+DQoJPHBhdGggZmlsbD0iIzY2NjY2NiIgZD0iTTE2LDBDNy4yLDAsMCw3LjIsMCwxNmMwLDguOCw3LjIsMTYsMTYsMTZjOC44LDAsMTYtNy4yLDE2LTE2QzMyLDcuMiwyNC44LDAsMTYsMHogTTI1LjcsMjMNCgkJYzAsMS44LTEuNCwzLjItMy4yLDMuMkg5LjJDNy41LDI2LjIsNiwyNC44LDYsMjNWOS44QzYsOCw3LjUsNi42LDkuMiw2LjZoMTMuMmMwLjIsMCwwLjQsMCwwLjcsMC4xbC0yLjgsMi44SDkuMg0KCQlDOSw5LjQsOC44LDkuNiw4LjgsOS44VjIzYzAsMC4yLDAuMiwwLjQsMC40LDAuNGgxMy4yYzAuMiwwLDAuNC0wLjIsMC40LTAuNHYtNS4zbDIuOC0yLjhWMjN6IE0xNS45LDIxLjNMMTEsMTYuNGwyLTIsMi45LDIuOQ0KCQlMMjYuNCw2LjhjMC42LDAuNywxLjIsMS41LDEuNywyLjNMMTUuOSwyMS4zeiIvPg0KPC9nPg0KPC9zdmc+", "key": "software" } ``` -------------------------------- ### 200 OK Response for Project Types Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-project Example JSON response when successfully retrieving project types. It includes details like color, description, formatted key, and an icon for each project type. ```json { "color": "#FFFFFF", "descriptionI18nKey": "Project type for software projects", "formattedKey": "Software", "icon": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAxOC4xLjEsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApIC0tPg0KPHN2ZyB2ZXJzaW9uPSIxLjEiIGlkPSJMYXllcl8xIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB4PSIwcHgiIHk9IjBweCINCgkJIHZpZXdCb3g9IjAgMCAzMiAzMiIgZW5hYmxlLWJhY2tncm91bmQ9Im5ldyAwIDAgMzIgMzIiIHhtbDpzcGFjZT0icHJlc2VydmUiPg0KPGc+DQoJPHBhdGggZmlsbD0iIzY2NjY2NiIgZD0iTTE2LDBDNy4yLDAsMCw3LjIsMCwxNmMwLDguOCw3LjIsMTYsMTYsMTZjOC44LDAsMTYtNy4yLDE2LTE2QzMyLDcuMiwyNC44LDAsMTYsMHogTTI1LjcsMjMNCgkJYzAsMS44LTEuNCwzLjItMy4yLDMuMkg5LjJDNy41LDI2LjIsNiwyNC44LDYsMjNWOS44QzYsOCw3LjUsNi42LDkuMiw2LjZoMTMuMmMwLjIsMCwwLjQsMCwwLjcsMC4xbC0yLjgsMi44SDkuMg0KCQlDOSw5LjQsOC44LDkuNiw4LjgsOS44VjIzYzAsMC4yLDAuMiwwLjQsMC40LDAuNGgxMy4yYzAuMiwwLDAuNC0wLjIsMC40LTAuNHYtNS4zbDIuOC0yLjhWMjN6IE0xNS45LDIxLjNMMTEsMTYuNGwyLTIsMi45LDIuOQ0KCQlMMjYuNCw2LjhjMC42LDAuNywxLjIsMS41LDEuNywyLjNMMTUuOSwyMS4zeiIvPg0KPC9nPg0KPC9zdmc+", "key": "software" } ``` -------------------------------- ### Example 200 OK Response for Board Projects Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-board This is an example of a successful JSON response when retrieving projects for a board. It includes details for each project such as avatar URLs, ID, key, name, project category, type, and self URL. ```json { "avatarUrls": {}, "id": "", "key": "", "name": "", "projectCategory": { "description": "This is a project category", "id": "10000", "name": "My Project Category", "self": "http://www.example.com/jira/rest/api/2/projectCategory/10000" }, "projectTypeKey": "", "self": "" } ``` -------------------------------- ### Example response for getting a comment property Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-comment This is an example of the JSON response when successfully retrieving a specific property from a comment. The value may be a JSON string. ```json { "key": "issue.support", "value": "{\"hipchat.room.id\":\"support-123\",\"support.time\":\"1m\"}" } ``` -------------------------------- ### Example 201 Created Response for Add User Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-group This is an example of a successful response when adding a user to a group. ```json { "name": "jira-administrators", "self": "http://www.example.com/jira/rest/api/2/group?groupname=jira-administrators", "users": { "backingListSize": 2154, "callback": {}, "items": [], "maxResults": 50, "pagingCallback": {}, "size": 50 } } ``` -------------------------------- ### Example 200 OK Response for Permissions Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-mypermissions This is an example of a successful JSON response when retrieving user permissions. It lists each permission, its details, and whether the user has it. ```json { "permissions": { "EDIT_ISSUE": { "id": "EDIT_ISSUE", "type": "USER", "description": "Ability to edit issues.", "name": "Edit Issues", "havePermission": true } } } ``` -------------------------------- ### GET /api/2/search/error/lookup Request Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-search Example of how to make a GET request to the error lookup resource using cURL. Ensure you replace {baseurl} with your Jira instance URL. ```curl curl --request GET \ --url 'http://{baseurl}/rest/api/2/search/error/lookup' \ --header 'Accept: application/json' ``` -------------------------------- ### Priority Scheme Response Example Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-priorityschemes Example JSON response when retrieving all priority schemes. It includes details like `maxResults`, `startAt`, `total`, and a list of `schemes` with their properties. ```json { "maxResults": 2154, "schemes": [ { "defaultOptionId": "", "defaultScheme": true, "description": "", "id": 2154, "name": "", "optionIds": [ "" ], "projectKeys": [ "" ], "self": "" } ], "startAt": 2154, "total": 2154 } ``` -------------------------------- ### Example Project Type Response Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-project A successful response (200 OK) for retrieving a project type, including its color, description, formatted key, icon, and key. ```json { "color": "#FFFFFF", "descriptionI18nKey": "Project type for software projects", "formattedKey": "Software", "icon": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAxOC4xLjEsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApIC0tPg0KPHN2ZyB2ZXJzaW9uPSIxLjEiIGlkPSJMYXllcl8xIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB4PSIwcHgiIHk9IjBweCINCgkJIHZpZXdCb3g9IjAgMCAzMiAzMiIgZW5hYmxlLWJhY2tncm91bmQ9Im5ldyAwIDAgMzIgMzIiIHhtbDpzcGFjZT0icHJlc2VydmUiPg0KPGc+DQoJPHBhdGggZmlsbD0iIzY2NjY2NiIgZD0iTTE2LDBDNy4yLDAsMCw3LjIsMCwxNmMwLDguOCw3LjIsMTYsMTYsMTZjOC44LDAsMTYtNy4yLDE2LTE2QzMyLDcuMiwyNC44LDAsMTYsMHogTTI1LjcsMjMNCgkJYzAsMS44LTEuNCwzLjItMy4yLDMuMkg5LjJDNy41LDI2LjIsNiwyNC44LDYsMjNWOS44QzYsOCw3LjUsNi42LDkuMiw2LjZoMTMuMmMwLjIsMCwwLjQsMCwwLjcsMC4xbC0yLjgsMi44SDkuMg0KCQlDOSw5LjQsOC44LDkuNiw4LjgsOS44VjIzYzAsMC4yLDAuMiwwLjQsMC40LDAuNGgxMy4yYzAuMiwwLDAuNC0wLjIsMC40LTAuNHYtNS4zbDIuOC0yLjhWMjN6IE0xNS45LDIxLjNMMTEsMTYuNGwyLTJsMi45LDIuOQ0KCQlMMjYuNCw2LjhjMC42LDAuNywxLjIsMS41LDEuNywyLjNMMTUuOSwyMS4zeiIvPg0KPC9nPg0KPC9zdmc+", "key": "software" } ``` -------------------------------- ### Deleted Worklogs Response Example Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-worklog Example JSON response for the GET /api/2/worklog/deleted endpoint, showing pagination details and a list of deleted worklogs with their updated and worklog IDs. ```json { "isLastPage": true, "lastPage": true, "nextPage": "http://www.example.com/jira/rest/api/2/worklog/updated?since=1438013693136", "self": "http://www.example.com/jira/rest/api/2/worklog/updated?since=1438013671136", "since": 1438013671562, "until": 1438013693136, "values": [ { "updatedTime": 1438013671562, "worklogId": 103 } ] } ``` -------------------------------- ### Get Security Level by ID (Node.js) Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-securitylevel Example of how to fetch a security level by ID using Node.js. This snippet demonstrates making a GET request to the Jira API. ```javascript const response = await fetch('http://{baseurl}/rest/api/2/securitylevel/{id}', { method: 'GET', headers: { 'Accept': 'application/json' }, auth: { username: 'email@example.com', password: '' } }); const securityLevel = await response.json(); ``` -------------------------------- ### Example JSON response for all resolutions Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-resolution An example of the JSON structure returned when retrieving all issue resolutions. ```json { "description": "Fixed", "iconUrl": "http://www.example.com/jira/images/icons/statuses/resolved.png", "id": "1", "name": "Fixed", "self": "http://www.example.com/jira/rest/api/2/resolution/1" } ``` -------------------------------- ### Example JSON Response for Issue Subtask List Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-issue This is an example JSON response structure for the 'Get an issue's subtask list' endpoint, detailing the fields returned for an issue. ```json { "fields": { "issuetype": { "avatarId": 10002, "description": "A problem which impairs or prevents the functions of the product.", "iconUrl": "http://www.example.com/jira/images/icons/issuetypes/bug.png", "id": "1", "name": "Bug", "self": "http://www.example.com/jira/rest/api/2/issuetype/1", "subtask": false }, "priority": { "description": "This is a description of the priority", "iconUrl": "http://www.example.com/jira/images/icons/priorities/major.png", "id": "1", "name": "Major", "self": "http://www.example.com/jira/rest/api/2/priority/1", "statusColor": "red" }, "status": { "description": "The issue is currently being worked on.", "iconUrl": "http://localhost:8090/jira/images/icons/progress.gif", "id": "10000", "name": "In Progress", "self": "http://localhost:8090/jira/rest/api/2.0/status/10000", "statusCategory": {}, "statusColor": "green" }, "summary": "" }, "id": "10000", "key": "HSP-1", "self": "http://www.example.com/jira/rest/api/2/issue/10000" } ``` -------------------------------- ### Example Response for Get Single Issue with Agile Fields Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-issue This is an example JSON response when retrieving a single issue with Agile fields. It includes details about watchers, attachments, and changelog history. ```json { "changelog": { "histories": [ { "author": {}, "created": "", "historyMetadata": {}, "id": "", "items": [ {} ] } ], "maxResults": 2154, "startAt": 2154, "total": 2154 }, "editmeta": {}, "fields": { "watcher": { "self": "http://www.example.com/jira/rest/api/2/issue/EX-1/watchers", "isWatching": false, "watchCount": 1, "watchers": [ { "self": "http://www.example.com/jira/rest/api/2/user?username=fred", "name": "fred", "displayName": "Fred F. User", "active": false } ] }, "attachment": [ { "self": "http://www.example.com/jira/rest/api/2.0/attachments/10000", "filename": "picture.jpg", "author": { "self": "http://www.example.com/jira/rest/api/2/user?username=fred", "key": "JIRAUSER10100", "name": "fred", "emailAddress": "fred@example.com", "avatarUrls": { "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred", "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred", "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred", "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred" }, "displayName": "Fred F." } } ] } } ``` -------------------------------- ### Example JSON Response for Remote Version Links Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-version Illustrates the structure of a successful JSON response when retrieving remote version links. ```json { "links": [ { "link": "{\"rel\":\"issue\",\"url\":\"http://www.example.com/jira/rest/api/2/issue/10000\"}", "name": "Issue 10000", "self": "http://www.example.com/jira/rest/api/2/issue/10000" } ] } ``` -------------------------------- ### GET /api/2/groupuserpicker cURL Example Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-groupuserpicker Example of how to call the group user picker API using cURL. Ensure you replace {baseurl} with your Jira instance URL and provide valid authentication credentials. ```curl curl --request GET \ --url 'http://{baseurl}/rest/api/2/groupuserpicker' \ --user 'email@example.com:' \ --header 'Accept: application/json' ``` -------------------------------- ### New Project Creation Response Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-project A sample JSON response upon successful creation of a new project, containing the project's ID, key, and self URL. ```json { "id": 10010, "key": "EX", "self": "http://example/jira/rest/api/2/project/10042" } ``` -------------------------------- ### Example Response for Get Issue Type Mapping Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-workflowscheme An example JSON response when successfully retrieving an issue type mapping. It shows the mapped issue type, whether to update a draft, and the associated workflow. ```json { "issueType": "10000", "updateDraftIfNeeded": false, "workflow": "My Workflow" } ``` -------------------------------- ### Example JSON response for getting issues Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-board This is an example of a successful JSON response when retrieving issues for an epic. It includes details about the changelog, fields such as watchers, attachments, sub-tasks, description, project information, and comments. ```json { "changelog": { "histories": [ { "author": {}, "created": "", "historyMetadata": {}, "id": "", "items": [ {} ] } ], "maxResults": 2154, "startAt": 2154, "total": 2154 }, "editmeta": {}, "fields": { "watcher": { "self": "http://www.example.com/jira/rest/api/2/issue/EX-1/watchers", "isWatching": false, "watchCount": 1, "watchers": [ { "self": "http://www.example.com/jira/rest/api/2/user?username=fred", "name": "fred", "displayName": "Fred F. User", "active": false } ] }, "attachment": [ { "self": "http://www.example.com/jira/rest/api/2.0/attachments/10000", "filename": "picture.jpg", "author": { "self": "http://www.example.com/jira/rest/api/2/user?username=fred", "key": "JIRAUSER10100", "name": "fred", "emailAddress": "fred@example.com", "avatarUrls": { "48x48": "http://www.example.com/jira/secure/useravatar?size=large&ownerId=fred", "24x24": "http://www.example.com/jira/secure/useravatar?size=small&ownerId=fred", "16x16": "http://www.example.com/jira/secure/useravatar?size=xsmall&ownerId=fred", "32x32": "http://www.example.com/jira/secure/useravatar?size=medium&ownerId=fred" }, "displayName": "Fred F. User", "active": true, "deleted": false, "timeZone": "Australia/Sydney", "locale": "en_AU", "lastLoginTime": "2023-08-30T16:37:01+1000" }, "created": "2024-05-23T14:47:28.592+0000", "size": 23123, "mimeType": "image/jpeg", "content": "http://www.example.com/jira/attachments/10000", "thumbnail": "http://www.example.com/jira/secure/thumbnail/10000" } ], "sub-tasks": [ { "id": "10000", "type": { "id": "10000", "name": "", "inward": "Parent", "outward": "Sub-task" }, "outwardIssue": { "id": "10003", "key": "EX-2", "self": "http://www.example.com/jira/rest/api/2/issue/EX-2", "fields": { "status": { "iconUrl": "http://www.example.com/jira//images/icons/statuses/open.png", "name": "Open" } } } } ], "description": "example bug report", "project": { "self": "http://www.example.com/jira/rest/api/2/project/EX", "id": "10000", "key": "EX", "name": "Example", "avatarUrls": { "48x48": "http://www.example.com/jira/secure/projectavatar?size=large&pid=10000", "24x24": "http://www.example.com/jira/secure/projectavatar?size=small&pid=10000", "16x16": "http://www.example.com/jira/secure/projectavatar?size=xsmall&pid=10000", "32x32": "http://www.example.com/jira/secure/projectavatar?size=medium&pid=10000" }, "projectCategory": { "self": "http://www.example.com/jira/rest/api/2/projectCategory/10000", "id": "10000", "name": "FIRST", "description": "First Project Category" } }, "comment": [ { "self": "http://www.example.com/jira/rest/api/2/issue/10010/comment/10000", "id": "10000", "author": { "self": "http://www.example.com/jira/rest/api/2/user?username=fred", "name": "fred", "displayName": "Fred F. User", "active": false }, "body": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venenatis elit. Duis eu justo eget augue iaculis fermentum. Sed semper quam laoreet nisi egestas at posuere augue semper.", "updateAuthor": { "self": "http://www.example.com/jira/rest/api/2/user?username=fred", "name": "fred", "displayName": "Fred F." } } ] } } ``` -------------------------------- ### Example JSON Response for Available Index Snapshots Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-index-snapshot Illustrates the structure of a successful JSON response when requesting a list of available index snapshots. ```json { "absolutePath": "/var/atlassian/application-data/jira/caches/indexesV1/issue", "timestamp": 1612345678900 } ``` -------------------------------- ### Paginated Components Response Example Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-component Example JSON response for a paginated list of components. It includes pagination details and a list of component values. ```json { "isLast": true, "maxResults": 2154, "nextPage": "", "self": "", "startAt": 2154, "total": 2154, "values": [ {} ] } ``` -------------------------------- ### Attachment Capabilities Response Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-attachment Example JSON response for the 'Get attachment capabilities' endpoint, indicating if attachments are enabled and the upload limit. ```json { "enabled": true, "uploadLimit": 1000000 } ``` -------------------------------- ### Example Response for All Issue Security Schemes Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-issuesecurityschemes This is a sample JSON response when successfully retrieving all issue security schemes. It includes details like scheme ID, name, description, and associated security levels. ```json { "issueSecuritySchemes": [ { "defaultSecurityLevelId": 10001, "description": "This is a security scheme", "id": 10000, "levels": [ { "description": "This is a security level", "id": "10000", "name": "My Security Level", "self": "http://www.example.com/jira/rest/api/2/securitylevel/10000" } ], "name": "My Security Scheme", "self": "http://www.example.com/jira/rest/api/2/issuesecurityschemes/10000" } ] } ``` -------------------------------- ### Get default actors response (JSON) Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-role Example JSON response when successfully retrieving default actors for a role. It lists the actors by name. ```json { "actors": [ { "name": "jira-developers" } ] } ``` -------------------------------- ### Accessibility Personal Settings Response Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-user Example JSON response for the 'Get available accessibility personal settings' endpoint, showing the enabled status and key of a setting. ```json { "enabled": true, "key": "a11y-setting-underlined-links" } ``` -------------------------------- ### Get Issue Estimation Response (JSON) Source: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-issue Example JSON response when successfully retrieving an issue's estimation. It includes the fieldId used for estimation and its value. ```json { "fieldId": "customfield_12532", "value": {} } ```