Skip to main content

Présentation des API

Important

Si vous débutez avec les API, consultez la page d'aide Pour commencer avec les API .

Important

À partir de la version 2022.1, nous avons retiré nos points de terminaison d'API OAuth1 publics hérités car ils nécessitent un hachage SHA1 non conforme à la norme FIPS. Cette suppression inclut les points de terminaison WCF (Windows communication Framework) hérités, Swagger pour ces points de terminaison hérités et le middleware OAuth1. Pour remplacer les points de terminaison OAuth1, vous pouvez utiliser les versions OAuth2 des API héritées publiées dans la version 21.4, qui sont conformes à la norme FIPS. Vous obtiendrez la même fonctionnalité avec les API OAuth2 que celle disponible avec les API OAuth1.

La souscription et les points de terminaison V1 et V2 continueront d'être pris en charge sous OAuth2.

Pour en savoir plus sur la conversion et son impact, consultez la page d'aide Instructions de migration d'OAuth1 vers OAuth2 ou les  instructions de conversion .

L'API Server est composée de 6 API :

  • API de souscription  : points de terminaison permettant aux utilisateurs d'interagir avec les souscriptions, les workflows et les planifications (tâches).

  • API User V2  : points de terminaison permettant aux utilisateurs d'interagir avec les identifiants, les fichiers d'entrée et les planifications (tâches).

  • API Admin V1  : points de terminaison permettant aux administrateurs d'extraire des ressources de l'interface administrateur.

  • API Admin V2  : version 2 des points de terminaison permettant aux administrateurs d'extraire des ressources de l'interface administrateur.

  • API Admin V3  : version 3 des points de terminaison. Cette version utilise OAuth 2.

  • API User V3  : version 3 des points de terminaison pour les utilisateurs. Cette version utilise OAuth 2.

Note

En plus d'ajouter de nouvelles fonctionnalités avec les points de terminaison de l'API V3 , nous rendons nos points de terminaison V1, de souscription et V2 compatibles pour l'utilisation avec OAuth 2. Les points de terminaison que vous utilisiez au préalable sont désormais disponibles pour OAuth 2 à une nouvelle adresse de base.

L'adresse de l'API Web ne peut être configurée que pour V1, V2 et V3 utilisant OAuth2. Pour la documentation de l'API V1 et V2 utilisant OAuth 1, l'adresse est  http://{ServerHostname}/gallery/api-docs/ .

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

Accéder aux documents de référence de l'API Server

La documentation de référence complète relative à tous les points de terminaison de l'API Server est disponible dans Swagger.

L'interface utilisateur Server présente deux emplacements où vous pouvez accéder à la documentation de référence de l'API Server.

  1. Sélectionnez l'icône en forme de point d'interrogation dans la barre d'outils supérieure et sélectionnez Documentation API .

    Select the question mark to access the API docu.
  2. Vous pouvez également accéder à la documentation de référence de l'API Server à l'aide de l'URL suivante : http(s)://serverhostname.domain/webapi/swagger . Serverhostname est l'URL de votre instance Server.

Authentification sur l'espace de la documentation de référence de l'API Server

Les documents de l'API Server sont interactifs, ce qui vous permet de renseigner les paramètres et de voir les réponses. Pour utiliser l'interactivité, vous devez vous authentifier. Pour ce faire, procédez comme suit :

  1. Dans l'interface utilisateur Server, sélectionnez votre nom d'utilisateur, puis  Mon Profil > Clés . Copiez les clés API de l'API à laquelle vous souhaitez vous authentifier et collez-les dans les champs Clé API et Secret partagé . Les clés s'afficheront avec le statut Enregistré .

  2. Sélectionnez l'appel que vous souhaitez exécuter, renseignez les paramètres et sélectionnez Essayer .

Clés et accès API

Les administrateurs de Server doivent autoriser les utilisateurs à accéder à l'API. Pour plus d'informations, consultez Autoriser l'utilisateur à accéder à l'API Server . Une fois que vous avez accordé aux utilisateurs l'accès à l'API, ils peuvent trouver leurs clés API dans l'onglet Clés de la page Mon Profil . Pour accéder à vos clés API, sélectionnez votre nom d'utilisateur, puis Mon Profil > Clés .

API keys are located under My Profile Keys.

Les utilisateurs ayant le rôle d'administrateur peuvent utiliser les clés d' accès à l'API pour accéder à toutes les API, y compris l'API de souscription, l'API User V2, l'API Admin V1, l'API Admin V2 et l'API V3.

