メタデータ API 開発者ガイド
jREST を使用した処理中のリリースのキャンセル
すでに処理中のリリースのキャンセルを要求できます。キャンセルの要求を行うには、継続中の deployRequest の状況にパッチを適用します。キャンセルは非同期で処理されます。
- URI
- https://host/services/data/vXX.0/metadata/deployRequest/deployRequestId
- 形式
- JSON
- HTTP メソッド
- PATCH
- 認証
- Authorization: Bearer token
リクエストボディ: リリースのキャンセルの要求
リリースのキャンセルの JSON リクエストボディには、元の deployRequest の状況に対する PATCH が含まれます。
1{
2 "deployResult":
3 {
4 "status" : "Canceling"
5 }
6 }レスポンスボディ: リリースのキャンセルの要求
キャンセル要求は非同期で処理されるため、レスポンスボディに表示される状況は Canceling または Canceled のいずれかになります。
1{
2 "id" : "0Afxx00000000lWCAQ"
3 "url" : “https://host/services/data/vXX.0/metadata/deployRequest/0Afxx00000000lWCAQ",
4 "deployResult":
5 {
6 "checkOnly" : "false",
7 "ignoreWarnings" : "false",
8 "rollbackOnError" : "false",
9 "status : "Canceling", // or Canceled
10 "numberComponentsDeployed" : "10",
11 "numberComponentsTotal" : "1032",
12 "numberComponentErrors" : "0",
13 "numberTestsCompleted" : "45",
14 "numberTestsTotal" : "135",
15 "numberTestErrors" : "0",
16 "details" : {
17 "componentFailures" : [],
18 "componentSuccesses" : [],
19 "retrieveResult" : null,
20 "runTestResults” : {
21 "numRun" : 0,
22 "successes" : [ … ],
23 "failures" : []
24 }
25 },
26
27 "createdDate" : "2017-10-10T08:22Z",
28 "startDate" : "2017-10-10T08:22Z",
29 "lastModifiedDate" : "2017-10-10T08:44Z",
30 "completedDate" : "2017-10-10T08:44Z",
31 "errorStatusCode" : null,
32 "errorMessage" : null,
33 "stateDetail" : "Processing Type: Apex Component",
34 "createdBy" : "005xx0000001Sv1m",
35 "createdByName" : "steve stevens",
36 "canceledBy" : null,
37 "canceledByName" : null,
38 "isRunTestsEnabled" : null
39 }
40 }202 (承諾済み) の HTTP 状況コードが返された場合は、キャンセル要求が処理中か成功したことを意味します。