Class IssueWorklogProperties

Index

Constructors

constructor

Methods

deleteWorklogProperty getWorklogProperty getWorklogPropertyKeys setWorklogProperty

Constructors

constructor

new IssueWorklogProperties(client: Client): Version3.IssueWorklogProperties
Parameters
- client: Client
Returns Version3.IssueWorklogProperties
- Defined in src/version3/issueWorklogProperties.ts:8

Methods

deleteWorklogProperty

deleteWorklogProperty<T = void>(
parameters: Version3Parameters.DeleteWorklogProperty,
callback: Callback<T>,
): 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.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.DeleteWorklogProperty
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueWorklogProperties.ts:168
deleteWorklogProperty<T = void>(
parameters: Version3Parameters.DeleteWorklogProperty,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.DeleteWorklogProperty
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueWorklogProperties.ts:185

getWorklogProperty

getWorklogProperty<T = Version3Models.EntityProperty>(
parameters: Version3Parameters.GetWorklogProperty,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = Version3Models.EntityProperty
Parameters
- parameters: Version3Parameters.GetWorklogProperty
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueWorklogProperties.ts:69
getWorklogProperty<T = Version3Models.EntityProperty>(
parameters: Version3Parameters.GetWorklogProperty,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = Version3Models.EntityProperty
Parameters
- parameters: Version3Parameters.GetWorklogProperty
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueWorklogProperties.ts:86

getWorklogPropertyKeys

getWorklogPropertyKeys<T = Version3Models.PropertyKeys>(
parameters: Version3Parameters.GetWorklogPropertyKeys,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = Version3Models.PropertyKeys
Parameters
- parameters: Version3Parameters.GetWorklogPropertyKeys
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueWorklogProperties.ts:23
getWorklogPropertyKeys<T = Version3Models.PropertyKeys>(
parameters: Version3Parameters.GetWorklogPropertyKeys,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = Version3Models.PropertyKeys
Parameters
- parameters: Version3Parameters.GetWorklogPropertyKeys
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueWorklogProperties.ts:40

setWorklogProperty

setWorklogProperty<T = unknown>(
parameters: Version3Parameters.SetWorklogProperty,
callback: Callback<T>,
): Promise<void>
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.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.SetWorklogProperty
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/issueWorklogProperties.ts:120
setWorklogProperty<T = unknown>(
parameters: Version3Parameters.SetWorklogProperty,
callback?: undefined,
): Promise<T>
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.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.SetWorklogProperty
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/issueWorklogProperties.ts:142

Class IssueWorklogProperties

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.IssueWorklogProperties

Methods

deleteWorklogProperty

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getWorklogProperty

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getWorklogPropertyKeys

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

setWorklogProperty

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page