GET API/AsyncApi/GetStatus?RequestId={RequestId}

要求IDに対応する非同期APIの実行ステータスを取得します。

Request Information

URI Parameters

NameDescriptionTypeAdditional information
RequestId

要求ID

string

Required

Body Parameters

None.

Response Information

Resource Description

非同期APIの実行ステータス

AsyncApiResultViewModel
NameDescriptionTypeAdditional information
RequestId

要求ID

string

None.

Status

実行状態 Request Start End Error のいずれか

string

None.

RequestDate

要求開始日

date

None.

EndDate

終了日

date

None.

Response Formats

application/json

Sample:
{
  "RequestId": "sample string 1",
  "Status": "sample string 2",
  "RequestDate": "2020-09-26T07:49:44.2559167+00:00",
  "EndDate": "2020-09-26T07:49:44.2559167+00:00"
}

text/json

Sample:
{
  "RequestId": "sample string 1",
  "Status": "sample string 2",
  "RequestDate": "2020-09-26T07:49:44.2559167+00:00",
  "EndDate": "2020-09-26T07:49:44.2559167+00:00"
}

application/xml

Sample:
<AsyncApiResultViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JP.DataHub.ApiWeb.Models.AsyncApi">
  <EndDate>2020-09-26T07:49:44.2559167+00:00</EndDate>
  <RequestDate>2020-09-26T07:49:44.2559167+00:00</RequestDate>
  <RequestId>sample string 1</RequestId>
  <Status>sample string 2</Status>
</AsyncApiResultViewModel>

text/xml

Sample:
<AsyncApiResultViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/JP.DataHub.ApiWeb.Models.AsyncApi">
  <EndDate>2020-09-26T07:49:44.2559167+00:00</EndDate>
  <RequestDate>2020-09-26T07:49:44.2559167+00:00</RequestDate>
  <RequestId>sample string 1</RequestId>
  <Status>sample string 2</Status>
</AsyncApiResultViewModel>