Skip to main content

API の概要

重要

APIを初めて使用する場合は、「 APIを開始する 」のヘルプページを参照してください。

重要

2022.1リリース以降、当社は、FIPSに準拠していないSHA1ハッシュを必要とするレガシーの公開OAuth1 APIエンドポイントを削除しました。この削除では、レガシーのWCF(Windows Communication Framework) エンドポイント、こうしたレガシーエンドポイントのSwagger、およびOAuth1ミドルウェアも対象になります。OAuth1 エンドポイントの代わりに、21.4 でリリースされたレガシー API の OAuth2 エンドポイント (FIPS 準拠) を使用できます。OAuth2 API では、OAuth1 API と同じ機能を利用できます。

サブスクリプション、V1 および V2 エンドポイントは、今後も OAuth2 でサポートされる予定です。

変換とその影響の詳細については、「 OAuth1からOAuth2への移行手順 」ヘルプページまたは「 移行手順 」を参照してください。

Server APIは、次の6つのAPIで構成されています。

  • Subscription API : ユーザーがサブスクリプション、ワークフロー、スケジュール(ジョブ)を操作するためのエンドポイントです。

  • User V2 API : ユーザーが資格情報、入力ファイル、スケジュール (ジョブ) を操作するためのエンドポイントです。

  • Admin V1 API : 管理者が管理インターフェースからリソースを取得するためのエンドポイントです。

  • Admin V2 API : 管理者が管理インターフェースからリソースを取得するためのエンドポイントのバージョン2です。

  • Admin V3 API : エンドポイントのバージョン 3 です。このバージョンでは OAuth 2 が使用されています。

  • User V3 API : ユーザー向けエンドポイントのバージョン3です。このバージョンでは OAuth 2 が使用されています。

注記

V3 API エンドポイント での新機能追加に加え、V1、サブスクリプション、V2 エンドポイントも OAuth 2 で使用できるようになりました。これまで使用していたエンドポイントと同じエンドポイントが、新しいベースアドレスで OAuth 2 に対応しました。Server API V3 オブジェクト

Web API アドレスは、OAuth 2 を使用する 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 リファレンスドキュメントの利用

すべての Server API エンドポイントに関する完全なリファレンスドキュメントは、Swaggerで提供されています。

Server UIには、Server APIリファレンスドキュメントにアクセスできる場所が2か所あります。

  1. 上部ツールバーの疑問符アイコンを選択し、 [ API ドキュメント ] を選択します。

    Select the question mark to access the API docu.

  2. Server APIのAPIリファレンスドキュメントは、URL: http(s)://serverhostname.domain/webapi/swagger を使用してアクセスすることもできます。Serverhostnameは、ServerインスタンスのURLです。

Server API リファレンスドキュメントへの認証

Server API のドキュメントは、パラメーターを入力してレスポンスを確認することができるインタラクティブなものとなっています。このインタラクティブ機能を使用するには、認証を行う必要があります。これを行うには、次の手順を実行します。

  1. Server UIでユーザー名を選択し、[ マイプロフィール ] > [ キー ]を選択します。認証したいAPIのAPIキーをコピーし、[ API キー ] フィールドと [ Shared Secret ] (共有暗号鍵) フィールドに貼り付けます。キーは [ Saved ] (保存済み) と表示されます。

  2. 実行したい呼び出しを選択し、パラメーターを入力して、[ 試してみる ] を選択します。

API キーと API アクセス

管理者 (Server 管理者) は、ユーザーに API へのアクセスを許可する必要があります。詳細については、「 Allow User Access to the Server API (Server API へのユーザーアクセスを許可する) 」を参照してください。API へのユーザーアクセスを許可すると、ユーザーは [ My Profile ] ページの [ Keys ] タブで API キーを見つけることができるようになります。APIキーにアクセスするには、ユーザー名を選択し、 [ マイプロフィール ] > [ キー ] を選択します。

API keys are located under My Profile Keys.

管理者ロールを有するユーザーは、 APIアクセス キーを使用して、Subscription API、User V2 API、V1 Admin V1 API、V2 Admin V2 API、V3 APIを含むすべてのAPIにアクセスすることができます。

すべての非管理者ユーザーは、 APIアクセス キーを使用してSubscription APIとUser V2 APIにアクセスできます。

認証

詳細については、「 Server APIの設定と認証 」の記事をご覧ください。

API エンドポイントの構築

APIエンドポイントを構築するには、 <hostname>/webapi/ というスキーマを使用します。

API エンドポイントとパラメーター

このセクションでは、次のエンドポイントについて詳しく説明します。

監査ログエンドポイント

Server は、以下のシステムエンティティに対する変更を追跡します。

  • AppInfo (ワークフロー)

  • Collection (コレクション)

  • Credential (資格情報)

  • Subscription (サブスクリプション)

  • User

  • UserGroup

Server API を使用して記録したイベントを取得する

これらのエンティティが更新されると、AuditEventレコードが作成されます。これらのレコードは、パブリック管理者 API エンドポイントを介して返すことができます。

エンドポイント

AuditEvents のエンドポイント: GET /admin/v1/auditlog/

必須のクエリーパラメーター

  • entity : (文字列) 照会する監査ログエンティティ。

  • page : (整数) 返すページ。

  • pageSize : (整数)各ページで返すレコードの数。

応答は、監査イベントレコードの配列になります。

[
  {
    "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. その後、質問オブジェクトにファイル参照ツールの name を含めます。ファイル参照ツールの名前がわからない場合は、 /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.移行準備が整ったワークフローのリストを取得する

次に、次のエンドポイントを使用して、移行準備が整ったワークフローのリストを取得します。

  • Environment:  移行元

  • Method: GET

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

クエリパラメーターとして、 subscriptionIds のカンマ区切りリストを含めます。サブスクリプション ID は、特定のスタジオを識別します。

指定されたサブスクリプション(スタジオ)下で移行準備完了とマークされた一連のワークフローが返されます。 subscriptionsIds を指定しない場合、移行準備完了としてマークされたすべてのワークフローが返されます。この戻り値には、 appId 、現在公開されている revisionId 、 ワークフローが属する subscriptionID の3つのプロパティが含まれます。

ステップ 2.ソース環境からワークフローをダウンロードする

次のエンドポイントは、ワークフローをYXZPファイルとしてダウンロードします。

  • Environment:  移行元

  • Method: GET

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

パスパラメーターとして appID を含めます。ワークフロー全体をパッケージとしたダウンロードが返されます。

ステップ3.移行先の環境でワークフローを公開する

以下のエンドポイントは、ダウンロードしたワークフローを移行先の環境に公開します。

  • Environment:  移行先

  • Method: POST

  • Endpoint: api/admin/v1/workflows/

パラメーター

パラメーター

説明

データ型

必須

file

新しいワークフローのファイル名です。

文字列

True

name

新しいワークフロー名です。

文字列

True

owner

移行されたワークフローの所有者です。E メールアドレスは、移行先の環境に存在している必要があります。

文字列

True

validate

移行先の環境への移行時にワークフローを検証するためのフラグです。

ブール値

True

isPublic

ワークフローを公開に設定し、移行先の環境で「自社の Gallery」に表示させるためのフラグです。

ブール値

True

sourceId

移行予定のワークフローの移行元環境のappIdです。同じsourceIdを持つワークフローが存在する場合、移行先の環境でそのワークフローを置き換えます。それ以外の場合は、新しいワークフローが生成されます。

(appIDを指定しない場合は、空の文字列を送信します。)

文字列

True

workerTag

ワークフローにワーカータグを追加し、特定のワーカーがワークフローを実行するようにします。

(ワーカーを指定しない場合は、空の文字列を送信します。)

文字列

True

canDownload

移行先の環境の他のユーザーがワークフローをダウンロードできるように設定するフラグです。

ブール値

True

(オプション) ステップ 4.移行元の環境で移行設定のワークフローをリセットする

必要に応じて、 migratable エンドポイントを使用し、移行先の環境でワークフローを移行した後に、移行先の環境におけるワークフローの [ このワークフローを移行対象にする ] 設定を [ いいえ ] に戻すことができます。

  • Environment:  移行元

  • Method: PUT

  • Endpoint: 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

資格情報 (Credentials)

GET /v3/credentials/{credentialId}

v3

2021.4

2022.3

既存の資格情報に関する詳細を取得します。

21

資格情報 (Credentials)

GET /v3/credentials

v3

2021.4

2022.3

アクセス可能なすべての資格情報レコードを取得します。

22

資格情報 (Credentials)

DELETE /v3/credentials/{credentialId}

v3

2021.4

既存の資格情報を削除します。

23

資格情報 (Credentials)

POST /v3/credentials/{credentialId}/users

v3

2021.4

既存の資格情報を既存のユーザーと共有します。

24

資格情報 (Credentials)

POST /v3/credentials/{credentialId}/userGroups

v3

2021.4

既存の資格情報を既存のユーザーグループと共有します。

25

資格情報 (Credentials)

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

v3

2021.4

ユーザーの権限を削除して、既存の資格情報を使用できるようにします。

26

資格情報 (Credentials)

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

v3

2021.4

ユーザーグループの権限を削除して、既存の資格情報を使用できるようにします。

27

資格情報 (Credentials)

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

DCMEAdmin

GET /v3/dcm/admin/connectionhandlingrules

v3

2024.1

すべてのDCM接続処理ルールを取得します。

41

DCMEAdmin

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

v3

2024.1

特定のDCM接続処理ルールを1つ取得します。

42

DCMEAdmin

POST /v3/dcm/admin/connectionhandlingrules

v3

2024.1

DCM接続処理ルールを追加または更新します。

43

DCMEAdmin

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

v3

2024.1

既存のDCM接続処理ルールを削除します。

44

DCMEConnections

GET /v3/DCMEConnections/{connectionId}

v3

2022.1

DCM.E接続を取得します。

45

Insights

GET /admin/v2/insights

v2

11.3

Gallery内のインサイトを検索

46

Insights

GET /admin/v1/insights

v1

9.1

Gallery内のインサイトを検索

47

Jobs

GET /v3/jobs/{jobId}/messages

v3

2024.2

Retrieve messages of a specific job.

48

ジョブ

GET /v3/jobs/{jobId}

v3

2022.3

2022.3

既存のジョブとその現在の状態に関する詳細を取得します。

49

ジョブ

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

注記

ワークフローが資格情報を使用して公開されている場合は、共有資格情報をAPIコールで明確に適用する必要があります。

v2

11.3

11.3

新しいジョブを作成し、ジョブ実行キューに追加

50

ジョブ

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

v1

9.1

9.1

指定されたジョブの出力を取得

51

ジョブ

GET /v1/jobs/{id}

v1

9.1

9.1

ジョブおよびそのジョブの現在の状態を取得

52

ジョブ

GET /v1/workflows/{appId}/jobs

v1

9.1

9.1

指定されたAlteryx Analyticsアプリのジョブを返す

53

ジョブ

POST /v1/workflows/{appId}/jobs

注記

ワークフローの実行に資格情報が必要な場合はPOST /user/v2/workflows/{appId}/jobsを使用します。

v1

9.1

9.1

指定されたワークフローのジョブ実行を、提供された回答とともにキューに入れる

54

ジョブ

GET /admin/v1/workflows/jobs

v1

9.1

最後に実行されたジョブと、そのジョブのワークフローの現在の状態を返す

55

スケジュール

DELETE /v3/schedules/{scheduleId}

v3

2021.4

既存のスケジュールを削除します。

56

スケジュール

GET /v3/schedules/{scheduleId}

v3

2021.4

既存のスケジュールに関する詳細を取得します。

57

スケジュール

PUT /v3/schedules/{scheduleId}

v3

2021.4

既存のスケジュールの詳細を更新します。

58

スケジュール

GET /v3/schedules

v3

2021.4

アクセス可能なすべてのスケジュールのレコードを取得します。

59

スケジュール

POST /v3/schedules

v3

2021.4

新しいスケジュールを作成します。

60

Schedules

PATCH /v3/schedules/{scheduleId}

v3

2024.2

2024.2

Make partial updates to details of an existing schedule.

61

スケジュール

GET /admin/v2/schedule/forecast

v2

11.3

指定された期間の今後の実行ジョブをすべて予測

62

スケジュール

GET /admin/v1/schedules

v1

9.1

Gallery内のスケジュールを検索

63

Server接続

GET /v3/serverDataConnections

v3

2021.4

アクセス可能なすべてのServerデータ接続レコードを取得します。

64

Server接続

DELETE /v3/serverDataConnections/{dataConnectionId}

v3

2021.4

既存のServerデータ接続を削除します。

65

Server接続

GET /v3/serverDataConnections/{dataConnectionId}

v3

2021.4

既存のServerデータ接続の詳細を取得します。

66

Server接続

PUT /v3/serverDataConnections/{dataConnectionId}

v3

2021.4

既存のServerデータ接続の接続名を更新します。

67

Server接続

POST /v3/serverDataConnections/{dataConnectionId}/users

v3

2021.4

既存のServerデータ接続を既存のユーザーと共有します。

68

Server接続

POST /v3/serverDataConnections/{dataConnectionId}/userGroups

v3

2021.4

既存のServerデータ接続を既存のユーザーグループと共有します。

69

Server接続

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

v3

2021.4

ユーザーの権限を削除して、既存のServerデータ接続を使用できるようにします。

70

Server接続

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

v3

2021.4

ユーザーグループの権限を削除して、既存のServerデータ接続を使用できるようにします。

71

Server接続

GET /admin/v1/serverdataconnections

v1

9.1

プライベートGalleryで作成されたデータ接続を返す

72

Subscriptions

POST /v3/subscriptions

v3

2024.2

Create a new subscription.

73

Subscriptions

GET /v3/subscriptions

v3

2024.2

Retrieve details about all subscriptions.

74

Subscriptions

GET /v3/subscriptions/{subscriptionId}

v3

2024.2

Search for a specific subscription.

75

Subscriptions

PUT /v3/subscription/{subscriptionId}

v3

2024.2

Update an existing subscription.

76

Subscriptions

DELETE /v3/subscriptions

v3

2024.2

Delete a specific subscription.

77

Subscriptions

PUT /v3/subscriptions/{subscriptionId}/users

v3

2024.2

Change a user’s subscription.

78

Subscriptions

GET /admin/v2/subscriptions

v2

11.3

Gallery内のサブスクリプションを検索

79

Subscriptions

GET /admin/v1/subscriptions

v1

9.1

Gallery内のサブスクリプションを検索

80

システムエイリアス

GET /admin/v1/systemdataconnections

v1

9.1

Alteryx Serverがインストールされているサーバー上に作成されたシステムデータ接続を返す

81

ユーザーグループ

GET /v3/usergroups

v3

2021.4

アクセス可能なすべてのユーザーグループのレコードを取得します。

82

ユーザーグループ

POST /v3/usergroups

v3

2021.4

新しいユーザーグループを作成します。

83

ユーザーグループ

DELETE /v3/usergroups/{userGroupId}

v3

2021.4

既存のユーザーグループを削除します。

84

ユーザーグループ

GET /v3/usergroups/{userGroupId}

v3

2021.4

既存のユーザーグループの詳細を取得します。

85

ユーザーグループ

PUT /v3/usergroups/{userGroupId}

v3

2021.4

既存のユーザーグループの名前とロールの両方または一方を更新します。

86

ユーザーグループ

POST /v3/usergroups/{userGroupId}/users

v3

2021.4

1人または複数の既存のユーザーを既存のユーザーグループに追加します。

87

ユーザーグループ

POST /v3/usergroups/{userGroupId}/activedirectorygroups

v3

2023.1

Active Directoryのグループを既存のユーザーグループに追加します。

88

ユーザーグループ

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

v3

2021.4

ユーザーを既存のユーザーグループから削除します。

89

ユーザーグループ

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

v3

2023.1

既存のユーザーグループからActive Directoryのグループを削除します。

90

ユーザー

DELETE /v3/users/{userId}

v3

2021.4

既存のユーザーを削除します。

91

ユーザー

GET /v3/users/{userId}

v3

2021.4

既存のユーザーが所有するすべてのアクセス可能なアセットを取得します。

92

ユーザー

GET /v3/users/{userId}/assets

v3

2021.4

ユーザーが所有する全アセット一覧を取得します。

93

ユーザー

GET /v3/users

v3

2021.4

アクセス可能なすべてのユーザーレコードを取得します。

94

ユーザー

POST /v3/users

v3

2021.4

新しいユーザーを作成します。

95

ユーザー

POST /v3/users/{userId}/deactivate

v3

2021.4

既存のユーザーを休止中として更新します。

96

ユーザー

POST /v3/users/{userId}/passwordReset

v3

2021.4

既存のユーザーにパスワードのリセット用のEメールを送信します。

97

ユーザー

PUT /v3/users/{userId}

v3

2021.4

既存のユーザーの詳細を更新します。

98

ユーザー

PUT /v3/users/{userId}/assetTransfer

v3

2024.1

あるユーザーが所有するアセット(ワークフロー、スケジュール、コレクション)の一部またはすべてを別のユーザーに移転します。

99

ユーザー

GET /admin/v2/users

v2

11.3

Gallery内のユーザーを検索

100

ユーザー

GET /admin/v1/users

v1

9.1

Gallery内のユーザーを検索

101

ワークフロー

GET /v3/workflows/{workflowId}

v3

2021.4

既存のワークフローに関する詳細を取得します。

102

ワークフロー

GET /v3/workflows/{workflowId}/package

v3

2022.3

2022.3

既存のワークフローパッケージのコピーをダウンロードします。

103

ワークフロー

GET /v3/workflows/{workflowId}/questions

v3

2022.3

2022.3

分析アプリの質問情報を取得します。

104

ワークフロー

GET /v3/workflows/{workflowId}/jobs

v3

2022.3

2022.3

既存のワークフローのジョブのリストを取得します。

105

ワークフロー

GET /v3/workflows

v3

2021.4

2022.3

アクセス可能なすべてのワークフローレコードを取得します。

106

ワークフロー

POST /v3/workflows

v3

2021.4

2022.3

新しいワークフローパッケージをアップロードします。

107

ワークフロー

DELETE /v3/workflows/{workflowId}

v3

2021.4

既存のワークフローを削除します。

108

ワークフロー

PUT /v3/workflows/{workflowId}

v3

2021.4

既存のワークフローの詳細を更新します。

109

ワークフロー

POST /v3/workflows/{workflowId}/versions

v3

2023.1

2023.1

既存のワークフローの新しいバージョンをアップロードします。

110

ワークフロー

POST /v3/workflows/{workflowId}/jobs

v3

2023.2

2023.2

新しいジョブを作成し、ジョブ実行キューに追加します。

111

ワークフロー

PUT /v3/workflows/{workflowId}/transfer

v3

2024.1

特定のワークフローを特定の所有者に移転します(必要に応じてスケジュールと一緒に)。

112

ワークフロー

POST /user/v2/inputfiles

v2

2020.3

2020.3

後続のワークフロー実行で使用する一時ファイルをパブリッシュしました

113

ワークフロー

GET /admin/v2/workflows/all

v2

11.3

オプションにより日付でフィルタリングした、すべてのワークフローを返す

114

ワークフロー

GET /v1/workflows/{appId}/package

v1

9.1

9.1

要求されたアプリケーションを返す

115

ワークフロー

GET /v1/workflows/{appId}/questions

v1

9.1

9.1

指定されたAlteryx Analyticsアプリに関する質問を取得

116

ワークフロー

GET /v1/workflows/subscription

v1

9.1

9.1

サブスクリプション内のワークフローを検索

117

ワークフロー

GET /admin/v1/{appId}/package

v1

9.1

要求されたアプリケーションを返す

118

ワークフロー

GET /admin/v1/workflows/migratable

v1

9.1

移行準備完了としてマークされているGallery内のワークフローを検索

119

ワークフロー

GET /admin/v1/workflows/all

v1

9.1

オプションにより日付でフィルタリングした、すべてのワークフローを返す

120

ワークフロー

GET /admin/v1/workflows

v1

9.1

Gallery内のワークフローを検索

121

ワークフロー

POST /admin/v1/workflows

v1

9.1

YXZPをシステムに公開

122

ワークフロー

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

v1

9.1

アプリの移行準備完了フラグを更新します。

このセクションの内容: