プロジェクト

次のエンドポイントを使用して、カスタマーワークスペース内のプロジェクト、プロジェクトプロパティ、およびプロジェクトデプロイメントをプログラムで管理します。

プライベートベータ

次のエンドポイントはプライベートベータ版です:

デプロイメントの対象レビュー担当者を一覧表示
デプロイメントにレビュー担当者を割り当て
レビュー用にデプロイメントを送信
承認済みデプロイメントをデプロイ

プライベートベータ機能はプロダクションで利用できますが、選定されたお客様のみが対象です。お客様はオプトインし、ベータへの参加を承認される必要があります。

プライベートベータ期間中、Workatoは事前の通知なしに機能を更新したり、提供状況を変更したりする場合があります。

レート制限

プロジェクトリソースには次のレート制限があります:

タイプ	リソース	制限
GET	プロジェクトを一覧表示: /api/managed_users/:managed_user_id /projects	1分あたり1,000リクエスト
すべて	すべてのデプロイメントエンドポイント	1分あたり60リクエスト
すべて	その他すべてのプロジェクトエンドポイント	1分あたり60リクエスト

クイックリファレンス

タイプ	リソース	説明
GET	/api/managed_users/:managed_user_id/projects	カスタマーワークスペース内のプロジェクトを一覧表示します。
POST	/api/managed_users/:managed_user_id/folders	カスタマーワークスペース内にプロジェクトを作成します。
PUT	/api/managed_users/:managed_user_id/projects/ :project_id	カスタマーワークスペース内のプロジェクトを更新します。
DELETE	/api/managed_users/:managed_user_id/projects/ :project_id	カスタマーワークスペース内のプロジェクトを削除します。
GET	/api/managed_users/:managed_user_id/properties	プレフィックスおよびプロジェクトIDでプロジェクトレベルのプロパティを一覧表示します。
POST	/api/managed_users/:managed_user_id/properties	プロジェクトレベルのプロパティをアップサートします。
GET	/api/managed_users/:managed_user_id/deployments	カスタマーワークスペース内のデプロイメントのリストを取得します。
GET	/api/managed_users/:managed_user_id/deployments/:id	カスタマーワークスペース内の単一のデプロイメントを取得します。
GET	/api/managed_users/:managed_user_id/api/project_builds/:id	カスタマーワークスペース内のダウンロード済みパッケージを取得します。
POST	/api/managed_users/:managed_user_id/projects/:id/build	カスタマーワークスペース内でプロジェクトをビルドします。
POST	/api/managed_users/:managed_user_id/project_builds/:id/ deploy	カスタマーワークスペース内でダウンロード済みパッケージをデプロイします。
POST	/api/managed_users/:managed_user_id/projects/:project_id/ deploy	カスタマーワークスペース内でプロジェクトをデプロイします。
GET	/api/managed_users/:managed_user_id/deployments/:id/ eligible_reviewers	カスタマーワークスペース内のデプロイメントをレビューするために割り当て可能な対象レビュー担当者のリストを取得します。
POST	/api/managed_users/:managed_user_id/deployments/:id/ assign_reviewers	カスタマーワークスペース内のデプロイメントにレビュー担当者を割り当てます。
POST	/api/managed_users/:managed_user_id/deployments/:id/ submit_for_review	カスタマーワークスペース内のデプロイメントをレビュー用に送信します。
POST	/api/managed_users/:managed_user_id/deployments/:id/ deploy	カスタマーワークスペース内で承認済みデプロイメントをデプロイします。

プロジェクトをリスト

すべてのプロジェクトをリストします。プロジェクトは、通常1つのユースケースを包含する最上位フォルダです。

shell

GET /api/managed_users/:managed_user_id/projects

URLパラメーター

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

クエリパラメーター

名前	タイプ	説明
page	integer optional	ページ番号。デフォルトは1です。
per_page	integer optional	ページサイズ。デフォルトは100です。最大値は100です。
updated_after	string 任意	指定した日時より後に更新されたプロジェクトのみを含むように、プロジェクトのリストをフィルタします。日時は、次のパターンに従ってISO 8601形式で指定する必要があります: `YYYY-MM-DDTHH:MM:SSZ`。

