レシピライフサイクルマネジメント

次のエンドポイントはEmbeddedパートナーのみが使用できます。これらのエンドポイントを使用すると、エクスポートマニフェストをプログラムで作成および管理できます。これらのエンドポイントを使用して、1セットのAPI認証情報で顧客ワークスペースにパッケージをインポートしたり、顧客ワークスペースからパッケージをエクスポートしたりすることもできます。

独自のEnvironment（顧客ワークスペースではない）にパッケージをインポートしたり、独自のEnvironmentからパッケージをエクスポートしたりする場合は、Developer APIドキュメントに記載されているエンドポイントを使用します。

用語集

マニフェスト: レシピ、ルックアップテーブル、コネクションなど、さまざまなアセットのコンテナー。
パッケージ: マニフェストのビルド。マニフェスト内の各アセットのソースコードが含まれます。パッケージ作成時に利用可能なアセットの最新バージョンが含まれます。

レート制限

レシピライフサイクルマネジメントリソースには、次のレート制限があります:

タイプ	リソース	制限
POST	パッケージを顧客ワークスペースにインポート: /api/managed_users/:managed_user_id /imports	1分あたり1,000リクエスト
GET	パッケージインポートのステータスを取得: /api/managed_users/:managed_user_id /imports/:package_id	1分あたり1,000リクエスト
すべて	その他すべてのレシピライフサイクルマネジメントエンドポイント	1分あたり60リクエスト

クイックリファレンス

タイプ	リソース	説明
GET	/api/managed_users/:managed_user_id/ export_manifests/folder_assets	フォルダ内のアセットを表示します。
POST	/api/managed_users/:managed_user_id/export_manifests	エクスポートマニフェストを作成します。
PUT	/api/managed_users/:managed_user_id/export_manifests/:id	エクスポートマニフェストを更新します。
GET	/api/managed_users/:managed_user_id/export_manifests/:id	エクスポートマニフェストを表示します。
DELETE	/api/managed_users/:managed_user_id/export_manifests/:id	エクスポートマニフェストを削除します。
POST	/api/managed_users/:id/imports	顧客ワークスペース内のフォルダにパッケージをインポートします。
GET	/api/managed_users/:id/imports/:package_id	インポートされたパッケージのステータスを取得します。
POST	/api/managed_users/:managed_user_id/exports/:manifest_id	マニフェストIDに基づいてパッケージをエクスポートします。 Embeddedワークスペースが必要です。
GET	/api/managed_users/:managed_user_id/exports/:package_id	パッケージエクスポートのステータスを返します。 Embeddedワークスペースが必要です。

フォルダ内のアセットを表示する

フォルダ内のアセットを表示します。このエンドポイントを使用して、エクスポートマニフェストの作成または更新に役立てることができます。

GET /api/managed_users/:managed_user_id/export_manifests/folder_assets

URLパラメーター

名前	タイプ	説明
managed_user_id	string 必須	Embedded顧客のアカウントIDまたはExternal ID。 External IDはURLエンコードし、`E`をプレフィックスとして付ける必要があります（例: `EA2300`）。
folder_id	integer optional	アセットを含むフォルダのID。デフォルトはルートフォルダです。
include_test_cases	boolean optional	このパラメーターは、アセットのリストからテストケースを含めます。デフォルトは`false.`です。
include_data	boolean optional	このパラメーターは、アセットのリストからデータを含めます。デフォルトは`false.`です。

サンプルリクエスト

shell

curl  -X GET 'https://www.workato.com/api/managed_users/91928/export_manifests?folder_id=423' \
      -H 'Authorization: Bearer <api_token>'

レスポンス

json

{
  "result": {
    "assets": [
      {
        "id": 12,
        "name": "Copy of Recipeops",
        "type": "recipe",
        "version": 1,
        "folder": "",
        "absolute_path": "All projects",
        "root_folder": false,
        "unreachable": false,
        "zip_name": "copy_of_recipeops.recipe.json",
        "checked": true
      }
    ]
  }
}

エクスポートマニフェストを作成する

エクスポートマニフェストを作成します。

POST /api/managed_users/:managed_user_id/export_manifests

URLパラメーター

名前	タイプ	説明
managed_user_id	string 必須	EmbeddedカスタマーIDまたは外部ID。 External IDはURLエンコードし、`E`をプレフィックスとして付ける必要があります（例: `EA2300`）。

ペイロード

名前	タイプ	説明
name	string 必須	新しいマニフェストの名前。
assets	object required	依存アセット。 Workatoでは、このエンドポイントを使用する前に、フォルダ内のアセットを表示するエンドポイントのレスポンスを確認することを推奨しています。フォルダ内のアセットを表示するエンドポイントは、特定のフォルダ内のすべてのアセットを含む`assets`オブジェクトを返します。これにより、マニフェストに含める予定のアセットを識別して形式設定できます。
id	integer required	依存関係のID。
type	string 必須	依存アセットのタイプ。サポートされているすべての`type`値については、アセットタイプを参照してください。
checked	boolean optional	アセットをマニフェストに含めるかどうかを決定します。デフォルトは`true`です。
version	integer optional	アセットのバージョン。デフォルトは最新のバージョンです。
フォルダ	string 任意	アセットを含むフォルダ。デフォルトは`""`です。
absolute_path	string 任意	アセットの絶対パス。デフォルトはルートフォルダです。
root_folder	boolean optional	ルートフォルダに名前を付けます。デフォルトは`false`です。
unreachable	boolean optional	アセットに到達できないかどうか。デフォルトは`false`です。
zip_name	string 任意	エクスポートされたzipファイル内の名前。デフォルトでは、Workatoは次の構造で名前を自動生成します:`asset_#{index}.#{type}.json`。
folder_id	integer optional	アセットを含むフォルダのID。デフォルトはルートフォルダです。
auto_generate_assets	boolean optional	フォルダからアセットを自動生成します。デフォルトは`false.`です。
include_test_cases	boolean optional	このパラメータは、自動アセット生成からテストケースを含めます。デフォルトは`false.`です。
include_data	boolean optional	このパラメータは、自動アセット生成からデータを含めます。デフォルトは`false.`です。
auto_run	boolean optional	エクスポートパッケージの生成を自動的に開始します。デフォルトは`false.`です。
include_tags	boolean optional	アセットに割り当てられたタグをエクスポートマニフェストに含めるかどうかを指定します。 `false`に設定すると、タグはマニフェストから除外されます。デフォルトでは`false`に設定されます。

アセットタイプ

サポートされているアセットのtype値は次のとおりです:

recipe
connection
lookup_table
workato_db_table
account_property
project_property
workato_schema
workato_template
lcap_app
lcap_page
custom_adapter
topic
connection
recipe
api_group
api_endpoint

サンプルリクエスト

shell

curl  -X POST 'https://www.workato.com/api/managed_users/91928/export_manifests' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "export_manifest": {
              "name": "Test Manifest",
              "assets": [
                {
                  "id": 12,
                  "name": "Copy of Recipeops",
                  "type": "recipe",
                  "version": 1,
                  "folder": "",
                  "absolute_path": "All projects",
                  "root_folder": false,
                  "unreachable": false,
                  "zip_name": "copy_of_recipeops.recipe.json",
                  "checked": true
                }
              ],
              "folder_id": 112,
              "include_tags": true
            }
          }'

複数のアセットを含むマニフェストの作成

複数のアセットをassetsパラメーターに渡して、マニフェストに含めることができます。

サンプルリクエスト

shell

curl  -X POST 'https://www.workato.com/api/managed_users/45267/export_manifests' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "export_manifest": {
              "name": "Test Manifest with two assets",
              "assets": [
                {
                   "id": 65008167,
                   "name": "Outreach",
                   "type": "connection",
                   "version": null,
                   "folder": "API tests",
                   "absolute_path": "All projects/API tests",
                   "root_folder": false,
                   "provider": "outreach",
                   "unreachable": false,
                   "zip_name": "API tests/outreach.connection.json",
                   "deps": [],
                   "checked": true
                },
                {
                    "id": 86330482,
                    "name": "Test recipe",
                    "type": "recipe",
                    "version": 4,
                    "folder": "API tests",
                    "absolute_path": "All projects/API tests",
                    "root_folder": false,
                    "include_test_cases": false,
                    "unreachable": false,
                    "zip_name": "API tests/test_recipe.recipe.json",
                    "deps": [],
                    "checked": true
                  }
              ],
              "folder_id": 21339705,
              "include_tags": true
              }
            }'

レスポンス

json

{
    "result": {
        "id": 267546,
        "name": "Test Manifest with two assets",
        "created_at": "2025-03-21T07:50:29.488-07:00",
        "updated_at": "2025-03-21T07:50:29.488-07:00",
        "deleted_at": null,
        "last_exported_at": null,
        "project_path": "Home assets",
        "status": "working",
        "include_tags": true
    }
}

アセットを自動生成する

Workatoでアセットを自動生成する予定の場合は、リクエストのペイロードにauto_generate_assetsパラメータを渡すことができます。自動生成する予定のfolder_idを指定する必要があります。 include_test_casesまたはinclude_dataパラメーターを含めることで、テストケースとデータを含めることもできます。それ以外の場合、デフォルトで除外されます。さらに、ペイロードにauto_runを含めてパッケージを自動生成できます。

サンプルリクエスト

shell


curl  -X POST 'https://www.workato.com/api/managed_users/91928/export_manifests' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "export_manifest": {
              "name": "Test Manifest",
              "folder_id": 112,
              "auto_generate_assets": true,
              "include_test_cases": true,
              "include_data": true,
              "auto_run": true
            }
          }'

レスポンス

json

{
  "result": {
    "id": 12,
    "name": "Test Manifest",
    "last_exported_at": null,
    "created_at": "2023-02-27T02:44:59.447-08:00",
    "updated_at": "2023-02-27T02:44:59.447-08:00",
    "deleted_at": null,
    "project_path": "Folder 1",
    "status": "working"
  }
}

指定可能なステータス

Status	定義
`working`	アクティブ。
`archived`	削除済み。

エクスポートマニフェストを更新する

エクスポートマニフェストを更新します。

PUT /api/managed_users/:managed_user_id/export_manifests/:id

URLパラメータ

名前	タイプ	説明
id	string 必須	依存関係のID。
managed_user_id	string 必須	EmbeddedカスタマーIDまたは外部ID。 External IDはURLエンコードされ、`E`で始まる必要があります（例：`EA2300`）。

ペイロード

以前に定義したアセットを置き換えるには、assets[]に含まれるプロパティを更新します。

名前	タイプ	説明
name	string 任意	マニフェストの名前。マニフェスト名を変更するには、この値を更新します。デフォルトは以前の名前です。
assets	object required	依存アセット。 Workatoでは、このエンドポイントを使用する前に、フォルダ内のアセットを表示するエンドポイントのレスポンスを確認することを推奨しています。フォルダ内のアセットを表示するエンドポイントは、特定のフォルダ内のすべてのアセットを含む`assets`オブジェクトを返します。これにより、マニフェストで更新する予定のアセットを識別して形式設定できます。
id	integer required	依存関係のID。
type	string 必須	依存アセットのタイプ。サポートされているすべての`type`値については、アセットタイプを参照してください。
checked	boolean optional	アセットをマニフェストに含めるかどうかを決定します。デフォルトは`true`です。
version	integer optional	アセットのバージョン。デフォルトは最新のバージョンです。
フォルダ	string 任意	アセットを含むフォルダ。デフォルトは`""`です。
absolute_path	string 任意	アセットの絶対パス。デフォルトはルートフォルダです。
root_folder	boolean optional	ルートフォルダ名。デフォルトは`false`です。
unreachable	boolean optional	アセットに到達できないかどうか。デフォルトは`false`です。
zip_name	string 任意	エクスポートされたzipファイル内の名前。デフォルトでは、Workatoは次の構造で名前を自動生成します:`asset_#{index}.#{type}.json`。
folder_id	integer optional	アセットを含むフォルダのID。デフォルトはルートフォルダです。
auto_generate_assets	boolean optional	フォルダからアセットを自動生成します。デフォルトは`false.`です。
include_test_cases	boolean optional	自動生成アセットにテストケースを含めます。デフォルトは`false.`です。
include_data	boolean optional	自動生成アセットにデータを含めます。デフォルトは`false.`です。
auto_run	boolean optional	エクスポートパッケージの生成を自動的に開始します。デフォルトは`false.`です。

アセットタイプ

サポートされているアセットのtype値は次のとおりです:

recipe
connection
lookup_table
workato_db_table
account_property
project_property
workato_schema
workato_template
lcap_app
lcap_page
custom_adapter
topic
connection
recipe
api_group
api_endpoint

サンプルリクエスト

shell

curl  -X PUT 'https://www.workato.com/api/managed_users/91928/export_manifests/12' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "export_manifest": {
              "name": "Test Manifest",
              "assets": [
                {
                  "id": 12,
                  "name": "Copy of Recipeops",
                  "type": "recipe",
                  "version": 1,
                  "folder": "",
                  "absolute_path": "All projects",
                  "root_folder": false,
                  "unreachable": false,
                  "zip_name": "copy_of_recipeops.recipe.json",
                  "checked": true
                }
              ],
              "folder_id": 112
            }
          }
          '

複数のアセットを含むマニフェストの更新

複数のアセットをassetsパラメーターに渡して、マニフェスト内で更新できます。

サンプルリクエスト

shell

curl  -X POST 'https://www.workato.com/api/managed_users/91928/export_manifests/15' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "export_manifest": {
              "name": "Test Manifest with two assets",
              "assets": [
                {
                   "id": 65008167,
                   "name": "Outreach",
                   "type": "connection",
                   "version": null,
                   "folder": "API tests",
                   "absolute_path": "All projects/API tests",
                   "root_folder": false,
                   "provider": "outreach",
                   "unreachable": false,
                   "zip_name": "API tests/outreach.connection.json",
                   "deps": [],
                   "checked": true
                },
                {
                    "id": 86330482,
                    "name": "Test recipe",
                    "type": "recipe",
                    "version": 4,
                    "folder": "API tests",
                    "absolute_path": "All projects/API tests",
                    "root_folder": false,
                    "include_test_cases": false,
                    "unreachable": false,
                    "zip_name": "API tests/test_recipe.recipe.json",
                    "deps": [],
                    "checked": true
                  }
              ],
              "folder_id": 21339715
              }
            }'

レスポンス

json

{
    "result": {
        "id": 171350,
        "name": "Test Manifest with two assets",
        "created_at": "2025-03-19T07:45:50.915-07:00",
        "updated_at": "2025-03-21T09:26:46.348-07:00",
        "deleted_at": null,
        "last_exported_at": null,
        "project_path": "Home assets",
        "status": "working",
        "include_tags": true,
        "assets": [
            {
                "checked": true,
                "root_folder": false,
                "unreachable": false,
                "name": "Outreach",
                "zip_name": "API tests/outreach.connection.json",
                "id": 65008167,
                "type": "connection",
                "version": null,
                "folder": "API tests",
                "absolute_path": "All projects/API tests",
                "deps": []
            },
            {
                "checked": true,
                "root_folder": false,
                "unreachable": false,
                "name": "Test recipe",
                "zip_name": "API tests/test_recipe.recipe.json",
                "id": 86330482,
                "type": "recipe",
                "version": 4,
                "folder": "API tests",
                "absolute_path": "All projects/API tests",
                "include_test_cases": false,
                "deps": []
            }
        ],
        "diff_included": false
    }
}

アセットを自動生成する

サンプルリクエスト

shell


curl  -X PUT 'https://www.workato.com/api/managed_users/91928/export_manifests/12' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "export_manifest": {
              "name": "Test Manifest",
              "folder_id": 112,
              "auto_generate_assets": true,
              "include_test_cases": true,
              "include_data": true,
              "auto_run": true
            }
          }
          '

レスポンス

json

{
  "result": {
    "id": 12,
    "name": "Test Manifest",
    "last_exported_at": null,
    "created_at": "2023-02-27T02:44:59.447-08:00",
    "updated_at": "2023-02-27T02:44:59.447-08:00",
    "deleted_at": null,
    "project_path": "Folder 1",
    "status": "working"
  }
}

エクスポートマニフェストを表示する

エクスポートマニフェストを表示します。

GET /api/managed_users/:managed_user_id/export_manifests/:id

URLパラメータ

名前	タイプ	説明
id	string 必須	依存関係のID。
managed_user_id	string 必須	EmbeddedカスタマーIDまたは外部ID。 External IDはURLエンコードし、`E`をプレフィックスとして付ける必要があります（例: `EA2300`）。

サンプルリクエスト

shell

curl  -X GET 'https://www.workato.com/api/managed_users/91928/export_manifests/12' \
      -H 'Authorization: Bearer <api_token>'

レスポンス

json

{
  "result": {
    "id": 12,
    "name": "Test Manifest",
    "last_exported_at": null,
    "created_at": "2023-02-27T02:44:59.447-08:00",
    "updated_at": "2023-02-27T02:44:59.447-08:00",
    "deleted_at": null,
    "project_path": "Folder 1",
    "status": "working"
  }
}

エクスポートマニフェストを削除する

エクスポートマニフェストを削除します。

DELETE /api/managed_users/:managed_user_id/export_manifests/:id

URLパラメータ

名前	タイプ	説明
id	string 必須	エクスポートマニフェストID。
managed_user_id	string 必須	EmbeddedカスタマーIDまたは外部ID。 External IDはURLエンコードされ、`E`で始まる必要があります（例：`EA2300`）。

サンプルリクエスト

shell

curl  -X DELETE 'https://www.workato.com/managed_users/12345/api/export_manifests/12' \
      -H 'Authorization: Bearer <api_token>'

レスポンス

json

{
    "result": {
        "success": true,
        "status": "destroyed"
    }
}

顧客ワークスペースへのパッケージのインポート

zipファイル形式のパッケージを、顧客ワークスペース内の指定したフォルダにインポートします。このエンドポイントを使用すると、APIクライアントはパッケージのインポートを通じて、レシピ、ルックアップテーブル、イベントトピック、メッセージテンプレートなどのアセットを作成または更新できます。

POST /api/managed_users/:managed_user_id/imports

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

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

URLパラメーター

名前	タイプ	説明
managed_user_id	string 必須	EmbeddedカスタマーIDまたは外部ID。 External IDはURLエンコードし、`E`をプレフィックスとして付ける必要があります（例: `EA2300`）。

クエリパラメーター

名前	タイプ	説明
folder_id	string 必須	フォルダID。
restart_recipes	boolean optional	インポート中に実行中のレシピの再起動を許可するには、値を`true`にする必要があります。実行中のレシピがあり、このパラメータが`false`に等しい場合、または指定されていない場合、パッケージはインポートできません。
include_tags	boolean optional	パッケージをフォルダにインポートするときに、アセットに割り当てられたタグを保持するかどうかを指定します。 `false`に設定すると、タグはインポートから除外されます。デフォルトでは`false`に設定されます。
folder_id_for_home_assets	string conditionally required	ルートフォルダの代わりにアセットを保存するフォルダのID。指定するフォルダはAPIクライアントからアクセス可能である必要があり、ルートフォルダにすることはできません。デフォルトは`""`です。

FOLDER_ID_FOR_HOME_ASSETSは条件付きで必須です

次の場合、folder_id_for_home_assetsパラメータは必須です:

ルートフォルダのアセットを含むパッケージをインポートする場合。
顧客のワークスペースのHome assetsフォルダがHome assetsプロジェクトに変換されている。

詳細については、Home assetsプロジェクトセクションを参照してください。

サンプルリクエスト

shell

curl  -X POST 'https://www.workato.com/api/managed_users/91928/imports?folder_id=1827&include_tags=true' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/octet-stream' \
      -F 'path/to/local/file.zip'

レスポンス

json

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

パッケージインポートのステータスの取得

顧客ワークスペースにインポートされたパッケージの詳細を取得します。

GET /api/managed_users/:managed_user_id/imports/:package_id

URLパラメーター

名前	タイプ	説明
managed_user_id	string 必須	EmbeddedカスタマーIDまたは外部ID。外部IDには`E`のプレフィックスを付ける必要があり（例: `EA2300`）、結果のIDはURLエンコードする必要があります。
package_id	string 必須	パッケージID。

サンプルリクエスト

shell

curl  -X GET 'https://www.workato.com/api/managed_users/91829/imports/198' \
      -H 'Authorization: Bearer <api_token>'

成功したインポート

インポートが正常に完了すると、次のレスポンスが返されます。

インポート結果

完了したインポートでは、各レシピのimport_resultも確認することが重要です。指定可能なimport_result値の詳細を確認します。

json

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

失敗したインポート

インポートが失敗すると、次のレスポンスが返されます。

インポート結果

インポートに失敗した場合、インポートが失敗する前に更新されていない可能性があるため、すべてのレシピがrecipe_statusに返されるとは限りません。指定可能なimport_result値の詳細を確認します。

json

{
   "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つあります。

no_update_or_update_without_restart: レシピを再起動する必要がなかったことを示します。再起動なしでレシピを更新できたか、更新が行われませんでした。 成功したインポート
not_found: レシピが見つからない場合の予期しないエラーです。頻繁に発生するものではありません。 レシピが更新されず、インポートは失敗しました。
stop_failed: 再起動が必要なレシピについて、レシピの停止を試行します。この状態は、レシピを停止できなかったことを示します。 レシピが更新されず、インポートは失敗しました。
stopped: Workatoはレシピを停止しましたが、レシピ内のエラーが原因でレシピは再起動されませんでした。 レシピは更新されましたが再起動されず、インポートは失敗しました
restart_failed: Workatoはレシピの再起動を試行しましたが、失敗しました。 レシピは更新されましたが再起動されず、インポートは失敗しました
restarted: Workatoは更新後にレシピを正常に再起動しました。 成功したインポート

パッケージのエクスポート

マニフェストIDを使用してパッケージをエクスポートします。このエンドポイントにはEmbeddedワークスペースが必要です。

エクスポートされたパッケージの詳細を取得するには、エクスポートステータスの取得エンドポイントを使用します。

WARNING

このエンドポイントへの権限をAPIクライアントに付与すると、結果のzipファイルを調べることで、レシピ、ルックアップテーブル、イベントトピック、メッセージテンプレートなどの他のアセットを作成/更新する機能を間接的に付与することになります。

POST /api/managed_users/:managed_user_id/exports/:manifest_id

エクスポートマニフェスト作成時にタグを含める

エクスポートされたパッケージにタグを含めるには、エクスポートマニフェストを作成するエンドポイントを呼び出すときに、include_tags属性をtrueに設定します。

URLパラメーター

名前	タイプ	説明
managed_user_id	string 必須	Embedded顧客のアカウントIDまたはExternal ID。 External IDはURLエンコードされ、`E`で始まる必要があります（例：`EA2300`）。また、結果のIDもURLエンコードする必要があります。
manifest_id	string 必須	エクスポートする予定のマニフェストのID。

サンプルリクエスト

shell

curl  -X POST 'https://www.workato.com/api/managed_users/91829/exports/508' \
      -H 'Authorization: Bearer <api_token>'

レスポンス

json

{
  "id": 365,
  "operation_type": "export",
  "status": "in_progress",
  "include_tags": true,
  "export_manifest_id": 508,
  "download_url": null
}

ダウンロードURLを取得する

エクスポートステータスを監視するには、エクスポートステータスの取得エンドポイントを使用します。プロセスが完了すると、レスポンスでダウンロードURLを使用できるようになります。

エクスポートステータスの取得

エクスポートされたパッケージのステータスを返します。 Embeddedワークスペースが必要です。

GET /api/managed_users/:managed_user_id/exports/:package_id

URLパラメーター

名前	タイプ	説明
managed_user_id	string 必須	Embedded顧客のアカウントIDまたはExternal ID。 External IDはURLエンコードされ、`E`で始まる必要があります（例：`EA2300`）。また、結果のIDもURLエンコードする必要があります。
package_id	string 必須	パッケージのID。

サンプルリクエスト

shell

curl  -X GET 'https://www.workato.com/api/managed_users/91829/exports/370' \
      -H 'Authorization: Bearer <api_token>'

レスポンス

json

{
      "id":370,
      "operation_type":"export",
      "status":"completed",
      "export_manifest_id":513,
      "download_url":"https://www.workato-staging-assets.com/packages/zip_files/000/000/242/original/exportdemo.zip"
}

Last updated:

レシピライフサイクルマネジメント ​

レート制限 ​

クイックリファレンス ​

フォルダ内のアセットを表示する ​

URLパラメーター ​

サンプルリクエスト ​

レスポンス ​

エクスポートマニフェストを作成する ​

URLパラメーター ​

ペイロード ​

アセットタイプ ​

サンプルリクエスト ​

サンプルリクエスト ​

レスポンス ​

アセットを自動生成する ​

サンプルリクエスト ​

レスポンス ​

指定可能なステータス ​

エクスポートマニフェストを更新する ​

URLパラメータ ​

ペイロード ​

アセットタイプ ​

サンプルリクエスト ​

サンプルリクエスト ​

レスポンス ​

アセットを自動生成する ​

サンプルリクエスト ​

レスポンス ​

エクスポートマニフェストを表示する ​

URLパラメータ ​

サンプルリクエスト ​

レスポンス ​

エクスポートマニフェストを削除する ​

URLパラメータ ​

サンプルリクエスト ​

レスポンス ​

顧客ワークスペースへのパッケージのインポート ​

URLパラメーター ​

クエリパラメーター ​

サンプルリクエスト ​

レスポンス ​

パッケージインポートのステータスの取得 ​

URLパラメーター ​

サンプルリクエスト ​

レスポンス ​

成功したインポート ​

失敗したインポート ​

レシピのimport_result値 ​

パッケージのエクスポート ​

URLパラメーター ​

サンプルリクエスト ​

レスポンス ​

エクスポートステータスの取得 ​

URLパラメーター ​

サンプルリクエスト ​

レスポンス ​

レシピライフサイクルマネジメント

レート制限

クイックリファレンス

フォルダ内のアセットを表示する

URLパラメーター

サンプルリクエスト

レスポンス

エクスポートマニフェストを作成する

URLパラメーター

ペイロード

アセットタイプ

サンプルリクエスト

サンプルリクエスト

レスポンス

アセットを自動生成する

サンプルリクエスト

レスポンス

指定可能なステータス

エクスポートマニフェストを更新する

URLパラメータ

ペイロード

アセットタイプ

サンプルリクエスト

サンプルリクエスト

レスポンス

アセットを自動生成する

サンプルリクエスト

レスポンス

エクスポートマニフェストを表示する

URLパラメータ

サンプルリクエスト

レスポンス

エクスポートマニフェストを削除する

URLパラメータ

サンプルリクエスト

レスポンス

顧客ワークスペースへのパッケージのインポート

URLパラメーター

クエリパラメーター

サンプルリクエスト

レスポンス

パッケージインポートのステータスの取得

URLパラメーター

サンプルリクエスト

レスポンス

成功したインポート

失敗したインポート

レシピのimport_result値

パッケージのエクスポート

URLパラメーター

サンプルリクエスト

レスポンス

エクスポートステータスの取得

URLパラメーター

サンプルリクエスト

レスポンス