Class ProjectPropertiesService

This resource represents project properties, which provides for storing custom data against a project. Use it to get, create, and delete project properties as well as get a list of property keys for a project. Project properties are a type of entity property.

See

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

Hierarchy

  • CommonHttpService
    • ProjectPropertiesService

Constructors

constructor

Methods

deleteProjectProperty getProjectProperty getProjectPropertyKeys setProjectProperty initialize

Constructors

constructor

  • new ProjectPropertiesService(getClientInstance): ProjectPropertiesService
  • Internal

    Create a new instance of the service.

    Parameters

    • getClientInstance: (() => CommonHttpClient)
        • (): CommonHttpClient

        • Returns CommonHttpClient

    Returns ProjectPropertiesService

Methods

deleteProjectProperty

getProjectProperty

getProjectPropertyKeys

setProjectProperty

  • setProjectProperty(params): Promise<{
        body: unknown;
        created: boolean;
    }>

  • 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.

    Parameters

    • params: {
          projectIdOrKey: string;
          propertyKey: string;
          requestBody: unknown;
      }
      • projectIdOrKey: string

        The project ID or project key (case sensitive).

      • propertyKey: string

        The key of the project 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.

        Example

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

    • status: 200, mediaType: application/json

      Returned if the project property is updated.

    • status: 201, mediaType: application/json

      Returned if the project property is created.

    Path

    PUT /rest/api/3/project/{projectIdOrKey}/properties/{propertyKey} @scopes-current manage:jira-project @scopes-beta write:project.property:jira

    See

    https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-properties#api-rest-api-3-project-projectidorkey-properties-propertykey-put

Protected Staticinitialize

  • initialize(): void

  • Method to initialize the class. Normally used to set up validation rules.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods