Class ProjectProperties

Index

Constructors

constructor

Methods

deleteProjectProperty getProjectProperty getProjectPropertyKeys setProjectProperty

Constructors

constructor

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

Methods

deleteProjectProperty

deleteProjectProperty<T = void>(
parameters: Version3Parameters.DeleteProjectProperty,
callback: Callback<T>,
): Promise<void>
Deletes the property from a project.

This operation can be accessed anonymously.

Permissions required: Administer Jira global permission or Administer Projects project permission for the project containing the property.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.DeleteProjectProperty
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectProperties.ts:147
deleteProjectProperty<T = void>(
parameters: Version3Parameters.DeleteProjectProperty,
callback?: undefined,
): Promise<T>
Deletes the property from a project.

This operation can be accessed anonymously.

Permissions required: Administer Jira global permission or Administer Projects project permission for the project containing the property.
Type Parameters
- T = void
Parameters
- parameters: Version3Parameters.DeleteProjectProperty
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/projectProperties.ts:162

getProjectProperty

getProjectProperty<T = Version3Models.EntityProperty>(
parameters: Version3Parameters.GetProjectProperty,
callback: Callback<T>,
): Promise<void>
Returns the value of a project property.

This operation can be accessed anonymously.

Permissions required: Browse Projects project permission for the project containing the property.
Type Parameters
- T = Version3Models.EntityProperty
Parameters
- parameters: Version3Parameters.GetProjectProperty
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectProperties.ts:61
getProjectProperty<T = Version3Models.EntityProperty>(
parameters: Version3Parameters.GetProjectProperty,
callback?: undefined,
): Promise<T>
Returns the value of a project property.

This operation can be accessed anonymously.

Permissions required: Browse Projects project permission for the project containing the property.
Type Parameters
- T = Version3Models.EntityProperty
Parameters
- parameters: Version3Parameters.GetProjectProperty
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/projectProperties.ts:74

getProjectPropertyKeys

getProjectPropertyKeys<T = Version3Models.PropertyKeys>(
parameters: string | Version3Parameters.GetProjectPropertyKeys,
callback: Callback<T>,
): Promise<void>
Returns all project property keys for the project.

This operation can be accessed anonymously.

Permissions required: Browse Projects project permission for the project.
Type Parameters
- T = Version3Models.PropertyKeys
Parameters
- parameters: string | Version3Parameters.GetProjectPropertyKeys
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectProperties.ts:20
getProjectPropertyKeys<T = Version3Models.PropertyKeys>(
parameters: string | Version3Parameters.GetProjectPropertyKeys,
callback?: undefined,
): Promise<T>
Returns all project property keys for the project.

This operation can be accessed anonymously.

Permissions required: Browse Projects project permission for the project.
Type Parameters
- T = Version3Models.PropertyKeys
Parameters
- parameters: string | Version3Parameters.GetProjectPropertyKeys
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/projectProperties.ts:34

setProjectProperty

setProjectProperty<T = unknown>(
parameters: Version3Parameters.SetProjectProperty,
callback: Callback<T>,
): Promise<void>
Sets the value of the project property. You can use project properties to store custom data against the project.

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: Administer Jira global permission or Administer Projects project permission for the project in which the property is created.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.SetProjectProperty
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version3/projectProperties.ts:104
setProjectProperty<T = unknown>(
parameters: Version3Parameters.SetProjectProperty,
callback?: undefined,
): Promise<T>
Sets the value of the project property. You can use project properties to store custom data against the project.

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: Administer Jira global permission or Administer Projects project permission for the project in which the property is created.
Type Parameters
- T = unknown
Parameters
- parameters: Version3Parameters.SetProjectProperty
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version3/projectProperties.ts:122

Class ProjectProperties

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Version3.ProjectProperties

Methods

deleteProjectProperty

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getProjectProperty

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

getProjectPropertyKeys

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

setProjectProperty

Type Parameters

Parameters

Returns Promise<void>

Type Parameters

Parameters

Returns Promise<T>

Settings

On This Page