Le service ‹identifiant_type_annexe›/xml permet de récupérer les données d'un type d'annexe.

Type de requête

Requête HTTP GET

Données en entrée

L'identifiant du type d'annexe est inclus dans l'URL du service, qui n'accepte aucun paramètre.

Exemple de requête

Appeler le service pour le type d'annexe dont l'identifiant est 654 se fait via l'URL suivante.

<siteUrl>/654/xml

Données de retour

Voici un exemple de type d'annexe en version XML.

<AnnexType type="object" id="385" iid="385" className="AnnexType">
 <title>Divers</title>
 <creator>system</creator>
 <created type="DateTime">2024/07/16 13:26:55.849000 GMT+2</created>
 <modified type="DateTime">2024/07/16 13:26:55.849000 GMT+2</modified>
 <modifier>system</modifier>
 <record type="object" className="History">
  <data type="list" count="1">
   <e type="object" className="Trigger">
    <transition>_init_</transition>
    <login>system</login>
    <state>active</state>
    <date type="DateTime">2024/07/16 13:26:55.849000 GMT+2</date>
    <comment/>
   </e>
  </data>
  <modified type="DateTime">2024/07/16 13:26:55.849000 GMT+2</modified>
  <modifier>system</modifier>
 </record>
 <annexTypeId>item-annex</annexTypeId>
 <description/>
 <predefinedTitle/>
 <image type="file" mimeType="image/png" name="other.png">
  <part type="base64" number="1">iVBORw0KGgoAAAANSUhEUgA...</part>
 </image>
 <transmitOnly type="bool">False</transmitOnly>
</AnnexType>

Outre les métadonnées classiques présentes sur chaque objet Appy, on notera ici la présence des tags suivants.

• Le tag description permet de disposer d'une description textuelle du type.
• Le tag predefinedTitle permet de spécifier un titre qui sera défini sur chaque annexe de ce type, si l'utilisateur ne définit pas de titre sur son annexe.
• Le tag image contient, encodée en Base64 comme décrit dans l'introduction de cette API,  une icône représentant visuellement le type dans l'interface d'HubSessions.
• Enfin, le tag transmitOnly, s'il vaut True, permet de spécifier qu'un type d'annexe ne peut pas être utilisé par un site HubSessions, excepté dans le contexte d'une transmission d'annexe vers un site tiers. Par exemple, imaginons qu'un HubSessions tiers HT récupère, pour chaque point d'un HubSessions H, un export POD sous la forme d'une annexe. Le type de cette annexe pourra être défini sur H avec transmitOnly valant True: il ne peut pas être affecté à une annexe uploadée manuellement sur H, mais servira à représenter l'annexe générée et stockée sur HT. En ce sens, il fait partie du modèle de données exposé par H.