Embedded API - タグの割り当て
このエンドポイントを使用して、顧客ワークスペース内のアセットにタグを適用したり、アセットからタグを削除したりします。
タグAPI
タグをプログラムで作成、取得、更新、および削除するには、Environment管理APIドキュメントを参照してください。
レート制限
タグ割り当てリソースには、次のレート制限があります:
| タイプ | リソース | クォータ |
|---|---|---|
| すべて | すべてのタグ割り当てエンドポイント | 1分あたり1,000リクエスト |
クイックリファレンス
| タイプ | リソース | 説明 |
|---|---|---|
| POST | /api/v2/managed_users/:managed_user_id/tags_assignments | 顧客ワークスペース内のアセットにタグを適用するか、アセットからタグを削除します。 |
タグ割り当ての管理
顧客ワークスペース内のアセットにタグを適用するか、アセットからタグを削除します。このエンドポイントでタグを付けられるのは、レシピとコネクションのみです。これらのアセットに1つ以上のタグを割り当てるか、既存のタグを削除できます。
POST https://YOUR_DATA_CENTER/api/v2/managed_users/:managed_user_id/tags_assignmentsURLパラメータ
| 名前 | タイプ | 説明 |
|---|---|---|
| managed_user_id | string 必須 | Embedded顧客ID/外部ID。 External IDはURLエンコードし、先頭にEを付ける必要があります(例: EA2300)。 |
ペイロード
| 名前 | タイプ | 説明 |
|---|---|---|
| add_tags | array of strings optional | 追加するタグハンドルの配列。例: tag-Abx8sFmg-NWx3Lb-CD。タグタイトルではなく、タグハンドルを使用します。各ハンドルは、指定したアセットに適用される既存のタグを表します。 |
| remove_tags | array of strings optional | 削除するタグハンドルの配列。各ハンドルは、指定されたアセットから削除するタグを表します。 |
| recipe_ids | 整数の配列 条件付き | タグ付けまたはタグ解除するレシピIDの配列。必須(connection_idsが指定されていない場合)。 |
| connection_ids | 整数の配列 条件付き | タグ付けまたはタグ解除するコネクションIDの配列。必須(recipe_idsが指定されていない場合)。 |
タグタイトルではなくタグハンドルを使用
このエンドポイントはタグハンドルのみを受け付け、タグは割り当てる前に存在している必要があります。既存のタグのハンドルは、List tags(GET /api/v2/managed_users/:managed_user_id/tags)エンドポイント、またはCreate a tag(POST /api/v2/managed_users/:managed_user_id/tags)で取得できます。handle はこのとき返される値です。
リクエスト内のadd_tagsまたはremove_tagsの値が既存のタグハンドルと一致しない場合、リクエストは200 OKを返しますがタグは適用されません。レスポンスにはエラーは含まれません。有効な値と認識されない値の両方を含むリクエストでは、有効なハンドルのみが適用され、無効な入力は無視されます。
タグは、カスタマーワークスペース内のすべてのEnvironmentで利用できます。タグの割り当ては、managed_user_id として渡したワークスペースIDを持つEnvironment内のレシピおよびコネクションにのみ適用されます。
タグを作成し、レシピに割り当てて結果を検証する一連の手順については、Create and assign a tagを参照してください。
サンプルリクエスト
このリクエストは、Workato内のコネクションとレシピにタグを追加します。
curl -X POST "https://YOUR_DATA_CENTER/api/v2/managed_users/:managed_user_id/tags_assignments" \
-H "Authorization: Bearer <api_token>" \
-H "Content-Type: application/json" \
-d '{
"add_tags": [":tag_handle"],
"recipe_ids": [:recipe_id],
"connection_ids": [:connection_id]
}'レスポンス
200 OKステータスは、Workatoがリクエストを受け付けたことを意味します。レスポンス本文ではコンテンツは返されません。
タグハンドルが認識されない場合でも、このエンドポイントは200 OKを返すため、200 OKステータスだけではタグが適用されたことは確認できません。アセットに割り当てられたタグを取得する例については、Create and assign a tagを参照してください。
タグの作成と割り当て
この例では、カスタマーワークスペースでタグを作成し、それをレシピに割り当てて、割り当てを確認します。コネクションにタグを付与するには、recipe_idsの代わりにconnection_idsを使用します。
POST /api/v2/managed_users/:managed_user_id/tags エンドポイントを使用してタグを作成します。 titleフィールドのみが必須フィールドです。
curl -X POST "https://YOUR_DATA_CENTER/api/v2/managed_users/:managed_user_id/tags" \
-H "Authorization: Bearer <api_token>" \
-H "Content-Type: application/json" \
-d '{
"title": "HR"
}'レスポンスからhandle値をコピーします。この例でのハンドルはtag-Abx8sFmg-NWx3Lb-CDです。この例ではリクエストでdescriptionを設定していないためdescriptionはnullであり、Workatoによってランダムなcolorが割り当てられます。
{
"data": {
"handle": "tag-Abx8sFmg-NWx3Lb-CD",
"title": "HR",
"description": null,
"color": "plum"
}
}前の手順で取得したハンドルをadd_tagsに指定してタグをレシピに割り当てます。タイトルHRではなくハンドルを使用します。
curl -X POST "https://YOUR_DATA_CENTER/api/v2/managed_users/:managed_user_id/tags_assignments" \
-H "Authorization: Bearer <api_token>" \
-H "Content-Type: application/json" \
-d '{
"add_tags": ["tag-Abx8sFmg-NWx3Lb-CD"],
"recipe_ids": [1234567]
}'List tags エンドポイントの q[recipe_id_eq] クエリパラメータを使用して、そのレシピに割り当てられているタグを一覧表示し、割り当てを検証します。割り当てが成功している場合、レスポンスにはそのタグが含まれます。
curl -X GET "https://YOUR_DATA_CENTER/api/v2/managed_users/:managed_user_id/tags?q[recipe_id_eq]=1234567" \
-H "Authorization: Bearer <api_token>"{
"data": {
"tags": [
{
"handle": "tag-Abx8sFmg-NWx3Lb-CD",
"title": "HR",
"description": null,
"color": "plum",
"created_at": "2026-10-14T09:11:17.344-07:00",
"updated_at": "2026-10-14T09:11:17.344-07:00"
}
]
}
}tags配列が空の場合、そのタグは適用されていないことを意味します。 add_tagsにタグタイトルではなくタグハンドルが含まれていることを確認します。
最終更新日: