Product UpdatesStatus PageAutomation Institute
▼ English
Workato Embedded
Workato Embedded パートナー API
リソース

# Recipe lifecycle management

以下のリストに示すエンドポイントは、パッケージをカスタマーアカウントにインポートするための Workato Embedded ベンダー専用のエンドポイントです。

パッケージをエクスポートするための API はこちらから入手できます。独自の環境 (カスタマーアカウントではなく) にパッケージをインポートする場合は、Workato API ページに記載されるエンドポイントも使用してください。

# クイックリファレンス

タイプ リソース 説明
POST api/managed_users/:id/imports パッケージをカスタマーアカウント内のフォルダーにインポートします。
GET api/managed_users/:id/recipes インポートしたパッケージのステータスを取得します。

# カスタマーアカウントへのパッケージのインポート

カスタマーアカウント内の指定されたフォルダーにパッケージをインポートします。

POST /api/managed_users/:id/imports

これは、非同期リクエストです。パッケージステータスの取得エンドポイントを使用して、インポートしたパッケージの詳細を取得します。

入力 (zip ファイル) は、パッケージのコンテンツを含む application/octet-stream ペイロードです。インポート時に実行中のレシピを再起動する必要がある場合は、URL パラメータ restart_recipes を true に設定する必要があります。

# URL パラメータ

名前 型 説明
managed_user_id string
必須		 Workato Embedded カスタマーアカウント ID または外部 ID。
外部 ID は、E を先頭に付ける必要があります (例 : Ea2300)。結果として返される ID は URL エンコードされます。
folder_id string
必須		 フォルダー ID。
restart_recipes boolean
任意		 インポート中の実行中のレシピの再起動を許可するには、値を true にする必要があります。
実行中のレシピが存在し、このパラメータが false であるか、指定されなかった場合は、パッケージをインポートできません。

# サンプルリクエスト

curl  -X POST https://www.workato.com/api/managed_users/91928/imports?folder_id=1827 \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>' \
      -H 'Content-Type: application/octet-stream' \
      -F 'path/to/local/file.zip'

# レスポンス

{  
   "id":251,
   "operation_type":"import",
   "status":"completed"
}

# パッケージステータスの取得

カスタマーアカウントにインポートしたパッケージの詳細を取得します。

GET /api/managed_users/:id/imports/:package_id

# URL パラメータ

名前 型 説明
managed_user_id string
必須		 Workato Embedded カスタマーアカウント ID または外部 ID。
外部 ID は、E を先頭に付ける必要があります (例 : Ea2300)。結果として返される ID は URL エンコードされます。
package_id string
必須		 パッケージ ID。

# サンプルリクエスト

curl  -X GET https://www.workato.com/api/managed_users/91829/imports/198 \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>'

# レスポンス

  • これは完了したインポートの取得からのレスポンスを示しています。

NOTE

完了したインポートがある場合、各レシピの import_result も確認することが重要です。考えられる import_result の値については、こちらを参照してください。

{
   "id":242,
   "operation_type":"export",
   "status":"completed",
   "recipe_status":[
      {
            "id": 12345,
            "import_result": "no_update_or_update_without_restart"
      },
      {
            "id": 12346,
            "import_result": "restarted"
      },
      {
            "id": 12347,
            "import_result": "stopped"
      }
   ]
}
  • これは失敗したインポートの取得からのレスポンスを示しています。

NOTE

失敗したインポートがある場合、レシピの中にはインポートが失敗する前に更新されていないものもあるため、すべてのレシピが recipe_status で返されるわけではありません。考えられる import_result の値については、こちらを参照してください。

{  
   "id":198,
   "operation_type":"export",
   "status":"failed",
   "error":"error_message",
   "recipe_status":[
      {
            "id": 12345,
            "import_result": "no_update_or_update_without_restart"
      },
      {
            "id": 12346,
            "import_result": "restarted"
      },
      {
            "id": 12347,
            "import_result": "stopped"
      }
   ]
}

# レシピの import_result の値

合計6つの考えられる結果を以下に示します。

  1. no_update_or_update_without_restart - これは、レシピに再起動の必要がなかったことを示しています。レシピは再起動なしで更新できたか、更新が行われなかったかのどちらかです。 インポートは成功しました。
  2. not_found - レシピが見つからず、予期しないエラーが発生しました。このエラーはまれにしか発生しません。 インポートは失敗し、レシピの更新は行われませんでした。
  3. stop_failed - 再起動する必要のあるレシピに対して、レシピを停止しようとしました。この状態は、レシピを停止できなかったことを示しています。 インポートは失敗し、レシピの更新は行われませんでした。
  4. stopped - Workato はレシピを停止しましたが、レシピ内のエラーのためにレシピは再起動されませんでした。 インポートは失敗し、レシピは更新されましたが再起動されませんでした。
  5. restart_failed - Workato はレシピの再起動を試行しましたが、再起動できませんでした。 インポートは失敗し、レシピは更新されましたが再起動されませんでした。
  6. restarted - Workato は更新の後正常にレシピを再起動しました。 インポートは成功しました。
← レシピ
ロール →


Last updated: 2023/8/31 1:07:14

On this page