Pleade API

To do :

Une liste exhaustive est disponible dans la page Doc/Pleade/API/Liste-brute, mais elle a besoin d'être nettoyée.

EAD

Obtenir la liste des fichiers dans un répertoire

• functions/ead/img-server/chemin/relatif/à/image-racines/dir.xml
• img-viewer/chemin/relatif/à/image-racines/dir.xml

On obtient uniquement les fichiers (pas de répertoire).

<dir:directory name="RESH7844_1849" lastModified="1339067248000" date="2012-06-07T13:07:28+0200" size="155648" sort="name" reverse="false" requested="true" chemin-base="" chemin-serie="almanachs/RESH7844_1849">
	<dir:file name="B452346101_RESH7844_1849_001.jpg" lastModified="1339066973000" date="2012-06-07T13:02:53+0200" size="73330" width="320" height="1680" dpi="300" mimetype="image/jpeg"/>
	<dir:file name="B452346101_RESH7844_1849_002.jpg" lastModified="1339066974000" date="2012-06-07T13:02:54+0200" size="250945" width="1968" height="1480" dpi="300" mimetype="image/jpeg"/>
	<dir:file name="B452346101_RESH7844_1849_003.jpg" lastModified="1339066974000" date="2012-06-07T13:02:54+0200" size="239972" width="1824" height="1480" dpi="300" mimetype="image/jpeg"/>
	<dir:file name="B452346101_RESH7844_1849_004.jpg" lastModified="1339066974000" date="2012-06-07T13:02:54+0200" size="260693" width="1920" height="1512" dpi="300" mimetype="image/jpeg"/>
...
</dir:directory>

Obtenir la liste des termes indexés

functions/sdx-terms.xml?&base=base&field=field&value=value

Seul le champs field est nécessaire. Les champs base et value sont optionnel.

<sdx:document xml:lang="fr" server="http://ad33.dev/ad33" api-url="http://ad33.dev/ad33/sdx/api-url" app="org.pleade3.demo" appbypath="module-eadeac" uri="http://ad33.dev/ad33/functions/sdx-terms.xml" query="?&field=ad33:commune-name-normal" version="2.4.1.4" build="2012091901" date="Mon Oct 01 16:33:11 CEST 2012">
	<sdx:terms name="ad33:commune-name-normal" field="ad33:commune-name-normal" qid="sdx_q2" page="1" hpp="20" pages="2" nb="24" start="1" end="20" id="sdx_q2" currentPage="1" nbPages="2">
		<sdx:multibase>
			<sdx:base sdxdbid="ead" nb="1"/>
			<sdx:base sdxdbid="" nb="23"/>
		</sdx:multibase>
		<sdx:term no="1" value="Aillas (Gironde, France)" escapedValue="Aillas+%28Gironde%2C+France%29" field="ad33:commune-name-normal" docs="1" id="FRAD033_IR_4E_S4_de-4843" base="ead" app="org.pleade3.demo" docId="FRAD033_IR_4E_S4_de-4843" docFreq="1"/>
		...
		<sdx:term no="20" value="Sillas (Gironde, France)" escapedValue="Sillas+%28Gironde%2C+France%29" field="ad33:commune-name-normal" docs="285" docFreq="285"/>
	</sdx:terms>
</sdx:document>

Obtenir un fragment EAD

ead-fragment.debug?c=pleade:id

