org.everit.atlassian.restclient.jiracloud.v2.api

Class UserSearchApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v2.api.UserSearchApi

public class UserSearchApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<PageBeanUserKey>	findUserKeysByQuery(Optional<String> query, Optional<Long> startAt, Optional<Integer> maxResults, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Find user keys by query Finds users with a structured query and returns a list of user keys.
io.reactivex.Single<PageBeanUser>	findUsersByQuery(Optional<String> query, Optional<Long> startAt, Optional<Integer> maxResults, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Find users by query Finds users with a structured query and returns user details.

Methods inherited from class java.lang.Object

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

Constructor Detail

UserSearchApi

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

Method Detail

findUserKeysByQuery

public io.reactivex.Single<PageBeanUserKey> findUserKeysByQuery(Optional<String> query,
                                                                Optional<Long> startAt,
                                                                Optional<Integer> maxResults,
                                                                Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Find user keys by query

Finds users with a structured query and returns a list of user keys.

Permissions required: Browse users and groups global permission.

The query statements are:

• is assignee of PROJ Returns the users that are assignees of at least one issue in project PROJ.
• is assignee of (PROJ-1, PROJ-2) Returns users that are assignees on the issues PROJ-1 or PROJ-2.
• is reporter of (PROJ-1, PROJ-2) Returns users that are reporters on the issues PROJ-1 or PROJ-2.
• is watcher of (PROJ-1, PROJ-2) Returns users that are watchers on the issues PROJ-1 or PROJ-2.
• is voter of (PROJ-1, PROJ-2) Returns users that are voters on the issues PROJ-1 or PROJ-2.
• is commenter of (PROJ-1, PROJ-2) Returns users that have posted a comment on the issues PROJ-1 or PROJ-2.
• is transitioner of (PROJ-1, PROJ-2) Returns users that have performed a transition on issues PROJ-1 or PROJ-2.
• [propertyKey].entity.property.path is "property value" Returns users with the entity property value.

The list of issues can be extended as needed, as in (PROJ-1, PROJ-2, ... PROJ-n). Statements can be combined using the AND and OR operators to form more complex queries. For example:

is assignee of PROJ AND [propertyKey].entity.property.path is "property value"

Parameters:

query -

The search query.

(optional)

startAt -

The index of the first item to return in a page of results (page offset).

(optional, default to 0l)

maxResults -

The maximum number of items to return per page. The maximum is 1000.

(optional, default to 100)

restRequestEnhancer -

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

Returns:

Single<PageBeanUserKey>

findUsersByQuery

public io.reactivex.Single<PageBeanUser> findUsersByQuery(Optional<String> query,
                                                          Optional<Long> startAt,
                                                          Optional<Integer> maxResults,
                                                          Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Find users by query

Finds users with a structured query and returns user details.

Permissions required: Browse users and groups global permission.

The query statements are:

• is assignee of PROJ Returns the users that are assignees of at least one issue in project PROJ.
• is assignee of (PROJ-1, PROJ-2) Returns users that are assignees on the issues PROJ-1 or PROJ-2.
• is reporter of (PROJ-1, PROJ-2) Returns users that are reporters on the issues PROJ-1 or PROJ-2.
• is watcher of (PROJ-1, PROJ-2) Returns users that are watchers on the issues PROJ-1 or PROJ-2.
• is voter of (PROJ-1, PROJ-2) Returns users that are voters on the issues PROJ-1 or PROJ-2.
• is commenter of (PROJ-1, PROJ-2) Returns users that have posted a comment on the issues PROJ-1 or PROJ-2.
• is transitioner of (PROJ-1, PROJ-2) Returns users that have performed a transition on issues PROJ-1 or PROJ-2.
• [propertyKey].entity.property.path is "property value" Returns users with the entity property value.

The list of issues can be extended as needed, as in (PROJ-1, PROJ-2, ... PROJ-n). Statements can be combined using the AND and OR operators to form more complex queries. For example:

is assignee of PROJ AND [propertyKey].entity.property.path is "property value"

Parameters:

query -

The search query.

(optional)

startAt -

The index of the first item to return in a page of results (page offset).

(optional, default to 0l)

maxResults -

The maximum number of items to return per page. The maximum is 1000.

(optional, default to 100)

restRequestEnhancer -

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

Returns:

Single<PageBeanUser>