Product UpdatesStatus PageWorkato Academy
English
日本語
Get a trial
Developer API
リソース

プロジェクト ​

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

Workatoでは、プロジェクトを使用して自動化アセットを整理し、アクセスを制御します。 プロジェクトには、コネクション、レシピ、サブフォルダなど、自動化に関連する一連のアセットが格納されます。

これらのAPIを使用できるユーザー

Environments機能が有効なアカウントは、このガイドのAPIを使用できます。 この機能がないアカウントから送信されたリクエストには、400 - Environments not provisionedレスポンスが返されます。

Project APIを使用すると、ワークスペースでプロビジョニングされたEnvironmentにプロジェクトをプログラムで管理およびデプロイできます。

プロジェクトデプロイメントの理解 ​

Workatoでは、プロジェクトをデプロイする方法が2つあります:

  • ビルドしてからデプロイ。 この方法は、パッケージを外部バージョン管理システムにコミットする場合に使用できます。 これを実行する手順は、次のようになります:

    1

    プロジェクトをビルドします: POST /api/projects/:id/build

    2

    プロジェクトが正常にビルドされたことを確認します: GET /api/project_builds/:id

    3

    GitHubなどのバージョン管理システムにコミットする場合は、ステップ2のレスポンスのdownload_urlを使用してパッケージをダウンロードします。

    4

    パッケージをバージョン管理システムにコミットします。

    5

    プロジェクトビルドをEnvironmentにデプロイします: POST /api/project_builds/:id/deploy?environment_type=:environment_type

    6

    プロジェクトが正常にデプロイされたことを確認します: GET /api/deployments/:id

  • 1つのステップでビルドしてデプロイ。 プロジェクトをバージョン管理システムにコミットする必要がない場合は、この方法を使用できます:

    1

    プロジェクトをビルドしてEnvironmentにデプロイします: POST /api/projects/:id/deploy?environment_type=:environment_type

    2

    プロジェクトが正常にデプロイされたことを確認します: GET /api/deployments/:id

レート制限 ​

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

タイプリソース制限
すべてすべてのプロジェクトエンドポイント1分あたり60リクエスト

クイックリファレンス ​

プライベートベータ

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

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

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

タイプリソース説明
POST/api/projects/:id/buildプロジェクトをビルドします。 プロジェクトビルドのデプロイエンドポイントを使用して、プロジェクトをEnvironmentにデプロイします。
GET/api/project_builds/:id一意のIDでプロジェクトビルドを取得します。
POST/api/project_builds/:id/deployプロジェクトビルドをEnvironmentにデプロイします。 プロジェクトのビルドエンドポイントを使用して、最初にプロジェクトをビルドします。
POST/api/projects/:id/deployプロジェクトをビルドし、Environmentにデプロイします。
GET/api/deployments/:id一意のIDで単一のデプロイメントを取得します。
GET/api/deploymentsデプロイメントのリストを取得します。 クエリパラメータを使用して、プロジェクト、フォルダ、または日付範囲で結果をフィルタリングします。
GET/api/deployments/:id/eligible_reviewersデプロイメントのレビューに割り当てることができる対象レビュー担当者のリストを取得します。
POST/api/deployments/:id/assign_reviewersデプロイメントにレビュー担当者を割り当てます。
POST/api/deployments/:id/submit_for_reviewデプロイメントをレビューのために送信します。
POST/api/deployments/:id/approveデプロイメントを承認します。
POST/api/deployments/:id/rejectデプロイメントを却下します。
POST/api/deployments/:id/reopenデプロイメントをレビュー用に再オープンします。
POST/api/deployments/:id/update_review_commentデプロイメントレビューコメントを更新します。
POST/api/deployments/:id/deploy承認済みデプロイメントをデプロイします。

プロジェクトをビルド ​

プロジェクトをビルドします。 プロジェクトをEnvironmentにデプロイするには、プロジェクトビルドをデプロイエンドポイントを使用します。

shell
POST /api/projects/:id/build

リクエスト ​

URLパラメーター ​

名前タイプ説明
idinteger
必須		プロジェクトID。 このパラメータでは、次のものを指定できます:

ペイロード ​

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

リクエスト例 ​

プロジェクトIDの使用 ​

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

フォルダIDの使用 ​

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

レスポンス ​

200 OK

成功すると、APIは200 OKステータスと単一のプロジェクトビルドオブジェクトを返します。

