指定したプロセスのステータスを返します。プロセスが完了しているかどうかや、複数のインポートがある場合はインポート中に失敗した行に関する情報を含む一つ以上のインポート ダンプ ファイルがあるかどうか (failureDumpAvailable) などです。
レスポンスには以下が含まれます。
| レスポンス値 | 説明 |
| currentStep | 指定した taskID に関連付けられたタスク。 |
| taskState | プロセス タスクのステータス。 次の値があります。 NOT_STARTED: 予定されているが開始されていない IN_PROGRESS: 現在実行中 COMPLETE: 正常に終了、または失敗により終了 CANCELLING: 取り消し実行中 CANCELLED: 取り消しを完了してすべての変更をロールバック |
| progress | どの程度タスクが完了したかを表すパーセンテージ。 値の範囲は 0.0 (開始前) ～ 1.0 (完了) です。 |
| failureDumpAvailable | 真であれば、利用できるダンプ ファイルがある。 |
| nestedResults | プロセスで実行された操作が正常に完了したかどうかを示す。これには JSON 配列形式の詳細が含まれ、エラーが発生した際のデバッグ情報も含まれます。 エラー ダンプ ファイルを取得して完全なデバッグ情報を確認してください。 |
| objectID | プロセス タスク又はそれに含まれているタスクの識別子。 |
メソッドとエンドポイント
GET
https://api.anaplan.com/2/0/workspaces/{workspaceID}/models/{modelID}processes/{processID}/tasks/{taskID}
パラメーター
| パラメーター | 説明 |
| AnaplanAuthToken:{token} | Anaplan の認証トークンの値 |
| workspaceID | ワークスペース ID |
| modelID | モデル ID |
| processID | プロセス ID |
| taskID | プロセス タスクの ID |
Curl のサンプル
curl -X GET \ https://api.anaplan.com/2/0/workspaces/0a800b00e0000000f000001eab0d0000/models/F1111111C11111111B11111F1111E11F/processes/118000000001/tasks/B7EA9FEC0FF2488B9A9E6040B6B26753 \ -H 'authorization:AnaplanAuthToken {token}' \ -H "Content-Type:application/json"
レスポンス
{
"meta":{
"schema":"https://api.anaplan.com/2/0/models/F1111111C11111111B11111F1111E11F/objects/task"
},
"status":{
"code":200,
"message":"Success"
},
"task":{
"taskId":"B7EA9FEC0FF2488B9A9E6040B6B26753",
"currentStep":"Failed.",
"progress":0.0,
"result":{
"details":[
{
"localMessageText":"The uploaded file is no longer available; please upload the file again",
"occurrences":0,
"type":"internalError"
}
],
"failureDumpAvailable":false,
"nestedResults":[
{
"details":[
{
"localMessageText":"The uploaded file is no longer available; please upload the file again",
"occurrences":0,
"type":"importFailedGeneralError",
"values":[
"errorMessage",
"The uploaded file is no longer available; please upload the file again"
]
}
],
"failureDumpAvailable":false,
"objectId":"112000000000",
"successful":false
},
{
"details":[
{
"occurrences":0,
"type":"exportSucceeded",
"values":[
"fileSize",
"0",
"serverAlert",
null,
"exportName",
null
]
}
],
"failureDumpAvailable":false,
"objectId":"116000000004",
"successful":false
}
],
"objectId":"118000000001",
"successful":false
},
"taskState":"COMPLETE",
"creationTime":1570823656906
}
}
