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

Lookup status of asynchronous API task by request ID.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
RequestId

Request ID

 string

Required

Body Parameters

None.

Response Information

Resource Description

Status of asynchronous API task

AsyncApiResultViewModel
NameDescriptionTypeAdditional information
RequestId

Request ID

 string

None.
Status

Possible Process Statuses: Request Start End Error

 string

None.
RequestDate

Requested start date

 date

None.
EndDate

End date

 date

None.

Response Formats

application/json

Sample: 
{
  "RequestId": "sample string 1",
  "Status": "sample string 2",
  "RequestDate": "2025-01-05T03:22:32.1561116+00:00",
  "EndDate": "2025-01-05T03:22:32.1561116+00:00"
}

text/json

Sample: 
{
  "RequestId": "sample string 1",
  "Status": "sample string 2",
  "RequestDate": "2025-01-05T03:22:32.1561116+00:00",
  "EndDate": "2025-01-05T03:22:32.1561116+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>2025-01-05T03:22:32.1561116+00:00</EndDate>
  <RequestDate>2025-01-05T03:22:32.1561116+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>2025-01-05T03:22:32.1561116+00:00</EndDate>
  <RequestDate>2025-01-05T03:22:32.1561116+00:00</RequestDate>
  <RequestId>sample string 1</RequestId>
  <Status>sample string 2</Status>
</AsyncApiResultViewModel>