queryProjects( )


Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Creates a query to retrieve a list of projects.

The queryProjects() method builds a query to retrieve a list of projects and returns a ProjectsQueryBuilder object.

The returned object contains the query definition, which is used to run the query using the find() method.

You can refine the query by chaining ProjectsQueryBuilder methods onto the query. ProjectsQueryBuilder methods enable you to filter, sort, and control the results that queryProjects() returns.

queryProjects() runs with the following ProjectsQueryBuilder defaults which you can override:

The following ProjectsQueryBuilder methods are supported for queryProjects(). For a full description of the operations object, see the object returned for the items property in ProjectsQueryResult.

PROPERTYSUPPORTED FILTERS & SORTING
_ideq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
titleeq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
descriptioneq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
hiddeneq(),ne(),exists(),in(),hasSome()
collectionIdseq(),ne(),exists(),in(),hasSome(),hasAll()
slugeq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
_createdDateeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
_updatedDateeq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
Permissions
Manage Portfolio
Learn more about app permissions.
Method Declaration
Copy
Method Parameters
optionsQueryProjectsOptions
Returns
Did this help?