This Confluence Space is no longer updated. If you want to read the most up-to-date documentation of Timetracker Cloud, click here: https://docs.everit.biz
Tags API
- 1 Get tags GET /tag
- 2 Examples
- 3 Create tag POST /tag
- 3.1 Header parameters
- 3.2 Body
- 4 Examples
- 5 Update tag PUT /tag/{worklogTagId}
- 5.1 Header parameters
- 5.2 Path variables
- 5.3 Body
- 6 Examples
- 7 Delete tag DELETE /tag/{worklogTagId}
- 7.1 Header parameters
- 7.2 Path variables
- 8 Examples
- 9 Archive tag POST /tag/{worklogTagId}/archive
- 9.1 Header parameters
- 9.2 Path variables
- 9.3 Body
- 10 Examples
- 11 Restore tag POST /tag/{worklogTagId}/restore
- 11.1 Header parameters
- 11.2 Path variables
- 11.3 Body
- 12 Examples
Get information about the configured Tags and their current status.
All requests need to be made to this base URL:
https://jttp-cloud.everit.biz/timetracker/api/latest/public
Get tags GET /tag
Header parameters
Query Parameters
The available query parameters for the request:
Query Parameter | Value type | Optional | Description |
|---|---|---|---|
archived | boolean | true | Filter the tags based on the archived status. If this parameter is not provided all tags will be returned. Example: /public/tag?archived=true |
Examples
GET URL: TIME_TRACKER_BASE_URL/timetracker/api/latest/public/tag
Example response:
200 Successful operation:
{
"worklogTags": [
{
"archived": false,
"colorIndex": null,
"description": "Development activities.",
"id": 1,
"name": "development"
},
{
"archived": false,
"colorIndex": null,
"description": "Testing activities.",
"id": 2,
"name": "testing"
},
{
"archived": false,
"colorIndex": null,
"description": "Support activities.",
"id": 3,
"name": "support"
},
{
"archived": false,
"colorIndex": null,
"description": "Meeting activities.",
"id": 4,
"name": "meeting"
},
{
"archived": false,
"colorIndex": 9,
"description": "Administration activities.",
"id": 5,
"name": "administration"
}
]
}401 Unauthorized
479 The user does not have one of the necessary Timetracker permissions that can be set in the Global Settings.
Create tag POST /tag
Header parameters
Header Parameter | Optional | Description |
|---|---|---|
x-everit-jwt | false | JWT token, see: https://everit.atlassian.net/wiki/spaces/TCDL/pages/3461578779 |
x-requested-by | false | CSRF protection parameter. |
Body
The POST body is a JSON object: WorklogTagRequest
The available fields of the WorklogTagRequest:
Parameter | Value type | Optional | Description |
|---|---|---|---|
name | string | false | The name of the worklog tag. Example: “name”: “test name“ |
description | string | false | The description of the worklog tag. Example: “description”: “test description“ |
colorIndex | number | true | The index of the selected color. Null, if the default color is used. Example: “colorIndex”: 1 |
Examples
POST URL: TIME_TRACKER_BASE_URL/timetracker/api/latest/public/tag
Example post body:
{
"description": "test description",
"name": "test name",
"colorIndex": 3
}Example response:
200 Successful operation:
{
"archived": false,
"colorIndex": 3,
"description": "test description",
"id": 21,
"name": "test name"
}401 Unauthorized
400 Invalid parameters:
An object that holds all field and non-field related errors:
479 The user does not have one of the necessary Timetracker permissions that can be set in the Global Settings.
Update tag PUT /tag/{worklogTagId}
Header parameters
Header Parameter | Optional | Description |
|---|---|---|
x-everit-jwt | false | JWT token, see: https://everit.atlassian.net/wiki/spaces/TCDL/pages/3461578779 |
x-requested-by | false | CSRF protection parameter. |
Path variables
The available path variables for the request:
Path Variable | Value type | Optional | Description |
|---|---|---|---|
worklogTagId | number | false | The ID of the worklog tag. Example: /public/tag/19 |
Body
The POST body is a JSON object: WorklogTagRequest
The available fields of the WorklogTagRequest:
Parameter | Value type | Optional | Description |
|---|---|---|---|
name | string | false | The name of the worklog tag. Example: “name”: “test name“ |
description | string | false | The description of the worklog tag. Example: “description”: “test description“ |
colorIndex | number | true | The index of the selected color. If not provided or the value is null the default color will be used. Example: “colorIndex”: 1 |
Examples
PUT URL: TIME_TRACKER_BASE_URL/timetracker/api/latest/public/tag/19
Example post body:
Example response:
204 Successful operation.
401 Unauthorized
404 Not found tag.
400 Invalid parameters:
An object that holds all field and non-field related errors:
479 The user does not have one of the necessary Timetracker permissions that can be set in the Global Settings.
Delete tag DELETE /tag/{worklogTagId}
Header parameters
Header Parameter | Optional | Description |
|---|---|---|
x-everit-jwt | false | JWT token, see: |
x-requested-by | false | CSRF protection parameter. |
Path variables
The available path variables for the request:
Path Variable | Value type | Optional | Description |
|---|---|---|---|
worklogTagId | number | false | The ID of the worklog tag. Example: /public/tag/19 |
Examples
DELETE URL: TIME_TRACKER_BASE_URL/timetracker/api/latest/public/tag/19
204 Successful operation.
401 Unauthorized
400 Invalid parameters:
An object that holds all field and non-field related errors:
479 The user does not have one of the necessary Timetracker permissions that can be set in the Global Settings.
Archive tag POST /tag/{worklogTagId}/archive
Header parameters
Header Parameter | Optional | Description |
|---|---|---|
x-everit-jwt | false | JWT token, see: |
x-requested-by | false | CSRF protection parameter. |
Path variables
The available path variables for the request:
Path Variable | Value type | Optional | Description |
|---|---|---|---|
worklogTagId | number | false | The ID of the worklog tag. Example: /public/tag/19/archive |
Body
POST body is not needed.
Examples
POST URL: TIME_TRACKER_BASE_URL/timetracker/api/latest/public/tag/19/archive
Example response:
204 Successful operation.
401 Unauthorized
404 Not found tag.
400 Invalid parameters:
An object that holds all field and non-field related errors:
479 The user does not have one of the necessary Timetracker permissions that can be set in the Global Settings.
Restore tag POST /tag/{worklogTagId}/restore
Header parameters
Header Parameter | Optional | Description |
|---|---|---|
x-everit-jwt | false | JWT token, see: |
x-requested-by | false | CSRF protection parameter. |
Path variables
The available path variables for the request:
Path Variable | Value type | Optional | Description |
|---|---|---|---|
worklogTagId | number | false | The ID of the worklog tag. Example: /public/tag/19/restore |
Body
POST body is not needed.
Examples
POST URL: TIME_TRACKER_BASE_URL/timetracker/api/latest/public/tag/19/restore
Example response:
204 Successful operation.
401 Unauthorized
404 Not found tag.
400 Invalid parameters:
An object that holds all field and non-field related errors:
479 The user does not have one of the necessary Timetracker permissions that can be set in the Global Settings.