Product UpdatesStatus PageWorkato Academy
English
日本語
Get a trial
開発者用 API
リソース

オンプレミス 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オンプレミスエージェントを検索します。

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

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

shell
GET /on_prem_groups

レスポンス ​

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

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

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

shell
POST /on_prem_groups

ペイロード ​

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

サンプルリクエスト ​

shell
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"
          }'

レスポンス ​

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

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

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

shell
GET /on_prem_groups/:id

URL パラメータ ​

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

レスポンス ​

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

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

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

shell
PUT /on_prem_groups/:id

URL パラメータ ​

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

ペイロード ​

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

サンプルリクエスト ​

shell
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"
          }'

レスポンス ​

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

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

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

shell
DELETE /on_prem_groups/:id

URL パラメータ ​

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

レスポンス ​

json
{
  "success": true
}

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

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

shell
GET /on_prem_groups/:id/status

URL パラメータ ​

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

レスポンス ​

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

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

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

shell
GET /on_prem_agents

レスポンス ​

json
[
  {
    "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 になります。

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

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

shell
POST /on_prem_agents

ペイロード ​

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

サンプルリクエスト ​

shell
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
           }'

レスポンス ​

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

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

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

shell
GET /on_prem_agents/:id

URL パラメータ ​

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

レスポンス ​

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

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

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

shell
PUT /on_prem_agents/:id

URL パラメータ ​

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

ペイロード ​

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

サンプルリクエスト ​

shell
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
           }'

レスポンス ​

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

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

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

shell
DELETE /on_prem_agents/:id

URL パラメータ ​

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

レスポンス ​

json
{
  "success": true
}

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

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

shell
GET /on_prem_agents/:id/status

URL パラメータ ​

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

レスポンス ​

json
{
  "active": true
}

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

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

shell
GET /on_prem_agents/search

URL パラメータ ​

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

レスポンス ​

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

Last updated: