Skip to main content

API-Übersicht

Wichtig

Wenn Sie noch nicht mit APIs vertraut sind, besuchen Sie die Hilfeseite Erste Schritte mit APIs .

Wichtig

Mit der Version 2022.1 haben wir unsere älteren öffentlichen OAuth1 API-Endpunkte entfernt, da sie nicht FIPS-konformes SHA1-Hashing erfordern. Dies beinhaltet die Legacy-WCF-Endpunkte (Windows Communication Framework), Swagger für diese Legacy-Endpunkte und OAuth1-Middleware. Um die OAuth1-Endpunkte zu ersetzen, können Sie die OAuth2-Versionen der in 21.4 veröffentlichten Legacy-APIs verwenden, die FIPS-konform sind. Mit den OAuth2-APIs stehen Ihnen dieselben Funktionen zur Verfügung wie mit den OAuth1-APIs.

Abonnement-, V1- und V2-Endpunkte werden unter OAuth2 weiterhin unterstützt.

Weitere Informationen über die Konvertierung und ihre Auswirkungen finden Sie auf der Hilfeseite Anweisungen für OAuth1 zu OAuth2 oder in den Konvertierungsanweisungen .

Die Server-API besteht aus sechs APIs:

  • Abonnement-API : Endpunkte für die Interaktion von Benutzern mit Abonnements, Workflows und Zeitplänen (Aufträge).

  • Benutzer-V2-API : Endpunkte für Benutzer zur Interaktion mit Anmeldedaten, Eingabedateien und Zeitplänen (Jobs).

  • Admin-V1-API : Endpunkte für Administratoren, um Ressourcen von der Admin-Oberfläche abzurufen.

  • Admin-V2-API : Version 2 der Endpunkte für Administratoren, um Ressourcen von der Admin-Oberfläche abzurufen.

  • Admin-V3-API : Version 3 der Endpunkte. Diese Version verwendet OAuth2.

  • Benutzer-V3-API : Version 3 der Endpunkte für Benutzer. Diese Version verwendet OAuth2.

Anmerkung

Zusätzlich zur Erweiterung um neue Funktionen mit V3-API-Endpunkten haben wir auch unsere V1-, Abonnement- und V2-Endpunkte für die Verwendung mit OAuth2 zur Verfügung gestellt. Die gleichen Endpunkte, die Sie in der Vergangenheit verwendet haben, stehen nun für OAuth2 unter einer neuen Basisadresse zur Verfügung.

Die Web-API-Adresse kann mithilfe von OAuth2 nur für V1, V2 und V3 eingerichtet werden. Für die API-Dokumentation von V1 und V2 mit OAuth 1 lautet die Adresse http://{ServerHostname}/gallery/api-docs/ .

The Web API address can be set up in System Settings.

Auf Referenzdokumente der Server-API zugreifen

Die vollständige Referenzdokumentation für alle Server-API-Endpunkte ist in Swagger verfügbar.

In der Server-Benutzeroberfläche gibt es zwei Stellen, an denen Sie auf die Server-API-Referenzdokumentation zugreifen können.

  1. Wählen Sie das Fragezeichen-Symbol in der oberen Symbolleiste und anschließend API-Dokumentation .

    Select the question mark to access the API docu.
  2. Sie können auch über die folgende URL auf die API-Referenzdokumentation für die Server-API zugreifen: http(s)://serverhostname.domain/webapi/swagger . Serverhostname ist die URL zu Ihrer Server-Instanz.

Sich für die Referenzdokumente der Server-API authentifizieren

Die Server-API-Dokumente sind interaktiv, sodass Sie Parameter eingeben und die Antworten anzeigen können. Um die Interaktivität nutzen zu können, müssen Sie sich authentifizieren. Folgen Sie dazu diesen Schritten:

  1. Wählen Sie in der Server-Benutzeroberfläche Ihren Benutzernamen und anschließend Mein Profil  >  Schlüssel . Kopieren Sie die API-Schlüssel für die API, bei der Sie sich authentifizieren möchten, und fügen Sie sie in die Felder API-Schlüssel und Freigegebene Geheimnisse ein. Die Schlüssel werden als Gespeichert angezeigt.

  2. Wählen Sie den Aufruf, den Sie ausführen möchten. Füllen Sie die Parameter aus und wählen Sie Testen .

API-Schlüssel und API-Zugriff

Der Administrator (Server-Admins) muss den Benutzern den Zugriff auf die API erlauben. Weitere Informationen finden Sie unter Benutzerzugriff auf die Server-API erlauben . Sobald Sie den Benutzerzugriff auf die API gewährt haben, können Benutzer ihre API-Schlüssel auf der Registerkarte Schlüssel der Seite Mein Profil finden. Um auf Ihre API-Schlüssel zuzugreifen, wählen Sie Ihren Benutzernamen und dann Mein Profil > Schlüssel aus.

API keys are located under My Profile Keys.

Benutzer:innen mit der Rolle „Administrator“ können mit den Schlüsseln für den  API-Zugriff  auf alle APIs zugreifen, einschließlich der Abonnement-API, der Benutzer-V2-API, der V1-Admin-V1-API, der V2-Admin-V2-API und der V3-API.

Alle Benutzer:innen ohne die Rolle „Administrator“ können die Schlüssel für den API-Zugriff verwenden, um auf die Abonnement-API und die Benutzer-V2-API zuzugreifen.

Authentifizierung

Weitere Informationen finden Sie im Artikel Server-API-Konfiguration und -Autorisierung .

API-Endpunkte erstellen

Um einen API-Endpunkt zu erstellen, verwenden Sie dieses Schema: <hostname>/webapi/ .

API-Endpunkte und -Parameter

In diesem Abschnitt finden Sie weitere Informationen zu den folgenden Endpunkten:

Server verfolgt Änderungen an diesen System-Entitäten:

  • AppInfo (Workflow)

  • Sammlung

  • Anmeldedaten

  • Abonnement

  • Benutzer

  • UserGroup

Protokollierte Ereignisse über die Server-API abrufen

Alle Aktualisierungen dieser Entitäten lösen die Erstellung eines AuditEvent-Datensatzes aus. Sie können diese Einträge über einen öffentlichen Admin-API-Endpunkt zurückgeben.

Endpunkt

Der Endpunkt für AuditEvents ist GET /admin/v1/auditlog/

Erforderliche Abfrageparameter

  • entity : (Zeichenfolge) die Überwachungsprotokoll-Entität, die Sie abfragen möchten.

  • page : (Ganzzahl) die Seite, die Sie zurückgeben möchten.

  • pageSize : (Ganzzahl) die Anzahl der Datensätze, die Sie auf jeder Seite zurückgeben möchten.

Die Antwort besteht aus einem Array von Einträgen der Überwachungsereignisse:

[
  {
    "id": "",
    "entity": "",
    "entityId": "",
    "userId": "",
    "timestamp": "Date",
    "event": "",
    "oldValues": "",
    "newValues": ""
  }
]

Die zurückgegebenen Eigenschaften sind wie folgt definiert:

  • id : die Überwachungsereignis-ID.

  • entity : der Name der Entität.

  • entityId : die Entitäts-ID der Entität.

  • userId : die ID des Benutzers, der die Entität geändert hat.

  • timestamp : Datum und Uhrzeit der Datensatzerstellung für das Überwachungsereignis.

  • event : das aufgetretene Ereignis (Einfügen, Aktualisieren, Löschen).

  • oldValues : die Werte der aktualisierten Eigenschaften vor der Aktualisierung.

  • newValues : die Werte der aktualisierten Eigenschaften nach der Aktualisierung.

Um Workflows, die das Dateiauswahl-Tool verwenden, über die API auszuführen, verwenden Sie den Endpunkt /user/v2/inputfiles  zum Hochladen der Datei.

  1. Beginnen Sie mit einer POST-Anfrage im Format multipart/form-data an den Endpunkt /user/v2/inputfiles , um eine temporäre Datei zu veröffentlichen. Der Name des erforderlichen form-data-Abschnitts lautet inputFile .

    curl --location --request POST 'http:{yourhostname}/api/user/v2/inputfiles/' \
    --form 'inputFile=@/file/path/filename.csv' 
  2. Senden Sie als Nächstes eine POST-Anfrage an den Endpunkt /user/v2/workflows/{appId}/jobs/ .

    1. Fügen Sie dann den Namen  des Dateiauswahl-Tools in das Frageobjekt ein. Wenn Sie sich bei dem Namen des Dateiauswahl-Tools nicht sicher sind, verwenden Sie den Endpunkt  /v1/workflows/{appId}/questions , um den Namen des Dateiauswahl-Tools zu erhalten.

    2. Der value ist die Referenz-ID, die der Aufruf Ihrer Eingabedatei in der Antwort zurückgegeben hat.

    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"
    }'
    

Verwenden Sie den migratable  Endpunkt, um Workflows über Server-Umgebungen hinweg zu migrieren. Damit können Sie Workflow-Bereitstellungen während der Entwicklungs- und Testphase verwalten.

Zunächst müssen Sie  Workflows für die Migration aktivieren . Nachdem Sie Workflows für die Migration markiert haben, befolgen Sie die folgenden Schritte, um sie aus der Quellumgebung in das entsprechende Abonnement (Studio) der Zielumgebung zu veröffentlichen.

1. Schritt: Eine Liste von Workflows abrufen, die für die Migration bereit sind

Als Nächstes rufen Sie mit dem folgenden Endpunkt eine Liste von Workflows ab, die für die Migration bereit sind:

  • Umgebung: Quelle

  • Methode: GET

  • Endpunkt: api/admin/v1/workflows/migratable/?subscriptionIds={subscriptionIds}/

Fügen Sie eine kommagetrennte Liste von subscriptionIds  als Abfrageparameter ein. Abonnement-IDs kennzeichnen ein bestimmtes Studio.

Die Rückgabe ist eine Reihe von Workflows, die als bereit für die Migration unter dem angegebenen Abonnement (Studio) markiert sind. Wenn Sie keine subscriptionsIds bereitstellen, enthält die Rückgabe alle Workflows, die als bereit für die Migration markiert sind. Die Rückgabe enthält drei Eigenschaften: appId , die aktuell veröffentlichte revisionId und die subscriptionID , zu der der Workflow gehört.

2. Schritt: Workflows aus der Quellumgebung herunterladen

Der folgende Endpunkt lädt den Workflow als YXZP-Datei herunter.

  • Umgebung: Quelle

  • Methode: GET

  • Endpunkt: api/admin/v1/{appID}/package/

Fügen Sie eine appID  als Pfadparameter ein. Die Rückgabe erfolgt als Download des gesamten Workflows als Paket.

3. Schritt: Workflows in der Zielumgebung veröffentlichen

Der folgende Endpunkt veröffentlicht den heruntergeladenen Workflow in der Zielumgebung.

  • Umgebung: Ziel

  • Methode: POST

  • Endpunkt: api/admin/v1/workflows/

Parameter

Parameter

Beschreibung

Typ

Erforderlich

file

Der Dateiname des neuen Workflows.

Zeichenfolge

True (wahr)

name

Der neue Workflow-Name.

Zeichenfolge

True (wahr)

owner

Der Besitzer des migrierten Workflows. Die E-Mail-Adresse muss in der Zielumgebung vorhanden sein.

Zeichenfolge

True (wahr)

validate

Flag zum Validieren des Workflows bei der Migration in die Zielumgebung.

Boolesch

True (wahr)

isPublic

Flag zum Setzen des Workflows auf „öffentlich“; wird in der Zielumgebung unter „Gallery meines Unternehmens“ angezeigt.

Boolesch

True (wahr)

sourceId

Dies ist die appId der Quellumgebung des zu migrierenden Workflows. Wenn ein Workflow mit derselben sourceId vorhanden ist, wird dieser Workflow in der Zielumgebung ersetzt. Andernfalls wird ein neuer Workflow generiert.

(Senden Sie eine leere Zeichenfolge, wenn Sie keine appID angeben möchten.)

Zeichenfolge

True (wahr)

workerTag

Fügen Sie dem Workflow einen Worker-Tag hinzu, damit ein bestimmter Worker den Workflow ausführt.

(Senden Sie eine leere Zeichenfolge, wenn Sie keinen Worker festlegen möchten.)

Zeichenfolge

True (wahr)

canDownload

Flag zum Definieren des Workflows als für andere Benutzer in der Zielumgebung zum Herunterladen verfügbar.

Boolesch

True (wahr)

(Optional) Schritt 4. Workflow-Migrationseinstellungen in der Quellumgebung zurücksetzen

Wenn Sie möchten, können Sie den migratable Endpunkt verwenden, um die Einstellung  Dieser Workflow ist bereit für die Migration eines Workflows in der Quellumgebung nach der Workflow-Migration in der Zielumgebung wieder auf Nein zu setzen.

  • Umgebung: Quelle

  • Methode: PUT

  • Endpunkt: api/admin/v1/workflows/migratable/{appID}/

Weitere Informationen zu allen Server-API-Endpunkten finden Sie unter Server-APIs .

Weitere Informationen zu den Endpunkten und Parametern der Server-API V3 finden Sie auf der Hilfeseite Alteryx Server-API V3 .

Server-APIs

Die Liste aller freigegebenen Server-APIs finden Sie in der Tabelle unten. Wenn ein API für Benutzer verfügbar ist, ist sie auch für Administratoren verfügbar.

Scrollen Sie nach links und rechts, um ausgeblendete Spalten in der Tabelle anzuzeigen.

Section

API-Endpunkt

Version

Build: Admin-Version

Build: Benutzer-Version

Beschreibung

1

Überwachungsprotokolle

GET /admin/v1/auditlog

v1

9.1

Auditprotokolleinträge für einen bestimmten Entitätstyp abrufen

2

Sammlungen

GET /V3/collections

v3

2021.4

Alle zugänglichen Datensätze einer Sammlung abrufen.

3

Sammlungen

POST /V3/collections

v3

2021.4

Eine neue Sammlung erstellen.

4

Sammlungen

DELETE /v3/collections/{collectionId}

v3

2021.4

Eine vorhandene Sammlung löschen.

5

Sammlungen

GET /v3/collections/{collectionId}

v3

2021.4

Details zu einer vorhandenen Sammlung abrufen.

6

Sammlungen

PUT /v3/collections/{collectionId}

v3

2021.4

Den Namen und/oder den Besitzer einer vorhandenen Sammlung aktualisieren.

7

Sammlungen

PUT /v3/collections/{collectionId}/users/{userId}/permissions

v3

2021.4

Die Berechtigungen eines Benutzers innerhalb einer vorhandenen Sammlung aktualisieren.

8

Sammlungen

PUT /v3/collections/{collectionId}/userGroups/{userGroupId}/permissions

v3

2021.4

Die Berechtigungen einer Benutzergruppe innerhalb einer vorhandenen Sammlung aktualisieren.

9

Sammlungen

POST /v3/collections/{collectionId}/users

v3

2021.4

Einen Benutzer einer vorhandenen Sammlung hinzufügen.

10

Sammlungen

POST /v3/collections/{collectionId}/insights

v3

2021.4

Ein Insight einer vorhandenen Sammlung hinzufügen.

11

Sammlungen

POST /v3/collections/{collectionId}/schedules

v3

2021.4

Einen Zeitplan einer vorhandenen Sammlung hinzufügen.

12

Sammlungen

POST /v3/collections/{collectionId}/workflows

v3

2021.4

Einen Workflow einer vorhandenen Sammlung hinzufügen.

13

Sammlungen

POST /v3/collections/{collectionId}/userGroups

v3

2021.4

Eine Benutzergruppe einer vorhandenen Sammlung hinzufügen.

14

Sammlungen

DELETE /v3/collections/{collectionId}/users/{userId}

v3

2021.4

Einen Benutzer aus einer vorhandenen Sammlung entfernen.

15

Sammlungen

DELETE /v3/collections/{collectionId}/workflows/{appId}

v3

2021.4

Einen Workflow aus einer vorhandenen Sammlung entfernen.

16

Sammlungen

DELETE /v3/collections/{collectionId}/insights/{insightId}

v3

2021.4

Ein Insight aus einer vorhandenen Sammlung entfernen.

17

Sammlungen

DELETE /v3/collections/{collectionId}/schedules/{scheduleId}

v3

2021.4

Einen Zeitplan aus einer Sammlung entfernen.

18

Sammlungen

DELETE /v3/collections/{collectionId}/userGroups/{userGroupId}

v3

2021.4

Eine Benutzergruppe aus einer vorhandenen Sammlung entfernen.

19

Sammlungen

GET /admin/v1/collections

v1

9.1

Sucht Sammlungen in einer Gallery

20

Anmeldedaten

GET /v3/credentials/{credentialId}

v3

2021.4

2022.3

Details zu vorhandenen Anmeldedaten abrufen.

21

Anmeldedaten

GET /v3/credentials

v3

2021.4

2022.3

Alle zugänglichen Anmeldedatensätze abrufen.

22

Anmeldedaten

DELETE /v3/credentials/{credentialId}

v3

2021.4

Vorhandene Anmeldedaten löschen.

23

Anmeldedaten

POST /v3/credentials/{credentialId}/users

v3

2021.4

Vorhandene Anmeldedaten für einen vorhandenen Benutzer freigeben.

24

Anmeldedaten

POST /v3/credentials/{credentialId}/userGroups

v3

2021.4

Vorhandene Anmeldedaten für eine vorhandene Benutzergruppe freigeben.

25

Anmeldedaten

DELETE /v3/credentials/{credentialId}/users/{userId}

v3

2021.4

Die Berechtigungen eines Benutzers zur Verwendung vorhandener Anmeldedaten entfernen.

26

Anmeldedaten

DELETE /v3/credentials/{credentialId}/userGroups/{userGroupId}

v3

2021.4

Die Berechtigung einer Benutzergruppe zur Verwendung vorhandener Anmeldedaten entfernen.

27

Anmeldedaten

GET /user/v2/credentials

v2

11.3

Sucht Anmeldedaten, die direkt mit Benutzern oder über einen Sub geteilt werden

28

DCME

DELETE /v3/dcm/connections/{id}

v3

2023.2

2023.2

Eine DCM-Verbindung löschen.

29

DCME

GET /v3/dcm/connections/{id}

v3

2023.2

2023.2

Einen DCM-Verbindungsdatensatz abrufen.

30

DCME

GET /v3/dcm/connections/lookup

v3

2023.2

2023.2

Eine DCM-Verbindung wie in Workflows referenziert abrufen.

31

DCME

DELETE /v3/dcm/connections/{id}/sharing/execution

v3

2023.2

2023.2

Freigabe einer DCM-Verbindung aufheben.

32

DCME

PUT /v3/dcm/connections/{id}/sharing/execution

v3

2023.2

2023.2

Eine DCM-Verbindung für angegebene Benutzer und Gruppen freigeben.

33

DCME

POST /v3/dcm/connections

v3

2023.2

2023.2

Eine DCM-Verbindung erstellen oder aktualisieren.

34

DCMEAdmin

DELETE /v3/dcm/admin/connections/{objectId}

v3

2023.2

Eine DCM-Verbindung löschen.

35

DCMEAdmin

GET /v3/dcm/admin/connections/{objectId}

v3

2023.2

Einen DCM-Verbindungsdatensatz abrufen.

36

DCMEAdmin

GET /v3/dcm/admin/connections

v3

2023.2

Eine Liste der DCM-Verbindungsdatensätze abrufen.

37

DCMEAdmin

POST /v3/dcm/admin/connections

v3

2023.2

Eine DCM-Verbindung im Namen eines Benutzers erstellen oder aktualisieren.

38

DCMEAdmin

DELETE /v3/dcm/admin/connections/{objectId}/sharing/execution

v3

2023.2

Freigabe einer DCM-Verbindung aufheben, die zur Ausführung freigegeben wurde.

39

DCMEAdmin

DELETE /v3/dcm/admin/connections/{objectId}/sharing/collaboration

v3

2023.2

Freigabe einer DCM-Verbindung aufheben, die für die Zusammenarbeit freigegeben wurde.

40

DCMEAdmin

GET /v3/dcm/admin/connectionhandlingrules

v3

2024.1

Rufen Sie alle Regeln für die DCM-Verbindungsbehandlung ab.

41

DCMEAdmin

