Lorsque vous créez des modèles à partir de zéro, il est toujours préférable de savoir quelles données sont à votre disposition. Dans les premières sections du manuel d’aide sur les modèles, il vous a été expliqué qu’un fichier d’entrée de données est fusionné avec un document Word contenant des balises pour générer dynamiquement une sortie. L’EPC utilise un fichier JSON comme fichier d’entrée de données. Si vous comparez un modèle existant au JSON, vous remarquerez que les balises correspondent exactement aux attributs du JSON. Cela signifie que la construction d’un modèle consiste simplement à prendre le nom d’attribut dans le JSON, à le placer entre accolades et à ajouter une couche de logique et de formatage.
Liste des requêtes
Pour obtenir le fichier d’entrée de données, collez les URL suivantes directement dans votre navigateur. Vous obtiendrez le fichier d’entrée de données au format JSON brut.
Pour la plupart des URL:
*Remplacez le premier ID (la longue chaîne de lettres et de chiffres séparés par des tirets) par l’ID de l’objet dont vous souhaitez obtenir la charge utile.
*Remplacez le deuxième ID par l’ID d’un modèle valide.
*Pour Generated from Template, remplacez l’ID par l’ID du document Generated from Template
| Objet | Exemple de demande |
|---|---|
| Processus | https://example.interfacing.com/api/v1/process/items/11AA111A-A111-111A-11AA-AA111AA1A111/templater-payload?draft=true&language=en&templateId=11AA111A-A111-111A-11AA-AA111AA1A111&include |
| Organisation | https://example.interfacing.com/api/v1/organization/items/11AA111A-A111-111A-11AA-AA111AA1A111/templater-payload?templateId=11AA111A-A111-111A-11AA-AA111AA1A111&includeChildren=true&language=en ORG_UNIT & types = ROLE & types = RESSOURCE & types = ASSET |
| Document | https://example.interfacing.com/api/v1/document/items/11AA111A-A111-111A-11AA-AA111AA1A111/templater-payload?templateId=11AA111A-A111-111A-11AA-AA111AA1A111&includeChildren=true&language= |
| Performance | https://example.interfacing.com/api/v1/performances/items/11AA111A-A111-111A-11AA-AA111AA1A111/templater-payload?templateId=11AA111A-A111-111A-11AA-AA111AA1A111&includeChildren=true&language= KCI & types = KPI & types = KRI & types = OBJECTIF |
| Risque | https://example.interfacing.com/api/v1/risk/items/11AA111A-A111-111A-11AA-AA111AA1A111/templater-payload?templateId=11AA111A-A111-111A-11AA-AA111AA1A111&includeChildren=true&language=en |
| Contrôle | https://example.interfacing.com/api/v1/control/items/11AA111A-A111-111A-11AA-AA111AA1A111/templater-payload?templateId=11AA111A-A111-111A-11AA-AA111AA1A111&includeChildren=true&language= |
| Règle | https://example.interfacing.com/api/v1/rule/items/11AA111A-A111-111A-11AA-AA111AA1A111/templater-payload?templateId=11AA111A-A111-111A-11AA-AA111AA1A111&includeChildren=false&language= |
| Données de base | https://example.interfacing.com/api/v1/masterData/items/11AA111A-A111-111A-11AA-AA111AA1A111/templater-payload?templateId=11AA111A-A111-111A-11AA-AA111AA1A111&includeChildren=true&language=en ENTITY & types = ATTRIBUTE |
| Généré à partir d’un modèle | https: //example.interfacing.com/api/v1/document/documents/11AA111A-A111-111A-11AA-AA111AA1A111/templater-payload? draft = true |
Paramètres des requêtes
| Paramètre | Description |
|---|---|
| projet | Pour obtenir la charge utile de la version publiée de l’objet, définissez draft sur true. Pour obtenir la dernière version, définissez draft sur false. |
| langue | Pour obtenir la charge utile de l’objet dans une langue spécifique, définissez la langue sur le code de langue ISO2 à 2 lettres. |
| includeChildren | Pour obtenir la charge utile de l’objet et de tous ses sous-éléments, définissez includeChildren sur true. Pour obtenir uniquement l’objet sans sous-éléments, définissez-le sur false. |
| types | Pour filtrer la charge utile afin d’obtenir uniquement les éléments d’un certain type, ajoutez ou supprimez des types (& types = [OBJECT_TYPE]). Ce filtre s’applique uniquement aux modules Organisation, Performance et Données de base. |
Méthode alternative d’obtention les “payloads”
Une alternative pour copier / coller l’URL dans votre navigateur à partir de la liste dans le manuel d’aide consiste à le faire via Google Chrome DevTools (ou tout autre outil pouvant intercepter les demandes réseau)
1. Accédez au module pour lequel vous souhaitez que le fichier d’entrée de données
2. Ouvrez Google DevTools en appuyant sur la touche F12 de votre clavier. Sinon, cliquez sur les options de votre navigateur> Plus d’outils> Outils de développement
3. Dans les outils de développement, accédez à l’onglet Réseau
4. Dans l’EPC, générez un document en sélectionnant n’importe quel modèle dans l’invite. Le but est d’intercepter une requête afin de consulter le fichier d’entrée de données.
5. De retour dans les outils de développement, recherchez une demande POST qui commence par “book?” (“sop?” pour Généré à partir d’un modèle}
6. Cliquez sur la demande POST. Une fenêtre à droite de l’outil apparaît. Sous l’onglet “En-têtes”, copiez et collez l’URL de demande dans votre navigateur et changez “book” en “templater-payload” dans la barre d’adresse de votre URL (voir le tableau de demande ci-dessus)
Lecture des “Payloads”
Après avoir copié l’URL dans votre navigateur, le résultat est un fichier JSON brut non formaté. Pour rendre le format facilement lisible, il existe une variété d’options:
1. Téléchargez l’extension du formateur JSON directement sur votre navigateur (pour Google Chrome)
2. Copiez collez l’intégralité du JSON et collez-le dans une visionneuse JSON en ligne
3. Copiez collez l’intégralité du JSON dans un IDE qui peut formater le JSON dans un format lisible
Laissez votre avis sur ce sujet.