Product UpdatesStatus PageWorkato Academy
English
日本語
Get a trial
Developer API
リソース

Environment管理 ​

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

次のエンドポイントでは、外部シークレットマネージャーを操作するためのツールを提供し、活動監査ログレコードを通じてユーザーアクティビティを監視することで、Environmentを管理および保護できます。 ワークスペース内でタグを作成、取得、更新、削除することもできます。

レート制限 ​

Environment管理リソースには、次のレート制限があります:

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

クイックリファレンス ​

タイプリソース説明
POST/api/secrets_management/clear_cacheSecrets managementキャッシュをクリアします。
GET/api/activity_logs活動監査ログレコードを取得します。
GET/api/tagsタグのリストを取得します。
POST/api/tagsタグを作成します。
PUT/api/tags/:handleタグを更新します。
DELETE/api/tags/:handleタグを削除します。

シークレットキャッシュの動作 ​

Workatoはyour external secrets managerから取得した認証情報を60分間キャッシュします。 この期間中は、シークレットを更新またはローテーションしても、レシピはキャッシュされた値を引き続き使用します。

キャッシュの有効期限が切れると、次回のレシピ実行時にyour external secrets managerから最新の値が取得されます。 変更をすぐに適用するには、Secrets managementキャッシュをクリアエンドポイントを呼び出します。 これにより、コネクションを切断して再接続しなくても、Workatoで最新の認証情報を強制的に取得できます。

Secrets managementキャッシュのクリア ​

Secrets managementキャッシュをクリアして、外部シークレットマネージャーから利用可能な最新の認証情報を取得します。 更新された認証情報を有効にするために、コネクションを切断して再接続する必要はありません。

たとえば、外部シークレットマネージャーでシークレットを更新したときに、同時にWorkato APIにリクエストを送信してSecrets managementキャッシュをクリアできます。 これにより、必要なときにWorkatoが最新のシークレットを取得できます。 これにより、シークレットローテーションプロセスの一環としてシークレットが変更されるたびに、プログラムでシークレットをWorkatoと同期できます。

リクエストに本文は必要ありません。

shell
POST /api/secrets_management/clear_cache

サンプルリクエスト ​

shell
curl  -X POST "https://www.workato.com/api/secrets_management/clear_cache" \
      -H "Authorization: Bearer <api_token>"

サンプルレスポンス ​

json
{
  "success": true
}

活動監査ログの取得 ​

特定のEnvironment内のアクティビティに関する詳細情報を取得します。 クエリパラメーターを使用して、活動監査ログを、レシピやコネクションなどのリソースタイプ、またはレシピの作成や削除などのイベントタイプでフィルタリングできます。

サポートされているリソースタイプおよびイベントタイプの完全なリストについては、活動監査ログAPIリファレンスを参照してください。

shell
GET /api/activity_logs

レスポンスには、主に2つの要素が含まれます:

要素説明
dataログエントリを表すオブジェクトの配列。
total返されたログエントリの合計数。

data配列内の各ログエントリには、イベントの一意の識別子、タイムスタンプ、タイプに加えて、次のオブジェクトが含まれます:

オブジェクト説明
workspaceこのオブジェクトには、ワークスペースID、名前、メールアドレス、Environmentが含まれます。

DevelopmentEnvironmentでは、workspace.nameはワークスペース名に対応します。

テストおよびプロダクションEnvironmentでは、workspace.nameはそれぞれEnvironment TestまたはEnvironment Productionです。
userこのオブジェクトには、ユーザーID、名前、メールアドレスが含まれます。
detailsこのオブジェクトは、リクエストに関する追加情報を提供します。 requestオブジェクトには、IPアドレスとユーザーエージェントが含まれます。 activityフィールドは、実行された特定のアクションを説明します。
resourceこのオブジェクトは、関連するリソースについて説明します。ID、名前、タイプ、メールアドレス、および該当する場合はemail_confirmed_atタイムスタンプが含まれます。

各Environmentのアクティビティログに対して個別のAPIクライアントを作成する

異なるEnvironmentからログを取得するには、Environmentごとに個別のAPIクライアントを作成し、ユースケースに応じて必要なデータを組み合わせます。

レスポンスには、Environmentに関連付けられているAPIクライアントに応じて、次のEnvironmentが表示される場合があります:

  • dev (Development)
  • sandbox (Sandbox)
  • test (テスト)
  • stage (Staging)
  • uat (User Acceptance Testing)
  • preprod (Pre-Production)
  • prod (プロダクション)

クエリパラメーター ​

名前タイプ説明
page[after]integer
optional		現在のページの最後の結果に基づいて、次の結果セットの開始点を指定します。
page[size]integer
optional		ページあたりの結果数を指定します。 レコードのデフォルト数および最大数は100です。
fromstring
任意		監査ログを取得する期間の開始を指定します。 ISO 8601形式（YYYY-MM-DDTHH:mm:ss.SSSZ）で指定します。
tostring
任意		監査ログを取得する期間の終了を指定します。 ISO 8601形式（YYYY-MM-DDTHH:mm:ss.SSSZ）で指定します。
users_ids[]array of integers
optional		指定したユーザーIDによって実行されたアクティビティを含めるようにログをフィルタリングします。
include_resource_types[]array of strings
optional		指定したリソースタイプに関連するアクティビティを含めるようにログをフィルタリングします。
exclude_resource_types[]array of strings
optional		指定したリソースタイプに関連するアクティビティを除外します。
include_event_types[]array of strings
optional		指定したイベントタイプのアクティビティを含めるようにログをフィルタリングします。
exclude_event_types[]array of strings
optional		指定したイベントタイプのアクティビティを除外します。

タイムゾーン

すべてのデータセンターは、システムタイムゾーンであるPacific Daylight Time（PDT）を使用します。 fromおよびtoクエリパラメーターでタイムゾーンを指定すると、システムはそれをPDTに変換して表示します。

サンプルリクエスト ​

リクエスト1: クエリパラメーターなし ​

次のリクエスト例は、APIクライアントに関連付けられているEnvironment内のすべてのアクティビティのリストを返します:

shell
curl  -X GET "https://www.workato.com/api/activity_logs" \
      -H "Authorization: Bearer <api_token>"
レスポンス1: クエリパラメーターなし
json
{
  "data": [
    {
      "id": 1234567,
      "timestamp": "2024-06-18 19:17:31 UTC",
      "event_type": "user_login",
      "workspace": {
        "id": 12345,
        "name": "Alex",
        "email": "[email protected]",
        "environment": "dev"
      },
      "user": {
        "id": 12345,
        "name": "Alex",
        "email": "[email protected]"
      },
      "details": {
        "request": {
          "ip_address": "60.160.90.91",
          "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36"
        },
        "activity": "password_login"
      },
      "resource": {
        "id": 12345,
        "name": "Alex",
        "type": "Workspace",
        "email": "[email protected]",
        "email_confirmed_at": "2024-04-24 14:23:03 -0700"
      }
    }
    {...}
  ],
  "total": 65
}

リクエスト2: 最後の3件のレコードを取得 ​

次のリクエスト例は、最新の3件のアクティビティログエントリを取得します。 このリクエストは、APIクライアントに関連付けられているEnvironmentのアクティビティを返します:

shell
curl  -X GET "https://www.workato.com/api/activity_logs?page%5Bsize%5D=3" \
      -H "Authorization: Bearer <api_token>"
レスポンス2: 最後の3件のレコードを取得
json
{
  "data": [
    {
      "id": 3674006,
      "timestamp": "2024-06-26 15:56:07 UTC",
      "event_type": "user_login",
      "workspace": {
        "id": 12345,
        "name": "Alex",
        "email": "[email protected]",
        "environment": "dev"
      },
      "user": {
        "id": 12345,
        "name": "Alex",
        "email": "[email protected]"
      },
      "details": {
        "request": {
          "ip_address": "60.160.90.91",
          "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36"
        },
        "activity": "password_login"
      },
      "resource": {
        "id": 12345,
        "name": "Alex",
        "type": "Workspace",
        "email": "[email protected]",
        "email_confirmed_at": "2024-04-24 14:23:03 -0700"
      }
    },
    {
      "id": 3670909,
      "timestamp": "2024-06-25 16:38:11 UTC",
      "event_type": "recipe_created",
      "workspace": {
        "id": 12345,
        "name": "Alex",
        "email": "[email protected]",
        "environment": "dev"
      },
      "user": {
        "id": 12345,
        "name": "Alex",
        "email": "[email protected]"
      },
      "details": {
        "request": {
          "ip_address": "60.160.90.91",
          "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36"
        }
      },
      "resource": {
        "id": 289287,
        "name": "My new recipe",
        "path": "Home/Demos",
        "type": "Flow",
        "folder_id": 46319
      }
    },
    {
      "id": 3668492,
      "timestamp": "2024-06-24 15:52:23 UTC",
      "event_type": "user_login",
      "workspace": {
        "id": 12345,
        "name": "Alex",
        "email": "[email protected]",
        "environment": "dev"
      },
      "user": {
        "id": 12345,
        "name": "Alex",
        "email": "[email protected]"
      },
      "details": {
        "request": {
          "ip_address": "60.160.90.91",
          "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36"
        },
        "activity": "password_login"
      },
      "resource": {
        "id": 12345,
        "name": "Alex",
        "type": "Workspace",
        "email": "[email protected]",
        "email_confirmed_at": "2024-04-24 14:23:03 -0700"
      }
    }
  ],
  "total": 65
}

