Atlassian: Time tracking schemas
4 Atlassian schemas with complete fields and constraints.
← Time tracking operations · All schemas
Get all time tracking providers — response body — item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about the time tracking provider. |
key | JSON | Optional | |
key (anyOf 1) | string | Alternative | The key for the time tracking provider. For example, *JIRA*. |
key (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | The name of the time tracking provider. For example, *JIRA provided time tracking*. |
name (anyOf 2) | null | Alternative | |
url | JSON | Optional | |
url (anyOf 1) | string | Alternative | The URL of the configuration page for the time tracking provider app. For example, */example/config/url*. This property is only returned if the `adminPageKey` property is set in the module descriptor of the time tracking provider app. Read only: true |
url (anyOf 2) | null | Alternative |
Get time tracking settings — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the time tracking configuration. |
defaultUnit | JSON | Optional | |
defaultUnit (anyOf 1) | string | Alternative | The default unit of time applied to logged time. Known values: minute, hour, day, week |
defaultUnit (anyOf 2) | null | Alternative | |
timeFormat | JSON | Optional | |
timeFormat (anyOf 1) | string | Alternative | The format that will appear on an issue's *Time Spent* field. Known values: pretty, days, hours |
timeFormat (anyOf 2) | null | Alternative | |
workingDaysPerWeek | JSON | Optional | |
workingDaysPerWeek (anyOf 1) | JSON | Alternative | |
workingDaysPerWeek (anyOf 1) (anyOf 1) | number | Alternative | The number of days in a working week. Format: double |
workingDaysPerWeek (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
workingDaysPerWeek (anyOf 2) | null | Alternative | |
workingHoursPerDay | JSON | Optional | |
workingHoursPerDay (anyOf 1) | JSON | Alternative | |
workingHoursPerDay (anyOf 1) (anyOf 1) | number | Alternative | The number of hours in a working day. Format: double |
workingHoursPerDay (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
workingHoursPerDay (anyOf 2) | null | Alternative |
Select time tracking provider — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details about the time tracking provider. Additional keys: not allowed |
key | string | Required within parent | The key for the time tracking provider. For example, *JIRA*. |
name | string | Optional | The name of the time tracking provider. For example, *JIRA provided time tracking*. |
url | string | Optional | The URL of the configuration page for the time tracking provider app. For example, */example/config/url*. This property is only returned if the `adminPageKey` property is set in the module descriptor of the time tracking provider app. Read only: true |
Set time tracking settings — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the time tracking configuration. Additional keys: not allowed |
defaultUnit | string | Required within parent | The default unit of time applied to logged time. One of: minute, hour, day, week |
timeFormat | string | Required within parent | The format that will appear on an issue's *Time Spent* field. One of: pretty, days, hours |
workingDaysPerWeek | number | Required within parent | The number of days in a working week. Format: double |
workingHoursPerDay | number | Required within parent | The number of hours in a working day. Format: double |