Panoramica sulle API
Importante
Se non hai esperienza con le API, consulta la pagina di assistenza Guida introduttiva alle API .
Importante
A partire dalla versione 2022.1, abbiamo rimosso gli endpoint pubblici API OAuth1 legacy perché richiedono l'hash SHA1 non conforme a FIPS. La rimozione include gli endpoint WCF (Windows Communication Framework) legacy, lo Swagger per tali endpoint e il middleware OAuth1. Per sostituire gli endpoint OAuth1, è possibile utilizzare le versioni OAuth2 delle API legacy rilasciate nella versione 21.4 e conformi a FIPS. Le API OAuth2 offrono le stesse funzionalità delle API OAuth1.
Gli endpoint Subscription, V1 e V2 continueranno a essere supportati in OAuth2.
Per ulteriori informazioni sulla conversione e sul suo impatto, visita la pagina della guida Istruzioni da OAuth1 a OAuth2 o Istruzioni per la conversione .
L'API Server è composta da 6 API:
API di iscrizione : endpoint che consentono agli utenti di interagire con iscrizioni, flussi di lavoro e pianificazioni (processi).
API V2 utente : endpoint che consentono agli utenti di interagire con credenziali, file di input e programmazioni (processi).
API V1 di amministrazione : endpoint che consentono agli amministratori di recuperare le risorse dall'interfaccia di amministrazione.
API V2 di amministrazione : versione 2 degli endpoint che consente agli amministratori di recuperare le risorse dall'interfaccia di amministrazione.
API V3 di amministrazione : versione 3 degli endpoint. Questa versione utilizza Oauth 2.
API V3 utente : versione 3 degli endpoint per gli utenti. Questa versione utilizza Oauth 2.
Nota
Oltre ad aggiungere nuove funzionalità con gli endpoint dell'API V3 , abbiamo reso disponibili anche gli endpoint V1, di iscrizione e V2 per l'utilizzo con Oauth 2. Gli stessi endpoint che hai utilizzato in passato sono ora disponibili per Oauth 2 a un nuovo indirizzo base.
L'indirizzo API Web può essere impostato solo per V1, V2 e V3 con Oauth 2. Per la documentazione relativa all'API V1 e V2 con Oauth 1, l'indirizzo è http://{ServerHostname}/gallery/api-docs/ .
Accesso ai documenti di riferimento dell'API Server
La documentazione di riferimento completa per tutti gli endpoint dell'API Server è disponibile in Swagger.
La documentazione di riferimento dell'API Server è accessibile in due posizioni nell'interfaccia utente di Server.
Seleziona l'icona con il punto interrogativo nella barra degli strumenti superiore e scegli Documentazione API .
Puoi anche accedere alla documentazione di riferimento per l'API Server tramite il seguente URL:
http(s)://serverhostname.domain/webapi/swagger
. Serverhostname è l'URL dell'istanza di Server.
Autenticazione per i documenti di riferimento dell'API Server
I documenti relativi all'API Server sono interattivi e consentono di compilare i parametri e visualizzare le risposte. Per sfruttare questa interattività, è necessario eseguire l'autenticazione attenendoti alla seguente procedura:
Nell'interfaccia utente di Server, seleziona il tuo nome utente e scegli Profilo personale > Chiavi . Copia le chiavi per l'API a cui desideri autenticarti e incollale nei campi Chiave API e Chiave segreta condivisa . Le chiavi vengono visualizzate come Salvate .
Seleziona la chiamata che desideri eseguire, compila i parametri e scegli Prova .
Chiavi API e accesso all'API
L'amministratore (di Server) deve autorizzare gli utenti ad accedere all'API. Per ulteriori informazioni, consulta Accesso degli utenti all'API Server . Una volta ottenuto l'accesso all'API, gli utenti possono trovare le chiavi API nella scheda Chiavi della pagina Profilo personale . Per accedere alle chiavi API, seleziona il tuo nome utente e scegli Profilo personale > Chiavi .
Gli utenti con ruolo di amministratore possono utilizzare le chiavi di accesso all'API per accedere a tutte le API, inclusa l'API di iscrizione, l'API V2 utente, l'API V1 di amministrazione, l'API V2 di amministrazione e l'API V3.
Tutti gli utenti che non hanno il ruolo di amministratore possono utilizzare le chiavi di accesso all'API per accedere all'API di iscrizione e all'API V2 utente.
Autenticazione
Per ulteriori informazioni, consulta l'articolo Configurazione e autorizzazione dell'API Server .
Costruzione degli endpoint API
Per costruire un endpoint API, utilizza questo schema: <hostname>/webapi/ .
Endpoint e parametri API
In questa sezione troverai ulteriori informazioni sui seguenti endpoint:
Server tiene traccia delle modifiche apportate alle seguenti entità di sistema:
AppInfo (flusso di lavoro)
Raccolta
Credenziale
Iscrizione
Utente
UserGroup
Recupero degli eventi registrati tramite l'API Server
Eventuali aggiornamenti a queste entità attivano la creazione di un record AuditEvent. È possibile restituire questi record tramite un endpoint API di un amministratore pubblico.
Endpoint
L'endpoint per AuditEvents è
GET /admin/v1/auditlog/
Parametri di query richiesti
entity
: (string) l'entità del log di controllo per la quale si desidera eseguire una query.page
: (int) la pagina che si desidera restituire.pageSize
: (int) il numero di record da restituire in ogni pagina.
La risposta sarà una serie di record Evento di controllo:
[ { "id": "", "entity": "", "entityId": "", "userId": "", "timestamp": "Date", "event": "", "oldValues": "", "newValues": "" } ]
Le proprietà restituite sono definite di seguito:
id
: l'ID dell'evento di controllo.entity
: il nome dell'entità.entityId
: l'ID dell'entità.userId
: l'ID dell'utente che ha modificato l'entità.timestamp
: la data e l'ora di creazione del record Evento di controllo.event
: l'evento che si è verificato (inserimento, aggiornamento, eliminazione).oldValues
: i valori delle proprietà aggiornate prima dell'aggiornamento.newValues
: i valori delle proprietà aggiornate dopo l'aggiornamento.
Per eseguire i flussi di lavoro che utilizzano lo
strumento Sfoglia file
tramite l'API, utilizza l'endpoint
/user/v2/inputfiles
per caricare il file.
Inizia inoltrando una richiesta POST multipart/form-data all'endpoint
/user/v2/inputfiles
per pubblicare un file temporaneo. Il nome della sezione form-data richiesta èinputFile
.curl --location --request POST 'http:{yourhostname}/api/user/v2/inputfiles/' \ --form 'inputFile=@/file/path/filename.csv'
Quindi, invia una richiesta POST all'endpoint
/user/v2/workflows/{appId}/jobs/
.Successivamente, includi il
nome
dello strumento Sfoglia file nell'oggetto della domanda. In caso di dubbi sul nome dello strumento Sfoglia file, utilizza l'endpoint/v1/workflows/{appId}/questions
per scoprirlo.Il
valore
è l'ID di riferimento restituito nella risposta dalla chiamata al file di input.
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" }'
Utilizza l'endpoint
migratable
per migrare i flussi di lavoro tra gli ambienti di Server. Puoi utilizzare questo endpoint per gestire le distribuzioni dei flusso di lavoro durante le fasi di sviluppo e test.
Per iniziare, è necessario abilitare i flussi di lavoro per la migrazione . Dopo aver contrassegnato i flussi di lavoro per la migrazione, attieniti alla procedura di seguito per pubblicarli dall'ambiente di origine nell'iscrizione appropriata (studio) dell'ambiente di destinazione.
Passaggio 1. Ottieni un elenco dei flussi di lavoro pronti per la migrazione
Successivamente, ottieni un elenco di flussi di lavoro pronti per la migrazione utilizzando il seguente endpoint:
Ambiente: origine
Metodo: GET
Endpoint:
api/admin/v1/workflows/migratable/?subscriptionIds={subscriptionIds}/
Includi un elenco separato da virgole di
subscriptionIds
come parametro di query. Gli ID iscrizione identificano uno studio specifico.
Il risultato è una serie di flussi di lavoro contrassegnati come pronti per la migrazione nell'iscrizione specificata (studio). Se non fornisci
subscriptionIds
, vengono forniti tutti i flussi di lavoro contrassegnati come pronti per la migrazione. Il risultato include 3 proprietà:
appId
,
revisionid
attualmente pubblicato e
subscriptionID
di appartenenza del flusso di lavoro.
Passaggio 2. Scarica i flussi di lavoro dall'ambiente di origine
Il seguente endpoint scarica il flusso di lavoro come file YXZP.
Ambiente: origine
Metodo: GET
Endpoint:
api/admin/v1/{appID}/package/
Includi un
appID
come parametro di percorso. Il risultato sarà un download dell'intero flusso di lavoro come pacchetto.
Passaggio 3. Pubblica i flussi di lavoro nell'ambiente di destinazione
Il seguente endpoint pubblica il flusso di lavoro scaricato nell'ambiente di destinazione.
Ambiente: destinazione
Metodo: POST
Endpoint:
api/admin/v1/workflows/
Parametri | |||
---|---|---|---|
Parametro | Descrizione | Tipo | Obbligatorio |
| Il nome file del nuovo flusso di lavoro. | Stringa | True |
| Il nome del nuovo flusso di lavoro. | Stringa | True |
| Il proprietario del flusso di lavoro migrato. L'indirizzo e-mail deve esistere nell'ambiente di destinazione. | Stringa | True |
| Contrassegno per convalidare il flusso di lavoro durante la migrazione all'ambiente di destinazione. | Booleano | True |
| Contrassegno per impostare il flusso di lavoro come pubblico e visualizzarlo in "Gallery della mia azienda" nell'ambiente di destinazione. | Booleano | True |
| L'appId dell'ambiente di origine del flusso di lavoro da migrare. Se è presente un flusso di lavoro con lo stesso sourceId, questo sostituisce il flusso di lavoro nell'ambiente di destinazione. In caso contrario, viene generato un nuovo flusso di lavoro. (Invia una stringa vuota se non desideri specificare un appID.) | Stringa | True |
| Aggiungi un tag worker al flusso di lavoro se desideri che questo sia eseguito da un worker specifico. (Invia una stringa vuota se non desideri specificare un worker.) | Stringa | True |
| Contrassegno per impostare il flusso di lavoro come disponibile per il download da parte di altri utenti nell'ambiente di destinazione. | Booleano | True |
Passaggio 4 (facoltativo). Ripristina i flussi di lavoro delle impostazioni di migrazione nell'ambiente di origine
Puoi utilizzare l'endpoint
migratable
per ripristinare l'impostazione
Questo flusso di lavoro è pronto per la migrazione
di un flusso di lavoro su
No
nell'ambiente di origine dopo la migrazione del flusso di lavoro nell'ambiente di destinazione.
Ambiente: origine
Metodo: PUT
Endpoint:
api/admin/v1/workflows/migratable/{appID}/
Per ulteriori informazioni su tutti gli endpoint dell'API Server, consulta API Server .
Per ulteriori informazioni sugli endpoint e i parametri dell'API Server V3, consulta la pagina di assistenza API Alteryx Server V3 .
API Server
Nella tabella seguente è riportato l'elenco di tutte le API Server rilasciate. Se un'API è disponibile per gli utenti, lo è anche per gli amministratori.
Per visualizzare le colonne nascoste nella tabella, scorri a sinistra e a destra.
Sezione | Endpoint API | Versione | Build di rilascio per amministratori | Build di rilascio per utenti | Descrizione | |
---|---|---|---|---|---|---|
1 | Dati di verifica | GET /admin/v1/auditlog | v1 | 9.1 | Recupera le voci del registro di controllo per un determinato tipo di entità | |
2 | Raccolte | GET /v3/collections | v3 | 2021.4 | Recupera tutti i record delle raccolte accessibili. | |
3 | Raccolte | POST /v3/collections | v3 | 2021.4 | Crea una nuova raccolta. | |
4 | Raccolte | DELETE /v3/collections/{collectionId} | v3 | 2021.4 | Elimina una raccolta esistente. | |
5 | Raccolte | GET /v3/collections/{collectionId} | v3 | 2021.4 | Recupera i dettagli di una raccolta esistente. | |
6 | Raccolte | PUT /v3/collections/{collectionId} | v3 | 2021.4 | Aggiorna il nome e/o il proprietario di una raccolta esistente. | |
7 | Raccolte | PUT /v3/collections/{collectionId}/users/{userId}/permissions | v3 | 2021.4 | Aggiorna le autorizzazioni di un utente all'interno di una raccolta esistente. | |
8 | Raccolte | PUT /v3/collections/{collectionId}/userGroups/{userGroupId}/permissions | v3 | 2021.4 | Aggiorna le autorizzazioni di un gruppo di utenti all'interno di una raccolta esistente. | |
9 | Raccolte | POST /v3/collections/{collectionId}/users | v3 | 2021.4 | Aggiunge un utente a una raccolta esistente. | |
10 | Raccolte | POST /v3/collections/{collectionId}/insights | v3 | 2021.4 | Aggiunge un insight a una raccolta esistente. | |
11 | Raccolte | POST /v3/collections/{collectionId}/schedules | v3 | 2021.4 | Aggiunge una pianificazione a una raccolta esistente. | |
12 | Raccolte | POST /v3/collections/{collectionId}/workflows | v3 | 2021.4 | Aggiunge un flusso di lavoro a una raccolta esistente. | |
13 | Raccolte | POST /v3/collections/{collectionId}/userGroups | v3 | 2021.4 | Aggiunge un gruppo di utenti a una raccolta esistente. | |
14 | Raccolte | DELETE /v3/collections/{collectionId}/users/{userId} | v3 | 2021.4 | Rimuove un utente da una raccolta esistente. | |
15 | Raccolte | DELETE /v3/collections/{collectionId}/workflows/{appId} | v3 | 2021.4 | Rimuove un flusso di lavoro da una raccolta esistente. | |
16 | Raccolte | DELETE /v3/collections/{collectionId}/insights/{insightId} | v3 | 2021.4 | Rimuove un insight da una raccolta esistente. | |
17 | Raccolte | DELETE /v3/collections/{collectionId}/schedules/{scheduleId} | v3 | 2021.4 | Rimuove una pianificazione da una raccolta. | |
18 | Raccolte | DELETE /v3/collections/{collectionId}/userGroups/{userGroupId} | v3 | 2021.4 | Rimuove un gruppo di utenti da una raccolta esistente. | |
19 | Raccolte | GET /admin/v1/collections | v1 | 9.1 | Trova le raccolte in Server | |
20 | Credenziali | GET /v3/credentials/{credentialId} | v3 | 2021.4 | 2022.3 | Recupera i dettagli di una credenziale esistente. |
21 | Credenziali | GET /v3/credentials | v3 | 2021.4 | 2022.3 | Recupera tutti i record di credenziali accessibili. |
22 | Credenziali | DELETE /v3/credentials/{credentialId} | v3 | 2021.4 | Elimina una credenziale esistente. | |
23 | Credenziali | POST /v3/credentials/{credentialId}/users | v3 | 2021.4 | Condivide una credenziale esistente con un utente esistente. | |
24 | Credenziali | POST /v3/credentials/{credentialId}/userGroups | v3 | 2021.4 | Condivide una credenziale esistente con un gruppo di utenti esistente. | |
25 | Credenziali | DELETE /v3/credentials/{credentialId}/users/{userId} | v3 | 2021.4 | Rimuove le autorizzazioni di un utente a utilizzare una credenziale esistente. | |
26 | Credenziali | DELETE /v3/credentials/{credentialId}/userGroups/{userGroupId} | v3 | 2021.4 | Rimuove l'autorizzazione di un gruppo di utenti a utilizzare una credenziale esistente. | |
27 | Credenziali | GET /user/v2/credentials | v2 | 11.3 | Trova le credenziali condivise direttamente con gli utenti o tramite un'iscrizione | |
28 | DCME | DELETE /v3/dcm/connections/{id} | v3 | 2023.2 | 2023.2 | Elimina una connessione DCM. |
29 | DCME | GET /v3/dcm/connections/{id} | v3 | 2023.2 | 2023.2 | Recupera il record di una connessione DCM. |
30 | DCME | GET /v3/dcm/connections/lookup | v3 | 2023.2 | 2023.2 | Recupera una connessione DCM come indicato nei flussi di lavoro. |
31 | DCME | DELETE /v3/dcm/connections/{id}/sharing/execution | v3 | 2023.2 | 2023.2 | Annulla la condivisione di una connessione DCM. |
32 | DCME | PUT /v3/dcm/connections/{id}/sharing/execution | v3 | 2023.2 | 2023.2 | Condivide una connessione DCM con gli utenti e i gruppi specificati. |
33 | DCME | POST /v3/dcm/connections | v3 | 2023.2 | 2023.2 | Crea o aggiorna una connessione DCM. |
34 | DCMEAdmin | DELETE /v3/dcm/admin/connections/{objectId} | v3 | 2023.2 | Elimina una connessione DCM. | |
35 | DCMEAdmin | GET /v3/dcm/admin/connections/{objectId} | v3 | 2023.2 | Recupera il record di una connessione DCM. | |
36 | DCMEAdmin | GET /v3/dcm/admin/connections | v3 | 2023.2 | Recupera un elenco di record di connessioni DCM. | |
37 | DCMEAdmin | POST /v3/dcm/admin/connections | v3 | 2023.2 | Crea o aggiorna una connessione DCM per conto di un utente. | |
38 | DCMEAdmin | DELETE /v3/dcm/admin/connections/{objectId}/sharing/execution | v3 | 2023.2 | Annulla la condivisione di una connessione DCM condivisa per l'esecuzione. | |
39 | DCMEAdmin | DELETE /v3/dcm/admin/connections/{objectId}/sharing/collaboration | v3 | 2023.2 | Annulla la condivisione di una connessione DCM condivisa per la collaborazione. | |
40 | DCMEAdmin | GET /v3/dcm/admin/connectionhandlingrules | v3 | 2024.1 | Recupera tutte le regole di gestione della connessione DCM. | |
41 | DCMEAdmin | GET /v3/dcm/admin/connectionhandlingrules/{id} | v3 | 2024.1 | Recupera una singola regola di gestione specifica della connessione DCM. | |
42 | DCMEAdmin | POST /v3/dcm/admin/connectionhandlingrules | v3 | 2024.1 | Aggiunge o aggiorna una regola di gestione della connessione DCM. | |
43 | DCMEAdmin | DELETE /v3/dcm/admin/connectionhandlingrules/{id} | v3 | 2024.1 | Elimina una regola di gestione della connessione DCM esistente: | |
44 | DCMEConnections | GET /v3/DCMEConnections/{connectionId} | v3 | 2022.1 | Recupera una connessione DCM.E. | |
45 | Insights | GET /admin/v2/insights | v2 | 11.3 | Trova gli insight in Server | |
46 | Insights | GET /admin/v1/insights | v1 | 9.1 | Trova gli insight in Server | |
47 | Processi | GET /v3/jobs/{jobId} | v3 | 2022.3 | 2022.3 | Recupera i dettagli relativi a un processo esistente e il relativo stato corrente. |
48 | Processi | POST /user/v2/workflows/{appId}/jobs Nota Se il flusso di lavoro è stato pubblicato con una credenziale, è necessario applicare esplicitamente una credenziale condivisa nella chiamata API. | v2 | 11.3 | 11.3 | Crea un nuovo processo e lo aggiunge alla coda di esecuzione del processo |
49 | Processi | GET /v1/jobs/{id}/output/{outputId} | v1 | 9.1 | 9.1 | Ottieni un output per un determinato processo |
50 | Processi | GET /v1/jobs/{id} | v1 | 9.1 | 9.1 | Recupera il processo e lo stato corrente |
51 | Processi | GET /v1/workflows/{appId}/jobs | v1 | 9.1 | 9.1 | Restituisce i processi per l'app Alteryx Analytics specificata |
52 | Processi | POST /v1/workflows/{appId}/jobs Nota Utilizza POST /user/v2/workflows/{appId}/jobs se il flusso di lavoro richiede una credenziale per l'esecuzione. | v1 | 9.1 | 9.1 | Mette in coda l'esecuzione di un processo per il flusso di lavoro specificato con le risposte fornite |
53 | Processi | GET /admin/v1/workflows/jobs | v1 | 9.1 | Restituisce l'ultimo processo eseguito e lo stato corrente per i flussi di lavoro | |
54 | Programmazioni | DELETE /v3/schedules/{scheduleId} | v3 | 2021.4 | Elimina una pianificazione esistente. | |
55 | Programmazioni | GET /v3/schedules/{scheduleId} | v3 | 2021.4 | Recupera i dettagli di una pianificazione esistente. | |
56 | Programmazioni | PUT /v3/schedules/{scheduleId} | v3 | 2021.4 | Aggiorna i dettagli di una pianificazione esistente. | |
57 | Programmazioni | GET /v3/schedules | v3 | 2021.4 | Recupera tutti i record della pianificazione accessibili. | |
58 | Programmazioni | POST /v3/schedules | v3 | 2021.4 | Creare una nuova pianificazione. | |
59 | Programmazioni | GET /admin/v2/schedule/forecast | v2 | 11.3 | Prevede tutti i processi eseguiti futuri per il periodo di tempo specificato | |
60 | Programmazioni | GET /admin/v1/schedules | v1 | 9.1 | Trova le pianificazioni in Server | |
61 | Connessioni Server | GET /v3/serverDataConnections | v3 | 2021.4 | Recupera tutti i record di connessione dati di Server accessibili. | |
62 | Connessioni Server | DELETE /v3/serverDataConnections/{dataConnectionId} | v3 | 2021.4 | Elimina una connessione dati di Server esistente. | |
63 | Connessioni Server | GET /v3/serverDataConnections/{dataConnectionId} | v3 | 2021.4 | Recupera i dettagli di una connessione dati di Server esistente. | |
64 | Connessioni Server | PUT /v3/serverDataConnections/{dataConnectionId} | v3 | 2021.4 | Aggiorna il nome di una connessione dati di Server esistente. | |
65 | Connessioni Server | POST /v3/serverDataConnections/{dataConnectionId}/users | v3 | 2021.4 | Condivide una connessione dati di Server esistente con un utente esistente. | |
66 | Connessioni Server | POST /v3/serverDataConnections/{dataConnectionId}/userGroups | v3 | 2021.4 | Condivide una connessione dati di Server esistente con un gruppo di utenti esistente. | |
67 | Connessioni Server | DELETE /v3/serverDataConnections/{dataConnectionId}/users/{userId} | v3 | 2021.4 | Rimuove le autorizzazioni di un utente a utilizzare una connessione dati di Server esistente. | |
68 | Connessioni Server | DELETE /v3/serverDataConnections/{dataConnectionId}/userGroups/{userGroupId} | v3 | 2021.4 | Rimuove le autorizzazioni di un gruppo di utenti a utilizzare una connessione dati di Server esistente. | |
69 | Connessioni Server | GET /admin/v1/serverdataconnections | v1 | 9.1 | Restituisce le connessioni dati create in una galleria privata | |
70 | Subscriptions | GET /admin/v2/subscriptions | v2 | 11.3 | Trova le iscrizioni in Server | |
71 | Subscriptions | GET /admin/v1/subscriptions | v1 | 9.1 | Trova le iscrizioni in Server | |
72 | Alias di sistema | GET /admin/v1/systemdataconnections | v1 | 9.1 | Restituisce le connessioni dati del sistema create sul server in cui è installato Alteryx Server | |
73 | Gruppi utenti | GET /v3/usergroups | v3 | 2021.4 | Recupera tutti i record del gruppo di utenti accessibili. | |
74 | Gruppi utenti | POST /v3/usergroups | v3 | 2021.4 | Crea un nuovo gruppo di utenti. | |
75 | Gruppi utenti | DELETE /v3/usergroups/{userGroupId} | v3 | 2021.4 | Elimina un gruppo di utenti esistente. | |
76 | Gruppi utenti | GET /v3/usergroups/{userGroupId} | v3 | 2021.4 | Recupera i dettagli relativi a un gruppo di utenti esistente. | |
77 | Gruppi utenti | PUT /v3/usergroups/{userGroupId} | v3 | 2021.4 | Aggiorna il nome e/o il ruolo di un gruppo di utenti esistente. | |
78 | Gruppi utenti | POST /v3/usergroups/{userGroupId}/users | v3 | 2021.4 | Aggiunge uno o più utenti a un gruppo di utenti esistente. | |
79 | Gruppi utenti | POST /v3/usergroups/{userGroupId}/activedirectorygroups | v3 | 2023.1 | Aggiunge un gruppo Active Directory a un gruppo di utenti esistente. | |
80 | Gruppi utenti | DELETE /v3/usergroups/{userGroupId}/users/{userId} | v3 | 2021.4 | Rimuove un utente da un gruppo di utenti esistente. | |
81 | Gruppi utenti | DELETE /v3/usergroups/{userGroupId}/activedirectorygroups/{adGroupSid}activedirectorygroups/{adGroupSid} | v3 | 2023.1 | Rimuove un gruppo Active Directory da un gruppo di utenti esistente. | |
82 | Utenti | DELETE /v3/users/{userId} | v3 | 2021.4 | Elimina un utente esistente. | |
83 | Utenti | GET /v3/users/{userId} | v3 | 2021.4 | Recupera tutte le risorse accessibili di proprietà di un utente esistente. | |
84 | Utenti | GET /v3/users/{userId}/assets | v3 | 2021.4 | Recupera un elenco completo delle risorse di proprietà di un utente. | |
85 | Utenti | GET /v3/users | v3 | 2021.4 | Recupera tutti i record dell'utente accessibili. | |
86 | Utenti | POST /v3/users | v3 | 2021.4 | Crea un nuovo utente. | |
87 | Utenti | POST /v3/users/{userId}/deactivate | v3 | 2021.4 | Aggiorna un utente esistente come inattivo. | |
88 | Utenti | POST /v3/users/{userId}/passwordReset | v3 | 2021.4 | Invia un'e-mail per la reimpostazione della password a un utente esistente. | |
89 | Utenti | PUT /v3/users/{userId} | v3 | 2021.4 | Aggiorna i dettagli di un utente esistente. | |
90 | Utenti | PUT /v3/users/{userId}/assetTransfer | v3 | 2024.1 | Trasferisce alcune o tutte le risorse (flussi di lavoro, pianificazioni e raccolte) di proprietà di un utente a un altro. | |
91 | Utenti | GET /admin/v2/users | v2 | 11.3 | Trova gli utenti in Server | |
92 | Utenti | GET /admin/v1/users | v1 | 9.1 | Trova gli utenti in Server | |
93 | Flussi di lavoro | GET /v3/Workflows/{workflowId} | v3 | 2021.4 | Recupera i dettagli di un flusso di lavoro esistente. | |
94 | Flussi di lavoro | GET /v3/workflows/{workflowId}/package | v3 | 2022.3 | 2022.3 | Scarica una copia di un pacchetto di flussi di lavoro esistente. |
95 | Flussi di lavoro | GET /v3/workflows/{workflowId}/questions | v3 | 2022.3 | 2022.3 | Recupera le informazioni sulle domande per un'app analitica. |
96 | Flussi di lavoro | GET /v3/workflows/{workflowId}/jobs | v3 | 2022.3 | 2022.3 | Recupera un elenco di processi per un flusso di lavoro esistente. |
97 | Flussi di lavoro | GET /v3/workflows | v3 | 2021.4 | 2022.3 | Recupera tutti i record dei flussi di lavoro accessibili. |
98 | Flussi di lavoro | POST /v3/workflows | v3 | 2021.4 | 2022.3 | Carica un nuovo pacchetto di flussi di lavoro. |
99 | Flussi di lavoro | DELETE /v3/workflows/{workflowId} | v3 | 2021.4 | Elimina un flusso di lavoro esistente. | |
100 | Flussi di lavoro | PUT /v3/workflows/{workflowId} | v3 | 2021.4 | Aggiorna i dettagli di un flusso di lavoro esistente. | |
101 | Flussi di lavoro | POST /v3/workflows/{workflowId}/versions | v3 | 2023.1 | 2023.1 | Carica una nuova versione di un flusso di lavoro esistente. |
102 | Flussi di lavoro | POST /v3/workflows/{workflowId}/jobs | v3 | 2023.2 | 2023.2 | Crea un nuovo processo e lo aggiunge alla coda di esecuzione dei processi. |
103 | Flussi di lavoro | PUT /v3/workflows/{workflowId}/transfer | v3 | 2024.1 | Trasferisce un flusso di lavoro specifico a un determinato proprietario, insieme alle pianificazioni, se lo si desidera. | |
104 | Flussi di lavoro | POST /user/v2/inputfiles | v2 | 2020.3 | 2020.3 | Pubblicato un file temporaneo da utilizzare in una successiva esecuzione del flusso di lavoro |
105 | Flussi di lavoro | GET /admin/v2/workflows/all | v2 | 11.3 | Restituisci tutti i flussi di lavoro, facoltativamente filtrati per data | |
106 | Flussi di lavoro | GET /v1/workflows/{appId}/package | v1 | 9.1 | 9.1 | Restituisce l'app richiesta |
107 | Flussi di lavoro | GET /v1/workflows/{appId}/questions | v1 | 9.1 | 9.1 | Ottieni le domande per l'app Alteryx Analytics specificata |
108 | Flussi di lavoro | GET /v1/workflows/subscription | v1 | 9.1 | 9.1 | Trova i flussi di lavoro in un'iscrizione |
109 | Flussi di lavoro | GET /admin/v1/{appId}/package | v1 | 9.1 | Restituisce l'app richiesta | |
110 | Flussi di lavoro | GET /admin/v1/workflows/migratable | v1 | 9.1 | Trova i flussi di lavoro in Server contrassegnati come pronti per la migrazione | |
111 | Flussi di lavoro | GET /admin/v1/workflows/all | v1 | 9.1 | Restituisci tutti i flussi di lavoro, facoltativamente filtrati per data | |
112 | Flussi di lavoro | GET /admin/v1/workflows | v1 | 9.1 | Trova i flussi di lavoro in Server | |
113 | Flussi di lavoro | POST /admin/v1/workflows | v1 | 9.1 | Pubblica un file YXZP nel sistema | |
114 | Flussi di lavoro | PUT /admin/v1/workflows/migratable/{appId} | v1 | 9.1 | Aggiorna il contrassegno di app pronta per la migrazione. |