リクエスト3: 2人のユーザーの1日分のアクティビティを取得 ​

次のリクエスト例は、2024年6月30日の2人のユーザーのアクティビティを取得します。 このリクエストは、APIクライアントに関連付けられているEnvironmentのアクティビティを返します:

shell
curl  -X GET "https://www.workato.com/api/activity_logs?from=2024-06-30T00:00:00Z&to=2024-06-30T23:59:59Z&users_ids[]=54321&users_ids[]=12345" \
      -H "Authorization: Bearer <api_token>"

日付と時刻の形式

fromおよびtoクエリパラメーターでは、月が日の前に来るYYYY-MM-DD形式を使用してください。 YYYY-DD-MM形式を使用すると、500 Server errorが発生します。

レスポンス3: 2人のユーザーの1日分のアクティビティを取得
json
{
  "data": [
    {
      "id": 3649152,
      "timestamp": "2024-06-30 23:09:51 UTC",
      "event_type": "connector_deleted",
      "workspace": {
        "id": 12345,
        "name": "Alex",
        "email": "[email protected]",
        "environment": "dev"
      },
      "user": {
        "id": 12345,
        "name": "Alex",
        "email": "[email protected]"
      },
      "details": {
        "request": {
          "ip_address": "60.160.90.91",
          "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36"
        }
      },
      "resource": {
        "id": 7321,
        "name": "Calendly",
        "type": "CustomAdapter"
      }
    },
    {
      "id": 3649149,
      "timestamp": "2024-06-30 23:07:33 UTC",
      "event_type": "connector_created",
      "workspace": {
        "id": 12345,
        "name": "Alex",
        "email": "[email protected]",
        "environment": "dev"
      },
      "user": {
        "id": 12345,
        "name": "Alex",
        "email": "[email protected]"
      },
      "details": {
        "request": {
          "ip_address": "60.160.90.91",
          "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36"
        }
      },
      "resource": {
        "id": 7321,
        "name": "Calendly",
        "type": "CustomAdapter"
      }
    },
    {
      "id": 3649129,
      "timestamp": "2024-06-30 22:34:36 UTC",
      "event_type": "user_logout",
      "workspace": {
        "id": 54321,
        "name": "Jie",
        "email": "[email protected]",
        "environment": "dev"
      },
      "user": {
        "id": 54321,
        "name": "Jie",
        "email": "[email protected]"
      },
      "details": {
        "request": {
          "ip_address": "192.0.2.1",
          "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36"
        },
        "activity": "switch_team"
      },
      "resource": {
        "id": 12345,
        "name": "Alex",
        "type": "Workspace",
        "email": "[email protected]",
        "email_confirmed_at": "2024-04-24 14:23:03 -0700"
      }
    },
    {
      "id": 3649127,
      "timestamp": "2024-06-30 22:32:43 UTC",
      "event_type": "user_login",
      "workspace": {
        "id": 54321,
        "name": "Jie",
        "email": "[email protected]",
        "environment": "dev"
      },
      "user": {
        "id": 54321,
        "name": "Jie",
        "email": "[email protected]"
      },
      "details": {
        "request": {
          "ip_address": "192.0.2.1",
          "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36"
        },
        "activity": "switch_team"
      },
      "resource": {
        "id": 12345,
        "name": "Alex",
        "type": "Workspace",
        "email": "[email protected]",
        "email_confirmed_at": "2024-04-24 14:23:03 -0700"
      }
    },
    {
      "id": 3649124,
      "timestamp": "2024-06-30 22:32:16 UTC",
      "event_type": "user_logout",
      "workspace": {
        "id": 54321,
        "name": "Jie",
        "email": "[email protected]",
        "environment": "dev"
      },
      "user": {
        "id": 54321,
        "name": "Jie",
        "email": "[email protected]"
      },
      "details": {
        "request": {
          "ip_address": "192.0.2.1",
          "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36"
        },
        "activity": "switch_team"
      },
      "resource": {
        "id": 12345,
        "name": "Alex",
        "type": "Workspace",
        "email": "[email protected]",
        "email_confirmed_at": "2024-04-24 14:23:03 -0700"
      }
    },
    {
      "id": 3649123,
      "timestamp": "2024-06-30 22:32:00 UTC",
      "event_type": "user_login",
      "workspace": {
        "id": 54321,
        "name": "Jie",
        "email": "[email protected]",
        "environment": "dev"
      },
      "user": {
        "id": 54321,
        "name": "Jie",
        "email": "[email protected]"
      },
      "details": {
        "request": {
          "ip_address": "192.0.2.1",
          "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36"
        },
        "activity": "switch_team"
      },
      "resource": {
        "id": 12345,
        "name": "Alex",
        "type": "Workspace",
        "email": "[email protected]",
        "email_confirmed_at": "2024-04-24 14:23:03 -0700"
      }
    }
  ],
  "total": 6
}

リクエスト4: 特定のresource_typesおよびevent_typesを持つアクティビティを含める ​

次のリクエスト例では、resource_typeがApiPrivilegeGroupで、event_typeがapi_privilege_group_updatedのアクティビティを含めます。 このリクエストは、APIクライアントに関連付けられているEnvironmentのアクティビティを返します:

shell
curl  -X GET "https://www.workato.com/api/activity_logs?include_resource_types[]=ApiPrivilegeGroup&include_event_types[]=api_privilege_group_updated" \
      -H "Authorization: Bearer <api_token>"
レスポンス4: 特定のresource_typesおよびevent_typesを持つアクティビティを含める
json
{
  "data": [
    {
      "id": 3661175,
      "timestamp": "2024-06-18 17:38:33 UTC",
      "event_type": "api_privilege_group_updated",
      "workspace": {
        "id": 12345,
        "name": "Alex",
        "email": "[email protected]",
        "environment": "dev"
      },
      "user": {
        "id": 12345,
        "name": "Alex",
        "email": "[email protected]"
      },
      "details": {
        "request": {
          "ip_address": "60.160.90.91",
          "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36"
        }
      },
      "resource": {
        "id": 40327,
        "name": "Recipe Operator",
        "type": "ApiPrivilegeGroup"
      }
    },
    {
      "id": 3644097,
      "timestamp": "2024-06-04 21:37:12 UTC",
      "event_type": "api_privilege_group_updated",
      "workspace": {
        "id": 12345,
        "name": "Alex",
        "email": "[email protected]",
        "environment": "dev"
      },
      "user": {
        "id": 12345,
        "name": "Alex",
        "email": "[email protected]"
      },
      "details": {
        "request": {
          "ip_address": "60.160.90.91",
          "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36"
        }
      },
      "resource": {
        "id": 40327,
        "name": "Recipe Operator",
        "type": "ApiPrivilegeGroup"
      }
    },
    {
      "id": 3643744,
      "timestamp": "2024-06-04 16:24:44 UTC",
      "event_type": "api_privilege_group_updated",
      "workspace": {
        "id": 12345,
        "name": "Alex",
        "email": "[email protected]",
        "environment": "dev"
      },
      "user": {
        "id": 12345,
        "name": "Alex",
        "email": "[email protected]"
      },
      "details": {
        "request": {
          "ip_address": "60.160.90.91",
          "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36"
        }
      },
      "resource": {
        "id": 40327,
        "name": "Recipe Operator",
        "type": "ApiPrivilegeGroup"
      }
    }
  ],
  "total": 3
}

リクエスト5: 特定のresource_typesおよびevent_typesを持つアクティビティを除外 ​

次のリクエスト例では、resource_typeがUserで、event_typeがuser_logoutのアクティビティを除外します。 このリクエストは、APIクライアントに関連付けられているEnvironmentのアクティビティを返します:

shell
curl  -X GET "https://www.workato.com/api/activity_logs?exclude_resource_types[]=User&exclude_event_types[]=user_logout" \
      -H "Authorization: Bearer <api_token>"
レスポンス5: 特定のresource_typesおよびevent_typesを持つアクティビティを除外
json
{
  "data": [
    {
      "id": 3670909,
      "timestamp": "2024-06-25 16:38:11 UTC",
      "event_type": "recipe_created",
      "workspace": {
        "id": 12345,
        "name": "Alex",
        "email": "[email protected]",
        "environment": "dev"
      },
      "user": {
        "id": 12345,
        "name": "Alex",
        "email": "[email protected]"
      },
      "details": {
        "request": {
          "ip_address": "60.160.90.91",
          "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36"
        }
      },
      "resource": {
        "id": 289287,
        "name": "My new recipe",
        "path": "Home/Demos",
        "type": "Flow",
        "folder_id": 46319
      }
    },
    {
      "id": 3665078,
      "timestamp": "2024-06-20 20:00:36 UTC",
      "event_type": "connection_updated",
      "workspace": {
        "id": 12345,
        "name": "Alex",
        "email": "[email protected]",
        "environment": "dev"
      },
      "user": {
        "id": 12345,
        "name": "Alex",
        "email": "[email protected]"
      },
      "details": {
        "request": {
          "ip_address": "60.160.90.91",
          "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/125.0.0.0 Safari/537.36"
        }
      },
      "resource": {
        "id": 66196,
        "name": "My RecipeOps by Workato account",
        "path": "Home/Demos",
        "type": "SharedAccount",
        "provider": "workato_app",
        "folder_id": 46319,
        "authorized": true
      }
    },
    {...}
  ],
  "total": 42
}

リクエスト6: 存在しないイベントタイプまたはユーザーIDでアクティビティを取得 ​

次のリクエスト例は、存在しないイベントタイプとユーザーIDのアクティビティの取得を試みます。 存在しないイベントタイプまたはユーザーIDでアクティビティをフィルタリングすると、空の配列になります:

shell
curl  -X GET "https://www.workato.com/api/activity_logs?users_ids[]=67890&include_event_types[]=nonexistent_event_type" \
      -H "Authorization: Bearer <api_token>"
レスポンス6: 存在しないイベントタイプまたはユーザーIDでアクティビティを取得
json
{
  "data": [],
  "total": 0
}

タグの一覧表示 ​

ワークスペース内のタグのリストを取得します。

shell
GET /api/tags

プログラムでタグを管理する

タグ割り当ての管理（POST /api/tags_assignments）エンドポイントを使用して、アセットにタグを適用したり、アセットからタグを削除したりします。 タグ付け可能なアセットには、レシピ、コネクション、ページ、Data tablesが含まれます。

クエリパラメーター ​

名前タイプ説明
pagenumber
optional		取得するタグのページ番号。 デフォルトは1です。
per_pagenumber
optional		1ページで返すタグの数。 デフォルトは100です。 最大値は100です。
q[title_or_description_cont]string
任意		タイトルまたは説明に指定した文字列が含まれるタグを含めるように結果をフィルタリングします。

例: ...?q[title_or_description_cont]=hr
q[handle_in]array of strings
optional		指定した値と一致するハンドルを持つタグのみを含めるように結果をフィルタリングします。 各ハンドルは、個別のパラメーターインスタンスとして指定する必要があります。

例: ...?q[handle_in][]=tag-APfXzndL-4whAmJ&q[handle_in][]=tag-APfWgxnc-Ggakzt
q[author_id_eq]number
optional		指定した作成者（ユーザーID）が作成したタグのみを含めるように結果をフィルタリングします。

例: ...?q[author_id_eq]=30482
q[recipe_id_eq]number
optional		指定したレシピIDに関連付けられているタグのみを含めるように結果をフィルタリングします。

例: ...?q[recipe_id_eq]=54525313
q[connection_id_eq]number
optional		指定したコネクションIDに関連付けられているタグのみを含めるように結果をフィルタリングします。

例: ...?q[connection_id_eq]=1571346
q[only_assigned]boolean
optional		アセットに割り当てられているタグのみを含めるように結果をフィルタリングします。

例: ...?q[only_assigned]=true
sort_bystring
任意		レスポンスを並べ替えるフィールドを指定します。 title、assignment_count、updated_at、またはlast_assigned_atを受け入れます。

例: ...?sort_by=assignment_count
sort_directionstring
任意		レスポンスの並べ替え順序を指定します。 ascまたはdescを受け入れます。

例: ...?sort_direction=asc
includes[]array of strings
optional		レスポンスに含める追加フィールドを指定します。 assignment_countおよびauthorを受け入れます。

例: ...?includes[]=author

リクエスト例 ​

このリクエストはタグのリストを取得し、includes[]クエリパラメーターを使用して、作成者（タグを作成したユーザー）とタグがアセットに割り当てられた回数の両方を返します。

shell
curl  -X GET "https://www.workato.com/api/tags?includes[]=author&includes[]=assignment_count" \
      -H "Authorization: Bearer <api_token>"

レスポンス ​

json
{
  "data": {
    "tags": [
      {
        "handle": "tag-ANgdXgTF-bANz3H",
        "title": "Accounting",
        "description": "Accounting tag",
        "color": "orange",
        "created_at": "2024-08-29T14:09:13-07:00",
        "updated_at": "2024-08-29T14:09:13-07:00",
        "author": {
            "id": 12345,
            "name": "Charlie",
            "avatar_url": ""
        },
        "assignment_count": 6
      },
      {
        "handle": "tag-ANgef8oT-TgTeFY",
        "title": "Business development",
        "description": "Business development tag",
        "color": "green",
        "created_at": "2024-08-29T15:20:44-07:00",
        "updated_at": "2024-08-29T15:20:44-07:00",
        "author": {
            "id": 30482,
            "name": "Jie",
            "avatar_url": ""
        },
        "assignment_count": 3
      },
      {
        "handle": "tag-ANgefFcG-RRkGKc",
        "title": "Finance",
        "description": "Finance tag",
        "color": "gold",
        "created_at": "2024-08-29T15:20:57-07:00",
        "updated_at": "2024-08-29T15:20:57-07:00",
        "author": {
            "id": 73913,
            "name": "Alex",
            "avatar_url": ""
        },
        "assignment_count": 4
      }
    ]
  }
}

タグの作成 ​

ワークスペースに新しいタグを作成します。

shell
POST /api/tags

ペイロード ​

名前タイプ説明
titlestring
必須		タグのタイトル。 最大30文字。
説明string
任意		タグの説明。 最大150文字。
colorstring
任意		タグの色。 使用可能な値には、blue、violet、green、red、orange、gold、indigo、brown、teal、plum、slate、neutralがあります。 このフィールドが指定されていない場合、Workatoはタグにランダムな色を割り当てます。

リクエスト例 ​

shell
curl  -X POST "https://www.workato.com/api/tags" \
      -H "Authorization: Bearer <api_token>" \
      -H "Content-Type: application/json" \
      -d '{
            "title": "HR",
            "description": "HR tag",
            "color": "green"
          }'

レスポンス ​

json
{
  "data": {
    "handle": "tag-ANrzJTFF-wczhaW",
    "title": "HR",
    "description": "HR tag",
    "color": "green"
  }
}

タグの更新 ​

ワークスペース内の既存のタグを更新します。

shell
PUT /api/tags/:handle

URLパラメーター ​

名前タイプ説明
handlestring
必須		更新するタグのハンドル。

ペイロード ​

名前タイプ説明
titlestring
必須		更新後のタグタイトル。 最大30文字。
説明string
任意		更新後のタグ説明。 最大150文字。
colorstring
任意		更新後のタグ色。 使用可能な値には、blue、violet、green、red、orange、gold、indigo、brown、teal、plum、slate、neutralがあります。

リクエスト例 ​

shell
curl  -X PUT "https://www.workato.com/api/tags/tag-ANrzJTFF-wczhaW" \
      -H "Authorization: Bearer <api_token>" \
      -H "Content-Type: application/json" \
      -d '{
            "title": "Updated tag name",
            "description": "Updated the tag name",
            "color": "red"
          }'

レスポンス ​

json
{
  "data": {
    "handle": "tag-ANrzJTFF-wczhaW",
    "title": "Updated tag name",
    "description": "Updated the tag name",
    "color": "red"
  }
}

タグの削除 ​

ワークスペース内の既存のタグを削除します。

shell
DELETE /api/tags/:handle

URLパラメーター ​

名前タイプ説明
handlestring
必須		削除するタグのハンドル。

リクエスト例 ​

shell
curl  -X DELETE "https://www.workato.com/api/tags/tag-ANrzJTFF-wczhaW" \
      -H "Authorization: Bearer <api_token>"

レスポンス ​

リクエストが200 OKステータスコードを返した場合、タグは正常に削除されています。 レスポンス本文ではコンテンツは返されません。

Last updated: