Get Service Order Status


Overview

Check progress status of Managed WAF device Service Order.


API Operation Object

  • Managed WAF device service order

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{endpoint}/API/ScreenEventFGWAFOrderProgressRate?tenant_id={tenant_id}&locale={locale}&soid={soid}

HTTP Request Header

X-Auth-Token: <token_id>

Request Parameter

Request Parameters
item Required type format description
tenant_id yes String UUID Tenant ID of the owner (UUID)
soId yes String - This value is returned value of when you execute Create Server, Update Server or Delete Server API
locale no String - Messages are displayed in Japanese or English depending on this value. ja: Japanese, en: English. Default value is "en".

Sample Request Body

This request does not include a request body.


Response

HTTP Response Code

Response Codes
Response Code Description
200 OK
400 Request format is invalid
401 Unauthorized
500 Internal Server Error
511 Internal Server Error (Fail Service Order etc.)

Response Parameter

Response Parameters
item type format description
code String - This code is for determining the details of the error.FOW-**: Successful Completion. FOW-E**: Error has occurred.
message String - This message is shown when error has occurred.
progressRate String - Percentage of Service Order Progress Status
status integer - This value indicates normal or abnormal. 1:normal, 2:abnormal

Sample Response Body

Normal Response

When locale is "ja"

{
    "code": "FOW-01",
    "message": "正常終了",
    "progressRate": "20",
    "status": 1
}

When locale is "en"
{
    "code": "FOW-01",
    "message": "Successful completion",
    "progressRate": "20",
    "status": 1
}

Error Response

When locale is "ja"

{
    "code": "FOW-E",
    "message": "システムエラーが発生しました。恐れ入りますが、チケットシステムでご連絡ください。",
    "status": 2
}

When locale is "en"
{
    "code": "FOW-E",
    "message": "System error has occurred. Excuse me, please contact us at the ticket system.",
    "status": 2
}
Delete Device
List Devices