Welcome to Keepeek Help Center

Articles in this section

See more

Search

This relation targets the resource representing a media search result.

Syntax

Search syntax is defined with query strings:

Query parameter Description Arity
q Full-text search parameter, terms are searched in all indexed fields. Its supports Lucene Query parser syntax. [0-1]
f Field based search. Multiple parameter can be used simultaneously [0-n]
fq Filter query parameter. Search terms (f or q parameters) only applies against filtered documents. [0-n]
sort Define the field and the direction to sort results on. [0-1]
page The requested page number in the result list. [0-1]
size Number of media to return per page. [0-1]
fields Specify which field from the representation must be returned [0-1]
notFoundReference Choose to return not found references if some values of field based parameters don't return any media [0-1]
facet-fields Specify a list of facet fields to return instead of the ones configured backoffice side (comma-separated list of facet field IDs, see facet-fields resource) [0-1]
facet-values-number Specify the number of facet values in api response [0-1]

Search examples

Full text search:

  • q=sea wind search for media containing the term sea or wind in one of the indexed field. Default operator is OR.
  • q=+sea -wind search for media containing the term sea excluding the one with the term wind.
  • q="sea wind" search for media containing the phrase "sea media" as is.

Multi criteria field search:

  • f=title:lighthouse search for media with lighthouse in its title field
  • f=title:-lighthouse search for media without lighthouse in its title field
  • f=importDate:[2010-01-01 TO 2014-12-31] ranged search for media imported between years 2010 and 2014. Upper and lower values of the range can be specified as RFC 3339 §5.6 date format or as timestamp from EPOCH.
  • f=updateDate:[2010-01-01 TO 2014-12-31] ranged search for media updated between years 2010 and 2014. Upper and lower values of the range can be specified as RFC 3339 §5.6 date format or as timestamp from EPOCH.
  • f=id:-[100 TO 200] ranged search returning medias which id is not in the range [100-200].
  • f=title:lighthouse*&f=author:"John Smith" search for media with title starting with lighthouse AND from author "John Smith"
  • f=color:1234 search for media with microthesaurus color field containing thesaurus node 1234
  • f=color.ENleaf:fuchsia search for media with microthesaurus color field containing thesaurus node fuchsia

Filter query:

  • fq=folderId:10 the search is restricted to the media of the folder 10
  • fq=folderId:10 subtree the search is restricted to the media of the folder 10 and its sub tree
  • fq=folderId:(10 20) subtree the search is restricted to the media of the folders 10 or 20 and their sub trees
  • fq=folderTitle:archive the search is restricted to the folders with archive in their title. Filter returns media from the matched folders and their sub tree
  • fq=folderPath:foo/bar the search is restricted to the folder bar child of the root folder foo. Filter returns media from the matched folder and its sub tree
  • fq=id:(33 47 107) the search is restricted to the media list provided between parenthesis
  • fq=formId:1 the search is restricted to the media with metadata form 1
  • fq=facet:importDate.FR:2014 the search is restricted to media corresponding to facet entry.
  • fq=thesaurus:back_color:69 the search is restricted to the media with microthesaurus field back_color containing the thesaurus node 69. See thesaurus resources and relations for more information
  • fq=thesaurus:back_color:69 subtree the search is restricted to the media with microthesaurus field back_color containing one of the children node of the thesaurus node 69 sub tree
  • fq=customStatusId:7 the search is restricted to the media with custom status 7. This filter can be used several times to restrict the search to a list of custom statuses.
  • fq=durationInSecond:[0 TO 20] the search is restricted to the media with duration in seconds matching the range [0-20]
  • fq=labelId:1 the search is restricted to the media with label 1. This filter can be used several times to restrict the search to a list of labels.
  • fq=basketId:1 the search is restricted to the media contained in the basket with technical identifier 1 v.4.40.0
  • fq=basketId:(1 2) the search is restricted to the media contained in baskets with technical identifier 1 and 2 v.4.40.0
  • fq=workflowId:1 the search is restricted to the media contained in the workflow with technical identifier 1 v.4.40.0
  • fq=workflowId:(1 2) the search is restricted to the media contained in workflows with technical identifier 1 and 2 v.4.40.0
  • fq=ranked:true this filter is only used for basket or workflow search context (ie. filter basketId or workflowId have to be set), if ranked filter is set to true the search query will return ranked elements, if ranked filter is set to false the search query will return not ranked elements V4.40.0
  • fq=width:[300 TO 800] the search is restricted to media with a width between 300 and 800 px. V.4.48.0
  • fq=width:[* TO 800] the search is restricted to media with a width lower than 800 px. V.4.48.0
  • fq=width:[300 TO *] the search is restricted to media with a width greater than 300 px. V.4.48.0
  • fq=height:[300 TO 800] the search is restricted to media with a height between 300 and 800 px. V.4.48.0
  • fq=height:[* TO 800] the search is restricted to media with a height lower than 800 px. V.4.48.0
  • fq=height:[300 TO *] the search is restricted to media with a height greater than 300 px. V.4.48.0
  • fq=selectionId:ade7f28p the search is restricted to media that are in the current user's selection with ID ade7f28p* - V.4.66.0*
  • fq=associations:1 the search is restricted to medias linked to media with identifier 1 - V.4.94.0
  • fq=associations:(1 2) the search is restricted to medias linked to media with identifier 1 OR 2 (limit of 1000 media ids) - V.4.94.0
  • fq=associations:(1 2) types:5 the search is restricted to medias linked to media with identifier 1 OR 2 (limit of 1000 media ids) and with link type of technical identifier 5 - V.4.94.0
  • fq=associations:(1 2) types:(1 5) the search is restricted to medias linked to media with identifier 1 OR 2 (limit of 1000 media ids) and with link type of technical identifier 1 OR 5 - V.4.95.0
  • fq=columnId:1 the search is restricted to media contained in column with technical identifier 1
  • fq=columnId:(1 2) the search is restricted to media contained in column with technical identifier 1 or 2
  • fq=boardId:1 the search is restricted to media contained in board with technical identifier 1
  • fq=boardId:(1 2) the search is restricted to media contained in board with technical identifier 1 or 2

