1. REST API

一括編集ジョブ

日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

各一括編集ジョブは、一括編集ジョブリソースによって表されます。このリソースを使用して、ジョブの状態を取得したり、ジョブをキャンセルしたりできます。

サポートされている方法は、GET、HEAD、PUT、およびPOSTです。

GET /api/massedits/id

ジョブの状態を含む一括編集ジョブオブジェクトを返します。

リクエストの例:

GET http://<hostname>/api/massedits/1493
Host: hostname
Accept: application/json

応答の例:

HTTP/1.1 200 OK
Content-Length: content length
Content-Type: application/json; charset=utf-8
ETag: "hash string"

{
    "state_description":"Pending",
    "state":"Pending",
    "condition":"Pending",
    "started_on":"...",
    "completed_on":null,
    "target_count":215,
    "targets_completed":100,
    "self":{
        "href":"http://<hostname>/api/massedits/1493",
        "title":"This mass edit job."
    },
    "targets":{
        "href":"http/<hostname>/api/massedits/1493/targets",
        "title":"The collection of targets for this Mass Edit Job."
    }
}

PUT /api/entities/id

一括編集ジョブをキャンセルする機会を提供します。Pending 状態にあるジョブのみを取り消すには、リソースにCancelled 状態を割り当ててからPUT要求を行います。リクエスト本文には、一括編集ジョブが含まれている必要があります。すべてのプロパティは無視され、state プロパティがCancelledに設定されている場合は、そのプロパティのみがチェックされます。その後、サーバーはジョブの更新が成功したことを示すために204 No Contentで応答します。それ以外の場合、サーバーは403 Forbiddenで要求を拒否します。

リクエストの例:

PUT http://<hostname>/api/entities/1493
Host: hostname
Content-Type: application/json

{
    "state_description":"In progress",
    "state":"Cancelled",
    "condition":"Pending",
    "started_on":"...",
    "completed_on":null,
    "target_count":215,
    "targets_completed":100,
    "self":{
        "href":"http://<hostname>/api/massedits/1493",
        "title":"This mass edit job."
    },
    "targets":{
        "href":"http/<hostname>/api/massedits/1493/targets",
        "title":"The collection of targets for this Mass Edit Job."
    }
}

応答の例:

HTTP/1.1 204 No Content
この記事を改善するための提案がある場合は、 お知らせください!