サンプルリクエスト

shell

curl  -X GET 'https://www.workato.com/api/managed_users/19029/projects' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \

レスポンス

json

{
    "result": [
        {
            "id": 649122,
            "description": "Coupa to Netsuite automations",
            "folder_id": 1563029,
            "name": "Procure to Pay"
        },
        {
            "id": 604202,
            "description": "Salesforce to Netsuite automations",
            "folder_id": 1486330,
            "name": "Order to Cash"
        }
    ],
    "count": 2,
    "page": 1,
    "per_page": 100
}

プロジェクトを作成

カスタマーワークスペース内にプロジェクトを作成するには、フォルダを作成エンドポイントを使用し、リクエストペイロードからparent_idを省略します。

プロジェクトを更新

カスタマーワークスペース内のプロジェクトを更新します。プロジェクトは、通常1つのユースケースを包含する最上位フォルダです。このエンドポイントを使用して、プロジェクトの名前または説明、あるいはその両方を変更します。

shell

PUT /api/managed_users/:managed_user_id/projects/:project_id

フォルダとプロジェクトの変換

このエンドポイントを使用して、フォルダをプロジェクトに変換したり、プロジェクトをフォルダに変換したりすることはできません。

URLパラメータ

名前	タイプ	説明
managed_user_id	string 必須	Embedded顧客ID/外部ID。 External IDはURLエンコードし、`E`をプレフィックスとして付ける必要があります（例: `EA2300`）。
project_id	string 必須	更新するプロジェクトのID。これはプロジェクトの`folder_id`とは異なります。プロジェクトを一覧表示エンドポイントを呼び出して、カスタマーワークスペース内のプロジェクトのリストを取得します。

ペイロード

名前	タイプ	説明
name	string 任意	プロジェクトの新しい名前。
説明	string 任意	プロジェクトの新しい説明。

プロジェクト名

プロジェクト名には/または\文字を含めることはできません。

サンプルリクエスト

shell

curl  -X PUT https://www.workato.com/api/managed_users/19029/projects/54321 \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "name": "My updated project name",
            "description": "My updated project description"
          }'

レスポンス

成功レスポンス

json

{
    "id": 54321,
    "description": "My updated project description",
    "folder_id": 09876,
    "name": "My updated project name"
}

失敗レスポンス

プロジェクト名を更新して/または\文字を含めようとすると、次のエラーが返されます:

json

{
    "message": "Name is invalid"
}

プロジェクトを削除する

カスタマーワークスペース内のプロジェクトを削除します。プロジェクトは、通常1つのユースケースを包含する最上位フォルダです。

プロジェクトの削除にはアセットが含まれます

このアクションは、プロジェクトとそのすべてのコンテンツを削除します。これには、プロジェクト内のすべての子フォルダ、レシピ、コネクション、およびWorkflow appsアセット（該当する場合）が含まれます。

このエンドポイントを使用するには、APIクライアントロールに次の権限が必要です:

プロジェクトを削除

shell

DELETE /api/managed_users/:managed_user_id/projects/:project_id

URLパラメータ

名前	タイプ	説明
managed_user_id	string 必須	Embedded顧客ID/外部ID。 External IDはURLエンコードし、`E`をプレフィックスとして付ける必要があります（例: `EA2300`）。
project_id	string 必須	削除するプロジェクトのID。プロジェクトを一覧表示エンドポイントを呼び出して、カスタマーワークスペース内のすべてのプロジェクトのリストを取得します。

サンプルリクエスト

shell

curl  -X DELETE 'https://www.workato.com/api/managed_users/19029/projects/54321' \
      -H 'Authorization: Bearer <api_token>'

レスポンス

成功レスポンス

json

{
    "success": "true"
}

失敗レスポンス

プロジェクトを削除しようとして適切な権限がない場合、Workatoは次のレスポンスを返します:

json

{
    "message": "Cannot destroy folder"
}

プロジェクトプロパティの一覧表示

指定したproject_idに一致する、顧客ワークスペース内の特定のプロジェクトに属するプロジェクトレベルのプロパティのリストを返します。プレフィックスも含める必要があります。たとえば、プレフィックスsalesforce_sync.を指定すると、指定したproject_idを持つ、salesforce_sync.admin_emailなどのsalesforce_sync.で始まる名前のプロジェクトプロパティが返されます。

shell

GET /api/managed_users/:managed_user_id/properties

URLパラメータ

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

クエリパラメータ

名前	タイプ	説明
prefix	string 必須	指定したプレフィックスを含むプロパティを返します。たとえば、プレフィックスが`salesforce_sync.`の場合、プロパティ`salesforce_sync.admin_email`が返されます。
project_id	string 必須	指定した`project_id`に一致するプロジェクトレベルのプロパティを返します。このパラメータが存在しない場合、この呼び出しはEnvironment propertiesを返します。

サンプルリクエスト

shell

curl  -X GET 'https://www.workato.com/api/managed_users/19029/properties?prefix=salesforce_sync.&project_id=523144' \
      -H 'Authorization: Bearer <token>' \
      -H 'Content-Type: application/json'

レスポンス

json

{
  "public_url": "https://www.example.com",
  "admin_email": "[email protected]"
}

プロジェクトプロパティのアップサート

指定したproject_idに一致する、顧客ワークスペース内の特定のプロジェクトに属するプロジェクトプロパティをアップサートします。このエンドポイントは、リクエストで指定した名前に基づいてプロパティにマッピングされます。

shell

POST /api/managed_users/:managed_user_id/properties

プロパティ制限

プロジェクトプロパティには、次の制限があります:

説明	制限
プロジェクトあたりのプロジェクトプロパティの最大数	1,000
プロジェクトプロパティ名の最大長	100文字
プロジェクトプロパティ値の最大長	1,024文字

URLパラメータ

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

クエリパラメータ

名前	タイプ	説明
project_id	string 必須	アップサートするプロジェクトプロパティを含むプロジェクトIDを指定します。このパラメータが存在しない場合、この呼び出しはEnvironment propertiesをアップサートします。

ペイロード

名前	タイプ	説明
properties	ハッシュ必須	アップサートするプロパティの名前と値を含みます。

サンプルリクエスト

shell

curl  -X POST 'https://www.workato.com/api/managed_users/19029/properties?project_id=523144' \
      -H 'Authorization: Bearer <token>' \
      -H 'Content-Type: application/json' \
      -d '{ "properties": { "admin_email": "[email protected]", "public_url": "https://www.example.com" }}'

レスポンス

json

{
  "success": true
}

デプロイメントをリスト

カスタマーワークスペース内のデプロイメントのリストを取得します。クエリパラメータを使用して、プロジェクト、フォルダ、または日付範囲で結果をフィルタリングします。

shell

GET /api/managed_users/:managed_user_id/deployments

URLパラメータ

名前	タイプ	説明
managed_user_id	string 必須	Embedded顧客ID/外部ID。 External IDはURLエンコードし、先頭に`E`を付ける必要があります（例: `EA2300`）。

クエリパラメータ

名前	タイプ	説明
project_id	string 任意	指定されたプロジェクトIDに関連付けられたデプロイメントを取得します。
folder_id	string 任意	`f{:folder_id}`形式のフォルダID。例: `f660222`。指定した場合、フォルダに関連付けられたデプロイメントのみがレスポンスに含まれます。フォルダを一覧表示エンドポイントを使用して、これらのIDを取得します。
environment_type	string 任意	Environmentタイプ。指定した場合、Environmentに関連付けられたデプロイメントのみがレスポンスに含まれます。使用できる値には`test`または`prod`があります。
state	string 任意	指定された状態でデプロイメントを取得します。使用できる値には`pending`、`success`、または`failed`があります。
from	timestamp optional	指定されたタイムスタンプより後に作成されたデプロイメントが含まれます。 ISO 8601形式を使用します（例:`2024-10-14T10:09:43Z`）。
to	timestamp optional	指定されたタイムスタンプより前に作成されたデプロイメントが含まれます。 ISO 8601形式を使用します（例:`2024-10-15T10:09:43Z`）。

サンプルリクエスト

shell

curl  -X GET 'https://www.workato.com/api/managed_users/12345/deployments' \
      -H 'Authorization: Bearer <token>' \

レスポンス

json

{
    "items": [
        {
            "id": 6409,
            "created_at": "2024-10-14T10:09:43.890-07:00",
            "updated_at": "2024-10-14T10:10:15.370-07:00",
            "title": "Deployment",
            "description": "",
            "project_build_id": 9120,
            "environment_type": "test",
            "project_id": "39334",
            "state": "success",
            "detailed_state": "deploy_finished",
            "performed_by_name": "Alex",
            "assets": [
                {
                    "id": null,
                    "name": "My Salesforce account",
                    "type": "connection",
                    "state": "new",
                    "folder": "Sample deployment"
                },
                {
                    "id": null,
                    "name": "My Zendesk account",
                    "type": "connection",
                    "state": "new",
                    "folder": "Sample deployment"
                },
                {
                    "id": null,
                    "name": "New Salesforce account will create Zendesk organization",
                    "type": "recipe",
                    "folder": "Sample deployment"
                },
            ],
            "review_state": "review_approved",
            "reviews": [
                {
                    "status": "approved",
                    "comment": "LGTM!",
                    "reviewer_name": "Alex"
                }
            ]
        }
        ...
    ]
}

デプロイメントを取得

一意のIDで、カスタマーワークスペース内の単一のデプロイメントを取得します。

shell

GET /api/managed_users/:managed_user_id/deployments/:id

URLパラメータ

名前	タイプ	説明
managed_user_id	string 必須	Embedded顧客ID/外部ID。 External IDはURLエンコードし、先頭に`E`を付ける必要があります（例: `EA2300`）。
id	integer required	取得するデプロイメントの一意の識別子。

サンプルリクエスト

shell

curl  -X GET https://www.workato.com/api/managed_users/12345/deployments/6409 \
      -H 'Authorization: Bearer <api_token>'

レスポンス

json

{
    "id": 6409,
    "created_at": "2024-10-14T10:09:43.890-07:00",
    "updated_at": "2024-10-14T10:10:15.370-07:00",
    "title": "Deployment",
    "description": "",
    "project_build_id": 9120,
    "environment_type": "test",
    "project_id": "39334",
    "state": "success",
    "detailed_state": "deploy_finished",
    "performed_by_name": "Alex",
    "assets": [
        {
            "id": null,
            "name": "My Salesforce account",
            "type": "connection",
            "state": "new",
            "folder": "Sample deployment"
        },
        {
            "id": null,
            "name": "My Zendesk account",
            "type": "connection",
            "state": "new",
            "folder": "Sample deployment"
        },
        {
            "id": null,
            "name": "New Salesforce account will create Zendesk organization",
            "type": "recipe",
            "folder": "Sample deployment"
        },
    ],
    "review_state": "review_approved",
    "reviews": [
        {
            "status": "approved",
            "comment": "LGTM!",
            "reviewer_name": "Alex"
        }
    ]
}

ダウンロード済みパッケージを取得

一意のIDで、カスタマーワークスペース内のダウンロード済みパッケージを取得します。

shell

GET /api/managed_users/:managed_user_id/api/project_builds/:id

URLパラメータ

名前	タイプ	説明
managed_user_id	string 必須	Embedded顧客ID/外部ID。 External IDはURLエンコードし、先頭に`E`を付ける必要があります（例: `EA2300`）。
id	integer required	取得するダウンロード済みパッケージの一意の識別子。

サンプルリクエスト

shell

curl  -X GET https://www.workato.com/api/managed_users/12345/project_builds/72 \
      -H 'Authorization: Bearer <api_token>'

レスポンス

json

{
    "id": 72,
    "created_at": "2021-12-10T11:39:15.738-08:00",
    "updated_at": "2021-12-10T11:39:16.218-08:00",
    "description": null,
    "project_id": "10416",
    "state": "success",
    "performed_by_name": "Alex",
    "download_url": "https://workato-assets.s3.us-west-2.amazonaws.com/packages/zip_files/000/714/699/original/<PROJECT_NAME_DATE>.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=<CREDENTIAL>"
}

