Function: setWorklogProperty()
ts
function setWorklogProperty(
client,
parameters,
options?
): Promise<void>;Defined in: src/cloud/api/issueWorklogProperties.ts:83
Sets the value of a worklog property. Use this operation to store custom data against the worklog.
The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.
This operation can be accessed anonymously.
Permissions required:
- Browse projects project permission for the project that the issue is in.
- If issue-level security is configured, issue-level security permission to view the issue.
- Edit all worklogs project permission to update any worklog or Edit own worklogs to update worklogs created by the user.
- If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
Parameters
| Parameter | Type | Description |
|---|---|---|
client | Client | - |
parameters | { body: Record<string, any>; issueIdOrKey: string; propertyKey: string; worklogId: string; } | - |
parameters.body | Record<string, any> | - |
parameters.issueIdOrKey? | string | The ID or key of the issue. |
parameters.propertyKey? | string | The key of the issue property. The maximum length is 255 characters. |
parameters.worklogId? | string | The ID of the worklog. |
options? | RequestOptions | - |
Returns
Promise<void>