You can authorize into the REST API by specifying a unique Authorization Token in one of 4 supported ways:
Authorization Token can be generated at ActivityTimeline Configuration → AT REST API page. |
---|
|
GET /rest/api/1/timeline?auth_token=YOUR_AUTH_TOKEN |
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.
|
* indicates required parameters
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 |
|
---|
{ "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 } ] } ] } |
Returns if incorrect input parameters were supplied
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
|
GET /rest/api/1/timeline/$username?auth_token=YOUR_AUTH_TOKEN |
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
|
* indicates required parameters
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 |
|
---|
{ "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 }] } |
Returns if incorrect input parameters were supplied
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
|
GET /rest/api/1/workload?auth_token=YOUR_AUTH_TOKEN |
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 | |
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 Example:
|
* indicates required parameters
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 |
|
---|
{ "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 } ] } ] } |
Returns if incorrect input parameters were supplied
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
|
GET /rest/api/1/workload/$username?auth_token=YOUR_AUTH_TOKEN |
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 |
https://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/workload/admin?start=2020-07-01&end=2020-07-30&auth_token=YOUR_AUTH_TOKEN |
|
---|
{ "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" }] } |
Returns if incorrect input parameters were supplied
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
|
POST /rest/api/1/event?auth_token=YOUR_AUTH_TOKEN |
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 |
isApproved (optional) | string | If set to "true" then custom event will be created pre-approved. |
* indicates required parameters
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 |
|
---|
{ "users":["admin"], "message":"admin|||<b>Booking</b> has been successfully created for admin.", "result":true, "id":3728690601734324315 } |
Returns if incorrect input parameters were supplied
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
|
DELETE /rest/api/1/event/$id?auth_token=YOUR_AUTH_TOKEN |
Parameter | Type | Description |
---|---|---|
id * | long | id of custom event |
* indicates required parameters
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/event/312463?auth_token=YOUR_AUTH_TOKEN |
|
---|
{ "message":"Event has been successfully deleted!" } |
Returns if incorrect input parameters were supplied
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
|
GET /rest/api/1/eventType/list?auth_token=YOUR_AUTH_TOKEN |
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/eventType/list?auth_token=YOUR_AUTH_TOKEN |
|
---|
[ { "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 } ] |
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
Request
|
application/json Returns json representation of the result if request performed successfully. Example
Returns if user was not logged in Returns if user didn't have permissions Returns if errors occurred during request |
---|
|
GET /rest/api/1/team/$teamId?auth_token=YOUR_AUTH_TOKEN |
Parameter | Type | Description |
---|---|---|
teamId * | long | id of specific team |
* indicates required parameters
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/1107507732947945188?auth_token=YOUR_AUTH_TOKEN |
|
---|
{ "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 } } ] } ] } |
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
Request
|
Parameter | Type | Description |
---|---|---|
id * | long | id of team |
* indicates required parameters
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/2782591321647696504?auth_token=YOUR_AUTH_TOKEN |
|
---|
{ "message": "Team successfully deleted" } |
Returns if incorrect input parameters were supplied
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
|
POST /rest/api/1/team/$id/member?auth_token=YOUR_AUTH_TOKEN |
Parameter | Type | Description |
---|---|---|
id * | long | Id of team |
username * | string | Username of user who will be added to the team |
* indicates required parameters
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/2782591321647696504/member?auth_token=YOUR_AUTH_TOKEN&username=admin |
|
---|
{ 'message':'User successfully added to Team [BP] Business Project Team' } |
Returns if incorrect input parameters were supplied
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
|
DELETE /rest/api/1/team/$id/member?auth_token=YOUR_AUTH_TOKEN |
Parameter | Type | Description |
---|---|---|
id * | long | id of team |
username * | string | Username of user who will be removed from the team |
* indicates required parameters
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/2782591321647696504/member?auth_token=YOUR_AUTH_TOKEN&username=admin |
|
---|
{ 'message':'User successfully removed from Team [BP] Business Project Team' } |
Returns if incorrect input parameters were supplied
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
|
GET /rest/api/1/team/$id/manager?auth_token=YOUR_AUTH_TOKEN |
Parameter | Type | Description |
---|---|---|
id * | long | id of team |
* indicates required parameters
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/2782591321647696504/manager?auth_token=YOUR_AUTH_TOKEN |
|
---|
[{ "fullName": "Administrator", "username": "admin" }] |
Returns if incorrect input parameters were supplied
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
|
POST /rest/api/1/team/$id/manager?auth_token=YOUR_AUTH_TOKEN |
Parameter | Type | Description |
---|---|---|
id * | long | id of team |
username * | string | Username of user who will be added to the team managers |
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/2782591321647696504/manager?auth_token=YOUR_AUTH_TOKEN&username=admin |
|
---|
{ "message": "User successfully added to Team Managers" } |
Returns if incorrect input parameters were supplied
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
Request
QUERY PARAMETERS
* indicates required parameters
|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/2782591321647696504/manager?auth_token=YOUR_AUTH_TOKEN&username=admin |
|
---|
{ "message": "User successfully removed from Team Managers." } |
Returns if incorrect input parameters were supplied
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
|
GET /rest/api/1/project/list?auth_token=YOUR_AUTH_TOKEN |
Parameter | Type | Description |
---|---|---|
startOffset | integer | Offset for the first project, default is 0 |
state | string | If specified then only projects of specified state will be returned. Should be either "active" or "inactive" |
* indicates required parameters
application/json Returns json representation of the result if request performed successfully. Example
Returns if user was not logged in Returns if user didn't have permissions Returns if errors occurred during request |
---|
|
POST /rest/api/1/project/$id/state?auth_token=YOUR_AUTH_TOKEN |
Parameter | Type | Description |
---|---|---|
id * | long | id of project |
state * | string | Project state. Should be either "active" or "inactive" |
* indicates required parameters
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/project/1074321572696248313/state?auth_token=YOUR_AUTH_TOKEN&state=inactive |
|
---|
{ "message": "Project successfully updated", "projectId": "1074321572696248313", "state": "inactive" } |
Returns if incorrect input parameters were supplied
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
|
GET /rest/api/1/user?auth_token=YOUR_AUTH_TOKEN |
Parameter | Type | Description |
---|---|---|
startOffset * | string | Offset for first user, default is 0 |
* indicates required parameters
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user?auth_token=YOUR_AUTH_TOKEN |
|
---|
[{ "fullName": "Administrator", "username": "admin" }, { "fullName": "Anna Jons", "username": "anna" }, { "fullName": "Erik Plain", "username": "erik" }] |
Returns if incorrect input parameters were supplied
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
|
GET /rest/api/1/user/$username?auth_token=YOUR_AUTH_TOKEN |
Parameter | Type | Description |
---|---|---|
username * | string | Username or accountId of specific user |
* indicates required parameters
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user/admin?auth_token=YOUR_AUTH_TOKEN |
|
---|
{ "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" } |
Returns if incorrect input parameters were supplied
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
Request
|
Parameter | Type | Description |
---|---|---|
username * | string | Username or accountId of specific user |
* indicates required parameters
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user/admin/skill?auth_token=YOUR_AUTH_TOKEN |
|
---|
[{ "level": { "defaultLevel": false, "id": 3239422491610663746, "levelColor": "#FCA800", "levelName": "Intermediate" }, "skill": { "id": "5038994036906348198", "skillName": "JAVA" } }] |
Returns if incorrect input parameters were supplied
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
|
DELETE /rest/api/1/user/$username/skill?auth_token=YOUR_AUTH_TOKEN |
Parameter | Type | Description |
---|---|---|
username * | string | Username or accountId of specific user |
* indicates required parameters
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user/admin/skill?auth_token=YOUR_AUTH_TOKEN |
|
---|
{ "message": "Skills successfully removed from user.", "username": "admin" } |
Returns if incorrect input parameters were supplied
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
Request
|
Parameter | Type | Description |
---|---|---|
username * | string | Username or accountId of specific user |
skillId | long | Skill ID |
levelId | long | Level for assigned skill |
* indicates required parameters
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user/admin/skill/356054081858522338?auth_token=YOUR_AUTH_TOKEN |
|
---|
{ "message": "Skill successfully assigned to user.", "skillId": 356054081858522338, "username": "admin" } |
Returns if incorrect input parameters were supplied
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
|
DELETE /rest/api/1/user/$username/skill/$skillId?auth_token=YOUR_AUTH_TOKEN |
Parameter | Type | Description |
---|---|---|
username * | string | Username or accountId of specific user |
skillId | long | Skill ID |
* indicates required parameters
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user/admin/skill/356054081858522338?auth_token=YOUR_AUTH_TOKEN |
|
---|
{ "message": "Skill successfully removed from user.", "username": "admin" } |
Returns if incorrect input parameters were supplied
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
|
POST /rest/api/1/user/$username/position?auth_token=YOUR_AUTH_TOKEN |
Parameter | Type | Description |
---|---|---|
username * | string | Username or accountId of specific user |
positionId | long | Position D |
* indicates required parameters
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user/admin/position?positionId=8219751323950402194&auth_token=YOUR_AUTH_TOKEN |
|
---|
{ "message": "Position successfully assigned to user", "username": "admin", "positionId": 8219751323950402194 } |
Returns if incorrect input parameters were supplied
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
|
DELETE /rest/api/1/user/$username/position?auth_token=YOUR_AUTH_TOKEN |
Parameter | Type | Description |
---|---|---|
username * | string | Username or accountId of specific user |
positionId | long | Position Id |
* indicates required parameters
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user/admin/position?positionId=8219751323950402194&auth_token=YOUR_AUTH_TOKEN |
|
---|
{ "message": "Position successfully removed from user", "positionId": 8219751323950402194 } |
Returns if incorrect input parameters were supplied
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
Request
|
Parameter | Type | Description |
---|---|---|
name * | string | Skill name |
* indicates required parameters
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/skill?name=skillName&auth_token=YOUR_AUTH_TOKEN |
|
---|
{ "message": "Skill SKILL_NAME successfully created!", "skillId": 2217128537518329713 } |
Returns if incorrect input parameters were supplied
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
|
GET /rest/api/1/skill?auth_token=YOUR_AUTH_TOKEN |
Parameter | Type | Description |
---|---|---|
startOffset | int | Offset for the first skill, default is 0 |
* indicates required parameters
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/skill?startOffSet=0&auth_token=YOUR_AUTH_TOKEN |
|
---|
[{ "id": "356054081858522338", "skillName": "API" }, { "id": "2047937836421629992", "skillName": "JS" }, { "id": "2698045061671109178", "skillName": "CSS" }, { "id": "3109049378266500399", "skillName": "SQL" }, { "id": "5038994036906348198", "skillName": "JAVA" }] |
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
|
GET /rest/api/1/skill/$id?auth_token=YOUR_AUTH_TOKEN |
Parameter | Type | Description |
---|---|---|
id | long | Skill Id |
* indicates required parameters
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/skill/5038994036906348198?auth_token=YOUR_AUTH_TOKEN |
|
---|
[{ "level": { "id": 3239422491610663746, "levelName": "Intermediate" }, "skill": { "id": "5038994036906348198", "skillName": "JAVA" }, "users": [{ "fullName": "Administrator", "username": "admin" }, { "fullName": "Erik Jons", "username": "erik" }] }, { "level": { "id": 149100742758843112, "levelName": "Advanced" }, "skill": { "id": "5038994036906348198", "skillName": "JAVA" }, "users": [{ "fullName": "Ana Lee", "username": "anna" }] }] |
Returns if incorrect input parameters were supplied
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
|
Parameter | Type | Description |
---|---|---|
name * | string | Skill proficiency level name |
isDefault | boolean | Should it be the default proficiency level for new skills? |
color * | string | Level color to display (HEX format), without hash symbol |
* indicates required parameters
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/skill/level?name=Expert&color=FCA800&auth_token=YOUR_AUTH_TOKEN |
|
---|
{ "message": "Level Expert successfully created!", "levelId": 8468734445048317988 } |
Returns if incorrect input parameters were supplied
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
|
GET /rest/api/1/skill/level?auth_token=YOUR_AUTH_TOKEN |
Parameter | Type | Description |
---|---|---|
startOffset | int | Offset for the first level, default is 0 |
* indicates required parameters
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/skill/level?auth_token=YOUR_AUTH_TOKEN |
|
---|
[{ "defaultLevel": false, "id": 149100742758843112, "levelColor": "#419B28", "levelName": "Advanced" }, { "defaultLevel": false, "id": 2281499161498896296, "levelColor": "#03439C", "levelName": "Basic" }, { "defaultLevel": false, "id": 3239422491610663746, "levelColor": "#FCA800", "levelName": "Intermediate" }, { "defaultLevel": true, "id": 4033501717766817092, "levelColor": "#FCA800", "levelName": "Low" }, { "defaultLevel": null, "id": 8468734445048317988, "levelColor": "#FCA800", "levelName": "Expert" }] |
Returns if incorrect input parameters were supplied
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
|
POST /rest/api/1/position?auth_token=YOUR_AUTH_TOKEN |
Parameter | Type | Description |
---|---|---|
name * | string | User position name |
* indicates required parameters
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/position?name=Manager&auth_token=YOUR_AUTH_TOKEN |
|
---|
{ "message": "Position Manager successfully created!", "positionId": 3000053725301066422 } |
Returns if incorrect input parameters were supplied
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
|
GET /rest/api/1/position?auth_token=YOUR_AUTH_TOKEN |
Parameter | Type | Description |
---|---|---|
startOffset | int | Offset for the first position, default is 0 |
* indicates required parameters
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/position?auth_token=YOUR_AUTH_TOKEN |
|
---|
[{ "id": 3000053725301066422, "positionDescription": "", "positionNameLong": "Manager" }, { "id": 6265207833807701265, "positionDescription": "", "positionNameLong": "CEO" }, { "id": 6343917500869986762, "positionDescription": null, "positionNameLong": "Developer" }, { "id": 7828428543988420376, "positionDescription": null, "positionNameLong": "QA" }, { "id": 8219751323950402194, "positionDescription": "", "positionNameLong": "Tester" }] |
Returns if incorrect input parameters were supplied
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
|
GET /rest/api/1/position/$id?auth_token=YOUR_AUTH_TOKEN |
Parameter | Type | Description |
---|---|---|
id | long | Position ID |
* indicates required parameters
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/position/5038994036906348198?auth_token=YOUR_AUTH_TOKEN |
|
---|
{ "id": 6343917500869986762, "persons": [{ "fullName": "Administrator", "username": "admin" }], "positionDescription": null, "positionNameLong": "Developer" } |
Returns if incorrect input parameters were supplied
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
|
POST /rest/api/1/worklog?auth_token=YOUR_AUTH_TOKEN |
Parameter | Type | Description |
---|---|---|
date * | string | Date for a worklog in "yyyy-MM-ddTHH:mm:ss±hh:mm" format. |
username * | string | Username (Jira Server) or accountId (Jira Cloud) of the user who logs work hours |
issueKey * | string | issueKey of issue |
timeSpent * | string | The time spent working on the issue. |
comment | string | A comment for the worklog |
category | number | Worklog category id. Configurable in Default Billable (“0”) |
* indicates required parameters
https://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/worklog?username=Adam&date=2021-04-15%2001:14:00%20%2B0300&issueKey=KAN-175&timeSpent=1h&auth_token=YOUR_AUTH_TOKEN |
|
---|
{ "approved": false, "approvedBy": "", "category": 0, "comment": "worklog comment", "date": "2021-04-15T01:14:00.000+03:00", "issueId": 12597, "issueKey": "KAN-175", "projectKey": "KAN", "timeSpent": 3600, "username": "557058:af2f543d-d6f7-4abc-a673-12355112323", "worklogId": 11667 } |
Returns if incorrect input parameters were supplied
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
|
PUT /rest/api/1/worklog/$id?auth_token=YOUR_AUTH_TOKEN |
Parameter | Type | Description |
---|---|---|
id * | long | Worklog id |
date * | string | Log work date in "yyyy-MM-ddTHH:mm:ss±hh:mm" format. |
username * | string | Username (Jira Server) or accountId (Jira Cloud) of the user who updates worklog |
timeSpent * | string | The time spent working on the issue. |
comment | string | A comment for the worklog |
category | number | Worklog category. Default Billable (“0”) |
* indicates required parameters
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/worklog/11667?username=Adam&date=2021-04-15 01:14:00 %2B0300&issueKey=KAN-175&timeSpent=1h&auth_token=YOUR_AUTH_TOKEN |
|
---|
{ "approved": false, "approvedBy": "", "category": 0, "comment": "", "date": "2021-04-15T01:14:00.000+03:00", "issueId": 12597, "issueKey": "KAN-175", "projectKey": "KAN", "timeSpent": 3600, "username": "557058:af2f543d-d6f7-4abc-a673-12355112323", "worklogId": 11667 } |
Returns if incorrect input parameters were supplied
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
|
DELETE /rest/api/1/worklog/$id?auth_token=YOUR_AUTH_TOKEN |
Parameter | Type | Description |
---|---|---|
id * | long | id of worklog |
* indicates required parameters
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/worklog/312463?auth_token=YOUR_AUTH_TOKEN |
|
---|
{ "message":"Worklog has been successfully deleted!" } |
Returns if incorrect input parameters were supplied
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
|
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 Accountld of specific user. If specified then returns worklogs from specific user only. |
teamld | long | Id of specified team. If specified then returns worklogs from specified team members only. |
projectKey | string | Project Key of Jira project. If specified then returns worklogs from specific project only! |
startOffset | int | Offset for the first worklog, default is 0. |
category | byte | Worklog category. Default Billable (“0”). If specified then returns worklogs of specific category only. |
* indicates required parameters
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/worklog/list?start=2021-04-12&end=2021-04-20&auth_token=YOUR_AUTH_TOKEN |
|
---|
[{ "approved": false, "approvedBy": "", "category": 0, "comment": "", "date": "2021-04-13T03:14:00.000+03:00", "issueId": 12637, "issueKey": "BT-11", "projectKey": "BT", "timeSpent": 7200, "username": "557058:009e0ad2-70b5-4b95-862c-12355112323", "worklogId": 11649 }, { "approved": false, "approvedBy": "", "category": 0, "comment": "", "date": "2021-04-14T00:00:00.000+03:00", "issueId": 12637, "issueKey": "BT-11", "projectKey": "BT", "timeSpent": 7200, "username": "557058:009e0ad2-70b5-4b95-862c-12355112323", "worklogId": 11641 }, { "approved": false, "approvedBy": "", "category": 0, "comment": "", "date": "2021-04-14T00:00:00.000+03:00", "issueId": 12707, "issueKey": "KAN-259", "projectKey": "KAN", "timeSpent": 7200, "username": "557058:009e0ad2-70b5-4b95-862c-12355112323", "worklogId": 11639 }, { "approved": false, "approvedBy": "", "category": 0, "comment": "", "date": "2021-04-14T00:00:00.000+03:00", "issueId": 12637, "issueKey": "BT-11", "projectKey": "BT", "timeSpent": 7200, "username": "557058:009e0ad2-70b5-4b95-862c-12355112323", "worklogId": 11640 }] |
Returns if incorrect input parameters were supplied
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
|
GET /rest/api/1/worklog/categories?auth_token=YOUR_AUTH_TOKEN |
Example
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/worklog/categories?auth_token=YOUR_AUTH_TOKEN |
|
---|
[{ "active": true, "id": 1, "name": "Non-Billable" }, { "active": true, "id": 0, "name": "Billable" }] |
Returns if incorrect input parameters were supplied
Returns if user was not logged in
Returns if user didn't have permissions
Returns if errors occurred during request
Frequently Asked Question. Read more.
Helpful tips in our Blog.
Questions? Contacts Us.
Contact details for Solution partners.
Search doсumentation