### Example Response for Get All Permissions Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-permissions An example JSON response detailing a global permission, including its description, key, name, and type. ```json { "permissions": { "BULK_CHANGE": { "description": "Ability to modify a collection of issues at once. For example, resolve multiple issues in one step.", "key": "BULK_CHANGE", "name": "Bulk Change", "type": "GLOBAL" } } } ``` -------------------------------- ### Example Response for Get Atlassian Team Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-teams-in-plan This is an example of the JSON response when successfully retrieving the planning settings for an Atlassian team in a plan. ```json { "capacity": 220, "id": "98WA-2JBO-12N3-2298", "issueSourceId": 1, "planningStyle": "Scrum", "sprintLength": 2 } ``` -------------------------------- ### Example JSON Response for Get Version Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions Illustrates the structure of a successful JSON response when retrieving a project version. ```json { "archived": false, "description": "An excellent version", "id": "10000", "name": "New Version 1", "overdue": true, "projectId": 10000, "releaseDate": "2010-07-06", "released": true, "self": "https://your-domain.atlassian.net/rest/api/3/version/10000", "userReleaseDate": "6/Jul/2010" } ``` -------------------------------- ### Bulk Get Users Response Example Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users Example JSON response for the bulk get users operation, showing pagination details and a sample user object with account information. ```json { "isLast": true, "maxResults": 100, "startAt": 0, "total": 1, "values": [ { "accountId": "5b10a2844c20165700ede21g", "accountType": "atlassian", "active": true, "avatarUrls": { "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16", "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24", "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32", "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48" }, "displayName": "Mia Krystof", "emailAddress": "mia@example.com", "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g", "timeZone": "Australia/Sydney" } ] } ``` -------------------------------- ### Example response for getting app properties Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-app-properties Illustrates the JSON structure returned when successfully retrieving app property keys. ```JSON { "keys": [ { "self": "https://your-domain.atlassian.net/jira/rest/atlassian-connect/1/addon/example.app.key/properties/propertyKey", "key": "propertyKey" } ] } ``` -------------------------------- ### Example response for getting all project categories Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-categories Illustrates the JSON structure of a successful response when retrieving all project categories. ```json [ { "description": "First Project Category", "id": "10000", "name": "FIRST", "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000" }, { "description": "Second Project Category", "id": "10001", "name": "SECOND", "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10001" } ] ``` -------------------------------- ### All Project Types Response Example Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-types Example JSON response for the 'Get all project types' API call, detailing the structure of project type objects. ```json [ { "color": "#FFFFFF", "descriptionI18nKey": "jira.project.type.business.description", "formattedKey": "Business", "icon": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAxOC4xLjEsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT4NCjxzdmcgdmVyc2lvbj0iMS4xIiBpZD0iTGF5ZXJfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgeD0iMHB4IiB5PSIwcHgiDQoJIHZpZXdCb3g9IjAgMCAzMiAzMiIgZW5hYmxlLWJhY2tncm91bmQ9Im5ldyAwIDAgMzIgMzIiIHhtbDpzcGFjZT0icHJlc2VydmUiPg0KPGc+DQoJPHBhdGggZmlsbD0iIzY2NjY2NiIgZD0iTTE2LDBDNy4yLDAsMCw3LjIsMCwxNmMwLDguOCw3LjIsMTYsMTYsMTZjOC44LDAsMTYtNy4yLDE2LTE2QzMyLDcuMiwyNC44LDAsMTYsMHogTTI1LjcsMjMNCgkJYzAsMS44LTEuNCwzLjItMy4yLDMuMkg5LjJDNy41LDI2LjIsNiwyNC44LDYsMjNWOS44QzYsOCw3LjUsNi42LDkuMiw2LjZoMTMuMmMwLjIsMCwwLjQsMCwwLjcsMC4xbC0yLjgsMi44SDkuMg0KCQlDOSw5LjQsOC44LDkuNiw4LjgsOS44VjIzYzAsMC4yLDAuMiwwLjQsMC40LDAuNGgxMy4yYzAuMiwwLDAuNC0wLjIsMC40LTAuNHYtNS4zbDIuOC0yLjhWMjN6IE0xNS45LDIxLjNMMTEsMTYuNGwyLTJsMi45LDIuOQ0KCQlMMjYuNCw2LjhjMC42LDAuNywxLjIsMS41LDEuNywyLjNMMTUuOSwyMS4zeiIvPg0KPC9nPg0KPC9zdmc=", "key": "business" }, { "color": "#AAAAAA", "descriptionI18nKey": "jira.project.type.software.description", "formattedKey": "Software", "icon": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4NCjwhLS0gR2VuZXJhdG9yOiBBZG9iZSBJbGx1c3RyYXRvciAxOC4xLjEsIFNWRyBFeHBvcnQgUGx1Zy1JbiAuIFNWRyBWZXJzaW9uOiA2LjAwIEJ1aWxkIDApICAtLT4NCjxzdmcgdmVyc2lvbj0iMS4xIiBpZD0iTGF5ZXJfMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgeD0iMHB4IiB5PSIwcHgiDQoJIHZpZXdCb3g9IjAgMCAzMiAzMiIgZW5hYmxlLWJhY2tncm91bmQ9Im5ldyAwIDAgMzIgMzIiIHhtbDpzcGFjZT0icHJlc2VydmUiPg0KPGc+DQoJPHBhdGggZmlsbD0iIzY2NjY2NiIgZD0iTTE2LDBDNy4yLDAsMCw3LjIsMCwxNmMwLDguOCw3LjIsMTYsMTYsMTZjOC44LDAsMTYtNy4yLDE2LTE2QzMyLDcuMiwyNC44LDAsMTYsMHogTTI1LjcsMjMNCgkJYzAsMS44LTEuNCwzLjItMy4yLDMuMkg5LjJDNy41LDI2LjIsNiwyNC44LDYsMjNWOS44QzYsOCw3LjUsNi42LDkuMiw2LjZoMTMuMmMwLjIsMCwwLjQsMCwwLjcsMC4xbC0yLjgsMi44SDkuMg0KCQlDOSw5LjQsOC44LDkuNiw4LjgsOS44VjIzYzAsMC4yLDAuMiwwLjQsMC40LDAuNGgxMy4yYzAuMiwwLDAuNC0wLjIsMC40LTAuNHYtNS4zbDIuOC0yLjhWMjN6IE0xNS45LDIxLjNMMTEsMTYuNGwyLTJsMi45LDIuOQ0KCQlMMjYuNCw2LjhjMC42LDAuNywxLjIsMS41LDEuNywyLjNMMTUuOSwyMS4zeiIvPg0KPC9nPg0KPC9zdmc=", "key": "software" } ] ``` -------------------------------- ### Example Response for Get Projects with Field Schemes Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-field-schemes This is an example of a successful JSON response when retrieving projects with field schemes. It includes pagination details and a list of projects with their associated scheme IDs. ```json { "isLast": true, "maxResults": 3, "startAt": 0, "total": 3, "values": [ { "projectId": 10000, "schemeId": 1 }, { "projectId": 10001, "schemeId": 1 }, { "projectId": 10002, "schemeId": 2 } ] } ``` -------------------------------- ### Example Project Data Structure Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects Illustrates the JSON structure returned for a Jira project when using the 'Get all projects' API endpoint. ```json [ { "avatarUrls": { "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000", "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000", "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000", "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000" }, "id": "10000", "insight": { "lastIssueUpdateTime": 1619069825000, "totalIssueCount": 100 }, "key": "EX", "name": "Example", "projectCategory": { "description": "First Project Category", "id": "10000", "name": "FIRST", "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000" }, "self": "https://your-domain.atlassian.net/rest/api/3/project/EX", "simplified": false, "style": "CLASSIC" }, { "avatarUrls": { "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10001", "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10001", "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10001", "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10001" }, "id": "10001", "insight": { "lastIssueUpdateTime": 1619069825000, "totalIssueCount": 100 }, "key": "ABC", "name": "Alphabetical", "projectCategory": { "description": "First Project Category", "id": "10000", "name": "FIRST", "self": "https://your-domain.atlassian.net/rest/api/3/projectCategory/10000" }, "self": "https://your-domain.atlassian.net/rest/api/3/project/ABC", "simplified": false, "style": "CLASSIC" } ] ``` -------------------------------- ### Example Response for Get Account IDs Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users Example JSON response structure for the get account IDs for users endpoint. ```json [ { "username": "mia", "accountId": "5b10a2844c20165700ede21g" }, { "username": "emma", "accountId": "5b10ac8d82e05b22cc7d4ef5" } ] ``` -------------------------------- ### Example 200 OK Response for Live Project Template Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-templates This is an example JSON response for a successful retrieval of a live custom project template. It includes details about the template's archetype, description, and configuration options. ```json { "archetype": { "realType": "BUSINESS", "style": "classic", "type": "BUSINESS" }, "defaultBoardView": "", "description": "", "liveTemplateProjectIdReference": 2154, "name": "", "projectTemplateKey": { "key": "", "uuid": "" }, "snapshotTemplate": {}, "templateGenerationOptions": { "enableScreenDelegatedAdminSupport": true, "enableWorkflowDelegatedAdminSupport": true }, "type": "LIVE" } ``` -------------------------------- ### Example Response for Get User Default Columns Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users Example JSON response structure for the get user default columns endpoint. ```json [ { "label": "", "value": "" } ] ``` -------------------------------- ### Example Response for Get comments by IDs Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-comments This is an example JSON response for the 'Get comments by IDs' operation, showing a paginated list of comments with their details. ```json { "isLast": true, "maxResults": 1048576, "startAt": 0, "total": 1, "values": [ { "author": { "accountId": "5b10a2844c20165700ede21g", "active": false, "displayName": "Mia Krystof", "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g" }, "body": { "type": "doc", "version": 1, "content": [ { "type": "paragraph", "content": [ { "type": "text", "text": "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." } ] } ] }, "created": "2021-01-17T12:34:00.000+0000", "id": "10000", "self": "https://your-domain.atlassian.net/rest/api/3/issue/10010/comment/10000", "updateAuthor": { "accountId": "5b10a2844c20165700ede21g", "active": false, "displayName": "Mia Krystof", "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g" }, "updated": "2021-01-18T23:45:00.000+0000", "visibility": { "identifier": "Administrators", "type": "role", "value": "Administrators" } } ] } ``` -------------------------------- ### Example Response for Get All Field Configurations Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-field-configurations Illustrates the structure of a successful response when retrieving field configurations, including pagination details and a list of configuration objects. ```json { "isLast": true, "maxResults": 50, "startAt": 0, "total": 2, "values": [ { "id": 10000, "name": "Default Field Configuration", "description": "The default field configuration description", "isDefault": true }, { "id": 10001, "name": "My Field Configuration", "description": "My field configuration description" } ] } ``` -------------------------------- ### Get Screens for a Field Response Example Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screens Example JSON response for the 'Get screens for a field' API call, showing screen details and associated tab information. ```json { "isLast": false, "maxResults": 1, "startAt": 0, "total": 5, "values": [ { "id": 10001, "name": "Default Screen", "description": "Provides for the update of all system fields.", "tab": { "id": 10000, "name": "Fields Tab" } } ] } ``` -------------------------------- ### Project Versions Response Example Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions Example JSON response for a paginated list of project versions, including version details and issue counts. ```json { "isLast": false, "maxResults": 2, "nextPage": "https://your-domain.atlassian.net/rest/api/3/project/PR/version?startAt=2&maxResults=2", "self": "https://your-domain.atlassian.net/rest/api/3/project/PR/version?startAt=0&maxResults=2", "startAt": 0, "total": 7, "values": [ { "archived": false, "description": "An excellent version", "id": "10000", "name": "New Version 1", "overdue": true, "projectId": 10000, "releaseDate": "2010-07-06", "released": true, "self": "https://your-domain.atlassian.net/rest/api/3/version/10000", "userReleaseDate": "6/Jul/2010" }, { "archived": false, "description": "Minor Bugfix version", "id": "10010", "issuesStatusForFixVersion": { "done": 100, "inProgress": 20, "toDo": 10, "unmapped": 0 }, "name": "Next Version", "overdue": false, "projectId": 10000, "released": false, "self": "https://your-domain.atlassian.net/rest/api/3/version/10010" } ] } ``` -------------------------------- ### Get Priority Schemes Response Example Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-priority-schemes Example JSON response for the 'Get priority schemes' endpoint, detailing a default priority scheme with its priorities and associated projects. ```json { "isLast": true, "maxResults": 50, "startAt": 0, "total": 1, "values": [ { "description": "This is the default scheme used by all new and unassigned projects", "id": "1", "isDefault": true, "name": "Default Priority Scheme", "priorities": { "isLast": true, "maxResults": 50, "startAt": 0, "total": 3, "values": [ { "description": "Serious problem that could block progress.", "iconUrl": "/images/icons/priorities/high.svg", "id": "1", "isDefault": false, "name": "High", "statusColor": "#f15C75" }, { "description": "Has the potential to affect progress.", "iconUrl": "/images/icons/priorities/medium.svg", "id": "2", "isDefault": true, "name": "Medium", "statusColor": "#f79232" }, { "description": "Minor problem or easily worked around.", "iconUrl": "/images/icons/priorities/low.svg", "id": "3", "isDefault": false, "name": "Low", "statusColor": "#707070" } ] }, "projects": { "isLast": true, "maxResults": 50, "startAt": 0, "total": 1, "values": [ { "avatarUrls": { "16x16": "secure/projectavatar?size=xsmall&pid=10000", "24x24": "secure/projectavatar?size=small&pid=10000", "32x32": "secure/projectavatar?size=medium&pid=10000", "48x48": "secure/projectavatar?size=large&pid=10000" }, "id": "10000", "key": "EX", "name": "Example", "projectCategory": { "description": "Project category description", "id": "10000", "name": "A project category" }, "projectTypeKey": "ProjectTypeKey{key='software'}", "self": "project/EX", "simplified": false } ] } } ] } ``` -------------------------------- ### Jira Instance License Response Example Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-license-metrics Example of a successful JSON response when retrieving license information for a Jira instance. ```json { "applications": [ { "id": "jira-core", "plan": "PAID" }, { "id": "jira-product-discovery", "plan": "FREE" }, { "id": "jira-servicedesk", "plan": "FREE" }, { "id": "jira-software", "plan": "PAID" } ] } ``` -------------------------------- ### Example Project JSON Response Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-projects This is an example of the JSON response structure when successfully retrieving project details. It includes information about avatars, components, and descriptions. ```json { "assigneeType": "PROJECT_LEAD", "avatarUrls": { "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000", "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000", "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000", "48x48": "https://your-domain.atlassian.net/secure/projectavatar?size=large&pid=10000" }, "components": [ { "ari": "ari:cloud:compass:fdb3fdec-4e70-be56-11ee-0242ac120002:component/fdb3fdec-4e70-11ee-be56-0242ac120002/fdb3fdec-11ee-4e70-be56-0242ac120002", "assignee": { "accountId": "5b10a2844c20165700ede21g", "accountType": "atlassian", "active": false, "avatarUrls": { "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16", "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24", "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32", "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48" }, "displayName": "Mia Krystof", "key": "", "name": "", "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g" }, "assigneeType": "PROJECT_LEAD", "description": "This is a Jira component", "id": "10000", "isAssigneeTypeValid": false, "lead": { "accountId": "5b10a2844c20165700ede21g", "accountType": "atlassian", "active": false, "avatarUrls": { "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16", "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24", "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32", "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48" }, "displayName": "Mia Krystof", "key": "", "name": "", "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g" }, "metadata": { "icon": "https://www.example.com/icon.png" }, "name": "Component 1", "project": "HSP", "projectId": 10000, "realAssignee": { "accountId": "5b10a2844c20165700ede21g", "accountType": "atlassian", "active": false, "avatarUrls": { "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16", "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24", "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32", "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48" }, "displayName": "Mia Krystof", "key": "", "name": "", "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g" }, "realAssigneeType": "PROJECT_LEAD", "self": "https://your-domain.atlassian.net/rest/api/3/component/10000" } ], "description": "This project was created as an example for REST.", "email": "" } ``` -------------------------------- ### Bulk Edit Get Fields Response Example Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-bulk-operations Example JSON response for the Bulk Edit Get Fields API, detailing available fields, their properties, and potential options or messages. ```json { "fields": [ { "id": "assignee", "isRequired": false, "name": "Assignee", "searchUrl": "https://your-domain.atlassian.net/rest/api/3/user/assignable/multiProjectSearch?projectKeys=KAN&query=", "type": "assignee" }, { "id": "components", "isRequired": false, "multiSelectFieldOptions": [ "ADD", "REMOVE", "REPLACE", "REMOVE_ALL" ], "name": "Components", "type": "components", "unavailableMessage": "{0}NOTE{1}: The project of the selected issue(s) does not have any components." }, { "fieldOptions": [ { "description": "This problem will block progress.", "id": "1", "priority": "Highest" }, { "description": "Has the potential to affect progress.", "id": "2", "priority": "Lowest" }, { "description": "Trivial problem with little or no impact on progress.", "id": "3", "priority": "Medium" } ], "id": "priority", "isRequired": false, "name": "Priority", "type": "priority" } ] } ``` -------------------------------- ### Get User Email Response Example Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users Example JSON response for a successful user email retrieval request. ```json { "accountId": "", "email": "" } ``` -------------------------------- ### Example JSON Response for Project Versions Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-versions This is an example of the JSON response structure when successfully retrieving project versions. It includes details like version ID, name, description, and release dates. ```json [ { "archived": false, "description": "An excellent version", "id": "10000", "name": "New Version 1", "overdue": true, "projectId": 10000, "releaseDate": 1278385482288, "releaseDateSet": true, "released": true, "self": "https://your-domain.atlassian.net/rest/api/3/version/10000", "startDateSet": false, "userReleaseDate": "6/Jul/2010" }, { "archived": false, "description": "Minor Bugfix version", "id": "10010", "issuesStatusForFixVersion": { "done": 100, "inProgress": 20, "toDo": 10, "unmapped": 0 }, "name": "Next Version", "overdue": false, "projectId": 10000, "releaseDateSet": false, "released": false, "self": "https://your-domain.atlassian.net/rest/api/3/version/10010", "startDateSet": false } ] ``` -------------------------------- ### Workflow Project Usage Response Example Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflows Example JSON response structure for a successful request to get projects using a workflow. ```json { "projects": { "nextPageToken": "eyJvIjoyfQ==", "values": [ { "id": "1003" } ] }, "workflowId": "fb759d53-a3a4-45ff-9de4-547c4b638dde" } ``` -------------------------------- ### Example Project Components Response Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-components This is an example of the JSON response when successfully retrieving project components. It includes details for each component such as ARI, assignee, description, and ID. ```json [ { "ari": "ari:cloud:compass:fdb3fdec-4e70-be56-11ee-0242ac120002:component/fdb3fdec-11ee-4e70-be56-0242ac120002/fdb3fdec-4e70-11ee-be56-0242ac120002", "assignee": { "accountId": "5b10a2844c20165700ede21g", "accountType": "atlassian", "active": false, "avatarUrls": { "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16", "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24", "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32", "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48" }, "displayName": "Mia Krystof", "key": "", "name": "", "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g" }, "assigneeType": "PROJECT_LEAD", "description": "This is a Jira component", "id": "10000", "isAssigneeTypeValid": false, "lead": { "accountId": "5b10a2844c20165700ede21g", "accountType": "atlassian", "active": false, "avatarUrls": { "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16", "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24", "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32", "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48" }, "displayName": "Mia Krystof", "key": "", "name": "", "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g" }, "metadata": { "icon": "https://www.example.com/icon.png" }, "name": "Component 1", "project": "HSP", "projectId": 10000, "realAssignee": { "accountId": "5b10a2844c20165700ede21g", "accountType": "atlassian", "active": false, "avatarUrls": { "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16", "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24", "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32", "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48" }, "displayName": "Mia Krystof", "key": "", "name": "", "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g" }, "realAssigneeType": "PROJECT_LEAD", "self": "https://your-domain.atlassian.net/rest/api/3/component/10000" }, { "ari": "ari:cloud:compass:fdb3fdec-4e70-be56-11ee-0242ac120002:component/fdb3fdec-11ee-4e70-be56-0242ac120002/fdb3fdec-4e70-11ee-be56-0242ac120002", "assignee": { "accountId": "5b10a2844c20165700ede21g", "accountType": "atlassian", "active": false, "avatarUrls": { "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16", "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24", "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32", "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48" }, "displayName": "Mia Krystof", "key": "", "name": "", "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g" }, "assigneeType": "PROJECT_LEAD", "description": "This is a Jira component", "id": "10000", "isAssigneeTypeValid": false, "lead": { "accountId": "5b10a2844c20165700ede21g", "accountType": "atlassian", "active": false, "avatarUrls": { "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16", "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24", "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32", "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48" }, "displayName": "Mia Krystof", "key": "", "name": "", "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g" }, "metadata": { "icon": "https://www.example.com/icon.png" }, "name": "Component 1", "project": "HSP", "projectId": 10000, "realAssignee": { "accountId": "5b10a2844c20165700ede21g", "accountType": "atlassian", "active": false, "avatarUrls": { "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16", "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24", "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32", "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48" }, "displayName": "Mia Krystof", "key": "", "name": "", "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g" }, "realAssigneeType": "PROJECT_LEAD", "self": "https://your-domain.atlassian.net/rest/api/3/component/10000" } ``` -------------------------------- ### Example Plan Response JSON Source: https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-plans This is an example of a successful JSON response when retrieving plan details. It includes various properties defining the plan's configuration and status. ```json { "crossProjectReleases": [ { "name": "x-plr", "releaseIds": [ 345 ] } ], "customFields": [ { "customFieldId": 34, "filter": false }, { "customFieldId": 39, "filter": true } ], "exclusionRules": { "issueIds": [ 1, 2 ], "issueTypeIds": [ 13, 23 ], "numberOfDaysToShowCompletedIssues": 50, "releaseIds": [ 14, 24 ], "workStatusCategoryIds": [ 12, 22 ], "workStatusIds": [ 11, 21 ] }, "id": 23, "issueSources": [ { "type": "Project", "value": 12 }, { "type": "Filter", "value": 10293 } ], "lastSaved": "2024-10-03T10:15:30Z", "leadAccountId": "628f5e86d5ec1f006ne7363x2s", "name": "Onset TBJ Plan", "permissions": [ { "holder": { "type": "AccountId", "value": "04jekw86d5jjje006ne7363x2s" }, "type": "Edit" } ], "scheduling": { "dependencies": "Concurrent", "endDate": { "dateCustomFieldId": 1098, "type": "DateCustomField" }, "estimation": "Hours", "inferredDates": "ReleaseDates", "startDate": { "type": "TargetStartDate" } }, "status": "Active" } ```