Environment管理

Environment管理エンドポイントを使用して、タグを作成、取得、更新、および削除できます。また、これらのエンドポイントを使用して、活動監査ログレコードを通じて顧客ワークスペース内のユーザー活動を監視できます。

レート制限

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

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

クイックリファレンス

タイプ	リソース	説明
GET	/api/managed_users/:id/activity_logs	顧客ワークスペース内の活動監査ログレコードを取得します。
GET	/api/v2/managed_users/:id/tags	顧客ワークスペース内のタグの一覧を取得します。
POST	/api/v2/managed_users/:id/tags	顧客ワークスペース内にタグを作成します。
PUT	/api/v2/managed_users/:id/tags/:handle	顧客ワークスペース内のタグを更新します。
DELETE	/api/v2/managed_users/:id/tags/:handle	顧客ワークスペース内のタグを削除します。

活動監査ログの取得

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

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

shell

GET /api/managed_users/:id/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`タイムスタンプが含まれます。

ワークスペースIDを使用して異なるEnvironmentのログにアクセス

異なる顧客Environmentからログを取得するには、各Environmentの関連するワークスペースIDをidURLパラメーターで指定する必要があります。

URLパラメーター

名前	タイプ	説明
id	string 必須	Embedded顧客ID/外部ID。 External IDはURLエンコードし、Eを先頭に付ける必要があります（例: EA2300）。

クエリパラメーター

名前	タイプ	説明
page[after]	integer optional	現在のページの最後の結果に基づいて、次の結果セットの開始点を指定します。
page[size]	integer optional	ページあたりの結果数を指定します。レコードのデフォルト数および最大数は100です。
from	string 任意	監査ログを取得する期間の開始を指定します。 ISO 8601形式（`YYYY-MM-DDTHH:mm:ss.SSSZ`）で指定します。
to	string 任意	監査ログを取得する期間の終了を指定します。 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: クエリパラメーターなし

次のリクエスト例は、idURLパラメーターに関連付けられた顧客ワークスペースのすべての活動のリストを返します:

shell

curl  -X GET "https://www.workato.com/api/managed_users/19029/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件のアクティビティログエントリを取得します。このリクエストは、idURLパラメーターに関連付けられた顧客ワークスペースの活動を返します:

shell

curl  -X GET "https://www.workato.com/api/managed_users/19029/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人のユーザーのアクティビティを取得します。このリクエストは、idURLパラメーターに関連付けられた顧客ワークスペースの活動を返します:

shell

curl  -X GET "https://www.workato.com/api/managed_users/19029/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": 19029,
                "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": "New Connector 1",
                "type": "CustomAdapter"
            }
        },
        {
            "id": 3649149,
            "timestamp": "2024-06-30 23:07:33 UTC",
            "event_type": "connector_created",
            "workspace": {
                "id": 19029,
                "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": "New Connector 1",
                "type": "CustomAdapter"
            }
        },
        {
            "id": 3649129,
            "timestamp": "2024-06-30 22:34:36 UTC",
            "event_type": "user_logout",
            "workspace": {
                "id": 19029,
                "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": 19029,
                "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": 19029,
                "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": 19029,
                "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": 19029,
                "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": 19029,
                "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": 19029,
                "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": 19029,
                "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のアクティビティを含めます。このリクエストは、idURLパラメーターに関連付けられた顧客ワークスペースの活動を返します:

shell

curl  -X GET "https://www.workato.com/api/managed_users/19029/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": 19029,
                "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": 19029,
                "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": 19029,
                "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のアクティビティを除外します。このリクエストは、idURLパラメーターに関連付けられた顧客ワークスペースの活動を返します:

shell

curl  -X GET "https://www.workato.com/api/managed_users/19029/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": 19029,
                "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": 19029,
                "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/managed_users/19029/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/v2/managed_users/:id/tags

タグをプログラムで適用または削除

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

名前	タイプ	説明
id	string 必須	Embedded顧客ID/外部ID。 External IDはURLエンコードし、先頭に`E`を付ける必要があります（例: `EA2300`）。

名前	タイプ	説明
page	number optional	取得するタグのページ番号。デフォルトは`1`です。
per_page	number 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_by	string 任意	レスポンスを並べ替えるフィールドを指定します。 `title`、`assignment_count`、`updated_at`、または`last_assigned_at`を受け入れます。例: `...?sort_by=assignment_count`
sort_direction	string 任意	レスポンスの並べ替え順序を指定します。 `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/v2/managed_users/19029/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/v2/managed_users/:id/tags

URLパラメーター

名前	タイプ	説明
id	string 必須	Embedded顧客ID/外部ID。 External IDはURLエンコードし、先頭に`E`を付ける必要があります（例: `EA2300`）。

ペイロード

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

サンプルリクエスト

shell

curl  -X POST "https://www.workato.com/api/v2/managed_users/19029/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/v2/managed_users/:id/tags/:handle

URLパラメーター

名前	タイプ	説明
id	string 必須	Embedded顧客ID/外部ID。 External IDはURLエンコードし、先頭に`E`を付ける必要があります（例: `EA2300`）。
handle	string 必須	更新するタグのハンドル。

ペイロード

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

リクエスト例

shell

curl  -X PUT "https://www.workato.com/api/v2/managed_users/19029/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/v2/managed_users/:id/tags/:handle

URLパラメーター

名前	タイプ	説明
id	string 必須	Embedded顧客ID/外部ID。 External IDはURLエンコードし、先頭に`E`を付ける必要があります（例: `EA2300`）。
handle	string 必須	削除するタグのハンドル。

リクエスト例

shell

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

レスポンス

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

Last updated:

Environment管理 ​

レート制限 ​

クイックリファレンス ​

活動監査ログの取得 ​

URLパラメーター ​

クエリパラメーター ​

サンプルリクエスト ​

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

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

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

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

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

リクエスト6: 存在しないイベントタイプまたは顧客ワークスペースIDで活動を取得 ​

タグの一覧表示 ​

URLパラメーター ​

クエリパラメーター ​

レスポンス ​

タグの作成 ​

URLパラメーター ​

ペイロード ​

サンプルリクエスト ​

レスポンス ​

タグの更新 ​

URLパラメーター ​

ペイロード ​

リクエスト例 ​

レスポンス ​

タグの削除 ​

URLパラメーター ​

リクエスト例 ​

レスポンス ​

Environment管理

レート制限

クイックリファレンス

活動監査ログの取得

URLパラメーター

クエリパラメーター

サンプルリクエスト

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

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

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

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

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

リクエスト6: 存在しないイベントタイプまたは顧客ワークスペースIDで活動を取得

タグの一覧表示

URLパラメーター

クエリパラメーター

レスポンス

タグの作成

URLパラメーター

ペイロード

サンプルリクエスト

レスポンス

タグの更新

URLパラメーター

ペイロード

リクエスト例

レスポンス

タグの削除

URLパラメーター

リクエスト例

レスポンス