json
{
    "id": 46,
    "created_at": "2021-12-09T22:09:29.997-08:00",
    "updated_at": "2021-12-09T22:09:30.004-08:00",
    "description": "Fixes bugs",
    "project_id": "10416",
    "state": "pending",
    "performed_by_name": "Finn the Human",
    "download_url": null
}
名前タイプ説明
idintegerビルドID。
created_attimestampビルドが作成された時刻。
updated_attimestampビルドが最後に更新された時刻。
説明stringビルドの説明。 リクエストで指定されていない場合、これはnullです。
include_test_casesbooleanビルドにテストケースが含まれているかどうか。 リクエストで指定されていない場合、これはnullです。
project_build_idintegerビルドに関連付けられているプロジェクトビルドのID。
project_idstringビルドされたプロジェクトのID。
statestringビルドの現在の状態。
performed_by_namestringプロジェクトをビルドしたユーザーの名前。
download_urlstringプロジェクトビルドをダウンロードできるURL。

400 BAD REQUEST - 必須パラメータが不足しています

リクエストの形式が正しくない場合、APIは400 BAD REQUESTステータスと次のエラーを返すことがあります:

environment_typeパラメータが不足しています:

{
   "message": "Missing parameter environment_type"
}

404 NOT FOUND - 無効なパラメータ

APIは、次の理由により404 NOT FOUNDステータスとNot foundエラーを返すことがあります:

  • 無効なid
  • 無効なenvironment_type

404 NOT FOUND - 無効なURI

APIは、次の理由により404 NOT FOUNDステータスとAPI not foundエラーを返すことがあります:

  • サポートされていないメソッド
  • 正しくないURI

プロジェクトビルドを取得 ​

一意のIDでプロジェクトビルドを取得します。

shell
GET /api/project_builds/:id

リクエスト ​

URLパラメータ ​

名前タイプ説明
idinteger
必須		取得するプロジェクトビルドのID。

リクエスト例 ​

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

レスポンス ​

200 OK

成功すると、APIは200 OKステータスと単一のプロジェクトビルドオブジェクトを返します。

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": "Erin Cochran",
    "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>"
}
名前タイプ説明
idintegerビルドID。
created_attimestampビルドが作成された時刻。
updated_attimestampビルドが最後に更新された時刻。
説明stringビルドの説明。 ビルドを作成したリクエストで指定されていない場合、これはnullになります。
project_idstringビルドされたプロジェクトのID。
statestringビルドの現在の状態。
performed_by_namestringプロジェクトをビルドしたユーザーの名前。
download_urlstringプロジェクトビルドをダウンロードできるURL。
404 NOT FOUND - 無効なパラメータ

APIは、次の理由により404 NOT FOUNDステータスとNot foundエラーを返すことがあります:

  • 無効なプロジェクトビルドid

404 NOT FOUND - 無効なURI

APIは、次の理由により404 NOT FOUNDステータスとAPI not foundエラーを返すことがあります:

  • サポートされていないメソッド
  • 正しくないURI

プロジェクトビルドをデプロイ ​

プロジェクトビルドをEnvironmentにデプロイします。 まずプロジェクトをビルドするには、プロジェクトをビルドエンドポイントを使用します。

shell
POST /api/project_builds/:id/deploy

リクエスト ​

URLパラメータ ​

名前タイプ説明
idinteger
必須		デプロイするビルドのID。

ペイロード ​

クエリパラメータとしてのペイロードフィールド

次のペイロードフィールドは、クエリパラメータとして指定することもできます。

名前タイプ説明
environment_typestring
必須		ビルドのデプロイメントEnvironmentを指定します。 使用可能な値は次のとおりです:
  • sandbox
  • test
  • stage
  • uat
  • preprod
  • prod
titlestring
任意		ビルドのタイトル。
説明string
任意		ビルドの簡単な説明。
include_tagsboolean
任意		デプロイされたビルド内のアセットに割り当てられているタグを含めるかどうかを指定します。 falseに設定すると、タグはワークスペースレベルに存在しますが、ターゲットEnvironmentのアセットには適用されません。 これはデフォルトでfalseに設定されます。

リクエスト例 ​

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

レスポンス ​

200 OK

成功すると、APIは200 OKステータスと単一のデプロイメントオブジェクトを返します。

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": 46,
    "environment_type": "test",
    "project_id": "10416",
    "state": "pending",
    "detailed_state": "pending",
    "performed_by_name": "Alex",
    "assets": null
}

最初は、デプロイメントプロセスがまだ進行中であるため、assetsフィールドはnullに設定されます。 このAPIを呼び出すと、新しく作成されたデプロイメントオブジェクトが返され、アセットを非同期でデプロイするバックグラウンドジョブが開始されます。 デプロイメントの完了後にassets配列に含まれるフィールドの詳細については、デプロイメントを取得を参照してください。

名前タイプ説明
idintegerデプロイメントID。
created_attimestampデプロイメントが作成された時刻。
updated_attimestampデプロイメントが最後に更新された時刻。
titlestringデプロイメントのタイトル。 リクエストで指定されていない場合、これはnullになります。
説明stringデプロイメントの説明。 リクエストで指定されていない場合、これはnullになります。
project_build_idintegerデプロイメントに関連付けられているプロジェクトビルドのID。
environment_typestringビルドのデプロイ先のEnvironment。
project_idstringデプロイされたビルドに関連付けられているプロジェクトのID。
statestringデプロイメントの現在の状態。
detailed_statestringデプロイメントの現在の状態に関する詳細な説明。
performed_by_namestringビルドをデプロイしたユーザーの名前。
assets配列デプロイメントに含まれるアセットの配列。

400 BAD REQUEST - 必須パラメータが不足しています

リクエストの形式が正しくない場合、APIは400 BAD REQUESTステータスと次のエラーを返すことがあります:

environment_typeパラメータが不足しています:

{
   "message": "Missing parameter environment_type"
}

404 NOT FOUND - 無効なパラメータ

APIは、次の理由により404 NOT FOUNDステータスとNot foundエラーを返すことがあります:

  • 無効なid
  • 無効なenvironment_type

404 NOT FOUND - 無効なURI

APIは、次の理由により404 NOT FOUNDステータスとAPI not foundエラーを返すことがあります:

  • サポートされていないメソッド
  • 正しくないURI

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

プロジェクトをビルドし、Environmentにデプロイします。

shell
POST /api/projects/:id/deploy

リクエスト ​

URLパラメータ ​

名前タイプ説明
idinteger
必須		プロジェクトID。 このパラメータでは、次のものを指定できます:

ペイロード ​

クエリパラメータとしてのペイロードフィールド

次のペイロードフィールドは、クエリパラメータとして指定することもできます。

名前タイプ説明
environment_typestring
必須		デプロイメントEnvironmentを指定します。 使用可能な値は次のとおりです:
  • sandbox
  • test
  • stage
  • uat
  • preprod
  • prod
titlestring
任意		デプロイメントのタイトル。
説明string
任意		デプロイメントの簡単な説明。
include_tagsboolean
任意		デプロイメントにアセットに割り当てられたタグを含めるかどうかを指定します。 falseに設定すると、タグはワークスペースレベルに存在しますが、ターゲットEnvironmentのアセットには適用されません。 これはデフォルトでfalseに設定されます。

リクエスト例 ​

プロジェクトIDの使用 ​
shell
curl  -X POST https://www.workato.com/api/projects/10416/deploy \
      -H 'Authorization: Bearer <api_token>'
      -H 'Content-Type: application/json' \
      -d '{
            "environment_type": "test",
            "include_tags": true
          }'
フォルダIDの使用 ​
shell
curl  -X POST https://www.workato.com/api/projects/f660222/deploy \
      -H 'Authorization: Bearer <api_token>'
      -H 'Content-Type: application/json' \
      -d '{
            "environment_type": "test",
            "include_tags": true
          }'

レスポンス ​

200 OK

成功すると、APIは200 OKステータスと単一のデプロイメントオブジェクトを返します。

json
{
    "id": 47,
    "created_at": "2021-12-09T22:37:30.025-08:00",
    "updated_at": "2021-12-09T22:37:30.025-08:00",
    "title": null,
    "description": null,
    "project_build_id": 52,
    "environment_type": "test",
    "project_id": "10416",
    "state": "pending",
    "performed_by_name": "Alex",
    "assets": null
}

最初は、デプロイメントプロセスがまだ進行中であるため、assetsフィールドはnullに設定されます。 このAPIを呼び出すと、新しく作成されたデプロイメントオブジェクトが返され、アセットを非同期でデプロイするバックグラウンドジョブが開始されます。 デプロイメントの完了後にassets配列に含まれるフィールドの詳細については、デプロイメントを取得を参照してください。

名前タイプ説明
idintegerデプロイメントID。
created_attimestampデプロイメントが作成された時刻。
updated_attimestampデプロイメントが最後に更新された時刻。
titlestringデプロイメントのタイトル。 リクエストで指定されていない場合、これはnullです。
説明stringデプロイメントの説明。 リクエストで指定されていない場合、これはnullになります。
project_build_idintegerデプロイメントに関連付けられているプロジェクトビルドのID。
environment_typestringプロジェクトのデプロイ先のEnvironment。
project_idstringデプロイされたプロジェクトのID。
statestringデプロイメントの現在の状態。
detailed_statestringデプロイメントの現在の状態に関する詳細な説明。
performed_by_namestringプロジェクトをデプロイしたユーザーの名前。
assets配列デプロイメントに含まれるアセットの配列。

400 BAD REQUEST - 必須パラメータが不足しています

リクエストの形式が正しくない場合、APIは400 BAD REQUESTステータスと次のエラーを返すことがあります:

environment_typeパラメータが不足しています:

{
   "message": "Missing parameter environment_type"
}

404 NOT FOUND - 無効なパラメータ

APIは、次の理由により404 NOT FOUNDステータスとNot foundエラーを返すことがあります:

  • 無効なid
  • 無効なenvironment_type

404 NOT FOUND - 無効なURI

APIは、次の理由により404 NOT FOUNDステータスとAPI not foundエラーを返すことがあります:

  • サポートされていないメソッド
  • 正しくないURI

デプロイメントを取得 ​

一意のIDで単一のデプロイメントを取得します。

shell
GET /api/deployments/:id

リクエスト ​

URLパラメータ ​

名前タイプ説明
idinteger
必須		取得するデプロイメントのID。

リクエスト例 ​

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

レスポンス ​

200 OK

成功すると、APIは200 OKステータスと単一のデプロイメントオブジェクトを返します。

json
{
    // Fields related to reviews and approvals (for example, review_state, reviews, status, comment, reviewer_name)
    // are returned only when reviews and approvals are enabled.
    "id": 43,
    "created_at": "2024-10-15T12:28:40.779-07:00",
    "updated_at": "2024-10-15T12:29:21.292-07:00",
    "title": "Sample deployment",
    "description": "",
    "project_build_id": 46,
    "environment_type": "test",
    "project_id": "10416",
    "state": "success",
    "detailed_state": "deploy_finished",
    "performed_by_name": "Charlie",
    "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"
        }
    ]
}
名前タイプ説明
idintegerデプロイメントID。
created_attimestampデプロイメントが作成された時刻。
updated_attimestampデプロイメントが最後に更新された時刻。
説明string
project_build_idintegerデプロイメントに関連付けられているプロジェクトビルドのID。
environment_typestringデプロイメントに関連付けられているEnvironment。
project_idstringデプロイメントに関連付けられているプロジェクトのID。
statestringデプロイメントの現在の状態。
detailed_statestringデプロイメントの現在の状態に関する詳細な説明。
performed_by_namestringデプロイメントを実行したユーザーの名前。
assets配列デプロイメントに含まれるアセットの配列。
assets[id]integer
assets[name]stringアセットの名前。
assets[type]stringアセットタイプ。
assets[state]string
assets[folder]stringアセットを含むフォルダ。

assets配列には、ターゲットEnvironment内のデプロイメントのアセットについて、名前、タイプ、フォルダ、状態などの詳細が示されます。

各アセットのidフィールドには、ターゲットEnvironment内の一意の識別子が含まれます。 "state": "new"のアセットは、ターゲットEnvironmentにまだ存在しないため、id: nullになります。 これらのアセットは、デプロイメント中に作成されるとIDを受け取ります。 "state": "updated"または"state": "deleted"のアセットは、ターゲットEnvironmentにすでに存在し、既存のidを含みます。

たとえば、JSONレスポンスでは、SalesforceとZendeskのコネクションは新しいアセットであるため、それらのid値はnullです。 これらのアセットは、デプロイメント中にターゲットEnvironmentで作成されるとIDを受け取ります。

404 NOT FOUND - 無効なパラメータ

APIは、次の理由により404 NOT FOUNDステータスとNot foundエラーを返すことがあります:

  • 無効なdeployment_id
  • 無効なid
  • 無効なenvironment_type

404 NOT FOUND - 無効なURI

APIは、次の理由により404 NOT FOUNDステータスとAPI not foundエラーを返すことがあります:

  • サポートされていないメソッド
  • 正しくないURI

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

デプロイメントのリストを取得します。 クエリパラメータを使用して、特定のプロジェクト、フォルダ、日付範囲などに結果を絞り込むことができます。

shell
GET /api/deployments

リクエスト ​

クエリパラメーター ​

名前タイプ説明
project_idstring
任意		プロジェクトID。 指定した場合、プロジェクトに関連付けられているデプロイメントのみがレスポンスに含まれます。
folder_idstring
任意		f{:folder_id}形式のフォルダID。 例: f660222。 指定した場合、フォルダに関連付けられているデプロイメントのみがレスポンスに含まれます。

これらのIDを取得するには、フォルダのリストエンドポイントを使用します。
environment_typestring
任意		Environmentタイプ。 指定した場合、指定したEnvironmentに関連付けられているデプロイメントのみがレスポンスに含まれます。 使用可能な値は次のとおりです:
  • sandbox
  • test
  • stage
  • uat
  • preprod
  • prod
statestring
任意		取得するデプロイメントの状態。 指定した場合、指定された状態のデプロイメントのみがレスポンスに含まれます。 次のいずれかである必要があります:
  • pending
  • success
  • failed
fromtimestamp
任意		この時刻より後に作成されたデプロイメントがレスポンスに含まれます。 値はISO 8601タイムスタンプである必要があります。
totimestamp
任意		この時刻より後に作成されたデプロイメントがレスポンスに含まれます。 値はISO 8601タイムスタンプである必要があります。

リクエスト例 ​

クエリパラメータなし ​
shell
curl  -X GET https://www.workato.com/api/deployments \
      -H 'Authorization: Bearer <api_token>'
フォルダIDを使用 ​
shell
curl  -X GET https://www.workato.com/api/deployments?folder_id=f660222 \
      -H 'Authorization: Bearer <api_token>'

レスポンス ​

200 OK

成功すると、APIは200 OKステータスとデプロイメントオブジェクトのリストを返します。

json
{
  // Fields related to reviews and approvals (for example, review_state, reviews, status, comment, reviewer_name)
  // are returned only when reviews and approvals are enabled.
  "items": [
      {
          "id": 43,
          "created_at": "2024-10-15T12:28:40.779-07:00",
          "updated_at": "2024-10-15T12:29:21.292-07:00",
          "title": "Sample deployment",
          "description": "",
          "project_build_id": 46,
          "environment_type": "test",
          "project_id": "10416",
          "state": "success",
          "detailed_state": "deploy_finished",
          "performed_by_name": "Charlie",
          "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": 42,
          "created_at": "2024-10-14T12:28:40.779-07:00",
          "updated_at": "2024-10-14T12:29:21.292-07:00",
          "title": "",
          "description": "",
          "project_build_id": 45,
          "environment_type": "test",
          "project_id": "10416",
          "state": "pending",
          "detailed_state": "pending_review",
          "performed_by_name": "Charlie",
          "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": "pending_review",
          "reviews": [
              {
                  "status": "pending",
                  "comment": null,
                  "reviewer_name": "Alex"
              }
          ]
      },
  ]
}
名前タイプ説明
itemsarrayデプロイメントオブジェクトのリスト。
idintegerデプロイメントID。
created_attimestampデプロイメントが作成された時刻。
updated_attimestampデプロイメントが最後に更新された時刻。
titlestringデプロイメントのタイトル。
説明stringデプロイメントの説明。 デプロイメントを作成したリクエストで指定されていない場合、これはnullになります。
project_build_idintegerデプロイメントに関連付けられているプロジェクトビルドのID。
environment_typestringデプロイメントに関連付けられているEnvironment。
project_idstringデプロイメントに関連付けられているプロジェクトのID。
statestringデプロイメントの現在の状態。
detailed_statestringデプロイメントの現在の状態に関する追加の詳細。
performed_by_namestringデプロイメントを実行したユーザーの名前。
assetsarrayデプロイメントに含まれるアセットの配列。
assets[id]integerアセットID。 この値は、ターゲットEnvironmentにまだ作成されていない新しいアセットではnullです。 編集または削除されたアセットには、null以外のIDが含まれます。
assets[name]stringアセットの名前。
assets[type]stringアセットタイプ。
assets[state]stringアセットの状態。 例: new。
assets[folder]stringアセットを含むフォルダ。
review_statestringレビューの状態。 使用可能な値には、pending_review、review_approved、review_rejectedがあります。
reviewsarray of objectsデプロイメントのレビューを表すオブジェクトの配列。
statusstring特定のレビューのステータス。 使用可能な値には、pending、approved、rejectedがあります。
commentstring利用可能な場合、レビュー担当者が残したコメント。
reviewer_namestringレビュー担当者の名前。

404 NOT FOUND - 無効なURI

APIは、次の理由により404 NOT FOUNDステータスとAPI not foundエラーを返すことがあります:

  • サポートされていないメソッド
  • 正しくないURI

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

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

shell
GET /api/deployments/:id/eligible_reviewers

URLパラメータ ​

名前タイプ説明
idinteger
required		対象レビュー担当者を取得する予定のデプロイメントの一意の識別子。

サンプルリクエスト ​

shell
curl  -X GET https://www.workato.com/api/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/deployments/:id/assign_reviewers

URLパラメータ ​

名前タイプ説明
idinteger
required		レビュー担当者を割り当てる予定のデプロイメントの一意の識別子。

ペイロード ​

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

サンプルリクエスト ​

shell
curl  -X POST https://www.workato.com/api/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/deployments/:id/submit_for_review

URLパラメータ ​

名前タイプ説明
idinteger
required		レビュー用に送信するデプロイメントの一意の識別子。

サンプルリクエスト ​

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

レスポンス ​

json
{
    "success": true
}

デプロイメントを承認 ​

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

shell
POST /api/deployments/:id/approve

URLパラメータ ​

名前タイプ説明
idinteger
required		承認するデプロイメントの一意の識別子。

ペイロード ​

名前タイプ説明
commentstring
必須		承認判断を説明するコメント。

サンプルリクエスト ​

shell
curl  -X POST https://www.workato.com/api/deployments/6390/approve \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "comment": "Looks good!"
          }'

レスポンス ​

json
{
    "review": {
        "deployment_id": 6390,
        "reviewer_id": 29036,
        "status": "approved",
        "comment": "Looks good!",
        "updated_at": "2024-10-11T13:39:22.857-07:00"
    }
}

デプロイメントを却下 ​

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

shell
POST /api/deployments/:id/reject

URLパラメータ ​

名前タイプ説明
idinteger
required		却下するデプロイメントの一意の識別子。

ペイロード ​

名前タイプ説明
commentstring
必須		却下の理由を説明するコメント。

サンプルリクエスト ​

shell
curl  -X POST https://www.workato.com/api/deployments/6390/reject \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "comment": "Deployment submission rejected due to failing review criteria. Please address the issues and resubmit."
          }'

レスポンス ​

json
{
    "review": {
        "deployment_id": 6390,
        "reviewer_id": 29036,
        "status": "rejected",
        "comment": "",
        "updated_at": "2024-10-11T13:42:32.614-07:00"
    }
}

レビュー用にデプロイメントを再オープン ​

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

shell
POST /api/deployments/:id/reopen

URLパラメータ ​

名前タイプ説明
idinteger
required		再オープンするデプロイメントの一意の識別子。

サンプルリクエスト ​

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

レスポンス ​

json
{
    "success": true
}

デプロイメントレビューコメントを更新 ​

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

shell
POST /api/deployments/:id/update_review_comment

URLパラメータ ​

名前タイプ説明
idinteger
required		デプロイメントの一意の識別子。

ペイロード ​

名前タイプ説明
commentstring
必須		デプロイメントレビューの更新されたコメント。

サンプルリクエスト ​

shell
curl  -X POST https://www.workato.com/api/deployments/6390/update_review_comment \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{
            "comment": "Looks good!"
          }'

レスポンス ​

json
{
    "review": {
        "deployment_id": 6390,
        "reviewer_id": 29036,
        "status": "approved",
        "comment": "Looks good!",
        "updated_at": "2024-10-11T13:43:19.547-07:00"
    }
}

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

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

shell
POST /api/deployments/:id/deploy

URLパラメータ ​

名前タイプ説明
idinteger
required		デプロイメントの一意の識別子。

ペイロード ​

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

サンプルリクエスト ​

shell
curl  -X POST https://www.workato.com/api/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: