Skip to main content

API 概述

重要

如果您还不熟悉 API，请访问 API 使用入门 帮助页面。

重要

从 2022.1 版开始，我们移除了传统的公共 OAuth1 API 端点，因为它们需要不符合 FIPS 的 SHA1 哈希算法。摒弃内容包括传统的 WCF（Windows 通信框架）端点、用于这些传统端点的 Swagger 以及 OAuth1 中间件。要替换 OAuth1 端点，您可以使用 21.4 版发布且符合 FIPS 标准的旧版 API 的 OAuth2 版本。使用 OAuth2 API 时，功能体验与 OAuth1 API 相同。

OAuth2 将继续支持订阅、V1 和 V2 端点。

要详细了解转换及其影响，请访问 从 OAuth1 转换为 OAuth2 的说明 帮助页面或 转换说明 。

Server API 由 6 个 API 组成：

  • Subscription API ：供用户与订阅、工作流和计划（作业）交互的端点。

  • User V2 API ：供用户与凭证、输入文件和计划（作业）交互的端点。

  • Admin V1 API ：供管理员从管理员界面获取资源的端点。

  • Admin V2 API ：供管理员从管理员界面获取资源的端点版本 2。

  • Admin V3 API ：端点版本 3。此版本使用 OAuth 2。

  • Admin V3 API ：端点版本 3。此版本使用 OAuth 2。

注意

除了为 V3 API 端点 添加新功能之外，我们还将 V1、订阅和 V2 端点提供 OAuth 2 使用。您过去使用的相同端点现在可作为一个 OAuth 2 的新基址。

用 OAuth 2 的情况下，Web API Address 只能为 V1、V2 和 V3 设置 。  OAuth 1 的 V1 和 V2 API 文档地址为 http://{ServerHostname}/gallery/api-docs/ 。

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

访问 Server API 参考文档

Swagger 中提供了所有 Server API 端点的完整参考文档。

Server UI 中有两个位置可以访问 Server API 参考文档。

  1. 选择顶部工具条中的问号图标，然后选择 API 文档 。

    Select the question mark to access the API docu.

  2. 您还可以使用以下 URL 访问 Server API 的参考文档： http(s)://serverhostname.domain/webapi/swagger 。Serverhostname 是您的 Server 实例的 URL。

向 Server API 参考文档进行身份验证

Server API 文档是交互式的，允许您填充参数并查看响应。要使用交互功能，您必须进行身份验证。为此，请执行以下步骤：

  1. 在 Server UI 中，选择您的用户名并选择 我的配置  >  密钥 。复制要向其进行身份验证的 API 的 API 验证序号，并将它们粘贴到 API 验证序号 和 共享密钥 字段中。这些密钥将显示为 已保存 。

  2. 选择要运行的调用，填充参数，然后选择 试用 。

API 验证序号和 API 访问权限

用户访问 API 应由 Server 管理员授权。如需了解详情，请访问 允许用户访问 Server API 。在您授予用户对 API 的访问权限后，用户可以在 我的配置 页面的 密钥 选项卡上找到他们的 API 验证序号。要访问您的 API 密钥，请选择您的用户名并选择 我的配置 > 密钥 。

API keys are located under My Profile Keys.

具有管理员角色的用户可以使用 API 验证 序号访问所有 API，包括 Subscription API、User V2 API、V1 Admin V1 API、V2 Admin V2 API 和 V3 API。

所有非管理员用户都可以使用 API 验证 序号访问 Subscription API 和 User V2 API。

身份验证

如需了解详情，请参阅 Server API 配置和授权 一文。

构建 API 端点

要构建 API 端点，请使用以下架构： <hostname>/webapi/ 。

API 端点和参数

在本节中，您将找到以下端点的相关详情：

审计日志端点

Server 会跟踪对以下系统实体所做的更改：

  • AppInfo（工作流）

  • 集合

  • 凭证

  • 订阅

  • 用户

  • UserGroup

通过 Server API 获取所记录的事件

这些实体每次更新都会生成一条事件审计记录。您可以通过公共的管理 API 端点返回这些记录。

端点

AuditEvents 的端点是 GET /admin/v1/auditlog/

它要求三个查询参数

  • entity ：（字符串）要查询的审计日志实体。

  • page ：(int) 要返回的页面。

  • pageSize ：(int) 每页要返回的记录数。

得到的反馈将是一组事件审计记录：

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

返回的属性定义如下：

  • id ：审计事件 ID。

  • entity ：实体的名称。

  • entityId ：实体的实体 ID。

  • userId ：修改实体的用户的 ID。

  • timestamp ：创建审计事件记录的日期和时间。

  • event ：发生的事件（插入、更新、删除）。

  • oldValues ：在更新之前的更新属性值。

  • newValues ：在更新之后的更新属性值。

Inputfiles 端点

要通过 API 运行使用 文件浏览工具 的工作流，请使用 /user/v2/inputfiles 端点上传文件。

  1. 首先向 /user/v2/inputfiles 端点发出 multipart/form-data POST 请求以发布临时文件。所需 form-data 部分的名称是 inputFile 。

    curl --location --request POST 'http:{yourhostname}/api/user/v2/inputfiles/' \
--form 'inputFile=@/file/path/filename.csv'

  2. 接下来，对 /user/v2/workflows/{appId}/jobs/ 端点执行 POST。

    1. 然后在问号对象中加入文件浏览工具的 名称 。如果您不确定文件浏览工具的名称，请使用 /v1/workflows/{appId}/questions 端点获取文件浏览工具的名称。

    2. value 是您的输入文件调用在响应中返回的参考 ID。

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

可迁移的端点

使用 migratable 端点跨 Server 环境迁移工作流。您可以使用它来管理开发和测试阶段的工作流部署。

首先，必须 启用迁移工作流 。将工作流标记为进行迁移后，请按照以下步骤将它们从源环境发布到目标环境的相应订阅（工作室）中。

第 1 步：获取准备迁移的工作流列表

接下来，使用以下端点获取准备迁移的工作流列表：

  • 环境： 源

  • 方法： GET

  • 端点： api/admin/v1/workflows/migratable/?subscriptionIds={subscriptionIds}/

包括逗号分隔的 subscriptionIds  列表作为查询参数。订阅 ID 用于标识特定的工作室。

返回的结果是在指定订阅（工作室）下标记为准备迁移的工作流数组。如果不提供 subscriptionsIds ，返回的结果将包括所有标记为准备迁移的工作流。返回结果包括 3 个属性： appId 、当前发布的 revisionId 和工作流所属的 subscriptionID 。

第 2 步：从源环境下载工作流

以下端点将工作流下载为 YXZP 文件。

  • Environment: 源

  • 方法： GET

  • 端点： api/admin/v1/{appID}/package/

包括 appID 作为路径参数。返回结果是一个下载包形式的完整工作流。

第 3 步：在目标环境中发布工作流

以下端点将下载的工作流发布到目标环境。

  • 环境： 目标

  • 方法： POST

  • 端点： api/admin/v1/workflows/

参数

参数

描述

类型

必填

file

新工作流的文件名。

字符串

True

name

新工作流名称。

字符串

True

owner

已迁移工作流的所有者。电子邮件地址必须存在于目标环境中。

字符串

True

validate

此标记用于在迁移到目标环境时验证工作流。

布尔值

True

isPublic

此标记用于将工作流设置为公开，以在目标环境中的“我的公司的 Gallery”中显示。

布尔值

True

sourceId

这是要迁移的工作流的源环境 appId。如果存在具有相同 sourceId 的工作流，则会在目标环境中替换该工作流。否则，将生成新的工作流。

（如果不希望指定 appID，请发送空字符串。）

字符串

True

workerTag

将工作程序标签添加到工作流，来让特定工作程序运行工作流。

（如果不希望指定工作程序，请发送空字符串。）

字符串

True

canDownload

此标记用于将工作流设置为可供目标环境中的其他用户下载。

布尔值

True

（可选）第 4 步：在源环境中重置迁移设置工作流

如果需要，您可以在目标环境中迁移工作流后，使用 migratable 端点将源环境中工作流的 此工作流已为迁移准备就绪 设置切换回 否 。

  • Environment: 源

  • 方法： PUT

  • 端点： api/admin/v1/workflows/migratable/{appID}/

如需详细了解所有 Server API 端点，请参阅 Server API 。

如需详细了解 Server API V3 端点和参数，请访问 Alteryx Server API V3 帮助页面。

Server API

在下表中查找所有已发布的 Server API 列表。如果 API 可供用户使用，那么管理员也可以使用。

所属部分

API 端点

版本

管理员发布版本

用户发布版本

描述

1

审计日志

GET /admin/v1/auditlog

v1

9.1

检索给定实体类型的审计日志条目

2

集合

GET /v3/collections

v3

2021.4

检索所有可访问的集合记录。

3

集合

POST /v3/collections

v3

2021.4

创建新的集合。

4

集合

DELETE /v3/collections/{collectionId}

v3

2021.4

删除现有集合。

5

集合

GET /v3/collections/{collectionId}

v3

2021.4

检索有关现有集合的详细信息。

6

集合

PUT /v3/collections/{collectionId}

v3

2021.4

更新现有集合的名称和/或所有者。

7

集合

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

v3

2021.4

更新现有集合中的用户权限。

8

集合

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

v3

2021.4

更新现有集合中的用户组权限。

9

集合

POST /v3/collections/{collectionId}/users

v3

2021.4

将用户添加到现有集合。

10

集合

POST /v3/collections/{collectionId}/insights

v3

2021.4

将洞察添加到现有集合。

11

集合

POST /v3/collections/{collectionId}/schedules

v3

2021.4

将计划添加到现有集合。

12

集合

POST /v3/collections/{collectionId}/workflows

v3

2021.4

将工作流添加到现有集合。

13

集合

POST /v3/collections/{collectionId}/userGroups

v3

2021.4

将用户组添加到现有集合。

14

集合

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

v3

2021.4

从现有集合中移除用户。

15

集合

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

v3

2021.4

从现有集合中移除工作流。

16

集合

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

v3

2021.4

从现有集合中移除洞察

17

集合

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

v3

2021.4

从现有集合中移除计划

18

集合

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

v3

2021.4

从现有集合中移除用户组。

19

集合

GET /admin/v1/collections

v1

9.1

在 Gallery 中查找集合

20

凭证

GET /v3/credentials/{credentialId}

v3

2021.4

2022.3

检索有关现有凭证的详细信息。

21

凭证

GET /v3/credentials

v3

2021.4

2022.3

检索所有可访问的凭证记录。

22

凭证

DELETE /v3/credentials/{credentialId}

v3

2021.4

删除现有凭证。

23

凭证

POST /v3/credentials/{credentialId}/users

v3

2021.4

与现有用户共享现有凭证。

24

凭证

POST /v3/credentials/{credentialId}/userGroups

v3

2021.4

与现有用户组共享现有凭证。

25

凭证

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

v3

2021.4

移除用户使用现有凭证的权限。

26

凭证

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

v3

2021.4

移除用户组使用现有凭证的权限。

27

凭证

GET /user/v2/credentials

v2

11.3

找到直接与用户共享或通过订阅共享的凭证

28

DCME

DELETE /v3/dcm/connections/{id}

v3

2023.2

2023.2

删除 DCM 连接。

29

DCME

GET /v3/dcm/connections/{id}

v3

2023.2

2023.2

检索 DCM 连接记录。

30

DCME

GET /v3/dcm/connections/lookup

v3

2023.2

2023.2

检索工作流中引用的 DCM 连接。

31

DCME

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

v3

2023.2

2023.2

取消共享 DCM 连接。

32

DCME

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

v3

2023.2

2023.2

与指定用户和用户组共享 DCM 连接。

33

DCME

POST /v3/dcm/connections

v3

2023.2

2023.2

创建或更新 DCM 连接。

34

DCMEAdmin

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

v3

2023.2

删除 DCM 连接。

35

DCMEAdmin

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

v3

2023.2

检索 DCM 连接记录。

36

DCMEAdmin

GET /v3/dcm/admin/connections

v3

2023.2

检索 DCM 连接记录列表。

37

DCMEAdmin

POST /v3/dcm/admin/connections

v3

2023.2

代表用户创建或更新 DCM 连接。

38