Tous les utilisateurs non-administrateurs peuvent utiliser les clés d' accès à l'API pour accéder à l'API de souscription et à l'API User V2.

Authentification

Pour plus d'informations, reportez-vous à l'article Configuration et autorisation de l'API Server .

Construction de points de terminaison d'API

Pour créer un point de terminaison d'API, utilisez le schéma suivant : <hostname>/webapi/ .

Points de terminaison et paramètres API

Dans cette section, vous trouverez plus d'informations sur les points de terminaison suivants :

Server suit les modifications apportées aux entités système suivantes :

  • AppInfo (workflow)

  • Collection

  • Informations d'identification

  • Souscription

  • Utilisateur

  • UserGroup

Obtenir les événements consignés via l'API Server

Toute mise à jour de ces entités déclenche la création d'un enregistrement d'événement d'audit. Vous pouvez renvoyer ces enregistrements via un point de terminaison d'API administrateur public.

Point de terminaison

Le point de terminaison pour AuditEvents est GET /admin/v1/auditlog/

Paramètres de requête requis

  • entity  : (chaîne) entité du journal d'audit à interroger.

  • page  : (int) page que vous voulez renvoyer.

  • pageSize  : (int) nombre d'enregistrements que vous voulez renvoyer sur chaque page.

La réponse sera renvoyée sous la forme d'un tableau d'enregistrements d'événements d'audit  :

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

Les propriétés renvoyées sont définies ci-dessous :

  • id  : ID de l'événement d'audit.

  • entity  : nom de l'entité.

  • entityId  : ID d'entité de l'entité.

  • userId  : ID de l'utilisateur qui a modifié l'entité.

  • timestamp  : date et heure de création de l'enregistrement de l'événement d'audit.

  • event  : événement qui s'est produit (insertion, mise à jour, suppression).

  • oldValues  : valeurs des propriétés modifiées avant la mise à jour.

  • newValues  : valeurs des propriétés modifiées après la mise à jour.

Pour exécuter des workflows qui utilisent l' outil Explorateur de fichiers via l'API, utilisez le point de terminaison /user/v2/inputfiles pour charger le fichier.

  1. Commencez par formuler une requête POST multipart/form-data au point de terminaison /user/v2/inputfiles pour publier un fichier temporaire. Le nom de la section de données de formulaire requise est inputFile .

    curl --location --request POST 'http:{yourhostname}/api/user/v2/inputfiles/' \
    --form 'inputFile=@/file/path/filename.csv' 
  2. Ensuite, effectuez un POST sur le point de terminaison /user/v2/workflows/{appId}/jobs/ .

    1. Ajoutez ensuite le nom de l'outil Explorateur de fichiers dans l'objet de la question. Si vous n'êtes pas sûr du nom de l'outil Explorateur de fichiers, utilisez le point de terminaison /v1/workflows/{appId}/questions pour l'obtenir.

    2. La valeur est l'ID de référence renvoyé par l'appel de votre fichier d'entrée dans la réponse.

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

Utilisez le point de terminaison migratable pour migrer les workflows dans les environnements de Server. Vous pouvez l'utiliser pour gérer les déploiements de workflows pendant les phases de développement et de test.

Pour commencer, vous devez activer les workflows pour la migration . Une fois que vous avez marqué des workflows pour la migration, suivez ces étapes pour les publier à partir de l'environnement source dans la souscription appropriée (studio) d'un environnement cible.

Étape 1. Obtenez une liste des workflows prêts pour la migration

Ensuite, obtenez une liste des workflows prêts pour la migration à l'aide du point de terminaison suivant :

  • Environnement : source

  • Méthode : GET

  • Point de terminaison : api/admin/v1/workflows/migratable/?subscriptionIds={subscriptionIds}/

Incluez une liste de subscriptionIds séparés par des virgules comme paramètre de requête. Les ID de souscription identifient un studio spécifique.

Vous obtenez un tableau des workflows marqués comme prêts pour la migration sous la souscription spécifiée (studio). Si vous ne fournissez pas de subscriptionsIds , le résultat inclut tous les workflows marqués comme prêts pour la migration. Le résultat inclut 3 propriétés : l' appId , le revisionId actuellement publié et le subscriptionID auquel appartient le workflow.

Étape 2. Téléchargez des workflows à partir de l'environnement source

Le point de terminaison suivant télécharge le workflow sous forme de fichier YXZP.

  • Environnement : source

  • Méthode : GET

  • Point de terminaison : api/admin/v1/{appID}/package/

Incluez un appID comme paramètre de chemin. Vous obtiendrez un téléchargement de l'ensemble du workflow sous forme de package.

Étape 3. Publiez des workflows dans l'environnement cible

Le point de terminaison suivant publie le workflow téléchargé dans l'environnement cible.

  • Environnement : cible

  • Méthode : POST

  • Point de terminaison : api/admin/v1/workflows/

Paramètres

Paramètre

Description

Type

Obligatoire

Tableau

Nom de fichier du nouveau workflow.

Chaîne

Vrai

name

Nom du nouveau workflow.

Chaîne

Vrai

owner

Propriétaire du workflow migré. L'adresse e-mail doit exister dans l'environnement cible.

Chaîne

Vrai

validate

Indicateur pour valider le workflow lors de la migration vers l'environnement cible.

Booléen

Vrai

isPublic

Indicateur pour définir le workflow sur public afin de l'afficher dans « Galerie de ma société » dans l'environnement cible.

Booléen

Vrai

sourceId

Il s'agit de l'appId de l'environnement source du workflow à migrer. Si un workflow avec le même sourceId existe, il remplace ce workflow dans l'environnement cible. Dans le cas contraire, un nouveau workflow sera généré.

(Envoyez une chaîne vide si vous ne souhaitez pas spécifier d'appID.)

Chaîne

Vrai

workerTag

Ajoutez une balise worker au workflow pour qu'un worker spécifique exécute le workflow.

(Envoyez une chaîne vide si vous ne souhaitez pas spécifier de worker.)

Chaîne

Vrai

canDownload

Indicateur pour définir le workflow comme disponible au téléchargement par d'autres utilisateurs dans l'environnement cible.

Booléen

Vrai

(Facultatif) Étape 4. Réinitialisez les workflows de paramétrage de migration dans l'environnement source

Si vous le souhaitez, vous pouvez utiliser le point de terminaison migratable pour définir le paramètre Ce workflow est prêt à être migré sur Non dans l'environnement source après la migration du workflow dans l'environnement cible.

  • Environnement : source

  • Méthode : PUT

  • Point de terminaison : api/admin/v1/workflows/migratable/{appID}/

Pour plus d'informations sur tous les points de terminaison d'API Server, consultez API Server .

Pour plus d'informations sur les points de terminaison et les paramètres V3 de l'API, consultez la page d'aide API Alteryx Server V3 .

API Server

Retrouvez la liste de toutes les API Server publiées dans le tableau ci-dessous. Si une API est disponible pour les utilisateurs, elle est aussi disponible pour les administrateurs.

Section

Point de terminaison d'API

Version

Version Administrateur

Version Utilisateur

Description

1

Journaux d'audit

GET /admin/v1/auditlog

v1

9.1

Récupérer les entrées du journal d'audit pour un type d'entité donné

2

Collections

GET /v3/collections

v3

2021.4

Récupérer tous les enregistrements de collection accessibles.

3

Collections

POST /v3/collections

v3

2021.4

Créer une nouvelle collection.

4

Collections

DELETE /v3/collections/{collectionId}

v3

2021.4

Supprimer une collection existante.

5

Collections

GET /v3/collections/{collectionId}

v3

2021.4

Récupérer les détails d'une collection existante.

6

Collections

PUT /v3/collections/{collectionId}

v3

2021.4

Mettre à jour le nom et/ou le propriétaire d'une collection existante.

7

Collections

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

v3

2021.4

Mettre à jour les autorisations d'un utilisateur au sein d'une collection existante.

8

Collections

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

v3

2021.4

Mettre à jour les autorisations d'un groupe d'utilisateurs au sein d'une collection existante.

9

Collections

POST /v3/collections/{collectionId}/users

v3

2021.4

Ajouter un utilisateur à une collection existante.

10

Collections

POST /v3/collections/{collectionId}/insights

v3

2021.4

Ajouter une analyse à une collection existante.

11

Collections

POST /v3/collections/{collectionId}/schedules

v3

2021.4

Ajouter une planification à une collection existante.

12

Collections

POST /v3/collections/{collectionId}/workflows

v3

2021.4

Ajouter un workflow à une collection existante.

13

Collections

POST /v3/collections/{collectionId}/userGroups

v3

2021.4

Ajouter un groupe d'utilisateurs à une collection existante.

14

Collections

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

v3

2021.4

Retirer un utilisateur d'une collection existante.

15

Collections

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

v3

2021.4

Retirer un workflow d'une collection existante.

16

Collections

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

v3

2021.4

Retirer une analyse d'une collection existante

17

Collections

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

v3

2021.4

Retirer une planification d'une collection

18

Collections

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

v3

2021.4

Retirer un groupe d'utilisateurs d'une collection existante.

19

Collections

GET /admin/v1/collections

v1

9.1

Recherche les collections dans une galerie

20

Informations d'identification

GET /v3/credentials/{credentialId}

v3

2021.4

2022.3

Récupérer les détails d'informations d'identification existantes.

21

Informations d'identification

GET /v3/credentials

v3

2021.4

2022.3

Récupérer tous les enregistrements d'informations d'identification accessibles.

22

Informations d'identification

DELETE /v3/credentials/{credentialId}

v3

2021.4

Supprimer des informations d'identification existantes.

23

Informations d'identification

POST /v3/credentials/{credentialId}/users

v3

2021.4

Partager des informations d'identification existantes avec un utilisateur existant.

24

Informations d'identification

POST /v3/credentials/{credentialId}/userGroups

v3

2021.4

Partager des informations d'identification existantes avec un groupe d'utilisateurs existant.

25

Informations d'identification

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

v3

2021.4

Retirer les autorisations d'un utilisateur permettant d'utiliser des informations d'identification existantes.

26

Informations d'identification

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

v3

2021.4

Retirer l'autorisation d'un groupe d'utilisateurs permettant d'utiliser des informations d'identification existantes.

27

Informations d'identification

GET /user/v2/credentials

v2

11.3

Recherche les informations d'identification partagées directement avec les utilisateurs ou via une souscription

28

DCME

DELETE /v3/dcm/connections/{id}

v3

2023.2

2023.2

Supprimer une connexion DCM.

29

DCME

GET /v3/dcm/connections/{id}

v3

2023.2

2023.2

Récupérer un enregistrement de connexion DCM.

30

DCME

GET /v3/dcm/connections/lookup

v3

2023.2

2023.2

Récupérer une connexion DCM comme référencée dans les workflows.

31

DCME

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

v3

2023.2

2023.2

Annuler le partage d'une connexion DCM.

32

DCME

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

v3

2023.2

2023.2

Partager une connexion DCM avec des utilisateurs et des groupes spécifiés.

33

DCME

POST /v3/dcm/connections

v3

2023.2

2023.2

Créer ou mettre à jour une connexion DCM.

34

DCMEAdmin

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

v3

2023.2

Supprimer une connexion DCM.

35

DCMEAdmin

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

v3

2023.2

Récupérer un enregistrement de connexion DCM.

36

DCMEAdmin

GET /v3/dcm/admin/connections

v3

2023.2

Récupérer une liste des enregistrements de connexion DCM.

37

DCMEAdmin

POST /v3/dcm/admin/connections

v3

2023.2

Créer ou mettre à jour une connexion DCM au nom d'un utilisateur.

38

DCMEAdmin

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

v3

2023.2

Annuler le partage d'une connexion DCM partagée pour l'exécution.

39

DCMEAdmin

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

v3

2023.2

Annuler le partage d'une connexion DCM partagée pour la collaboration.

40

DCMEConnections

GET /v3/DCMEConnections/{connectionId}

v3

2022.1

Récupérer une connexion DCM.E

41

Analyses

GET /admin/v2/insights

v2

11.3

Recherche les analyses dans une galerie

42

Analyses

GET /admin/v1/insights

v1

9.1

Recherche les analyses dans une galerie

43

Tâches

GET /v3/jobs/{jobId}

v3

2022.3

2022.3

Récupérer des détails sur une tâche existante et son état actuel.

44

Tâches

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

Note

Si le workflow a été publié avec des informations d'identification, des informations d'identification partagées doivent être explicitement appliquées dans l'appel d'API.

v2

11.3

11.3

Crée une nouvelle tâche et l'ajoute à la file d'attente d'exécution de la tâche

45

Tâches

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

v1

9.1

9.1

Obtenir la sortie d'une tâche donnée

46

Tâches

GET /v1/jobs/{id}

v1

9.1

9.1

Récupère la tâche et son état actuel

47

Tâches

GET /v1/workflows/{appId}/jobs

v1

9.1

9.1

Renvoie les tâches pour l'application analytique Alteryx donnée

48

Tâches

POST /v1/workflows/{appId}/jobs

Note

Utilisez POST /user/v2/workflows/{appId}/jobs si le workflow a besoin d'informations d'identification pour s'exécuter.

v1

9.1

9.1

Met en file d'attente l'exécution d'une tâche pour le workflow spécifié avec les réponses fournies

49

Tâches

GET /admin/v1/workflows/jobs

v1

9.1

Renvoie la dernière tâche exécutée et son état actuel pour les workflows

50

Planifications

DELETE /v3/schedules/{scheduleId}

v3

2021.4

Supprimer une planification existante.

51

Planifications

GET /v3/schedules/{scheduleId}

v3

2021.4

Récupérer les détails d'une planification existante.

52

Planifications

PUT /v3/schedules/{scheduleId}

v3

2021.4

Mettre à jour les détails d'une planification existante.

53

Planifications

GET /v3/schedules

v3

2021.4

Récupérer tous les enregistrements de planification accessibles.

54

Planifications

POST /v3/schedules

v3

2021.4

Créer une nouvelle planification.

55

Planifications

GET /admin/v2/schedule/forecast

v2

11.3

Prévoit toutes les tâches d'exécution futures pour la période donnée

56

Planifications

GET /admin/v1/schedules

v1

9.1

Recherche les planifications dans une galerie

57

Connexions à Server

GET /v3/serverDataConnections

v3

2021.4

Récupérer tous les enregistrements de connexion aux données Server accessibles.

58

Connexions à Server

DELETE /v3/serverDataConnections/{dataConnectionId}

v3

2021.4

Supprimer une connexion aux données Server existante.

59

Connexions à Server

GET /v3/serverDataConnections/{dataConnectionId}

v3

2021.4

Récupérer les détails d'une connexion aux données Server existante.

60

Connexions à Server

PUT /v3/serverDataConnections/{dataConnectionId}

v3

2021.4

Mettre à jour le nom de connexion d'une connexion aux données Server existante.

61

Connexions à Server

POST /v3/serverDataConnections/{dataConnectionId}/users

v3

2021.4

Partager une connexion aux données Server existante avec un utilisateur existant.

62

Connexions à Server

POST /v3/serverDataConnections/{dataConnectionId}/userGroups

v3

2021.4

Partager une connexion aux données Server existante avec un groupe d'utilisateurs existant.

63

Connexions à Server

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

v3

2021.4

Retirer les autorisations d'un utilisateur permettant d'utiliser une connexion aux données Server existante.

64

Connexions à Server

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

v3

2021.4

Retirer les autorisations d'un groupe d'utilisateurs permettant d'utiliser une connexion aux données Server existante.

65

Connexions à Server

GET /admin/v1/serverdataconnections

v1

9.1

Renvoie les connexions aux données créées dans une galerie privée

66

Souscriptions

GET /admin/v2/subscriptions

v2

11.3

Recherche les souscriptions dans une galerie

67

Souscriptions

GET /admin/v1/subscriptions

v1

9.1

Recherche les souscriptions dans une galerie

68

Alias système

GET /admin/v1/systemdataconnections

v1

9.1

Renvoie les connexions aux données système créées sur le serveur sur lequel Alteryx Server est installé

69

Groupes d'utilisateurs

GET /v3/usergroups

v3

2021.4

Récupérer tous les enregistrements de groupes d'utilisateurs accessibles.

70

Groupes d'utilisateurs

POST /v3/usergroups

v3

2021.4

Créer un nouveau groupe d'utilisateurs.

71

Groupes d'utilisateurs

DELETE /v3/usergroups/{userGroupId}

v3

2021.4

Supprimer un groupe d'utilisateurs existant.

72

Groupes d'utilisateurs

\GET /v3/usergroups/{userGroupId}

v3

2021.4

Récupérer les détails d'un groupe d'utilisateurs existant.

73

Groupes d'utilisateurs

PUT /v3/usergroups/{userGroupId}

v3

2021.4

Mettre à jour le nom et/ou le rôle d'un groupe d'utilisateurs existant.

74

Groupes d'utilisateurs

POST /v3/usergroups/{userGroupId}/users

v3

2021.4

Ajouter un ou plusieurs utilisateurs existants à un groupe d'utilisateurs existant.

75

Groupes d'utilisateurs

POST /v3/usergroups/{userGroupId}/activedirectorygroups

v3

2023.1

Ajouter un groupe Active Directory à un groupe d'utilisateurs existant.

76

Groupes d'utilisateurs

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

v3

2021.4

Retirer un utilisateur d'un groupe d'utilisateurs existant.

77

Groupes d'utilisateurs

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

v3

2023.1

Retirer un groupe Active Directory d'un groupe d'utilisateurs existant.

78

Utilisateurs

DELETE /v3/users/{userId}

v3

2021.4

Supprimer un utilisateur existant.

79

Utilisateurs

GET /v3/users/{userId}

v3

2021.4

Récupérer toutes les ressources accessibles appartenant à un utilisateur existant.

80

Utilisateurs

GET /v3/users/{userId}/assets

v3

2021.4

Récupérer la liste complète des ressources d'un utilisateur

81

Utilisateurs

GET /v3/users

v3

2021.4

Récupérer tous les enregistrements d'utilisateurs accessibles.

82

Utilisateurs

POST /v3/users

v3

2021.4

Créer un nouvel utilisateur.

83

Utilisateurs

POST /v3/users/{userId}/deactivate

v3

2021.4

Mettre à jour un utilisateur existant pour le rendre inactif.

84

Utilisateurs

POST /v3/users/{userId}/passwordReset

v3

2021.4

Envoyer un e-mail de réinitialisation du mot de passe à un utilisateur existant.

85

Utilisateurs

PUT /v3/users/{userId}

v3

2021.4

Mettre à jour les détails d'un utilisateur existant.

86

Utilisateurs

GET /admin/v2/users

v2

11.3

Recherche les utilisateurs dans une galerie

87

Utilisateurs

GET /admin/v1/users

v1

9.1

Recherche les utilisateurs dans une galerie

88

Workflows

GET /v3/workflows/{workflowId}

v3

2021.4

Récupérer les détails d'un workflow existant.

89

Workflows

GET /v3/workflows/{workflowId}/package

v3

2022.3

2022.3

Télécharger une copie d'un package de workflow existant.

90

Workflows

GET /v3/workflows/{workflowId}/questions

v3

2022.3

2022.3

Récupérer des informations de question pour une application analytique.

91

Workflows

GET /v3/workflows/{workflowId}/jobs

v3

2022.3

2022.3

Récupérer une liste de tâches pour un workflow existant.

92

Workflows

GET /v3/workflows

v3

2021.4

2022.3

Récupérer tous les enregistrements de workflows accessibles.

93

Workflows

POST /v3/workflows

v3

2021.4

2022.3

Charger un nouveau package de workflow.

94

Workflows

DELETE /v3/workflows/{workflowId}

v3

2021.4

Supprimer un workflow existant.

95

Workflows

PUT /v3/workflows/{workflowId}

v3

2021.4

Mettre à jour les détails d'un workflow existant.

96

Workflows

POST /v3/workflows/{workflowId}/versions

v3

2023.1

2023.1

Charger une nouvelle version d'un workflow existant.

97

Workflows

POST /v3/workflows/{workflowId}/jobs

v3

2023.2

2023.2

Crée une nouvelle tâche et l'ajoute à la file d'attente d'exécution de la tâche.

98

Workflows

POST /user/v2/inputfiles

v2

2020.3

2020.3

Publication d'un fichier temporaire à utiliser lors de l'exécution ultérieure d'un workflow

99

Workflows

GET /admin/v2/workflows/all

v2

11.3

Renvoyer tous les workflows, éventuellement filtrés par date

100

Workflows

GET /v1/workflows/{appId}/package

v1

9.1

9.1

Renvoie l'application demandée

101

Workflows

GET /v1/workflows/{appId}/questions

v1

9.1

9.1

Obtenir les questions pour l'application analytique Alteryx donnée

102

Workflows

GET /v1/workflows/subscription

v1

9.1

9.1

Recherche les workflows dans une souscription

103

Workflows

GET /admin/v1/{appId}/package

v1

9.1

Renvoie l'application demandée

104

Workflows

GET /admin/v1/workflows/migratable

v1

9.1

Recherche les workflows d'une galerie qui ont été marqués comme prêts pour la migration

105

Workflows

GET /admin/v1/workflows/all

v1

9.1

Renvoyer tous les workflows, éventuellement filtrés par date

106

Workflows

GET /admin/v1/workflows

v1

9.1

Recherche les workflows dans une galerie

107

Workflows

POST /admin/v1/workflows

v1

9.1

Publie un fichier YXZP dans le système

108

Workflows

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

v1

9.1

Met à jour l'indicateur « prêt pour la migration » d'une application