Hämta information om tjänsten (ännu inte implementerad)
NOTE
Utgivningsdatumet för den här funktionen har ännu inte fastställts.
Returnerar information om tjänsten, t.ex. funktioner. Adobe Workfront använder den här informationen för att anpassa användargränssnittet i Workfront. Om webkromimplementeringen till exempel innehåller vissa anpassade åtgärder, ska JSON visa dessa åtgärder i JSON. Användarna kan sedan aktivera dessa åtgärder från Workfront.
URL
GET /serviceInfo
Frågeparametrar
Ingen. Dessutom ska anrop till den här slutpunkten inte kräva autentisering.
Svar
JSON som innehåller information om den här tjänsten
Namn
Typ
Beskrivning
webkrokVersion
Sträng
Den webkrosversion som implementeras av den här tjänsten. Det här är versionsnumret som visas högst upp i den här specifikationen.
version
Sträng
Tjänstens interna versionsnummer. Detta nummer bestäms av webbkroktjänstleverantören och används endast i informationssyfte.
utgivare
Sträng
Namnet på det företag som tillhandahåller webbkrokimplementeringen.
availableEndpoints
Sträng
En lista som innehåller API-slutpunkterna som implementeras av den här tjänsten. Detta kan användas för att säkerställa att användargränssnittet i Workfront återspeglar funktionerna som erbjuds av webkrokprovidern. Varje objekt i listan måste innehålla slutpunktens namn (till exempel "sök").
customActions
Sträng
En lista som innehåller de anpassade åtgärder som implementeras av den här webbocken. Varje listobjekt innehåller ett namn och ett visningsnamn. Visningsnamnet visas i listrutan Dokumentåtgärder i Workfront. Om du klickar på objektet i listrutan anropas åtgärden i webkroken genom att slutpunkten /customAction anropas.
Exempel: https://www.acme.com/api/serviceInfo
returnerar
{
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" },
]
}
recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43