オンプレミス API

Workato API では、API を介して、オンプレミスグループおよびオンプレミスエージェントを操作できます。

クイックリファレンス

タイプ	リソース	説明
GET	/on_prem_groups	オンプレミスグループを列挙します。
POST	/on_prem_groups	オンプレミスグループを作成します。
GET	/on_prem_groups/:id	オンプレミスグループの詳細を取得します。
PUT	/on_prem_groups/:id	オンプレミスグループを更新します。
DELETE	/on_prem_groups/:id	オンプレミスグループを削除します。
GET	/on_prem_groups/:id/status	オンプレミスグループのステータスを取得します。
GET	/on_prem_agents	オンプレミスエージェントを列挙します。
POST	/on_prem_agents	オンプレミスエージェントを作成します。
GET	/on_prem_agents/:id	オンプレミスエージェントの詳細を取得します。
PUT	/on_prem_agents/:id	オンプレミスエージェントを更新します。
DELETE	/on_prem_agents/:id	オンプレミスエージェントを削除します。
GET	/on_prem_agents/:id/status	オンプレミスエージェントのステータスを取得します。
GET	/on_prem_agents/search	オンプレミスエージェントを検索します。

オンプレミスグループの列挙

ワークスペース内のすべてのオンプレミスグループを列挙します。

GET /on_prem_groups

レスポンス

[
  {
    "id": 16803,
    "name": "CRM server",
    "created_at": "2017-09-21T01:51:45.954-07:00"
  }
]

オンプレミスグループの作成

オンプレミスグループを作成します。

POST /on_prem_groups

ペイロード

名前	型	説明
name	string	オンプレミスグループの名前。

サンプルリクエスト

curl  -X POST 'https://www.workato.com/api/on_prem_groups' \
      -H 'Authorization: Bearer <api_token>'
      -H 'Content-Type: application/json' \
      -d  '{
             "name":"CRM server"
          }'

レスポンス

[
  {
    "id": 16803,
    "name": "CRM server",
    "created_at": "2017-09-21T01:51:45.954-07:00"
  }
]

オンプレミスグループの詳細の取得

オンプレミスグループについての詳細を取得します。

GET /on_prem_groups/:id

URL パラメータ

名前	型	説明
id	integer	オンプレミスグループの ID。

レスポンス

[
  {
    "id": 16803,
    "name": "CRM server",
    "created_at": "2017-09-21T01:51:45.954-07:00"
  }
]

オンプレミスグループの更新

オンプレミスグループを更新します。

PUT /on_prem_groups/:id

URL パラメータ

名前	型	説明
id	integer	オンプレミスグループの ID。

ペイロード

名前	型	説明
name	string	オンプレミスグループの名前。

サンプルリクエスト

curl  -X PUT 'https://www.workato.com/api/on_prem_groups/16803' \
      -H 'Authorization: Bearer <api_token>'
      -H 'Content-Type: application/json' \
      -d  '{
             "name":"CRM server"
          }'

レスポンス

[
  {
    "id": 16803,
    "name": "CRM server",
    "created_at": "2017-09-21T01:51:45.954-07:00"
  }
]

オンプレミスグループの削除

オンプレミスグループを削除します。このグループ内のすべてのオンプレミスエージェントが削除されます。

DELETE /on_prem_groups/:id

URL パラメータ

名前	型	説明
id	integer	オンプレミスグループの ID。

レスポンス

{
  "success": true
}

オンプレミスグループのステータスの取得

オンプレミスグループのステータスを取得します。

GET /on_prem_groups/:id/status

URL パラメータ

名前	型	説明
id	integer	オンプレミスグループの ID。

レスポンス

{
  "agent_count": 4,
  "active_agent_count": 3,
  "profiles": [
    {
      "name": "CRM-Oracle",
      "provider": "oracle",
      "type": "Database",
      "connections": [
        {
          "id": 440724,
          "name": "Oracle CRM DB"
        }
      ]
    }
  ]
}

オンプレミスエージェントの列挙

ワークスペース内のすべてのオンプレミスエージェントを列挙します。

GET /on_prem_agents

レスポンス

