Atlassian: Issue worklogs schemas

7 Atlassian schemas with complete fields and constraints.

← Issue worklogs operations · All schemas

Add worklog — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of a worklog. Additional keys: allowed
`author`	Model	Optional	Expand Add comment — request body — body author Details of the user who created the worklog. Read only: true
`comment`	JSON	Optional	A comment about the worklog in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/). Optional when creating or updating a worklog.
`created`	string	Optional	The datetime on which the worklog was created. Format: date-time Read only: true
`id`	string	Optional	The ID of the worklog record. Read only: true
`issueId`	string	Optional	The ID of the issue this worklog is for. Read only: true
`properties`	array	Optional	Details of properties for the worklog. Optional when creating or updating a worklog.
`properties[]`	Model	Each item	Expand Edit issue — request body — body properties item
`self`	string	Optional	The URL of the worklog item. Format: uri Read only: true
`started`	string	Optional	The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog. Format: date-time
`timeSpent`	string	Optional	The time spent working on the issue as days (\#d), hours (\#h), or minutes (\#m or \#). Required when creating a worklog if `timeSpentSeconds` isn't provided. Optional when updating a worklog. Cannot be provided if `timeSpentSecond` is provided.
`timeSpentSeconds`	integer	Optional	The time in seconds spent working on the issue. Required when creating a worklog if `timeSpent` isn't provided. Optional when updating a worklog. Cannot be provided if `timeSpent` is provided. Format: int64
`updateAuthor`	Model	Optional	Expand Add comment — request body — body author Details of the user who last updated the worklog. Read only: true
`updated`	string	Optional	The datetime on which the worklog was last updated. Format: date-time Read only: true
`visibility`	Model	Optional	Expand Add comment — request body — body visibility Details about any restrictions in the visibility of the worklog. Optional when creating or updating a worklog.

Referenced models: Edit issue — request body — body properties item, Add comment — request body — body author, Add comment — request body — body visibility

Add worklog — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of a worklog. Additional keys: allowed
`author`	JSON	Optional
`author (anyOf 1)`	Model	Alternative	Expand Add comment — response body — author account Id, account Type, active, avatar Urls, display Name, email Address, key, name, self, time Zone Details of the user who created the worklog. Read only: true
`author (anyOf 2)`	null	Alternative
`comment`	JSON	Optional
`comment (anyOf 1)`	JSON	Alternative	A comment about the worklog in [Atlassian Document Format](https://developer.atlassian.com/cloud/jira/platform/apis/document/structure/). Optional when creating or updating a worklog.
`comment (anyOf 2)`	null	Alternative
`created`	JSON	Optional
`created (anyOf 1)`	JSON	Alternative
`created (anyOf 1) (anyOf 1)`	string	Alternative	The datetime on which the worklog was created. Read only: true
`created (anyOf 1) (anyOf 2)`	integer	Alternative
`created (anyOf 2)`	null	Alternative
`id`	JSON	Optional
`id (anyOf 1)`	string	Alternative	The ID of the worklog record. Read only: true
`id (anyOf 2)`	null	Alternative
`issueId`	JSON	Optional
`issueId (anyOf 1)`	string	Alternative	The ID of the issue this worklog is for. Read only: true
`issueId (anyOf 2)`	null	Alternative
`properties`	JSON	Optional
`properties (anyOf 1)`	array	Alternative	Details of properties for the worklog. Optional when creating or updating a worklog.
`properties (anyOf 1)[]`	Model	Each item	Expand Get user property — response body
`properties (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL of the worklog item. Format: uri Read only: true
`self (anyOf 2)`	null	Alternative
`started`	JSON	Optional
`started (anyOf 1)`	JSON	Alternative
`started (anyOf 1) (anyOf 1)`	string	Alternative	The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog.
`started (anyOf 1) (anyOf 2)`	integer	Alternative
`started (anyOf 2)`	null	Alternative
`timeSpent`	JSON	Optional
`timeSpent (anyOf 1)`	string	Alternative	The time spent working on the issue as days (\#d), hours (\#h), or minutes (\#m or \#). Required when creating a worklog if `timeSpentSeconds` isn't provided. Optional when updating a worklog. Cannot be provided if `timeSpentSecond` is provided.
`timeSpent (anyOf 2)`	null	Alternative
`timeSpentSeconds`	JSON	Optional
`timeSpentSeconds (anyOf 1)`	JSON	Alternative
`timeSpentSeconds (anyOf 1) (anyOf 1)`	integer	Alternative	The time in seconds spent working on the issue. Required when creating a worklog if `timeSpent` isn't provided. Optional when updating a worklog. Cannot be provided if `timeSpent` is provided. Format: int64
`timeSpentSeconds (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`timeSpentSeconds (anyOf 2)`	null	Alternative
`updateAuthor`	JSON	Optional
`updateAuthor (anyOf 1)`	Model	Alternative	Expand Add comment — response body — author account Id, account Type, active, avatar Urls, display Name, email Address, key, name, self, time Zone Details of the user who last updated the worklog. Read only: true
`updateAuthor (anyOf 2)`	null	Alternative
`updated`	JSON	Optional
`updated (anyOf 1)`	JSON	Alternative
`updated (anyOf 1) (anyOf 1)`	string	Alternative	The datetime on which the worklog was last updated. Read only: true
`updated (anyOf 1) (anyOf 2)`	integer	Alternative
`updated (anyOf 2)`	null	Alternative
`visibility`	JSON	Optional
`visibility (anyOf 1)`	Model	Alternative	Expand Add comment — response body — visibility The group or role to which this item is visible Details about any restrictions in the visibility of the worklog. Optional when creating or updating a worklog.
`visibility (anyOf 2)`	null	Alternative

Referenced models: Get user property — response body, Add comment — response body — author account Id, account Type, active, avatar Urls, display Name, email Address, key, name, self, time Zone, Add comment — response body — visibility The group or role to which this item is visible

Bulk move worklogs — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`ids`	array	Optional	A list of worklog IDs. Unique items: true
`ids[]`	integer	Each item	Format: int64
`issueIdOrKey`	string	Optional	The issue id or key of the destination issue

Get I Ds of deleted worklogs — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	List of changed worklogs.
`lastPage`	JSON	Optional
`lastPage (anyOf 1)`	boolean	Alternative
`lastPage (anyOf 2)`	null	Alternative
`nextPage`	JSON	Optional
`nextPage (anyOf 1)`	string	Alternative	The URL of the next list of changed worklogs. Format: uri Read only: true
`nextPage (anyOf 2)`	null	Alternative
`self`	JSON	Optional
`self (anyOf 1)`	string	Alternative	The URL of this changed worklogs list. Format: uri Read only: true
`self (anyOf 2)`	null	Alternative
`since`	JSON	Optional
`since (anyOf 1)`	JSON	Alternative
`since (anyOf 1) (anyOf 1)`	integer	Alternative	The datetime of the first worklog item in the list. Format: int64 Read only: true
`since (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`since (anyOf 2)`	null	Alternative
`until`	JSON	Optional
`until (anyOf 1)`	JSON	Alternative
`until (anyOf 1) (anyOf 1)`	integer	Alternative	The datetime of the last worklog item in the list. Format: int64 Read only: true
`until (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`until (anyOf 2)`	null	Alternative
`values`	JSON	Optional
`values (anyOf 1)`	array	Alternative	Changed worklog list. Read only: true
`values (anyOf 1)[]`	Model	Each item	Expand Get I Ds of deleted worklogs — response body — values Changed worklog list item
`values (anyOf 2)`	null	Alternative

Referenced models: Get I Ds of deleted worklogs — response body — values Changed worklog list item

Get I Ds of deleted worklogs — response body — values Changed worklog list item

Field	Type	Presence	Description and constraints
`$`	object	Root	Details of a changed worklog.
`properties`	JSON	Optional
`properties (anyOf 1)`	array	Alternative	Details of properties associated with the change. Read only: true
`properties (anyOf 1)[]`	Model	Each item	Expand Get user property — response body
`properties (anyOf 2)`	null	Alternative
`updatedTime`	JSON	Optional
`updatedTime (anyOf 1)`	JSON	Alternative
`updatedTime (anyOf 1) (anyOf 1)`	integer	Alternative	The datetime of the change. Format: int64 Read only: true
`updatedTime (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`updatedTime (anyOf 2)`	null	Alternative
`worklogId`	JSON	Optional
`worklogId (anyOf 1)`	JSON	Alternative
`worklogId (anyOf 1) (anyOf 1)`	integer	Alternative	The ID of the worklog. Format: int64 Read only: true
`worklogId (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`worklogId (anyOf 2)`	null	Alternative

Referenced models: Get user property — response body

Get issue worklogs — response body

Field	Type	Presence	Description and constraints
`$`	object	Root	Paginated list of worklog details Additional keys: allowed
`maxResults`	JSON	Optional
`maxResults (anyOf 1)`	JSON	Alternative
`maxResults (anyOf 1) (anyOf 1)`	integer	Alternative	The maximum number of results that could be on the page. Format: int32 Read only: true
`maxResults (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`maxResults (anyOf 2)`	null	Alternative
`startAt`	JSON	Optional
`startAt (anyOf 1)`	JSON	Alternative
`startAt (anyOf 1) (anyOf 1)`	integer	Alternative	The index of the first item returned on the page. Format: int32 Read only: true
`startAt (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`startAt (anyOf 2)`	null	Alternative
`total`	JSON	Optional
`total (anyOf 1)`	JSON	Alternative
`total (anyOf 1) (anyOf 1)`	integer	Alternative	The number of results on the page. Format: int32 Read only: true
`total (anyOf 1) (anyOf 2)`	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
`total (anyOf 2)`	null	Alternative
`worklogs`	JSON	Optional
`worklogs (anyOf 1)`	array	Alternative	List of worklogs. Read only: true
`worklogs (anyOf 1)[]`	Model	Each item	Expand Add worklog — response body
`worklogs (anyOf 2)`	null	Alternative

Referenced models: Add worklog — response body

Get worklogs — request body — body

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`ids`	array	Required within parent	A list of worklog IDs. Unique items: true
`ids[]`	integer	Each item	Format: int64

Report an issue with this page