# コネクター
これらの API エンドポイントを使用して、標準の Workato コネクターに関する情報を取得します。これは、特に、アプリの市場の生成に役立ちます。
# コネクターメタデータの列挙
API リクエストで指定されたコネクターと関連するメタデータのリストを返します。
GET /api/integrations
# ペイロード
| 名前 | 型 | 説明 |
|---|---|---|
| applications | string 必須 | カンマ区切りのコネクター識別子。 |
# サンプルリクエスト
curl -X GET https://www.workato.com/api/integrations \
-H 'x-user-email: <email>' \
-H 'x-user-token: <token>' \
-H 'Content-Type: application/json' \
-d '{
"applications": "google_drive,service_now"
}'
# レスポンス
{
"items": [
{
"name": "google_drive",
"title": "Google Drive",
"categories": [
"Document/File",
"Sales Enablement"
],
"oauth": true,
"deprecated": false,
"secondary": false,
"triggers": [
{
"name": "new_file_in_subfolder",
"title": "New file or folder in folder hierarchy",
"deprecated": false,
"bulk": false,
"batch": false
},
{
"name": "new_file_or_folder",
"title": "New file or folder",
"deprecated": false,
"bulk": false,
"batch": false
}
],
"actions": [
{
"name": "__adhoc_http_action",
"title": "Custom action",
"deprecated": false,
"bulk": false,
"batch": false
},
{
"name": "create_folder",
"title": "Create folder",
"deprecated": false,
"bulk": false,
"batch": false
},
{
"name": "download_file_contents",
"title": "Download file",
"deprecated": false,
"bulk": false,
"batch": false
},
{
"name": "move_rename_file",
"title": "Rename or move file/folder",
"deprecated": false,
"bulk": false,
"batch": false
},
{
"name": "search_file_or_folder",
"title": "Search files or folders",
"deprecated": false,
"bulk": false,
"batch": false
},
{
"name": "upload_file",
"title": "Upload small file",
"deprecated": false,
"bulk": false,
"batch": false
},
{
"name": "upload_file_stream",
"title": "Upload large file",
"deprecated": false,
"bulk": false,
"batch": false
}
]
},
{
"name": "service_now",
"title": "ServiceNow",
"categories": [
"Customer Service",
"IT Service Management"
],
"oauth": true,
"deprecated": false,
"secondary": false,
"triggers": [
{
"name": "closed_incident",
"title": "Closed incident",
"deprecated": true,
"bulk": false,
"batch": false
},
{
"name": "new_incident",
"title": "New incident",
"deprecated": true,
"bulk": false,
"batch": false
},
{
"name": "new_object",
"title": "New record",
"deprecated": false,
"bulk": false,
"batch": false
},
{
"name": "new_object_webhook",
"title": "New record",
"deprecated": false,
"bulk": false,
"batch": false
},
{
"name": "new_sys_user",
"title": "New user",
"deprecated": true,
"bulk": false,
"batch": false
},
{
"name": "scheduled_query",
"title": "Scheduled record search",
"deprecated": false,
"bulk": false,
"batch": true
},
{
"name": "updated_incident",
"title": "New/updated incident",
"deprecated": true,
"bulk": false,
"batch": false
},
{
"name": "updated_object",
"title": "New/updated record",
"deprecated": false,
"bulk": false,
"batch": false
},
{
"name": "updated_object_webhook",
"title": "New/updated record",
"deprecated": false,
"bulk": false,
"batch": false
},
{
"name": "updated_sys_user",
"title": "New/updated user",
"deprecated": true,
"bulk": false,
"batch": false
}
],
"actions": [
{
"name": "__adhoc_http_action",
"title": "Custom action",
"deprecated": false,
"bulk": false,
"batch": false
},
{
"name": "assign_user_to_incident",
"title": "Assign user to incident",
"deprecated": true,
"bulk": false,
"batch": false
},
{
"name": "create_asset",
"title": "Create asset",
"deprecated": true,
"bulk": false,
"batch": false
},
{
"name": "create_catalog_task",
"title": "Create catalog task",
"deprecated": true,
"bulk": false,
"batch": false
},
{
"name": "create_change",
"title": "Create change",
"deprecated": true,
"bulk": false,
"batch": false
},
{
"name": "create_core_company",
"title": "Create core company",
"deprecated": true,
"bulk": false,
"batch": false
},
{
"name": "create_incident",
"title": "Create incident",
"deprecated": true,
"bulk": false,
"batch": false
},
{
"name": "create_object",
"title": "Create record",
"deprecated": false,
"bulk": false,
"batch": false
},
{
"name": "create_object_using_template",
"title": "Create record using a template",
"deprecated": false,
"bulk": false,
"batch": false
},
{
"name": "create_problem",
"title": "Create problem",
"deprecated": true,
"bulk": false,
"batch": false
},
{
"name": "create_user",
"title": "Create user",
"deprecated": true,
"bulk": false,
"batch": false
},
{
"name": "get_incident",
"title": "Get incident details by ID",
"deprecated": true,
"bulk": false,
"batch": false
},
{
"name": "get_user",
"title": "Get user details by ID",
"deprecated": true,
"bulk": false,
"batch": false
},
{
"name": "lookup_user",
"title": "Search users",
"deprecated": true,
"bulk": false,
"batch": false
},
{
"name": "search_assets",
"title": "Search assets",
"deprecated": true,
"bulk": false,
"batch": false
},
{
"name": "search_companies",
"title": "Search companies",
"deprecated": true,
"bulk": false,
"batch": false
},
{
"name": "search_objects",
"title": "Search records",
"deprecated": true,
"bulk": false,
"batch": false
},
{
"name": "search_objects_v2",
"title": "Search records",
"deprecated": false,
"bulk": false,
"batch": false
},
{
"name": "search_users",
"title": "Search users",
"deprecated": true,
"bulk": false,
"batch": false
},
{
"name": "search_using_query",
"title": "Search records using query",
"deprecated": false,
"bulk": false,
"batch": false
},
{
"name": "update_asset",
"title": "Update asset",
"deprecated": true,
"bulk": false,
"batch": false
},
{
"name": "update_company",
"title": "Update company",
"deprecated": true,
"bulk": false,
"batch": false
},
{
"name": "update_incident",
"title": "Update incident",
"deprecated": true,
"bulk": false,
"batch": false
},
{
"name": "update_object",
"title": "Update record",
"deprecated": false,
"bulk": false,
"batch": false
},
{
"name": "update_object_using_template",
"title": "Update record using a template",
"deprecated": false,
"bulk": false,
"batch": false
},
{
"name": "update_user",
"title": "Update user",
"deprecated": true,
"bulk": false,
"batch": false
}
]
}
]
}
# 全プラットフォームコネクタの列挙
埋め込みパートナーアカウント内のすべてのコネクタと関連するメタデータのページネーションされたリストを返します。これには標準コネクタとプラットフォームコネクタの両方が含まれます。Workatoは応答の最後にレコードの総数を含めます。
GET api/integrations/all
# クエリパラメータ
| 名前 | タイプ | 説明 |
|---|---|---|
| page | integer オプション | ページ番号。デフォルトは1です。コネクタの総数がページごとの制限を超える場合は、次のページを呼び出して後続のページを取得します。 |
| per_page | integer オプション | ページごとのレコード数。デフォルトは1です。最大は100です。100を超える場合、Workatoは応答で100件のレコードのみを返します。 |
# サンプルリクエスト
curl -X GET https://workato.com/api/integrations/all?page=1&per_page=90 \
-H 'Authorization: Bearer <api_token>'
# レスポンス
"count": 293,
"page": 1,
"per_page": 90
省略されたレスポンス
前のレスポンスは、応答で返されるレコードの総数を表示するために省略されています。各レコードに対してWorkatoが返すコネクタと関連するメタデータの例については、コネクタメタデータのリストAPIを参照してください。
Last updated: 2024/2/13 16:59:53