-
@JvmSuppressWildcards() public interface QueriesApi
-
-
Method Summary
Modifier and Type Method Description abstract NodePagingfindNodes(@Query(value = term) String term, @Query(value = rootNodeId) String rootNodeId, @Query(value = skipCount) Integer skipCount, @Query(value = maxItems) Integer maxItems, @Query(value = nodeType) String nodeType, @Query(value = include) List<String> include, @Query(value = orderBy) List<String> orderBy, @Query(value = fields) List<String> fields)Find nodes Note: this endpoint is available in Alfresco 5.2 and newer versions. abstract PersonPagingfindPeople(@Query(value = term) String term, @Query(value = skipCount) Integer skipCount, @Query(value = maxItems) Integer maxItems, @Query(value = fields) List<String> fields, @Query(value = orderBy) List<String> orderBy)Find people Note: this endpoint is available in Alfresco 5.2 and newer versions. abstract SitePagingfindSites(@Query(value = term) String term, @Query(value = skipCount) Integer skipCount, @Query(value = maxItems) Integer maxItems, @Query(value = orderBy) List<String> orderBy, @Query(value = fields) List<String> fields)Find sites Note: this endpoint is available in Alfresco 5.2 and newer versions. -
-
Method Detail
-
findNodes
@Headers(value = {Content-Type: application/json})@GET(value = alfresco/versions/1/queries/nodes) abstract NodePaging findNodes(@Query(value = term) String term, @Query(value = rootNodeId) String rootNodeId, @Query(value = skipCount) Integer skipCount, @Query(value = maxItems) Integer maxItems, @Query(value = nodeType) String nodeType, @Query(value = include) List<String> include, @Query(value = orderBy) List<String> orderBy, @Query(value = fields) List<String> fields)Find nodes Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets a list of nodes that match the given search criteria. The search term is used to look for nodes that match against name, title, description, full text content or tags. The search term: - must contain a minimum of 3 alphanumeric characters - allows \"quoted term\" - can optionally use '*' for wildcard matching By default, file and folder types will be searched unless a specific type is provided as a query parameter. By default, the search will be across the repository unless a specific root node id is provided to start the search from. You can sort the result list using the orderBy parameter. You can specify one or more of the following fields in the orderBy parameter: * name * modifiedAt * createdAt The endpoint is owned by defaultname service owner
- Parameters:
term- The term to search for.rootNodeId- The id of the node to start the search from.skipCount- The number of entities that exist in the collection before those included in this list.maxItems- The maximum number of items to return in the list.nodeType- Restrict the returned results to only those of the given node type and its sub-types (optional)include- Returns additional information about the node.orderBy- A string to control the order of the entities returned in a list.fields- A list of field names.
-
findPeople
@Headers(value = {Content-Type: application/json})@GET(value = alfresco/versions/1/queries/people) abstract PersonPaging findPeople(@Query(value = term) String term, @Query(value = skipCount) Integer skipCount, @Query(value = maxItems) Integer maxItems, @Query(value = fields) List<String> fields, @Query(value = orderBy) List<String> orderBy)Find people Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets a list of people that match the given search criteria. The search term is used to look for matches against person id, firstname and lastname. The search term: - must contain a minimum of 2 alphanumeric characters - can optionally use '*' for wildcard matching within the term You can sort the result list using the orderBy parameter. You can specify one or more of the following fields in the orderBy parameter: * id * firstName * lastName The endpoint is owned by defaultname service owner
- Parameters:
term- The term to search for.skipCount- The number of entities that exist in the collection before those included in this list.maxItems- The maximum number of items to return in the list.fields- A list of field names.orderBy- A string to control the order of the entities returned in a list.
-
findSites
@Headers(value = {Content-Type: application/json})@GET(value = alfresco/versions/1/queries/sites) abstract SitePaging findSites(@Query(value = term) String term, @Query(value = skipCount) Integer skipCount, @Query(value = maxItems) Integer maxItems, @Query(value = orderBy) List<String> orderBy, @Query(value = fields) List<String> fields)Find sites Note: this endpoint is available in Alfresco 5.2 and newer versions. Gets a list of sites that match the given search criteria. The search term is used to look for sites that match against site id, title or description. The search term: - must contain a minimum of 2 alphanumeric characters - can optionally use '*' for wildcard matching within the term The default sort order for the returned list is for sites to be sorted by ascending id. You can override the default by using the orderBy parameter. You can specify one or more of the following fields in the orderBy parameter: * id * title * description The endpoint is owned by defaultname service owner
- Parameters:
term- The term to search for.skipCount- The number of entities that exist in the collection before those included in this list.maxItems- The maximum number of items to return in the list.orderBy- A string to control the order of the entities returned in a list.fields- A list of field names.
-
-
-
-