Nota
Esta página de ajuda aborda o uso de um ponto de extremidade de API do Server. Para começar a usar a API do Server, consulte a Visão geral da API do Server.
Use o ponto de extremidade de migração para migrar fluxos de trabalho entre ambientes do Server. Você pode usar isso para gerenciar implantações de fluxo de trabalho durante as fases de desenvolvimento e teste.
Para começar, você precisa habilitar fluxos de trabalho para migração. Depois de marcar fluxos de trabalho para migração, siga estas etapas para publicá-los do ambiente de origem na assinatura apropriada (estúdio) de um ambiente de destino.
Em seguida, obtenha uma lista de fluxos de trabalho prontos para migrar usando o seguinte ponto de extremidade:
Ambiente: origem
Método: GET
Ponto de extremidade: webapi/admin/v1/workflows/migratable/?subscriptionIds={subscriptionIds}/
Inclua uma lista separada por vírgulas de subscriptionIds (IDs de assinatura) como um parâmetro de consulta. Os IDs de assinatura identificam um estúdio específico.
O retorno é uma variedade de fluxos de trabalho marcados como prontos para migrar mediante a assinatura especificada (estúdio). Se você não fornecer subscriptionsIds, o retorno incluirá todos os fluxos de trabalho marcados como prontos para migração. O retorno inclui três propriedades: appId (ID do aplicativo), revisionId (ID de revisão) atualmente publicado e subscriptionID (ID da assinatura) ao qual o fluxo de trabalho pertence.
O ponto de extremidade a seguir faz download do fluxo de trabalho como um arquivo YXZP.
Ambiente: origem
Método: GET
Ponto de extremidade: webapi/admin/v1/{appID}/package/
Inclua um appID como um parâmetro de caminho. O retorno será um download de todo o fluxo de trabalho como um pacote.
O ponto de extremidade a seguir publica o fluxo de trabalho baixado no ambiente de destino.
Ambiente: destino
Método: POST
Ponto de extremidade: webapi/admin/v1/workflows/
Parâmetros | |||
Parâmetro | Descrição | Tipo | Obrigatório |
|---|---|---|---|
arquivo | O nome do arquivo do novo fluxo de trabalho. | Cadeia de caracteres (string) | Verdadeiro (True) |
nome | O novo nome do fluxo de trabalho. | Cadeia de caracteres (string) | Verdadeiro (True) |
proprietário | O proprietário do fluxo de trabalho migrado. O endereço de e-mail deve existir no ambiente de destino. | Cadeia de caracteres (string) | Verdadeiro (True) |
validar | Sinalizador para validar o fluxo de trabalho ao migrar para o ambiente de destino. | Booleano | Verdadeiro (True) |
isPublic (é público) | Sinalizador para definir o fluxo de trabalho como público para ser exibido no "Server da minha empresa" no ambiente de destino. | Booleano | Verdadeiro (True) |
sourceId (id da origem/fonte) | Este é o appId do ambiente de origem do fluxo de trabalho a ser migrado. Se existir um fluxo de trabalho com o mesmo sourceId, a versão do fluxo de trabalho será incrementada. Caso contrário, um novo fluxo de trabalho será gerado. (Envie uma string vazia se não desejar especificar um appID.) | Cadeia de caracteres (string) | Verdadeiro (True) |
workerTag (tag de trabalhador) | Adicione ao fluxo de trabalho uma tag de trabalhador para que um trabalhador específico execute o fluxo. (Envie uma cadeia de caracteres (string) vazia se você não quiser especificar o trabalhador.) | Cadeia de caracteres (string) | Verdadeiro (True) |
canDownload (pode baixar) | Sinalizador para definir o fluxo de trabalho como disponível para download por outros usuários no ambiente de destino. | Booleano | Verdadeiro (True) |
Se desejar, você pode usar o ponto de extremidade de migração para alternar a configuração Este fluxo de trabalho está pronto para ser migrado em um fluxo de trabalho de volta para Não no ambiente de origem após a migração do fluxo de trabalho no ambiente de destino.
Ambiente: origem
Método: PUT
Ponto de extremidade: webapi/admin/v1/workflows/migratable/{appID}/