タグ割り当て
このエンドポイントを使用して、顧客ワークスペース内のアセットにタグを適用したり、アセットからタグを削除したりします。
タグAPI
タグをプログラムで作成、取得、更新、および削除するには、Environment管理APIドキュメントを参照してください。
レート制限
タグ割り当てリソースには、次のレート制限があります:
| タイプ | リソース | 制限 |
|---|---|---|
| すべて | すべてのタグ割り当てエンドポイント | 1分あたり1,000リクエスト |
クイックリファレンス
| タイプ | リソース | 説明 |
|---|---|---|
| POST | /api/v2/managed_users/:id/tags_assignments | 顧客ワークスペース内のアセットにタグを適用するか、アセットからタグを削除します。 |
タグ割り当ての管理
顧客ワークスペース内のアセットにタグを適用するか、アセットからタグを削除します。 このエンドポイントを通じてタグ付けできるアセットには、レシピおよびコネクションが含まれます。 これらのアセットに1つ以上のタグを割り当てるか、既存のタグを削除できます。
shell
POST /api/v2/managed_users/:id/tags_assignmentsURLパラメーター
| 名前 | タイプ | 説明 |
|---|---|---|
| id | string 必須 | Embedded顧客ID/外部ID。 External IDはURLエンコードし、先頭にEを付ける必要があります(例: EA2300)。 |
ペイロード
| 名前 | タイプ | 説明 |
|---|---|---|
| add_tags | array of strings optional | 追加するタグハンドルの配列。 各ハンドルは、指定されたアセットに適用するタグを表します。 |
| remove_tags | array of strings optional | 削除するタグハンドルの配列。 各ハンドルは、指定されたアセットから削除するタグを表します。 |
| recipe_ids | 整数の配列 条件付き | タグ付けまたはタグ解除するレシピIDの配列。 必須(connection_idsが指定されていない場合)。 |
| connection_ids | 整数の配列 条件付き | タグ付けまたはタグ解除するコネクションIDの配列。 必須(recipe_idsが指定されていない場合)。 |
LIST TAGSエンドポイントでタグハンドルを取得
適用または削除する予定のタグのハンドルを取得するには、タグの一覧表示(GET /api/v2/managed_users/:id/tags)エンドポイントを使用します。
サンプルリクエスト
このリクエストは、ハンドルtag-ANgdXgTF-bANz3Hを持つ会計タグを、Workato内のコネクションとレシピの両方に追加します。
shell
curl -X POST "https://www.workato.com/api/v2/managed_users/19029/tags_assignments" \
-H "Authorization: Bearer <api_token>" \
-H "Content-Type: application/json" \
-d '{
"add_tags": ["tag-ANgdXgTF-bANz3H"],
"recipe_ids": [54525313],
"connection_ids": [1571346]
}'レスポンス
リクエストが200 OKステータスを返した場合、タグはアセットに正常に追加されたか、アセットから削除されています。 レスポンス本文ではコンテンツは返されません。
Last updated: