Go to appAcademyWhat's new?
Back
Artisan IMG > Jira (jira) (13c43d21-8820-4b8a-a0ec-5a1f75f85652)
Jira
OverviewOperations (sample payloads)Operations

Operations (sample payloads)

Main operations
Copy

Create issue comment
Copy

Creates a comment on an issue.

Sample Input

1
{
2
    "issue_id": "CTP-123",
3
    "body": "This is a new comment on the issue. We should consider adding more details to the reproduction steps.",
4
    "properties": [
5
        {
6
            "key": "comment-type",
7
            "value": {
8
                "type": "internal"
9
            }
10
        }
11
    ]
12
}

Sample Output

1
{
2
    "self": "https://your-domain.atlassian.net/rest/api/3/issue/CTP-123/comment/456789",
3
    "id": "456789",
4
    "author": {
5
        "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
6
        "name": "john.doe",
7
        "key": "john.doe",
8
        "accountId": "5b10a2844c20165700ede21g",
9
        "emailAddress": "john.doe@example.com",
10
        "avatarUrls": {
11
            "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9a-18e4f5bb2e94/48",
12
            "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9a-18e4f5bb2e94/24",
13
            "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9a-18e4f5bb2e94/16",
14
            "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9a-18e4f5bb2e94/32"
15
        },
16
        "displayName": "John Doe",
17
        "active": true,
18
        "timeZone": "America/New_York",
19
        "accountType": "atlassian"
20
    },
21
    "body": "This is a new comment on the issue. We should consider adding more details to the reproduction steps.",
22
    "updateAuthor": {
23
        "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
24
        "name": "john.doe",
25
        "key": "john.doe",
26
        "accountId": "5b10a2844c20165700ede21g",
27
        "emailAddress": "john.doe@example.com",
28
        "avatarUrls": {
29
            "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9a-18e4f5bb2e94/48",
30
            "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9a-18e4f5bb2e94/24",
31
            "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9a-18e4f5bb2e94/16",
32
            "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9a-18e4f5bb2e94/32"
33
        },
34
        "displayName": "John Doe",
35
        "active": true,
36
        "timeZone": "America/New_York",
37
        "accountType": "atlassian"
38
    },
39
    "created": "2023-05-15T14:30:00.000+0000",
40
    "updated": "2023-05-15T14:30:00.000+0000",
41
    "jsdPublic": false
42
}

Create a link beteween two Jira issues

Sample Input

1
{
2
    "link_type": "Relates",
3
    "inward_issue": "PROJ-123",
4
    "outward_issue": "PROJ-456"
5
}

Sample Output

1
{
2
    "success": true
3
}

Create version
Copy

Create a project version to be released

Sample Input

1
{
2
    "name": "Version 2.0",
3
    "description": "Major release with new features and bug fixes",
4
    "project": "PROJ",
5
    "user_start_date": "2023-06-01T00:00:00Z",
6
    "user_release_date": "2023-09-30T23:59:59Z",
7
    "archived": false,
8
    "released": false
9
}

Sample Output

1
{
2
    "self": "https://your-domain.atlassian.net/rest/api/3/version/10000",
3
    "id": "10000",
4
    "description": "Major release with new features and bug fixes",
5
    "name": "Version 2.0",
6
    "archived": false,
7
    "released": false,
8
    "startDate": "2023-06-01T00:00:00.000Z",
9
    "releaseDate": "2023-09-30T23:59:59.000Z",
10
    "overdue": false,
11
    "userStartDate": "2023-06-01",
12
    "userReleaseDate": "2023-09-30",
13
    "projectId": 10001
14
}

Delete issue
Copy

Delete an issue from your Jira account. Optionally also delete the attached subtasks.

Sample Input

1
{
2
    "issue_id": "CTP-123",
3
    "delete_subtasks": true
4
}

Sample Output

1
{
2
    "deleted": true
3
}

Download issue attachment
Copy

Download an attachment by providing its ID.

Sample Input

1
{
2
    "attachment_id": "10001"
3
}

Sample Output

1
{
2
    "name": "project_requirements.pdf",
3
    "url": "https://your-domain.atlassian.net/secure/attachment/10001/project_requirements.pdf",
4
    "mime_type": "application/pdf",
5
    "expires": 1623456789000
6
}

Get attachment metadata
Copy

Returns the metadata for an attachment. Note that the attachment itself is not returned.

Sample Input

1
{
2
    "attachment_id": "10001"
3
}

Sample Output

1
{
2
    "id": 10001,
3
    "self": "https://your-domain.atlassian.net/rest/api/3/attachment/10001",
4
    "filename": "example_document.pdf",
5
    "author": {
6
        "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
7
        "accountId": "5b10a2844c20165700ede21g",
8
        "avatarUrls": {
9
            "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=48&s=48",
10
            "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=24&s=24",
11
            "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=16&s=16",
12
            "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/MK-5.png?size=32&s=32"
13
        },
14
        "displayName": "Max Kohler",
15
        "active": true
16
    },
17
    "created": "2023-05-15T09:30:00.000Z",
18
    "size": 1048576,
19
    "mimeType": "application/pdf",
20
    "properties": {},
21
    "content": "https://your-domain.atlassian.net/rest/api/3/attachment/content/10001",
22
    "thumbnail": "https://your-domain.atlassian.net/rest/api/3/attachment/thumbnail/10001"
23
}

Get comment property
Copy

Returns the value of a comment property.

Sample Input

1
{
2
    "comment_id": "10001",
3
    "property_key": "custom_property"
4
}

Sample Output

1
{
2
    "keys": [
3
        {
4
            "self": "https://your-domain.atlassian.net/rest/api/3/comment/10001/properties/custom_property",
5
            "key": "custom_property"
6
        }
7
    ]
8
}

Get issue
Copy

Get details of an issue, using the issue's unique ID or Key.

Sample Input

1
{
2
    "issue_id": "CTP-123"
3
}

Sample Output

1
{
2
    "expand": "renderedFields,names,schema,operations,editmeta,changelog,versionedRepresentations",
3
    "id": "10001",
4
    "self": "https://your-domain.atlassian.net/rest/api/3/issue/10001",
5
    "key": "CTP-123",
6
    "fields": {
7
        "issuetype": {
8
            "self": "https://your-domain.atlassian.net/rest/api/3/issuetype/10001",
9
            "id": "10001",
10
            "description": "A task that needs to be done.",
11
            "iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=medium&avatarId=10318&avatarType=issuetype",
12
            "name": "Task",
13
            "subtask": false,
14
            "avatarId": 10318
15
        },
16
        "timespent": null,
17
        "project": {
18
            "self": "https://your-domain.atlassian.net/rest/api/3/project/10000",
19
            "id": "10000",
20
            "key": "CTP",
21
            "name": "Customer Tracking Project",
22
            "avatarUrls": {
23
                "48x48": "https://your-domain.atlassian.net/secure/projectavatar?pid=10000&avatarId=10011",
24
                "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000&avatarId=10011",
25
                "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000&avatarId=10011",
26
                "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000&avatarId=10011"
27
            }
28
        },
29
        "fixVersions": [],
30
        "aggregatetimespent": null,
31
        "resolution": null,
32
        "resolutiondate": null,
33
        "workratio": -1,
34
        "lastViewed": "2023-06-15T10:30:00.000+0000",
35
        "watches": {
36
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/CTP-123/watchers",
37
            "watchCount": 1,
38
            "isWatching": true
39
        },
40
        "created": "2023-06-14T09:00:00.000+0000",
41
        "priority": {
42
            "self": "https://your-domain.atlassian.net/rest/api/3/priority/3",
43
            "iconUrl": "https://your-domain.atlassian.net/images/icons/priorities/medium.svg",
44
            "name": "Medium",
45
            "id": "3"
46
        },
47
        "labels": [
48
            "customer-request"
49
        ],
50
        "timeestimate": null,
51
        "aggregatetimeoriginalestimate": null,
52
        "versions": [],
53
        "issuelinks": [],
54
        "assignee": {
55
            "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
56
            "name": "john.doe",
57
            "key": "john.doe",
58
            "emailAddress": "john.doe@example.com",
59
            "avatarUrls": {
60
                "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/47f71cf9-e9c1-4c61-8f5a-2e446d12c789/48",
61
                "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/47f71cf9-e9c1-4c61-8f5a-2e446d12c789/24",
62
                "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/47f71cf9-e9c1-4c61-8f5a-2e446d12c789/16",
63
                "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/47f71cf9-e9c1-4c61-8f5a-2e446d12c789/32"
64
            },
65
            "displayName": "John Doe",
66
            "active": true,
67
            "timeZone": "America/New_York"
68
        },
69
        "updated": "2023-06-15T11:00:00.000+0000",
70
        "status": {
71
            "self": "https://your-domain.atlassian.net/rest/api/3/status/10000",
72
            "description": "The issue is open and ready for the assignee to start work on it.",
73
            "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
74
            "name": "To Do",
75
            "id": "10000",
76
            "statusCategory": {
77
                "self": "https://your-domain.atlassian.net/rest/api/3/statuscategory/2",
78
                "id": 2,
79
                "key": "new",
80
                "colorName": "blue-gray",
81
                "name": "To Do"
82
            }
83
        },
84
        "components": [],
85
        "description": "Customer reported an issue with the login process. Need to investigate and resolve.",
86
        "timetracking": {},
87
        "attachment": [],
88
        "aggregatetimeestimate": null,
89
        "summary": "Investigate login issue reported by customer",
90
        "creator": {
91
            "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21f",
92
            "name": "jane.smith",
93
            "key": "jane.smith",
94
            "emailAddress": "jane.smith@example.com",
95
            "avatarUrls": {
96
                "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21f/47f71cf9-e9c1-4c61-8f5a-2e446d12c789/48",
97
                "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21f/47f71cf9-e9c1-4c61-8f5a-2e446d12c789/24",
98
                "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21f/47f71cf9-e9c1-4c61-8f5a-2e446d12c789/16",
99
                "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21f/47f71cf9-e9c1-4c61-8f5a-2e446d12c789/32"
100
            },
101
            "displayName": "Jane Smith",
102
            "active": true,
103
            "timeZone": "Europe/London"
104
        },
105
        "subtasks": [],
106
        "reporter": {
107
            "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21f",
108
            "name": "jane.smith",
109
            "key": "jane.smith",
110
            "emailAddress": "jane.smith@example.com",
111
            "avatarUrls": {
112
                "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21f/47f71cf9-e9c1-4c61-8f5a-2e446d12c789/48",
113
                "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21f/47f71cf9-e9c1-4c61-8f5a-2e446d12c789/24",
114
                "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21f/47f71cf9-e9c1-4c61-8f5a-2e446d12c789/16",
115
                "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21f/47f71cf9-e9c1-4c61-8f5a-2e446d12c789/32"
116
            },
117
            "displayName": "Jane Smith",
118
            "active": true,
119
            "timeZone": "Europe/London"
120
        },
121
        "aggregateprogress": {
122
            "progress": 0,
123
            "total": 0
124
        },
125
        "environment": null,
126
        "duedate": null,
127
        "progress": {
128
            "progress": 0,
129
            "total": 0
130
        },
131
        "comment": {
132
            "comments": [],
133
            "maxResults": 0,
134
            "total": 0,
135
            "startAt": 0
136
        },
137
        "votes": {
138
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/CTP-123/votes",
139
            "votes": 0,
140
            "hasVoted": false
141
        },
142
        "worklog": {
143
            "startAt": 0,
144
            "maxResults": 20,
145
            "total": 0,
146
            "worklogs": []
147
        }
148
    }
149
}

Get user
Copy

Get a user from Jira, either by their username or their user "key".

Sample Input

1
{
2
    "name": "johndoe"
3
}

Sample Output

1
{
2
    "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
3
    "key": "johndoe",
4
    "name": "johndoe",
5
    "emailAddress": "johndoe@example.com",
6
    "avatarUrls": {
7
        "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/initials/JD-5.png?size=16&s=16",
8
        "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/initials/JD-5.png?size=24&s=24",
9
        "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/initials/JD-5.png?size=32&s=32",
10
        "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/initials/JD-5.png?size=48&s=48"
11
    },
12
    "displayName": "John Doe",
13
    "active": true,
14
    "timeZone": "America/New_York",
15
    "locale": "en_US",
16
    "groups": {
17
        "size": 3,
18
        "items": []
19
    },
20
    "applicationRoles": {
21
        "size": 1,
22
        "items": []
23
    },
24
    "expand": "groups,applicationRoles"
25
}

Get user info
Copy

Get information about the current authenticated user.

Sample Input

1
{}

Sample Output

1
{
2
    "instance_url": "https://your-domain.atlassian.net"
3
}

Get version
Copy

Get a project version by its id

Sample Input

1
{
2
    "id": "10000"
3
}

Sample Output

1
{
2
    "self": "https://your-domain.atlassian.net/rest/api/3/version/10000",
3
    "id": "10000",
4
    "description": "Version 1.0 of our project",
5
    "name": "Version 1.0",
6
    "archived": false,
7
    "released": true,
8
    "startDate": "2023-01-15",
9
    "releaseDate": "2023-06-30",
10
    "overdue": false,
11
    "userStartDate": "15/Jan/23",
12
    "userReleaseDate": "30/Jun/23",
13
    "projectId": 1001
14
}

List board sprints
Copy

Lists all the sprints for a specific board

Sample Input

1
{
2
    "board_id": "123",
3
    "state": "active,closed",
4
    "start_at": 0,
5
    "max_results": 10
6
}

Sample Output

1
{
2
    "maxResults": 10,
3
    "startAt": 0,
4
    "isLast": false,
5
    "values": [
6
        {
7
            "id": 456,
8
            "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/456",
9
            "state": "active",
10
            "name": "Sprint 1",
11
            "startDate": "2023-05-01T00:00:00.000Z",
12
            "endDate": "2023-05-14T23:59:59.999Z",
13
            "completeDate": null,
14
            "originBoardId": 123,
15
            "goal": "Complete user authentication feature"
16
        },
17
        {
18
            "id": 457,
19
            "self": "https://your-domain.atlassian.net/rest/agile/1.0/sprint/457",
20
            "state": "closed",
21
            "name": "Sprint 2",
22
            "startDate": "2023-04-17T00:00:00.000Z",
23
            "endDate": "2023-04-30T23:59:59.999Z",
24
            "completeDate": "2023-04-30T18:00:00.000Z",
25
            "originBoardId": 123,
26
            "goal": "Implement dashboard analytics"
27
        }
28
    ]
29
}

List boards
Copy

Lists all boards

Sample Input

1
{
2
    "start_at": 0,
3
    "max_results": 50
4
}

Sample Output

1
{
2
    "maxResults": 50,
3
    "startAt": 0,
4
    "total": 3,
5
    "isLast": true,
6
    "values": [
7
        {
8
            "id": 1,
9
            "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/1",
10
            "name": "Development Board",
11
            "type": "scrum",
12
            "location": {
13
                "projectId": 10000,
14
                "displayName": "Project Alpha",
15
                "projectName": "Project Alpha",
16
                "projectKey": "ALPHA",
17
                "projectTypeKey": "software",
18
                "avatarURI": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000&avatarId=10200",
19
                "name": "Project Alpha"
20
            }
21
        },
22
        {
23
            "id": 2,
24
            "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/2",
25
            "name": "Marketing Board",
26
            "type": "kanban",
27
            "location": {
28
                "projectId": 10001,
29
                "displayName": "Project Beta",
30
                "projectName": "Project Beta",
31
                "projectKey": "BETA",
32
                "projectTypeKey": "business",
33
                "avatarURI": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10001&avatarId=10201",
34
                "name": "Project Beta"
35
            }
36
        },
37
        {
38
            "id": 3,
39
            "self": "https://your-domain.atlassian.net/rest/agile/1.0/board/3",
40
            "name": "Support Board",
41
            "type": "kanban",
42
            "location": {
43
                "projectId": 10002,
44
                "displayName": "Project Gamma",
45
                "projectName": "Project Gamma",
46
                "projectKey": "GAMMA",
47
                "projectTypeKey": "service_desk",
48
                "avatarURI": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10002&avatarId=10202",
49
                "name": "Project Gamma"
50
            }
51
        }
52
    ]
53
}

List issue comments
Copy

Lists all of the comments for an issue.

Sample Input

1
{
2
    "issue_id": "CTP-123",
3
    "start_at": 0,
4
    "max_results": 10,
5
    "expand": "renderedBody,properties"
6
}

Sample Output

1
{
2
    "startAt": 0,
3
    "maxResults": 10,
4
    "total": 2,
5
    "comments": [
6
        {
7
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/CTP-123/comment/10001",
8
            "id": "10001",
9
            "author": {
10
                "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
11
                "name": "john.doe",
12
                "key": "john.doe",
13
                "accountId": "5b10a2844c20165700ede21g",
14
                "emailAddress": "john.doe@example.com",
15
                "avatarUrls": {
16
                    "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9d-4d02f7d3c1a6/48",
17
                    "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9d-4d02f7d3c1a6/24",
18
                    "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9d-4d02f7d3c1a6/16",
19
                    "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9d-4d02f7d3c1a6/32"
20
                },
21
                "displayName": "John Doe",
22
                "active": true,
23
                "timeZone": "America/New_York",
24
                "accountType": "atlassian"
25
            },
26
            "body": "This is the first comment on the issue.",
27
            "updateAuthor": {
28
                "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
29
                "name": "john.doe",
30
                "key": "john.doe",
31
                "accountId": "5b10a2844c20165700ede21g",
32
                "emailAddress": "john.doe@example.com",
33
                "avatarUrls": {
34
                    "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9d-4d02f7d3c1a6/48",
35
                    "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9d-4d02f7d3c1a6/24",
36
                    "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9d-4d02f7d3c1a6/16",
37
                    "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128c0ca8-3a3e-4f8c-8f9d-4d02f7d3c1a6/32"
38
                },
39
                "displayName": "John Doe",
40
                "active": true,
41
                "timeZone": "America/New_York",
42
                "accountType": "atlassian"
43
            },
44
            "created": "2023-05-18T09:30:00.000+0000",
45
            "updated": "2023-05-18T09:30:00.000+0000",
46
            "jsdPublic": true,
47
            "properties": [
48
                {
49
                    "key": "com.atlassian.jira.issue.fields.comment.level",
50
                    "value": {
51
                        "value1": "1"
52
                    }
53
                }
54
            ]
55
        },
56
        {
57
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/CTP-123/comment/10002",
58
            "id": "10002",
59
            "author": {
60
                "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21h",
61
                "name": "jane.smith",
62
                "key": "jane.smith",
63
                "accountId": "5b10a2844c20165700ede21h",
64
                "emailAddress": "jane.smith@example.com",
65
                "avatarUrls": {
66
                    "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128c0ca8-3a3e-4f8c-8f9d-4d02f7d3c1a7/48",
67
                    "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128c0ca8-3a3e-4f8c-8f9d-4d02f7d3c1a7/24",
68
                    "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128c0ca8-3a3e-4f8c-8f9d-4d02f7d3c1a7/16",
69
                    "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128c0ca8-3a3e-4f8c-8f9d-4d02f7d3c1a7/32"
70
                },
71
                "displayName": "Jane Smith",
72
                "active": true,
73
                "timeZone": "Europe/London",
74
                "accountType": "atlassian"
75
            },
76
            "body": "This is the second comment on the issue.",
77
            "updateAuthor": {
78
                "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21h",
79
                "name": "jane.smith",
80
                "key": "jane.smith",
81
                "accountId": "5b10a2844c20165700ede21h",
82
                "emailAddress": "jane.smith@example.com",
83
                "avatarUrls": {
84
                    "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128c0ca8-3a3e-4f8c-8f9d-4d02f7d3c1a7/48",
85
                    "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128c0ca8-3a3e-4f8c-8f9d-4d02f7d3c1a7/24",
86
                    "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128c0ca8-3a3e-4f8c-8f9d-4d02f7d3c1a7/16",
87
                    "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128c0ca8-3a3e-4f8c-8f9d-4d02f7d3c1a7/32"
88
                },
89
                "displayName": "Jane Smith",
90
                "active": true,
91
                "timeZone": "Europe/London",
92
                "accountType": "atlassian"
93
            },
94
            "created": "2023-05-18T10:15:00.000+0000",
95
            "updated": "2023-05-18T10:15:00.000+0000",
96
            "jsdPublic": true,
97
            "properties": []
98
        }
99
    ]
100
}

List issue worklogs
Copy

Returns all worklogs for an issue. Time tracking must be enabled in Jira, otherwise this operation returns an error.

Sample Input

1
{
2
    "issue_id": "CTP-123"
3
}

Sample Output

1
{
2
    "startAt": 0,
3
    "maxResults": 50,
4
    "total": 2,
5
    "worklogs": [
6
        {
7
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/CTP-123/worklog/12345",
8
            "author": {
9
                "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
10
                "name": "john.doe",
11
                "key": "john.doe",
12
                "accountId": "5b10a2844c20165700ede21g",
13
                "emailAddress": "john.doe@example.com",
14
                "avatarUrls": {
15
                    "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128?size=48&s=48",
16
                    "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128?size=24&s=24",
17
                    "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128?size=16&s=16",
18
                    "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128?size=32&s=32"
19
                },
20
                "displayName": "John Doe",
21
                "active": true,
22
                "timeZone": "America/New_York"
23
            },
24
            "updateAuthor": {
25
                "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
26
                "name": "john.doe",
27
                "key": "john.doe",
28
                "accountId": "5b10a2844c20165700ede21g",
29
                "emailAddress": "john.doe@example.com",
30
                "avatarUrls": {
31
                    "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128?size=48&s=48",
32
                    "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128?size=24&s=24",
33
                    "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128?size=16&s=16",
34
                    "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/128?size=32&s=32"
35
                },
36
                "displayName": "John Doe",
37
                "active": true,
38
                "timeZone": "America/New_York"
39
            },
40
            "comment": "Worked on implementing new feature",
41
            "created": "2023-05-15T09:00:00.000+0000",
42
            "updated": "2023-05-15T09:00:00.000+0000",
43
            "started": "2023-05-15T08:00:00.000+0000",
44
            "timeSpent": "1h",
45
            "timeSpentSeconds": 3600,
46
            "id": "12345",
47
            "issueId": "10002"
48
        },
49
        {
50
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/CTP-123/worklog/12346",
51
            "author": {
52
                "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21h",
53
                "name": "jane.smith",
54
                "key": "jane.smith",
55
                "accountId": "5b10a2844c20165700ede21h",
56
                "emailAddress": "jane.smith@example.com",
57
                "avatarUrls": {
58
                    "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128?size=48&s=48",
59
                    "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128?size=24&s=24",
60
                    "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128?size=16&s=16",
61
                    "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128?size=32&s=32"
62
                },
63
                "displayName": "Jane Smith",
64
                "active": true,
65
                "timeZone": "Europe/London"
66
            },
67
            "updateAuthor": {
68
                "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21h",
69
                "name": "jane.smith",
70
                "key": "jane.smith",
71
                "accountId": "5b10a2844c20165700ede21h",
72
                "emailAddress": "jane.smith@example.com",
73
                "avatarUrls": {
74
                    "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128?size=48&s=48",
75
                    "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128?size=24&s=24",
76
                    "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128?size=16&s=16",
77
                    "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/128?size=32&s=32"
78
                },
79
                "displayName": "Jane Smith",
80
                "active": true,
81
                "timeZone": "Europe/London"
82
            },
83
            "comment": "Reviewed and tested the new feature",
84
            "created": "2023-05-15T14:30:00.000+0000",
85
            "updated": "2023-05-15T14:30:00.000+0000",
86
            "started": "2023-05-15T14:00:00.000+0000",
87
            "timeSpent": "30m",
88
            "timeSpentSeconds": 1800,
89
            "id": "12346",
90
            "issueId": "10002"
91
        }
92
    ]
93
}

List projects
Copy

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

1
{}

Sample Output

1
{
2
    "items": [
3
        {
4
            "expand": "description,lead,issueTypes,url,projectKeys",
5
            "self": "https://your-domain.atlassian.net/rest/api/3/project/10000",
6
            "id": "10000",
7
            "key": "PRJ",
8
            "description": "This is a sample project description",
9
            "lead": {
10
                "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
11
                "key": "john.doe",
12
                "name": "John Doe",
13
                "avatarUrls": {
14
                    "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JD-5.png?size=16&s=16",
15
                    "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JD-5.png?size=24&s=24",
16
                    "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JD-5.png?size=32&s=32",
17
                    "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JD-5.png?size=48&s=48"
18
                },
19
                "displayName": "John Doe",
20
                "active": true
21
            },
22
            "issueTypes": [
23
                {
24
                    "self": "https://your-domain.atlassian.net/rest/api/3/issuetype/10001",
25
                    "id": "10001",
26
                    "description": "A task that needs to be done.",
27
                    "iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=medium&avatarId=10318&avatarType=issuetype",
28
                    "name": "Task",
29
                    "subtask": false,
30
                    "avatarId": 10318
31
                }
32
            ],
33
            "name": "Sample Project",
34
            "avatarUrls": {
35
                "48x48": "https://your-domain.atlassian.net/secure/projectavatar?pid=10000&avatarId=10011",
36
                "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000&avatarId=10011",
37
                "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000&avatarId=10011",
38
                "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000&avatarId=10011"
39
            },
40
            "projectKeys": [
41
                "PRJ"
42
            ],
43
            "projectTypeKey": "software"
44
        }
45
    ]
46
}

List sprint issues
Copy

Lists all the issues in a specific sprint

Sample Input

1
{
2
    "board_id": "123",
3
    "sprint_id": "456",
4
    "jql": "project = PROJ AND status = 'In Progress'",
5
    "fields": [
6
        "summary",
7
        "status",
8
        "assignee"
9
    ],
10
    "expand": "changelog",
11
    "start_at": 0,
12
    "max_results": 50
13
}

Sample Output

1
{
2
    "expand": "schema,names",
3
    "startAt": 0,
4
    "maxResults": 50,
5
    "total": 2,
6
    "issues": [
7
        {
8
            "expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
9
            "id": "10001",
10
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/10001",
11
            "key": "PROJ-1",
12
            "fields": {
13
                "summary": "Implement new feature",
14
                "status": {
15
                    "self": "https://your-domain.atlassian.net/rest/api/3/status/3",
16
                    "description": "This issue is being actively worked on at the moment by the assignee.",
17
                    "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/inprogress.png",
18
                    "name": "In Progress",
19
                    "id": "3",
20
                    "statusCategory": {
21
                        "self": "https://your-domain.atlassian.net/rest/api/3/statuscategory/2",
22
                        "id": 2,
23
                        "key": "inprogress",
24
                        "colorName": "yellow",
25
                        "name": "In Progress"
26
                    }
27
                },
28
                "assignee": {
29
                    "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
30
                    "name": "john.doe",
31
                    "key": "john.doe",
32
                    "accountId": "5b10a2844c20165700ede21g",
33
                    "emailAddress": "john.doe@example.com",
34
                    "avatarUrls": {
35
                        "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JD-5.png?size=48&s=48",
36
                        "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JD-5.png?size=24&s=24",
37
                        "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JD-5.png?size=16&s=16",
38
                        "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JD-5.png?size=32&s=32"
39
                    },
40
                    "displayName": "John Doe",
41
                    "active": true,
42
                    "timeZone": "Australia/Sydney"
43
                }
44
            }
45
        },
46
        {
47
            "expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
48
            "id": "10002",
49
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/10002",
50
            "key": "PROJ-2",
51
            "fields": {
52
                "summary": "Fix critical bug",
53
                "status": {
54
                    "self": "https://your-domain.atlassian.net/rest/api/3/status/3",
55
                    "description": "This issue is being actively worked on at the moment by the assignee.",
56
                    "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/inprogress.png",
57
                    "name": "In Progress",
58
                    "id": "3",
59
                    "statusCategory": {
60
                        "self": "https://your-domain.atlassian.net/rest/api/3/statuscategory/2",
61
                        "id": 2,
62
                        "key": "inprogress",
63
                        "colorName": "yellow",
64
                        "name": "In Progress"
65
                    }
66
                },
67
                "assignee": {
68
                    "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21h",
69
                    "name": "jane.smith",
70
                    "key": "jane.smith",
71
                    "accountId": "5b10a2844c20165700ede21h",
72
                    "emailAddress": "jane.smith@example.com",
73
                    "avatarUrls": {
74
                        "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JS-5.png?size=48&s=48",
75
                        "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JS-5.png?size=24&s=24",
76
                        "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JS-5.png?size=16&s=16",
77
                        "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JS-5.png?size=32&s=32"
78
                    },
79
                    "displayName": "Jane Smith",
80
                    "active": true,
81
                    "timeZone": "America/New_York"
82
                }
83
            }
84
        }
85
    ]
86
}

Raw HTTP request (advanced)
Copy

Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication.

Sample Input

1
{
2
    "method": "POST",
3
    "url": {
4
        "endpoint": "/rest/api/3/issue"
5
    },
6
    "headers": [
7
        {
8
            "key": "Content-Type",
9
            "value": "application/json"
10
        }
11
    ],
12
    "query_parameters": [
13
        {
14
            "key": "fields",
15
            "value": "summary,description"
16
        }
17
    ],
18
    "body": {
19
        "raw": {
20
            "fields": {
21
                "project": {
22
                    "key": "PROJ"
23
                },
24
                "summary": "New issue created via API",
25
                "description": {
26
                    "type": "doc",
27
                    "version": 1,
28
                    "content": [
29
                        {
30
                            "type": "paragraph",
31
                            "content": [
32
                                {
33
                                    "text": "This is a sample issue description.",
34
                                    "type": "text"
35
                                }
36
                            ]
37
                        }
38
                    ]
39
                },
40
                "issuetype": {
41
                    "name": "Task"
42
                }
43
            }
44
        }
45
    },
46
    "include_raw_body": true,
47
    "parse_response": "true"
48
}

Sample Output

1
{
2
    "response": {
3
        "status_code": 201,
4
        "headers": {
5
            "Content-Type": "application/json;charset=UTF-8",
6
            "X-AUSERNAME": "admin",
7
            "X-Seraph-LoginReason": "OK",
8
            "X-ASESSIONID": "1234x5678x90123",
9
            "Cache-Control": "no-cache, no-store, no-transform"
10
        },
11
        "body": {
12
            "id": "10001",
13
            "key": "PROJ-1",
14
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/10001"
15
        }
16
    }
17
}

Search issues (JQL)
Copy

Search for issues using JQL

Sample Input

1
{
2
    "jql": "project = 'PROJ' AND status = 'Open' ORDER BY priority DESC",
3
    "expand": "description,lead,projectKeys,url,issueTypes",
4
    "per_page": 50,
5
    "start_at": 0
6
}

Sample Output

1
{
2
    "expand": "schema,names",
3
    "startAt": 0,
4
    "maxResults": 50,
5
    "total": 2,
6
    "issues": [
7
        {
8
            "expand": "operations,versionedRepresentations,editmeta,changelog,renderedFields",
9
            "id": "10001",
10
            "self": "https://your-domain.atlassian.net/rest/api/3/issue/10001",
11
            "key": "PROJ-1",
12
            "fields": {
13
                "issuetype": {
14
                    "self": "https://your-domain.atlassian.net/rest/api/3/issuetype/10000",
15
                    "id": "10000",
16
                    "description": "A problem which impairs or prevents the functions of the product.",
17
                    "iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=medium&avatarId=10303&avatarType=issuetype",
18
                    "name": "Bug",
19
                    "subtask": false,
20
                    "avatarId": 10303
21
                },
22
                "project": {
23
                    "self": "https://your-domain.atlassian.net/rest/api/3/project/10000",
24
                    "id": "10000",
25
                    "key": "PROJ",
26
                    "name": "Project",
27
                    "avatarUrls": {
28
                        "48x48": "https://your-domain.atlassian.net/secure/projectavatar?pid=10000&avatarId=10011",
29
                        "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000&avatarId=10011",
30
                        "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000&avatarId=10011",
31
                        "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000&avatarId=10011"
32
                    }
33
                },
34
                "priority": {
35
                    "self": "https://your-domain.atlassian.net/rest/api/3/priority/1",
36
                    "iconUrl": "https://your-domain.atlassian.net/images/icons/priorities/highest.svg",
37
                    "name": "Highest",
38
                    "id": "1"
39
                },
40
                "labels": [
41
                    "critical",
42
                    "frontend"
43
                ],
44
                "assignee": {
45
                    "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
46
                    "name": "john.doe",
47
                    "key": "john.doe",
48
                    "emailAddress": "john.doe@example.com",
49
                    "avatarUrls": {
50
                        "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/290dc749-2dfc-4e9c-9523-63c5d5b1d4cc/48",
51
                        "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/290dc749-2dfc-4e9c-9523-63c5d5b1d4cc/24",
52
                        "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/290dc749-2dfc-4e9c-9523-63c5d5b1d4cc/16",
53
                        "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/290dc749-2dfc-4e9c-9523-63c5d5b1d4cc/32"
54
                    },
55
                    "displayName": "John Doe",
56
                    "active": true,
57
                    "timeZone": "Australia/Sydney"
58
                },
59
                "status": {
60
                    "self": "https://your-domain.atlassian.net/rest/api/3/status/1",
61
                    "description": "The issue is open and ready for the assignee to start work on it.",
62
                    "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
63
                    "name": "Open",
64
                    "id": "1",
65
                    "statusCategory": {
66
                        "self": "https://your-domain.atlassian.net/rest/api/3/statuscategory/2",
67
                        "id": 2,
68
                        "key": "new",
69
                        "colorName": "blue-gray",
70
                        "name": "To Do"
71
                    }
72
                },
73
                "summary": "Main page is not loading properly",
74
                "creator": {
75
                    "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
76
                    "name": "jane.smith",
77
                    "key": "jane.smith",
78
                    "emailAddress": "jane.smith@example.com",
79
                    "avatarUrls": {
80
                        "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/290dc749-2dfc-4e9c-9523-63c5d5b1d4cc/48",
81
                        "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/290dc749-2dfc-4e9c-9523-63c5d5b1d4cc/24",
82
                        "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/290dc749-2dfc-4e9c-9523-63c5d5b1d4cc/16",
83
                        "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/290dc749-2dfc-4e9c-9523-63c5d5b1d4cc/32"
84
                    },
85
                    "displayName": "Jane Smith",
86
                    "active": true,
87
                    "timeZone": "Australia/Sydney"
88
                },
89
                "reporter": {
90
                    "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
91
                    "name": "jane.smith",
92
                    "key": "jane.smith",
93
                    "emailAddress": "jane.smith@example.com",
94
                    "avatarUrls": {
95
                        "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/290dc749-2dfc-4e9c-9523-63c5d5b1d4cc/48",
96
                        "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/290dc749-2dfc-4e9c-9523-63c5d5b1d4cc/24",
97
                        "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/290dc749-2dfc-4e9c-9523-63c5d5b1d4cc/16",
98
                        "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/290dc749-2dfc-4e9c-9523-63c5d5b1d4cc/32"
99
                    },
100
                    "displayName": "Jane Smith",
101
                    "active": true,
102
                    "timeZone": "Australia/Sydney"
103
                },
104
                "created": "2023-05-01T09:00:00.000+0000",
105
                "updated": "2023-05-01T10:00:00.000+0000"
106
            }
107
        }
108
    ]
109
}