[
  {
    "id": 12233,
    "on_prem_group_id": 16803,
    "name": "primary agent",
    "cn": "134fd7acd89cf5b8b96deea4870d413d:12233",
    "os": "windows",
    "awaiting_setup": true,
    "enabled": true
  }
]

レスポンスのスキーマ

名前	説明
name	オンプレミスエージェントの名前。
os	サーバーのオペレーティングシステム。返される OS は、windows、linux、または mac になります。
on_prem_group_id	オンプレミスグループの ID。
awaiting_setup	エージェントが設定されていない場合は true になります。
enabled	エージェントが有効になっている場合は true になります。

オンプレミスエージェントの作成

オンプレミスエージェントを作成します。

POST /on_prem_agents

ペイロード

名前	型	説明
name	string	オンプレミスエージェントの名前。
os	string	サーバーのオペレーティングシステム。
on_prem_group_id	integer	オンプレミスグループの ID。詳細については、オンプレミスグループの列挙を参照してください。
awaiting_setup	boolean 任意	true エージェントを設定待機中状態で作成すべきかどうか。エージェントの設定をスキップして、そのステータスをただちに取得するには、false に設定します。

サンプルリクエスト

curl  -X POST 'https://www.workato.com/api/on_prem_agents' \
      -H 'Authorization: Bearer <api_token>'
      -H 'Content-Type: application/json' \
      -d  '{
              "name": "US-west-1",
              "on_prem_group_id": 50,
              "os": "windows",
              "awaiting_setup": false
           }'

レスポンス

[
  {
    "id": 12233,
    "on_prem_group_id": 16803,
    "name": "primary agent",
    "cn": "134fd7acd89cf5b8b96deea4870d413d:12233",
    "os": "windows",
    "awaiting_setup": false,
    "enabled": true
  }
]

オンプレミスエージェントの詳細の取得

オンプレミスエージェントについての詳細を取得します。

GET /on_prem_agents/:id

URL パラメータ

名前	型	説明
id	integer	オンプレミスエージェントの ID。

レスポンス

[
  {
    "id": 12233,
    "on_prem_group_id": 16803,
    "name": "primary agent",
    "cn": "134fd7acd89cf5b8b96deea4870d413d:12233",
    "os": "windows",
    "awaiting_setup": false,
    "enabled": true
  }
]

オンプレミスエージェントの更新

オンプレミスエージェントを更新します。

PUT /on_prem_agents/:id

URL パラメータ

名前	型	説明
id	integer	オンプレミスエージェントの ID。

ペイロード

名前	型	説明
name	string	オンプレミスエージェントの名前。
os	string	サーバーのオペレーティングシステム。
on_prem_group_id	integer	オンプレミスグループの ID。詳細については、オンプレミスグループの列挙を参照してください。

サンプルリクエスト

curl  -X POST 'https://www.workato.com/api/on_prem_agents/12233' \
      -H 'Authorization: Bearer <api_token>'
      -H 'Content-Type: application/json' \
      -d  '{
              "name": "primary agent"d
           }'

レスポンス

[
  {
    "id": 12233,
    "on_prem_group_id": 16803,
    "name": "primary agent",
    "cn": "134fd7acd89cf5b8b96deea4870d413d:12233",
    "os": "windows",
    "awaiting_setup": false,
    "enabled": true
  }
]

オンプレミスエージェントの削除

オンプレミスエージェントを削除します。

DELETE /on_prem_agents/:id

URL パラメータ

名前	型	説明
id	integer	オンプレミスエージェントの ID。

レスポンス

{
  "success": true
}

オンプレミスエージェントのステータスの取得

オンプレミスエージェントのステータスを取得します。

GET /on_prem_agents/:id/status

URL パラメータ

名前	型	説明
id	integer	オンプレミスエージェントの ID。

レスポンス

{
  "active": true
}

一般名でのオンプレミスエージェントの検索

一般名に一致するオンプレミスエージェントを取得します。

GET /on_prem_agents/search

URL パラメータ

名前	型	説明
cn	string	オンプレミスエージェントの一般名。

レスポンス

[
  {
    "id": 12233,
    "on_prem_group_id": 16803,
    "name": "primary agent",
    "cn": "134fd7acd89cf5b8b96deea4870d413d:12233",
    "os": "windows",
    "awaiting_setup": false,
    "enabled": true
  }
]