Paramètres de requête supplémentaires

Pour vous permettre de spécifier l'extension et le contenu d'un flux demandé, des paramètres de requête supplémentaires sont à votre disposition. Tous les paramètres de requête supplémentaires sont facultatifs.

Niveaux

Vous pouvez demander un flux d'une ressource qui est maintenue dans un modèle d'arborescence. Dans ce cas, il est possible de paramétrer l'URL en fonction du nombre de niveaux que la réponse doit contenir, de la manière suivante : 

   [ &levels = levelcount ]
levelcount est une valeur entière supérieure à zéro. La signification des valeurs est la suivante :
0
Valeur non valide et par conséquent renvoie 400: Bad Request.
1
Représente le noeud de modèle proprement dit. En tant que client, vous pouvez obtenir une sous-arborescence d'un modèle en demandant la racine de la sous-arborescence de votre choix et les niveaux qui se trouvent en-dessous.
2
Représente le noeud demandé y compris les enfants directs.
>2
Il s'agit des entrées pour le noeud demandé et ses enfants jusqu'au niveau de profondeur spécifié. La longueur de chemin d'accès maximale est limitée par le profondeur maximale du (sous) modèle et du compte de niveaux demandés.
tout
Si vous spécifiez cette valeur, le flux obtenu inclut tous les descendants du noeud racine demandé. Comme il peut s'agir d'un appel coûteux, un client doit l'utiliser uniquement pour le modèle de présentation ou à titre de test.
(absent)
Equivalent à un paramètre de niveaux all .
Le paramètre level pour le modèle de portlet :
PortletModel n'est pas un modèle d'arborescence, la signification du paramètre level est donc différente dans le contexte PortletModel. Vous pouvez le définir aux valeurs suivantes :
0
Valeur non valide et par conséquent retourne un 400: Bad Request.
<0
Retourne à tous les parents de la hiérarchie ci-dessus l'ID d'objet donné avec les profondeurs de la valeur spécifiée.
(absent)
Retourne un flux ATOM qui contient le noeud du PortletModel adressé. Equivalent pour un paramètre de niveaux ayant la valeur -1.
1
Equivalent à une valeur -1.
-all
Renvoie tous les niveaux jusqu'à l'application Web racine.

Les paramètres level et mode s'excluent mutuellement si la valeur définie pour mode est view.

Example : URL spécifiant de façon explicite que la réponse retournée doit contenir le noeud proprement dit ainsi que ses enfants directs : 
   /wps/mycontenthandler?uri=nm:oid:wps.content.root&levels=2

Mode de représentation

Si le flux transporte toujours toutes les informations disponibles, celui-ci est important. Il existe donc un moyen de limiter la taille du flux. Le paramètre de requête rep permet d'indiquer le volume des informations transportées. Utilisez le paramètre comme suit :

[ &rep = compact | full | empty ]

Vous pouvez définir le paramètre aux valeurs suivantes :

Compacte
Il s'agit de la valeur par défaut pour les liens générés. Pour des raisons de performances, ceci réduit le volume des informations retournées à un sous-ensemble des éléments les plus importants. La signification du mode de représentation compact est définie séparément et est différente pour chaque modèle.
complet
Le mode de représentation expose toutes les informations disponibles.
vide
Le mode de représentation empty retourne un corps en non réponse. Toutefois, les en-têtes de réponse, et notamment le code d'état HTTP sont les mêmes que lorsque vous utilisez les modes de représentation compact ou full. Par exemple, vous pouvez utiliser ce mode si un client souhaite modifier la ressource, sans évaluer la réponse pour des raisons de performances.
(absent)
Si vous omettez le paramètre, le mode de représentation full est alors utilisé.

Paramètre extension

Dans des cas d'utilisation spécifiques, par exemple dans le contexte d'une fédération, il existe un paramètre qui vous autorise à manipuler l'autre lien ATOM, également appelé lien view. La valeur spécifiée pour ce paramètre doit être URI. Si vous spécifiez ce paramètre, la SPI du modèle distant exécute une recherche POC (Piece Of Content) via l'interface com.ibm.portal.resolver.LookupService avec le mode view et l'URI donné. Dans ce cas, la SPI du modèle distant utilise le service de recherche par défaut. Utilisez le paramètre comme suit :

[ &extension=uri ]

Métadonnées explicites

Certains noms de métadonnées sont masqués, car ils ne sont pas exposés dans l'itérateur des métadonnées ; il s'agit par exemple de tous les noms commençant par com.ibm.portal. Ces noms n'apparaissent pas non plus dans un flux.

Dans le mode de représentation compact aucune métadonnée ne peut être exposée, bien que certaines d'entre elles soient requises. En conséquence, pour pouvoir les exposer dans un flux, vous devez explicitement les demander. Pour cela, utilisez le paramètre &mdname comme suit :
[ &mdname=string ]
Vous pouvez utiliser le paramètre mdname plusieurs fois dans la même URL.
Example : Cette URL indique de façon explicite que les métadonnées com.ibm.portal.Hidden qui seraient sinon masquées sont exposées dans la réponse retournée : 
/wps/mycontenthandler?uri=nm:oid:wps.content.root&mdname=com.ibm.portal.Hidden