Package io.github.primelib.confluence4j.rest.v1.client

Interface ConfluenceRestClientSearchApi

@Generated("io.github.primelib.primecodegen")
public interface ConfluenceRestClientSearchApi

ConfluenceRestClientSearchApi

Method Summary

Modifier and Type	Method	Description
SearchPageResponseSearchResult	GetSearchUserV1(@NotNull String cql, @Nullable Integer start, @Nullable Integer limit, @Nullable List<String> expand, @Nullable String sitePermissionTypeFilter)	GetSearchUserV1 Search users Searches for users using user-specific queries from the [Confluence Query Language (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).
SearchPageResponseSearchResult	GetSearchV1(@NotNull String cql, @Nullable String cqlcontext, @Nullable String cursor, @Nullable Boolean next, @Nullable Boolean prev, @Nullable Integer limit, @Nullable Integer start, @Nullable Boolean includeArchivedSpaces, @Nullable Boolean excludeCurrentSpaces, @Nullable String excerpt, @Nullable String sitePermissionTypeFilter, @Nullable List<String> expand)	GetSearchV1 Search content Searches for content using the [Confluence Query Language (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/).

Method Details

GetSearchV1

SearchPageResponseSearchResult GetSearchV1(@NotNull
 @NotNull String cql,
 @Nullable
 @Nullable String cqlcontext,
 @Nullable
 @Nullable String cursor,
 @Nullable
 @Nullable Boolean next,
 @Nullable
 @Nullable Boolean prev,
 @Nullable
 @Nullable Integer limit,
 @Nullable
 @Nullable Integer start,
 @Nullable
 @Nullable Boolean includeArchivedSpaces,
 @Nullable
 @Nullable Boolean excludeCurrentSpaces,
 @Nullable
 @Nullable String excerpt,
 @Nullable
 @Nullable String sitePermissionTypeFilter,
 @Nullable
 @Nullable List<String> expand)

GetSearchV1 Search content Searches for content using the [Confluence Query Language (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/). **Note that CQL input queries submitted through the `/wiki/rest/api/search` endpoint no longer support user-specific fields like `user`, `user.fullname`, `user.accountid`, and `user.userkey`.** See this [deprecation notice](https://developer.atlassian.com/cloud/confluence/deprecation-notice-search-api/) for more details. Example initial call: ``` /wiki/rest/api/search?cql=type=page&limit=25 ``` Example response: ``` { "results": [ { ... }, { ... }, ... { ... } ], "limit": 25, "size": 25, ... "_links": { "base": "<url>", "context": "<url>", "next": "/rest/api/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg", "self": "<url>" } } ``` When additional results are available, returns `next` and `prev` URLs to retrieve them in subsequent calls. The URLs each contain a cursor that points to the appropriate set of results. Use `limit` to specify the number of results returned in each call. Example subsequent call (taken from example response): ``` /wiki/rest/api/search?cql=type=page&limit=25&cursor=raNDoMsTRiNg ``` The response to this will have a `prev` URL similar to the `next` in the example response. If the expand query parameter is used with the `body.export_view` and/or `body.styled_view` properties, then the query limit parameter will be restricted to a maximum value of 25. **[Permissions](https://confluence.atlassian.com/x/_AozKw) required**: Permission to view the entities. Note, only entities that the user has permission to view will be returned.

Parameters:

cql - The CQL query to be used for the search. See [Advanced Searching using CQL](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/) for instructions on how to build a CQL query.

cqlcontext - The space, content, and content status to execute the search against. - `spaceKey` Key of the space to search against. Optional. - `contentId` ID of the content to search against. Optional. Must be in the space specified by `spaceKey`. - `contentStatuses` Content statuses to search against. Optional. Specify these values in an object. For example, `cqlcontext={%22spaceKey%22:%22TEST%22, %22contentId%22:%22123%22}`

cursor - Pointer to a set of search results, returned as part of the `next` or `prev` URL from the previous search call.

next -

prev -

limit - The maximum number of content objects to return per page. Note, this may be restricted by fixed system limits.

start - The start point of the collection to return

includeArchivedSpaces - Whether to include content from archived spaces in the results.

excludeCurrentSpaces - Whether to exclude current spaces and only show archived spaces.

excerpt - The excerpt strategy to apply to the result

sitePermissionTypeFilter - Filters users by permission type. Use `none` to default to licensed users, `externalCollaborator` for external/guest users, and `all` to include all permission types.

expand -

GetSearchUserV1

SearchPageResponseSearchResult GetSearchUserV1(@NotNull
 @NotNull String cql,
 @Nullable
 @Nullable Integer start,
 @Nullable
 @Nullable Integer limit,
 @Nullable
 @Nullable List<String> expand,
 @Nullable
 @Nullable String sitePermissionTypeFilter)

GetSearchUserV1 Search users Searches for users using user-specific queries from the [Confluence Query Language (CQL)](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/). Note that CQL input queries submitted through the `/wiki/rest/api/search/user` endpoint only support user-specific fields like `user`, `user.fullname`, `user.accountid`, and `user.userkey`. Note that some user fields may be set to null depending on the user's privacy settings. These are: email, profilePicture, displayName, and timeZone.

Parameters:

cql - The CQL query to be used for the search. See [Advanced Searching using CQL](https://developer.atlassian.com/cloud/confluence/advanced-searching-using-cql/) for instructions on how to build a CQL query. Example queries: cql=type=user will return up to 10k users cql=user="1234" will return user with accountId "1234" You can also use IN, NOT IN, != operators cql=user IN ("12", "34") will return users with accountids "12" and "34" cql=user.fullname~jo will return users with nickname/full name starting with "jo" cql=user.accountid="123" will return user with accountId "123"

start - The starting index of the returned users.

limit - The maximum number of user objects to return per page. Note, this may be restricted by fixed system limits.

expand - A multi-value parameter indicating which properties of the user to expand. - `operations` returns the operations for the user, which are used when setting permissions. - `personalSpace` returns the personal space of the user.

sitePermissionTypeFilter - Filters users by permission type. Use `none` to default to licensed users, `externalCollaborator` for external/guest users, and `all` to include all permission types.