Cancel Host-based Security


Overview

Cancel the order of Host-based Security.


API Operation Object

  • Host-based Security order


Synchronous / Asynchronous

  • Synchronous


Request

HTTP Request Method

  • POST


HTTP Request Path

{endpoint}/API/SoEntryHBS

HTTP Request Header

X-Auth-Token: <token_id>

Request Parameter

Request Parameters

item

Required

type

format

description

sokind

yes

String

-

C: Cancel Host-based Security

mailaddress

yes

String

-

Contactable mail address

tenant_id

yes

String

UUID

Tenant ID of the owner (UUID)

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

{
   "tenant_id": "7c510f7b9a9248e48c1b4c3887b61bd7",
   "sokind": "C",
   "locale": "en",
   "mailaddress": "test@rfg.co.jp"
}

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.DEP-**: Successful Completion DEP-E**: Error has occurred

message

String

-

This message is shown when error has occurred.

soId

String

-

Identification ID of Service Order.

status

integer

-

This value indicates normal or abnormal. 1:normal, 2:abnormal


Sample Response Body

Normal Response

When locale is "ja"

{
    "code": "DEP-01",
    "message": "正常終了",
    "soId": "HBS_FT64D7781E8541B298FCFE418909B44C0",
    "status": 1
}

When locale is "en"
{
    "code": "DEP-01",
    "message": "Successful completion",
    "soId": "HBS_FT64D7781E8541B298FCFE418909B44C0",
    "status": 1
}

Error Response

When locale is "ja"

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

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