...
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: REST API |
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:
| Code Block |
|---|
{
"description": "test description",
"name": "test name",
"colorIndex": 3
} |
Example response:
200 Successful operation:
| Code Block |
|---|
{
"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:
| Code Block |
|---|
{
// Errors that are not tied to any specific field.
"additionalErrors": [
{
"errorType": "JiraError" | "PeriodicLimit" | "PeriodicLoggablePeriod" | "PeriodicMaxHoursPerDay" | "TooManyDataForTimesheet" | "TooManyWorklogsToExport" | "NoActiveLicense" | "ManualUpgradeNeeded"
"extra": // A field holding additional information related to the error
}
],
// Error response data for fields.
"fieldErrors": [
{
"errorType": "Exceed" | "Invalid" | "InvalidByJira" | "InvalidFormat" | "LoggablePeriod" | "MaxHoursPerDay" | "Required" | "TooManyPeriodicIssues",
// An array of string arrays containing the problematic field names.
"paths": [
[
"string"
]
]
}
]
}
|
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: REST API |
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:
| Code Block |
|---|
{
"description": "test description",
"name": "test name",
"colorIndex": 3
} |
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:
| Code Block |
|---|
{
// Errors that are not tied to any specific field.
"additionalErrors": [
{
"errorType": "JiraError" | "PeriodicLimit" | "PeriodicLoggablePeriod" | "PeriodicMaxHoursPerDay" | "TooManyDataForTimesheet" | "TooManyWorklogsToExport" | "NoActiveLicense" | "ManualUpgradeNeeded"
"extra": // A field holding additional information related to the error
}
],
// Error response data for fields.
"fieldErrors": [
{
"errorType": "Exceed" | "Invalid" | "InvalidByJira" | "InvalidFormat" | "LoggablePeriod" | "MaxHoursPerDay" | "Required" | "TooManyPeriodicIssues",
// An array of string arrays containing the problematic field names.
"paths": [
[
"string"
]
]
}
]
}
|
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: REST API |
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:
| Code Block |
|---|
{
// Errors that are not tied to any specific field.
"additionalErrors": [
{
"errorType": "JiraError" | "PeriodicLimit" | "PeriodicLoggablePeriod" | "PeriodicMaxHoursPerDay" | "TooManyDataForTimesheet" | "TooManyWorklogsToExport" | "NoActiveLicense" | "ManualUpgradeNeeded"
"extra": // A field holding additional information related to the error
}
],
// Error response data for fields.
"fieldErrors": [
{
"errorType": "Exceed" | "Invalid" | "InvalidByJira" | "InvalidFormat" | "LoggablePeriod" | "MaxHoursPerDay" | "Required" | "TooManyPeriodicIssues",
// An array of string arrays containing the problematic field names.
"paths": [
[
"string"
]
]
}
]
}
|
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: REST API |
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:
| Code Block |
|---|
{
// Errors that are not tied to any specific field.
"additionalErrors": [
{
"errorType": "JiraError" | "PeriodicLimit" | "PeriodicLoggablePeriod" | "PeriodicMaxHoursPerDay" | "TooManyDataForTimesheet" | "TooManyWorklogsToExport" | "NoActiveLicense" | "ManualUpgradeNeeded"
"extra": // A field holding additional information related to the error
}
],
// Error response data for fields.
"fieldErrors": [
{
"errorType": "Exceed" | "Invalid" | "InvalidByJira" | "InvalidFormat" | "LoggablePeriod" | "MaxHoursPerDay" | "Required" | "TooManyPeriodicIssues",
// An array of string arrays containing the problematic field names.
"paths": [
[
"string"
]
]
}
]
}
|
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: REST API |
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:
| Code Block |
|---|
{
// Errors that are not tied to any specific field.
"additionalErrors": [
{
"errorType": "JiraError" | "PeriodicLimit" | "PeriodicLoggablePeriod" | "PeriodicMaxHoursPerDay" | "TooManyDataForTimesheet" | "TooManyWorklogsToExport" | "NoActiveLicense" | "ManualUpgradeNeeded"
"extra": // A field holding additional information related to the error
}
],
// Error response data for fields.
"fieldErrors": [
{
"errorType": "Exceed" | "Invalid" | "InvalidByJira" | "InvalidFormat" | "LoggablePeriod" | "MaxHoursPerDay" | "Required" | "TooManyPeriodicIssues",
// An array of string arrays containing the problematic field names.
"paths": [
[
"string"
]
]
}
]
}
|
479 The user does not have one of the necessary Timetracker permissions that can be set in the Global Settings.