Obtenir des informations sur le service (pas encore implémenté)

Dernière mise à jour : 3 septembre 2024
  • Rubriques :

Créé pour :

  • Développeur
NOTE
La date de publication de cette fonctionnalité n’a pas encore été déterminée.

Renvoie des informations sur le service, telles que ses caractéristiques et ses capacités. Adobe Workfront utilisera ces informations pour personnaliser l’interface utilisateur de Workfront. Par exemple, si la mise en œuvre du webhook contient des actions personnalisées, le fichier JSON doit énumérer ces opérations dans le fichier JSON. Les utilisateurs et utilisatrices pourront alors invoquer ces actions à partir de Workfront.

URL

GET /serviceInfo

Paramètres de requête

Aucun. En outre, les appels à ce point d’entrée ne doivent pas nécessiter d’authentification.

Réponse

Fichier JSON contenant des informations sur ce service.

NomTypeDescription
webhookVersionChaîneVersion du webhook mise en œuvre par ce service. Il s’agit du numéro de version indiqué au début de la présente spécification.
versionChaîneNuméro de version interne de ce service. Ce numéro est déterminé par le fournisseur du service du webhook et n’est utilisé qu’à titre d’information.
publisherChaîneNom de l’entreprise qui fournit l’implémentation du webhook.
availableEndpointsChaîneListe contenant les points d’entrée de l’API mis en œuvre par ce service. Ceci peut être utilisé pour s’assurer que l’interface d’utilisation dans Workfront reflète les capacités offertes par le fournisseur du webhook. Chaque élément de la liste doit inclure le nom du point d’entrée (tel que « search »).
customActionsChaîneListe contenant les opérations personnalisées implémentées par ce webhook. Chaque élément de la liste comprend un nom et un nom d’affichage. Le nom d’affichage apparaît dans le menu déroulant « Actions sur le document » dans Workfront. En cliquant sur l’élément de la liste déroulante, l’action est déclenchée en appelant le point d’entrée /customAction du webhook.

Exemple : https://www.acme.com/api/serviceInfo

returns

{
webhook version: "1.2", version: "1.0", publisher: "Acme, LLC", availableEndpoints: ["files", "metadata", "search", "download"
"thumbnail", "uploadInit", "upload" ], customActions [
{
name: "archive", displayName: "Archive"
},
{name: "doSomethingElse", displayName: "Do Something" },
]
}
Page précédenteSupprimer un document ou un dossier (pas encore implémenté)
Page suivanteRenommer un document ou un dossier (pas encore implémenté)

Workfront