Search Users
Copy

Returns a list of users that match the search string.

Sample Input

1
{
2
    "query": "john",
3
    "start_at": 0,
4
    "max_results": 2
5
}

Sample Output

1
{
2
    "results": [
3
        {
4
            "active": true,
5
            "accountType": "atlassian",
6
            "accountId": "5b10ac8d82e05b22cc7d4ef5",
7
            "name": "john.doe",
8
            "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10ac8d82e05b22cc7d4ef5",
9
            "displayName": "John Doe",
10
            "emailAddress": "john.doe@example.com",
11
            "timeZone": "America/New_York",
12
            "locale": "en_US",
13
            "avatarUrls": {
14
                "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef5/48",
15
                "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef5/24",
16
                "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef5/16",
17
                "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef5/32"
18
            },
19
            "key": "john.doe"
20
        },
21
        {
22
            "active": true,
23
            "accountType": "atlassian",
24
            "accountId": "5b10ac8d82e05b22cc7d4ef6",
25
            "name": "john.smith",
26
            "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10ac8d82e05b22cc7d4ef6",
27
            "displayName": "John Smith",
28
            "emailAddress": "john.smith@example.com",
29
            "timeZone": "Europe/London",
30
            "locale": "en_GB",
31
            "avatarUrls": {
32
                "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef6/48",
33
                "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef6/24",
34
                "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef6/16",
35
                "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10ac8d82e05b22cc7d4ef6/32"
36
            },
37
            "key": "john.smith"
38
        }
39
    ]
40
}

Search Users (JIRA Server)
Copy

Returns a list of users that match the search string for a JIRA Server instance.

Sample Input

1
{
2
    "query": "john",
3
    "start_at": 0,
4
    "max_results": 10
5
}

Sample Output

1
{
2
    "results": [
3
        {
4
            "active": true,
5
            "accountType": "atlassian",
6
            "accountId": "5b10a2844c20165700ede21g",
7
            "name": "john.doe",
8
            "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21g",
9
            "displayName": "John Doe",
10
            "emailAddress": "john.doe@example.com",
11
            "timeZone": "America/New_York",
12
            "locale": "en_US",
13
            "avatarUrls": {
14
                "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JD-5.png?size=48&s=48",
15
                "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JD-5.png?size=24&s=24",
16
                "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JD-5.png?size=16&s=16",
17
                "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JD-5.png?size=32&s=32"
18
            },
19
            "key": "john.doe"
20
        },
21
        {
22
            "active": true,
23
            "accountType": "atlassian",
24
            "accountId": "5b10a2844c20165700ede21h",
25
            "name": "john.smith",
26
            "self": "https://your-domain.atlassian.net/rest/api/3/user?accountId=5b10a2844c20165700ede21h",
27
            "displayName": "John Smith",
28
            "emailAddress": "john.smith@example.com",
29
            "timeZone": "Europe/London",
30
            "locale": "en_GB",
31
            "avatarUrls": {
32
                "48x48": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JS-5.png?size=48&s=48",
33
                "24x24": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JS-5.png?size=24&s=24",
34
                "16x16": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JS-5.png?size=16&s=16",
35
                "32x32": "https://avatar-management--avatars.server-location.prod.public.atl-paas.net/initials/JS-5.png?size=32&s=32"
36
            },
37
            "key": "john.smith"
38
        }
39
    ]
40
}

Update issue
Copy

Update an issue in Jira.

Sample Input

1
{
2
    "issue_id": "CTP-123",
3
    "project_key": "CTP",
4
    "summary": "Update API integration",
5
    "issue_type_id": "10001",
6
    "labels": [
7
        "api",
8
        "integration"
9
    ],
10
    "description": "We need to update our API integration to support the latest version.",
11
    "due_date": "2023-06-30",
12
    "assignee_key": "john.doe",
13
    "reporter_key": "jane.smith",
14
    "priority_id": "2",
15
    "resolution_id": "10000",
16
    "versions": [
17
        "1.0",
18
        "1.1"
19
    ],
20
    "fix_versions": [
21
        "1.2"
22
    ],
23
    "other_fields": [
24
        {
25
            "name": "customfield_10000",
26
            "value": "High"
27
        }
28
    ],
29
    "update": [
30
        {
31
            "field": "components",
32
            "verb": "add",
33
            "value": [
34
                {
35
                    "name": "Backend"
36
                }
37
            ]
38
        }
39
    ]
40
}

Sample Output

1
{
2
    "id": "10001",
3
    "header": {},
4
    "body": {
5
        "expand": "renderedFields,names,schema,operations,editmeta,changelog,versionedRepresentations",
6
        "id": "10001",
7
        "self": "https://your-domain.atlassian.net/rest/api/2/issue/10001",
8
        "key": "CTP-123",
9
        "fields": {
10
            "issuetype": {
11
                "self": "https://your-domain.atlassian.net/rest/api/2/issuetype/10001",
12
                "id": "10001",
13
                "description": "A task that needs to be done.",
14
                "iconUrl": "https://your-domain.atlassian.net/secure/viewavatar?size=xsmall&avatarId=10318&avatarType=issuetype",
15
                "name": "Task",
16
                "subtask": false,
17
                "avatarId": 10318
18
            },
19
            "project": {
20
                "self": "https://your-domain.atlassian.net/rest/api/2/project/10000",
21
                "id": "10000",
22
                "key": "CTP",
23
                "name": "Customer Training Project",
24
                "avatarUrls": {
25
                    "48x48": "https://your-domain.atlassian.net/secure/projectavatar?pid=10000&avatarId=10324",
26
                    "24x24": "https://your-domain.atlassian.net/secure/projectavatar?size=small&pid=10000&avatarId=10324",
27
                    "16x16": "https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&pid=10000&avatarId=10324",
28
                    "32x32": "https://your-domain.atlassian.net/secure/projectavatar?size=medium&pid=10000&avatarId=10324"
29
                }
30
            },
31
            "summary": "Update API integration",
32
            "description": "We need to update our API integration to support the latest version.",
33
            "priority": {
34
                "self": "https://your-domain.atlassian.net/rest/api/2/priority/2",
35
                "iconUrl": "https://your-domain.atlassian.net/images/icons/priorities/high.svg",
36
                "name": "High",
37
                "id": "2"
38
            },
39
            "status": {
40
                "self": "https://your-domain.atlassian.net/rest/api/2/status/10000",
41
                "description": "The issue is open and ready for the assignee to start work on it.",
42
                "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
43
                "name": "To Do",
44
                "id": "10000",
45
                "statusCategory": {
46
                    "self": "https://your-domain.atlassian.net/rest/api/2/statuscategory/2",
47
                    "id": 2,
48
                    "key": "new",
49
                    "colorName": "blue-gray",
50
                    "name": "To Do"
51
                }
52
            },
53
            "assignee": {
54
                "self": "https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21g",
55
                "name": "john.doe",
56
                "key": "john.doe",
57
                "emailAddress": "john.doe@example.com",
58
                "avatarUrls": {
59
                    "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/6a7e7a90-b393-4c6f-8eb3-b9c3e3414433/48",
60
                    "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/6a7e7a90-b393-4c6f-8eb3-b9c3e3414433/24",
61
                    "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/6a7e7a90-b393-4c6f-8eb3-b9c3e3414433/16",
62
                    "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21g/6a7e7a90-b393-4c6f-8eb3-b9c3e3414433/32"
63
                },
64
                "displayName": "John Doe",
65
                "active": true,
66
                "timeZone": "Australia/Sydney"
67
            },
68
            "reporter": {
69
                "self": "https://your-domain.atlassian.net/rest/api/2/user?accountId=5b10a2844c20165700ede21h",
70
                "name": "jane.smith",
71
                "key": "jane.smith",
72
                "emailAddress": "jane.smith@example.com",
73
                "avatarUrls": {
74
                    "48x48": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/6a7e7a90-b393-4c6f-8eb3-b9c3e3414434/48",
75
                    "24x24": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/6a7e7a90-b393-4c6f-8eb3-b9c3e3414434/24",
76
                    "16x16": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/6a7e7a90-b393-4c6f-8eb3-b9c3e3414434/16",
77
                    "32x32": "https://avatar-management--avatars.us-west-2.prod.public.atl-paas.net/5b10a2844c20165700ede21h/6a7e7a90-b393-4c6f-8eb3-b9c3e3414434/32"
78
                },
79
                "displayName": "Jane Smith",
80
                "active": true,
81
                "timeZone": "Australia/Sydney"
82
            },
83
            "labels": [
84
                "api",
85
                "integration"
86
            ],
87
            "versions": [
88
                {
89
                    "self": "https://your-domain.atlassian.net/rest/api/2/version/10000",
90
                    "id": "10000",
91
                    "name": "1.0",
92
                    "archived": false,
93
                    "released": true,
94
                    "releaseDate": "2023-03-01"
95
                },
96
                {
97
                    "self": "https://your-domain.atlassian.net/rest/api/2/version/10001",
98
                    "id": "10001",
99
                    "name": "1.1",
100
                    "archived": false,
101
                    "released": true,
102
                    "releaseDate": "2023-05-01"
103
                }
104
            ],
105
            "fixVersions": [
106
                {
107
                    "self": "https://your-domain.atlassian.net/rest/api/2/version/10002",
108
                    "id": "10002",
109
                    "name": "1.2",
110
                    "archived": false,
111
                    "released": false,
112
                    "releaseDate": "2023-07-01"
113
                }
114
            ],
115
            "components": [
116
                {
117
                    "self": "https://your-domain.atlassian.net/rest/api/2/component/10000",
118
                    "id": "10000",
119
                    "name": "Backend"
120
                }
121
            ],
122
            "duedate": "2023-06-30",
123
            "customfield_10000": "High"
124
        }
125
    }
126
}

Update version
Copy

Update a project version by its id

Sample Input

1
{
2
    "id": "10000",
3
    "name": "Version 2.0",
4
    "description": "Major release with new features",
5
    "project": "PROJ",
6
    "user_start_date": "2023-06-01T00:00:00Z",
7
    "user_release_date": "2023-12-31T23:59:59Z",
8
    "archived": false,
9
    "released": false
10
}

Sample Output

1
{
2
    "self": "https://your-domain.atlassian.net/rest/api/3/version/10000",
3
    "id": "10000",
4
    "description": "Major release with new features",
5
    "name": "Version 2.0",
6
    "archived": false,
7
    "released": false,
8
    "startDate": "2023-06-01T00:00:00.000Z",
9
    "releaseDate": "2023-12-31T23:59:59.000Z",
10
    "overdue": false,
11
    "userStartDate": "2023-06-01",
12
    "userReleaseDate": "2023-12-31",
13
    "projectId": 10001
14
}

DDL operations
Copy

List assignable users (DDL)
Copy

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

1
{}

Sample Output

1
[
2
    {
3
        "value": "john.doe@example.com",
4
        "label": "John Doe"
5
    },
6
    {
7
        "value": "jane.smith@example.com",
8
        "label": "Jane Smith"
9
    },
10
    {
11
        "value": "mike.johnson@example.com",
12
        "label": "Mike Johnson"
13
    },
14
    {
15
        "value": "sarah.brown@example.com",
16
        "label": "Sarah Brown"
17
    }
18
]

List issue fields (DDL)
Copy

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

1
{}

Sample Output

1
[
2
    {
3
        "id": "summary",
4
        "name": "Summary",
5
        "custom": false,
6
        "orderable": true,
7
        "navigable": true,
8
        "searchable": true,
9
        "clauseNames": [
10
            "summary"
11
        ],
12
        "schema": {
13
            "type": "string",
14
            "system": "summary"
15
        }
16
    },
17
    {
18
        "id": "issuetype",
19
        "name": "Issue Type",
20
        "custom": false,
21
        "orderable": true,
22
        "navigable": true,
23
        "searchable": true,
24
        "clauseNames": [
25
            "issuetype",
26
            "type"
27
        ],
28
        "schema": {
29
            "type": "issuetype",
30
            "system": "issuetype"
31
        }
32
    },
33
    {
34
        "id": "priority",
35
        "name": "Priority",
36
        "custom": false,
37
        "orderable": true,
38
        "navigable": true,
39
        "searchable": true,
40
        "clauseNames": [
41
            "priority"
42
        ],
43
        "schema": {
44
            "type": "priority",
45
            "system": "priority"
46
        }
47
    },
48
    {
49
        "id": "customfield_10001",
50
        "name": "Story Points",
51
        "custom": true,
52
        "orderable": true,
53
        "navigable": true,
54
        "searchable": true,
55
        "clauseNames": [
56
            "cf[10001]",
57
            "Story Points"
58
        ],
59
        "schema": {
60
            "type": "number",
61
            "custom": "com.atlassian.jira.plugin.system.customfieldtypes:float",
62
            "customId": 10001
63
        }
64
    }
65
]

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

1
{}

Sample Output

1
[
2
    {
3
        "id": "10000",
4
        "name": "Blocks",
5
        "inward": "is blocked by",
6
        "outward": "blocks"
7
    },
8
    {
9
        "id": "10001",
10
        "name": "Cloners",
11
        "inward": "is cloned by",
12
        "outward": "clones"
13
    },
14
    {
15
        "id": "10002",
16
        "name": "Duplicate",
17
        "inward": "is duplicated by",
18
        "outward": "duplicates"
19
    },
20
    {
21
        "id": "10003",
22
        "name": "Relates",
23
        "inward": "relates to",
24
        "outward": "relates to"
25
    }
26
]

List issue transitions (DDL)
Copy

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

1
{}

Sample Output

1
{
2
    "transitions": [
3
        {
4
            "id": "11",
5
            "name": "To Do",
6
            "to": {
7
                "self": "https://your-domain.atlassian.net/rest/api/3/status/10000",
8
                "description": "This issue is ready to be worked on.",
9
                "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/open.png",
10
                "name": "To Do",
11
                "id": "10000",
12
                "statusCategory": {
13
                    "self": "https://your-domain.atlassian.net/rest/api/3/statuscategory/2",
14
                    "id": 2,
15
                    "key": "new",
16
                    "colorName": "blue-gray",
17
                    "name": "To Do"
18
                }
19
            }
20
        },
21
        {
22
            "id": "21",
23
            "name": "In Progress",
24
            "to": {
25
                "self": "https://your-domain.atlassian.net/rest/api/3/status/3",
26
                "description": "This issue is being actively worked on.",
27
                "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/inprogress.png",
28
                "name": "In Progress",
29
                "id": "3",
30
                "statusCategory": {
31
                    "self": "https://your-domain.atlassian.net/rest/api/3/statuscategory/4",
32
                    "id": 4,
33
                    "key": "indeterminate",
34
                    "colorName": "yellow",
35
                    "name": "In Progress"
36
                }
37
            }
38
        },
39
        {
40
            "id": "31",
41
            "name": "Done",
42
            "to": {
43
                "self": "https://your-domain.atlassian.net/rest/api/3/status/10001",
44
                "description": "This issue is completed.",
45
                "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/closed.png",
46
                "name": "Done",
47
                "id": "10001",
48
                "statusCategory": {
49
                    "self": "https://your-domain.atlassian.net/rest/api/3/statuscategory/3",
50
                    "id": 3,
51
                    "key": "done",
52
                    "colorName": "green",
53
                    "name": "Done"
54
                }
55
            }
56
        }
57
    ]
58
}

List issue types (DDL)
Copy

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

1
{}

Sample Output

1
[
2
    {
3
        "value": "10000",
4
        "label": "Epic"
5
    },
6
    {
7
        "value": "10001",
8
        "label": "Story"
9
    },
10
    {
11
        "value": "10002",
12
        "label": "Task"
13
    },
14
    {
15
        "value": "10003",
16
        "label": "Bug"
17
    },
18
    {
19
        "value": "10004",
20
        "label": "Subtask"
21
    }
22
]

List priorities (DDL)
Copy

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

1
{}

Sample Output

1
[
2
    {
3
        "value": "1",
4
        "label": "Highest"
5
    },
6
    {
7
        "value": "2",
8
        "label": "High"
9
    },
10
    {
11
        "value": "3",
12
        "label": "Medium"
13
    },
14
    {
15
        "value": "4",
16
        "label": "Low"
17
    },
18
    {
19
        "value": "5",
20
        "label": "Lowest"
21
    }
22
]

List project IDs (DDL)
Copy

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

1
{}

Sample Output

1
{
2
    "options": [
3
        {
4
            "value": "10000",
5
            "text": "Project Alpha"
6
        },
7
        {
8
            "value": "10001",
9
            "text": "Project Beta"
10
        },
11
        {
12
            "value": "10002",
13
            "text": "Project Gamma"
14
        },
15
        {
16
            "value": "10003",
17
            "text": "Project Delta"
18
        },
19
        {
20
            "value": "10004",
21
            "text": "Project Epsilon"
22
        }
23
    ]
24
}

List project keys (DDL)
Copy

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

1
{}

Sample Output

1
[
2
    {
3
        "key": "PROJ",
4
        "name": "Project Alpha"
5
    },
6
    {
7
        "key": "DEV",
8
        "name": "Development Team"
9
    },
10
    {
11
        "key": "QA",
12
        "name": "Quality Assurance"
13
    },
14
    {
15
        "key": "MKTG",
16
        "name": "Marketing"
17
    },
18
    {
19
        "key": "HR",
20
        "name": "Human Resources"
21
    }
22
]

List project statuses (DDL)
Copy

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

1
{}

Sample Output

1
[
2
    {
3
        "id": "1",
4
        "name": "To Do",
5
        "statusCategory": {
6
            "id": "2",
7
            "key": "new",
8
            "colorName": "blue-gray",
9
            "name": "To Do"
10
        }
11
    },
12
    {
13
        "id": "2",
14
        "name": "In Progress",
15
        "statusCategory": {
16
            "id": "4",
17
            "key": "indeterminate",
18
            "colorName": "yellow",
19
            "name": "In Progress"
20
        }
21
    },
22
    {
23
        "id": "3",
24
        "name": "Done",
25
        "statusCategory": {
26
            "id": "3",
27
            "key": "done",
28
            "colorName": "green",
29
            "name": "Done"
30
        }
31
    }
32
]

List project versions (DDL)
Copy

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

1
{}

Sample Output

1
{
2
    "versions": [
3
        {
4
            "self": "https://your-domain.atlassian.net/rest/api/3/version/10000",
5
            "id": "10000",
6
            "name": "Version 1.0",
7
            "archived": false,
8
            "released": true,
9
            "startDate": "2023-01-01",
10
            "releaseDate": "2023-03-15",
11
            "userStartDate": "01/Jan/23",
12
            "userReleaseDate": "15/Mar/23",
13
            "projectId": 10001
14
        },
15
        {
16
            "self": "https://your-domain.atlassian.net/rest/api/3/version/10001",
17
            "id": "10001",
18
            "name": "Version 1.1",
19
            "archived": false,
20
            "released": false,
21
            "startDate": "2023-04-01",
22
            "releaseDate": "2023-06-30",
23
            "userStartDate": "01/Apr/23",
24
            "userReleaseDate": "30/Jun/23",
25
            "projectId": 10001
26
        }
27
    ]
28
}

List resolutions (DDL)
Copy

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

1
{}

Sample Output

1
[
2
    {
3
        "self": "https://your-domain.atlassian.net/rest/api/3/resolution/1",
4
        "id": "1",
5
        "description": "A fix for this issue is complete and tested.",
6
        "name": "Done",
7
        "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/closed.png"
8
    },
9
    {
10
        "self": "https://your-domain.atlassian.net/rest/api/3/resolution/2",
11
        "id": "2",
12
        "description": "This issue won't be actioned.",
13
        "name": "Won't Do",
14
        "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/cancelled.png"
15
    },
16
    {
17
        "self": "https://your-domain.atlassian.net/rest/api/3/resolution/3",
18
        "id": "3",
19
        "description": "This issue is a duplicate of an existing issue.",
20
        "name": "Duplicate",
21
        "iconUrl": "https://your-domain.atlassian.net/images/icons/statuses/duplicate.png"
22
    }
23
]

List statuses (DDL)
Copy

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

1
{}

Sample Output

1
[
2
    {
3
        "id": "1",
4
        "name": "To Do",
5
        "statusCategory": {
6
            "id": "2",
7
            "key": "new",
8
            "name": "To Do"
9
        }
10
    },
11
    {
12
        "id": "3",
13
        "name": "In Progress",
14
        "statusCategory": {
15
            "id": "4",
16
            "key": "indeterminate",
17
            "name": "In Progress"
18
        }
19
    },
20
    {
21
        "id": "5",
22
        "name": "Done",
23
        "statusCategory": {
24
            "id": "3",
25
            "key": "done",
26
            "name": "Done"
27
        }
28
    },
29
    {
30
        "id": "10000",
31
        "name": "Backlog",
32
        "statusCategory": {
33
            "id": "2",
34
            "key": "new",
35
            "name": "To Do"
36
        }
37
    },
38
    {
39
        "id": "10001",
40
        "name": "Selected for Development",
41
        "statusCategory": {
42
            "id": "2",
43
            "key": "new",
44
            "name": "To Do"
45
        }
46
    }
47
]
Previous

Overview

Next

Operations