Paramètres de requête

Les paramètres suivants peuvent être utilisés avec des requêtes.

Tableau 1. Nouveaux paramètres de requête ajoutés aux versions HCL Digital Experience 9.5 CF_172, CF18 et ultérieuresLes nouveaux paramètres suivants fonctionneront à partir des versions HCL Digital Experience 9.5 CF_172 et ultérieures, mais n'existent pas avant ces versions. Cette option est uniquement disponible pour les utilisateurs des versions HCL Digital Experience 8.5 et 9.0 CF18
Paramètre Informations et exemples de paramètres pouvant être ajoutés aux requêtes.
namelikeignorecase Ce paramètre est utilisé comme requête générique pour les objets dont les noms correspondent au paramètre namelike spécifié. Il ignore la casse de la chaîne.
Par exemple:
?namelikeignorecase=nameApproxValue%
Remarque : Les bibliothèques ne peuvent pas être obtenues à l'aide de ce paramètre.
titlelikeignorecase Ce paramètre est utilisé comme requête générique pour les objets dont les titres correspondent au paramètre titlelike spécifié. Il ignore la casse de la chaîne.
Par exemple:
?titlelikeignorecase=nameApproxValue%
titleornamelike Si ce paramètre est défini au lieu de fusionner titlelike et namelike via une condition AND, il sera fusionné via une condition OR.
Tableau 2. Paramètres de requêteVous pouvez également utiliser les paramètres suivants dans la dernière version d'HCL.
Paramètre Informations et exemples de paramètres pouvant être ajoutés aux requêtes.
approver Ce paramètre est utilisé pour obtenir les objets associés à un valideur spécifique. Un ID utilisateur doit être spécifié lorsque ce paramètre est utilisé.
Par exemple:
?approver=userid
authoringtemplateid Ce paramètre est utilisé pour obtenir les objets associés à un ID de modèle de création spécifique.
Par exemple:
?authoringtemplateid=wcmrest:18cfc80c-a490-4d75-9057-fed3db89de53
author Ce paramètre est utilisé pour obtenir les objets associés à un auteur spécifique. Un ID utilisateur doit être spécifié lorsque ce paramètre est utilisé.
Par exemple:
?author=uid=WCMUT_Editor_A,o=defaultWIMFileBasedRealm
categoryid Ce paramètre est utilisé pour obtenir les objets associés à un ID de catégorie spécifique.
Par exemple:
?categoryid=wcmrest:18cfc80c-a490-4d75-9057-fed3db89de53
createdafter Ce paramètre est utilisé pour obtenir les objets qui sont créés après une date et une heure spécifiques.
Par exemple:
?createdafter=2011-01-11T11:43:29.0150Z
createdbefore Ce paramètre est utilisé pour obtenir les objets qui sont créés avant une date et une heure spécifiques.
Par exemple:
?createdbefore=2011-01-11T11:43:29.0150Z
creator Ce paramètre est utilisé pour obtenir les objets associés à un créateur spécifique. Un ID utilisateur doit être spécifié lorsque ce paramètre est utilisé.
Par exemple:
?creator=uid=WCMUT_Editor_A,o=defaultWIMFileBasedRealm
dateformat Ce paramètre est utilisé pour définir le format de date des paramètres de requête.
Par exemple:
?dateformat=mm-dd-yyyy&createdbefore=12-31-2011
Si aucun format de date n'est spécifié, le format par défaut yyyy-MM-dd'T'HH:mm:ssz est appliqué.
depth Ce paramètre est utilisé avec parentid pour définir si la recherche de tous les descendants d'un parent, ou la recherche des enfants immédiats d'un objet parent uniquement, doit être effectuée.
Par exemple, pour obtenir les enfants immédiats d'un objet uniquement, ajoutez &depth=CHILDREN à la requête :
?parentid=wcmrest:18cfc80c-a490-4d75-9057-fed3db89de53&depth=CHILDREN
Pour obtenir tous les descendants d'un objet, ajoutez &depth=DESCENDANTS à la requête :
?parentid=wcmrest:18cfc80c-a490-4d75-9057-fed3db89de53&depth=DESCENDANTS
expireafter Ce paramètre est utilisé pour obtenir les objets qui sont arrivés à expiration après une date et une heure spécifiques.
Par exemple:
?expireafter=2011-01-11T11:43:29.0150Z
expirebefore Ce paramètre est utilisé pour obtenir les objets qui ont expiré avant une date et une heure spécifiques.
Par exemple:
?expirebefore=2011-01-11T11:43:29.0150Z
id Ce paramètre est utilisé pour obtenir un élément associé à un ID spécifique.
Par exemple:
?id=wcmrest:18cfc80c-a490-4d75-9057-fed3db89de53
keyword Ce paramètre est utilisé pour obtenir les objets qui sont profilés avec un mot clé spécifique.
Par exemple:
?keyword=keywordValue
lastmodifiedafter Ce paramètre est utilisé pour obtenir les objets dont la dernière modification est survenue après une date et une heure spécifiques.
Par exemple:
?lastmodifiedafter=2011-01-11T11:43:29.0150Z
lastmodifiedbefore Ce paramètre est utilisé pour obtenir les objets dont la dernière modification est survenue avant une date et une heure spécifiques.
Par exemple:
?lastmodifiedbefore=2011-01-11T11:43:29.0150Z
lastmodifier Ce paramètre est utilisé pour obtenir les objets dont la dernière modification a été effectuée par un utilisateur spécifique. Un ID utilisateur doit être spécifié lorsque ce paramètre est utilisé.
Par exemple:
?lastmodifier=uid=WCMUT_Editor_A,o=defaultWIMFileBasedRealm
libraryid Ce paramètre est utilisé pour obtenir les objets qui sont stockés dans une bibliothèque spécifique.
Par exemple:
?libraryid=wcmrest:18cfc80c-a490-4d75-9057-fed3db89de53
namelike Ce paramètre est utilisé comme requête générique pour les objets dont les noms correspondent au paramètre namelike spécifié.
Par exemple:
?namelike=nameApproxValue%
Remarque : Les bibliothèques ne peuvent pas être obtenues à l'aide de ce paramètre.
name Ce paramètre est utilisé pour obtenir un objet associé à un nom spécifique.
Par exemple:
?name=nameValue
Remarque : Les bibliothèques ne peuvent pas être obtenues à l'aide de ce paramètre.
owner Ce paramètre est utilisé pour obtenir les objets associés à un propriétaire spécifique. Un ID utilisateur doit être spécifié lorsque ce paramètre est utilisé.
Par exemple:
?owner=uid=WCMUT_Editor_A,o=defaultWIMFileBasedRealm
pagesize Ce paramètre est utilisé pour limiter le nombre d'objets renvoyés par une requête à un nombre défini. Il peut être utilisé avec le paramètre page pour renvoyer des pages spécifiques de résultats.
Par exemple, pour limiter le nombre de requêtes renvoyées à 5, entrez :
?type=PresentationTemplate&pagesize=5
page Ce paramètre est utilisé avec le paramètre pagesize pour définir l'ensemble de résultats à afficher. Par exemple, si le paramètre pagesize a pour valeur 5 et que le paramètre page a pour valeur 2, seuls les résultats 6 à 10 sont affichés.
Par exemple:
?type=PresentationTemplate&pagesize=5&page=2
parentid Ce paramètre est utilisé pour obtenir les objets qui sont les enfants d'un objet parent spécifique.
Par exemple:
?parentid=wcmrest:18cfc80c-a490-4d75-9057-fed3db89de53

Vous pouvez utiliser le paramètre depth pour définir si la recherche de tous les descendants, ou la recherche des enfants immédiats d'un objet parent uniquement, doit être effectuée.
projectid Ce paramètre est utilisé pour obtenir les objets qui sont liés à un projet spécifique.
Par exemple:
?projectid=wcmrest:18cfc80c-a490-4d75-9057-fed3db89de53
projectstate Ce paramètre est utilisé pour obtenir les objets qui sont liés à un projet avec un état spécifique. Les valeurs suivantes peuvent être utilisées avec ce paramètre :
  • ACTIVE
  • SYNDICATING
  • PENDING
  • PUBLISHING
  • PUBLISHED
  • PUBLISHED_FAILED
Par exemple, pour obtenir les objets liés à des projets dont l'état est "active", utilisez la requête suivante :
?projectstate=ACTIVE
publishafter Ce paramètre est utilisé pour obtenir les objets qui sont publiés après une date et une heure spécifiques.
Par exemple:
?publishafter=2011-01-11T11:43:29.0150Z
publishbefore Ce paramètre est utilisé pour obtenir les objets qui ont été publiés avant une date et une heure spécifiques.
Par exemple:
?publishbefore=2011-01-11T11:43:29.0150Z
sort Le paramètre sort est ajouté aux requêtes pour déterminer la façon dont les résultats de requête sont triés. Les valeurs suivantes peuvent être utilisées avec le paramètre sort :
  • author
  • created
  • modified
  • name
  • title
  • parents
  • position

Les valeurs _ascending ou _descending sont ajoutées à la requête pour déterminer l'ordre de tri.

Par exemple, pour trier une requête de modèles de présentation par ordre croissant de création, utilisez :
?type=PresentationTemplate&sort=created_ascending
Pour trier une requête de modèles de présentation par ordre décroissant de création, utilisez :
?type=PresentationTemplate&sort=created_descending
Si la valeur _ascending ou _descending n'est pas spécifiée, les résultats apparaissent par ordre croissant.
state Ce paramètre est utilisé pour obtenir les objets qui sont dans un état spécifique. Les valeurs suivantes peuvent être utilisées avec ce paramètre :
  • DRAFT
  • PUBLISHED
  • EXPIRED
Par exemple:
?state=PUBLISHED
titlelike Ce paramètre est utilisé comme requête générique pour les objets dont les titres correspondent au paramètre titlelike spécifié.
Par exemple:
?titlelike=nameApproxValue%
title Ce paramètre est utilisé pour obtenir un objet associé à un titre spécifique.
Par exemple:
?title=titleValue
type Ce paramètre est utilisé pour obtenir les objets d'un type spécifique.
Par exemple, pour interroger une liste de composants :
?type=LibraryHTMLComponent
workflowid Ce paramètre est utilisé pour obtenir les objets qui utilisent un flux de travaux spécifique.
Par exemple:
?workflowid=wcmrest:8d25860b-7a5c-4015-9cd5-bdcc60ce14bb
workflowstageid Ce paramètre est utilisé pour obtenir les objets qui sont actifs dans une étape de flux de travaux spécifique.
Par exemple:
?workflowstageid=wcmrest:18cfc80c-a490-4d75-9057-fed3db89de53

Utilisation de plusieurs paramètres

  • Vous ne pouvez spécifier plusieurs instances d'un même type de paramètre dans une requête que sous forme de requêtes "OR", avec les exceptions suivantes :
    Une valeur seulement admise
    Une instance seulement des paramètres ci-dessous est admise dans une requête unique. Si plusieurs instances sont utilisées, la première instance seulement est appliquée par la requête :
    • categoryid
    • dateformat
    • depth
    • page
    • pagesize
    Requêtes "AND" admises
    Les requêtes suivantes peuvent être utilisées sous forme de requêtes "AND" :
    • createdafter
    • createdbefore
    • expireafter
    • expirebefore
    • lastmodifiedafter
    • lastmodifiedbefore
    • publishafter
    • publishbefore
    Valeurs de tri
    Les valeurs de tri sont séparées par une virgule. Par exemple:
    ?sort=created_ascending,title_descending