Operations (sample payloads)
Main operations
Create issue
Create an issue in Jira. Sample Input
{
"project_key": "PROJ",
"summary": "Implement new feature for user authentication",
"issue_type_id": "10001",
"labels": [
"security",
"authentication"
],
"description": "We need to implement a new feature for user authentication that includes two-factor authentication and password complexity requirements.",
"due_date": "2023-06-30",
"assignee_key": "john.doe",
"reporter_key": "jane.smith",
"priority_id": "2",
"versions": [
"1.0",
"1.1"
],
"fix_versions": [
"1.2"
],
"other_fields": [
\{
"name": "customfield_10001",
"value": "High"
\},
\{
"name": "customfield_10002",
"value": [
"Frontend",
"Backend"
]
\}
]
}
Sample Output
{
"expand": "renderedFields,names,schema,operations,editmeta,changelog,versionedRepresentations",
"id": "10234",
"self": "https://your-domain.atlassian.net/rest/api/2/issue/10234",
"key": "PROJ-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": "PROJ",
"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"
\}
},
"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"
\},
"labels": [
"security",
"authentication"
],
"versions": [
\{
"self": "https://your-domain.atlassian.net/rest/api/2/version/10000",
"id": "10000",
"name": "1.0",
"archived": false,
"released": true
\},
\{
"self": "https://your-domain.atlassian.net/rest/api/2/version/10001",
"id": "10001",
"name": "1.1",
"archived": false,
"released": false
\}
],
"fixVersions": [
\{
"self": "https://your-domain.atlassian.net/rest/api/2/version/10002",
"id": "10002",
"name": "1.2",
"archived": false,
"released": false
\}
],
"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/47f71cf9-e9c1-4c9c-8d51-54a6f3324a4c/48",
"24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/47f71cf9-e9c1-4c9c-8d51-54a6f3324a4c/24",
"16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/47f71cf9-e9c1-4c9c-8d51-54a6f3324a4c/16",
"32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/47f71cf9-e9c1-4c9c-8d51-54a6f3324a4c/32"
\},
"displayName": "John Doe",
"active": true,
"timeZone": "Australia/Sydney"
},
"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"
\}
},
"description": "We need to implement a new feature for user authentication that includes two-factor authentication and password complexity requirements.",
"summary": "Implement new feature for user authentication",
"creator": {
"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/47f71cf9-e9c1-4c9c-8d51-54a6f3324a4c/48",
"24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/47f71cf9-e9c1-4c9c-8d51-54a6f3324a4c/24",
"16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/47f71cf9-e9c1-4c9c-8d51-54a6f3324a4c/16",
"32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/47f71cf9-e9c1-4c9c-8d51-54a6f3324a4c/32"
\},
"displayName": "Jane Smith",
"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/47f71cf9-e9c1-4c9c-8d51-54a6f3324a4c/48",
"24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/47f71cf9-e9c1-4c9c-8d51-54a6f3324a4c/24",
"16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/47f71cf9-e9c1-4c9c-8d51-54a6f3324a4c/16",
"32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/47f71cf9-e9c1-4c9c-8d51-54a6f3324a4c/32"
\},
"displayName": "Jane Smith",
"active": true,
"timeZone": "Australia/Sydney"
},
"duedate": "2023-06-30",
"customfield_10001": "High",
"customfield_10002": [
"Frontend",
"Backend"
]
}
}
Create issue attachment
Creates an attachment on an issue. Sample Input
{
"issue_id": "CTP-123",
"attachment": \{
"filename": "bug_report.pdf",
"content": "JVBERi0xLjMKJcTl8uXrp/Og0MTGCjQgMCBvYmoKPDwgL0xlbmd0aCA1IDAgUiAvRmlsdGVyIC9GbGF0ZURlY29kZSA+PgpzdHJlYW0KeAGNksFugzAMhu99Cp9gD8ZJCGlwQtoOe4CpF9oOEweEtNJWgulh...",
"mime_type": "application/pdf"
\}
}
Sample Output
{
"results": [
{
"self": "https://your-domain.atlassian.net/rest/api/3/attachment/10000",
"id": "10000",
"filename": "bug_report.pdf",
"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.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",
"accountType": "atlassian"
},
"created": "2023-06-15T09:30:00.000+0000",
"size": 58392,
"mimeType": "application/pdf",
"content": "https://your-domain.atlassian.net/secure/attachment/10000/bug_report.pdf"
}
]
}
Create issue comment
Creates a comment on an issue. Sample Input
{
"issue_id": "CTP-123",
"body": "This is a new comment on the issue. We should consider adding more details to the reproduction steps.",
"properties": [
{
"key": "comment_type",
"value": {
"type": "internal"
}
}
]
}
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/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",
"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/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",
"accountType": "atlassian"
},
"created": "2023-06-15T14:30:00.000+0000",
"updated": "2023-06-15T14:30:00.000+0000",
"jsdPublic": false
}
Create issue link
Create a link between two Jira issues. Sample Input Sample Output
{
"success": true
}
Create version
Create a project version to be released. Sample Input
\{
"name": "Version 2.0",
"description": "Major release with new features and bug fixes",
"project": "PROJ",
"user_start_date": "2023-06-01T00:00:00Z",
"user_release_date": "2023-09-30T23:59:59Z",
"archived": false,
"released": false
\}
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-01",
"releaseDate": "2023-09-30",
"overdue": false,
"userStartDate": "2023-06-01T00:00:00.000Z",
"userReleaseDate": "2023-09-30T23:59:59.000Z",
"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
{
"attachment_id": "10001"
}
Sample Output
\{
"name": "project_requirements.pdf",
"url": "https://jira-instance.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
{
"attachment_id": "10001"
}
Sample Output
{
"id": 10001,
"self": "https://your-domain.atlassian.net/rest/api/3/attachment/10001",
"filename": "example_document.pdf",
"author": {
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
"accountId": "5b10a2844c20165700ede21g",
"avatarUrls": \{
"48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48",
"24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
"16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
"32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32"
\},
"displayName": "Mark Kennedy",
"active": true
},
"created": "2023-05-15T09:30:00.000+0000",
"size": 2048000,
"mimeType": "application/pdf",
"properties": {},
"content": "https://your-domain.atlassian.net/rest/api/3/attachment/content/10001",
"thumbnail": "https://your-domain.atlassian.net/rest/api/3/attachment/thumbnail/10001"
}
Get comment property
Returns the value of a comment property. Sample Input
\{
"comment_id": "10001",
"property_key": "custom_field_123"
\}
Sample Output
Get issue
Get details of an issue, using the issue's unique ID or Key. Sample Input
{
"issue_id": "CTP-123"
}
Sample Output
{
"expand": "renderedFields,names,schema,operations,editmeta,changelog,versionedRepresentations",
"id": "10001",
"self": "https://your-domain.atlassian.net/rest/api/3/issue/10001",
"key": "CTP-123",
"fields": {
"issuetype": \{
"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
\},
"timespent": null,
"project": {
"self": "https://your-domain.atlassian.net/rest/api/3/project/10000",
"id": "10000",
"key": "CTP",
"name": "Customer Tracking 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"
\}
},
"fixVersions": [],
"aggregatetimespent": null,
"resolution": null,
"resolutiondate": null,
"workratio": -1,
"lastViewed": "2023-05-17T09:30:00.000+0000",
"watches": \{
"self": "https://your-domain.atlassian.net/rest/api/3/issue/CTP-123/watchers",
"watchCount": 1,
"isWatching": true
\},
"created": "2023-05-15T14:00:00.000+0000",
"priority": \{
"self": "https://your-domain.atlassian.net/rest/api/3/priority/3",
"iconUrl": "https://your-domain.atlassian.net/images/icons/priorities/medium.svg",
"name": "Medium",
"id": "3"
\},
"labels": [
"customer-facing",
"urgent"
],
"timeestimate": null,
"aggregatetimeoriginalestimate": null,
"versions": [],
"issuelinks": [],
"assignee": {
"self": "https://your-domain.atlassian.net/rest/api/3/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/a447bfe0-eca1-4317-9941-5361ef3dff9f/48",
"24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/a447bfe0-eca1-4317-9941-5361ef3dff9f/24",
"16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/a447bfe0-eca1-4317-9941-5361ef3dff9f/16",
"32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/a447bfe0-eca1-4317-9941-5361ef3dff9f/32"
\},
"displayName": "John Doe",
"active": true,
"timeZone": "America/New_York"
},
"updated": "2023-05-17T10:00:00.000+0000",
"status": {
"self": "https://your-domain.atlassian.net/rest/api/3/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/3/statuscategory/2",
"id": 2,
"key": "new",
"colorName": "blue-gray",
"name": "To Do"
\}
},
"components": [],
"timeoriginalestimate": null,
"description": "We need to update the customer portal with the latest features and bug fixes.",
"timetracking": {},
"attachment": [],
"aggregatetimeestimate": null,
"summary": "Update customer portal",
"creator": {
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21f",
"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/5b10a2844c20165700ede21f/a447bfe0-eca1-4317-9941-5361ef3dff9f/48",
"24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21f/a447bfe0-eca1-4317-9941-5361ef3dff9f/24",
"16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21f/a447bfe0-eca1-4317-9941-5361ef3dff9f/16",
"32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21f/a447bfe0-eca1-4317-9941-5361ef3dff9f/32"
\},
"displayName": "Jane Smith",
"active": true,
"timeZone": "America/New_York"
},
"subtasks": [],
"reporter": {
"self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21f",
"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/5b10a2844c20165700ede21f/a447bfe0-eca1-4317-9941-5361ef3dff9f/48",
"24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21f/a447bfe0-eca1-4317-9941-5361ef3dff9f/24",
"16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21f/a447bfe0-eca1-4317-9941-5361ef3dff9f/16",
"32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21f/a447bfe0-eca1-4317-9941-5361ef3dff9f/32"
\},
"displayName": "Jane Smith",
"active": true,
"timeZone": "America/New_York"
},
"aggregateprogress": \{
"progress": 0,
"total": 0
\},
"environment": null,
"duedate": "2023-05-31",
"progress": \{
"progress": 0,
"total": 0
\},
"comment": \{
"comments": [],
"maxResults": 0,
"total": 0,
"startAt": 0
\},
"votes": \{
"self": "https://your-domain.atlassian.net/rest/api/3/issue/CTP-123/votes",
"votes": 0,
"hasVoted": false
\},
"worklog": \{
"startAt": 0,
"maxResults": 20,
"total": 0,
"worklogs": []
\}
}
}
Get user
Get a user from Jira, either by their username or their user "key". Sample Input Sample Output
Get user info
Get information about the current authenticated user. Sample Input Sample Output
{
"instance_url": "https://your-domain.atlassian.net"
}
Get version
Get a project version by its ID. Sample Input
{
"id": "10000"
}
Sample Output
List issue comments
Lists all of the comments for an issue. Sample Input Sample Output
{
"startAt": 0,
"maxResults": 50,
"total": 2,
"comments": [
{
"self": "https://your-domain.atlassian.net/rest/api/3/issue/CTP-123/comment/10000",
"id": "10000",
"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-8f9d-4e4f58d4ad8a/48",
"24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9d-4e4f58d4ad8a/24",
"16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9d-4e4f58d4ad8a/16",
"32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9d-4e4f58d4ad8a/32"
\},
"displayName": "John Doe",
"active": true,
"timeZone": "Australia/Sydney",
"accountType": "atlassian"
},
"body": "This is the first comment on the issue.",
"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-8f9d-4e4f58d4ad8a/48",
"24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9d-4e4f58d4ad8a/24",
"16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9d-4e4f58d4ad8a/16",
"32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9d-4e4f58d4ad8a/32"
\},
"displayName": "John Doe",
"active": true,
"timeZone": "Australia/Sydney",
"accountType": "atlassian"
},
"created": "2023-05-18T09:30:00.000+0000",
"updated": "2023-05-18T09:30:00.000+0000",
"jsdPublic": true,
"properties": [
{
"key": "custom-property",
"value": {
"value1": "Some custom value"
}
}
]
},
{
"self": "https://your-domain.atlassian.net/rest/api/3/issue/CTP-123/comment/10001",
"id": "10001",
"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/128c0ca8-3a3e-4f8c-8f9d-4e4f58d4ad8b/48",
"24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128c0ca8-3a3e-4f8c-8f9d-4e4f58d4ad8b/24",
"16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128c0ca8-3a3e-4f8c-8f9d-4e4f58d4ad8b/16",
"32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128c0ca8-3a3e-4f8c-8f9d-4e4f58d4ad8b/32"
\},
"displayName": "Jane Smith",
"active": true,
"timeZone": "America/New_York",
"accountType": "atlassian"
},
"body": "This is the second comment on the issue.",
"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/128c0ca8-3a3e-4f8c-8f9d-4e4f58d4ad8b/48",
"24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128c0ca8-3a3e-4f8c-8f9d-4e4f58d4ad8b/24",
"16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128c0ca8-3a3e-4f8c-8f9d-4e4f58d4ad8b/16",
"32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128c0ca8-3a3e-4f8c-8f9d-4e4f58d4ad8b/32"
\},
"displayName": "Jane Smith",
"active": true,
"timeZone": "America/New_York",
"accountType": "atlassian"
},
"created": "2023-05-18T10:15:00.000+0000",
"updated": "2023-05-18T10:15:00.000+0000",
"jsdPublic": true,
"properties": []
}
]
}
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": "Australia/Sydney"
},
"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": "Australia/Sydney"
},
"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-15T09:00:00.000+0000",
"timeSpent": "3h 30m",
"timeSpentSeconds": 12600,
"id": "12345",
"issueId": "CTP-123"
},
{
"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": "America/New_York"
},
"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": "America/New_York"
},
"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:30:00.000+0000",
"timeSpent": "1h 45m",
"timeSpentSeconds": 6300,
"id": "12346",
"issueId": "CTP-123"
}
]
}
List project issues
Get a list of all of the issues in a project. Sample Input
\{
"project_id": "PROJ",
"updated_after": "2023-05-01",
"per_page": 50,
"page": 1
\}
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": {
"issuetype": \{
"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
\},
"timespent": null,
"project": {
"self": "https://your-domain.atlassian.net/rest/api/3/project/10000",
"id": "10000",
"key": "PROJ",
"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"
\}
},
"fixVersions": [],
"aggregatetimespent": null,
"resolution": null,
"resolutiondate": null,
"workratio": -1,
"lastViewed": "2023-05-15T10:00:00.000+0000",
"watches": \{
"self": "https://your-domain.atlassian.net/rest/api/3/issue/PROJ-1/watchers",
"watchCount": 1,
"isWatching": true
\},
"created": "2023-05-10T09:00:00.000+0000",
"priority": \{
"self": "https://your-domain.atlassian.net/rest/api/3/priority/3",
"iconUrl": "https://your-domain.atlassian.net/images/icons/priorities/medium.svg",
"name": "Medium",
"id": "3"
\},
"labels": [
"documentation"
],
"timeestimate": null,
"aggregatetimeoriginalestimate": null,
"versions": [],
"issuelinks": [],
"assignee": {
"self": "https://your-domain.atlassian.net/rest/api/3/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-b1f1-4122-a2b4-3f1c59d90b01/48",
"24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/6a7e7a90-b1f1-4122-a2b4-3f1c59d90b01/24",
"16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/6a7e7a90-b1f1-4122-a2b4-3f1c59d90b01/16",
"32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/6a7e7a90-b1f1-4122-a2b4-3f1c59d90b01/32"
\},
"displayName": "John Doe",
"active": true,
"timeZone": "Australia/Sydney"
},
"updated": "2023-05-15T11:00:00.000+0000",
"status": {
"self": "https://your-domain.atlassian.net/rest/api/3/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/3/statuscategory/2",
"id": 2,
"key": "new",
"colorName": "blue-gray",
"name": "To Do"
\}
},
"components": [],
"timeoriginalestimate": null,
"description": "We need to update the API documentation for the new features.",
"aggregatetimeestimate": null,
"summary": "Update API documentation",
"creator": {
"self": "https://your-domain.atlassian.net/rest/api/3/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-b1f1-4122-a2b4-3f1c59d90b01/48",
"24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/6a7e7a90-b1f1-4122-a2b4-3f1c59d90b01/24",
"16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/6a7e7a90-b1f1-4122-a2b4-3f1c59d90b01/16",
"32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/6a7e7a90-b1f1-4122-a2b4-3f1c59d90b01/32"
\},
"displayName": "John Doe",
"active": true,
"timeZone": "Australia/Sydney"
},
"subtasks": [],
"reporter": {
"self": "https://your-domain.atlassian.net/rest/api/3/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-b1f1-4122-a2b4-3f1c59d90b01/48",
"24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/6a7e7a90-b1f1-4122-a2b4-3f1c59d90b01/24",
"16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/6a7e7a90-b1f1-4122-a2b4-3f1c59d90b01/16",
"32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/6a7e7a90-b1f1-4122-a2b4-3f1c59d90b01/32"
\},
"displayName": "John Doe",
"active": true,
"timeZone": "Australia/Sydney"
},
"aggregateprogress": \{
"progress": 0,
"total": 0
\},
"environment": null,
"duedate": "2023-05-31",
"progress": \{
"progress": 0,
"total": 0
\},
"votes": \{
"self": "https://your-domain.atlassian.net/rest/api/3/issue/PROJ-1/votes",
"votes": 0,
"hasVoted": false
\}
}
}
]
}
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.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
},
"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=xsmall&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
\{
"board_id": "123",
"sprint_id": "456",
"jql": "project = PROJ AND status = 'In Progress'",
"fields": [
"summary",
"status",
"assignee"
],
"expand": "changelog",
"start_at": 0,
"max_results": 50
\}
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"
\}
],
"body": {
"raw": {
"fields": {
"project": {
"key": "PROJ"
},
"summary": "New issue created via API",
"issuetype": {
"name": "Task"
},
"description": {
"type": "doc",
"version": 1,
"content": [
{
"type": "paragraph",
"content": [
\{
"text": "This is a sample issue created using the Jira Cloud API.",
"type": "text"
\}
]
}
]
}
}
}
},
"include_raw_body": false,
"parse_response": "true"
}
Sample Output
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/128c0ca8-3a3e-4f8c-9cbf-4d3b98e252c6/48",
"24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef5/128c0ca8-3a3e-4f8c-9cbf-4d3b98e252c6/24",
"16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef5/128c0ca8-3a3e-4f8c-9cbf-4d3b98e252c6/16",
"32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef5/128c0ca8-3a3e-4f8c-9cbf-4d3b98e252c6/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/128c0ca8-3a3e-4f8c-9cbf-4d3b98e252c7/48",
"24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef6/128c0ca8-3a3e-4f8c-9cbf-4d3b98e252c7/24",
"16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef6/128c0ca8-3a3e-4f8c-9cbf-4d3b98e252c7/16",
"32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef6/128c0ca8-3a3e-4f8c-9cbf-4d3b98e252c7/32"
\},
"key": "john.smith"
}
]
}
Update version
Update a project version by its ID. Sample Input
\{
"id": "10000",
"name": "Version 2.0",
"description": "Major release with new features",
"project": "PROJ",
"user_start_date": "2023-06-01T00:00:00.000Z",
"user_release_date": "2023-12-31T23:59:59.999Z",
"archived": false,
"released": false
\}
Sample Output
\{
"self": "https://your-domain.atlassian.net/rest/api/3/version/10000",
"id": "10000",
"description": "Major release with new features",
"name": "Version 2.0",
"archived": false,
"released": false,
"startDate": "2023-06-01T00:00:00.000Z",
"releaseDate": "2023-12-31T23:59:59.999Z",
"overdue": false,
"userStartDate": "2023-06-01",
"userReleaseDate": "2023-12-31",
"projectId": 10001
\}
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
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
{
"issueLinkTypes": [
\{
"id": "10000",
"name": "Blocks",
"inward": "is blocked by",
"outward": "blocks"
\},
\{
"id": "10001",
"name": "Cloners",
"inward": "is cloned by",
"outward": "clones"
\},
\{
"id": "10002",
"name": "Duplicate",
"inward": "is duplicated by",
"outward": "duplicates"
\},
\{
"id": "10003",
"name": "Relates",
"inward": "relates to",
"outward": "relates to"
\}
]
}
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)
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": "10000",
"name": "Epic",
"description": "A big user story that needs to be broken down.",
"iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=medium&avatarId=10307&avatarType=issuetype"
\},
\{
"id": "10001",
"name": "Story",
"description": "A user story.",
"iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=medium&avatarId=10315&avatarType=issuetype"
\},
\{
"id": "10002",
"name": "Task",
"description": "A task that needs to be done.",
"iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=medium&avatarId=10318&avatarType=issuetype"
\},
\{
"id": "10003",
"name": "Bug",
"description": "A problem which impairs or prevents the functions of the product.",
"iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=medium&avatarId=10303&avatarType=issuetype"
\}
]
List priorities (DDL)
Sample Input
{}
Sample Output
[
\{
"value": "1",
"text": "Highest"
\},
\{
"value": "2",
"text": "High"
\},
\{
"value": "3",
"text": "Medium"
\},
\{
"value": "4",
"text": "Low"
\},
\{
"value": "5",
"text": "Lowest"
\}
]
List project IDs (DDL)
Sample Input
{}
Sample Output
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
\{
"projectKeys": [
"PROJ",
"DEV",
"TEST",
"PROD",
"SUPPORT"
]
\}
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)
Sample Input
{}
Sample Output
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/resolved.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 no longer relevant.",
"name": "Obsolete",
"iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/abandoned.png"
\}
]
List resources (DDL)
Sample Input Sample Output
[
\{
"id": "issue",
"name": "Issue",
"description": "Represents a Jira issue"
\},
\{
"id": "project",
"name": "Project",
"description": "Represents a Jira project"
\},
\{
"id": "user",
"name": "User",
"description": "Represents a Jira user"
\},
\{
"id": "board",
"name": "Board",
"description": "Represents a Jira board"
\},
\{
"id": "sprint",
"name": "Sprint",
"description": "Represents a Jira sprint"
\}
]
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
[
{
"id": "1",
"name": "To Do",
"statusCategory": \{
"id": 2,
"key": "new",
"colorName": "blue-gray",
"name": "To Do"
\}
},
{
"id": "2",
"name": "In Progress",
"statusCategory": \{
"id": 4,
"key": "indeterminate",
"colorName": "yellow",
"name": "In Progress"
\}
},
{
"id": "3",
"name": "Done",
"statusCategory": \{
"id": 3,
"key": "done",
"colorName": "green",
"name": "Done"
\}
}
]