プロジェクトをビルド

カスタマーワークスペース内でプロジェクトをビルドします。ビルド後、ダウンロード済みパッケージをデプロイエンドポイントを使用して、プロジェクトをEnvironmentにデプロイします。

shell

POST /api/managed_users/:managed_user_id/projects/:id/build

URLパラメータ

名前	タイプ	説明
managed_user_id	string 必須	Embedded顧客ID/外部ID。 External IDはURLエンコードし、先頭に`E`を付ける必要があります（例: `EA2300`）。
id	string 必須	ビルドするプロジェクトのID。有効な`project_id`、または`f{:folder_id}`形式の有効な`folder_id`（例:`f660222`）を受け入れます。

ペイロード

名前	タイプ	説明
説明	string 任意	ビルドの簡単な説明。
include_test_cases	boolean optional	ビルドにテストケースを含めるかどうかを指定します。
include_tags	boolean optional	ビルドにアセットに割り当てられたタグを含めるかどうかを指定します。 `false`に設定すると、タグはビルドから除外されます。デフォルトでは`false`に設定されます。

サンプルリクエスト

shell

curl  -X POST https://www.workato.com/api/managed_users/12345/projects/10416/build \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "description": "Fixes bugs",
            "include_tags": true
          }'

レスポンス

json

{
    "id": 9121,
    "created_at": "2024-10-14T14:37:29.877-07:00",
    "updated_at": "2024-10-14T14:37:29.885-07:00",
    "description": "Fixes bugs",
    "project_id": "10416",
    "state": "pending",
    "performed_by_name": "Alex",
    "download_url": null
}

ダウンロード済みパッケージをデプロイ

カスタマーワークスペース内でダウンロード済みパッケージをEnvironmentにデプロイします。デプロイする前に、プロジェクトをビルドエンドポイントを使用してプロジェクトをビルドします。

shell

POST /api/managed_users/:managed_user_id/project_builds/:id/deploy

URLパラメータ

名前	タイプ	説明
managed_user_id	string 必須	Embedded顧客ID/外部ID。 External IDはURLエンコードし、先頭に`E`を付ける必要があります（例: `EA2300`）。
id	integer required	デプロイするダウンロード済みパッケージの一意の識別子。

ペイロード

名前	タイプ	説明
environment_type	string 必須	ダウンロード済みパッケージをデプロイするEnvironmentを指定します。指定できる値には`test`と`prod`があります。
title	string 任意	デプロイメントのタイトル。
説明	string 任意	デプロイメントの簡単な説明。
include_tags	boolean optional	デプロイ済みパッケージにアセットに割り当てられたタグを含めるかどうかを指定します。タグはワークスペースレベルに存在しますが、`false`に設定するとターゲットEnvironment内のアセットには適用されません。これはデフォルトで`false`に設定されます。

サンプルリクエスト

shell

curl  -X POST https://www.workato.com/api/managed_users/12345/project_builds/9121 \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "environment_type": "test",
            "include_tags": true
          }'

レスポンス

json

{
    "id": 67,
    "created_at": "2021-12-10T11:59:03.426-08:00",
    "updated_at": "2021-12-10T11:59:03.426-08:00",
    "title": null,
    "description": null,
    "project_build_id": 9121,
    "environment_type": "test",
    "project_id": "10416",
    "state": "pending",
    "performed_by_name": "Alex",
    "assets": null
}

プロジェクトをデプロイ

カスタマーワークスペース内でプロジェクトをデプロイします。ペイロードでターゲットEnvironmentを指定します。プロジェクトはDEV Environmentからのみデプロイできます。

shell

POST /api/managed_users/:managed_user_id/projects/:project_id/deploy

URLパラメータ

名前	タイプ	説明
managed_user_id	string 必須	Embedded顧客ID/外部ID。 External IDはURLエンコードし、先頭に`E`を付ける必要があります（例: `EA2300`）。
project_id	string 必須	デプロイするプロジェクトの一意の識別子。プロジェクトを一覧表示エンドポイントを使用して、ワークスペース内のプロジェクトIDを取得します。

ペイロード

名前	タイプ	説明
environment_type	string 必須	プロジェクトをデプロイするEnvironmentを指定します。
title	string 必須	デプロイメントのタイトル。
説明	string 任意	デプロイメントの簡単な説明。
include_tags	boolean optional	デプロイメントにアセットに割り当てられたタグを含めるかどうかを指定します。タグはワークスペースレベルに存在しますが、`false`に設定するとターゲットEnvironment内のアセットには適用されません。これはデフォルトで`false`に設定されます。

サンプルリクエスト

shell

curl  -X POST 'https://www.workato.com/api/managed_users/19029/projects/35263/deploy' \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "environment_type": "test",
            "title": "My deployment",
            "description": "Description of my deployment",
            "include_tags": true
          }'

サンプルレスポンス

json

{
    "id": 3905,
    "created_at": "2024-03-10T13:08:53.344-08:00",
    "updated_at": "2024-03-10T13:08:53.344-08:00",
    "title": "My deployment",
    "description": "Description of my deployment",
    "project_build_id": 6544,
    "environment_type": "test",
    "project_id": "35263",
    "state": "pending",
    "performed_by_name": "Barnaby",
    "assets": null
}

デプロイメントの対象レビュー担当者をリスト

カスタマーワークスペース内のデプロイメントをレビューするために割り当て可能な対象レビュー担当者のリストを取得します。レビュー担当者は、DEV EnvironmentとターゲットデプロイメントEnvironmentの両方でレビュー権限を持つコラボレーターである必要があります。このエンドポイントにアクセスするには、ワークスペース管理者＞設定＞デプロイメントでレビューと承認を必須にするトグルを有効にする必要があります。

shell

GET /api/managed_users/:managed_user_id/deployments/:id/eligible_reviewers

URLパラメータ

名前	タイプ	説明
managed_user_id	string 必須	Embedded顧客ID/外部ID。 External IDはURLエンコードし、先頭に`E`を付ける必要があります（例: `EA2300`）。
id	integer required	デプロイメントの一意の識別子。

サンプルリクエスト

shell

curl  -X GET https://www.workato.com/api/managed_users/12345/deployments/6390/eligible_reviewers \
      -H 'Authorization: Bearer <api_token>'

レスポンス

json

{
    "reviewers": [
        {
            "id": 29036,
            "name": "Jie",
            "avatar_url": ""
        },
        {
            "id": 30143,
            "name": "Alex",
            "avatar_url": ""
        },
        {
            "id": 31836,
            "name": "Charlie",
            "avatar_url": ""
        }
    ]
}

デプロイメントにレビュー担当者を割り当て

カスタマーワークスペース内のデプロイメントにレビュー担当者を割り当てます。デプロイメントをレビュー用に送信する前でも後でも、レビュー担当者を割り当てることができます。このエンドポイントにアクセスするには、ワークスペース管理者＞設定＞デプロイメントでレビューと承認を必須にするトグルを有効にする必要があります。

このエンドポイントは、レビュー担当者の割り当て解除にも使用できます。レビュー担当者の割り当てを解除するには、エンドポイントを再度呼び出し、デプロイメントへの割り当てを維持するユーザーのIDのみを指定します。レビュー担当者の割り当てを解除すると、そのレビューがデプロイメントから削除されます。

shell

POST /api/managed_users/:managed_user_id/deployments/:id/assign_reviewers

URLパラメータ

名前	タイプ	説明
managed_user_id	string 必須	Embedded顧客ID/外部ID。 External IDはURLエンコードし、先頭に`E`を付ける必要があります（例: `EA2300`）。
id	integer required	デプロイメントの一意の識別子。

ペイロード

名前	タイプ	説明
reviewer_ids	文字列の配列必須	デプロイメントのレビュー担当者として割り当てるユーザーIDの配列。

サンプルリクエスト

shell

curl  -X POST https://www.workato.com/api/managed_users/12345/deployments/6390/assign_reviewers \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "reviewer_ids": ["29036", "30143", "31836"]
          }'

レスポンス

json