DCMEAdmin

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

v3

2023.2

取消对共享以执行的 DCM 连接的共享。

39

DCMEAdmin

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

v3

2023.2

取消对共享以便进行协作的 DCM 连接的共享。

40

DCME 连接

GET /v3/DCMEConnections/{connectionId}

v3

2022.1

检索 DCME 连接

41

洞察

GET /admin/v2/insights

v2

11.3

在 Gallery 中查找洞察

42

洞察

GET /admin/v1/insights

v1

9.1

在 Gallery 中查找洞察

43

作业

GET /v3/jobs/{jobId}

v3

2022.3

2022.3

检索有关现有作业及其当前状态的详细信息。

44

作业

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

注意

如果使用凭证发布工作流，则必须在 API 调用中明确地应用共享凭证。

v2

11.3

11.3

创建新作业并将其添加至作业执行队列

45

作业

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

v1

9.1

9.1

获取给定作业的输出

46

作业

GET /v1/jobs/{id}

v1

9.1

9.1

检索作业及其当前状态

47

作业

GET /v1/workflows/{appId}/jobs

v1

9.1

9.1

返回给定 Alteryx Analytics 应用程序的作业

48

作业

POST /v1/workflows/{appId}/jobs

注意

如果工作流需要凭据才能运行，请使用 POST /user/v2/workflows/{appId}/jobs。

v1

9.1

9.1

使用提供的答案为指定工作流的作业执行排队

49

作业

GET /admin/v1/workflows/jobs

v1

9.1

返回上次运行的作业及其工作流的当前状态

50

计划

DELETE /v3/schedules/{scheduleId}

v3

2021.4

删除现有计划。

51

计划

GET /v3/schedules/{scheduleId}

v3

2021.4

检索有关现有计划的详细信息。

52

计划

PUT /v3/schedules/{scheduleId}

v3

2021.4

更新现有计划的详细信息。

53

计划

GET /v3/schedules

v3

2021.4

检索所有可访问的计划记录。

54

计划

POST /v3/schedules

v3

2021.4

创建新计划。

55

计划

GET /admin/v2/schedule/forecast

v2

11.3

预测给定时间段内所有将来的运行作业

56

计划

GET /admin/v1/schedules

v1

9.1

在 Gallery 中查找计划

57

Server 连接

GET /v3/serverDataConnections

v3

2021.4

检索所有可访问的 Server 数据连接记录。

58

Server 连接

DELETE /v3/serverDataConnections/{dataConnectionId}

v3

2021.4

删除现有 Server 数据连接。

59

Server 连接

GET /v3/serverDataConnections/{dataConnectionId}

v3

2021.4

检索有关现有 Server 数据连接的详细信息。

60

Server 连接

PUT /v3/serverDataConnections/{dataConnectionId}

v3

2021.4

更新现有 Server 数据连接的连接名称。

61

Server 连接

POST /v3/serverDataConnections/{dataConnectionId}/users

v3

2021.4

与现有用户共享现有 Server 数据连接。

62

Server 连接

POST /v3/serverDataConnections/{dataConnectionId}/userGroups

v3

2021.4

与现有用户组共享现有 Server 数据连接。

63

Server 连接

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

v3

2021.4

移除用户使用现有 Server 数据连接的权限。

64

Server 连接

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

v3

2021.4

移除用户组使用现有 Server 数据连接的权限。

65

Server 连接

GET /admin/v1/serverdataconnections

v1

9.1

返回私有 Gallery 中创建的数据连接

66

订阅

GET /admin/v2/subscriptions

v2

11.3

在 Gallery 中查找订阅

67

订阅

GET /admin/v1/subscriptions

v1

9.1

在 Gallery 中查找订阅

68

系统别名

GET /admin/v1/systemdataconnections

v1

9.1

返回在安装了 Alteryx Server 的服务器上创建的系统数据连接

69

用户组

GET /v3/usergroups

v3

2021.4

检索所有可访问的用户组记录。

70

用户组

POST /v3/usergroups

v3

2021.4

创建新的用户组。

71

用户组

DELETE /v3/usergroups/{userGroupId}

v3

2021.4

删除现有用户组。

72

用户组

GET /v3/usergroups/{userGroupId}

v3

2021.4

检索有关现有用户组的详细信息。

73

用户组

PUT /v3/usergroups/{userGroupId}

v3

2021.4

更新现有用户组的名称和/或角色。

74

用户组

POST /v3/usergroups/{userGroupId}/users

v3

2021.4

向现有用户组添加一个或多个现有用户。

75

用户组

POST /v3/usergroups/{userGroupId}/activedirectorygroups

v3

2023.1

将 Active Directory 组添加到现有用户组。

76

用户组

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

v3

2021.4

从现有用户组中移除用户。

77

用户组

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

v3

2023.1

从现有用户组中移除 Active Directory 组。

78

用户

DELETE /v3/users/{userId}

v3

2021.4

删除现有用户。

79

用户

GET /v3/users/{userId}

v3

2021.4

检索现有用户拥有的所有可访问资产。

80

用户

GET /v3/users/{userId}/assets

v3

2021.4

检索用户拥有的资产的完整列表

81

用户

GET /v3/users

v3

2021.4

检索所有可访问的用户记录。

82

用户

POST /v3/users

v3

2021.4

创建新用户。

83

用户

POST /v3/users/{userId}/deactivate

v3

2021.4

将现有用户更新为非活跃状态。

84

用户

POST /v3/users/{userId}/passwordReset

v3

2021.4

向现有用户发送密码重置电子邮件。

85

用户

PUT /v3/users/{userId}

v3

2021.4

更新现有用户的详细信息。

86

用户

GET /admin/v2/users

v2

11.3

在 Gallery 中查找用户

87

用户

GET /admin/v1/users

v1

9.1

在 Gallery 中查找用户

88

工作流

GET /v3/workflows/{workflowId}

v3

2021.4

检索有关现有工作流的详细信息。

89

工作流

GET /v3/workflows/{workflowId}/package

v3

2022.3

2022.3

下载现有工作流包的副本。

90

工作流

GET /v3/workflows/{workflowId}/questions

v3

2022.3

2022.3

检索分析应用程序的问题信息。

91

工作流

GET /v3/workflows/{workflowId}/jobs

v3

2022.3

2022.3

检索现有工作流的作业列表。

92

工作流

GET /v3/workflows

v3

2021.4

2022.3

检索所有可访问的工作流记录。

93

工作流

POST /v3/workflows

v3

2021.4

2022.3

上传新的工作流包。

94

工作流

DELETE /v3/workflows/{workflowId}

v3

2021.4

删除现有工作流。

95

工作流

PUT /v3/workflows/{workflowId}

v3

2021.4

更新现有工作流的详细信息。

96

工作流

POST /v3/workflows/{workflowId}/versions

v3

2023.1

2023.1

上传现有工作流的新版本。

97

工作流

POST /v3/workflows/{workflowId}/jobs

v3

2023.2

2023.2

创建新作业并将其添加至作业执行队列。

98

工作流

POST /user/v2/inputfiles

v2

2020.3

2020.3

发布要在后续工作流执行中使用的临时文件

99

工作流

GET /admin/v2/workflows/all

v2

11.3

返回所有工作流，可以选择按日期筛选

100

工作流

GET /v1/workflows/{appId}/package

v1

9.1

9.1

返回请求的应用程序

101

工作流

GET /v1/workflows/{appId}/questions

v1

9.1

9.1

获取给定 Alteryx Analytics 应用程序的问题

102

工作流

GET /v1/workflows/subscription

v1

9.1

9.1

在订阅中查找工作流

103

工作流

GET /admin/v1/{appId}/package

v1

9.1

返回请求的应用程序

104

工作流

GET /admin/v1/workflows/migratable

v1

9.1

在 Gallery 中找到标记为已准备好迁移的工作流

105

工作流

GET /admin/v1/workflows/all

v1

9.1

返回所有工作流，可以选择按日期筛选

106

工作流

GET /admin/v1/workflows

v1

9.1

在 Gallery 中查找工作流

107

工作流

POST /admin/v1/workflows

v1

9.1

将 YXZP 文件发布到系统

108

工作流

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

v1

9.1

更新应用程序的迁移就绪标记

本节内容如下: