InternalCreate a new instance of the service.
Searches for content using the Confluence Query Language (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
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 required: Permission to view the entities. Note, only entities that the user has permission to view will be returned.
Optional_?: numberThe CQL query to be used for the search. See Advanced Searching using CQL for instructions on how to build a CQL query.
Optionalcqlcontext?: stringThe 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}
Optionalcursor?: stringPointer to a set of search results, returned as part of the next or prev
URL from the previous search call.
Optionalexcerpt?: The excerpt strategy to apply to the result
OptionalexcludeWhether to exclude current spaces and only show archived spaces.
Optionalexpand?: string[]OptionalincludeWhether to include content from archived spaces in the results.
Optionallimit?: numberThe maximum number of content objects to return per page. Note, this may be restricted by fixed system limits.
Optionalnext?: booleanOptionalprev?: booleanOptionalsiteFilters users by permission type. Use none to default to licensed users,
externalCollaborator
for external/guest users, and all to include all permission types.
Optionalstart?: numberThe start point of the collection to return
Returned if the requested results are returned.
Searches for users using user-specific queries from the Confluence Query Language (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.
The CQL query to be used for the search. See 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"
Optionalexpand?: string[]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.Optionallimit?: numberThe maximum number of user objects to return per page. Note, this may be restricted by fixed system limits.
OptionalsiteFilters users by permission type. Use none to default to licensed users,
externalCollaborator
for external/guest users, and all to include all permission types.
Optionalstart?: numberThe starting index of the returned users.
Returned if the requested results are returned.
Protected Staticinitialize
See
https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-search