ActivityTimeline REST API

Created by Instructor
Last updated: Jun 23, 2022

All API requests can be made by ActivityTimeline user with Administrator permission only.

ActivityTimeline REST API is turned off by default. You must turn it on before the first use.


ActivityTimeline REST API can be turned on by changing ActivityTimeline REST API setting at Dashboard → Configuration → Advanced Settings page or AT REST API page:

 

 

ActivityTimeline REST API is available starting from ActivityTimeline v4.2.

How to Use REST API

  1. Create a unique AT REST API authorization token in ActivityTimeline configuration

  2. Call API methods with specifying that auth-token as a request Header or URL parameter (or auth_token before AT v8.3.0). 

Sample Java/C# code of AT REST API usage

Sample Java project that demonstrates how to call AT REST API can be downloaded here (all API methods):

Sample .NET (C#) project that demonstrates how to call AT REST API can be downloaded here (some API methods):

 

 

Authorization

You can authorize into the REST API by specifying a unique Authorization Token in one of 4 supported ways:

  • Add auth-token Header with the value of your Authorization Token (preferred) V8.3.0+

  • Add auth_token Header with the value of your Authorization Token

  • Add auth-token URL parameter with the value of your Authorization Token V8.3.0+

  • Add auth_token URL parameter with the value of your Authorization Token 

 

Authorization Token can be generated at ActivityTimeline Configuration → AT REST API page.

You can authorize into the REST API by specifying a unique Authorization Token in one of 4 supported ways:

  • Add auth-token Header with the value of your Authorization Token (preferred) V8.3.0+

  • Add auth_token Header with the value of your Authorization Token

  • Add auth-token URL parameter with the value of your Authorization Token V8.3.0+

  • Add auth_token URL parameter with the value of your Authorization Token 

 

Authorization Token can be generated at ActivityTimeline Configuration → AT REST API page.

 

Methods:

Timeline Schedule & Workload  v4.2.0+

Returns information about user and events (Jira issues and custom events) for specified user for specified period of time.


Request

1 GET /rest/api/1/timeline?auth_token=YOUR_AUTH_TOKEN

 

QUERY PARAMETERS

Parameter

Type

Description

Parameter

Type

Description

start *

string

Start of the period formatted in "yyyy-MM-dd" format

end *

string

End of the period formatted in "yyyy-MM-dd" format

teamId *

long

Id of a specific team

eventType

string

Optional

If specified then the system will filter returned items to the specified type.

  • supported custom event type names: BOOKING, DAY_OFF, HOLIDAY,
    NOTE, PLACEHOLDER, SICK_LEAVE, VACATION.

  • ISSUE for Jira issues only,

  • WORKLOG for Jira worklogs only,

  • empty - return all items in a period.

* indicates required parameters

Example

1 2 3 4 5 6 7 8 9 https://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/timeline?teamId=1234567890&start=2016-07-11&end=2016-07-18&auth_token=YOUR_AUTH_TOKEN https://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/timeline?teamId=1234567890&start=2018-11-30&end=2019-01-01&eventType=HOLIDAY&auth_token=YOUR_AUTH_TOKEN https://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/timeline?teamId=1234567890&start=2018-11-30&end=2019-01-01&eventType=BOOKING&auth_token=YOUR_AUTH_TOKEN https://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/timeline?teamId=1234567890&start=2018-11-30&end=2019-01-01&eventType=ISSUE&auth_token=YOUR_AUTH_TOKEN https://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/timeline?teamId=1234567890&start=2018-11-30&end=2019-01-01&eventType=WORKLOG&auth_token=YOUR_AUTH_TOKEN

Responses


status 200 application/json Returns json representation of the result if request performed successfully.
Example
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 { "id": "1107507732947945188", "name": "External Team", "members": [ { "id": "3786270175247354575", "involvement": 8, "personPosition": { "id": "8582213406392863840", "positionNameLong": "QA", "positionDescription": "QA Engineer" }, "userRealName": "Amy Kartel", "email": "amy.kartel@company.com", "enabled": true, "username": "amy.kartel", "issues": [ { "id": "273688659851364550", "issueId": 20003, "issueKey": "TRP-10", "summary": "[TRP-10] Incorrect wording on a label", "plannedStart": "2016-07-13", "plannedEnd": "2016-07-13", "due": "", "color": "Red", "issueType": "JIRA_ISSUE", "originalTimeEstimate": 0, "remainingTimeEstimate": 0 }, { "id": "10913502816060634", "issueId": null, "issueKey": "TRPae98fee1-96c1-4b0b-ada6-dd138e12e693", "summary": "[Booking] Reperi Product | potential work", "plannedStart": "2016-07-14", "plannedEnd": "2016-07-15", "due": "", "color": null, "issueType": "BOOKING", "originalTimeEstimate": 7200, "remainingTimeEstimate": 7200, "estimatePerWorkDay": "yes", "extraLink": "", "approvedBy": null }, { "id": "4960169761522796814", "issueId": 16802, "issueKey": "TA-8", "summary": "[TA-8] Choose ISP", "plannedStart": "2016-07-14", "plannedEnd": "2016-07-14", "due": "", "color": "None", "issueType": "JIRA_ISSUE", "originalTimeEstimate": 0, "remainingTimeEstimate": 0 }, { "id": "4445216931731619881", "issueId": null, "issueKey": "_AT_2db7247c-a0f5-4e3b-bfe5-4baf1df566fa", "summary": "[Day Off] out of the office", "plannedStart": "2016-07-11", "plannedEnd": "2016-07-12", "due": "", "color": "Yellow", "issueType": "DAY_OFF", "originalTimeEstimate": 0, "remainingTimeEstimate": 0, "extraLink": "", "approvedBy": null } ] }, { "id": "4759616025136811794", "involvement": 4, "personPosition": { "id": "3712124335976172354", "positionNameLong": "Consultant", "positionDescription": null }, "userRealName": "Bob Robinson", "email": "bob.robinson@company.com", "enabled": true, "username": "bob.robinson", "issues": [ { "id": "6068295962237947803", "issueId": 15103, "issueKey": "TDES-1", "summary": "[TDES-1] Two new graphics", "plannedStart": "2016-07-11", "plannedEnd": "2016-07-22", "due": "", "color": null, "issueType": "JIRA_ISSUE", "originalTimeEstimate": 57600, "remainingTimeEstimate": 144000 } ] }, { "id": "2612086174493854452", "involvement": 8, "personPosition": null, "userRealName": "Janny Miller", "email": "janny.miller@company.com", "enabled": true, "username": "janny.miller", "issues": [ { "id": "3121097772564302182", "issueId": 15106, "issueKey": "TDES-4", "summary": "[TDES-4] Update default layout", "plannedStart": "2016-07-12", "plannedEnd": "2016-07-12", "due": "", "color": null, "issueType": "JIRA_ISSUE", "originalTimeEstimate": 14400, "remainingTimeEstimate": 5400 }, { "id": "3954119684277487799", "issueId": 15105, "issueKey": "TDES-3", "summary": "[TDES-3] Update title styles", "plannedStart": "2016-07-11", "plannedEnd": "2016-07-11", "due": "", "color": "Purple", "issueType": "JIRA_ISSUE", "originalTimeEstimate": 0, "remainingTimeEstimate": 0 }, { "id": "4134472451282322432", "issueId": 15100, "issueKey": "TRP-1", "summary": "[TRP-1] Implement Data Migration Script", "plannedStart": "2016-07-13", "plannedEnd": "2016-07-15", "due": "", "color": null, "issueType": "JIRA_ISSUE", "originalTimeEstimate": 57600, "remainingTimeEstimate": 86400 }, { "id": "41351470354940514", "issueId": null, "issueKey": "TRPddc956ec-bb5b-4201-85ab-8f4f32f50e2c", "summary": "[Placeholder | TRP-4] Add Print dialog", "plannedStart": "2016-07-12", "plannedEnd": "2016-07-12", "due": "", "color": null, "issueType": "PLACEHOLDER", "originalTimeEstimate": 7200, "remainingTimeEstimate": 7200, "placeholderIssueKey": "TRP-4", "extraLink": "", "approvedBy": null } ] } ] }

 

status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request


status 200 application/json Returns json representation of the result if request performed successfully.
Example
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 { "id": "1107507732947945188", "name": "External Team", "members": [ { "id": "3786270175247354575", "involvement": 8, "personPosition": { "id": "8582213406392863840", "positionNameLong": "QA", "positionDescription": "QA Engineer" }, "userRealName": "Amy Kartel", "email": "amy.kartel@company.com", "enabled": true, "username": "amy.kartel", "issues": [ { "id": "273688659851364550", "issueId": 20003, "issueKey": "TRP-10", "summary": "[TRP-10] Incorrect wording on a label", "plannedStart": "2016-07-13", "plannedEnd": "2016-07-13", "due": "", "color": "Red", "issueType": "JIRA_ISSUE", "originalTimeEstimate": 0, "remainingTimeEstimate": 0 }, { "id": "10913502816060634", "issueId": null, "issueKey": "TRPae98fee1-96c1-4b0b-ada6-dd138e12e693", "summary": "[Booking] Reperi Product | potential work", "plannedStart": "2016-07-14", "plannedEnd": "2016-07-15", "due": "", "color": null, "issueType": "BOOKING", "originalTimeEstimate": 7200, "remainingTimeEstimate": 7200, "estimatePerWorkDay": "yes", "extraLink": "", "approvedBy": null }, { "id": "4960169761522796814", "issueId": 16802, "issueKey": "TA-8", "summary": "[TA-8] Choose ISP", "plannedStart": "2016-07-14", "plannedEnd": "2016-07-14", "due": "", "color": "None", "issueType": "JIRA_ISSUE", "originalTimeEstimate": 0, "remainingTimeEstimate": 0 }, { "id": "4445216931731619881", "issueId": null, "issueKey": "_AT_2db7247c-a0f5-4e3b-bfe5-4baf1df566fa", "summary": "[Day Off] out of the office", "plannedStart": "2016-07-11", "plannedEnd": "2016-07-12", "due": "", "color": "Yellow", "issueType": "DAY_OFF", "originalTimeEstimate": 0, "remainingTimeEstimate": 0, "extraLink": "", "approvedBy": null } ] }, { "id": "4759616025136811794", "involvement": 4, "personPosition": { "id": "3712124335976172354", "positionNameLong": "Consultant", "positionDescription": null }, "userRealName": "Bob Robinson", "email": "bob.robinson@company.com", "enabled": true, "username": "bob.robinson", "issues": [ { "id": "6068295962237947803", "issueId": 15103, "issueKey": "TDES-1", "summary": "[TDES-1] Two new graphics", "plannedStart": "2016-07-11", "plannedEnd": "2016-07-22", "due": "", "color": null, "issueType": "JIRA_ISSUE", "originalTimeEstimate": 57600, "remainingTimeEstimate": 144000 } ] }, { "id": "2612086174493854452", "involvement": 8, "personPosition": null, "userRealName": "Janny Miller", "email": "janny.miller@company.com", "enabled": true, "username": "janny.miller", "issues": [ { "id": "3121097772564302182", "issueId": 15106, "issueKey": "TDES-4", "summary": "[TDES-4] Update default layout", "plannedStart": "2016-07-12", "plannedEnd": "2016-07-12", "due": "", "color": null, "issueType": "JIRA_ISSUE", "originalTimeEstimate": 14400, "remainingTimeEstimate": 5400 }, { "id": "3954119684277487799", "issueId": 15105, "issueKey": "TDES-3", "summary": "[TDES-3] Update title styles", "plannedStart": "2016-07-11", "plannedEnd": "2016-07-11", "due": "", "color": "Purple", "issueType": "JIRA_ISSUE", "originalTimeEstimate": 0, "remainingTimeEstimate": 0 }, { "id": "4134472451282322432", "issueId": 15100, "issueKey": "TRP-1", "summary": "[TRP-1] Implement Data Migration Script", "plannedStart": "2016-07-13", "plannedEnd": "2016-07-15", "due": "", "color": null, "issueType": "JIRA_ISSUE", "originalTimeEstimate": 57600, "remainingTimeEstimate": 86400 }, { "id": "41351470354940514", "issueId": null, "issueKey": "TRPddc956ec-bb5b-4201-85ab-8f4f32f50e2c", "summary": "[Placeholder | TRP-4] Add Print dialog", "plannedStart": "2016-07-12", "plannedEnd": "2016-07-12", "due": "", "color": null, "issueType": "PLACEHOLDER", "originalTimeEstimate": 7200, "remainingTimeEstimate": 7200, "placeholderIssueKey": "TRP-4", "extraLink": "", "approvedBy": null } ] } ] }

 

status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request

 

 

Returns information about user and events (Jira issues and custom events) for specified user for specified period of time.


Request

1 GET /rest/api/1/timeline/$username?auth_token=YOUR_AUTH_TOKEN

 

QUERY PARAMETERS

Parameter

Type

Description

Parameter

Type

Description

start *

string

Start of the period formatted in "yyyy-MM-dd" format

end *

string

End of the period formatted in "yyyy-MM-dd" format

username *

string

Username or accountId of specific user

eventType

string

Optional

If specified then the system will filter returned items to the specified type.

  • supported custom event type names: BOOKING, DAY_OFF, HOLIDAY,
    NOTE, PLACEHOLDER, SICK_LEAVE, VACATION.

  • ISSUE for Jira issues only,

  • WORKLOG for Jira worklogs only,

  • empty - return all items in a period.

* indicates required parameters

Example

1 2 3 4 5 6 7 8 9 https://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/timeline/admin?start=2016-07-11&end=2016-07-18&auth_token=YOUR_AUTH_TOKEN https://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/timeline/admin?start=2018-11-30&end=2019-01-01&eventType=HOLIDAY&auth_token=YOUR_AUTH_TOKEN https://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/timeline/admin?start=2018-11-30&end=2019-01-01&eventType=BOOKING&auth_token=YOUR_AUTH_TOKEN https://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/timeline/admin?start=2018-11-30&end=2019-01-01&eventType=ISSUE&auth_token=YOUR_AUTH_TOKEN https://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/timeline/admin?start=2018-11-30&end=2019-01-01&eventType=WORKLOG&auth_token=YOUR_AUTH_TOKEN

Responses


status 200 application/json Returns json representation of the result if request performed successfully.
Example
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 { "id": "2641502681345183593", "involvement": 8.0, "personPosition": null, "userRealName": "Administrator", "email": "admin@company.com", "enabled": true, "username": "admin", "issues": [{ "id": "1800561052349910244", "issueId": null, "issueKey": "_AT_-ce48f923-bb20-47c1-8a71-95aaa2742d6f", "summary": "Placeholder", "plannedStart": "2020-07-29", "plannedEnd": "2020-07-29", "due": "", "color": "Green", "issueType": "PLACEHOLDER", "originalTimeEstimate": 18000, "remainingTimeEstimate": 18000, "placeholderIssueKey": null, "extraLink": "", "approvedBy": null }, { "id": "2163682457033067837", "issueId": null, "issueKey": "ADP-eb93d739-4aa7-4b1b-9b19-7b283d3b6442", "summary": "[Placeholder | ADP-69] Test", "plannedStart": "2020-07-28", "plannedEnd": "2020-07-28", "due": "", "color": "Green", "issueType": "PLACEHOLDER", "originalTimeEstimate": 18000, "remainingTimeEstimate": 18000, "placeholderIssueKey": "ADP-69", "extraLink": "", "approvedBy": null }, { "id": "4519045037419348631", "issueId": null, "issueKey": "ADP-6a2eb537-bf08-4403-a07a-2e8c8b520994", "summary": "[Placeholder | ADP-63] My team issue", "plannedStart": "2020-07-30", "plannedEnd": "2020-07-30", "due": "", "color": "Green", "issueType": "PLACEHOLDER", "originalTimeEstimate": 225000, "remainingTimeEstimate": 225000, "placeholderIssueKey": "ADP-63", "extraLink": "", "approvedBy": null }, { "id": "7749083366501270133", "issueId": null, "issueKey": "ADP-74f4b492-a4b9-432e-a463-cda63a7d447c", "summary": "[Placeholder | ADP-66] API issue", "plannedStart": "2020-07-27", "plannedEnd": "2020-07-27", "due": "", "color": "Green", "issueType": "PLACEHOLDER", "originalTimeEstimate": 0, "remainingTimeEstimate": 248400, "placeholderIssueKey": "ADP-66", "extraLink": "", "approvedBy": null }] }

 

status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request


status 200 application/json Returns json representation of the result if request performed successfully.
Example
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 { "id": "2641502681345183593", "involvement": 8.0, "personPosition": null, "userRealName": "Administrator", "email": "admin@company.com", "enabled": true, "username": "admin", "issues": [{ "id": "1800561052349910244", "issueId": null, "issueKey": "_AT_-ce48f923-bb20-47c1-8a71-95aaa2742d6f", "summary": "Placeholder", "plannedStart": "2020-07-29", "plannedEnd": "2020-07-29", "due": "", "color": "Green", "issueType": "PLACEHOLDER", "originalTimeEstimate": 18000, "remainingTimeEstimate": 18000, "placeholderIssueKey": null, "extraLink": "", "approvedBy": null }, { "id": "2163682457033067837", "issueId": null, "issueKey": "ADP-eb93d739-4aa7-4b1b-9b19-7b283d3b6442", "summary": "[Placeholder | ADP-69] Test", "plannedStart": "2020-07-28", "plannedEnd": "2020-07-28", "due": "", "color": "Green", "issueType": "PLACEHOLDER", "originalTimeEstimate": 18000, "remainingTimeEstimate": 18000, "placeholderIssueKey": "ADP-69", "extraLink": "", "approvedBy": null }, { "id": "4519045037419348631", "issueId": null, "issueKey": "ADP-6a2eb537-bf08-4403-a07a-2e8c8b520994", "summary": "[Placeholder | ADP-63] My team issue", "plannedStart": "2020-07-30", "plannedEnd": "2020-07-30", "due": "", "color": "Green", "issueType": "PLACEHOLDER", "originalTimeEstimate": 225000, "remainingTimeEstimate": 225000, "placeholderIssueKey": "ADP-63", "extraLink": "", "approvedBy": null }, { "id": "7749083366501270133", "issueId": null, "issueKey": "ADP-74f4b492-a4b9-432e-a463-cda63a7d447c", "summary": "[Placeholder | ADP-66] API issue", "plannedStart": "2020-07-27", "plannedEnd": "2020-07-27", "due": "", "color": "Green", "issueType": "PLACEHOLDER", "originalTimeEstimate": 0, "remainingTimeEstimate": 248400, "placeholderIssueKey": "ADP-66", "extraLink": "", "approvedBy": null }] }

 

status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request

 

 

Returns information about users and workloads for specified team for specified period of time.


Request

1 GET /rest/api/1/workload?auth_token=YOUR_AUTH_TOKEN


QUERY PARAMETERS

Parameter

Type

Description

Parameter

Type

Description

start *

string

Start of the period formatted in "yyyy-MM-dd" format

end *

string

End of the period formatted in "yyyy-MM-dd" format

teamId *

long

id of specified team

projectKey

string

Optional ActivityTimeline v8.1.2 and above
The system will output the per-user workload per specific project if
projectKey parameter is set

startOffset

int

Offset for first users, default is 0

maxUsers

int

Maximum users count to return, max 50

includeProjectDetails

boolean

Optional Activity Timeline v8.2.0 and above
If set to 'true" then the app will return break down of hours per project key.

Example:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 "username": "amy.kartel", "workload": [ { "day": "2021-07-12", "day0fWeek" : "mon", "hours": { "ABC": 4, "CDF": 2, "AMS": 0.5 } }, { "day": "2021-07-13", "day0fWeek": "tue", "hours": 0 }, .......... { "day": "2021-07-16", "dayOfWeek": "fri", "hours": { "CDF": 7, "AMS": 1 } } ]

* indicates required parameters

Example

1 http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/workload?start=2016-07-11&end=2016-07-18&teamId=1107507732947945188&startOffset=0&maxUsers=50&auth_token=YOUR_AUTH_TOKEN


Responses


status 200 application/json Returns json representation of the result if request performed successfully.
Example
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 { "id": "1107507732947945188", "name": "External Team", "members": [ { "id": "3786270175247354575", "involvement": 8, "personPosition": { "id": "8582213406392863840", "positionNameLong": "QA", "positionDescription": "QA Engineer" }, "userRealName": "Amy Kartel", "email": "amy.kartel@company.com", "enabled": true, "username": "amy.kartel", "workload": [ { "day": "2016-07-10", "dayOfWeek": "sun", "hours": -1000 }, { "day": "2016-07-11", "dayOfWeek": "mon", "hours": -2000 }, { "day": "2016-07-12", "dayOfWeek": "tue", "hours": -2000 }, { "day": "2016-07-13", "dayOfWeek": "wed", "hours": 0 }, { "day": "2016-07-14", "dayOfWeek": "thu", "hours": 2 }, { "day": "2016-07-15", "dayOfWeek": "fri", "hours": 2 }, { "day": "2016-07-16", "dayOfWeek": "sat", "hours": -1000 }, { "day": "2016-07-17", "dayOfWeek": "sun", "hours": -1000 }, { "day": "2016-07-18", "dayOfWeek": "mon", "hours": 0 }, { "day": "2016-07-19", "dayOfWeek": "tue", "hours": 0 } ] }, { "id": "4759616025136811794", "involvement": 4, "personPosition": { "id": "3712124335976172354", "positionNameLong": "Consultant", "positionDescription": null }, "userRealName": "Bob Robinson", "email": "bob.robinson@company.com", "enabled": true, "username": "bob.robinson", "workload": [ { "day": "2016-07-10", "dayOfWeek": "sun", "hours": -1000 }, { "day": "2016-07-11", "dayOfWeek": "mon", "hours": 4 }, { "day": "2016-07-12", "dayOfWeek": "tue", "hours": 4 }, { "day": "2016-07-13", "dayOfWeek": "wed", "hours": 4 }, { "day": "2016-07-14", "dayOfWeek": "thu", "hours": 4 }, { "day": "2016-07-15", "dayOfWeek": "fri", "hours": 4 }, { "day": "2016-07-16", "dayOfWeek": "sat", "hours": -1000 }, { "day": "2016-07-17", "dayOfWeek": "sun", "hours": -1000 }, { "day": "2016-07-18", "dayOfWeek": "mon", "hours": 4 }, { "day": "2016-07-19", "dayOfWeek": "tue", "hours": 4 } ] }, { "id": "2612086174493854452", "involvement": 8, "personPosition": null, "userRealName": "Janny Miller", "email": "janny.miller@company.com", "enabled": true, "username": "janny.miller", "workload": [ { "day": "2016-07-10", "dayOfWeek": "sun", "hours": -1000 }, { "day": "2016-07-11", "dayOfWeek": "mon", "hours": 0 }, { "day": "2016-07-12", "dayOfWeek": "tue", "hours": 3.5 }, { "day": "2016-07-13", "dayOfWeek": "wed", "hours": 8 }, { "day": "2016-07-14", "dayOfWeek": "thu", "hours": 8 }, { "day": "2016-07-15", "dayOfWeek": "fri", "hours": 8 }, { "day": "2016-07-16", "dayOfWeek": "sat", "hours": -1000 }, { "day": "2016-07-17", "dayOfWeek": "sun", "hours": -1000 }, { "day": "2016-07-18", "dayOfWeek": "mon", "hours": 0 }, { "day": "2016-07-19", "dayOfWeek": "tue", "hours": 0 } ] } ] }



status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request


status 200 application/json Returns json representation of the result if request performed successfully.
Example
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 { "id": "1107507732947945188", "name": "External Team", "members": [ { "id": "3786270175247354575", "involvement": 8, "personPosition": { "id": "8582213406392863840", "positionNameLong": "QA", "positionDescription": "QA Engineer" }, "userRealName": "Amy Kartel", "email": "amy.kartel@company.com", "enabled": true, "username": "amy.kartel", "workload": [ { "day": "2016-07-10", "dayOfWeek": "sun", "hours": -1000 }, { "day": "2016-07-11", "dayOfWeek": "mon", "hours": -2000 }, { "day": "2016-07-12", "dayOfWeek": "tue", "hours": -2000 }, { "day": "2016-07-13", "dayOfWeek": "wed", "hours": 0 }, { "day": "2016-07-14", "dayOfWeek": "thu", "hours": 2 }, { "day": "2016-07-15", "dayOfWeek": "fri", "hours": 2 }, { "day": "2016-07-16", "dayOfWeek": "sat", "hours": -1000 }, { "day": "2016-07-17", "dayOfWeek": "sun", "hours": -1000 }, { "day": "2016-07-18", "dayOfWeek": "mon", "hours": 0 }, { "day": "2016-07-19", "dayOfWeek": "tue", "hours": 0 } ] }, { "id": "4759616025136811794", "involvement": 4, "personPosition": { "id": "3712124335976172354", "positionNameLong": "Consultant", "positionDescription": null }, "userRealName": "Bob Robinson", "email": "bob.robinson@company.com", "enabled": true, "username": "bob.robinson", "workload": [ { "day": "2016-07-10", "dayOfWeek": "sun", "hours": -1000 }, { "day": "2016-07-11", "dayOfWeek": "mon", "hours": 4 }, { "day": "2016-07-12", "dayOfWeek": "tue", "hours": 4 }, { "day": "2016-07-13", "dayOfWeek": "wed", "hours": 4 }, { "day": "2016-07-14", "dayOfWeek": "thu", "hours": 4 }, { "day": "2016-07-15", "dayOfWeek": "fri", "hours": 4 }, { "day": "2016-07-16", "dayOfWeek": "sat", "hours": -1000 }, { "day": "2016-07-17", "dayOfWeek": "sun", "hours": -1000 }, { "day": "2016-07-18", "dayOfWeek": "mon", "hours": 4 }, { "day": "2016-07-19", "dayOfWeek": "tue", "hours": 4 } ] }, { "id": "2612086174493854452", "involvement": 8, "personPosition": null, "userRealName": "Janny Miller", "email": "janny.miller@company.com", "enabled": true, "username": "janny.miller", "workload": [ { "day": "2016-07-10", "dayOfWeek": "sun", "hours": -1000 }, { "day": "2016-07-11", "dayOfWeek": "mon", "hours": 0 }, { "day": "2016-07-12", "dayOfWeek": "tue", "hours": 3.5 }, { "day": "2016-07-13", "dayOfWeek": "wed", "hours": 8 }, { "day": "2016-07-14", "dayOfWeek": "thu", "hours": 8 }, { "day": "2016-07-15", "dayOfWeek": "fri", "hours": 8 }, { "day": "2016-07-16", "dayOfWeek": "sat", "hours": -1000 }, { "day": "2016-07-17", "dayOfWeek": "sun", "hours": -1000 }, { "day": "2016-07-18", "dayOfWeek": "mon", "hours": 0 }, { "day": "2016-07-19", "dayOfWeek": "tue", "hours": 0 } ] } ] }



status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request

 

Returns information about user and workloads for specified user for specified period of time.


Request

1 GET /rest/api/1/workload/$username?auth_token=YOUR_AUTH_TOKEN


QUERY PARAMETERS

Parameter

Type

Description

Parameter

Type

Description

start *

string

Start of the period formatted in "yyyy-MM-dd" format

end *

string

End of the period formatted in "yyyy-MM-dd" format

username *

string

Username or accountId of specific user

* indicates required parameters


Example

1 https://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/workload/admin?start=2020-07-01&end=2020-07-30&auth_token=YOUR_AUTH_TOKEN


Responses


status 200 application/json Returns json representation of the result if request performed successfully.
Example
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 { "id": "2641502681345183593", "involvement": 8.0, "personPosition": null, "userRealName": "Administrator", "email": "admin@company.com", "enabled": true, "username": "admin", "workload": [{ "day": "2020-07-01", "hours": 0, "dayOfWeek": "wed" }, { "day": "2020-07-02", "hours": 0, "dayOfWeek": "thu" }, { "day": "2020-07-03", "hours": 0, "dayOfWeek": "fri" }, { "day": "2020-07-04", "hours": 0, "dayOfWeek": "sat" }, { "day": "2020-07-05", "hours": 0, "dayOfWeek": "sun" }, { "day": "2020-07-06", "hours": 0, "dayOfWeek": "mon" }, { "day": "2020-07-07", "hours": 0, "dayOfWeek": "tue" }, { "day": "2020-07-08", "hours": 0, "dayOfWeek": "wed" }, { "day": "2020-07-09", "hours": 0, "dayOfWeek": "thu" }, { "day": "2020-07-10", "hours": 0, "dayOfWeek": "fri" }, { "day": "2020-07-11", "hours": 0, "dayOfWeek": "sat" }, { "day": "2020-07-12", "hours": 0, "dayOfWeek": "sun" }, { "day": "2020-07-13", "hours": 0, "dayOfWeek": "mon" }, { "day": "2020-07-14", "hours": 0, "dayOfWeek": "tue" }, { "day": "2020-07-15", "hours": 0, "dayOfWeek": "wed" }, { "day": "2020-07-16", "hours": 0, "dayOfWeek": "thu" }, { "day": "2020-07-17", "hours": 0, "dayOfWeek": "fri" }, { "day": "2020-07-18", "hours": 0, "dayOfWeek": "sat" }, { "day": "2020-07-19", "hours": 0, "dayOfWeek": "sun" }, { "day": "2020-07-20", "hours": 0, "dayOfWeek": "mon" }, { "day": "2020-07-21", "hours": 0, "dayOfWeek": "tue" }, { "day": "2020-07-22", "hours": 0, "dayOfWeek": "wed" }, { "day": "2020-07-23", "hours": 0, "dayOfWeek": "thu" }, { "day": "2020-07-24", "hours": 0, "dayOfWeek": "fri" }, { "day": "2020-07-25", "hours": 0, "dayOfWeek": "sat" }, { "day": "2020-07-26", "hours": 0, "dayOfWeek": "sun" }, { "day": "2020-07-27", "hours": 0, "dayOfWeek": "mon" }, { "day": "2020-07-28", "hours": 0, "dayOfWeek": "tue" }, { "day": "2020-07-29", "hours": 0, "dayOfWeek": "wed" }, { "day": "2020-07-30", "hours": 62.5, "dayOfWeek": "thu" }, { "day": "2020-07-31", "hours": 0, "dayOfWeek": "fri" }] }



status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request


status 200 application/json Returns json representation of the result if request performed successfully.
Example
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 { "id": "2641502681345183593", "involvement": 8.0, "personPosition": null, "userRealName": "Administrator", "email": "admin@company.com", "enabled": true, "username": "admin", "workload": [{ "day": "2020-07-01", "hours": 0, "dayOfWeek": "wed" }, { "day": "2020-07-02", "hours": 0, "dayOfWeek": "thu" }, { "day": "2020-07-03", "hours": 0, "dayOfWeek": "fri" }, { "day": "2020-07-04", "hours": 0, "dayOfWeek": "sat" }, { "day": "2020-07-05", "hours": 0, "dayOfWeek": "sun" }, { "day": "2020-07-06", "hours": 0, "dayOfWeek": "mon" }, { "day": "2020-07-07", "hours": 0, "dayOfWeek": "tue" }, { "day": "2020-07-08", "hours": 0, "dayOfWeek": "wed" }, { "day": "2020-07-09", "hours": 0, "dayOfWeek": "thu" }, { "day": "2020-07-10", "hours": 0, "dayOfWeek": "fri" }, { "day": "2020-07-11", "hours": 0, "dayOfWeek": "sat" }, { "day": "2020-07-12", "hours": 0, "dayOfWeek": "sun" }, { "day": "2020-07-13", "hours": 0, "dayOfWeek": "mon" }, { "day": "2020-07-14", "hours": 0, "dayOfWeek": "tue" }, { "day": "2020-07-15", "hours": 0, "dayOfWeek": "wed" }, { "day": "2020-07-16", "hours": 0, "dayOfWeek": "thu" }, { "day": "2020-07-17", "hours": 0, "dayOfWeek": "fri" }, { "day": "2020-07-18", "hours": 0, "dayOfWeek": "sat" }, { "day": "2020-07-19", "hours": 0, "dayOfWeek": "sun" }, { "day": "2020-07-20", "hours": 0, "dayOfWeek": "mon" }, { "day": "2020-07-21", "hours": 0, "dayOfWeek": "tue" }, { "day": "2020-07-22", "hours": 0, "dayOfWeek": "wed" }, { "day": "2020-07-23", "hours": 0, "dayOfWeek": "thu" }, { "day": "2020-07-24", "hours": 0, "dayOfWeek": "fri" }, { "day": "2020-07-25", "hours": 0, "dayOfWeek": "sat" }, { "day": "2020-07-26", "hours": 0, "dayOfWeek": "sun" }, { "day": "2020-07-27", "hours": 0, "dayOfWeek": "mon" }, { "day": "2020-07-28", "hours": 0, "dayOfWeek": "tue" }, { "day": "2020-07-29", "hours": 0, "dayOfWeek": "wed" }, { "day": "2020-07-30", "hours": 62.5, "dayOfWeek": "thu" }, { "day": "2020-07-31", "hours": 0, "dayOfWeek": "fri" }] }



status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request

 

 

Custom events   v4.5.5+

Creates a new custom event.


Request

1 POST /rest/api/1/event?auth_token=YOUR_AUTH_TOKEN


QUERY PARAMETERS

Parameter

Type

Description

Parameter

Type

Description

start *

string

Start of the period formatted in "yyyy-MM-dd" format

end *

string

End of the period formatted in "yyyy-MM-dd" format

username *

string

Assignee username (Jira Server) or accountld (Jira Cloud)

eventTypeld *

long

id of eventType

eventTitle *

string

Title of event

projectKey (optional)

string

Key of target project (Booking, Placeholder and Note types)

hours (optional)

number

Booking event estimate in hours / hours for partial Day Off event

estimate (optional)

number

Estimate in hours for Placeholder event type
Available starting from AT v7.3.5

isApproved (optional)

string

If set to "true" then custom event will be created pre-approved.
Applicable to Placeholder, Vacation and Booking event types.
Available starting from AT v5.0.7

* indicates required parameters

Example

1 http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/event?username=admin&eventTypeId=240025532758377186&eventTitle=someTitle&projectKey=TPA&hours=7&start=2016-11-14&end=2016-11-14&auth_token=YOUR_AUTH_TOKEN


Responses


status 200 application/json Returns created event id and new assignee username.
Example
1 2 3 4 5 6 { "users":["admin"], "message":"admin|||<b>Booking</b> has been successfully created for admin.", "result":true, "id":3728690601734324315 }



status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request


status 200 application/json Returns created event id and new assignee username.
Example
1 2 3 4 5 6 { "users":["admin"], "message":"admin|||<b>Booking</b> has been successfully created for admin.", "result":true, "id":3728690601734324315 }



status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request

 

Deletes a custom event.


Request

1 DELETE /rest/api/1/event/$id?auth_token=YOUR_AUTH_TOKEN


QUERY PARAMETERS

Parameter

Type

Description

Parameter

Type

Description

id *

long

id of custom event

* indicates required parameters

Example

1 http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/event/312463?auth_token=YOUR_AUTH_TOKEN

Responses


status 200 application/json Returns success message.
Example
1 2 3 { "message":"Event has been successfully deleted!" }

 

status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request


status 200 application/json Returns success message.
Example
1 2 3 { "message":"Event has been successfully deleted!" }

 

status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request

 

Returns a list of custom event types.


Request

1 GET /rest/api/1/eventType/list?auth_token=YOUR_AUTH_TOKEN


Example

1 http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/eventType/list?auth_token=YOUR_AUTH_TOKEN


Responses


status 200 application/json Returns json representation of event types.
Example
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 [ { "id":240025532758377186, "name":"Booking", "eventType":"BOOKING", "eventTypeIconUrl":"../images/jira/icons/eventTypes/at_booking.png", "isSystemEventType":true, "isMilestoneEventType":false }, { "id":143598346239228823, "name":"Vacation", "eventType":"VACATION", "eventTypeIconUrl":"../images/jira/icons/eventTypes/at_vacation.png", "isSystemEventType":true, "isMilestoneEventType":false }, { "id":308729741261950787, "name":"Placeholder", "eventType":"PLACEHOLDER", "eventTypeIconUrl":"../images/jira/icons/eventTypes/at_placeholder.png", "isSystemEventType":true, "isMilestoneEventType":false } ]

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request


status 200 application/json Returns json representation of event types.
Example
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 [ { "id":240025532758377186, "name":"Booking", "eventType":"BOOKING", "eventTypeIconUrl":"../images/jira/icons/eventTypes/at_booking.png", "isSystemEventType":true, "isMilestoneEventType":false }, { "id":143598346239228823, "name":"Vacation", "eventType":"VACATION", "eventTypeIconUrl":"../images/jira/icons/eventTypes/at_vacation.png", "isSystemEventType":true, "isMilestoneEventType":false }, { "id":308729741261950787, "name":"Placeholder", "eventType":"PLACEHOLDER", "eventTypeIconUrl":"../images/jira/icons/eventTypes/at_placeholder.png", "isSystemEventType":true, "isMilestoneEventType":false } ]

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request

 

 

Teams   v8.3.0+

Returns list of Activity Timeline teams.

 

Request

1 GET /rest/api/1/team/list?auth_token=YOUR_AUTH_TOKEN


Responses

status 200 application/json Returns json representation of the result if request performed successfully.

Example
1 2 3 4 5 6 7 8 9 10 [{ "id": "1107507732947945188", "name": "External Team" }, { "id": "387281612195971911", "name": "Developers Team" }, { "id": "7756417552636331634", "name": "QA Team" }]

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request

status 200 application/json Returns json representation of the result if request performed successfully.

Example
1 2 3 4 5 6 7 8 9 10 [{ "id": "1107507732947945188", "name": "External Team" }, { "id": "387281612195971911", "name": "Developers Team" }, { "id": "7756417552636331634", "name": "QA Team" }]

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request

 

Returns information about team and users in a specified team.


Request

1 GET /rest/api/1/team/$teamId?auth_token=YOUR_AUTH_TOKEN


QUERY PARAMETERS

Parameter

Type

Description

Parameter

Type

Description

teamId *

long

id of specific team

* indicates required parameters


Example

1 http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/1107507732947945188?auth_token=YOUR_AUTH_TOKEN


Responses


status 200 application/json Returns json representation of the result if request performed successfully.
Example
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 { "id": "1107507732947945188", "name": "External Team", "members": [ { "id": "3786270175247354575", "involvement": 8, "personPosition": { "id": "8582213406392863840", "positionNameLong": "QA", "positionDescription": "QA Engineer" }, "userRealName": "Amy Kartel", "email": "amy.kartel@company.com", "enabled": true, "username": "amy.kartel", "skills": [ { "skill": { "id": "6696288071248397937", "skillName": "TESTING" }, "level": { "id": "2845444854505357930", "levelName": "Advanced", "levelColor": "#419B28", "defaultLevel": false } }, { "skill": { "id": "9007657690122438304", "skillName": "QA" }, "level": { "id": "2845444854505357930", "levelName": "Advanced", "levelColor": "#419B28", "defaultLevel": false } }, { "skill": { "id": "5423046373371626385", "skillName": "JIRA" }, "level": { "id": "8309150234355319522", "levelName": "Intermediate", "levelColor": "#FCA800", "defaultLevel": true } }, { "skill": { "id": "495820420823861967", "skillName": "TEST CASES" }, "level": { "id": "8309150234355319522", "levelName": "Intermediate", "levelColor": "#FCA800", "defaultLevel": true } }, { "skill": { "id": "5159432958879026484", "skillName": "TEST PLAN" }, "level": { "id": "7372549001497429227", "levelName": "Basic", "levelColor": "#C2D2E8", "defaultLevel": false } } ] }, { "id": "4759616025136811794", "involvement": 4, "personPosition": { "id": "3712124335976172354", "positionNameLong": "Consultant", "positionDescription": null }, "userRealName": "Bob Robinson", "email": "bob.robinson@company.com", "enabled": true, "username": "bob.robinson", "skills": [ { "skill": { "id": "6393636176441000868", "skillName": "CONSULTING" }, "level": { "id": "7372549001497429227", "levelName": "Basic", "levelColor": "#C2D2E8", "defaultLevel": false } }, { "skill": { "id": "6433704713829763909", "skillName": "EMAIL" }, "level": { "id": "8309150234355319522", "levelName": "Intermediate", "levelColor": "#FCA800", "defaultLevel": true } }, { "skill": { "id": "2081234984920762007", "skillName": "COMMUNICATION" }, "level": { "id": "2845444854505357930", "levelName": "Advanced", "levelColor": "#419B28", "defaultLevel": false } } ] }, { "id": "2612086174493854452", "involvement": 8, "personPosition": null, "userRealName": "Janny Miller", "email": "janny.miller@company.com", "enabled": true, "username": "janny.miller", "skills": [ { "skill": { "id": "4881094816891751527", "skillName": "DESIGN" }, "level": { "id": "7372549001497429227", "levelName": "Basic", "levelColor": "#C2D2E8", "defaultLevel": false } }, { "skill": { "id": "2918480463760540781", "skillName": "PHOTOSHOP" }, "level": { "id": "8309150234355319522", "levelName": "Intermediate", "levelColor": "#FCA800", "defaultLevel": true } } ] } ] }

 

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request


status 200 application/json Returns json representation of the result if request performed successfully.
Example
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 { "id": "1107507732947945188", "name": "External Team", "members": [ { "id": "3786270175247354575", "involvement": 8, "personPosition": { "id": "8582213406392863840", "positionNameLong": "QA", "positionDescription": "QA Engineer" }, "userRealName": "Amy Kartel", "email": "amy.kartel@company.com", "enabled": true, "username": "amy.kartel", "skills": [ { "skill": { "id": "6696288071248397937", "skillName": "TESTING" }, "level": { "id": "2845444854505357930", "levelName": "Advanced", "levelColor": "#419B28", "defaultLevel": false } }, { "skill": { "id": "9007657690122438304", "skillName": "QA" }, "level": { "id": "2845444854505357930", "levelName": "Advanced", "levelColor": "#419B28", "defaultLevel": false } }, { "skill": { "id": "5423046373371626385", "skillName": "JIRA" }, "level": { "id": "8309150234355319522", "levelName": "Intermediate", "levelColor": "#FCA800", "defaultLevel": true } }, { "skill": { "id": "495820420823861967", "skillName": "TEST CASES" }, "level": { "id": "8309150234355319522", "levelName": "Intermediate", "levelColor": "#FCA800", "defaultLevel": true } }, { "skill": { "id": "5159432958879026484", "skillName": "TEST PLAN" }, "level": { "id": "7372549001497429227", "levelName": "Basic", "levelColor": "#C2D2E8", "defaultLevel": false } } ] }, { "id": "4759616025136811794", "involvement": 4, "personPosition": { "id": "3712124335976172354", "positionNameLong": "Consultant", "positionDescription": null }, "userRealName": "Bob Robinson", "email": "bob.robinson@company.com", "enabled": true, "username": "bob.robinson", "skills": [ { "skill": { "id": "6393636176441000868", "skillName": "CONSULTING" }, "level": { "id": "7372549001497429227", "levelName": "Basic", "levelColor": "#C2D2E8", "defaultLevel": false } }, { "skill": { "id": "6433704713829763909", "skillName": "EMAIL" }, "level": { "id": "8309150234355319522", "levelName": "Intermediate", "levelColor": "#FCA800", "defaultLevel": true } }, { "skill": { "id": "2081234984920762007", "skillName": "COMMUNICATION" }, "level": { "id": "2845444854505357930", "levelName": "Advanced", "levelColor": "#419B28", "defaultLevel": false } } ] }, { "id": "2612086174493854452", "involvement": 8, "personPosition": null, "userRealName": "Janny Miller", "email": "janny.miller@company.com", "enabled": true, "username": "janny.miller", "skills": [ { "skill": { "id": "4881094816891751527", "skillName": "DESIGN" }, "level": { "id": "7372549001497429227", "levelName": "Basic", "levelColor": "#C2D2E8", "defaultLevel": false } }, { "skill": { "id": "2918480463760540781", "skillName": "PHOTOSHOP" }, "level": { "id": "8309150234355319522", "levelName": "Intermediate", "levelColor": "#FCA800", "defaultLevel": true } } ] } ] }

 

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request

 

Deletes team.

 

Request

1 DELETE /rest/api/1/team/$id?auth_token=YOUR_AUTH_TOKEN


QUERY PARAMETERS

Parameter

Type

Description

Parameter

Type

Description

id *

long

id of team

* indicates required parameters

Example

1 http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/2782591321647696504?auth_token=YOUR_AUTH_TOKEN

 

Responses


status 200 application/json Returns success message.
Example
1 2 3 { "message": "Team successfully deleted" }

 

status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request


status 200 application/json Returns success message.
Example
1 2 3 { "message": "Team successfully deleted" }

 

status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request

 

Add user to the team.


Request

1 POST /rest/api/1/team/$id/member?auth_token=YOUR_AUTH_TOKEN


QUERY PARAMETERS

Parameter

Type

Description

Parameter

Type

Description

id *

long

Id of team

username *

string

Username of user who will be added to the team

* indicates required parameters


Example

1 http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/2782591321647696504/member?auth_token=YOUR_AUTH_TOKEN&username=admin


Responses


status 200 application/json Returns success message.
Example
1 2 3 { 'message':'User successfully added to Team [BP] Business Project Team' }

 

status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request


status 200 application/json Returns success message.
Example
1 2 3 { 'message':'User successfully added to Team [BP] Business Project Team' }

 

status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request

 

Remove user from the team.


Request

1 DELETE /rest/api/1/team/$id/member?auth_token=YOUR_AUTH_TOKEN


QUERY PARAMETERS

Parameter

Type

Description

Parameter

Type

Description

id *

long

id of team

username *

string

Username of user who will be removed from the team

* indicates required parameters


Example

1 http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/2782591321647696504/member?auth_token=YOUR_AUTH_TOKEN&username=admin


Responses


status 200 application/json Returns success message.
Example
1 2 3 { 'message':'User successfully removed from Team [BP] Business Project Team' }

 

status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request


status 200 application/json Returns success message.
Example
1 2 3 { 'message':'User successfully removed from Team [BP] Business Project Team' }

 

status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request

 

Get the list of team managers.


Request

1 GET /rest/api/1/team/$id/manager?auth_token=YOUR_AUTH_TOKEN


QUERY PARAMETERS

Parameter

Type

Description

Parameter

Type

Description

id *

long

id of team

* indicates required parameters


Example

1 http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/2782591321647696504/manager?auth_token=YOUR_AUTH_TOKEN


Responses


status 200 application/json Returns success message.
Example
1 2 3 4 [{ "fullName": "Administrator", "username": "admin" }]

 

status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request


status 200 application/json Returns success message.
Example
1 2 3 4 [{ "fullName": "Administrator", "username": "admin" }]

 

status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request

 

Add team manager to the team.


Request

1 POST /rest/api/1/team/$id/manager?auth_token=YOUR_AUTH_TOKEN

 

QUERY PARAMETERS

Parameter

Type

Description

Parameter

Type

Description

id *

long

id of team

username *

string

Username of user who will be added to the team managers

* indicates required parameters


Example

1 http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/2782591321647696504/manager?auth_token=YOUR_AUTH_TOKEN&username=admin


Responses


status 200 application/json Returns success message.
Example
1 2 3 { "message": "User successfully added to Team Managers" }



status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request


status 200 application/json Returns success message.
Example
1 2 3 { "message": "User successfully added to Team Managers" }



status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request



 

Remove user from the team managers.

 

Request

1 DELETE /rest/api/1/team/$id/manager?auth_token=YOUR_AUTH_TOKEN

 

QUERY PARAMETERS

Parameter

Type

Description

Parameter

Type

Description

id *

long

id of team

username *

string

Username of user who will be removed from the team managers

* indicates required parameters


Example

1 http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/2782591321647696504/manager?auth_token=YOUR_AUTH_TOKEN&username=admin


Responses


status 200 application/json Returns success message.
Example
1 2 3 { "message": "User successfully removed from Team Managers." }

 

status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request


status 200 application/json Returns success message.
Example
1 2 3 { "message": "User successfully removed from Team Managers." }

 

status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request

 

 

Projects    v8.3.0+

Returns list of Activity Timeline projects by portions of 100.


Request

1 GET /rest/api/1/project/list?auth_token=YOUR_AUTH_TOKEN

 

QUERY PARAMETERS

Parameter

Type

Description

Parameter

Type

Description

startOffset

integer

Offset for the first project, default is 0

state v9.2.0+

string

If specified then only projects of specified state will be returned. Should be either "active" or "inactive"

* indicates required parameters


Responses

status 200 application/json Returns json representation of the result if request performed successfully.

Example
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 [{ "id": 230762418407883660, "name": "Sprint project", "projectKey": "SPRINT", "state": "inactive" }, { "id": 385656806786155406, "name": "Agile adaptation", "projectKey": "AGILE", "state": "active" }, { "id": 466697191147325533, "name": "New Features Proj", "projectKey": "NFP", "state": "active" }, { "id": 847848775082921846, "name": "Project Managment", "projectKey": "PM", "state": "active" }, { "id": 1074321572696248313, "name": "Automation Project", "projectKey": "AP", "state": "active" }, { "id": 1414612396227578312, "name": "Business Project ", "projectKey": "BP", "state": "active" }]

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request

status 200 application/json Returns json representation of the result if request performed successfully.

Example
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 [{ "id": 230762418407883660, "name": "Sprint project", "projectKey": "SPRINT", "state": "inactive" }, { "id": 385656806786155406, "name": "Agile adaptation", "projectKey": "AGILE", "state": "active" }, { "id": 466697191147325533, "name": "New Features Proj", "projectKey": "NFP", "state": "active" }, { "id": 847848775082921846, "name": "Project Managment", "projectKey": "PM", "state": "active" }, { "id": 1074321572696248313, "name": "Automation Project", "projectKey": "AP", "state": "active" }, { "id": 1414612396227578312, "name": "Business Project ", "projectKey": "BP", "state": "active" }]

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request

 

Change the project state between active (enabled in the app) and inactive (disabled in the app).


Request

1 POST /rest/api/1/project/$id/state?auth_token=YOUR_AUTH_TOKEN


QUERY PARAMETERS

Parameter

Type

Description

Parameter

Type

Description

id *

long

id of project

state *

string

Project state. Should be either "active" or "inactive"

* indicates required parameters

Example

1 http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/project/1074321572696248313/state?auth_token=YOUR_AUTH_TOKEN&state=inactive


Responses


status 200 application/json Returns success message.
Example
1 2 3 4 5 { "message": "Project successfully updated", "projectId": "1074321572696248313", "state": "inactive" }

 

status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request


status 200 application/json Returns success message.
Example
1 2 3 4 5 { "message": "Project successfully updated", "projectId": "1074321572696248313", "state": "inactive" }

 

status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request

 

 

Users    v8.3.0+

Get paginated user list. Returns 100 users.


Request

1 GET /rest/api/1/user?auth_token=YOUR_AUTH_TOKEN


QUERY PARAMETERS

Parameter

Type

Description

Parameter

Type

Description

startOffset *

string

Offset for first user, default is 0

* indicates required parameters


Example

1 http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user?auth_token=YOUR_AUTH_TOKEN


Responses


status 200 application/json Returns created event id and new assignee username.
Example
1 2 3 4 5 6 7 8 9 10 [{ "fullName": "Administrator", "username": "admin" }, { "fullName": "Anna Jons", "username": "anna" }, { "fullName": "Erik Plain", "username": "erik" }]

 

status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request


status 200 application/json Returns created event id and new assignee username.
Example
1 2 3 4 5 6 7 8 9 10 [{ "fullName": "Administrator", "username": "admin" }, { "fullName": "Anna Jons", "username": "anna" }, { "fullName": "Erik Plain", "username": "erik" }]

 

status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request

 

Get detailed user data.


Request

1 GET /rest/api/1/user/$username?auth_token=YOUR_AUTH_TOKEN


QUERY PARAMETERS

Parameter

Type

Description

Parameter

Type

Description

username *

string

Username or accountId of specific user

* indicates required parameters


Example

1 http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user/admin?auth_token=YOUR_AUTH_TOKEN

 

Responses


status 200 application/json Returns created event id and new assignee username.
Example
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 { "fullName": "Administrator", "position": { "id": 6343917500869986762, "positionDescription": null, "positionNameLong": "Developer" }, "skillLevels": [{ "level": { "defaultLevel": false, "id": 3239422491610663746, "levelColor": "#FCA800", "levelName": "Intermediate" }, "skill": { "id": "5038994036906348198", "skillName": "JAVA" } }], "username": "admin" }

 

status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request


status 200 application/json Returns created event id and new assignee username.
Example
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 { "fullName": "Administrator", "position": { "id": 6343917500869986762, "positionDescription": null, "positionNameLong": "Developer" }, "skillLevels": [{ "level": { "defaultLevel": false, "id": 3239422491610663746, "levelColor": "#FCA800", "levelName": "Intermediate" }, "skill": { "id": "5038994036906348198", "skillName": "JAVA" } }], "username": "admin" }

 

status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request

 

Get user's skills.

 

Request

1 GET /rest/api/1/user/$username/skill?auth_token=YOUR_AUTH_TOKEN


QUERY PARAMETERS

Parameter

Type

Description

Parameter

Type

Description

username *

string

Username or accountId of specific user

* indicates required parameters


Example

1 http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user/admin/skill?auth_token=YOUR_AUTH_TOKEN


Responses


status 200 application/json Returns created event id and new assignee username.
Example
1 2 3 4 5 6 7 8 9 10 11 12 [{ "level": { "defaultLevel": false, "id": 3239422491610663746, "levelColor": "#FCA800", "levelName": "Intermediate" }, "skill": { "id": "5038994036906348198", "skillName": "JAVA" } }]

 

status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request


status 200 application/json Returns created event id and new assignee username.
Example
1 2 3 4 5 6 7 8 9 10 11 12 [{ "level": { "defaultLevel": false, "id": 3239422491610663746, "levelColor": "#FCA800", "levelName": "Intermediate" }, "skill": { "id": "5038994036906348198", "skillName": "JAVA" } }]

 

status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request

 

Remove all skills from the user.


Request

1 DELETE /rest/api/1/user/$username/skill?auth_token=YOUR_AUTH_TOKEN


QUERY PARAMETERS

Parameter

Type

Description

Parameter

Type

Description

username *

string

Username or accountId of specific user

* indicates required parameters


Example

1 http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user/admin/skill?auth_token=YOUR_AUTH_TOKEN


Responses


status 200 application/json Returns created event id and new assignee username.
Example
1 2 3 4 { "message": "Skills successfully removed from user.", "username": "admin" }

 

status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request


status 200 application/json Returns created event id and new assignee username.
Example
1 2 3 4 { "message": "Skills successfully removed from user.", "username": "admin" }

 

status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request

 

Assign a skill to user.

 

Request

1 POST /rest/api/1/user/$username/skill/$skillId?auth_token=YOUR_AUTH_TOKEN


QUERY PARAMETERS

Parameter

Type

Description

Parameter

Type

Description

username *

string

Username or accountId of specific user

skillId

long

Skill ID

levelId

long

Level for assigned skill

* indicates required parameters


Example

1 http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user/admin/skill/356054081858522338?auth_token=YOUR_AUTH_TOKEN


Responses


status 200 application/json Returns created event id and new assignee username.
Example
1 2 3 4 5 { "message": "Skill successfully assigned to user.", "skillId": 356054081858522338, "username": "admin" }

 

status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request


status 200 application/json Returns created event id and new assignee username.
Example
1 2 3 4 5 { "message": "Skill successfully assigned to user.", "skillId": 356054081858522338, "username": "admin" }

 

status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request

 

Remove a skill from the user.


Request

1 DELETE /rest/api/1/user/$username/skill/$skillId?auth_token=YOUR_AUTH_TOKEN


QUERY PARAMETERS

Parameter

Type

Description

Parameter

Type

Description

username *

string

Username or accountId of specific user

skillId

long

Skill ID

* indicates required parameters


Example

1 http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user/admin/skill/356054081858522338?auth_token=YOUR_AUTH_TOKEN


Responses


status 200 application/json Returns created event id and new assignee username.
Example
1 2 3 4 { "message": "Skill successfully removed from user.", "username": "admin" }

 

status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request


status 200 application/json Returns created event id and new assignee username.
Example
1 2 3 4 { "message": "Skill successfully removed from user.", "username": "admin" }

 

status 400 Returns if incorrect input parameters were supplied

status 401 Returns if user was not logged in

status 403 Returns if user didn't have permissions

status 500 Returns if errors occurred during request

 

Add a position for the user.


Request

1 POST /rest/api/1/user/$username/position?auth_token=YOUR_AUTH_TOKEN


QUERY PARA