Notice :

  • Filters on collaborative spaces must not be passed in the same query, an Error HTTP 400 will be thrown
  • If basketId does not correspond to a basket an Error HTTP 400 will be thrown
  • If workflowId does not correspond to a workflow an Error HTTP 400 will be thrown
  • If boardId does not correspond to a board an Error HTTP 400 will be thrown
  • If columnId does not correspond to a board column an Error HTTP 400 will be thrown

Sort:

  • sort=title result list is sorted by title. Default direction is ascendant. Pagination links include the direction
  • sort=title desc result list is sorted by title in descending direction
  • sort=statViews desc result list is sorted by number of views in descending direction
  • sort=statDownloads desc result list is sorted by number of downloads in descending direction
  • sort=fileSize result list is sorted by original file size in ascending direction
  • sort=fileSize desc desc result is sorted by original file size in descending direction
  • sort=totalSize result list is sorted by total file size in ascending direction
  • sort=totalSize desc desc result is sorted by total file size in descending direction

Page & size:

  • size=30 returns result page of 30 items instead of the default value (20)
  • size=30&page=3 returns the third page of result: items from the 91 to 120 row

4.0.1+

Search for medias with duplicates:

  • f=duplicationStatus:DUPLICATES_FOUND search for media with duplicates

4.16.0+

Return not found reference:

  • notFoundReference=true&f=title:lighthouse&f=title:house search for media with lighthouse or house in its title field and return a list of notFoundReference if some criterias don't return medias.
  • With an advanced search, notFoundReference parameter to true is based on first field in filters of advanced search if there is no f parameters otherwise it's one of f parameters. ```json POST { { "_embedded": 
    { "filter":
  [
    {
      "internalFieldName": "couleur",
      "modifier": "EQUALS_ONE",
      "type": "TEXTFIELD",
      "fieldType": "METAFIELD",
      "values":
        [
          "jaune",
          "gris",
          "bleu",
          "rouge"
        ]
    }
  ]
}
    } }

GET GET {path}/api/dam/search/advanced/{advancedSearchId}/media?notFoundReference=true search for media with color in values list and return a list of notFoundReference if some colors don't return medias.

4.66.0+

Get media link count

  • fields=mediaLinkCount add mediaLinkCount property of MediaAPI

4.74.0+

Request custom facets:

  • facet-fields=title,folderName,creation_date the search result will include facets on Title and Creation date fields and on the folder name

4.75.0+

Request custom facets values number:

  • facet-values-number=90 the maximum number of facet values will be set to 90, this parameter can be only used with facet-fields parameters for performance purpose. If this parameter is used without facet-fields parameter the search will return 400 - search-invalid-facets-parameter The maximum value is 150, if the requested value exceeed this value the search will return 400 - search-invalid-facets-parameter

4.104.0

This relation targets the resource representing a media search result without the targeted filter.

4.0.2+

This relation targets the resource representing a basket search result.

Syntax

Search syntax is defined with query strings:

Query parameter Description Arity
q Full-text search parameter, search if basket contains query string [0-1]
fq Filter query parameter. Search term (q parameter) only applies against filtered baskets. [0-n]
sort Define the field and the direction to sort results on. [0-1]
page The requested page number in the result list. [0-1]
size Number of basket to return per page. [0-1]

Search examples

Full text search:

  • q=meeting search for basket containing the term meeting in its title.

Filter query:

  • fq=status:deactivated the search is restricted to baskets with deactivated status
  • fq=status:activated the search is restricted to baskets with activated status
  • fq=bookmarked:true the search is restricted to bookmarked baskets
  • fq=permission:READ the search is restricted to the baskets the connected user can only READ in
  • fq=permission:ADMIN the search is restricted to the baskets the connected user has ADMIN rights on
  • fq=permission:WRITE the search is restricted to the baskets the connected user can WRITE in (returns both WRITE only and ADMIN baskets)
  • fq=uiId:1 the search is restricted to the baskets created in the user-interface with identifier 1.
  • fq=uiId:(1 3) the search is restricted to the baskets created in the user-interface with identifier 1 or 3.
  • fq=admin:true the search will not be restricted by user rights (only accessible for tech admin an admin users). Notice that this filter must not be used with permission filter, in case of those 2 filters are used permission filter will be ignored
  • fq=ownerName:foo the search is restricted to baskets owned by users containing 'foo' in their name
  • fq=tag:EMPTY the search is restricted to baskets without tags
  • fq=tag:CONTAINS_ONE:private;delete the search is restricted to baskets containing at least private tag or delete tag
  • fq=tag:CONTAINS_ALL:private;delete the search is restricted to baskets containing private tag and delete tag
  • fq=tag:CONTAINS_NONE:private the search is restricted to baskets not containing private tag

Sort:

  • sort=title result list is sorted by title. Default direction is ascendant. Pagination links include the direction
  • sort=title desc result list is sorted by title in descending direction
  • sort=statViews desc result list is sorted by number of views in descending direction
  • sort=statDownloads desc result list is sorted by number of downloads in descending direction

Page & size:

  • size=30 returns result page of 30 items instead of the default value (20)
  • size=30&page=3 returns the third page of result: items from the 91 to 120 row

4.0.2+

This relation targets the resource representing a board search result.

Syntax

Search syntax is defined with query strings:

Query parameter Description Arity
q Full-text search parameter, search if board name contains query string [0-1]
fq Filter query parameter. Search term (q parameter) only applies against filtered board. [0-n]
sort Define the field and the direction to sort results on. [0-1]
page The requested page number in the result list. [0-1]
size Number of board to return per page. [0-1]

Search examples

Full text search:

  • q=meeting search for board containing the term meeting in its name.

Filter query:

  • fq=status:deactivated the search is restricted to boards with deactivated status
  • fq=status:activated the search is restricted to boards with activated status
  • fq=admin:true the search will not be restricted by user rights (only accessible for tech admin an admin users).
  • fq=managerName:foo the search is restricted to boards managed by users containing 'foo' in their name
  • fq=tag:EMPTY the search is restricted to boards without tags
  • fq=tag:CONTAINS_ONE:private;delete the search is restricted to boards containing at least private tag or delete tag
  • fq=tag:CONTAINS_ALL:private;delete the search is restricted to boards containing private tag and delete tag
  • fq=tag:CONTAINS_NONE:private the search is restricted to boards not containing private tag

Sort:

  • sort=title result list is sorted by title. Default direction is ascendant. Pagination links include the direction
  • sort=title desc result list is sorted by title in descending direction
  • sort=creationDate desc result list is sorted by the creation date in descending direction
  • sort=updateDate desc result list is sorted by the last modification date in descending direction

Page & size:

  • size=30 returns result page of 30 items instead of the default value (20)
  • size=30&page=3 returns the third page of result: items from the 91 to 120 row

4.105.0

This relation targets the resource representing a group search result.

Syntax

Search syntax is defined with query strings:

Query parameter Description Arity
q Full-text search parameter, search if group contains query string [0-1]
fq Filter query parameter. Search term (q parameter) only applies against filtered groups . [0-n]
sort Define the field and the direction to sort results on. [0-1]
page The requested page number in the result list. [0-1]
size Number of groups to return per page. [0-1]

Search examples

Full text search:

  • q=contrib search for groups containing the term contrib in its name.

Filter query:

  • fq=enabled:true the search is restricted to enabled groups
  • fq=enabled:false the search is restricted to disabled groups

Sort:

  • sort=name result list is sorted by name. Default direction is ascendant. Pagination links include the direction
  • sort=name desc result list is sorted by name in descending direction
  • sort=id result list is sorted by id
  • sort=userCount result list is sorted by number of user in groups
  • sort=expirationDate result list is sorted by group expiration date

Page & size:

  • size=30 returns result page of 30 items instead of the default value (20)
  • size=30&page=3 returns the third page of result: items from the 91 to 120 row

4.20.0+

This relation targets the resource representing a user search result.

Syntax

Search syntax is defined with query strings:

Query parameter Description Arity
q Full-text search parameter, search if user contains query string [0-1]
fq Filter query parameter. Search term (q parameter) only applies against filtered users. [0-n]
sort Define the field and the direction to sort results on. [0-1]
page The requested page number in the result list. [0-1]
size Number of users to return per page. [0-1]

Search examples

Full text search:

  • q=john search for users containing the term john in its first name, last name, login, email or profile name.

Filter query:

  • fq=groupId:10 the search is restricted to users of the group with id 10
  • fq=type:VISITOR the search is restricted to users of visitor's groups
  • fq=type:WRITER the search is restricted to users of writer's groups
  • fq=type:MANAGER the search is restricted to users of manager's groups
  • fq=type:ADMINISTRATOR the search is restricted to users of administrator group
  • fq=login:pascal the search is restricted to user with login is pascal (v.4.42.0)

Sort:

  • sort=lastName result list is sorted by last name. Default direction is ascendant. Pagination links include the direction
  • sort=lastName desc result list is sorted by last name in descending direction
  • sort=id result list is sorted by id
  • sort=login result list is sorted by login
  • sort=firstName result list is sorted by first name
  • sort=acronym result list is sorted by acronym

Page & size:

  • size=30 returns result page of 30 items instead of the default value (20)
  • size=30&page=3 returns the third page of result: items from the 91 to 120 row

4.20.0+

This relation targets the resource representing a user-preferences search result.

Syntax

Search syntax is defined with query strings:

Query parameter Description Arity
fq Filter query parameter. Search term (q parameter) only applies against filtered user's user interface preferences search. [0-n]
sort Define the field and the direction to sort results on. [0-1]
page The requested page number in the result list. [0-1]
size Number of media to return per page. [0-1]

Search examples

  • /search/user-preference get the first 20 user preference.
  • /search/user-preference?fq=uiId:45 get the first 20 user preference where the uiId equals to 45.
  • /search/user-preference?size=20&fq=uiId:45&page=1&sort=preferenceKey get the first 20 user preference where the uiId equals to 45, the result is sorted based on preference Key.

Filter query:

  • fq=uiId:1 the search is restricted to user-preferences of the ui (user interface like back or front) with id 1.
  • fq=preferenceKey:MAIL the search is filtered based on preference key.

Sort:

  • sort=uiId result list is sorted by the UiId in the default direction is ascendant.
  • sort=preferenceKey desc result list is sorted by preferenceId descending direction.

4.36.0+

This relation targets the resource representing a trash search result.

Syntax

Search syntax is defined with query strings:

Query parameter Description Arity
f Field based search (Only trashDate for the moment). Multiple parameter can be used simultaneously [0-n]
sort Define the field and the direction to sort results on. [0-1]
page The requested page number in the result list. [0-1]
size Number of media to return per page. [0-1]
fields Specify which fields from the representation must be returned [0-n]

Search examples

  • /search/trash: to get 20 first medias in trash
  • /search/trash?page=2&size=10: : to get second page with 10 medias per page
  • /search/trash?f=trashDate:20190521: : to get medias in trash with a trash date equals to 21/05/2019
  • /search/trash?f=trashDate:[20190520 TO 20190521]: : to get medias in trash with a trash date between 20/05/2019 and 21/05/2019
  • /search/trash?fields=_embedded{updateUser}: : to get medias in trash with the user who performed the last update
  • /search/trash?fields=_embedded{updateUser,trashUser}: : to get medias in trash with the user who performed the last update and the one who deleted it

4.26.0+

This relation targets the resource representing an autocomplete (terms and folders) search.

Syntax

Search syntax is defined with query strings:

Query parameter Description Arity
q Query [1-1]
limit Define the limit of results for each type (terms and folders and thesaurus). Default 10 and maximum 20. [0-1]
sheetField Only search among the values of certain thesaurus and/or suggestion sheet fields. [0-n]
folder Only search among the name of certain folders and their sub-folders. [0-n]
locale Define locale to use. By default current locale. [0-1]
type (4.61.0+) Return only embedded value corresponding to type('thesaurus or 'folder' or 'term' and by default returns all values). [0-n]
thesaurusId (4.61.0+) Filter on a specific sub tree of a thesaurus. [0-1]
withFolderPath (4.85.0+) Set this parameter to true to include full folder path in folder results. [0-1]

Search examples

  • /search/autocomplete?q=me: to get suggestion terms and folders which contains 'me'
  • /search/autocomplete?q=me&limit=5: to get maximum 5 suggestion terms and 5 suggestion folders which contains 'me'

4.61.0+

  • /search/autocomplete?q=me&type=thesaurus: to get thesaurus results only
  • /search/autocomplete?q=me&type=folder: to get folder results only
  • /search/autocomplete?q=me&type=term&type=thesaurus: to get terms and thesaurus results only
  • /search/autocomplete?q=me&type=thesaurus&thesaurusId=17: to get thesaurus results only filtered on a root thesaurus id

4.27.0+

Sheet field filter

  • /search/autocomplete?q=me&sheetField=color&sheetField=keywords: to get suggestion terms which contains 'me' and that are among the values of sheet fields with id color or keywords (provided fields color and keywords are thesaurus or suggestion fields)

4.53.0+

Folder filter

  • /search/autocomplete?q=me&folder=234&folder=765: to get suggestion terms which contains 'me' and that are the names of folders with id 234 or 765 or one of their sub-folders

4.53.0+

advanced

This relation targets the resource representing the collection of advanced searches. See the Advanced search section below for details

4.32.0+

This relation targets the resource representing a folder search result.

Syntax

Search syntax is defined with query strings:

Query parameter Description Arity
q Full-text search parameter, search if folder name contains query string [0-1]
fq Filter query parameter with folderId [0-n]
sort Define the field and the direction to sort results on. [0-1]
page The requested page number in the result list. [0-1]
size Number of users to return per page. [0-1]
countMedias True to have number of medias by folder [0-1]
withChildrenList True to have embedded children list by folder [0-1]

Search examples

Full text search:

  • q=ven search for folders containing the term ven in its name.

Filter query:

  • fq=folderId:(10 12 105) the search is restricted to folders with id 10, 12 and 105
  • fq=folderId:10 the search is restricted to folders with id 10

If no q and fq parameters, returns all root folders.

Sort:

  • sort=title result list is sorted by folder name. Default direction is ascendant. Pagination links include the direction
  • sort=id result list is sorted by folder id. Default direction is ascendant. Pagination links include the direction
  • sort=sequence result list is sorted by sequence. Default direction is ascendant. Pagination links include the direction By default, sort is equal to 'sequence'

Page & size:

  • size=30 returns result page of 30 items instead of the default value (20)
  • size=30&page=3 returns the third page of result: items from the 91 to 120 row

4.69.0+

facet-fields

This relation targets the resource representing a facet field. A facet field representation follows the following schema:

{
  "properties": {
    "id": {
      "title": "ID",
      "description": "Facet field identifier",
      "type": "string"
    },
    "displayName": {
      "title": "Display name",
      "type": "string"
    },
    "facetType": {
      "title": "Facet type",
      "description": "Type of the facet",
      "type": "string",
      "enum": [
        "SHEET_FIELD",
        "MEDIA_FIELD"
      ]
    },
    "fieldType": {
      "title": "Field type",
      "description": "Type of the field",
      "type": "string",
      "enum": [
        "CHECK_BOX",
        "DATETIME",
        "DATE",
        "EMAIL",
        "FIELD_SET",
        "GEO",
        "HTML",
        "MICROTHESAURUS",
        "MULTIPLE_LIST",
        "NUMBER",
        "PERSON_LIST",
        "SIMPLE_LIST",
        "TEXT",
        "TEXT_AREA",
        "URL",
        "UNKNOWN"
      ]
    }
  }
}

4.75.0+

Related articles