Accès aux données avec les API Vuforia > API Vuforia > Accès à une liste de procédures publiées > Effectuer l'appel d'API > Annexe
  
Annexe
L'API décrite dans cette section (ExperienceService/<orgid>/cms/projects/_default/distro/procedures) récupère la liste des procédures publiées. Par défaut, toutes les sessions sont renvoyées et les résultats peuvent être filtrés à l'aide d'un ou de plusieurs paramètres de requête. Les résultats sont ensuite répartis sur 100 pages de session, chacune contenant un lien vers la page suivante.
Le tableau suivant fournit des informations sur tous les paramètres de requête disponibles pouvant être utilisés pour filtrer les résultats dans l'API.
Paramètre
Type
Description
include
string
(requête)
Paramètre facultatif qui filtre ou augmente la liste des procédures. Ce paramètre peut être défini sur l'une des valeurs suivantes :
publishedonly : renvoie uniquement les procédures publiées.
unpublished : renvoie des procédures publiées et non publiées qui ont été publiées à un moment donné.
unpublisheddistributed : renvoie les procédures publiées et toutes les procédures non publiées auxquelles au moins un lecteur est affecté.
La propriété status des données renvoyées peut être utilisée pour dériver le statut actuel d'une procédure. Lorsque le statut est 0, la procédure est à l'état Non publié. Lorsque le statut est autre que 0, la procédure est à l'état Publié.
Par défaut, cette valeur est définie sur unpublisheddistributed.
includeallunpublished
* 
Ce paramètre est obsolète.
string
(requête)
Paramètre facultatif qui renvoie toutes les procédures non publiées, quel que soit leur statut de distribution.
La propriété status des données renvoyées peut être utilisée pour dériver le statut actuel d'une procédure. Lorsque le statut est 0, la procédure est à l'état Non publié. Lorsque le statut est autre que 0, la procédure est à l'état Publié.
Par défaut, cette valeur est définie sur false.
organizationId (obligatoire)
string($uuid)
(chemin)
ID de votre organisation. Il est obligatoire.