Atlassian · Schema

Worklog

Details of a worklog.

CodeCollaborationPlatformProductivitySoftware Development

Properties

Name Type Description
author object Details of the user who created the worklog.
comment object 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 The datetime on which the worklog was created.
id string The ID of the worklog record.
issueId string The ID of the issue this worklog is for.
properties array Details of properties for the worklog. Optional when creating or updating a worklog.
self string The URL of the worklog item.
started string The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog.
timeSpent string 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
timeSpentSeconds integer 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.
updateAuthor object Details of the user who last updated the worklog.
updated string The datetime on which the worklog was last updated.
visibility object Details about any restrictions in the visibility of the worklog. Optional when creating or updating a worklog.
View JSON Schema on GitHub

JSON Schema

atlassian-worklog-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Worklog",
  "title": "Worklog",
  "additionalProperties": true,
  "description": "Details of a worklog.",
  "properties": {
    "author": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserDetails"
        }
      ],
      "description": "Details of the user who created the worklog.",
      "readOnly": true
    },
    "comment": {
      "description": "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": {
      "description": "The datetime on which the worklog was created.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "id": {
      "description": "The ID of the worklog record.",
      "readOnly": true,
      "type": "string"
    },
    "issueId": {
      "description": "The ID of the issue this worklog is for.",
      "readOnly": true,
      "type": "string"
    },
    "properties": {
      "description": "Details of properties for the worklog. Optional when creating or updating a worklog.",
      "items": {
        "$ref": "#/components/schemas/EntityProperty"
      },
      "type": "array"
    },
    "self": {
      "description": "The URL of the worklog item.",
      "format": "uri",
      "readOnly": true,
      "type": "string"
    },
    "started": {
      "description": "The datetime on which the worklog effort was started. Required when creating a worklog. Optional when updating a worklog.",
      "format": "date-time",
      "type": "string"
    },
    "timeSpent": {
      "description": "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.",
      "type": "string"
    },
    "timeSpentSeconds": {
      "description": "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",
      "type": "integer"
    },
    "updateAuthor": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserDetails"
        }
      ],
      "description": "Details of the user who last updated the worklog.",
      "readOnly": true
    },
    "updated": {
      "description": "The datetime on which the worklog was last updated.",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "visibility": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Visibility"
        }
      ],
      "description": "Details about any restrictions in the visibility of the worklog. Optional when creating or updating a worklog."
    }
  },
  "type": "object",
  "xml": {
    "name": "worklog"
  }
}