mablリソースID

mabl APIまたはmabl CLIで使用するmablリソースIDの取得方法

アプリケーションや環境から、テストのアドホック実行に至るまで、ワークスペースの全てのコンポーネントには、mablリソースIDという一意のIDがあります。mablリソースIDは、mabl CLIの多くのコマンドや、mabl APIエンドポイントのパラメーターとして必要です。

このガイドでは、mablリソースIDを持つコンポーネントタイプを列挙し、mabl CLI、mablアプリケーション、WebhookペイロードからmablリソースIDを取得する方法について説明します。

コンポーネントタイプ

mablリソースIDは、英数字の文字列と、コンポーネントの種類を表す接尾辞で構成されます。たとえば、ワークスペースのIDは1234567890AbCdE-wのようになっています。

次のリストは、mablリソースIDを持つコンポーネントの種類と、そのコンポーネントごとの接尾辞です。

ワークスペース: -w
アプリケーション: -a
環境: -e
プラン: -p
テスト: -j
デプロイイベント: -v
プラン実行: -pr
テスト実行: -jr
DataTable: -vt
DataTable シナリオ: -vr

* User ID には接尾辞はつきません

mabl CLI で取得する

mabl CLIでは、listコマンドでほとんどのコンポーネントのIDを取得できます。

mabl workspaces list
mabl applications list
mabl environments list
mabl plans list
mabl tests list
mabl datatables list
mabl branches list
mabl deployments list
mabl users list

* listコマンドはコンポーネントタイプのID、名前、作成日時を返します。

DataTableシナリオのIDを取得するには、以下のコマンドを実行します。

mabl datatables scenarios <datatable-id>

次の例の場合、mabl applications list コマンドは、アプリケーションのID、名前、作成日時のテーブルを返します。

┌──────────────────────────┬─────────────────────────────────┬─────────────────────────┐
│ ID                       │ Name                            │ Created time            │
├──────────────────────────┼─────────────────────────────────┼─────────────────────────┤
│ <application-id>         │ Marketing Site | FreshBooks.com │ Oct 29th 2019, 22:06:55 │
├──────────────────────────┼─────────────────────────────────┼─────────────────────────┤
│ <application-id>         │ FreshBooks App                  │ Mar 19th 2020, 14:15:01 │
├──────────────────────────┼─────────────────────────────────┼─────────────────────────┤
│ <application-id>         │ mabl Sandbox                    │ Mar 23rd 2020, 17:57:23 │
├──────────────────────────┼─────────────────────────────────┼─────────────────────────┤
│ <application-id>         │ Sandbox                         │ Jun 16th 2022, 01:28:37 │
└──────────────────────────┴─────────────────────────────────┴─────────────────────────┘

📘
オプションの引数
listコマンドの最後に--helpフラグをつけると、このコマンドで利用可能なオプションが表示されます。
たとえば、mabl environments list –helpと入力すると、環境の一覧を表示するのに使用できるオプションが表示されます。

--workspace-id: 複数のワークスペースに属している場合、特定のワークスペースの環境の一覧を表示します。

--limit: 返す環境の数を指定します。デフォルトは10です。

--output: コマンドの実行結果の表示形式を指定します。table、json、yamlのいずれかを指定できます。

mablアプリケーション内で取得

mablアプリケーションでは、コンポーネントごとに異なるページでmablリソースIDを取得できます。

ワークスペース

ワークスペースIDを取得するには、[ワークスペース] > [ワークスペース] に移動します。ワークスペースIDの接尾辞は-wです。

アプリケーションと環境

[ワークスペース] > [API] に移動し、[mabl CLI] セクションまでスクロールします。アプリケーション、環境、またはその両方をドロップダウンから選択します。mabl CLIコマンドにアプリケーションIDと環境IDが表示されます。アプリケーションIDの接尾辞は-a、環境IDの接尾辞は-eです。