非同期呼び出しの概要

完了していない呼び出しの応答例

以下に、まだ完了していない非同期呼び出しの /requests 応答の一部を示します。

{
    "data": {
        "attributes": {
            "requestMethod": "POST",
            "requestPath": "/admin/v1/users",
            "responseStatus": 202,
            "startTime": "2022-07-12T16:53:12.365Z",
            "status": {
                "code": "Accepted",
                "name": "Accepted"
            }
        }
    }
}

完了している呼び出しの応答例

以下に、完了している非同期呼び出しの /requests 応答の一部を示します。

{
    "data": {
        "attributes": {
            "completionTime": "2022-07-12T16:53:16.073Z",
            "requestMethod": "POST",
            "requestPath": "/admin/v1/users",
            "responseBodyJson": {
                "data": {
                    "attributes": {
                        ...
                        "username": "asyncUser99",
                        "vacationStatus": {
                            "code": "atwork",
                            "name": "At work"
                        }
                    },
                    "checksum": "321dff263827cbbd772c26676398d8ae",
                    "links": {
                    ...
                    }
                }
            },
            "responseHeaders": {
                "Cache-Control": [
                    "must-revalidate",
                    "post-check=0",
                    "pre-check=0",
                    "max-age=0",
                    "no-store",
                    "no-cache"
                ],
                "Content-Type": [
                    "application/json;charset=UTF-8"
                ],
                "GW-Checksum": [
                    "321dff263827cbbd772c26676398d8ae"
                ],
                "Location": [
                    "/admin/v1/users/pc:ScaA3kB5cImBkuh7bxjNn"
                ],
                "X-Correlation-ID": [
                    "d516344d-5769-4964-adb7-79eaca41e4a2"
                ],
                ...
            },
            "responseStatus": 201,
            "startTime": "2022-07-12T16:53:12.365Z",
            "status": {
                "code": "Complete",
                "name": "Complete"
            }
        }
        ...
    }
}

元の要求が完了するまでのポーリング

呼び出し元アプリケーションは、ステータスが完了の応答を受け取るまで、クラウド API を定期的にポーリングします。これについては、次の図で説明します。

1. 呼び出し元アプリケーションが GET /async/v1/requests/{asyncRequestId} 要求をクラウド API に送信します。このパスは最初の応答のヘッダーから取得できます。
2. クラウド API 応答には、元の要求に関する情報が含まれます。ステータスが受理済みまたは進行中の場合は、呼び出し元アプリケーションは適切な間隔を置いて GET を再送信する必要があります。

応答に完了ステータスが含まれる場合は、呼び出し元は元の要求に対する応答を取得できます。複数の取得方法があります。