Class IssueWorklogPropertiesService

This resource represents issue worklog properties, which provides for storing custom data against an issue worklog. Use it to get, create, and delete issue worklog properties as well as obtain the keys of all properties on a issue worklog. Issue worklog properties are a type of entity property.

See

https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklog-properties

Hierarchy

CommonHttpService
- IssueWorklogPropertiesService

Index

Constructors

constructor

Methods

deleteWorklogProperty getWorklogProperty getWorklogPropertyKeys setWorklogProperty initialize

Constructors

constructor

new IssueWorklogPropertiesService(getClientInstance): IssueWorklogPropertiesService
Internal
Create a new instance of the service.
Parameters
- getClientInstance: (() => CommonHttpClient)
  - - (): CommonHttpClient
    - Returns CommonHttpClient
Returns IssueWorklogPropertiesService
Inherited from CommonHttpService.constructor

Methods

deleteWorklogProperty

deleteWorklogProperty(params): Promise<void>
Deletes a worklog property.

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.
- If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
Parameters
- params: {
      issueIdOrKey: string;
      propertyKey: string;
      worklogId: string;
  }
  - issueIdOrKey: string
    The ID or key of the issue.
  - propertyKey: string
    The key of the property.
  - worklogId: string
    The ID of the worklog.
Returns Promise<void>
Path
DELETE /rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey} @scopes-current write:jira-work @scopes-beta delete:issue-worklog.property:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklog-properties#api-rest-api-3-issue-issueidorkey-worklog-worklogid-properties-propertykey-delete

getWorklogProperty

getWorklogProperty(params): Promise<EntityProperty>
Returns the value of a worklog property.

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.
- If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
Parameters
- params: {
      issueIdOrKey: string;
      propertyKey: string;
      worklogId: string;
  }
  - issueIdOrKey: string
    The ID or key of the issue.
  - propertyKey: string
    The key of the property.
  - worklogId: string
    The ID of the worklog.
Returns Promise<EntityProperty>
Returned if the request is successful.

example:
```
{
  "key": "issue.support",
  "value": {
    "system.conversation.id": "b1bf38be-5e94-4b40-a3b8-9278735ee1e6",
    "system.support.time": "1m"
  }
}
```
Path
GET /rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey} @scopes-current read:jira-work @scopes-beta read:issue-worklog.property:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklog-properties#api-rest-api-3-issue-issueidorkey-worklog-worklogid-properties-propertykey-get

getWorklogPropertyKeys

getWorklogPropertyKeys(params): Promise<PropertyKeys>
Returns the keys of all properties for a worklog.

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.
- If the worklog has visibility restrictions, belongs to the group or has the role visibility is restricted to.
Parameters
- params: {
  issueIdOrKey: string;
  worklogId: string;
  }
  - issueIdOrKey: string
    The ID or key of the issue.
  - worklogId: string
    The ID of the worklog.
Returns Promise<PropertyKeys>
Returned if the request is successful.

example:
```
{
  "keys": [
    {
      "key": "issue.support",
      "self": "https://your-domain.atlassian.net/rest/api/3/issue/EX-2/properties/issue.support"
    }
  ]
}
```
Path
GET /rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties @scopes-current read:jira-work @scopes-beta read:issue-worklog.property:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklog-properties#api-rest-api-3-issue-issueidorkey-worklog-worklogid-properties-get

setWorklogProperty

setWorklogProperty(params): Promise<{
body: unknown;
created: boolean;
}>
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
- params: {
      issueIdOrKey: string;
      propertyKey: string;
      requestBody: unknown;
      worklogId: string;
  }
  - issueIdOrKey: string
    The ID or key of the issue.
  - propertyKey: string
    The key of the issue property. The maximum length is 255 characters.
  - requestBody: unknown
    The value of the property. The value has to be a valid, non-empty JSON value. The maximum length of the property value is 32768 bytes.
  - worklogId: string
    The ID of the worklog.
Returns Promise<{
body: unknown;
created: boolean;
}>
- status: 200, mediaType: application/json
  
  Returned if the worklog property is updated.
- status: 201, mediaType: application/json
  
  Returned if the worklog property is created.
Path
PUT /rest/api/3/issue/{issueIdOrKey}/worklog/{worklogId}/properties/{propertyKey} @scopes-current write:jira-work @scopes-beta write:issue-worklog.property:jira

See
https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-worklog-properties#api-rest-api-3-issue-issueidorkey-worklog-worklogid-properties-propertykey-put

`Protected` `Static`initialize

initialize(): void
Method to initialize the class. Normally used to set up validation rules.

Returns void
Overrides CommonHttpService.initialize

Class IssueWorklogPropertiesService

See

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns CommonHttpClient

Returns IssueWorklogPropertiesService

Methods

deleteWorklogProperty

Parameters

issueIdOrKey: string

propertyKey: string

worklogId: string

Returns Promise<void>

Path

See

getWorklogProperty

Parameters

issueIdOrKey: string

propertyKey: string

worklogId: string

Returns Promise<EntityProperty>

Path

See

getWorklogPropertyKeys

Parameters

issueIdOrKey: string

worklogId: string

Returns Promise<PropertyKeys>

Path

See

setWorklogProperty

Parameters

issueIdOrKey: string

propertyKey: string

requestBody: unknown

worklogId: string

Returns Promise<{ body: unknown; created: boolean; }>

Path

See

Protected Staticinitialize

Returns void

Settings

On This Page

Returns Promise<{
body: unknown;
created: boolean;
}>

`Protected` `Static`initialize