GET /v3/dcm/admin/connectionhandlingrules/{id}

v3

2024.1

Rufen Sie eine einzelne spezifische Regel für die DCM-Verbindungsbehandlung ab.

42

DCMEAdmin

POST /v3/dcm/admin/connectionhandlingrules

v3

2024.1

Fügen Sie eine Regel zur DCM-Verbindungsbehandlung hinzu oder aktualisieren Sie sie.

43

DCMEAdmin

DELETE /v3/dcm/admin/connectionhandlingrules/{id}

v3

2024.1

Löschen Sie eine bestehende Regel für die DCM-Verbindungsbehandlung:

44

DCMEConnections

GET /v3/DCMEConnections/{connectionId}

v3

2022.1

Eine DCM.E-Verbindung abrufen

45

Insights

GET /admin/v2/insights

v2

11.3

Sucht Insights in einer Gallery

46

Insights

GET /admin/v1/insights

v1

9.1

Sucht Insights in einer Gallery

47

Aufträge

GET /v3/jobs/{jobId}

v3

2022.3

2022.3

Details zu einem vorhandenen Auftrag und seinem aktuellen Status abrufen.

48

Aufträge

POST /user/v2/workflows/{appId}/jobs

Anmerkung

Wenn der Workflow mit Anmeldedaten veröffentlicht wurde, müssen freigegebene Anmeldedaten explizit im API-Aufruf angewendet werden.

v2

11.3

11.3

Erstellt einen neuen Auftrag und fügt ihn der Auftragsausführungswarteschlange hinzu

49

Aufträge

GET /v1/jobs/{id}/output/{outputId}

v1

9.1

9.1

Ausgabe für einen bestimmten Auftrag abrufen

50

Aufträge

GET /v1/jobs/{id}

v1

9.1

9.1

Ruft den Auftrag und seinen aktuellen Status ab

51

Aufträge

GET /v1/workflows/{appId}/jobs

v1

9.1

9.1

Gibt die Aufträge für die angegebene Alteryx Analytics App zurück

52

Aufträge

POST /v1/workflows/{appId}/jobs

Anmerkung

Verwenden Sie POST /user/v2/workflows/{appId}/jobs, wenn für den Workflow Anmeldedaten erforderlich sind.

v1

9.1

9.1

Stellt eine Auftragsausführung für den angegebenen Workflow mit den angegebenen Antworten in die Warteschlange

53

Aufträge

GET /admin/v1/workflows/jobs

v1

9.1

Gibt den letzten ausgeführten Auftrag und seinen aktuellen Status für Workflows zurück

54

Zeitpläne

DELETE /v3/schedule/{scheduleId}

v3

2021.4

Einen vorhandenen Zeitplan löschen.

55

Zeitpläne

GET /v3/schedule/{scheduleId}

v3

2021.4

Details zu einem vorhandenen Zeitplan abrufen.

56

Zeitpläne

PUT /v3/schedule/{scheduleId}

v3

2021.4

Details eines vorhandenen Zeitplans aktualisieren.

57

Zeitpläne

GET /v3/schedules

v3

2021.4

Alle zugänglichen Zeitplandatensätze abrufen.

58

Zeitpläne

POST /v3/schedules

v3

2021.4

Erstellen Sie einen neuen Zeitplan.

59

Zeitpläne

GET /admin/v2/schedule/forecast

v2

11.3

Prognostiziert alle zukünftigen Aufträge für den angegebenen Zeitraum

60

Zeitpläne

GET /admin/v1/schedules

v1

9.1

Sucht Zeitpläne in einer Gallery

61

Server-Verbindungen

GET /v3/serverDataConnections

v3

2021.4

Alle zugänglichen Server-Datenverbindungsdatensätze abrufen.

62

Server-Verbindungen

DELETE /v3/serverDataConnections/{dataConnectionId}

v3

2021.4

Eine vorhandene Server-Datenverbindung löschen.

63

Server-Verbindungen

GET /v3/serverDataConnections/{dataConnectionId}

v3

2021.4

Details zu einer vorhandenen Server-Datenverbindung abrufen.

64

Server-Verbindungen

PUT /v3/serverDataConnections/{dataConnectionId}

v3

2021.4

Den Verbindungsnamen einer vorhandenen Server-Datenverbindung aktualisieren.

65

Server-Verbindungen

POST /v3/serverDataConnections/{dataConnectionId}/users

v3

2021.4

Eine vorhandene Server-Datenverbindung für einen vorhandenen Benutzer freigeben.

66

Server-Verbindungen

POST /v3/serverDataConnections/{dataConnectionId}/userGroups

v3

2021.4

Eine vorhandenen Server-Datenverbindung für eine vorhandene Benutzergruppe freigeben.

67

Server-Verbindungen

DELETE /v3/serverDataConnections/{dataConnectionId}/users/{userId}

v3

2021.4

Berechtigungen eines Benutzers zur Verwendung einer vorhandenen Server-Datenverbindung entfernen.

68

Server-Verbindungen

DELETE /v3/serverDataConnections/{dataConnectionId}/userGroups/{userGroupId}

v3

2021.4

Berechtigungen einer Benutzergruppe zur Verwendung einer vorhandenen Server-Datenverbindung entfernen.

69

Server-Verbindungen

GET /admin/v1/serverdataconnections

v1

9.1

Gibt Datenverbindungen zurück, die in einer privaten Gallery erstellt wurden

70

Abonnements

GET /admin/v2/subscriptions

v2

11.3

Sucht Abonnements in einer Gallery

71

Abonnements

GET /admin/v1/subscriptions

v1

9.1

Sucht Abonnements in einer Gallery

72

System-Alias

GET /admin/v1/systemdataconnections

v1

9.1

Gibt Systemdatenverbindungen zurück, die auf dem Server erstellt wurden, auf dem Alteryx Server installiert ist

73

Benutzergruppen

GET /v3/usergroups

v3

2021.4

Alle zugänglichen Datensätze für Benutzergruppen abrufen.

74

Benutzergruppen

POST /v3/usergroups

v3

2021.4

Einen neue Benutzergruppe erstellen.

75

Benutzergruppen

DELETE /v3/usergroups/{userGroupId}

v3

2021.4

Eine vorhandene Benutzergruppe löschen.

76

Benutzergruppen

GET /v3/usergroups/{userGroupId}

v3

2021.4

Details zu einer vorhandenen Benutzergruppe abrufen.

77

Benutzergruppen

PUT /v3/usergroups/{userGroupId}

v3

2021.4

Den Namen und/oder die Rolle einer vorhandenen Benutzergruppe aktualisieren.

78

Benutzergruppen

POST /v3/usergroups/{userGroupId}/users

v3

2021.4

Einen oder mehrere vorhandene Benutzer einer vorhandenen Benutzergruppe hinzufügen.

79

Benutzergruppen

POST /v3/usergroups/{userGroupId}/activedirectorygroups

v3

2023.1

Einer vorhandenen Benutzergruppe eine Active Directory-Gruppe hinzufügen.

80

Benutzergruppen

DELETE /v3/usergroups/{userGroupId}/users/{userId}

v3

2021.4

Einen Benutzer aus einer vorhandenen Benutzergruppe entfernen.

81

Benutzergruppen

DELETE /v3/usergroups/{userGroupId}/activedirectorygroups/{adGroupSid}activedirectorygroups/{adGroupSid}

v3

2023.1

Eine Active Directory-Gruppe aus einer vorhandenen Benutzergruppe entfernen.

82

Benutzer

DELETE /v3/users/{userId}

v3

2021.4

Einen vorhandenen Benutzer löschen.

83

Benutzer

GET /v3/users/{userId}

v3

2021.4

Alle zugänglichen Assets abrufen, die einem vorhandenen Benutzer gehören.

84

Benutzer

GET /v3/users/{userId}/assets

v3

2021.4

Eine vollständige Liste der Assets abrufen, die einem Benutzer gehören.

85

Benutzer

GET /v3/users

v3

2021.4

Alle zugänglichen Benutzerdatensätze abrufen.

86

Benutzer

POST /v3/users

v3

2021.4

Einen neuen Benutzer erstellen.

87

Benutzer

POST /v3/users/{userId}/deactivate

v3

2021.4

Einen vorhandenen Benutzer als inaktiv aktualisieren.

88

Benutzer

POST /v3/users/{userId}/passwordReset

v3

2021.4

Eine E-Mail zum Zurücksetzen des Kennworts an einen vorhandenen Benutzer senden.

89

Benutzer

PUT /v3/users/{userId}

v3

2021.4

Details eines vorhandenen Benutzers aktualisieren.

90

Benutzer

PUT /v3/users/{userId}/assetTransfer

v3

2024.1

Übertragen Sie den Besitz an einigen oder allen Assets (Workflows, Zeitpläne und Sammlungen) zwischen Benutzern.

91

Benutzer

GET /admin/v2/users

v2

11.3

Sucht Benutzer in einer Gallery

92

Benutzer

GET /admin/v1/users

v1

9.1

Sucht Benutzer in einer Gallery

93

Workflows

GET /v3/workflows/{workflowId}

v3

2021.4

Details zu einem vorhandenen Workflow abrufen.

94

Workflows

GET /v3/workflows/{workflowId}/package

v3

2022.3

2022.3

Eine Kopie eines vorhandenen Workflow-Pakets herunterladen.

95

Workflows

GET /v3/workflows/{workflowId}/questions

v3

2022.3

2022.3

Frageinformationen für eine analytische App abrufen.

96

Workflows

GET /v3/workflows/{workflowId}/jobs

v3

2022.3

2022.3

Eine Liste der Aufträge für einen vorhandenen Workflow abrufen.

97

Workflows

GET /v3/workflows

v3

2021.4

2022.3

Alle zugänglichen Workflowdatensätze abrufen.

98

Workflows

POST /v3/workflows

v3

2021.4

2022.3

Ein neues Workflow-Paket hochladen.

99

Workflows

DELETE /v3/workflows/{workflowId}

v3

2021.4

Einen vorhandenen Workflow löschen.

100

Workflows

PUT /v3/workflows/{workflowId}

v3

2021.4

Details eines vorhandenen Workflows aktualisieren.

101

Workflows

POST /v3/workflows/{workflowId}/versions

v3

2023.1

2023.1

Eine neue Version eines vorhandenen Workflows hochladen.

102

Workflows

POST /v3/workflows/{workflowId}/jobs

v3

2023.2

2023.2

Erstellt einen neuen Auftrag und fügt ihn der Auftragsausführungswarteschlange hinzu.

103

Workflows

PUT /v3/workflows/{workflowId}/transfer

v3

2024.1

Übertragen Sie einen bestimmten Workflow an bestimmte Besitzer:innen, zusammen mit Zeitplänen, falls gewünscht.

104

Workflows

POST /user/v2/inputfiles

v2

2020.3

2020.3

Veröffentlichte eine temporäre Datei, die in einer nachfolgenden Workflow-Ausführung verwendet werden soll

105

Workflows

GET /admin/v2/workflows/all

v2

11.3

Alle Workflows zurückgeben, optional nach Datum gefiltert

106

Workflows

GET /v1/workflows/{appId}/package

v1

9.1

9.1

Gibt die angeforderte App zurück

107

Workflows

GET /v1/workflows/{appId}/questions

v1

9.1

9.1

Fragen zur angegebenen Alteryx Analytics App abrufen

108

Workflows

GET /v1/workflows/subscription

v1

9.1

9.1

Sucht Workflows in einem Abonnement

109

Workflows

GET /admin/v1/{appId}/package

v1

9.1

Gibt die angeforderte App zurück

110

Workflows

GET /admin/v1/workflows/migratable

v1

9.1

Sucht Workflows in einer Gallery, die für die Migration als bereit markiert wurden

111

Workflows

GET /admin/v1/workflows/all

v1

9.1

Alle Workflows zurückgeben, optional nach Datum gefiltert

112

Workflows

GET /admin/v1/workflows

v1

9.1

Sucht Workflows in einer Gallery

113

Workflows

POST /admin/v1/workflows

v1

9.1

Veröffentlicht eine YXZP auf dem System

114

Workflows

PUT /admin/v1/workflows/migratable/{appId}

v1

9.1

Aktualisiert die Kennzeichnung „Bereit für die Migration“ einer App