Visão geral da API
Importante
Caso não tenha experiência com APIs, visite a página de ajuda Introdução às APIs .
Importante
A partir da versão 2022.1, os pontos de extremidade de API OAuth1 públicos herdados foram removidos porque exigem hash SHA1 não compatível com FIPS. Essa remoção inclui os pontos de extremidade WCF (Windows Communication Framework) herdados, o Swagger para esses pontos de extremidade herdados e o middleware de OAuth1. Para substituir os pontos de extremidade OAuth1, você pode usar as versões OAuth2 das APIs herdadas lançadas na versão 21.4, que são compatíveis com FIPS. As APIs OAuth2 oferecem a mesma experiência de funcionalidade das APIs OAuth1.
Os pontos de extremidade V1 e V2 e de assinatura continuarão sendo compatíveis no OAuth2.
Para saber mais sobre a conversão e seus impactos, acesse a página de ajuda Instruções para conversão de OAuth1 para OAuth2 ou este artigo .
A API do Server é composta por seis APIs:
API de assinatura : pontos de extremidade para que os usuários interajam com assinaturas, fluxos de trabalho e agendamentos (trabalhos).
API V2 de usuário : pontos de extremidade para que os usuários interajam com credenciais, arquivos de entrada e agendamentos (trabalhos).
API V1 de administrador : pontos de extremidade para que os administradores busquem recursos da interface do administrador.
API V2 de administrador : versão 2 dos pontos de extremidade para que os administradores busquem recursos da interface do administrador.
API V3 de administrador : versão 3 dos pontos de extremidade. Esta versão usa OAuth 2.
API V3 de usuário : versão 3 dos pontos de extremidade para usuários. Esta versão usa OAuth 2.
Nota
Além de adicionar novas funcionalidades com pontos de extremidade de API V3 , também disponibilizamos nossos pontos de extremidade V1, de assinatura e pontos de extremidade V2 para uso com OAuth 2. Os mesmos pontos de extremidade que você usou anteriormente agora estão disponíveis para OAuth 2 em um novo endereço base.
O endereço da API Web pode ser configurado apenas para V1, V2 e V3 usando o OAuth 2. Para a documentação da API V1 e V2 usando o OAuth 1, o endereço é http://{ServerHostname}/gallery/api-docs/ .
Acessar a documentação de referência da API do Server
A documentação de referência completa para todos os pontos de extremidade de API do Server está disponível no Swagger.
Há dois locais na IU do Server onde você pode acessar a documentação de referência da API do Server.
Clique no ícone de ponto de interrogação na barra de ferramentas superior e selecione Documentação da API .
Você também pode acessar a documentação de referência para a API do Server usando este URL:
http(s)://serverhostname.domain/webapi/swagger. A parte "serverhostname" é o URL da sua instância do Server.
Autenticação na documentação de referência da API do Server
Os documentos da API do Server são interativos, permitindo que você preencha os parâmetros e veja as respostas. Para usar a interatividade, você precisa fazer a autenticação. Para isso, siga estas etapas:
Na IU do Server, selecione seu nome de usuário e vá para Meu perfil > Chaves . Copie as chaves de API para a API na qual deseja se autenticar e cole-as nos campos API Key (chave de API) e Shared Secret (segredo compartilhado). As chaves serão salvas e exibidas como Saved .
Selecione a chamada que deseja executar, preencha os parâmetros e clique em Try it out! para testar.
Chaves de API e acesso à API
Os administradores do Server precisam permitir que os usuários acessem a API. Acesse Permitir acesso de usuários à API do Server para obter mais informações. Depois que você tiver concedido aos usuários acesso à API, eles poderão encontrar suas chaves de API na guia Chaves da página Meu perfil . Para acessar suas chaves de API, selecione seu nome de usuário e vá para Meu perfil > Chaves .
Os usuários com a função de administrador podem usar as chaves de Acesso à API para acessar todas as APIs, incluindo a API de assinatura, a API V2 de usuário, a API V1 de administrador, a API V2 de administrador e a API V3.
Todos os usuários que não sejam administradores podem usar as chaves de Acesso à API para acessar a API de assinatura e a API V2 de usuário.
Autenticação
Consulte o artigo Configuração e autorização da API do Server para obter mais informações.
Criar pontos de extremidade de API
Para construir um ponto de extremidade de API, use este esquema: <hostname>/webapi/ .
Pontos de extremidade de API e parâmetros
Nesta seção, você encontrará mais informações sobre os seguintes pontos de extremidade:
O Server monitora as alterações feitas nas seguintes entidades do sistema:
AppInfo (fluxo de trabalho)
Coleção
Credencial
Assinatura
Usuário
Grupo de usuário
Obter eventos registrados pela API do Server
Qualquer atualização feita nessas entidades aciona a criação de um registro AuditEvent (evento de auditoria). Você pode fazer o retorno desses registros por meio de um ponto de extremidade público de API de administrador.
Ponto de extremidade
O ponto de extremidade para AuditEvents é
GET /admin/v1/auditlog/
Parâmetros de consulta obrigatórios
entity: (string) a entidade do log de auditoria a ser consultada.page: (int) a página a ser retornada.pageSize: (int) o número de registros a serem retornados em cada página.
A resposta será uma série de registros de evento de auditoria:
[
{
"id": "",
"entity": "",
"entityId": "",
"userId": "",
"timestamp": "Date",
"event": "",
"oldValues": "",
"newValues": ""
}
]As propriedades retornadas estão definidas abaixo:
id: o ID do evento de auditoria.entity: o nome da entidade.entityId: o ID da entidade.userId: o ID do usuário que modificou a entidade.timestamp: a data/hora de criação do registro do evento de auditoria.event: o evento que ocorreu (inserção, atualização, exclusão).oldValues: os valores das propriedades antes da atualização.newValues: os valores das propriedades depois da atualização.
Para executar fluxos de trabalho que usam a
ferramenta Explorador de Arquivos
por meio da API, use o ponto de extremidade
/user/v2/inputfiles
para fazer upload do arquivo.
Comece fazendo uma solicitação POST multipart/form-data para o ponto de extremidade
/user/v2/inputfilespara publicar um arquivo temporário. O nome da seção form-data obrigatória éinputFile.curl --location --request POST 'http:{yourhostname}/api/user/v2/inputfiles/' \ --form 'inputFile=@/file/path/filename.csv'Em seguida, faça um POST para o ponto de extremidade
/user/v2/workflows/{appId}/jobs/.Em seguida, inclua o nome (
name) da ferramenta Explorador de Arquivos no objeto de pergunta. Se você não tiver certeza do nome da ferramenta Explorador de Arquivos, use o ponto de extremidade/v1/workflows/{appId}/questionspara obtê-lo.O
valueé o ID de referência que a chamada do arquivo de entrada retornou na resposta.
curl --location --request POST 'http:{yourhostname}/api/user/v2/workflows/{appId}/jobs' \ --header 'Content-Type: text/plain' \ --header 'Authorization: OAuth oauth_consumer_key="{consumer key}", oauth_signature_method="HMAC-SHA1", oauth_timestamp="{timestamp}", oauth_nonce="{nonce}", oauth_signature="{signature}"' \ --data-raw '{ "questions": [ { "name": "File Browse", "value": "{reference ID}" } ] "priority": "Low" }'
Use o ponto de extremidade
migratable
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.
Etapa 1. Obter uma lista de fluxos de trabalho prontos para migração
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:
api/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 a migração dentro da 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
(o ID do aplicativo),
revisionId
(a revisão atualmente publicada) e
subscriptionID
(o ID da assinatura à qual o fluxo de trabalho pertence).
Etapa 2. Fazer download dos fluxos de trabalho do ambiente de origem
O ponto de extremidade a seguir baixa o fluxo de trabalho como um arquivo YXZP.
Ambiente: origem
Método: GET
Ponto de extremidade:
api/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.
Etapa 3. Publicar fluxos de trabalho no ambiente de destino
O ponto de extremidade a seguir publica o fluxo de trabalho baixado no ambiente de destino.
Ambiente: destino
Método: POST
Ponto de extremidade:
api/admin/v1/workflows/
Parâmetros | |||
|---|---|---|---|
Parâmetro | Descrição | Tipo | Obrigatório |
| O nome do arquivo do novo fluxo de trabalho. | Cadeia de caracteres | Verdadeiro |
| O novo nome do fluxo de trabalho. | Cadeia de caracteres | Verdadeiro |
| O proprietário do fluxo de trabalho migrado. O endereço de e-mail deve existir no ambiente de destino. | Cadeia de caracteres | Verdadeiro |
| Sinalizador para validar o fluxo de trabalho ao migrar para o ambiente de destino. | Booleano | Verdadeiro |
| Sinalizador para definir o fluxo de trabalho como público para ser exibido no "Server da minha empresa" no ambiente de destino. | Booleano | Verdadeiro |
| Este é o appId do ambiente de origem do fluxo de trabalho a ser migrado. Se existir um fluxo de trabalho com o mesmo sourceId, ele será substituído no ambiente de destino. Caso contrário, um novo fluxo de trabalho será gerado. (Envie uma string vazia se não desejar especificar um appID.) | Cadeia de caracteres | Verdadeiro |
| Adicione ao fluxo de trabalho uma tag de trabalhador para que um trabalhador específico execute o fluxo. (Envie uma string vazia se não quiser especificar o trabalhador.) | Cadeia de caracteres | Verdadeiro |
| Sinalizador para definir o fluxo de trabalho como disponível para download por outros usuários no ambiente de destino. | Booleano | Verdadeiro |
(Opcional) Etapa 4. Redefinir configuração de migração de fluxos de trabalho no ambiente de origem
Se desejar, você pode usar o ponto de extremidade
migratable
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:
api/admin/v1/workflows/migratable/{appID}/
Para obter mais informações sobre todos os pontos de extremidade de API do Server, consulte APIs do Server .
Para obter mais informações sobre os pontos de extremidade de API V3 do Server e seus parâmetros, acesse a página de ajuda API V3 do Alteryx Server .
APIs do Server
Encontre a lista de todas as APIs do Server na tabela abaixo. Se uma API estiver disponível para os usuários, ela estará disponível para os administradores.
Para exibir colunas ocultas na tabela, role para a esquerda e para a direita.
Seção | Ponto de extremidade de API | Versão | Build da versão de administrador | Build da versão de usuário | Descrição | |
|---|---|---|---|---|---|---|
1 | Logs de auditoria | GET /admin/v1/auditlog | v1 | 9.1 | Recuperar entradas de log de auditoria para um determinado tipo de entidade | |
2 | Coleções | GET /v3/collections | v3 | 2021.4 | Recuperar todos os registros de coleção acessíveis. | |
3 | Coleções | POST /v3/collections | v3 | 2021.4 | Criar uma nova coleção. | |
4 | Coleções | DELETE /v3/collections/{collectionId} | v3 | 2021.4 | Excluir uma coleção existente. | |
5 | Coleções | GET /v3/collections/{collectionId} | v3 | 2021.4 | Recuperar detalhes sobre uma coleção existente. | |
6 | Coleções | PUT /v3/collections/{collectionId} | v3 | 2021.4 | Atualizar o nome e/ou o proprietário de uma coleção existente. | |
7 | Coleções | PUT /v3/collections/{collectionId}/users/{userId}/permissions | v3 | 2021.4 | Atualizar as permissões de um usuário dentro de uma coleção existente. | |
8 | Coleções | PUT /v3/collections/{collectionId}/userGroups/{userGroupId}/permissions | v3 | 2021.4 | Atualizar as permissões de um grupo de usuários dentro de uma coleção existente. | |
9 | Coleções | POST /v3/collections/{collectionId}/users | v3 | 2021.4 | Adicionar um usuário a uma coleção existente. | |
10 | Coleções | POST /v3/collections/{collectionId}/insights | v3 | 2021.4 | Adicionar um insight a uma coleção existente. | |
11 | Coleções | POST /v3/collections/{collectionId}/schedules | v3 | 2021.4 | Adicionar um agendamento a uma coleção existente. | |
12 | Coleções | POST /v3/collections/{collectionId}/workflows | v3 | 2021.4 | Adicionar um fluxo de trabalho a uma coleção existente. | |
13 | Coleções | POST /v3/collections/{collectionId}/userGroups | v3 | 2021.4 | Adicionar um grupo de usuários a uma coleção existente. | |
14 | Coleções | DELETE /v3/collections/{collectionId}/users/{userId} | v3 | 2021.4 | Remover um usuário de uma coleção existente. | |
15 | Coleções | DELETE /v3/collections/{collectionId}/workflows/{appId} | v3 | 2021.4 | Remover um fluxo de trabalho de uma coleção existente. | |
16 | Coleções | DELETE /v3/collections/{collectionId}/insights/{insightId} | v3 | 2021.4 | Remover um insight de uma coleção existente | |
17 | Coleções | DELETE /v3/collections/{collectionId}/schedules/{scheduleId} | v3 | 2021.4 | Remover um agendamento de uma coleção | |
18 | Coleções | DELETE /v3/collections/{collectionId}/userGroups/{userGroupId} | v3 | 2021.4 | Remover um grupo de usuários de uma coleção existente. | |
19 | Coleções | GET /admin/v1/collections | v1 | 9.1 | Encontrar coleções em um Server | |
20 | Credenciais | GET /v3/credentials/{credentialId} | v3 | 2021.4 | 2022.3 | Recuperar detalhes sobre uma credencial existente. |
21 | Credenciais | GET /v3/credentials | v3 | 2021.4 | 2022.3 | Recuperar todos os registros de credenciais acessíveis. |
22 | Credenciais | DELETE /v3/credentials/{credentialId} | v3 | 2021.4 | Excluir uma credencial existente. | |
23 | Credenciais | POST /v3/credentials/{credentialId}/users | v3 | 2021.4 | Compartilhar uma credencial existente com um usuário existente. | |
24 | Credenciais | POST /v3/credentials/{credentialId}/userGroups | v3 | 2021.4 | Compartilhar uma credencial existente com um grupo de usuários existente. | |
25 | Credenciais | DELETE /v3/credentials/{credentialId}/users/{userId} | v3 | 2021.4 | Remover as permissões de um usuário para usar uma coleção existente. | |
26 | Credenciais | DELETE /v3/credentials/{credentialId}/userGroups/{userGroupId} | v3 | 2021.4 | Remover a permissão de um grupo de usuários para usar uma credencial existente. | |
27 | Credenciais | GET /user/v2/credentials | v2 | 11.3 | Encontrar credenciais compartilhadas com usuários diretamente ou por meio de uma assinatura | |
28 | DCM.E | DELETE /v3/dcm/connections/{id} | v3 | 2023.2 | 2023.2 | Excluir uma conexão do DCM. |
29 | DCM.E | GET /v3/dcm/connections/{id} | v3 | 2023.2 | 2023.2 | Recuperar um registro de conexão do DCM. |
30 | DCM.E | GET /v3/dcm/connections/lookup | v3 | 2023.2 | 2023.2 | Recuperar uma conexão do DCM como referenciada em fluxos de trabalho. |
31 | DCM.E | DELETE /v3/dcm/connections/{id}/sharing/execution | v3 | 2023.2 | 2023.2 | Reverter o compartilhamento de uma conexão do DCM. |
32 | DCM.E | PUT /v3/dcm/connections/{id}/sharing/execution | v3 | 2023.2 | 2023.2 | Compartilhar uma conexão do DCM com usuários e grupos específicos. |
33 | DCM.E | POST /v3/dcm/connections | v3 | 2023.2 | 2023.2 | Criar ou atualizar uma conexão do DCM. |
34 | DCM.E - Admininstrador | DELETE /v3/dcm/admin/connections/{objectId} | v3 | 2023.2 | Excluir uma conexão do DCM. | |
35 | DCM.E - Admininstrador | GET /v3/dcm/admin/connections/{objectId} | v3 | 2023.2 | Recuperar um registro de conexão do DCM. | |
36 | DCM.E - Admininstrador | GET /v3/dcm/admin/connections | v3 | 2023.2 | Recuperar uma lista de registros de conexões do DCM. | |
37 | DCM.E - Admininstrador | POST /v3/dcm/admin/connections | v3 | 2023.2 | Criar ou atualizar uma conexão do DCM em nome de um usuário. | |
38 | DCM.E - Admininstrador | DELETE /v3/dcm/admin/connections/{objectId}/sharing/execution | v3 | 2023.2 | Reverter o compartilhamento de uma conexão do DCM compartilhada para execução. | |
39 | DCM.E - Admininstrador | DELETE /v3/dcm/admin/connections/{objectId}/sharing/collaboration | v3 | 2023.2 | Reverter o compartilhamento de uma conexão do DCM compartilhada para colaboração. | |
40 | DCM.E - Admininstrador | GET /v3/dcm/admin/connectionhandlingrules | v3 | 2024.1 | Recuperar todas as regras de tratamento de conexão do DCM. | |
41 | DCM.E - Admininstrador | GET /v3/dcm/admin/connectionhandlingrules/{id} | v3 | 2024.1 | Recuperar uma única regra específica de tratamento de conexão do DCM | |
42 | DCM.E - Admininstrador | POST /v3/dcm/admin/connectionhandlingrules | v3 | 2024.1 | Adicionar ou atualizar uma regra de tratamento de conexão do DCM. | |
43 | DCM.E - Admininstrador | DELETE /v3/dcm/admin/connectionhandlingrules/{id} | v3 | 2024.1 | Excluir uma regra de tratamento de conexão do DCM existente. | |
44 | DCMEConnections | GET /v3/DCMEConnections/{connectionId} | v3 | 2022.1 | Recuperar uma conexão do DCM.E | |
45 | Insights | GET /admin/v2/insights | v2 | 11.3 | Encontrar insights em um Server | |
46 | Insights | GET /admin/v1/insights | v1 | 9.1 | Encontrar insights em um Server | |
47 | Jobs | GET /v3/jobs/{jobId}/messages | v3 | 2024.2 | Retrieve messages of a specific job. | |
48 | Trabalhos | GET /v3/jobs/{jobId} | v3 | 2022.3 | 2022.3 | Recuperar detalhes sobre um trabalho existente e seu estado atual. |
49 | Trabalhos | POST /user/v2/workflows/{appId}/jobs Nota Se o fluxo de trabalho foi publicado com uma credencial, uma credencial compartilhada deve ser explicitamente aplicada na chamada da API. | v2 | 11.3 | 11.3 | Criar um novo trabalho e adicioná-lo à fila de execução de trabalhos |
50 | Trabalhos | GET /v1/jobs/{id}/output/{outputId} | v1 | 9.1 | 9.1 | Obter a saída para um determinado trabalho |
51 | Trabalhos | GET /v1/jobs/{id} | v1 | 9.1 | 9.1 | Recuperar o trabalho e seu estado atual |
52 | Trabalhos | GET /v1/workflows/{appId}/jobs | v1 | 9.1 | 9.1 | Retornar os trabalhos para o aplicativo analítico Alteryx fornecido |
53 | Trabalhos | POST /v1/workflows/{appId}/jobs Nota Use POST /user/v2/workflows/{appId}/jobs se o fluxo de trabalho precisar de uma credencial para ser executado. | v1 | 9.1 | 9.1 | Colocar na fila uma execução para o fluxo de trabalho especificado com as respostas fornecidas |
54 | Trabalhos | GET /admin/v1/workflows/jobs | v1 | 9.1 | Retornar o último trabalho executado e seu estado atual para fluxos de trabalho | |
55 | Agendamentos | DELETE /v3/schedules/{scheduleId} | v3 | 2021.4 | Excluir um agendamento existente. | |
56 | Agendamentos | GET /v3/schedules/{scheduleId} | v3 | 2021.4 | Recuperar detalhes sobre um agendamento existente. | |
57 | Agendamentos | PUT /v3/schedules/{scheduleId} | v3 | 2021.4 | Atualizar detalhes de um agendamento existente. | |
58 | Agendamentos | GET /v3/schedules | v3 | 2021.4 | Recuperar todos os registros de agendamento acessíveis. | |
59 | Agendamentos | POST /v3/schedules | v3 | 2021.4 | Criar um novo agendamento. | |
60 | Schedules | PATCH /v3/schedules/{scheduleId} | v3 | 2024.2 | 2024.2 | Make partial updates to details of an existing schedule. |
61 | Agendamentos | GET /admin/v2/schedule/forecast | v2 | 11.3 | Fazer previsões de todos os futuros trabalhos de execução para o período de tempo fornecido | |
62 | Agendamentos | GET /admin/v1/schedules | v1 | 9.1 | Encontrar agendamentos em um Server | |
63 | Conexões do Server | GET /v3/serverDataConnections | v3 | 2021.4 | Recuperar todos os registros de conexão de dados do Server acessíveis. | |
64 | Conexões do Server | DELETE /v3/serverDataConnections/{dataConnectionId} | v3 | 2021.4 | Excluir uma conexão de dados do Server existente. | |
65 | Conexões do Server | GET /v3/serverDataConnections/{dataConnectionId} | v3 | 2021.4 | Recuperar detalhes sobre uma conexão de dados do Server existente. | |
66 | Conexões do Server | PUT /v3/serverDataConnections/{dataConnectionId} | v3 | 2021.4 | Atualizar o nome de uma conexão de dados do Server existente. | |
67 | Conexões do Server | POST /v3/serverDataConnections/{dataConnectionId}/users | v3 | 2021.4 | Compartilhar uma conexão de dados do Server existente com um usuário existente. | |
68 | Conexões do Server | POST /v3/serverDataConnections/{dataConnectionId}/userGroups | v3 | 2021.4 | Compartilhar uma conexão de dados do Server existente com um grupo de usuários existente. | |
69 | Conexões do Server | DELETE /v3/serverDataConnections/{dataConnectionId}/users/{userId} | v3 | 2021.4 | Remover as permissões de um usuário para usar uma conexão de dados do Server existente. | |
70 | Conexões do Server | DELETE /v3/serverDataConnections/{dataConnectionId}/userGroups/{userGroupId} | v3 | 2021.4 | Remover as permissões de um grupo de usuários para usar uma conexão de dados do Server existente. | |
71 | Conexões do Server | GET /admin/v1/serverdataconnections | v1 | 9.1 | Retornar conexões de dados criadas em um Server privado | |
72 | Subscriptions | POST /v3/subscriptions | v3 | 2024.2 | Create a new subscription. | |
73 | Subscriptions | GET /v3/subscriptions | v3 | 2024.2 | Retrieve details about all subscriptions. | |
74 | Subscriptions | GET /v3/subscriptions/{subscriptionId} | v3 | 2024.2 | Search for a specific subscription. | |
75 | Subscriptions | PUT /v3/subscription/{subscriptionId} | v3 | 2024.2 | Update an existing subscription. | |
76 | Subscriptions | DELETE /v3/subscriptions | v3 | 2024.2 | Delete a specific subscription. | |
77 | Subscriptions | PUT /v3/subscriptions/{subscriptionId}/users | v3 | 2024.2 | Change a user’s subscription. | |
78 | Assinaturas | GET /admin/v2/subscriptions | v2 | 11.3 | Encontrar assinaturas em um Server | |
79 | Assinaturas | GET /admin/v1/subscriptions | v1 | 9.1 | Encontrar assinaturas em um Server | |
80 | Alias do sistema | GET /admin/v1/systemdataconnections | v1 | 9.1 | Retornar conexões de dados do sistema criadas no servidor onde o Alteryx Server está instalado | |
81 | Grupos de usuários | GET /v3/usergroups | v3 | 2021.4 | Recuperar todos os registros de grupos de usuários acessíveis. | |
82 | Grupos de usuários | POST /v3/usergroups | v3 | 2021.4 | Criar um novo grupo de usuários. | |
83 | Grupos de usuários | DELETE /v3/usergroups/{userGroupId} | v3 | 2021.4 | Excluir um grupo de usuários existente. | |
84 | Grupos de usuários | GET /v3/usergroups/{userGroupId} | v3 | 2021.4 | Recuperar detalhes sobre um grupos de usuários existente. | |
85 | Grupos de usuários | PUT /v3/usergroups/{userGroupId} | v3 | 2021.4 | Atualizar o nome e/ou a função de um grupo de usuários existente. | |
86 | Grupos de usuários | POST /v3/usergroups/{userGroupId}/users | v3 | 2021.4 | Adicionar um ou mais usuários existentes a um grupo de usuários existente. | |
87 | Grupos de usuários | POST /v3/usergroups/{userGroupId}/activedirectorygroups | v3 | 2023.1 | Adicionar um grupo do Active Directory a um grupo de usuários existente. | |
88 | Grupos de usuários | DELETE /v3/usergroups/{userGroupId}/users/{userId} | v3 | 2021.4 | Remover um usuário de um grupo de usuários existente. | |
89 | Grupos de usuários | DELETE /v3/usergroups/{userGroupId}/activedirectorygroups/{adGroupSid}activedirectorygroups/{adGroupSid} | v3 | 2023.1 | Remover um grupo do Active Directory de um grupo de usuários existente. | |
90 | Usuários | DELETE /v3/users/{userId} | v3 | 2021.4 | Excluir um usuário existente. | |
91 | Usuários | GET /v3/users/{userId} | v3 | 2021.4 | Recuperar todos os ativos acessíveis de propriedade de um usuário existente. | |
92 | Usuários | GET /v3/users/{userId}/assets | v3 | 2021.4 | Recuperar uma lista completa de ativos que um usuário possui | |
93 | Usuários | GET /v3/users | v3 | 2021.4 | Recuperar todos os registros de usuário acessíveis. | |
94 | Usuários | POST /v3/users | v3 | 2021.4 | Criar um novo usuário. | |
95 | Usuários | POST /v3/users/{userId}/deactivate | v3 | 2021.4 | Atualizar um usuário existente como inativo. | |
96 | Usuários | POST /v3/users/{userId}/passwordReset | v3 | 2021.4 | Enviar um e-mail de redefinição de senha para um usuário existente. | |
97 | Usuários | PUT /v3/users/{userId} | v3 | 2021.4 | Atualizar detalhes de um usuário existente. | |
98 | Usuários | PUT /v3/users/{userId}/assetTransfer | v3 | 2024.1 | Transferir alguns ou todos os ativos (fluxos de trabalho, agendamentos e coleções) de propriedade de um usuário para outro. | |
99 | Usuários | GET /admin/v2/users | v2 | 11.3 | Encontrar usuários em um Server | |
100 | Usuários | GET /admin/v1/users | v1 | 9.1 | Encontrar usuários em um Server | |
101 | Fluxos de trabalho | GET /v3/workflows/{workflowId} | v3 | 2021.4 | Recuperar detalhes sobre um fluxo de trabalho existente. | |
102 | Fluxos de trabalho | GET /v3/workflows/{workflowId}/package | v3 | 2022.3 | 2022.3 | Baixar uma cópia de um pacote de fluxo de trabalho existente. |
103 | Fluxos de trabalho | GET /v3/workflows/{workflowId}/questions | v3 | 2022.3 | 2022.3 | Recuperar informações de perguntas para um aplicativo analítico. |
104 | Fluxos de trabalho | GET /v3/workflows/{workflowId}/jobs | v3 | 2022.3 | 2022.3 | Recuperar uma lista de trabalhos de um fluxo de trabalho existente. |
105 | Fluxos de trabalho | GET /v3/workflows | v3 | 2021.4 | 2022.3 | Recuperar todos os registros de fluxos de trabalho acessíveis. |
106 | Fluxos de trabalho | POST /v3/workflows | v3 | 2021.4 | 2022.3 | Carregar um novo pacote de fluxo de trabalho. |
107 | Fluxos de trabalho | DELETE /v3/workflows/{workflowId} | v3 | 2021.4 | Excluir um fluxo de trabalho existente. | |
108 | Fluxos de trabalho | PUT /v3/workflows/{workflowId} | v3 | 2021.4 | Atualizar detalhes de um fluxo de trabalho existente. | |
109 | Fluxos de trabalho | POST /v3/workflows/{workflowId}/versions | v3 | 2023.1 | 2023.1 | Carregar uma nova versão de um fluxo de trabalho existente. |
110 | Fluxos de trabalho | POST /v3/workflows/{workflowId}/jobs | v3 | 2023.2 | 2023.2 | Cria um novo trabalho e o adiciona à fila de execução de trabalhos. |
111 | Fluxos de trabalho | PUT /v3/workflows/{workflowId}/transfer | v3 | 2024.1 | Transferir um fluxo de trabalho específico para um proprietário específico, juntamente com os agendamentos, se desejado. | |
112 | Fluxos de trabalho | POST /user/v2/inputfiles | v2 | 2020.3 | 2020.3 | Publicar um arquivo temporário a ser usado em uma execução subsequente de um fluxo de trabalho |
113 | Fluxos de trabalho | GET /admin/v2/workflows/all | v2 | 11.3 | Retornar todos os fluxos de trabalho, opcionalmente filtrados por data | |
114 | Fluxos de trabalho | GET /v1/workflows/{appId}/package | v1 | 9.1 | 9.1 | Retornar o aplicativo solicitado |
115 | Fluxos de trabalho | GET /v1/workflows/{appId}/questions | v1 | 9.1 | 9.1 | Obter as perguntas para o aplicativo analítico Alteryx fornecido |
116 | Fluxos de trabalho | GET /v1/workflows/subscription | v1 | 9.1 | 9.1 | Encontrar fluxos de trabalho em uma assinatura |
117 | Fluxos de trabalho | GET /admin/v1/{appId}/package | v1 | 9.1 | Retornar o aplicativo solicitado | |
118 | Fluxos de trabalho | GET /admin/v1/workflows/migratable | v1 | 9.1 | Encontrar fluxos de trabalho em um Server que foram marcados como prontos para migração | |
119 | Fluxos de trabalho | GET /admin/v1/workflows/all | v1 | 9.1 | Retornar todos os fluxos de trabalho, opcionalmente filtrados por data | |
120 | Fluxos de trabalho | GET /admin/v1/workflows | v1 | 9.1 | Encontrar fluxos de trabalho em um Server | |
121 | Fluxos de trabalho | POST /admin/v1/workflows | v1 | 9.1 | Publicar um YXZP no sistema | |
122 | Fluxos de trabalho | PUT /admin/v1/workflows/migratable/{appId} | v1 | 9.1 | Atualizar o sinalizador que indica se um aplicativo está pronto para migração |