<sdx:document xml:lang="fr" server="http://earchives.cg64.fr/e-archives" api-url="http://earchives.cg64.fr/e-archives/sdx/api-url" app="org.pleade3.demo" appbypath="module-eadeac" uri="http://earchives.cg64.fr/e-archives/ead-fragment.debug" query="?base=ead&id=FRAD064003_IR0009_de-2&hilite=true&c=FRAD064003_IR0009_de-2" version="2.4.1.2" build="2010052701" date="Mon Oct 01 14:14:05 GMT 2012">
	<pleade:subdoc pleade:eadid="FRAD064003_IR0009" id="de-2" level="file" pleade:no="61" pleade:pos="00001.00002" pleade:id="FRAD064003_IR0009_de-2" pleade:component="true" pleade:title="Droits de la vallée d'Aspe à une rente bisanuelle de 100 florins d'or sur Jaca" pleade:break="true" pleade:toc="true">
		<pleade:ancestors pleade:eadid="FRAD064003_IR0009" pleade:ead-title="Sous-série 1 J">
			<pleade:ancestor level="recordgrp" pleade:no="28" pleade:pos="00001" pleade:id="FRAD064003_IR0009_e0000028" pleade:component="true" pleade:title="Sous-série 1 J" pleade:break="true" pleade:toc="true"/>
		</pleade:ancestors>
		<c pleade:original-element="c" id="de-2" level="file" pleade:no="61" pleade:pos="00001.00002" pleade:id="FRAD064003_IR0009_de-2" pleade:component="true" pleade:title="Droits de la vallée d'Aspe à une rente bisanuelle de 100 florins d'or sur Jaca" pleade:break="true" pleade:toc="true">
			<did pleade:no="62" pleade:id="FRAD064003_IR0009_e0000062">
				<unitid label="Cotes extrêmes" pleade:no="63" pleade:id="FRAD064003_IR0009_e0000063">1 J 2</unitid>
				<unittitle label="Intitulé de l'unité documentaire" pleade:no="64" pleade:id="FRAD064003_IR0009_e0000064">Droits de la vallée d'Aspe à une rente bisanuelle de 100 florins d'or sur Jaca</unittitle>
				<unitdate label="Date de l'unité documentaire" normal="1524/1866" era="ce" calendar="gregorian" pleade:no="65" pleade:id="FRAD064003_IR0009_e0000065">1524-1866</unitdate>
			</did>
			<scopecontent pleade:no="66" pleade:id="FRAD064003_IR0009_e0000066">
				<head pleade:no="67" pleade:id="FRAD064003_IR0009_e0000067">Présentation du contenu</head>
				<p pleade:no="68" pleade:id="FRAD064003_IR0009_e0000068">Grosse 1524-1525 et consultations franco-espagnoles de 1865-1866.</p>
			</scopecontent>
			<controlaccess pleade:no="69" pleade:id="FRAD064003_IR0009_e0000069">
				<head pleade:no="70" pleade:id="FRAD064003_IR0009_e0000070">Descripteurs</head>
				<geogname pleade:no="71" pleade:id="FRAD064003_IR0009_e0000071" pleade:index-list="geogname" pleade:index-id="geogname" pleade:value="Aspe (vallée d')" pleade:index-local="true" pleade:index-local-name="lfgeogname">Aspe (vallée d')</geogname>
				<geogname pleade:no="72" pleade:id="FRAD064003_IR0009_e0000072" pleade:index-list="geogname" pleade:index-id="geogname" pleade:value="Jaca (Espagne)" pleade:index-local="true" pleade:index-local-name="lfgeogname">Jaca (Espagne)</geogname>
			</controlaccess>
		</c>
	</pleade:subdoc>
</sdx:document>

Obtenir un formulaire de recherche

functions/get-search-form.xml

<form action="results.html" max-chars="50" documents="ead">
	<key type="text" field="extfulltext" />
</form>

Paramètre de la Query String

functions/get-request-params.xml

<h:request target="/ad33/functions/get-request-params.xml" sitemap="functions/get-request-params.xml" source="">
	<h:requestHeaders>
		<h:header name="host">ad33.dev</h:header>
		<h:header name="user-agent">AJLSM; Ed; Linux Mint 11 Katya; Linux x86_64;</h:header>
		<h:header name="accept">text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8</h:header>
		<h:header name="accept-language">en-US,en,fr-FR;q=0.9,fr;q=0.9,en-GB;q=0.8,de-de;q=0.8,de;q=0.7,id-ID;q=0.7,id;q=0.6,en-UK;q=0.6,ru-RU;q=0.5,ru;q=0.5,fr-FR.UTF-8;q=0.5,en-US-x-Hixie;q=0.4,en-AU;q=0.4,zh-CN;q=0.3,zh;q=0.3,en-US.UTF-8;q=0.2,es-ES;q=0.2,es;q=0.1,bn-IN;q=0.1,bn;q=0.0</h:header>
		<h:header name="accept-encoding">gzip, deflate</h:header>
		<h:header name="DNT">1</h:header>
		<h:header name="connection">keep-alive</h:header>
		<h:header name="cookie">pleade-zones=local; pleade-zone=local; JSESSIONID=4E684A7F3AEFE4F9A9D23C1B700840BE</h:header>
	</h:requestHeaders>
	<h:requestParameters>
		<h:parameter name="cop10">
			<h:value>AND</h:value>
		</h:parameter>
		<h:parameter name="hidden2">
			<h:value>true</h:value>
		</h:parameter>
		<h:parameter name="hidden1">
			<h:value>true</h:value>
		</h:parameter>
		<h:parameter name="name">
			<h:value>etat-civil-custom</h:value>
		</h:parameter>
		<h:parameter name="base">
			<h:value>ead</h:value>
		</h:parameter>
		<h:parameter name="fv">
			<h:value>état civil</h:value>
			<h:value>true</h:value>
			<h:value>état civil</h:value>
			<h:value>true</h:value>
			<h:value>état civil</h:value>
			<h:value>true</h:value>
		</h:parameter>
		<h:parameter name="query8">
			<h:value/>
		</h:parameter>
...
		<h:parameter name="n-start">
			<h:value>0</h:value>
		</h:parameter>
	</h:requestParameters>
	<h:configurationParameters/>
	<h:remoteUser/>
</h:request>

Visionneuse

Tester si une image est disponible

To do :

À vérifier avec les pipelines.

• /img-server/path/to/image/directory/eadimage.xml?pleade-url=path/to/image/directory/&pleade-img=filename.ext

La valeur de l'attribut find indique si l'image à été résolue (true) ou non (false).

<result>
	<eadimage
		src="__thumbs__/vignette/FRAD033/E/4E/4E108T1/FRAD033_4E108T1_0001_P.jpg"
		href="FRAD033/E/4E/4E108T1/viewer.html"
		vsize="&w=150&h=150"
		psrchidef="/FRAD033/E/4E/4E108T1/"
		find="true"
/>
</result>

Liste exhaustive des APIs

Notice :

Une liste exhaustive est disponible dans la page Doc/Pleade/API/Liste-brute, mais elle a besoin d'être nettoyée.

Script de génération

#!/bin/bash

workingDir="$HOME/build/pleade-entreprise"
rm /tmp/api.txt
for x in "$workingDir"/**/*.xmap
do
  file="${x/$workingDir\//}";
  (
    printf "== %s ==\n" "$file";
    xmlstarlet sel -N map="http://apache.org/cocoon/sitemap/1.0" \
    -t -m "//map:match[contains(@pattern,'function') and not(contains(@pattern,'xsl'))]" \
    -o '=== ' -v "@pattern" -o '===' -n \
    -o '@internal-only: [' -v 'ancestor::map:pipeline/@internal-only' -o ']' -n \
    -o ' ' -v "@pattern" -n \
    -n "$x"
  ) | tee -a /tmp/api.txt
done