Documentation SDX v 1.1 - Documentation de l'API URL

Cette servlet permet de retourner un document XML géré par SDX. Les paramètres sont :

db (obligatoire)	Le code de la base de documents.
id (obligatoire)	L'identificateur du document désiré.

Exemple :

http://sdx.culture.fr/sdx/servlets/get?db=sdxdoc&id=api_url

Cette servlet permet d'obtenir un document attaché à un document XML dans son format natif. Les paramètres sont :

db (obligatoire)	Le code de la base de documents.
id (obligatoire)	L'identificateur du document attaché recherché.
doc (obligatoire)	L'identificateur du document XML auquel est attaché le document recherché.

Exemple :

http://sdx.culture.fr/sdx/servlets/getatt?db=sdxdoc&doc=api_url&id=fig001

Elle permet de retourner une liste d'utilisateurs enregistrés dans SDX, pour l'ensemble de l'installation ou pour une base de documents en particulier. Les paramètres permis sont :

db	Le code de la base de documents dont on veut obtenir la liste des utilisateurs. S'il n'est pas spécifié, tous les utilisateurs seront retournés.

Exemple :

http://sdx.culture.fr/sdx/servlets/users?db=sdxdoc

Les résultats seront présentés en XML selon le format users.

Cette servlet permet de retourner les valeurs d'une table externe associée à une base de documents. Les paramètres sont :

db (obligatoire)	Le code de la base de documents.
t (obligatoire)	Le code de la table tel que défini dans la configuration de la base de documents.
w	Le contenu d'une clause WHERE en SQL pour filtrer le contenu de la table.

Exemple :

http://sdx.culture.fr/sdx/servlets/tabledata?db=sdxdoc&t=tdm&w=id='api_url'

Les résultats seront présentés en XML selon le format tableValues.

Cette servlet permet de retourner une liste de termes issus d'un index, c'est-à-dire d'un champ de recherche défini dans la base de documents ou d'un champ de recherche système. Les paramètres sont :

db (obligatoire)	Le code de la base de documents.
f (obligatoire et répétable)	Le code du champ de recherche. Il peut y avoir plusieurs occurrences de ce paramètre. Dans ce cas, la dernière occurrence représente le code du champ, et les précédentes représentent des codes de champs qui servent de filtre.
p	Le numéro de page pour le retour des listes de termes. Si absent, la première page sera retournée.
h	Le nombre de termes par pages. Si absent, on affiche 20 termes par pages.
v (répétable)	Des valeurs à appliquer comme filtre. Il doit y avoir une occurrence de moins que le paramètre f. La première occurrence est associée à la première occurrence du paramètre f. Ensemble, il définissent un critère de filtre pour la liste des termes affichés. Ainsi, seuls les termes dont au moins un document qui le possède respecte ce filtre seront retournés.

Exemple :

http://sdx.culture.fr/sdx/servlets/terms?db=sdxdoc&f=region&v=Aquitaine&f=dpt&p=2

Cette liste de termes pourrait correspondre, logiquement, aux départements de la région Aquitaine. On affiche la deuxième page de termes, donc les termes 21 à 40.

Les résultats sont présentés en XML selon le format terms.

Cette servlet permet de convertir un document HTML en format XHTML, donc XML. Cette servlet utilise le programme HTML Tidy (version Java). Cette opération n'apporte aucune valeur ajoutée, mais permet de traiter des documents HTML à l'aide d'outils XML comme XSLT.

Pour l'instant, la seule information requise par cette servlet est la localisation du document HTML à convertir. Cette localisation peut être fournie par un nom de fichier (relatif ou absolu) ou par une URL absolue. Les paramètres vérifiés sont (dans l'ordre de priorité) :

u	L'URL abslue du fichier HTML.
r	L'URL relative du fichier HTML. L'URL de base sera soit l'URL de base du serveur SDX, soit celle fournie par le paramètre b.
b	L'URL de base lorsqu'on fournit une URL relative. Ce paramètre est toutefois optionnel, s'il n'est pas spécifié l'URL de base sera l'URL de l'installation de SDX.
p	Le chemin d'accès complet et absolu du fichier HTML, disponible sur le serveur.

Aucun autre paramètre ne peut être fourni. Eventuellement, des paramètres contrôlant le type de conversion vers XHTML pourront être inclus.

La plate-forme SDX propose plusieurs types de requêtes de recherche. Toutes utilisent le même outil de base, mais elles offrent au développeur d'applications des façons plus simples d'effectuer les requêtes.

Toutes ces méthode de recherche ont leur équivalent dans l'API URL sauf les requêtes complexes. Il existe donc six servlets qui proposent autant de méthodes de recherche, ces servlets partageant plusieurs caractéristiques communes.

Les caractéristiques communes

Toutes les servlets de cette section retournent des résultats en XML selon le format results.

De plus, elles paratagent un jeu de paramètres qui ont tous la même signification que voici.

db (obligatoire)	Le code de la base de documents.
n	L'identifiant d'une requête de recherche. S'il est spécifié et qu'il correspond à une requête stockée, la requête ne sera pas réexécutée mais réaffichée, potentiellement avec une page de résultats différentes.
p	Le numéro de page pour le retour des résultats de recherche. Si absent, la première page sera retournée.
h	Le nombre de résultats par pages. Si absent, on affiche 20 résultats par pages.
d	Si ce paramètre est présent et qu'il contient une valeur vraie (par exemple 1 ou true) alors les documents complets seront inclus dans les résultats, pas seulement les champs de recherche.
ff (répétable)	Ce paramètre indique les champs qui constituent des filtres à appliquer à la recherche.
fv (répétable)	Ce paramètre indique les valeurs de champs qui constituent des filtres à appliquer à la recherche. Il doit y en avoir le même nombre que le paramètre f.
fo	Ce paramètre indique l'opérateur qui connecte les différents critères de filtre (paramètres ff et fv). Il peut prendre les valeurs and ou or, et s'il est absent on suppose un opérateur ET logique.
bq	L'identifiant d'une requête qui servira de requête de base pour cette recherche. Cette requête de base sera combinée avec la requête en cours selon l'opérateur spécifié avec le paramètre bo, ou l'opérateur ET logique si ce dernier n'est pas spécifié.
bo	L'opérateur reliant la requête en cours à la requête de base spécifiée par le paramètre bq. Il peut prendre les valeurs and, or ou not, s'il est absent on suppose un ET logique.
sf (répétable)	Un code champ constituant une clé de tri. On peut utiliser autant de clés de tri que l'on désire. Par défaut, on utilise l'ordre ascendant pour le tri.
so (répétable)	Un ordre pour la clé de tri. Ces ordres correspondent au champ identifié par le paramètre sf correspondant. Par défait, on suppose un ordre ascendant. Les valeurs de ce paramètre peuvent être desc ou asc.

simplesearch

Permet d'effectuer une requête simple (selon la classe fr.gouv.culture.sdx.query.SDXSimpleQuery). En plus des paramètres communs, on peut utiliser :

q (obligatoire)

La requête de recherche.

restrictedsearch

Permet d'effectuer une requête restreinte (selon la classe fr.gouv.culture.sdx.query.SDXRestrictedQuery). En plus des paramètres communs, on peut utiliser :

q (obligatoire)	La requête de recherche.
f	Le champ où s'effectue la recherche. S'il n'est pas présent, on utilisera le champ de recherche par défaut pour la base de documents.

exactfieldsearch

Permet d'effectuer une requête exacte sur un champ (selon la classe fr.gouv.culture.sdx.query.SDXExactFieldQuery). En plus des paramètres communs, on peut utiliser :

q (obligatoire)	La requête de recherche.
f	Le champ où s'effectue la recherche. S'il n'est pas présent, on utilisera le champ de recherche par défaut pour la base de documents.

datesearch

Permet d'effectuer une requête sur un intervalle de date (selon la classe fr.gouv.culture.sdx.query.SDXDateIntervalQuery). En plus des paramètres communs, on peut utiliser :

f	Le champ où s'effectue la recherche. S'il n'est pas spécifié, on utilisera le champ par défaut.
bd	La date de début de l'intervalle. S'il n'est pas spécifié, la requête n'est pas bornée en début d'intervalle.
ed	La date de fin d'intervalle. S'il nest pas spécifié, la requête n'est pas bornée en fin d'intervalle.

fieldsearch

Permet d'effectuer une requête dans un champ (selon la classe fr.gouv.culture.sdx.query.SDXFieldQuery). En plus des paramètres communs, on peut utiliser :

q (obligatoire)	La requête de recherche.
f	Le champ où s'effectue la recherche. S'il n'est pas présent, on utilisera le champ de recherche par défaut pour la base de documents.

linearsearch

Permet d'effectuer une requête linéaire (selon la classe fr.gouv.culture.sdx.query.SDXLinearQuery). En plus des paramètres communs, on peut utiliser :

q (obligatoire, répétable)	Les expressions recherchées..
f (répétable)	Les champs s'effectuent les recherches. S'il n'est pas spécifié, on utilise le champ par défaut.
o	Les opérateurs qui relient les critères de recherche. S'il n'est pas spécifié, on suppose un ET logique.