製品アップデートステータスページWorkato Academy
English
日本語
トライアルを開始
Developer API
リソース

XChange ​

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

このリソースを使用して、XChangeパッケージをプログラムで管理します。パッケージとバージョンの参照および作成、送信されたバージョンのレビューおよび承認、プライベートライブラリへの公開、ワークスペースへのパッケージの配布、共有リンクの管理、インストール分析の表示を行えます。

利用可能状況

XChange APIsは、XChangeが有効なワークスペースで利用できます。 XChangeへのオーナーまたはコントリビューターアクセス権がないワークスペースからのリクエストは404エラーを返します。

これらのエンドポイントにアクセスするために必要なAPIクライアント権限が有効になっていることを確認してください。

レート制限 ​

XChangeリソースには、次のレート制限があります:

タイプリソースクォータ
すべてすべてのXChangeエンドポイント1秒あたり60リクエスト

クイックリファレンス ​

タイプリソース説明
GET/api/xchange/packages呼び出し元に表示されるパッケージを一覧表示します。
GET/api/xchange/packages/:package_id/versionsパッケージのバージョンを一覧表示します。
GET/api/xchange/versions/:version_idパッケージバージョンを取得します。
PUT/api/xchange/versions/:version_idバージョンのメタデータを更新します。
POST/api/xchange/packages/import.zipから新しいパッケージをインポートします。
POST/api/xchange/packages/:package_id/versions/import.zipから新しいパッケージバージョンをインポートします。
GET/api/xchange/versions/:draft_id/version_draftバージョン作成ステータスを取得します。
GET/api/xchange/packages/versions/:version_id/exportバージョンの.zipダウンロードURLを取得します。
POST/api/xchange/versions/:version_id/approveパッケージバージョンを承認します。
POST/api/xchange/versions/:version_id/rejectパッケージバージョンを却下します。
POST/api/xchange/versions/:version_id/resetバージョンレビューをリセットします。
PUT/api/xchange/versions/:version_id/comment/:review_idレビューコメントを更新します。
PUT/api/xchange/packages/:package_id/versions/:version_id/publishバージョンを公開します。
PUT/api/xchange/packages/:package_id/versions/:version_id/unpublishバージョンを非公開にします。
GET/api/xchange/packages/:package_id/consumersパッケージのコンシューマーを一覧表示します。
POST/api/xchange/distributions配布バッチを作成してキューに入れます。
GET/api/xchange/distributions配布バッチを一覧表示します。
GET/api/xchange/distributions/:idIDで配布バッチを取得します。
POST/api/xchange/distributions/:id/retry_failedバッチ内の失敗した配布を再試行します。
GET/api/xchange/packages/:package_id/sharing/linksパッケージの共有リンクを一覧表示します。
POST/api/xchange/packages/:package_id/sharing/links共有リンクを作成します。
POST/api/xchange/packages/:package_id/sharing/links/:link_id/activate共有リンクを有効化します。
POST/api/xchange/packages/:package_id/sharing/links/:link_id/deactivate共有リンクを無効化します。
DELETE/api/xchange/packages/:package_id/sharing/links/:link_id共有リンクを削除します。
PUT/api/xchange/packages/:package_id/versions/:version_id/shareパッケージの共有リンクバージョンを設定します。
DELETE/api/xchange/packages/:package_id/versions/:version_id/shareパッケージの共有リンクバージョンをクリアします。
GET/api/xchange/packages/:package_id/statsパッケージのインストール統計を取得します。
GET/api/xchange/packages/:package_id/installationsワークスペースごとのインストールレポートを取得します。

参照と作成 ​

次のエンドポイントを使用すると、パッケージとバージョンの一覧表示、表示、作成、インポート、更新、およびバージョンエクスポートのダウンロードを行えます。

パッケージの一覧表示 ​

呼び出し元に表示されるパッケージを一覧表示します。

GET https://YOUR_DATA_CENTER/api/xchange/packages

クエリパラメーター ​

名前タイプ説明
statusstring
任意		バージョンまたは公開のステータスでパッケージをフィルタリングします。
builder_idnumber
optional		ビルダーユーザーIDでパッケージをフィルタリングします。
tenant_builder_idnumber
optional		テナントビルダーワークスペースIDでパッケージをフィルタリングします。
テキストstring
任意		名前でパッケージを検索します。
sortstring
任意		ソートの基準となるフィールド。降順でソートするには、先頭に-を追加します。
page[number]number
optional		ページ番号。
page[size]number
optional		ページごとの項目数。
サンプルリクエスト ​
shell
curl  -X GET 'https://YOUR_DATA_CENTER/api/xchange/packages?text=sales&page[number]=1&page[size]=100' \
      -H 'Authorization: Bearer <api_token>'
レスポンス ​
json
{
    "data": [
        {
            "id": "1d2e3f4a-5b6c-4d7e-8f90-a1b2c3d4e5f6",
            "name": "Sales automation",
            "description": "Recipes and connections for sales automation.",
            "is_own": true,
            "is_published": true,
            "last_version": {
                "version": "1.2.0",
                "status": "published",
                "release_notes": "- New: Invoice sync recipe.\n- Improved: Connection error messages.",
                "connectors": [
                    "salesforce",
                    "netsuite"
                ]
            },
            "latest_activity": {
                "user_id": 45231,
                "user_name": "Ariel",
                "event_type": "package_version_created",
                "timestamp": "2026-07-10T09:15:32.000-07:00"
            }
        },
        {
            "id": "2e3f4a5b-6c7d-4e8f-9a0b-1c2d3e4f5a6b",
            "name": "Marketing sync",
            "description": "Recipes for marketing and CRM sync.",
            "is_own": true,
            "is_published": false,
            "last_version": {
                "version": "1.0.0",
                "status": "pending_review",
                "release_notes": "- Added: Lead sync recipe.\n- Improved: Field mapping.",
                "connectors": [
                    "hubspot"
                ]
            },
            "latest_activity": {
                "user_id": 45455,
                "user_name": "Dana",
                "event_type": "package_version_created",
                "timestamp": "2026-08-20T10:05:00.000-07:00"
            }
        }
    ],
    "page": {
        "number": 1,
        "size": 100
    },
    "total": 2
}

パッケージのバージョンの一覧表示 ​

バージョンごとのインストール数とともに、パッケージのバージョンを一覧表示します。これらのカウントは、カウントのみの軽量サーフェスです。完全な統計サーフェスについては、パッケージインストール統計情報の取得を使用してください。

GET https://YOUR_DATA_CENTER/api/xchange/packages/:package_id/versions

URLパラメーター ​

名前タイプ説明
package_idstring
必須		パッケージのUUID。

クエリパラメーター ​

名前タイプ説明
builder_idnumber
optional		作成したビルダーでバージョンをフィルタリングします。
created_at_fromstring
任意		この日付以降に作成されたバージョンを返します。形式: YYYY-MM-DD。
created_at_tostring
任意		この日付以前に作成されたバージョンを返します。形式: YYYY-MM-DD。
exclude_rejectedboolean
optional		拒否されたバージョンをレスポンスから除外するには、trueに設定します。
page[number]number
optional		ページ番号。
page[size]number
optional		ページごとの項目数。
サンプルリクエスト ​
shell
curl  -X GET 'https://YOUR_DATA_CENTER/api/xchange/packages/:package_id/versions?exclude_rejected=true' \
      -H 'Authorization: Bearer <api_token>'
レスポンス ​
json
{
    "data": [
        {
            "id": "9f8c2b1e-4a6d-4c2f-9e3a-7b5d1c0a8f21",
            "version": "1.2.0",
            "status": "published",
            "release_notes": "- New: Invoice sync recipe.\n- Improved: Connection error messages.\n- Fixed: Timeout on large syncs.",
            "created_at": "2026-07-10T09:15:32.000-07:00",
            "last_installed_at": "2026-07-16T08:41:15.000-07:00",
            "installations": {
                "direct": 12,
                "private_library": 4,
                "sharing_link": 1
            }
        },
        {
            "id": "8e7d6c5b-4a3f-4c2d-9e1a-0b8c7d6e5f4a",
            "version": "1.1.0",
            "status": "approved",
            "release_notes": "- Added: Initial CRM sync recipe.",
            "created_at": "2026-06-02T09:00:00.000-07:00",
            "last_installed_at": null,
            "installations": {
                "direct": 0,
                "private_library": 0,
                "sharing_link": 0
            }
        }
    ],
    "max_installations_count": 12,
    "page": {
        "number": 1,
        "size": 100
    },
    "total": 2
}

パッケージバージョンの取得 ​

1つのバージョンを表示します。

GET https://YOUR_DATA_CENTER/api/xchange/versions/:version_id

URLパラメーター ​

名前タイプ説明
version_idstring
必須		バージョンのUUID。
サンプルリクエスト ​
shell
curl  -X GET 'https://YOUR_DATA_CENTER/api/xchange/versions/:version_id' \
      -H 'Authorization: Bearer <api_token>'
レスポンス ​

レスポンスには、バージョンがプライベートライブラリに公開されている場合にのみprivate_library_publicationが含まれます。

json
{
    "data": {
        "id": "9f8c2b1e-4a6d-4c2f-9e3a-7b5d1c0a8f21",
        "version": "1.2.0",
        "status": "published",
        "builder_id": 45231,
        "builder": {
            "id": 45231,
            "name": "Ariel",
            "avatar_url": "https://www.workato.com/assets/avatars/ariel.png"
        },
        "description": "Sales automation starter package.",
        "release_notes": "- New: Invoice sync recipe.\n- Improved: Connection error messages.\n- Fixed: Timeout on large syncs.",
        "created_at": "2026-07-10T09:15:32.000-07:00",
        "project_handles": ["sales-automation"],
        "content": {
            "counters": {
                "recipe": 6
            },
            "connectors": [
                "salesforce",
                "netsuite"
            ]
        },
        "package": {
            "id": "1d2e3f4a-5b6c-4d7e-8f90-a1b2c3d4e5f6",
            "name": "Sales automation",
            "description": "Recipes and connections for sales automation."
        },
        "projects": [
            {
                "id": 7801234,
                "name": "Sales automation",
                "folder_id": 27180380
            }
        ],
        "installations": {
            "direct": 12,
            "private_library": 4,
            "sharing_link": 1
        },
        "private_library_publication": {
            "id": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
            "card_description": "A starter package for sales automation.",
            "version": {
                "id": "9f8c2b1e-4a6d-4c2f-9e3a-7b5d1c0a8f21",
                "version": "1.2.0"
            }
        },
        "review": {
            "id": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
            "status": "approved",
            "comments": "Approved for distribution.",
            "updated_at": "2026-07-16T11:02:10.000-07:00",
            "author": {
                "id": 45301,
                "name": "Bola",
                "avatar_url": "https://www.workato.com/assets/avatars/bola.png"
            }
        }
    }
}

バージョンのメタデータの更新 ​

既存のバージョンの編集可能なメタデータを更新します。エンドポイントは完全なバージョンを再取得して返します。

PUT https://YOUR_DATA_CENTER/api/xchange/versions/:version_id

URLパラメーター ​

名前タイプ説明
version_idstring
必須		更新するバージョンのUUID。

ペイロード ​

version、description、release_notesのみが許可されます。エンドポイントはリクエスト本文内のその他のフィールドを無視します。

名前タイプ説明
versionstring
任意		バージョンラベル。例: 1.3.0。
説明string
任意		パッケージバージョンの説明。
release_notesstring
任意		バージョンのリリースノート。
サンプルリクエスト ​
shell
curl  -X PUT 'https://YOUR_DATA_CENTER/api/xchange/versions/:version_id' \
      -H 'Authorization: Bearer <api_token>' \
      -H "Content-Type: application/json" \
      -d '{
            "release_notes": "Adds the invoice sync recipe and fixes a connection timeout."
         }'
レスポンス ​

レスポンスは、パッケージバージョンを取得エンドポイントと同じ形式で完全なバージョンを返し、release_notesには更新が反映されます。レスポンスには、バージョンがプライベートライブラリに公開されている場合にのみprivate_library_publicationが含まれます。

json
{
    "data": {
        "id": "9f8c2b1e-4a6d-4c2f-9e3a-7b5d1c0a8f21",
        "version": "1.2.0",
        "status": "published",
        "builder_id": 45231,
        "builder": {
            "id": 45231,
            "name": "Ariel",
            "avatar_url": "https://www.workato.com/assets/avatars/ariel.png"
        },
        "description": "Sales automation starter package.",
        "release_notes": "Adds the invoice sync recipe and fixes a connection timeout.",
        "created_at": "2026-07-10T09:15:32.000-07:00",
        "project_handles": ["sales-automation"],
        "content": {
            "counters": {
                "recipe": 6
            },
            "connectors": [
                "salesforce",
                "netsuite"
            ]
        },
        "package": {
            "id": "1d2e3f4a-5b6c-4d7e-8f90-a1b2c3d4e5f6",
            "name": "Sales automation",
            "description": "Recipes and connections for sales automation."
        },
        "projects": [
            {
                "id": 7801234,
                "name": "Sales automation",
                "folder_id": 27180380
            }
        ],
        "installations": {
            "direct": 12,
            "private_library": 4,
            "sharing_link": 1
        },
        "private_library_publication": {
            "id": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
            "card_description": "A starter package for sales automation.",
            "version": {
                "id": "9f8c2b1e-4a6d-4c2f-9e3a-7b5d1c0a8f21",
                "version": "1.2.0"
            }
        },
        "review": {
            "id": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
            "status": "approved",
            "comments": "Approved for distribution.",
            "updated_at": "2026-07-16T11:02:10.000-07:00",
            "author": {
                "id": 45301,
                "name": "Bola",
                "avatar_url": "https://www.workato.com/assets/avatars/bola.png"
            }
        }
    }
}

.zipから新しいパッケージをインポート ​

.zipを完全に新規のパッケージとその最初のバージョンとしてインポートします。エンドポイントはファイル拡張子と100 MBのサイズ上限を同期的に検証し、その後、非同期インポートジョブをステージングしてキューに入れます。バージョン作成ステータスの取得でジョブの進行状況をポーリングします。

nameパラメーターはありません。ドラフトパッケージ名はアップロードされたファイル名から取得されます。 versionを省略した場合、デフォルトはv1.0です。

POST https://YOUR_DATA_CENTER/api/xchange/packages/import

リクエスト本文 ​

リクエストをmultipart/form-dataとして送信します。

名前タイプ説明
filefile
required		パッケージの.zipファイル。最大サイズは100 MBです。
versionstring
任意		最初のバージョンのバージョンラベル。デフォルトはv1.0です。
説明string
任意		パッケージの説明。
release_notesstring
任意		最初のバージョンのリリースノート。
サンプルリクエスト ​
shell
curl  -X POST 'https://YOUR_DATA_CENTER/api/xchange/packages/import' \
      -H 'Authorization: Bearer <api_token>' \
      -F 'file=@/path/to/marketing_sync.zip' \
      -F 'version=v1.0' \
      -F 'description=Recipes for marketing and CRM sync.'
レスポンス ​

レスポンスは新しいドラフトのIDと、そのステータスをポーリングするためのリンクを返します。インポートを監視するには、バージョン作成ステータスを取得を使用します。

json
{
    "data": {
        "version_draft_id": 1576,
        "link": "/api/xchange/versions/1576/version_draft"
    }
}

.zipから新しいパッケージバージョンをインポート ​

完全に新規のパッケージインポートと同じ非同期パイプラインを使用して、.zipを既存パッケージの新しいバージョンとしてインポートします。

POST https://YOUR_DATA_CENTER/api/xchange/packages/:package_id/versions/import

必須バージョン

このエンドポイントにはversionが必須です。 versionがない場合、ドラフトが作成される前に400エラーが返されます。アクセスできない、または不明なpackage_idは404エラーを返します。

URLパラメーター ​

名前タイプ説明
package_idstring
必須		バージョンを追加するパッケージのUUID。

リクエスト本文 ​

リクエストをmultipart/form-dataとして送信します。

名前タイプ説明
filefile
required		パッケージの.zipファイル。最大サイズは100 MBです。
versionstring
必須		バージョンラベル。例: 1.3.0。
説明string
任意		バージョンの説明。
release_notesstring
任意		バージョンのリリースノート。
サンプルリクエスト ​
shell
curl  -X POST 'https://YOUR_DATA_CENTER/api/xchange/packages/:package_id/versions/import' \
      -H 'Authorization: Bearer <api_token>' \
      -F 'file=@/path/to/sales_automation_v1.3.zip' \
      -F 'version=1.3.0' \
      -F 'release_notes=Adds the invoice sync recipe.'
レスポンス ​

成功すると、レスポンスは.zipから新しいパッケージをインポートと同じ形式を返します。 versionがない場合は、代わりに400エラーが返されます。

json
{
    "errors": [
        {
            "code": 400,
            "title": "A version is required"
        }
    ]
}

バージョン作成ステータスの取得 ​

.zipインポートによって作成されたバージョンドラフトのステータスをポーリングします。レスポンスはドラフトステータスのみを返します。生成されたアセットの内容やdiffは含まれません。

GET https://YOUR_DATA_CENTER/api/xchange/versions/:draft_id/version_draft

ドラフトの所有権

ドラフトは呼び出し元のEnvironmentとビルダーにスコープ設定されます。現在のEnvironmentで呼び出し元が所有していないドラフトは404エラーを返します。

URLパラメーター ​

名前タイプ説明
draft_idinteger
required		インポートエンドポイントによって返されるversion_draft_id。
サンプルリクエスト ​
shell
curl  -X GET 'https://YOUR_DATA_CENTER/api/xchange/versions/:draft_id/version_draft' \
      -H 'Authorization: Bearer <api_token>'
レスポンス ​

error_messageは、statusがfailedの場合にのみ入力されます。

json
{
    "data": {
        "version_draft_id": 1576,
        "status": "completed",
        "error_message": null,
        "package_id": "01a086c1-ae0a-7057-b66b-ee4d6b66467c",
        "version_id": "01a0b04e-e2d4-7694-855a-94aa08a4071e"
    }
}

バージョン.zipダウンロードURLの取得 ​

パッケージバージョンの.zip用に、有効期間の短い署名済みダウンロードURLを取得します。 APIはファイルを直接ストリーミングしません。ダウンロードに使用できるURLを返します。

GET https://YOUR_DATA_CENTER/api/xchange/packages/versions/:version_id/export

URLパラメーター ​

名前タイプ説明
version_idstring
必須		エクスポートするバージョンのUUID。
サンプルリクエスト ​
shell
curl  -X GET 'https://YOUR_DATA_CENTER/api/xchange/packages/versions/:version_id/export' \
      -H 'Authorization: Bearer <api_token>'
レスポンス ​
json
{
    "data": {
        "version_id": "01a086d3-de39-7e8a-85c2-35437eed7de4",
        "download_url": "https://file-storage.workato.com/sharing/files?sign=eyJ0eXAiOiJKV1QiLCJhbGciOiJFUzI1NiJ9...<truncated>"
    }
}

レビューと承認 ​

次のエンドポイントを使用すると、パッケージオーナーは送信されたバージョンを承認、拒否、リセット、またはコメントできます:

パッケージバージョンの承認 ​

送信されたパッケージバージョンを承認します。

POST https://YOUR_DATA_CENTER/api/xchange/versions/:version_id/approve

自己レビュー制限

ハブで自動承認が有効になっていない限り、ビルダーは自分のパッケージバージョンを承認または拒否できません。自己レビューの試行は404エラーを返します。

URLパラメーター ​

名前タイプ説明
version_idstring
必須		承認するパッケージバージョンのUUID。

ペイロード ​

名前タイプ説明
commentsstring
必須		承認とともに記録するレビューコメント。

サンプルリクエスト ​

shell
curl  -X POST 'https://YOUR_DATA_CENTER/api/xchange/versions/:version_id/approve' \
      -H 'Authorization: Bearer <api_token>' \
      -H "Content-Type: application/json" \
      -d '{
            "comments": "Approved for distribution."
         }'

レスポンス ​

レスポンスは完全なパッケージバージョンを返します。レスポンスには、バージョンがプライベートライブラリに公開されている場合にのみprivate_library_publicationが含まれます。

json
{
    "data": {
        "id": "9f8c2b1e-4a6d-4c2f-9e3a-7b5d1c0a8f21",
        "version": "1.2.0",
        "status": "approved",
        "builder_id": 45231,
        "description": "Sales automation starter package.",
        "release_notes": "Adds the invoice sync recipe.",
        "created_at": "2026-07-10T09:15:32.000-07:00",
        "project_handles": ["sales-automation"],
        "package": {
            "id": "1d2e3f4a-5b6c-4d7e-8f90-a1b2c3d4e5f6",
            "name": "Sales automation",
            "description": "Recipes and connections for sales automation."
        },
        "content": {
            "counters": {},
            "connectors": []
        },
        "projects": [
            {
                "id": 7801234,
                "name": "Sales automation",
                "folder_id": 27180380
            }
        ],
        "installations": {
            "direct": 12,
            "private_library": 4,
            "sharing_link": 1
        },
        "review": {
            "id": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
            "status": "approved",
            "comments": "Approved for distribution.",
            "updated_at": "2026-07-16T11:02:10.000-07:00",
            "author": {
                "id": 45301,
                "name": "Bola",
                "avatar_url": "https://www.workato.com/assets/avatars/bola.png"
            }
        },
        "builder": {
            "id": 45231,
            "name": "Ariel",
            "avatar_url": "https://www.workato.com/assets/avatars/ariel.png"
        }
    }
}

パッケージバージョンの拒否 ​

送信されたパッケージバージョンを拒否します。

POST https://YOUR_DATA_CENTER/api/xchange/versions/:version_id/reject

自己レビュー制限

ハブで自動承認が有効になっていない限り、ビルダーは自分のパッケージバージョンを承認または拒否できません。自己レビューの試行は404エラーを返します。

URLパラメーター ​

名前タイプ説明
version_idstring
必須		拒否するパッケージバージョンのUUID。

ペイロード ​

名前タイプ説明
commentsstring
必須		拒否とともに記録するレビューコメント。

サンプルリクエスト ​

shell
curl  -X POST 'https://YOUR_DATA_CENTER/api/xchange/versions/:version_id/reject' \
      -H 'Authorization: Bearer <api_token>' \
      -H "Content-Type: application/json" \
      -d '{
            "comments": "Update the connection descriptions before you resubmit."
         }'

レスポンス ​

レスポンスはパッケージバージョンの承認エンドポイントと同じ形式で完全なパッケージバージョンを返し、バージョンとレビューステータスには拒否が反映されます。

バージョンレビューのリセット ​

送信されたバージョンのレビューをレビュー前の状態にリセットします。リクエストには本文がありません。

POST https://YOUR_DATA_CENTER/api/xchange/versions/:version_id/reset

URLパラメーター ​

名前タイプ説明
version_idstring
必須		リセットするバージョンのUUID。
サンプルリクエスト ​
shell
curl  -X POST 'https://YOUR_DATA_CENTER/api/xchange/versions/:version_id/reset' \
      -H 'Authorization: Bearer <api_token>'

レビューコメントの更新 ​

既存のレビューコメントを更新します。

PUT https://YOUR_DATA_CENTER/api/xchange/versions/:version_id/comment/:review_id

URLパラメーター ​

名前タイプ説明
version_idstring
必須		バージョンのUUID。
review_idstring
必須		更新するレビューのID。

ペイロード ​

名前タイプ説明
commentsstring
必須		更新されたレビューコメント。
サンプルリクエスト ​
shell
curl  -X PUT 'https://YOUR_DATA_CENTER/api/xchange/versions/:version_id/comment/:review_id' \
      -H 'Authorization: Bearer <api_token>' \
      -H "Content-Type: application/json" \
      -d '{
            "comments": "Approved. Nice work on the connection cleanup."
         }'

プライベートライブラリ ​

次のエンドポイントを使用すると、パッケージオーナーはDiscovery Layerのプライベートライブラリにバージョンを公開または非公開にできます。

バージョンの公開 ​

承認済みバージョンをプライベートライブラリに公開します。

PUT https://YOUR_DATA_CENTER/api/xchange/packages/:package_id/versions/:version_id/publish

URLパラメーター ​

名前タイプ説明
package_idstring
必須		パッケージのUUID。
version_idstring
必須		公開するバージョンのUUID。

ペイロード ​

名前タイプ説明
card_descriptionstring
任意		パッケージのプライベートライブラリカードに表示される説明。
サンプルリクエスト ​
shell
curl  -X PUT 'https://YOUR_DATA_CENTER/api/xchange/packages/:package_id/versions/:version_id/publish' \
      -H 'Authorization: Bearer <api_token>' \
      -H "Content-Type: application/json" \
      -d '{
            "card_description": "A starter package for sales automation."
         }'
レスポンス ​

レスポンスは、private_library_publicationオブジェクトを含む完全なバージョンを返します。

json
{
    "data": {
        "id": "9f8c2b1e-4a6d-4c2f-9e3a-7b5d1c0a8f21",
        "version": "1.2.0",
        "status": "published",
        "builder_id": 45231,
        "builder": {
            "id": 45231,
            "name": "Ariel",
            "avatar_url": "https://www.workato.com/assets/avatars/ariel.png"
        },
        "description": "Sales automation starter package.",
        "release_notes": "- New: Invoice sync recipe.\n- Improved: Connection error messages.\n- Fixed: Timeout on large syncs.",
        "created_at": "2026-07-10T09:15:32.000-07:00",
        "project_handles": ["sales-automation"],
        "content": {
            "counters": {
                "recipe": 6
            },
            "connectors": [
                "salesforce",
                "netsuite"
            ]
        },
        "package": {
            "id": "1d2e3f4a-5b6c-4d7e-8f90-a1b2c3d4e5f6",
            "name": "Sales automation",
            "description": "Recipes and connections for sales automation."
        },
        "projects": [
            {
                "id": 7801234,
                "name": "Sales automation",
                "folder_id": 27180380
            }
        ],
        "installations": {
            "direct": 12,
            "private_library": 4,
            "sharing_link": 1
        },
        "private_library_publication": {
            "id": "4d5e6f7a-8b9c-4d0e-8f1a-2b3c4d5e6f7a",
            "card_description": "A starter package for sales automation.",
            "version": {
                "id": "9f8c2b1e-4a6d-4c2f-9e3a-7b5d1c0a8f21",
                "version": "1.2.0"
            }
        },
        "review": {
            "id": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
            "status": "approved",
            "comments": "Approved for distribution.",
            "updated_at": "2026-07-16T11:02:10.000-07:00",
            "author": {
                "id": 45301,
                "name": "Bola",
                "avatar_url": "https://www.workato.com/assets/avatars/bola.png"
            }
        }
    }
}

バージョンの非公開 ​

パッケージのプライベートライブラリ公開を削除します。既存のインストールは残ります。

PUT https://YOUR_DATA_CENTER/api/xchange/packages/:package_id/versions/:version_id/unpublish

URLパラメーター ​

名前タイプ説明
package_idstring
必須		パッケージのUUID。
version_idstring
必須		公開済みバージョンのUUID。
サンプルリクエスト ​
shell
curl  -X PUT 'https://YOUR_DATA_CENTER/api/xchange/packages/:package_id/versions/:version_id/unpublish' \
      -H 'Authorization: Bearer <api_token>'
レスポンス ​

レスポンスは、statusがapprovedに戻され、private_library_publicationが削除された完全なバージョンを返します。

json
{
    "data": {
        "id": "9f8c2b1e-4a6d-4c2f-9e3a-7b5d1c0a8f21",
        "version": "1.2.0",
        "status": "approved",
        "builder_id": 45231,
        "builder": {
            "id": 45231,
            "name": "Ariel",
            "avatar_url": "https://www.workato.com/assets/avatars/ariel.png"
        },
        "description": "Sales automation starter package.",
        "release_notes": "- New: Invoice sync recipe.\n- Improved: Connection error messages.\n- Fixed: Timeout on large syncs.",
        "created_at": "2026-07-10T09:15:32.000-07:00",
        "project_handles": ["sales-automation"],
        "content": {
            "counters": {
                "recipe": 6
            },
            "connectors": [
                "salesforce",
                "netsuite"
            ]
        },
        "package": {
            "id": "1d2e3f4a-5b6c-4d7e-8f90-a1b2c3d4e5f6",
            "name": "Sales automation",
            "description": "Recipes and connections for sales automation."
        },
        "projects": [
            {
                "id": 7801234,
                "name": "Sales automation",
                "folder_id": 27180380
            }
        ],
        "installations": {
            "direct": 12,
            "private_library": 4,
            "sharing_link": 1
        },
        "review": {
            "id": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f",
            "status": "approved",
            "comments": "Approved for distribution.",
            "updated_at": "2026-07-16T11:02:10.000-07:00",
            "author": {
                "id": 45301,
                "name": "Bola",
                "avatar_url": "https://www.workato.com/assets/avatars/bola.png"
            }
        }
    }
}

直接配布 ​

次のエンドポイントを使用すると、パッケージオーナーはバージョンをワークスペースに一括配布し、パッケージを利用しているユーザーを一覧表示できます:

パッケージコンシューマーの一覧表示 ​

パッケージのコンシューマーを返します。インストールステータスでコンシューマーをフィルタリングし、名前または外部IDで検索できます。

GET https://YOUR_DATA_CENTER/api/xchange/packages/:package_id/consumers

URLパラメーター ​

名前タイプ説明
package_idstring
必須		パッケージのUUID。

クエリパラメーター ​

名前タイプ説明
installation_statusstring
任意		インストールステータスでコンシューマーをフィルタリングします。受け入れられる値: not_installed、installed。
version_idstring
任意		パッケージバージョンのUUID。 installation_statusがinstalledに設定されている場合に必須です。
テキストstring
任意		名前または外部IDでコンシューマーを検索します。
page[number]number
optional		ページ番号。
page[size]number
optional		ページごとの項目数。最大は500です。
サンプルリクエスト ​

このサンプルリクエストは、特定のバージョンをインストールしたパッケージのコンシューマーを取得します。

shell
curl  -X GET 'https://YOUR_DATA_CENTER/api/xchange/packages/:package_id/consumers?installation_status=installed&version_id=:version_id' \
      -H 'Authorization: Bearer <api_token>'
レスポンス ​

コンシューマーがレスポンスに含まれるには、avatar_urlおよびexternal_idパラメーターが設定されている必要があります。

json
{
    "data": [
        {
            "id": 45231,
            "name": "Acme West",
            "avatar_url": "https://www.workato.com/assets/avatars/acme-west.png",
            "external_id": "acme-west-01"
        },
        {
            "id": 45232,
            "name": "Acme East"
        }
    ],
    "page": {
        "number": 1,
        "size": 100,
        "total": 2
    }
}

配布バッチの作成 ​

パッケージバージョンの配布バッチを作成し、処理のためにキューに入れます。

POST https://YOUR_DATA_CENTER/api/xchange/distributions

ペイロード ​

名前タイプ説明
version_idstring
必須		配布するパッケージバージョンのUUID。
environment_ids整数の配列
必須		ターゲットEnvironmentのID。
サンプルリクエスト ​

次のサンプルリクエストは、パッケージバージョンを2つのターゲットEnvironmentに配布します:

shell
curl  -X POST 'https://YOUR_DATA_CENTER/api/xchange/distributions' \
      -H 'Authorization: Bearer <api_token>' \
      -H "Content-Type: application/json" \
      -d '{
            "version_id": ":version_id",
            "environment_ids": [40012, 40018]
         }'
レスポンス ​

エンドポイントは、新しいバッチのUUIDを含む201レスポンスを返します。バッチステータスを監視するには、IDによる配布バッチの取得エンドポイントを使用します。

json
{
    "data": {
        "id": "6b7c8d9e-0f1a-4b2c-9d3e-4f5a6b7c8d9e"
    }
}

配布バッチの一覧表示 ​

配布バッチの一覧を返します。任意でパッケージにスコープ設定できます。

GET https://YOUR_DATA_CENTER/api/xchange/distributions

クエリパラメーター ​

名前タイプ説明
package_idstring
任意		パッケージのUUID。すべてのパッケージにわたってバッチを一覧表示するには、このパラメーターを省略します。
version_idstring
任意		パッケージバージョンのUUID。
fromtimestamp
optional		このISO 8601タイムスタンプより後に作成されたバッチを返します。
totimestamp
optional		このISO 8601タイムスタンプより前に作成されたバッチを返します。
statusstring
任意		ステータスでバッチをフィルタリングします。受け入れられる値: pending、in_progress、completed。
activeboolean
optional		pendingおよびin_progressのバッチのみを返すには、trueに設定します。
page[number]number
optional		ページ番号。
page[size]number
optional		ページごとの項目数。
サンプルリクエスト ​

次のサンプルリクエストは、パッケージバージョンのアクティブな配布バッチを取得します:

shell
curl  -X GET 'https://YOUR_DATA_CENTER/api/xchange/distributions?version_id=:version_id&active=true' \
      -H 'Authorization: Bearer <api_token>'
レスポンス ​
json
{
    "data": [
        {
            "id": "6b7c8d9e-0f1a-4b2c-9d3e-4f5a6b7c8d9e",
            "version_id": "9f8c2b1e-4a6d-4c2f-9e3a-7b5d1c0a8f21",
            "version": "1.2.0",
            "status": "in_progress",
            "target_workspaces": {
                "total": 2,
                "pending": 1,
                "completed": 1,
                "failed": 0
            },
            "created_at": "2026-07-16T08:30:00.000-07:00"
        }
    ],
    "page": {
        "number": 1,
        "size": 100,
        "total": 1
    }
}

IDによる配布バッチの取得 ​

配布バッチを返します。任意でターゲットごとの配布詳細を含めることができます。

GET https://YOUR_DATA_CENTER/api/xchange/distributions/:id

URLパラメーター ​

名前タイプ説明
idstring
必須		配布バッチのUUID。

クエリパラメーター ​

名前タイプ説明
include_detailsboolean
optional		ターゲットごとの配布詳細をレスポンスに含めるには、trueに設定します。
page[number]number
optional		詳細リストのページ番号。 include_detailsがtrueに設定されている場合にのみ適用されます。
page[size]number
optional		ページあたりの詳細数。 include_detailsがtrueに設定されている場合にのみ適用されます。
サンプルリクエスト ​

次のサンプルリクエストは、ターゲットごとの詳細を含む配布バッチを取得します:

shell
curl  -X GET 'https://YOUR_DATA_CENTER/api/xchange/distributions/:id?include_details=true' \
      -H 'Authorization: Bearer <api_token>'
レスポンス ​

レスポンスには、include_detailsがtrueに設定されている場合にのみ、details配列とトップレベルのpageおよびtotalフィールドが含まれます。各詳細には、詳細ステータスがfailedの場合にのみerrorが含まれます。

json
{
    "data": {
        "id": "6b7c8d9e-0f1a-4b2c-9d3e-4f5a6b7c8d9e",
        "version_id": "9f8c2b1e-4a6d-4c2f-9e3a-7b5d1c0a8f21",
        "version": "1.2.0",
        "status": "completed",
        "target_workspaces": {
            "total": 2,
            "pending": 0,
            "completed": 1,
            "failed": 1
        },
        "created_at": "2026-07-16T08:30:00.000-07:00",
        "details": [
            {
                "id": "0a1b2c3d-4e5f-4a6b-8c7d-8e9f0a1b2c3d",
                "environment_id": 40012,
                "environment_name": "Acme West - prod",
                "environment_external_id": "acme-west-01",
                "status": "completed",
                "updated_at": "2026-07-16T08:41:15.000-07:00"
            },
            {
                "id": "5f6a7b8c-9d0e-4f1a-8b2c-3d4e5f6a7b8c",
                "environment_id": 40018,
                "environment_name": "Acme East - prod",
                "environment_external_id": "acme-east-01",
                "status": "failed",
                "error": "Connector version conflict in the target environment.",
                "updated_at": "2026-07-16T08:42:03.000-07:00"
            }
        ]
    },
    "page": 1,
    "total": 2
}

失敗した配布の再試行 ​

バッチ内の失敗した配布を再試行し、処理のために再度キューに入れます。バッチに失敗した配布が含まれていない場合、エンドポイントは422エラーを返します。

POST https://YOUR_DATA_CENTER/api/xchange/distributions/:id/retry_failed

URLパラメーター ​

名前タイプ説明
idstring
必須		配布バッチのUUID。
サンプルリクエスト ​
shell
curl  -X POST 'https://YOUR_DATA_CENTER/api/xchange/distributions/:id/retry_failed' \
      -H 'Authorization: Bearer <api_token>'
レスポンス ​
json
{
    "data": {
        "id": "6b7c8d9e-0f1a-4b2c-9d3e-4f5a6b7c8d9e"
    }
}

次のエンドポイントを使用すると、パッケージオーナーはパッケージの共有リンクと共有リンクバージョンを管理できます:

パッケージの共有リンクを一覧表示します。

GET https://YOUR_DATA_CENTER/api/xchange/packages/:package_id/sharing/links
名前タイプ説明
package_idstring
必須		パッケージのUUID。
名前タイプ説明
statusstring
任意		ステータスでリンクをフィルタリングします。受け入れられる値: active、inactive。
created_bynumber
optional		リンク作成者の数値ユーザーID。
page[number]number
optional		ページ番号。
page[size]number
optional		ページごとの項目数。
shell
curl  -X GET 'https://YOUR_DATA_CENTER/api/xchange/packages/:package_id/sharing/links?status=active' \
      -H 'Authorization: Bearer <api_token>'

1つの公開リンク、または1つ以上のワークスペーススコープのリンクを作成します。

POST https://YOUR_DATA_CENTER/api/xchange/packages/:package_id/sharing/links

公開とワークスペースリンク

nameはpublicリンクでは必須で、workspaceリンクでは拒否されます。 workspace_idsはworkspaceリンクでは必須で最大200件まで指定でき、publicリンクでは拒否されます。

名前タイプ説明
package_idstring
必須		パッケージのUUID。
名前タイプ説明
kindstring
必須		作成するリンクのタイプ。受け入れられる値: public、workspace。
namestring
publicリンクでは必須		公開リンクの名前。
workspace_idsarray of integers
workspaceリンクでは必須		リンクを作成するワークスペースID。最大200。
shell
curl  -X POST 'https://YOUR_DATA_CENTER/api/xchange/packages/:package_id/sharing/links' \
      -H 'Authorization: Bearer <api_token>' \
      -H "Content-Type: application/json" \
      -d '{
            "kind": "public",
            "name": "Sales automation - partner preview"
         }'

リンクのステータスをactiveに設定します。結果を変更せずに、このエンドポイントを複数回呼び出すことができます。

POST https://YOUR_DATA_CENTER/api/xchange/packages/:package_id/sharing/links/:link_id/activate
名前タイプ説明
package_idstring
必須		パッケージのUUID。
link_idstring
必須		共有リンクのID。
shell
curl  -X POST 'https://YOUR_DATA_CENTER/api/xchange/packages/:package_id/sharing/links/:link_id/activate' \
      -H 'Authorization: Bearer <api_token>'

リンクのステータスをinactiveに設定します。結果を変更せずに、このエンドポイントを複数回呼び出すことができます。

POST https://YOUR_DATA_CENTER/api/xchange/packages/:package_id/sharing/links/:link_id/deactivate
名前タイプ説明
package_idstring
必須		パッケージのUUID。
link_idstring
必須		共有リンクのID。
shell
curl  -X POST 'https://YOUR_DATA_CENTER/api/xchange/packages/:package_id/sharing/links/:link_id/deactivate' \
      -H 'Authorization: Bearer <api_token>'

共有リンクを完全に削除します。

DELETE https://YOUR_DATA_CENTER/api/xchange/packages/:package_id/sharing/links/:link_id
名前タイプ説明
package_idstring
必須		パッケージのUUID。
link_idstring
必須		削除する共有リンクのID。
shell
curl  -X DELETE 'https://YOUR_DATA_CENTER/api/xchange/packages/:package_id/sharing/links/:link_id' \
      -H 'Authorization: Bearer <api_token>'

approvedまたはpublishedのバージョンをパッケージの共有リンクバージョンとしてマークします。

PUT https://YOUR_DATA_CENTER/api/xchange/packages/:package_id/versions/:version_id/share
名前タイプ説明
package_idstring
必須		パッケージのUUID。
version_idstring
必須		共有リンクバージョンとして設定するバージョンのUUID。
shell
curl  -X PUT 'https://YOUR_DATA_CENTER/api/xchange/packages/:package_id/versions/:version_id/share' \
      -H 'Authorization: Bearer <api_token>'

パッケージの共有リンクバージョンをクリアします。これは、URL内のversion_idが現在の共有リンクバージョンと一致する場合にのみ成功します。

DELETE https://YOUR_DATA_CENTER/api/xchange/packages/:package_id/versions/:version_id/share

アクティブなリンクは残ります

共有リンクバージョンをクリアした後も、アクティブな共有リンクはそのまま残ります。新しい共有リンクバージョンを設定するまで、コンシューマー側のリンク解決は404エラーを返します。現在の共有リンクバージョンではないversion_idを渡した場合も、404エラーが返されます。

名前タイプ説明
package_idstring
必須		パッケージのUUID。
version_idstring
必須		現在の共有リンクバージョンのUUID。
shell
curl  -X DELETE 'https://YOUR_DATA_CENTER/api/xchange/packages/:package_id/versions/:version_id/share' \
      -H 'Authorization: Bearer <api_token>'

分析 ​

次のエンドポイントは、パッケージのインストール統計情報とワークスペースごとのインストールレポートを返します:

パッケージインストール統計情報の取得 ​

パッケージのインストール統計情報を返します。 summaryブロックはパッケージ全体に適用され、version_idフィルターやページネーションの影響を受けません。 by_versionは、ページネーションされたバージョンごとの内訳です。

GET https://YOUR_DATA_CENTER/api/xchange/packages/:package_id/stats

URLパラメーター ​

名前タイプ説明
package_idstring
必須		パッケージのUUID。

クエリパラメーター ​

名前タイプ説明
version_idstring
任意		by_versionの内訳を単一のバージョンにフィルタリングします。 summaryには影響しません。
page[number]number
optional		by_version内訳のページ番号。
page[size]number
optional		by_version内訳のページあたりの項目数。
サンプルリクエスト ​
shell
curl  -X GET 'https://YOUR_DATA_CENTER/api/xchange/packages/:package_id/stats' \
      -H 'Authorization: Bearer <api_token>'

ワークスペースごとのインストールレポートの取得 ​

パッケージのワークスペースごとのインストールレポートを返します。

GET https://YOUR_DATA_CENTER/api/xchange/packages/:package_id/installations

URLパラメーター ​

名前タイプ説明
package_idstring
必須		パッケージのUUID。

クエリパラメーター ​

名前タイプ説明
version_idstring
任意		バージョンでインストールをフィルタリングします。
customer_idsarray of integers
optional		コンシューマーワークスペースIDでインストールをフィルタリングします。すべてのインストールを返すには、このパラメーターを省略します。明示的な空の配列は空のページを返します。
page[number]number
optional		ページ番号。
page[size]number
optional		ページごとの項目数。
サンプルリクエスト ​
shell
curl  -X GET 'https://YOUR_DATA_CENTER/api/xchange/packages/:package_id/installations?version_id=:version_id' \
      -H 'Authorization: Bearer <api_token>'

最終更新日: