Product UpdatesStatus PageWorkato Academy
English
日本語
Get a trial
開発者用 API
リソース

ジョブ ​

タイプリソース説明
GET/api/recipes/:recipe_id/jobsレシピからのジョブを列挙します。
GET/api/recipes/:recipe_id/jobs/:job_handleレシピからのジョブ ID のマッピングを列挙します。
GET/api/recipes/:recipe_id/jobs/id_mappingsレシピからのジョブ ID のマッピングを列挙します。

レシピからのジョブの列挙 ​

Workato 内の指定されたレシピに対する、集計されたジョブ情報および詳細なジョブ情報を返します。

GET /api/recipes/:recipe_id/jobs

実行時データは含まれない

実行時データとは、ジョブの実行時にレシピ内で使用されるデータです。これには、個々のステップからの入力および出力データが含まれます。

このデータは、Workato プラットフォームのジョブの詳細ページで確認できます。

URL パラメータ ​

名前型説明
recipe_idinteger
必須		レシピ ID。

クエリーパラメータ ​

名前型説明
offset_job_idstring
任意		オフセットジョブ ID。このジョブ ID 後に実行されたジョブを返します。
prevboolean
任意		true の場合は前のジョブ、false の場合は次のジョブ。
statusstring
任意		ステータス (succeeded、failed、または pending) 別にフィルタリングします。
rerun_onlyboolean
任意		true の場合、再実行されたジョブのみを返します。
offset_run_idinteger
(廃止)		オフセット実行 ID。このパラメータは廃止されています。
failedboolean
(廃止)		true の場合、失敗したジョブのみを返します。このパラメータは廃止されています。

サンプルリクエスト ​

shell
curl  -X GET 'https://www.workato.com/api/recipes/28904/jobs' \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>'

レスポンス ​

json
{
  "job_succeeded_count": 1,
  "job_failed_count": 1,
  "job_count": 1,
  "items": [
    {
      "id": "j-KGAKfhsz-GYoLe",
      "flow_run_id": 1004,
      "completed_at": "2015-01-02T01:02:03.000Z",
      "started_at": "2015-01-02T01:02:03.000Z",
      "title": "Callable recipes by Workato: new call for recipe: Calling IP address=129.1.1.1, Access profile ID=123456, and Access profile name=recipe_test",
        "is_poll_error": false,
        "error": null,
        "is_error": false
    },
    {
      "id": "j-AD9bJn99-hsCXcs",
      "flow_run_id": 1005,
      "completed_at": "2015-01-02T01:02:03.000Z",
      "started_at": "2015-01-02T01:02:03.000Z",
      "title": "Callable recipes by Workato: new call for recipe: Calling IP address=129.1.1.1, Access profile ID=123456, and Access profile name=recipe_test",
      "is_poll_error": false,
      "error": "Callable recipes by Workato: new call for recipe: Calling IP address=129.1.1.1, Access profile ID=123456, and Access profile name=recipe_test",
      "error_parts": {
        "adapter": "marketo",
        "error_type": "Missing required field",
        "message": "'Filter values' must be present",
        "error_id": "603260f5-a309-45b3-a20e-111d90a28917",
        "error_at": "2020-01-22T01:17:18.021-08:00",
        "input": "<redacted>",
        "inner_message": null
      },
      "is_error": true
    },
  ]
}

ジョブの取得 ​

ジョブハンドルで指定された1つのジョブのメタデータを返します。

GET /api/recipes/:recipe_id/jobs/:job_handle

実行時データは含まれない

実行時データとは、ジョブの実行時にレシピ内で使用されるデータです。これには、個々のステップからの入力および出力データが含まれます。

このデータは、Workato プラットフォームのジョブの詳細ページで確認できます。

URL パラメータ ​

名前型説明
recipe_idinteger
必須		レシピ ID。
job_handlestring
必須		ジョブの一意の識別子。

クエリーパラメータ ​

名前型説明
offset_job_idstring
任意		オフセットジョブ ID。このジョブ ID 後に実行されたジョブを返します。
prevboolean
任意		true の場合は前のジョブ、false の場合は次のジョブ。
statusstring
任意		ステータス (succeeded、failed、または pending) 別にフィルタリングします。
rerun_onlyboolean
任意		true の場合、再実行されたジョブのみを返します。
offset_run_idinteger
(廃止)		オフセット実行 ID。このパラメータは廃止されています。
failedboolean
(廃止)		true の場合、失敗したジョブのみを返します。このパラメータは廃止されています。

サンプルリクエスト ​

shell
curl  -X GET 'https://www.workato.com/api/recipes/28904/jobs' \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>'

レスポンス ​

json
{
  "job_succeeded_count": 1,
  "job_failed_count": 1,
  "job_count": 1,
  "items": [
    {
      "id": "j-KGAKfhsz-GYoLe",
      "flow_run_id": 1004,
      "completed_at": "2015-01-02T01:02:03.000Z",
      "started_at": "2015-01-02T01:02:03.000Z",
      "title": "Callable recipes by Workato: new call for recipe: Calling IP address=129.1.1.1, Access profile ID=123456, and Access profile name=recipe_test",
        "is_poll_error": false,
        "error": null,
        "is_error": false
    },
    {
      "id": "j-AD9bJn99-hsCXcs",
      "flow_run_id": 1005,
      "completed_at": "2015-01-02T01:02:03.000Z",
      "started_at": "2015-01-02T01:02:03.000Z",
      "title": "Callable recipes by Workato: new call for recipe: Calling IP address=129.1.1.1, Access profile ID=123456, and Access profile name=recipe_test",
      "is_poll_error": false,
      "error": "Callable recipes by Workato: new call for recipe: Calling IP address=129.1.1.1, Access profile ID=123456, and Access profile name=recipe_test",
      "error_parts": {
        "adapter": "marketo",
        "error_type": "Missing required field",
        "message": "'Filter values' must be present",
        "error_id": "603260f5-a309-45b3-a20e-111d90a28917",
        "error_at": "2020-01-22T01:17:18.021-08:00",
        "input": "<redacted>",
        "inner_message": null
      },
      "is_error": true
    },
  ]
}

レシピからのジョブ ID のマッピングの列挙 ​

特定のレシピに対するすべてのジョブ ID のマッピングを返します。

GET /api/recipes/:recipe_id/jobs/id_mappings

ジョブ ID のマッピング API のサポート

Workato は、今後6か月または2023年2月1日まで、この API エンドポイントをサポートすることを約束します。

URL パラメータ ​

名前型説明
recipe_idinteger
必須		レシピ ID。

クエリーパラメータ ​

名前型説明
limitinteger
任意		取得するジョブ ID のマッピングの数。デフォルトで10,000に設定されます。
offset_job_idstring
任意		オフセットジョブ ID。このジョブ ID 後に実行されたジョブを返します。数値と文字列の両方のジョブ ID を受け付けます。

サンプルリクエスト ​

shell
curl  -X GET 'https://www.workato.com/api/recipes/28904/jobs/id_mappings' \
      -H 'x-user-email: <email>' \
      -H 'x-user-token: <token>'

レスポンス ​

shell
14004191049,j-ADt1PHzN-At0MtR
14004195305,j-ADt1PbMP-T30bPH
14004151595,j-ADt1TYh8-nD0XfC
14004161099,j-ADt1W63w-MW0cnw
14004176766,j-ADt1WtXW-w80PH9
14004184037,j-ADt1XLHn-cR4AWF
14004117662,j-ADt1YoeC-Hz0pBe
14004143161,j-ADt1bFTt-Aw0YLh
14004155023,j-ADt1bz6m-Fp0EJM
14004161914,j-ADt1cKML-kx0wka

Last updated: