org.everit.atlassian.restclient.jiracloud.v3.api

Class ProjectPropertiesApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v3.api.ProjectPropertiesApi

public class ProjectPropertiesApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ProjectPropertiesApi(org.everit.http.restclient.RestClient restClient)

Method Summary

Modifier and Type	Method and Description
io.reactivex.Completable	deleteProjectProperty(String projectIdOrKey, String propertyKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete project property Deletes the [property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties) from a project.
io.reactivex.Single<EntityProperty>	getProjectProperty(String projectIdOrKey, String propertyKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get project property Returns the value of a [project property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties).
io.reactivex.Single<PropertyKeys>	getProjectPropertyKeys(String projectIdOrKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get project property keys Returns all [project property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties) keys for the project.
io.reactivex.Single<Object>	setProjectProperty(String projectIdOrKey, String propertyKey, Object body, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Set project property Sets the value of the [project property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ProjectPropertiesApi

public ProjectPropertiesApi(org.everit.http.restclient.RestClient restClient)

Method Detail

deleteProjectProperty

public io.reactivex.Completable deleteProjectProperty(String projectIdOrKey,
                                                      String propertyKey,
                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete project property Deletes the [property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties) from a project. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the property.

Parameters:

projectIdOrKey - The project ID or project key (case sensitive). (required)

propertyKey - The project property key. Use [Get project property keys](#api-rest-api-3-project-projectIdOrKey-properties-get) to get a list of all project property keys. (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Completable

getProjectProperty

public io.reactivex.Single<EntityProperty> getProjectProperty(String projectIdOrKey,
                                                              String propertyKey,
                                                              Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get project property Returns the value of a [project property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties). This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project containing the property.

Parameters:

projectIdOrKey - The project ID or project key (case sensitive). (required)

propertyKey - The project property key. Use [Get project property keys](#api-rest-api-3-project-projectIdOrKey-properties-get) to get a list of all project property keys. (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<EntityProperty>

getProjectPropertyKeys

public io.reactivex.Single<PropertyKeys> getProjectPropertyKeys(String projectIdOrKey,
                                                                Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get project property keys Returns all [project property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties) keys for the project. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Browse Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project.

Parameters:

projectIdOrKey - The project ID or project key (case sensitive). (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<PropertyKeys>

setProjectProperty

public io.reactivex.Single<Object> setProjectProperty(String projectIdOrKey,
                                                      String propertyKey,
                                                      Object body,
                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Set project property Sets the value of the [project property](https://developer.atlassian.com/cloud/jira/platform/storing-data-without-a-database/#a-id-jira-entity-properties-a-jira-entity-properties). You can use project properties to store custom data against the project. The value of the request body must be a [valid](http://tools.ietf.org/html/rfc4627), non-empty JSON blob. The maximum length is 32768 characters. This operation can be accessed anonymously. **[Permissions](#permissions) required:** *Administer Jira* [global permission](https://confluence.atlassian.com/x/x4dKLg) or *Administer Projects* [project permission](https://confluence.atlassian.com/x/yodKLg) for the project in which the property is created.

Parameters:

projectIdOrKey - The project ID or project key (case sensitive). (required)

propertyKey - The key of the project property. The maximum length is 255 characters. (required)

body - (required)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<Object>