Obter informações sobre o serviço (ainda não implementado)
NOTE
A data de lançamento desse recurso ainda não foi determinada.
Retorna informações sobre o serviço, como recursos e funcionalidades. O Adobe Workfront usará essas informações para personalizar a interface do usuário no Workfront. Por exemplo, se a implementação de webhook contiver algumas ações personalizadas, o JSON deverá listar essas operações no JSON. Os usuários poderão então invocar essas ações a partir do Workfront.
URL
GET /serviceInfo
Parâmetros de consulta
Nenhum. Além disso, as chamadas para esse endpoint não devem exigir autenticação.
Resposta
JSON contendo informações sobre este serviço
Nome
Tipo
Descrição
webhookVersion
String
A versão de webhook implementada por este serviço. Esse é o número da versão listado na parte superior desta especificação.
version
String
O número da versão interna deste serviço. Esse número é determinado pelo provedor de serviços de webhook e é usado apenas para fins informativos.
editor
String
O nome da empresa que fornece a implementação do webhook.
availableEndpoints
String
Uma lista contendo os endpoints de API implementados por este serviço. Isso pode ser usado para garantir que a interface do usuário no Workfront reflita os recursos oferecidos pelo provedor de webhook. Cada item na lista deve incluir o nome do endpoint (como "pesquisa").
customActions
String
Uma lista contendo as operações personalizadas implementadas por este webhook. Cada item da lista inclui um nome e um nome de exibição. O nome de exibição aparecerá na lista suspensa "Ações do documento" no Workfront. Clicar no item na lista suspensa chamará a ação no webhook, chamando o ponto de extremidade /customAction.
Exemplo: https://www.acme.com/api/serviceInfo
devoluções
{
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