Query management
The query management capabilities of the API allow application developers to manage searches and includes the following REST calls:
search
|
Function |
Search assets/collection using a searchDefinition. |
||
|
Description |
This request searches assets/collections based on a given searchDefinition. This API has been exposd as both Get and POST. In the case of a large payload, POST API can be used. |
||
|
Type |
GET, POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
An XML object containing metadata of the asset/collections to be found. |
|
|
Returns |
Returns a Returns a |
||
|
Examples |
URL:
Result:
|
||
|
Function |
Search assets/collection using pagination from searchDefinition. |
||
|
Description |
This request searches assets/collections based on a given searchDefinition in a paginated manner. This APi has been exposed as both GET and POST. |
||
|
Type |
GET, POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters
|
Name |
Type |
Description |
|
|
string |
An XML object containing metadata of the asset/collections to be found. |
|
|
|
int |
|
|
|
|
int |
|
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
searchAssets
|
Function |
Search assets for a particular attribute value. |
||
|
Description |
This request searchs for assets matching specfic search criteria. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
|
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
long or string |
The attribute name and value that you are searching for. (Mandatory) The attributes must be queryable. The following is a lit of non-queryable attributes:
Functions to get assets based on two non-queryable atributes (Collection, Status) are given below. You can pass more than one attribute as a paramater with the value to search for. |
|
|
|
boolean |
Parameter to include child content types in search criteria. |
|
|
|
|
You can pass the appropriate value for any queryable attribute. For a list of attributes,
use a call to |
|
|
|
long |
The default display modes are documented in the JavaDoc SDK at |
|
|
|
long |
For a list of explore modes, see Defaults to 0. |
|
|
|
string |
Comma separated ids of collections in which assets are to be searched. |
|
|
|
boolean |
Indicates whether all of the hierarchy below and including collections are to be searched. Deffault value=true |
|
|
Returns |
Returns search results based upon specified attribute values. |
||
|
Examples |
URL:
Result:
|
||
|
Function |
Search for assets that contain a particular text string. |
||
|
Description |
This request will search for assets that contain a given text string. This is specific to content based searches in workspace and ConnectClient. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
Specify the string to search for. (Mandatory) |
|
|
|
string |
You can pass the appropriate value for any queryable attribute to fetch specific attributes. For a list of attributes, use a call to The attributes must be queryable. The following is a lit of non-queryable attributes:
|
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result: Example of a text search with specific attribute:
|
||
|
Function |
Search for a particular attachment. |
||
|
Description |
This request searches for all attachments for a given document. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
long |
ID of the document whose attachments you want found. (Mandatory) |
|
|
|
long or string |
You can pass the appropriate value for any queryable attribute to fetch specific attributes. For a list of attributes, use a call to The attributes must be queryable. The following is a lit of non-queryable attributes:
|
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result: A
|
||
|
Function |
Search within an existing query. |
||
|
Description |
This request searchs an existiing query in the platform. |
||
|
Type |
GET |
||
|
URL Format |
.../ |
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
long or string |
Use /search to get IDs. (Mandatory) |
|
|
|
long or string |
You can pass the appropriate value for any queryable attribute to fetch specific attributes. For a list of attributes, use a call to The attributes must be queryable. The following is a lit of non-queryable attributes:
|
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result: A |
||
|
Function |
Search for assets with a particular status. |
||
|
Description |
This request returns all assets associated with given status. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
Specify Status of a workflow. Specify Name or ID of a workflow. (Mandatory) Status and workflow will go hand in hand. |
|
|
|
long or string |
You can pass the appropriate value for any queryable attribute to fetch specific attributes. For a list of attributes, use a call to The attributes must be queryable. The following is a lit of non-queryable attributes:
|
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result:
|
||
|
Function |
Search for assets in a particular collection. |
||
|
Description |
This request searchs for the assets checked-in at given collection. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
long or string |
To get a list of collection IDs for a particular collection, use a call to |
|
|
|
boolean |
Parameter to include child collections. Defaults to true. (Optional) |
|
|
|
long or string |
You can pass the appropriate value for any queryable attribute to fetch specific attributes. For a list of attributes, use a call to The attributes must be queryable. The following is a lit of non-queryable attributes:
|
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result:
|
||
searchCollections
|
Function |
Search for collections in a particular collection. |
||
|
Description |
This request searchs all nested collections accessible to the user under a given collection ID or Name. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
long or string |
Parameter to include child collections. To get a list of collection IDs for a particular
collection, use a call to |
|
|
|
boolean |
Defaults to true.(Optional) |
|
|
|
boolean |
Parameter to include child content types in search criteria. |
|
|
|
long or string |
Specify the string to search for. (Mandatory) You can pass the appropriate value for any queryable attribute to fetch specific attributes. For a list of attributes, use a call to The attributes must be queryable. The following is a lit of non-queryable attributes:
|
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
|
Function |
Search for collections in a collection with particular attributes. |
||
|
Description |
This request searchs for assets in a specified collection and displasy results with the specified attributes. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
long or string |
For a list of attributes, use a call to |
|
|
|
long or string |
Parameter to include child collections. To get a list of collection IDs for a particular collection, use a call to |
|
|
|
boolean |
Defaults to true. (Optional) |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
createSearches
|
Function |
Create searches. |
||
|
Description |
This request creates a single or multiple searches at one time. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
long |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
An XML object containing metadata of searches to be created. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getSearch
|
Function |
Search for a saved search. |
||
|
Description |
This request returns the metadata of a specified search. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
boolean |
Defaults to false. |
|
|
|
boolean |
Defaults to false. |
|
|
|
boolean |
Defaults to false. |
|
|
|
boolean |
Defaults to false. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getAllSearches
|
Function |
Get all saved searches. |
||
|
Description |
This request returns all saved, shared searches. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
boolean |
Defaults to false. |
|
|
|
boolean |
Defaults to false. |
|
|
|
boolean |
Defaults to false. |
|
|
|
boolean |
Defaults to false. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getSearchResultsForQuery
|
Function |
Get the results of an existing search. |
||
|
Description |
This request returns the results of the execution of an already saved search. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
long |
Defaults to 1. The default display modes are documented in the |
|
|
|
long |
Defaults to 0. For a list of explore modes, see |
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result:
|
||
|
Function |
Get the results of an existing search with specific display attributes. |
||
|
Description |
This request returns the results of the execution of an already saved search and displays only the specified attributes. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
com.quark.qpp.service.facade Class QueryFacade |
||
|
Parameters |
Name |
Type |
Description |
|
|
long or string |
For a list of attributes, use a call to |
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result:
|
||
|
Function |
Get the results of an already saved "Ask" queries. |
||
|
Description |
This request returns the result of an already saved search (Ask Queries) by accepting required values of search criteria as its parameters. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
Provide value for search criteria as its parameter. Parameter will be based upon the saved query. (Mandatory) |
|
|
|
string or long |
You can pass the appropriate value for any queryable attribute to fetch specific attributes. For a list of attributes, use a call to |
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result:
|
||
|
Function |
Search assets using pagination from a saved query. |
||
|
Description |
This request returns the results of the execution of an already saved search in a paginated manner. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
int |
. (Mandatory) |
|
|
|
int |
. |
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result:
|
||
getTextSearchResults
|
Function |
Search for assets using wild cards. |
||
|
Description |
This request executes a quick search for assets based on their name. Both simple and wildcard based comparison is performed for name. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
long or string |
To get a list of collection IDs for a particular collection, use a call to |
|
|
|
boolean |
Parameter to include child collections. Defaults to true. (Optional) |
|
|
|
long or string |
You can pass the appropriate value for any queryable attribute to fetch specific attributes. For a list of attributes, use a call to The attributes must be queryable. The following is a lit of non-queryable attributes:
|
|
|
|
boolean |
Parameter to include child content types in search criteria. |
|
|
|
long or string |
attributeIds used for determining the sequence of asset elements in query results. |
|
|
Returns |
Returns an |
||
|
Examples |
URL:
Result:
|
||
setSharedSearchTrustees
|
Function |
Share a search. |
||
|
Description |
This request shares any specified search to any user or group. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
long |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
An XML object containing metadata of all trustees (users, groups) that the search will be shared with. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
getSharedSearchTrustees
|
Function |
Get the trustees of a shared search. |
||
|
Description |
This request returns the trustees that a specfied search has been shared with. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
long |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
updateSearches
|
Function |
Update searches. |
||
|
Description |
This request updates a single or multiple searches at one time. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
|
|
|
|
|
|
||
|
Parameters |
|
|
|
|
|
long |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
string |
An XML object containing metadata of searches to be updated. |
|
|
Returns |
Returns a |
||
|
Examples |
URL:
Result:
|
||
deleteSearch
|
Function |
Delete searches. |
||
|
Description |
This request deletes a specified search. |
||
|
Type |
POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
long |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
Returns |
A status of 200 is returned in response to a successful request execution. |
||
|
Examples |
URL:
|
||
count
|
Function |
Count assets/collection using a searchDefinition. |
||
|
Description |
This request counts assets/collections based on a given searchDefinition. This API has been exposd as both Get and POST. In the case of a large payload, POST API can be used. |
||
|
Type |
GET, POST |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
string |
An XML object containing metadata of the asset/collections to be counted. |
|
|
Returns |
Returns a count of the assets, if the context of the given searchInfo is ASSET. Returns a count of the collections, if the context of the given searchInfo is COLLECTION |
||
|
Examples |
URL:
Result:
|
||
countAssets
|
Function |
Count assets. |
||
|
Description |
This request counts assets based on given conditions. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
long |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
long or string |
(Mandatory) |
|
|
|
boolean |
Defaults to true.(Optional) |
|
|
|
boolean |
Parameter to include child content types in search criteria. |
|
|
|
long or string |
Specify the string to search for. (Mandatory) You can pass the appropriate value for any queryable attribute to fetch specific attributes. For a list of attributes, use a call to The attributes must be queryable. The following is a lit of non-queryable attributes:
|
|
|
Returns |
Returns a count of the assets satisfying the condition parameters specified. |
||
|
Examples |
URL:
Result:
|
||
countCollections
|
Function |
Count collections. |
||
|
Description |
This request counts collections based on given conditions. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
long |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
long or string |
Parameter to include child collections. To get a list of collection IDs for a particular
collection, use a call to |
|
|
|
boolean |
Defaults to true.(Optional) |
|
|
|
boolean |
Parameter to include child content types in search criteria. |
|
|
|
long or string |
Specify the string to search for. (Mandatory) You can pass the appropriate value for any queryable attribute to fetch specific attributes. For a list of attributes, use a call to The attributes must be queryable. The following is a lit of non-queryable attributes:
|
|
|
Returns |
Returns a count of the collections satisfying the condition parameters specified. |
||
|
Examples |
URL:
Result:
|
||
countSearchResultsForQuery
|
Function |
Count assets based on saved query. |
||
|
Description |
This request counts resultant assets of saved query. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
long |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
long or string |
Specify the string to search for. (Mandatory) You can pass the appropriate value for any queryable attribute to fetch specific attributes. For a list of attributes, use a call to The attributes must be queryable. The following is a lit of non-queryable attributes:
|
|
|
Returns |
Returns a count of the assets satisfying the specified query. |
||
|
Examples |
URL:
Result:
|
||
countTextSearchResults
|
Function |
Count text search results. |
||
|
Description |
This request counts assets based on given conditions. |
||
|
Type |
GET |
||
|
URL Format |
|
||
|
Java API |
Method Name |
Class Name |
|
|
|
|
||
|
Parameters |
Name |
Type |
Description |
|
|
long |
The op parameter allows you to specify which operation is to be performed. (Mandatory) |
|
|
|
long or string |
Parameter to include child collections. To get a list of collection IDs for a particular
collection, use a call to |
|
|
|
boolean |
Defaults to true.(Optional) |
|
|
|
boolean |
Parameter to include child content types in search criteria. |
|
|
|
long or string |
Specify the string to search for. (Mandatory) You can pass the appropriate value for any queryable attribute to fetch specific attributes. For a list of attributes, use a call to The attributes must be queryable. The following is a lit of non-queryable attributes:
|
|
|
Returns |
Returns a count of the assets satisfying the condition parameters specified. |
||
|
Examples |
URL:
Result:
|
||
