# IssueWorklogsByIdOrKey: JIRA Cloud Issue Worklogs by ID or Key - Catalog: `JIRA` - Schema: `Core` - Primary Keys: `id` - Label: Issue Worklogs by ID or Key - Select JIRA Cloud API URL: `/issue/{issueIdOrKey}/worklog` - Insert JIRA Cloud API URL: `/issue/{issueIdOrKey}/worklog` - Update JIRA Cloud API URL: `/issue/{issueIdOrKey}/worklog` - Delete JIRA Cloud API URL: `/issue/{issueIdOrKey}/worklog` - Field Selection Method: NotRequired - Base Path: `worklogs[*]` This is a read-only table function. The JIRA Cloud API may not support changing the data or the Invantive SQL driver for JIRA Cloud does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the JIRA Cloud API. ## Parameters of Table Function | Name | Data Type | Required | Default Value | Documentation | |---|:---:|:---:|:---:|---| | `issueIdOrKey` | `string` | ☑ | | The ID or key to be retrieved. | ## Columns of Table Function The columns of the table function `IssueWorklogsByIdOrKey` are shown below. Each column has an SQL data type. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `author_accountId` | `string` | | ☐ | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests. An account ID with value unknown is returned when there is missing data for a user, which only happens for deleted users. We recommend you treat this value as an error case if you need to access more information about the user. | | `author_accountType` | `string` | | ☐ | The user account type. Can take the following values: atlassian regular Atlassian user account, app system account used for Connect applications and OAuth to represent external systems, customer Jira Service Desk account representing an external service desk | | `author_active` | `boolean` | | ☐ | Indicates whether the user is active. | | `author_displayName` | `string` | | ☐ | The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. | | `author_emailAddress` | `string` | | ☐ | The email address of the user. Depending on the user’s privacy setting, this may be returned as null. | | `author_key` | `string` | | ☐ | This property is no longer available and will be removed from the documentation soon | | `author_locale` | `string` | | ☐ | The locale of the user. Depending on the user’s privacy setting, this may be returned as null. | | `author_name` | `string` | | ☐ | This property is no longer available and will be removed from the documentation soon. | | `author_timeZone` | `string` | | ☐ | The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null. | | `comment` | `string` | | ☐ | A comment about the worklog in Atlassian Document Format. Optional when creating or updating a worklog. | | `created` | `datetime` | | ☐ | 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. | | `started` | `datetime` | | ☐ | 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 be provided if timeSpentSecond is provided. | | `timeSpentSeconds` | `int64` | | ☐ | 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_accountId` | `string` | | ☐ | The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5. Required in requests. An account ID with value unknown is returned when there is missing data for a user, which only happens for deleted users. We recommend you treat this value as an error case if you need to access more information about the user. | | `updateAuthor_accountType` | `string` | | ☐ | The user account type. Can take the following values: atlassian regular Atlassian user account, app system account used for Connect applications and OAuth to represent external systems, customer Jira Service Desk account representing an external service desk | | `updateAuthor_active` | `boolean` | | ☐ | Indicates whether the user is active. | | `updateAuthor_displayName` | `string` | | ☐ | The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. | | `updateAuthor_emailAddress` | `string` | | ☐ | The email address of the user. Depending on the user’s privacy setting, this may be returned as null. | | `updateAuthor_key` | `string` | | ☐ | This property is no longer available and will be removed from the documentation soon | | `updateAuthor_locale` | `string` | | ☐ | The locale of the user. Depending on the user’s privacy setting, this may be returned as null. | | `updateAuthor_name` | `string` | | ☐ | This property is no longer available and will be removed from the documentation soon. | | `updateAuthor_timeZone` | `string` | | ☐ | The time zone specified in the user's profile. Depending on the user’s privacy setting, this may be returned as null. | | `updated` | `datetime` | | ☐ | The datetime on which the worklog was last updated. | | `visibility_type` | `string` | | ☐ | Indicates whether visibility of this item is restricted to a group or role. | | `visibility_value` | `string` | | ☐ | The name of the group or role to which visibility of this item is restricted. |