タグ割り当て

このページは機械翻訳により提供されています。翻訳内容と英語版に相違がある場合は、英語版が優先されます。

このエンドポイントを使用して、ワークスペース内のアセットにタグを適用するか、アセットからタグを削除します。

タグAPI

タグをプログラムで作成、取得、更新、および削除するには、Environment管理APIドキュメントを参照してください。

レート制限

タグ割り当てリソースには、次のレート制限があります:

タイプリソース制限
すべてすべてのタグ割り当てエンドポイント1分あたり60リクエスト

クイックリファレンス

タイプリソース説明
POST/api/tags_assignmentsワークスペース内のアセットにタグを適用するか、アセットからタグを削除します。

タグ割り当ての管理

ワークスペース内のアセットにタグを適用するか、アセットからタグを削除します。 このエンドポイントを通じてタグ付けできるアセットには、レシピおよびコネクションが含まれます。 これらのアセットに1つ以上のタグを割り当てるか、既存のタグを削除できます。

shell
POST /api/tags_assignments

ペイロード

名前タイプ説明
add_tagsarray of strings
optional
追加するタグハンドルの配列。 各ハンドルは、指定されたアセットに適用するタグを表します。
remove_tagsarray of strings
optional
削除するタグハンドルの配列。 各ハンドルは、指定されたアセットから削除するタグを表します。
recipe_ids整数の配列
条件付き
タグ付けまたはタグ解除するレシピIDの配列。 必須connection_idsが指定されていない場合)。
connection_ids整数の配列
条件付き
タグ付けまたはタグ解除するコネクションIDの配列。 必須recipe_idsが指定されていない場合)。

LIST TAGSエンドポイントでタグハンドルを取得

適用または削除するタグのハンドルを取得するには、タグの一覧表示GET /api/tags)エンドポイントを使用します。

サンプルリクエスト

このリクエストは、ハンドルtag-ANgdXgTF-bANz3Hを持つ会計タグを、Workato内のコネクションとレシピの両方に追加します。

shell
curl  -X POST "https://www.workato.com/api/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: