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 に対応しました。
Web API アドレスは、OAuth 2 を使用する V1、V2、V3 に対してのみ設定できます。OAuth 1 を使用した V1、V2 の API ドキュメントの場合、アドレスは http://{ServerHostname}/gallery/api-docs/となります。
Server API リファレンスドキュメントの利用
すべてのServer APIエンドポイントに関する完全なリファレンスドキュメントは、Swaggerで提供されています。
Server UIには、Server APIリファレンスドキュメントにアクセスできる場所が2か所あります。
上部ツールバーの疑問符アイコンを選択し、 [ API ドキュメント] を選択します。
Server APIのAPIリファレンスドキュメントは、URL:
http(s)://serverhostname.domain/webapi/swaggerを使用してアクセスすることもできます。サーバーのホスト名は、ご自身のServerインスタンスのURLです。
Server API リファレンスドキュメントへの認証
Server API のドキュメントは、パラメーターを入力してレスポンスを確認することができるインタラクティブなものとなっています。このインタラクティブな機能を使用するには、認証を行う必要があります。これを行うには、次の手順を実行します。
Server UIでユーザー名を選択し、[マイプロフィール] > [キー]を選択します。認証したいAPIのAPIキーをコピーし、[APIキー]フィールドと[Shared Secret] (共有暗号鍵)フィールドに貼り付けます。キーは [ Saved] (保存済み) と表示されます。
実行したい呼び出しを選択し、パラメーターを入力して、[試してみる] を選択します。
API キーと API アクセス
管理者 (Server 管理者) は、ユーザーに API へのアクセスを許可する必要があります。詳細については、「Server API へのユーザーアクセスを許可」を参照してください。API へのユーザーアクセスを許可すると、ユーザーは [ マイプロフィール ] ページの [ キー ] タブで API キーを見つけることができるようになります。APIキーにアクセスするには、ユーザー名を選択し、[マイプロフィール] > [キー]を選択します。
管理者ロールを有するユーザーは、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 (ワークフロー)
コレクション
資格情報
サブスクリプション
ユーザー
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: 更新後に更新されたプロパティの値。
API経由で ファイル参照ツール を使用するワークフローを実行するには、/user/v2/inputfilesエンドポイントを使用してファイルをアップロードします。
まず、
/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'次に、
/user/v2/workflows/{appId}/jobs/エンドポイントにPOSTを行います 。その後、質問オブジェクトにファイル参照ツールの
nameを含めます。ファイル参照ツールの名前がわからない場合は、/v1/workflows/{appId}/questionsエンドポイントを使用してファイル参照ツールの名前を取得します。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を指定しない場合、移行準備完了としてマークされたすべてのワークフローが返されます。この戻り値には、appId、現在公開されているrevisionId、 ワークフローが属するsubscriptionIDの3つのプロパティが含まれます。
ステップ 2.移行元環境からワークフローをダウンロードする
次のエンドポイントは、ワークフローをYXZPファイルとしてダウンロードします。
環境: 移行元
方法: GET
エンドポイント:
api/admin/v1/{appID}/package/
パスパラメーターとしてappIDを含めます。ワークフロー全体をパッケージとしたダウンロードが返されます。
ステップ 3.移行先の環境でワークフローを公開する
以下のエンドポイントは、ダウンロードしたワークフローを移行先の環境に公開します。
環境: 移行先
方法: POST
エンドポイント:
api/admin/v1/workflows/
パラメーター | |||
|---|---|---|---|
パラメーター | 説明 | 型 | 必須 |
| 新しいワークフローのファイル名です。 | 文字列 | True |
| 新しいワークフロー名です。 | 文字列 | True |
| 移行されたワークフローの所有者です。E メールアドレスは、移行先の環境に存在している必要があります。 | 文字列 | True |
| 移行先の環境への移行時にワークフローを検証するためのフラグです。 | ブール値 | True |
| ワークフローを公開に設定し、移行先の環境で「自社の Gallery」に表示させるためのフラグです。 | ブール値 | True |
| 移行予定のワークフローの、移行元環境のappIdです。同じsourceIdを持つワークフローが存在する場合、移行先の環境でそのワークフローを置き換えます。それ以外の場合は、新しいワークフローが生成されます。 (appIDを指定しない場合は、空の文字列を送信します。) | 文字列 | True |
| ワークフローにワーカータグを追加し、特定のワーカーがワークフローを実行するようにします。 (ワーカーを指定しない場合は、空の文字列を送信します。) | 文字列 | True |
| 移行先の環境の他のユーザーがワークフローをダウンロードできるように設定するフラグです。 | ブール値 | True |
(オプション) ステップ 4.移行元の環境で移行設定のワークフローをリセットする
必要に応じて、 migratableエンドポイントを使用し、移行先の環境でワークフローを移行した後に、移行先の環境におけるワークフローの [このワークフローを移行対象にする] 設定を [いいえ] に戻すことができます。
環境: 移行元
方法: 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 | 資格情報 | POST /v3/credentials | v3 | 2024.1 | 資格情報を作成します。 | |
28 | 資格情報 | PUT /v3/credentials/{credentialId} | v3 | 2024.1 | 資格情報を更新します。 | |
29 | 資格情報 | GET /user/v2/credentials | v2 | 11.3 | ユーザーと直接、またはサブ経由で共有されている資格情報を検索 | |
30 | DCME | DELETE /v3/dcm/connections/{id} | v3 | 2023.2 | 2023.2 | DCM接続を削除します。 |
33 | DCME | GET /v3/dcm/connections/{id} | v3 | 2023.2 | 2023.2 | DCM接続レコードを取得します。 |
32 | DCME | GET /v3/dcm/connections/lookup | v3 | 2023.2 | 2023.2 | ワークフローで参照されているDCM接続を取得します。 |
33 | DCME | DELETE /v3/dcm/connections/{id}/sharing/execution | v3 | 2023.2 | 2023.2 | DCM接続の共有を解除します。 |
34 | DCME | PUT /v3/dcm/connections/{id}/sharing/execution | v3 | 2023.2 | 2023.2 | 指定したユーザーおよびグループとDCM接続を共有します。 |
35 | DCME | POST /v3/dcm/connections | v3 | 2023.2 | 2023.2 | DCM接続を作成または更新します。 |
36 | DCMEAdmin | DELETE /v3/dcm/admin/connections/{objectId} | v3 | 2023.2 | DCM接続を削除します。 | |
37 | DCMEAdmin | GET /v3/dcm/admin/connections/{objectId} | v3 | 2023.2 | DCM接続レコードを取得します。 | |
38 | DCMEAdmin | GET /v3/dcm/admin/connections | v3 | 2023.2 | DCM接続レコードのリストを取得します。 | |
39 | DCMEAdmin | POST /v3/dcm/admin/connections | v3 | 2023.2 | ユーザーの代わりにDCM接続を作成または更新します。 | |
40 | DCMEAdmin | DELETE /v3/dcm/admin/connections/{objectId}/sharing/execution | v3 | 2023.2 | 実行用に共有されているDCM接続の共有を解除します。 | |
41 | DCMEAdmin | DELETE /v3/dcm/admin/connections/{objectId}/sharing/collaboration | v3 | 2023.2 | コラボレーション用に共有されているDCM接続の共有を解除します。 | |
42 | DCMEAdmin | GET /v3/dcm/admin/connectionhandlingrules | v3 | 2024.1 | すべてのDCM接続処理ルールを取得します。 | |
43 | DCMEAdmin | GET /v3/dcm/admin/connectionhandlingrules/{id} | v3 | 2024.1 | 特定のDCM接続処理ルールを1つ取得します。 | |
44 | DCMEAdmin | POST /v3/dcm/admin/connectionhandlingrules | v3 | 2024.1 | DCM接続処理ルールを追加または更新します。 | |
46 | DCMEAdmin | DELETE /v3/dcm/admin/connectionhandlingrules/{id} | v3 | 2024.1 | 既存のDCM接続処理ルールを削除します。 | |
46 | DCMEConnections | GET /v3/DCMEConnections/{connectionId} | v3 | 2022.1 | DCM.E接続を取得します。 | |
47 | Insights | GET /admin/v2/insights | v2 | 11.3 | Gallery内のインサイトを検索 | |
48 | Insights | GET /admin/v1/insights | v1 | 9.1 | Gallery内のインサイトを検索 | |
49 | ジョブ | GET /v3/jobs/{jobId}/messages | v3 | 2024.2 | 特定のジョブのメッセージを取得します。 | |
50 | ジョブ | GET /v3/jobs/{jobId} | v3 | 2022.3 | 2022.3 | 既存のジョブとそのジョブの現在の状態について詳細を取得します。 |
51 | ジョブ | DELETE /v3/jobs/{jobId} | v3 | 2025.1 | 2025.1 | 特定のジョブをキャンセルします。 |
52 | ジョブ | POST /user/v2/workflows/{appId}/jobs 注: ワークフローが資格情報を使用して公開されている場合は、共有資格情報をAPI呼び出しで明確に適用する必要があります。 | v2 | 11.3 | 11.3 | 新しいジョブを作成し、ジョブ実行キューに追加します。 |
53 | ジョブ | GET /v1/jobs/{id}/output/{outputId} | v1 | 9.1 | 9.1 | 指定されたジョブの出力を取得します。 |
54 | ジョブ | GET /v1/jobs/{id} | v1 | 9.1 | 9.1 | ジョブおよびそのジョブの現在の状態を取得 |
55 | ジョブ | GET /v1/workflows/{appId}/jobs | v1 | 9.1 | 9.1 | 指定されたAlteryx Analyticsアプリのジョブを返す |
56 | ジョブ | POST /v1/workflows/{appId}/jobs 注: ワークフローの実行に資格情報が必要な場合はPOST /user/v2/workflows/{appId}/jobsを使用します。 | v1 | 9.1 | 9.1 | 指定されたワークフローのジョブ実行を、提供された回答とともにキューに入れる |
57 | ジョブ | GET /admin/v1/workflows/jobs | v1 | 9.1 | 最後に実行されたジョブと、そのジョブのワークフローの現在の状態を返す | |
58 | スケジュール | DELETE /v3/schedules/{scheduleId} | v3 | 2021.4 | 既存のスケジュールを削除します。 | |
59 | スケジュール | GET /v3/schedules/{scheduleId} | v3 | 2021.4 | 既存のスケジュールの詳細を取得します。 | |
60 | スケジュール | PUT /v3/schedules/{scheduleId} | v3 | 2021.4 | 既存のスケジュールの詳細を更新します。 | |
61 | スケジュール | GET /v3/schedules | v3 | 2021.4 | アクセス可能なすべてのスケジュールレコードを取得します。 | |
62 | スケジュール | POST /v3/schedules | v3 | 2021.4 | 新しいスケジュールを作成します。 | |
63 | スケジュール | PATCH /v3/schedules/{scheduleId} | v3 | 2024.2 | 2024.2 | 既存スケジュールの詳細の一部を更新します。 |
64 | スケジュール | GET /admin/v2/schedule/forecast | v2 | 11.3 | 指定された期間の今後の実行ジョブをすべて予測 | |
65 | スケジュール | GET /admin/v1/schedules | v1 | 9.1 | Gallery内のスケジュールを検索 | |
66 | Server接続 | GET /v3/serverDataConnections | v3 | 2021.4 | アクセス可能なすべてのServerデータ接続レコードを取得します。 | |
67 | Server接続 | DELETE /v3/serverDataConnections/{dataConnectionId} | v3 | 2021.4 | 既存のServerデータ接続を削除します。 | |
68 | Server接続 | GET /v3/serverDataConnections/{dataConnectionId} | v3 | 2021.4 | 既存のServerデータ接続の詳細を取得します。 | |
69 | Server接続 | PUT /v3/serverDataConnections/{dataConnectionId} | v3 | 2021.4 | 既存のServerデータ接続の接続名を更新します。 | |
70 | Server接続 | POST /v3/serverDataConnections/{dataConnectionId}/users | v3 | 2021.4 | 既存のServerデータ接続を既存のユーザーと共有します。 | |
71 | Server接続 | POST /v3/serverDataConnections/{dataConnectionId}/userGroups | v3 | 2021.4 | 既存のServerデータ接続を既存のユーザーグループと共有します。 | |
72 | Server接続 | DELETE /v3/serverDataConnections/{dataConnectionId}/users/{userId} | v3 | 2021.4 | 既存のServerデータ接続を使用するユーザーの権限を削除します。 | |
73 | Server接続 | DELETE /v3/serverDataConnections/{dataConnectionId}/userGroups/{userGroupId} | v3 | 2021.4 | 既存のServerデータ接続を使用するユーザーグループの権限を削除します。 | |
74 | Server接続 | GET /admin/v1/serverdataconnections | v1 | 9.1 | プライベートGalleryで作成されたデータ接続を返す | |
75 | Server使用状況 | GET /v3/usage | v3 | 2025.1 | すべてのServer使用(実行)状況に関する詳細を取得します。 | |
76 | Server使用状況 | POST /v3/usage | v3 | 2025.1 | 返された応答ファイルをAACにアップロードします。 | |
77 | サブスクリプション | POST /v3/subscriptions | v3 | 2024.2 | 新しいサブスクリプションを作成します。 | |
78 | サブスクリプション | GET /v3/subscriptions | v3 | 2024.2 | すべてのサブスクリプションに関する詳細を取得します。 | |
79 | サブスクリプション | GET /v3/subscriptions/{subscriptionId} | v3 | 2024.2 | 特定のサブスクリプションを検索します。 | |
80 | サブスクリプション | PUT /v3/subscription/{subscriptionId} | v3 | 2024.2 | 既存のサブスクリプションを更新します。 | |
81 | サブスクリプション | DELETE /v3/subscriptions | v3 | 2024.2 | 特定のサブスクリプションを削除します。 | |
82 | サブスクリプション | PUT /v3/subscriptions/{subscriptionId}/users | v3 | 2024.2 | ユーザーのサブスクリプションを変更します。 | |
83 | サブスクリプション | GET /admin/v2/subscriptions | v2 | 11.3 | Gallery内のサブスクリプションを検索 | |
84 | サブスクリプション | GET /admin/v1/subscriptions | v1 | 9.1 | Gallery内のサブスクリプションを検索 | |
85 | システムエイリアス | GET /admin/v1/systemdataconnections | v1 | 9.1 | Alteryx Serverがインストールされているサーバー上に作成されたシステムデータ接続を返す | |
86 | ユーザーグループ | GET /v3/usergroups | v3 | 2021.4 | アクセス可能なすべてのユーザーグループレコードを取得します。 | |
87 | ユーザーグループ | POST /v3/usergroups | v3 | 2021.4 | 新しいユーザーグループを作成します。 | |
88 | ユーザーグループ | DELETE /v3/usergroups/{userGroupId} | v3 | 2021.4 | 既存のユーザーグループを削除します。 | |
89 | ユーザーグループ | GET /v3/usergroups/{userGroupId} | v3 | 2021.4 | 既存のユーザーグループの詳細を取得します。 | |
90 | ユーザーグループ | PUT /v3/usergroups/{userGroupId} | v3 | 2021.4 | 既存のユーザーグループの名前やロールを更新します。 | |
91 | ユーザーグループ | POST /v3/usergroups/{userGroupId}/users | v3 | 2021.4 | 1人または複数の既存ユーザーを既存のユーザーグループに追加します。 | |
92 | ユーザーグループ | POST /v3/usergroups/{userGroupId}/activedirectorygroups | v3 | 2023.1 | Active Directoryグループを既存のユーザーグループに追加します。 | |
93 | ユーザーグループ | DELETE /v3/usergroups/{userGroupId}/users/{userId} | v3 | 2021.4 | ユーザーを既存のユーザーグループから削除します。 | |
94 | ユーザーグループ | DELETE /v3/usergroups/{userGroupId}/activedirectorygroups/{adGroupSid}activedirectorygroups/{adGroupSid} | v3 | 2023.1 | Active Directoryグループを既存のユーザーグループから削除します。 | |
95 | ユーザー | DELETE /v3/users/{userId} | v3 | 2021.4 | 既存のユーザーを削除します。 | |
96 | ユーザー | GET /v3/users/{userId} | v3 | 2021.4 | 既存のユーザーが所有するアクセス可能なすべてのアセットを取得します。 | |
97 | ユーザー | GET /v3/users/{userId}/assets | v3 | 2021.4 | ユーザーが所有する全アセット一覧を取得します。 | |
98 | ユーザー | GET /v3/users | v3 | 2021.4 | アクセス可能なすべてのユーザーレコードを取得します。 | |
99 | ユーザー | POST /v3/users | v3 | 2021.4 | 新しいユーザーを作成します。 | |
100 | ユーザー | POST /v3/users/{userId}/deactivate | v3 | 2021.4 | 既存のユーザーを休止中として更新します。 | |
101 | ユーザー | POST /v3/users/{userId}/passwordReset | v3 | 2021.4 | 既存のユーザーにパスワードリセット用のEメールを送信します。 | |
102 | ユーザー | PUT /v3/users/{userId} | v3 | 2021.4 | 既存のユーザーの詳細を更新します。 | |
103 | ユーザー | PUT /v3/users/{userId}/assetTransfer | v3 | 2024.1 | あるユーザーが所有するアセット(ワークフロー、スケジュール、コレクション)の一部またはすべてを別のユーザーに移転します。 | |
104 | ユーザー | GET /admin/v2/users | v2 | 11.3 | Gallery内のユーザーを検索します。 | |
105 | ユーザー | GET /admin/v1/users | v1 | 9.1 | Gallery内のユーザーを検索します。 | |
106 | ワークフロー | GET /v3/workflows/{workflowId} | v3 | 2021.4 | 既存のワークフローの詳細を取得します。 | |
107 | ワークフロー | GET /v3/workflows/{workflowId}/package | v3 | 2022.3 | 2022.3 | 既存のワークフローパッケージのコピーをダウンロードします。 |
108 | ワークフロー | GET /v3/workflows/{workflowId}/questions | v3 | 2022.3 | 2022.3 | 分析アプリの質問情報を取得します。 |
109 | ワークフロー | GET /v3/workflows/{workflowId}/jobs | v3 | 2022.3 | 2022.3 | 既存のワークフローのジョブリストを取得します。 |
110 | ワークフロー | GET /v3/workflows | v3 | 2021.4 | 2022.3 | アクセス可能なすべてのワークフローレコードを取得します。 |
111 | ワークフロー | POST /v3/workflows | v3 | 2021.4 | 2022.3 | 新しいワークフローパッケージをアップロードします。 |
112 | ワークフロー | DELETE /v3/workflows/{workflowId} | v3 | 2021.4 | 既存のワークフローを削除します。 | |
113 | ワークフロー | PUT /v3/workflows/{workflowId} | v3 | 2021.4 | 既存のワークフローの詳細を更新します。 | |
114 | ワークフロー | POST /v3/workflows/{workflowId}/versions | v3 | 2023.1 | 2023.1 | 既存のワークフローの新しいバージョンをアップロードします。 |
115 | ワークフロー | POST /v3/workflows/{workflowId}/jobs | v3 | 2023.2 | 2023.2 | 新しいジョブを作成し、ジョブ実行キューに追加します。 |
116 | ワークフロー | PUT /v3/workflows/{workflowId}/transfer | v3 | 2024.1 | 特定のワークフローを特定の所有者に移転します(必要に応じてスケジュールと一緒に)。 | |
117 | ワークフロー | POST /user/v2/inputfiles | v2 | 2020.3 | 2020.3 | 後続のワークフロー実行で使用する一時ファイルをパブリッシュしました |
118 | ワークフロー | GET /admin/v2/workflows/all | v2 | 11.3 | オプションにより日付でフィルタリングした、すべてのワークフローを返します。 | |
119 | ワークフロー | GET /v1/workflows/{appId}/package | v1 | 9.1 | 9.1 | 要求されたアプリケーションを返します。 |
120 | ワークフロー | GET /v1/workflows/{appId}/questions | v1 | 9.1 | 9.1 | 指定されたAlteryx Analyticsアプリに関する質問を取得します。 |
121 | ワークフロー | GET /v1/workflows/subscription | v1 | 9.1 | 9.1 | サブスクリプション内のワークフローを検索します。 |
122 | ワークフロー | GET /admin/v1/{appId}/package | v1 | 9.1 | 要求されたアプリケーションを返します。 | |
123 | ワークフロー | GET /admin/v1/workflows/migratable | v1 | 9.1 | 移行準備完了としてマークされているGallery内のワークフローを検索します。 | |
124 | ワークフロー | GET /admin/v1/workflows/all | v1 | 9.1 | オプションにより日付でフィルタリングした、すべてのワークフローを返します。 | |
125 | ワークフロー | GET /admin/v1/workflows | v1 | 9.1 | Gallery内のワークフローを検索します。 | |
126 | ワークフロー | POST /admin/v1/workflows | v1 | 9.1 | YXZPをシステムに公開します。 | |
127 | ワークフロー | PUT /admin/v1/workflows/migratable/{appId} | v1 | 9.1 | アプリの移行準備完了フラグを更新します。 |