{
    "reviews": [
        {
            "deployment_id": 6390,
            "reviewer_id": 29036,
            "status": "pending",
            "comment": "",
            "updated_at": "2024-10-11T10:54:26.075-07:00"
        },
        {
            "deployment_id": 6390,
            "reviewer_id": 30143,
            "status": "pending",
            "comment": "",
            "updated_at": "2024-10-11T10:31:07.047-07:00"
        },
        {
            "deployment_id": 6390,
            "reviewer_id": 31836,
            "status": "pending",
            "comment": "",
            "updated_at": "2024-10-11T10:54:26.099-07:00"
        }
    ],
    "authors": [
        {
            "id": 29036,
            "name": "Jie",
            "avatar_url": ""
        },
        {
            "id": 30143,
            "name": "Alex",
            "avatar_url": ""
        },
        {
            "id": 31836,
            "name": "Charlie",
            "avatar_url": ""
        }
    ]
}

レビュー用にデプロイメントを送信

カスタマーワークスペース内のデプロイメントをレビュー用に送信します。このエンドポイントを呼び出す前に、プロジェクトをビルドエンドポイントとダウンロード済みパッケージをデプロイエンドポイントを使用して、デプロイメントIDを生成して取得します。このエンドポイントにアクセスするには、ワークスペース管理者＞設定＞デプロイメントでレビューと承認を必須にするトグルを有効にする必要があります。

shell

POST /api/managed_users/:managed_user_id/deployments/:id/submit_for_review

URLパラメータ

名前	タイプ	説明
managed_user_id	string 必須	Embedded顧客ID/外部ID。 External IDはURLエンコードし、先頭に`E`を付ける必要があります（例: `EA2300`）。
id	integer required	レビュー用に送信するデプロイメントの一意の識別子。

サンプルリクエスト

shell

curl  -X POST https://www.workato.com/api/managed_users/12345/deployments/6390/submit_for_review \
      -H 'Authorization: Bearer <api_token>'

レスポンス

json

{
    "success": true
}

カスタマーワークスペース内のレビューアクション

カスタマーワークスペース内のレビューを承認、却下、またはリセットするには、EmbeddedカスタマーがUIから、またはDeveloper APIエンドポイントを使用してアクションを実行する必要があります。 Embeddedパートナーは、Embedded APIを通じてこれらのアクションを実行できません。

承認済みデプロイメントをデプロイ

カスタマーワークスペース内で承認済みデプロイメントをデプロイします。このエンドポイントにアクセスするには、ワークスペース管理者＞設定＞デプロイメントでレビューと承認を必須にするトグルを有効にする必要があります。

shell

POST /api/managed_users/:managed_user_id/deployments/:id/deploy

URLパラメータ

名前	タイプ	説明
managed_user_id	string 必須	Embedded顧客ID/外部ID。 External IDはURLエンコードし、先頭に`E`を付ける必要があります（例: `EA2300`）。
id	integer required	デプロイする承認済みデプロイメントの一意の識別子。

ペイロード

名前	タイプ	説明
include_tags	boolean optional	デプロイメントにタグを含めるかどうかを指定します。

サンプルリクエスト

shell

curl  -X POST https://www.workato.com/api/managed_users/12345/deployments/6390/deploy \
      -H 'Authorization: Bearer <api_token>'
      -H 'Content-Type: application/json' \
      -d '{
            "include_tags": true
          }'

レスポンス

json

{
    "id": 6390,
    "created_at": "2024-10-11T13:16:58.170-07:00",
    "updated_at": "2024-10-11T13:47:31.254-07:00",
    "title": "",
    "description": "",
    "project_build_id": 9104,
    "environment_type": "test",
    "project_id": "44946",
    "state": "pending",
    "detailed_state": "deploy_started",
    "performed_by_name": "Alex",
    "assets": [
        {
            "id": null,
            "name": "My Salesforce account",
            "type": "connection",
            "state": "new",
            "folder": "Sample deployment"
        },
        {
            "id": null,
            "name": "My Zendesk account",
            "type": "connection",
            "state": "new",
            "folder": "Sample deployment"
        },
        {
            "id": null,
            "name": "New Salesforce account will create Zendesk organization",
            "type": "recipe",
            "folder": "Sample deployment"
        },
    ],
    "review_state": "review_approved",
    "reviews": [
        {
            "status": "approved",
            "comment": "Looks good!",
            "reviewer_name": "Jie"
        }
    ]
}

Last updated:

プロジェクト ​

レート制限 ​

クイックリファレンス ​

プロジェクトをリスト ​

URLパラメーター ​

クエリパラメーター ​

サンプルリクエスト ​

レスポンス ​

プロジェクトを作成 ​

プロジェクトを更新 ​

URLパラメータ ​

ペイロード ​

サンプルリクエスト ​

レスポンス ​

プロジェクトを削除する ​

URLパラメータ ​

サンプルリクエスト ​

レスポンス ​

プロジェクトプロパティの一覧表示 ​

URLパラメータ ​

クエリパラメータ ​

サンプルリクエスト ​

レスポンス ​

プロジェクトプロパティのアップサート ​

URLパラメータ ​

クエリパラメータ ​

ペイロード ​

サンプルリクエスト ​

レスポンス ​

デプロイメントをリスト ​

URLパラメータ ​

クエリパラメータ ​

サンプルリクエスト ​

レスポンス ​

デプロイメントを取得 ​

URLパラメータ ​

サンプルリクエスト ​

レスポンス ​

ダウンロード済みパッケージを取得 ​

URLパラメータ ​

サンプルリクエスト ​

レスポンス ​

プロジェクトをビルド ​

URLパラメータ ​

ペイロード ​

サンプルリクエスト ​

レスポンス ​

ダウンロード済みパッケージをデプロイ ​

URLパラメータ ​

ペイロード ​

サンプルリクエスト ​

レスポンス ​

プロジェクトをデプロイ ​

URLパラメータ ​

ペイロード ​

サンプルリクエスト ​

サンプルレスポンス ​

デプロイメントの対象レビュー担当者をリスト ​

URLパラメータ ​

サンプルリクエスト ​

レスポンス ​

デプロイメントにレビュー担当者を割り当て ​

URLパラメータ ​

ペイロード ​

サンプルリクエスト ​

レスポンス ​

レビュー用にデプロイメントを送信 ​

URLパラメータ ​

サンプルリクエスト ​

レスポンス ​

承認済みデプロイメントをデプロイ ​

URLパラメータ ​

ペイロード ​

サンプルリクエスト ​

レスポンス ​

プロジェクト

レート制限

クイックリファレンス

プロジェクトをリスト

URLパラメーター

クエリパラメーター

サンプルリクエスト

レスポンス

プロジェクトを作成

プロジェクトを更新

URLパラメータ

ペイロード

サンプルリクエスト

レスポンス

プロジェクトを削除する

URLパラメータ

サンプルリクエスト

レスポンス

プロジェクトプロパティの一覧表示

URLパラメータ

クエリパラメータ

サンプルリクエスト

レスポンス

プロジェクトプロパティのアップサート

URLパラメータ

クエリパラメータ

ペイロード

サンプルリクエスト

レスポンス

デプロイメントをリスト

URLパラメータ

クエリパラメータ

サンプルリクエスト

レスポンス

デプロイメントを取得

URLパラメータ

サンプルリクエスト

レスポンス

ダウンロード済みパッケージを取得

URLパラメータ

サンプルリクエスト

レスポンス

プロジェクトをビルド

URLパラメータ

ペイロード

サンプルリクエスト

レスポンス

ダウンロード済みパッケージをデプロイ

URLパラメータ

ペイロード

サンプルリクエスト

レスポンス

プロジェクトをデプロイ

URLパラメータ

ペイロード

サンプルリクエスト

サンプルレスポンス

デプロイメントの対象レビュー担当者をリスト

URLパラメータ

サンプルリクエスト

レスポンス

デプロイメントにレビュー担当者を割り当て

URLパラメータ

ペイロード

サンプルリクエスト

レスポンス

レビュー用にデプロイメントを送信

URLパラメータ

サンプルリクエスト

レスポンス

承認済みデプロイメントをデプロイ

URLパラメータ

ペイロード

サンプルリクエスト

レスポンス