Operations (sample payloads)
Main operations
Create issue comment
Creates a comment on an issue. Sample Input Sample Output
{
"self": "https://your-domain.atlassian.net/rest/api/3/issue/CTP-123/comment/456789",
"id": "456789",
"author": {
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
"name": "john.doe",
"key": "john.doe",
"accountId": "5b10a2844c20165700ede21g",
"emailAddress": "john.doe@example.com",
"avatarUrls": \{
"48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9a-18e4f5bb2e94/48",
"24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9a-18e4f5bb2e94/24",
"16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9a-18e4f5bb2e94/16",
"32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9a-18e4f5bb2e94/32"
\},
"displayName": "John Doe",
"active": true,
"timeZone": "America/New_York",
"accountType": "atlassian"
},
"body": "This is a new comment on the issue. We should consider adding more details to the reproduction steps.",
"updateAuthor": {
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
"name": "john.doe",
"key": "john.doe",
"accountId": "5b10a2844c20165700ede21g",
"emailAddress": "john.doe@example.com",
"avatarUrls": \{
"48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9a-18e4f5bb2e94/48",
"24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9a-18e4f5bb2e94/24",
"16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9a-18e4f5bb2e94/16",
"32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9a-18e4f5bb2e94/32"
\},
"displayName": "John Doe",
"active": true,
"timeZone": "America/New_York",
"accountType": "atlassian"
},
"created": "2023-05-15T14:30:00.000+0000",
"updated": "2023-05-15T14:30:00.000+0000",
"jsdPublic": false
}
Create issue link
Create a link beteween two Jira issues Sample Input Sample Output
{
"success": true
}
Create version
Create a project version to be released Sample Input Sample Output
\{
"self": "https://your-domain.atlassian.net/rest/api/3/version/10000",
"id": "10000",
"description": "Major release with new features and bug fixes",
"name": "Version 2.0",
"archived": false,
"released": false,
"startDate": "2023-06-01T00:00:00.000Z",
"releaseDate": "2023-09-30T23:59:59.000Z",
"overdue": false,
"userStartDate": "2023-06-01",
"userReleaseDate": "2023-09-30",
"projectId": 10001
\}
Delete issue
Delete an issue from your Jira account. Optionally also delete the attached subtasks. Sample Input
\{
"issue_id": "CTP-123",
"delete_subtasks": true
\}
Sample Output
Download issue attachment
Download an attachment by providing its ID. Sample Input Sample Output
\{
"name": "project_requirements.pdf",
"url": "https://your-domain.atlassian.net/secure/attachment/10001/project_requirements.pdf",
"mime_type": "application/pdf",
"expires": 1623456789000
\}
Get attachment metadata
Returns the metadata for an attachment. Note that the attachment itself is not returned. Sample Input Sample Output
Get comment property
Returns the value of a comment property. Sample Input Sample Output
{
"keys": [
\{
"self": "https://your-domain.atlassian.net/rest/api/3/comment/10001/properties/custom_property",
"key": "custom_property"
\}
]
}
Get issue
Get details of an issue, using the issue's unique ID or Key. Sample Input
{
"issue_id": "CTP-123"
}
Sample Output
Get user
Get a user from Jira, either by their username or their user "key". Sample Input
{
"name": "johndoe"
}
Sample Output
{
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
"key": "johndoe",
"name": "johndoe",
"emailAddress": "johndoe@example.com",
"avatarUrls": \{
"16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/initials/JD-5.png?size=16&s=16",
"24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/initials/JD-5.png?size=24&s=24",
"32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/initials/JD-5.png?size=32&s=32",
"48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/initials/JD-5.png?size=48&s=48"
\},
"displayName": "John Doe",
"active": true,
"timeZone": "America/New_York",
"locale": "en_US",
"groups": \{
"size": 3,
"items": []
\},
"applicationRoles": \{
"size": 1,
"items": []
\},
"expand": "groups,applicationRoles"
}
Get user info
Get information about the current authenticated user. Sample Input Sample Output
Get version
Get a project version by its id Sample Input Sample Output
List board sprints
Lists all the sprints for a specific board Sample Input
\{
"board_id": "123",
"state": "active,closed",
"start_at": 0,
"max_results": 10
\}
Sample Output
{
"maxResults": 10,
"startAt": 0,
"isLast": false,
"values": [
\{
"id": 456,
"self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/456",
"state": "active",
"name": "Sprint 1",
"startDate": "2023-05-01T00:00:00.000Z",
"endDate": "2023-05-14T23:59:59.999Z",
"completeDate": null,
"originBoardId": 123,
"goal": "Complete user authentication feature"
\},
\{
"id": 457,
"self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/457",
"state": "closed",
"name": "Sprint 2",
"startDate": "2023-04-17T00:00:00.000Z",
"endDate": "2023-04-30T23:59:59.999Z",
"completeDate": "2023-04-30T18:00:00.000Z",
"originBoardId": 123,
"goal": "Implement dashboard analytics"
\}
]
}
List boards
Lists all boards Sample Input
\{
"start_at": 0,
"max_results": 50
\}
Sample Output
{
"maxResults": 50,
"startAt": 0,
"total": 3,
"isLast": true,
"values": [
{
"id": 1,
"self": "https://your-domain.atlassian.net/rest/agile/1.0/board/1",
"name": "Development Board",
"type": "scrum",
"location": \{
"projectId": 10000,
"displayName": "Project Alpha",
"projectName": "Project Alpha",
"projectKey": "ALPHA",
"projectTypeKey": "software",
"avatarURI": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000&avatarId=10200",
"name": "Project Alpha"
\}
},
{
"id": 2,
"self": "https://your-domain.atlassian.net/rest/agile/1.0/board/2",
"name": "Marketing Board",
"type": "kanban",
"location": \{
"projectId": 10001,
"displayName": "Project Beta",
"projectName": "Project Beta",
"projectKey": "BETA",
"projectTypeKey": "business",
"avatarURI": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10001&avatarId=10201",
"name": "Project Beta"
\}
},
{
"id": 3,
"self": "https://your-domain.atlassian.net/rest/agile/1.0/board/3",
"name": "Support Board",
"type": "kanban",
"location": \{
"projectId": 10002,
"displayName": "Project Gamma",
"projectName": "Project Gamma",
"projectKey": "GAMMA",
"projectTypeKey": "service_desk",
"avatarURI": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10002&avatarId=10202",
"name": "Project Gamma"
\}
}
]
}
List issue comments
Lists all of the comments for an issue. Sample Input
\{
"issue_id": "CTP-123",
"start_at": 0,
"max_results": 10,
"expand": "renderedBody,properties"
\}
Sample Output
List issue worklogs
Returns all worklogs for an issue. Time tracking must be enabled in Jira, otherwise this operation returns an error. Sample Input Sample Output
{
"startAt": 0,
"maxResults": 50,
"total": 2,
"worklogs": [
{
"self": "https://your-domain.atlassian.net/rest/api/3/issue/CTP-123/worklog/12345",
"author": {
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
"name": "john.doe",
"key": "john.doe",
"accountId": "5b10a2844c20165700ede21g",
"emailAddress": "john.doe@example.com",
"avatarUrls": \{
"48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128?size=48&s=48",
"24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128?size=24&s=24",
"16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128?size=16&s=16",
"32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128?size=32&s=32"
\},
"displayName": "John Doe",
"active": true,
"timeZone": "America/New_York"
},
"updateAuthor": {
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
"name": "john.doe",
"key": "john.doe",
"accountId": "5b10a2844c20165700ede21g",
"emailAddress": "john.doe@example.com",
"avatarUrls": \{
"48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128?size=48&s=48",
"24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128?size=24&s=24",
"16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128?size=16&s=16",
"32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128?size=32&s=32"
\},
"displayName": "John Doe",
"active": true,
"timeZone": "America/New_York"
},
"comment": "Worked on implementing new feature",
"created": "2023-05-15T09:00:00.000+0000",
"updated": "2023-05-15T09:00:00.000+0000",
"started": "2023-05-15T08:00:00.000+0000",
"timeSpent": "1h",
"timeSpentSeconds": 3600,
"id": "12345",
"issueId": "10002"
},
{
"self": "https://your-domain.atlassian.net/rest/api/3/issue/CTP-123/worklog/12346",
"author": {
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21h",
"name": "jane.smith",
"key": "jane.smith",
"accountId": "5b10a2844c20165700ede21h",
"emailAddress": "jane.smith@example.com",
"avatarUrls": \{
"48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128?size=48&s=48",
"24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128?size=24&s=24",
"16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128?size=16&s=16",
"32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128?size=32&s=32"
\},
"displayName": "Jane Smith",
"active": true,
"timeZone": "Europe/London"
},
"updateAuthor": {
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21h",
"name": "jane.smith",
"key": "jane.smith",
"accountId": "5b10a2844c20165700ede21h",
"emailAddress": "jane.smith@example.com",
"avatarUrls": \{
"48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128?size=48&s=48",
"24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128?size=24&s=24",
"16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128?size=16&s=16",
"32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128?size=32&s=32"
\},
"displayName": "Jane Smith",
"active": true,
"timeZone": "Europe/London"
},
"comment": "Reviewed and tested the new feature",
"created": "2023-05-15T14:30:00.000+0000",
"updated": "2023-05-15T14:30:00.000+0000",
"started": "2023-05-15T14:00:00.000+0000",
"timeSpent": "30m",
"timeSpentSeconds": 1800,
"id": "12346",
"issueId": "10002"
}
]
}
List projects
Returns all projects which are visible for the currently logged in user. If no user is logged in, it returns the list of projects that are visible when using anonymous access. Sample Input Sample Output
{
"items": [
{
"expand": "description,lead,issueTypes,url,projectKeys",
"self": "https://your-domain.atlassian.net/rest/api/3/project/10000",
"id": "10000",
"key": "PRJ",
"description": "This is a sample project description",
"lead": {
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
"key": "john.doe",
"name": "John Doe",
"avatarUrls": \{
"16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JD-5.png?size=16&s=16",
"24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JD-5.png?size=24&s=24",
"32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JD-5.png?size=32&s=32",
"48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JD-5.png?size=48&s=48"
\},
"displayName": "John Doe",
"active": true
},
"issueTypes": [
\{
"self": "https://your-domain.atlassian.net/rest/api/3/issuetype/10001",
"id": "10001",
"description": "A task that needs to be done.",
"iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=medium&avatarId=10318&avatarType=issuetype",
"name": "Task",
"subtask": false,
"avatarId": 10318
\}
],
"name": "Sample Project",
"avatarUrls": \{
"48x48": "https://your-domain.atlassian.net/secure/projectavatar?pid=10000&avatarId=10011",
"24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000&avatarId=10011",
"16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000&avatarId=10011",
"32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000&avatarId=10011"
\},
"projectKeys": [
"PRJ"
],
"projectTypeKey": "software"
}
]
}
List sprint issues
Lists all the issues in a specific sprint Sample Input Sample Output
{
"expand": "schema,names",
"startAt": 0,
"maxResults": 50,
"total": 2,
"issues": [
{
"expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
"id": "10001",
"self": "https://your-domain.atlassian.net/rest/api/3/issue/10001",
"key": "PROJ-1",
"fields": {
"summary": "Implement new feature",
"status": {
"self": "https://your-domain.atlassian.net/rest/api/3/status/3",
"description": "This issue is being actively worked on at the moment by the assignee.",
"iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/inprogress.png",
"name": "In Progress",
"id": "3",
"statusCategory": \{
"self": "https://your-domain.atlassian.net/rest/api/3/statuscategory/2",
"id": 2,
"key": "inprogress",
"colorName": "yellow",
"name": "In Progress"
\}
},
"assignee": {
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
"name": "john.doe",
"key": "john.doe",
"accountId": "5b10a2844c20165700ede21g",
"emailAddress": "john.doe@example.com",
"avatarUrls": \{
"48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JD-5.png?size=48&s=48",
"24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JD-5.png?size=24&s=24",
"16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JD-5.png?size=16&s=16",
"32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JD-5.png?size=32&s=32"
\},
"displayName": "John Doe",
"active": true,
"timeZone": "Australia/Sydney"
}
}
},
{
"expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
"id": "10002",
"self": "https://your-domain.atlassian.net/rest/api/3/issue/10002",
"key": "PROJ-2",
"fields": {
"summary": "Fix critical bug",
"status": {
"self": "https://your-domain.atlassian.net/rest/api/3/status/3",
"description": "This issue is being actively worked on at the moment by the assignee.",
"iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/inprogress.png",
"name": "In Progress",
"id": "3",
"statusCategory": \{
"self": "https://your-domain.atlassian.net/rest/api/3/statuscategory/2",
"id": 2,
"key": "inprogress",
"colorName": "yellow",
"name": "In Progress"
\}
},
"assignee": {
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21h",
"name": "jane.smith",
"key": "jane.smith",
"accountId": "5b10a2844c20165700ede21h",
"emailAddress": "jane.smith@example.com",
"avatarUrls": \{
"48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JS-5.png?size=48&s=48",
"24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JS-5.png?size=24&s=24",
"16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JS-5.png?size=16&s=16",
"32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JS-5.png?size=32&s=32"
\},
"displayName": "Jane Smith",
"active": true,
"timeZone": "America/New_York"
}
}
}
]
}
Raw HTTP request (advanced)
Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication. Sample Input
{
"method": "POST",
"url": {
"endpoint": "/rest/api/3/issue"
},
"headers": [
\{
"key": "Content-Type",
"value": "application/json"
\}
],
"query_parameters": [
\{
"key": "fields",
"value": "summary,description"
\}
],
"body": {
"raw": {
"fields": {
"project": {
"key": "PROJ"
},
"summary": "New issue created via API",
"description": {
"type": "doc",
"version": 1,
"content": [
{
"type": "paragraph",
"content": [
\{
"text": "This is a sample issue description.",
"type": "text"
\}
]
}
]
},
"issuetype": {
"name": "Task"
}
}
}
},
"include_raw_body": true,
"parse_response": "true"
}
Sample Output
{
"response": {
"status_code": 201,
"headers": \{
"Content-Type": "application/json;charset=UTF-8",
"X-AUSERNAME": "admin",
"X-Seraph-LoginReason": "OK",
"X-ASESSIONID": "1234x5678x90123",
"Cache-Control": "no-cache, no-store, no-transform"
\},
"body": \{
"id": "10001",
"key": "PROJ-1",
"self": "https://your-domain.atlassian.net/rest/api/3/issue/10001"
\}
}
}
Search issues (JQL)
Search for issues using JQL Sample Input
\{
"jql": "project = 'PROJ' AND status = 'Open' ORDER BY priority DESC",
"expand": "description,lead,projectKeys,url,issueTypes",
"per_page": 50,
"start_at": 0
\}
Sample Output
Search Users
Returns a list of users that match the search string. Sample Input
\{
"query": "john",
"start_at": 0,
"max_results": 2
\}
Sample Output
{
"results": [
{
"active": true,
"accountType": "atlassian",
"accountId": "5b10ac8d82e05b22cc7d4ef5",
"name": "john.doe",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10ac8d82e05b22cc7d4ef5",
"displayName": "John Doe",
"emailAddress": "john.doe@example.com",
"timeZone": "America/New_York",
"locale": "en_US",
"avatarUrls": \{
"48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef5/48",
"24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef5/24",
"16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef5/16",
"32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef5/32"
\},
"key": "john.doe"
},
{
"active": true,
"accountType": "atlassian",
"accountId": "5b10ac8d82e05b22cc7d4ef6",
"name": "john.smith",
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10ac8d82e05b22cc7d4ef6",
"displayName": "John Smith",
"emailAddress": "john.smith@example.com",
"timeZone": "Europe/London",
"locale": "en_GB",
"avatarUrls": \{
"48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef6/48",
"24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef6/24",
"16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef6/16",
"32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef6/32"
\},
"key": "john.smith"
}
]
}
Search Users (JIRA Server)
Returns a list of users that match the search string for a JIRA Server instance. Sample Input
\{
"query": "john",
"start_at": 0,
"max_results": 10
\}
Sample Output
Update issue
Update an issue in Jira. Sample Input Sample Output
{
"id": "10001",
"header": {},
"body": {
"expand": "renderedFields,names,schema,operations,editmeta,changelog,versionedRepresentations",
"id": "10001",
"self": "https://your-domain.atlassian.net/rest/api/2/issue/10001",
"key": "CTP-123",
"fields": {
"issuetype": \{
"self": "https://your-domain.atlassian.net/rest/api/2/issuetype/10001",
"id": "10001",
"description": "A task that needs to be done.",
"iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10318&avatarType=issuetype",
"name": "Task",
"subtask": false,
"avatarId": 10318
\},
"project": {
"self": "https://your-domain.atlassian.net/rest/api/2/project/10000",
"id": "10000",
"key": "CTP",
"name": "Customer Training Project",
"avatarUrls": \{
"48x48": "https://your-domain.atlassian.net/secure/projectavatar?pid=10000&avatarId=10324",
"24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000&avatarId=10324",
"16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000&avatarId=10324",
"32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000&avatarId=10324"
\}
},
"summary": "Update API integration",
"description": "We need to update our API integration to support the latest version.",
"priority": \{
"self": "https://your-domain.atlassian.net/rest/api/2/priority/2",
"iconUrl": "https://your-domain.atlassian.net/images/icons/priorities/high.svg",
"name": "High",
"id": "2"
\},
"status": {
"self": "https://your-domain.atlassian.net/rest/api/2/status/10000",
"description": "The issue is open and ready for the assignee to start work on it.",
"iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
"name": "To Do",
"id": "10000",
"statusCategory": \{
"self": "https://your-domain.atlassian.net/rest/api/2/statuscategory/2",
"id": 2,
"key": "new",
"colorName": "blue-gray",
"name": "To Do"
\}
},
"assignee": {
"self": "https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g",
"name": "john.doe",
"key": "john.doe",
"emailAddress": "john.doe@example.com",
"avatarUrls": \{
"48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/6a7e7a90-b393-4c6f-8eb3-b9c3e3414433/48",
"24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/6a7e7a90-b393-4c6f-8eb3-b9c3e3414433/24",
"16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/6a7e7a90-b393-4c6f-8eb3-b9c3e3414433/16",
"32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/6a7e7a90-b393-4c6f-8eb3-b9c3e3414433/32"
\},
"displayName": "John Doe",
"active": true,
"timeZone": "Australia/Sydney"
},
"reporter": {
"self": "https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21h",
"name": "jane.smith",
"key": "jane.smith",
"emailAddress": "jane.smith@example.com",
"avatarUrls": \{
"48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/6a7e7a90-b393-4c6f-8eb3-b9c3e3414434/48",
"24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/6a7e7a90-b393-4c6f-8eb3-b9c3e3414434/24",
"16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/6a7e7a90-b393-4c6f-8eb3-b9c3e3414434/16",
"32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/6a7e7a90-b393-4c6f-8eb3-b9c3e3414434/32"
\},
"displayName": "Jane Smith",
"active": true,
"timeZone": "Australia/Sydney"
},
"labels": [
"api",
"integration"
],
"versions": [
\{
"self": "https://your-domain.atlassian.net/rest/api/2/version/10000",
"id": "10000",
"name": "1.0",
"archived": false,
"released": true,
"releaseDate": "2023-03-01"
\},
\{
"self": "https://your-domain.atlassian.net/rest/api/2/version/10001",
"id": "10001",
"name": "1.1",
"archived": false,
"released": true,
"releaseDate": "2023-05-01"
\}
],
"fixVersions": [
\{
"self": "https://your-domain.atlassian.net/rest/api/2/version/10002",
"id": "10002",
"name": "1.2",
"archived": false,
"released": false,
"releaseDate": "2023-07-01"
\}
],
"components": [
\{
"self": "https://your-domain.atlassian.net/rest/api/2/component/10000",
"id": "10000",
"name": "Backend"
\}
],
"duedate": "2023-06-30",
"customfield_10000": "High"
}
}
}
Update version
Update a project version by its id Sample Input Sample Output
DDL operations
List assignable users (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
{}
Sample Output
List issue fields (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input Sample Output
[
{
"id": "summary",
"name": "Summary",
"custom": false,
"orderable": true,
"navigable": true,
"searchable": true,
"clauseNames": [
"summary"
],
"schema": \{
"type": "string",
"system": "summary"
\}
},
{
"id": "issuetype",
"name": "Issue Type",
"custom": false,
"orderable": true,
"navigable": true,
"searchable": true,
"clauseNames": [
"issuetype",
"type"
],
"schema": \{
"type": "issuetype",
"system": "issuetype"
\}
},
{
"id": "priority",
"name": "Priority",
"custom": false,
"orderable": true,
"navigable": true,
"searchable": true,
"clauseNames": [
"priority"
],
"schema": \{
"type": "priority",
"system": "priority"
\}
},
{
"id": "customfield_10001",
"name": "Story Points",
"custom": true,
"orderable": true,
"navigable": true,
"searchable": true,
"clauseNames": [
"cf[10001]",
"Story Points"
],
"schema": \{
"type": "number",
"custom": "com.atlassian.jira.plugin.system.customfieldtypes:float",
"customId": 10001
\}
}
]
List issue link types (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input Sample Output
List issue transitions (DDL)
Sample Input Sample Output
{
"transitions": [
{
"id": "11",
"name": "To Do",
"to": {
"self": "https://your-domain.atlassian.net/rest/api/3/status/10000",
"description": "This issue is ready to be worked on.",
"iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
"name": "To Do",
"id": "10000",
"statusCategory": \{
"self": "https://your-domain.atlassian.net/rest/api/3/statuscategory/2",
"id": 2,
"key": "new",
"colorName": "blue-gray",
"name": "To Do"
\}
}
},
{
"id": "21",
"name": "In Progress",
"to": {
"self": "https://your-domain.atlassian.net/rest/api/3/status/3",
"description": "This issue is being actively worked on.",
"iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/inprogress.png",
"name": "In Progress",
"id": "3",
"statusCategory": \{
"self": "https://your-domain.atlassian.net/rest/api/3/statuscategory/4",
"id": 4,
"key": "indeterminate",
"colorName": "yellow",
"name": "In Progress"
\}
}
},
{
"id": "31",
"name": "Done",
"to": {
"self": "https://your-domain.atlassian.net/rest/api/3/status/10001",
"description": "This issue is completed.",
"iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/closed.png",
"name": "Done",
"id": "10001",
"statusCategory": \{
"self": "https://your-domain.atlassian.net/rest/api/3/statuscategory/3",
"id": 3,
"key": "done",
"colorName": "green",
"name": "Done"
\}
}
}
]
}
List issue types (DDL)
Sample Input
{}
Sample Output
[
\{
"value": "10000",
"label": "Epic"
\},
\{
"value": "10001",
"label": "Story"
\},
\{
"value": "10002",
"label": "Task"
\},
\{
"value": "10003",
"label": "Bug"
\},
\{
"value": "10004",
"label": "Subtask"
\}
]
List priorities (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
{}
Sample Output
List project IDs (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
{}
Sample Output
{
"options": [
\{
"value": "10000",
"text": "Project Alpha"
\},
\{
"value": "10001",
"text": "Project Beta"
\},
\{
"value": "10002",
"text": "Project Gamma"
\},
\{
"value": "10003",
"text": "Project Delta"
\},
\{
"value": "10004",
"text": "Project Epsilon"
\}
]
}
List project keys (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input Sample Output
[
\{
"key": "PROJ",
"name": "Project Alpha"
\},
\{
"key": "DEV",
"name": "Development Team"
\},
\{
"key": "QA",
"name": "Quality Assurance"
\},
\{
"key": "MKTG",
"name": "Marketing"
\},
\{
"key": "HR",
"name": "Human Resources"
\}
]
List project statuses (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input Sample Output
List project versions (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input
{}
Sample Output
{
"versions": [
\{
"self": "https://your-domain.atlassian.net/rest/api/3/version/10000",
"id": "10000",
"name": "Version 1.0",
"archived": false,
"released": true,
"startDate": "2023-01-01",
"releaseDate": "2023-03-15",
"userStartDate": "01/Jan/23",
"userReleaseDate": "15/Mar/23",
"projectId": 10001
\},
\{
"self": "https://your-domain.atlassian.net/rest/api/3/version/10001",
"id": "10001",
"name": "Version 1.1",
"archived": false,
"released": false,
"startDate": "2023-04-01",
"releaseDate": "2023-06-30",
"userStartDate": "01/Apr/23",
"userReleaseDate": "30/Jun/23",
"projectId": 10001
\}
]
}
List resolutions (DDL)
Sample Input
{}
Sample Output
[
\{
"self": "https://your-domain.atlassian.net/rest/api/3/resolution/1",
"id": "1",
"description": "A fix for this issue is complete and tested.",
"name": "Done",
"iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/closed.png"
\},
\{
"self": "https://your-domain.atlassian.net/rest/api/3/resolution/2",
"id": "2",
"description": "This issue won't be actioned.",
"name": "Won't Do",
"iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/cancelled.png"
\},
\{
"self": "https://your-domain.atlassian.net/rest/api/3/resolution/3",
"id": "3",
"description": "This issue is a duplicate of an existing issue.",
"name": "Duplicate",
"iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/duplicate.png"
\}
]
List statuses (DDL)
Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping
Sample Input Sample Output