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

コネクター ​

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

これらのAPIエンドポイントを使用して、標準のWorkatoコネクターに関する情報を取得します。 これは、アプリのマーケットプレイスを生成する場合に特に便利です。

レート制限 ​

コネクターリソースには、次のレート制限があります:

タイプリソース制限
すべてすべてのコネクターエンドポイント1分あたり1,000リクエスト

クイックリファレンス ​

タイプリソース説明
GET/api/v2/managed_users/:managed_user_id/connectors
/:connector_name/input_schema		ベース入力スキーマを返します。 スキーマは静的であり、特定のコネクション入力は考慮されません。
GETapi/integrationsリクエストで指定されたコネクターとメタデータのリストを返します。
GETapi/integrations/allEmbeddedパートナーのアカウント内のすべてのコネクターと関連メタデータのページ分割されたリストを返します。 レスポンスには、標準コネクターとプラットフォームコネクターが含まれます。

コネクター取得エンドポイント ​

ベース入力スキーマを返します。 スキーマは静的であり、特定のコネクション入力は考慮されません。

shell
GET /api/v2/managed_users/:managed_user_id/connectors/:connector_name/input_schema

コネクション取得エンドポイントについては、コネクション取得エンドポイントを参照してください。

URLパラメーター ​

名前タイプ説明
managed_user_idstring
必須		Embedded顧客のアカウントIDまたはExternal ID。 External IDにはプレフィックス'E'を付け、URLエンコードする必要があります。 例: 'EA2300'。
connector_namestring
必須		ベース入力スキーマを取得するコネクターの名前。

サンプルリクエスト ​

shell
curl  -X GET https://www.workato.com/api/v2/managed_users/97/connectors/jms/input_schema \
      -H 'Authorization: Bearer <api_token>'

レスポンス ​

JSON
{
    "result": [
        {
            "control_type": "text",
            "label": "On-prem connection profile",
            "disable_formula": true,
            "ngIf": "!line.use_managed_connection",
            "hint": "Profile names are in the <b>jms</b> section of an on-prem group's <b>config.yml</b> file. <a href=\"https://docs.workato.com/on-prem/agents/connection/profile.html#jms-profile\" target=\"_blank\">Learn more</a>",
            "type": "string",
            "name": "profile"
        },
        {
            "control_type": "select",
            "label": "Provider",
            "disable_formula": true,
            "ngIf": "line.use_managed_connection",
            "pick_list": [
                [
                    "Amazon SQS",
                    "amazon-sqs"
                ],
                [
                    "ActiveMQ",
                    "activemq"
                ],
                [
                    "Custom",
                    "custom"
                ]
            ],
            "hint": "Select JMS provider.<br/>You can find more information about jms providers <a href='https://docs.workato.com/on-prem/agents/connection/cloud.html#jms-profile' target='_blank'>here</a>.",
            "extends_schema": true,
            "type": "string",
            "name": "provider"
        }
    ]
}

コネクターメタデータの一覧表示 ​

APIリクエストで指定されたコネクターと関連メタデータのリストを返します。

GET /api/integrations

ペイロード ​

名前タイプ説明
applicationsstring
必須		カンマ区切りのコネクター識別子。

サンプルリクエスト ​

shell
curl  -X GET https://www.workato.com/api/integrations \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "applications": "google_drive,service_now"
          }'

レスポンス ​

json
{
    "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
                }
            ]
        }
    ]
}

すべてのプラットフォームコネクターの一覧表示 ​

Embeddedパートナーのアカウント内のすべてのコネクターと関連メタデータのページ分割されたリストを返します。 これには標準コネクターとプラットフォームコネクターの両方が含まれます。 Workatoはレスポンスの末尾にレコードの合計数を含めます。

GET api/integrations/all

クエリパラメーター ​

名前タイプ説明
pageinteger
optional		ページ番号。 デフォルトは1です。 コネクターの合計数がページあたりのレコード制限を超える場合は、次のページを呼び出して後続のページを取得します。
per_pageinteger
optional		ページあたりのレコード数。 デフォルトは1です。 最大は100です。 100を超える値を入力した場合、Workatoはレスポンスで100件のレコードのみを返します。

サンプルリクエスト ​

shell
curl  -X GET https://www.workato.com/api/integrations/all?page=1&per_page=90 \
      -H 'Authorization: Bearer <api_token>'

レスポンス ​

json
    "count": 293,
    "page": 1,
    "per_page": 90

省略されたレスポンス

前述のレスポンスは、レスポンスで返されるレコードの合計数を表示するために省略されています。 各レコードについてWorkatoが返すコネクターと関連メタデータの例については、コネクターメタデータ一覧APIを参照してください。

Last updated: