Authorization
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. |
---|
Methods:
Timeline Schedule & Workload
Status | ||||
---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
GET /rest/api/1/timeline?auth_token=YOUR_AUTH_TOKEN |
QUERY PARAMETERS
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
Example
Code Block |
---|
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
Example
|
---|
Expand | ||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||
|
Code Block |
---|
GET /rest/api/1/timeline/$username?auth_token=YOUR_AUTH_TOKEN |
QUERY PARAMETERS
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
Example
Code Block |
---|
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
Info |
---|
Returns information about users and workloads for specified team for specified period of time. |
Code Block |
---|
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
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:
Code Block |
---|
"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
Code Block |
---|
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 |
Status | ||||
---|---|---|---|---|
|
Example
Example
|
---|
title | GET /rest/api/1/workload?auth_token=YOUR_AUTH_TOKEN |
---|
|
---|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
GET /rest/api/1/workload?auth_token=YOUR_AUTH_TOKEN |
QUERY PARAMETERS
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
Example
Code Block |
---|
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
Example
|
---|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
GET /rest/api/1/workload/$username?auth_token=YOUR_AUTH_TOKEN |
QUERY PARAMETERS
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
Code Block |
---|
https://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/workload/admin?start=2020-07-01&end=2020-07-30&auth_token=YOUR_AUTH_TOKEN |
Responses
Example
|
---|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
GET /rest/api/1/availability?auth_token=YOUR_AUTH_TOKEN |
QUERY PARAMETERS
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 |
startOffset | int | Offset for first users, default is 0 |
maxUsers | int | Maximum users count to return, max 50 |
* indicates required parameters
Example
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/availability?start=2023-02-11&end=2023-02-18&teamId=5648895637201243664&startOffset=0&maxUsers=50&auth_token=YOUR_AUTH_TOKEN |
Responses
Example
|
---|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
GET rest/api/1/availability/$username?auth_token==YOUR_AUTH_TOKEN |
QUERY PARAMETERS
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 |
* indicates required parameters
Example
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/availability/63c83eb49d59ec705dddddd?start=2023-02-11&end=2023-02-18&auth_token=YOUR_AUTH_TOKEN |
Responses
Example
|
---|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
GET /rest/api/1/capacity?auth_token=YOUR_AUTH_TOKEN |
QUERY PARAMETERS
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 |
startOffset | int | Offset for first users, default is 0 |
maxUsers | int | Maximum users count to return, max 50 |
* indicates required parameters
Example
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/capacity?start=2023-02-11&end=2023-02-18&teamId=5648895637201243664&startOffset=0&maxUsers=50&auth_token=YOUR_AUTH_TOKEN |
Responses
Example
|
---|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
GET rest/api/1/capacity/$username?auth_token==YOUR_AUTH_TOKEN |
QUERY PARAMETERS
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 |
* indicates required parameters
Example
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/capacity/63c83eb49d59ec705dddddd?start=2023-02-11&end=2023-02-18&auth_token=YOUR_AUTH_TOKEN |
Responses
Example
|
---|
Custom events
Status | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
POST /rest/api/1/event?auth_token=YOUR_AUTH_TOKEN |
QUERY PARAMETERS
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
Example
Code Block |
---|
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
Example
|
---|
Expand | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
GET /rest/api/1/event/$id?auth_token=YOUR_AUTH_TOKEN |
QUERY PARAMETERS
Parameter | Type | Description |
---|---|---|
id * | number | ID of custom event |
* indicates required parameters
Example
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/event/29686068180042429?auth_token=YOUR_AUTH_TOKEN |
Responses
Example
|
---|
Expand | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
DELETE /rest/api/1/event/$id?auth_token=YOUR_AUTH_TOKEN |
QUERY PARAMETERS
Parameter | Type | Description |
---|---|---|
id * | long | id of custom event |
* indicates required parameters
Example
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/event/312463?auth_token=YOUR_AUTH_TOKEN |
Responses
Example
|
---|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
POST /rest/api/1/event/$id/color?auth_token=YOUR_AUTH_TOKEN |
QUERY PARAMETERS
Parameter | Type | Description |
---|---|---|
id * | long | id of custom event |
color * | string | color of the event to be set. |
* indicates required parameters
Example
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/event/312463534535435/color?auth_token=YOUR_AUTH_TOKEN |
Responses
Example
|
---|
Expand | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||
|
Code Block |
---|
GET /rest/api/1/eventType/list?auth_token=YOUR_AUTH_TOKEN |
Example
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/eventType/list?auth_token=YOUR_AUTH_TOKEN |
Responses
Example
|
---|
Teams
Status | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||
Request
|
Example
|
---|
Expand | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
GET /rest/api/1/team/$teamId?auth_token=YOUR_AUTH_TOKEN |
QUERY PARAMETERS
Parameter | Type | Description |
---|---|---|
teamId * | long | id of specific team |
* indicates required parameters
Example
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/1107507732947945188?auth_token=YOUR_AUTH_TOKEN |
Responses
Example
|
---|
Expand | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||
Request
|
Parameter | Type | Description |
---|---|---|
id * | long | id of team |
* indicates required parameters
Example
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/2782591321647696504?auth_token=YOUR_AUTH_TOKEN |
Responses
Example
|
---|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
POST /rest/api/1/team/$id/member?auth_token=YOUR_AUTH_TOKEN |
QUERY PARAMETERS
Parameter | Type | Description |
---|---|---|
id * | long | Id of team |
username * | string | Username of user who will be added to the team |
* indicates required parameters
Example
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/2782591321647696504/member?auth_token=YOUR_AUTH_TOKEN&username=admin |
Responses
Example
|
---|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
DELETE /rest/api/1/team/$id/member?auth_token=YOUR_AUTH_TOKEN |
QUERY PARAMETERS
Parameter | Type | Description |
---|---|---|
id * | long | id of team |
username * | string | Username of user who will be removed from the team |
* indicates required parameters
Example
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/2782591321647696504/member?auth_token=YOUR_AUTH_TOKEN&username=admin |
Responses
Example
|
---|
Expand | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
GET /rest/api/1/team/$id/manager?auth_token=YOUR_AUTH_TOKEN |
QUERY PARAMETERS
Parameter | Type | Description |
---|---|---|
id * | long | id of team |
* indicates required parameters
Example
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/2782591321647696504/manager?auth_token=YOUR_AUTH_TOKEN |
Responses
Example
|
---|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
POST /rest/api/1/team/$id/manager?auth_token=YOUR_AUTH_TOKEN |
QUERY PARAMETERS
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
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/2782591321647696504/manager?auth_token=YOUR_AUTH_TOKEN&username=admin |
Responses
Example
|
---|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||
Request
QUERY PARAMETERS
* indicates required parameters
|
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/team/2782591321647696504/manager?auth_token=YOUR_AUTH_TOKEN&username=admin |
Responses
Example
|
---|
Projects
Status | ||||
---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
GET /rest/api/1/project/list?auth_token=YOUR_AUTH_TOKEN |
QUERY PARAMETERS
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
Responses
Example
|
---|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
POST /rest/api/1/project/$id/state?auth_token=YOUR_AUTH_TOKEN |
QUERY PARAMETERS
Parameter | Type | Description |
---|---|---|
id * | long | id of project |
state * | string | Project state. Should be either "active" or "inactive" |
* indicates required parameters
Example
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/project/1074321572696248313/state?auth_token=YOUR_AUTH_TOKEN&state=inactive |
Responses
Example
|
---|
Users
Status | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
GET /rest/api/1/user?auth_token=YOUR_AUTH_TOKEN |
QUERY PARAMETERS
Parameter | Type | Description |
---|---|---|
startOffset * | string | Offset for first user, default is 0 |
* indicates required parameters
Example
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user?auth_token=YOUR_AUTH_TOKEN |
Responses
Example
|
---|
Expand | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
GET /rest/api/1/user/$username?auth_token=YOUR_AUTH_TOKEN |
QUERY PARAMETERS
Parameter | Type | Description |
---|---|---|
username * | string | Username or accountId of specific user |
* indicates required parameters
Example
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user/admin?auth_token=YOUR_AUTH_TOKEN |
Responses
Example
|
---|
Expand | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||
Request
|
Parameter | Type | Description |
---|---|---|
username * | string | Username or accountId of specific user |
* indicates required parameters
Example
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user/admin/skill?auth_token=YOUR_AUTH_TOKEN |
Responses
Example
|
---|
Expand | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
DELETE /rest/api/1/user/$username/skill?auth_token=YOUR_AUTH_TOKEN |
QUERY PARAMETERS
Parameter | Type | Description |
---|---|---|
username * | string | Username or accountId of specific user |
* indicates required parameters
Example
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user/admin/skill?auth_token=YOUR_AUTH_TOKEN |
Responses
Example
|
---|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||
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
Example
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user/admin/skill/356054081858522338?auth_token=YOUR_AUTH_TOKEN |
Responses
Example
|
---|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
DELETE /rest/api/1/user/$username/skill/$skillId?auth_token=YOUR_AUTH_TOKEN |
QUERY PARAMETERS
Parameter | Type | Description |
---|---|---|
username * | string | Username or accountId of specific user |
skillId | long | Skill ID |
* indicates required parameters
Example
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user/admin/skill/356054081858522338?auth_token=YOUR_AUTH_TOKEN |
Responses
Example
|
---|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
POST /rest/api/1/user/$username/position?auth_token=YOUR_AUTH_TOKEN |
QUERY PARAMETERS
Parameter | Type | Description |
---|---|---|
username * | string | Username or accountId of specific user |
positionId | long | Position D |
* indicates required parameters
Example
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user/admin/position?positionId=8219751323950402194&auth_token=YOUR_AUTH_TOKEN |
Responses
Example
|
---|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
DELETE /rest/api/1/user/$username/position?auth_token=YOUR_AUTH_TOKEN |
QUERY PARAMETERS
Parameter | Type | Description |
---|---|---|
username * | string | Username or accountId of specific user |
positionId | long | Position Id |
* indicates required parameters
Example
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/user/admin/position?positionId=8219751323950402194&auth_token=YOUR_AUTH_TOKEN |
Responses
Example
|
---|
Skills
Status | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||
Request
|
Parameter | Type | Description |
---|---|---|
name * | string | Skill name |
* indicates required parameters
Example
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/skill?name=skillName&auth_token=YOUR_AUTH_TOKEN |
Responses
Example
|
---|
Expand | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
GET /rest/api/1/skill?auth_token=YOUR_AUTH_TOKEN |
QUERY PARAMETERS
Parameter | Type | Description |
---|---|---|
startOffset | int | Offset for the first skill, default is 0 |
* indicates required parameters
Example
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/skill?startOffSet=0&auth_token=YOUR_AUTH_TOKEN |
Responses
Example
|
---|
Expand | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
GET /rest/api/1/skill/$id?auth_token=YOUR_AUTH_TOKEN |
QUERY PARAMETERS
Parameter | Type | Description |
---|---|---|
id | long | Skill Id |
* indicates required parameters
Example
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/skill/5038994036906348198?auth_token=YOUR_AUTH_TOKEN |
Responses
Example
|
---|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||
|
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
Example
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/skill/level?name=Expert&color=FCA800&auth_token=YOUR_AUTH_TOKEN |
Responses
Example
|
---|
Expand | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
GET /rest/api/1/skill/level?auth_token=YOUR_AUTH_TOKEN |
QUERY PARAMETERS
Parameter | Type | Description |
---|---|---|
startOffset | int | Offset for the first level, default is 0 |
* indicates required parameters
Example
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/skill/level?auth_token=YOUR_AUTH_TOKEN |
Responses
Example
|
---|
Positions
Status | ||||
---|---|---|---|---|
|
Expand | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
POST /rest/api/1/position?auth_token=YOUR_AUTH_TOKEN |
QUERY PARAMETERS
Parameter | Type | Description |
---|---|---|
name * | string | User position name |
* indicates required parameters
Example
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/position?name=Manager&auth_token=YOUR_AUTH_TOKEN |
Responses
Example
|
---|
Expand | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
GET /rest/api/1/position?auth_token=YOUR_AUTH_TOKEN |
QUERY PARAMETERS
Parameter | Type | Description |
---|---|---|
startOffset | int | Offset for the first position, default is 0 |
* indicates required parameters
Example
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/position?auth_token=YOUR_AUTH_TOKEN |
Responses
Example
|
---|
Expand | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
GET /rest/api/1/position/$id?auth_token=YOUR_AUTH_TOKEN |
QUERY PARAMETERS
Parameter | Type | Description |
---|---|---|
id | long | Position ID |
* indicates required parameters
Example
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/position/5038994036906348198?auth_token=YOUR_AUTH_TOKEN |
Responses
Example
|
---|
Worklogs
Status | ||||
---|---|---|---|---|
|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
POST /rest/api/1/worklog?auth_token=YOUR_AUTH_TOKEN |
QUERY PARAMETERS
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
Example
Code Block |
---|
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 |
Responses
Example
|
---|
Expand | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
PUT /rest/api/1/worklog/$id?auth_token=YOUR_AUTH_TOKEN |
QUERY PARAMETERS
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
Example
Code Block |
---|
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 |
Responses
Example
|
---|
Expand | |||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
DELETE /rest/api/1/worklog/$id?auth_token=YOUR_AUTH_TOKEN |
QUERY PARAMETERS
Parameter | Type | Description |
---|---|---|
id * | long | id of worklog |
* indicates required parameters
Example
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/worklog/312463?auth_token=YOUR_AUTH_TOKEN |
Responses
Example
|
---|
Expand | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
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
Example
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/worklog/list?start=2021-04-12&end=2021-04-20&auth_token=YOUR_AUTH_TOKEN |
Responses
Example
|
---|
Expand | |||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||||||||||||
|
Code Block |
---|
GET /rest/api/1/worklog/categories?auth_token=YOUR_AUTH_TOKEN |
Example
Code Block |
---|
http://<ACTIVITYTIMELINE_INSTANCE>/rest/api/1/worklog/categories?auth_token=YOUR_AUTH_TOKEN |
Responses
Example
|
---|
Frequently Asked Question. Read more.
📰 Helpful tips in our Blog.
📬 Questions? Contacts Us.
🤝 Contact details for Solution partners.
Search doсumentation
Live Search | ||||
---|---|---|---|---|
|