Add Proposal

Overview

Add new Proposal

Classification

  • Post

API Operation Object

  • Proposal(menu/plans)

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • POST

HTTP Request Path

{api_endpoint}/v1/proposal/update/{tenant_id}

HTTP Request Header

Format

Content-Type: application/json
X-Auth-Token: <token_id>

HTTP Request Body

Format

{
    "Language": 1,
    "ServiceId": 1,
    "OrderId": "OrderId",
    "CustomerEMailAddress": "youremail@example.com",
    "ProposalXml": "{xml}"
}

Request Parameter

Request Parameters
name style format description required/optional
tenant_id URL String(UUID) Tenant which the user have role. required
token_id Header String(token_id) - required
Language Body int Choose 'language_id' below required
ServiceId Body int Choose 'service_id' below required
OrderId Body String OrderId to identify this proposal optional/reqired when update
CustomerEMailAddress Body String Your e-mail address required
ProposalXml Body xml 'XML format' below required
language_id
language_id Language
1 Japanese
2 English
service_id
service_id Service Name
1 HULFT
5 Power Systems
8 FastDNS
13 Hybrid Cloud with GCP
16 Hybrid Cloud with AWS

XML format

  • HULFT

Multiple settings are possible for HulftModel.

<?xml version="1.0"?>
<HulftModels xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CustomerEMailAddress>{e-mail address}</CustomerEMailAddress>
  <Language>{language(ja/en)}</Language>
  <Models>
    <HulftModel>
      <Uuid>{Uuid}</Uuid>
      <Dc>{Dc}</Dc>
      <Product>{Product name}</Product>
      <Cluster>{Cluster}</Cluster>
      <Aes>{Aes}</Aes>
      <Script>{Script}</Script>
      <LicensePack>{LicensePack}</LicensePack>
      <Name>{Name}</Name>
      <RowNumber>{RowNumber}</RowNumber>
      <ParentSerial>{ParentSerial}</ParentSerial>
      <Number>{Number}</Number>
      <Status>{Status}</Status>
    </HulftModel>
  </Models>
</HulftModels>
Item description
name description format
CustomerEMailAddress e-mail address
Language Corresponding language 'ja'or'en'
Uuid uuid to identify this item UUID
Dc Region name 'jp1' or 'jp2' or 'jp3' or 'jp4' or 'jp5' or 'jp6' or 'jp7'
Product Product name. Choose 'Product' or 'ProductEn' below
Cluster Existence of cluster. Choose 'Cluster' or 'ClusterEn' below
Aes Existence of AES. Choose 'AES' or 'AESEn' below
Script Existence of Script. Choose 'Script' or 'ScriptEn' below
LicensePack License Pack. Choose 'LicensePack' or 'LicensePackEn' below  
Name Item name. Choose 'Name' or 'NameEn' below
RowNumber number to identify this row(from 1 to ...) number
ParentSerial Parent SerialNo or RowNumber  
Number number of add plans number
Status
fixed '1'
description Product/Cluster/Aes/Script/LicensePack/Name
Product ProductEn LicensePack LicensePackEn Cluster ClusterEn AES AESEn Script ScriptEn Name NameEn
HULFT8 for Linux-Enterprise HULFT8 for Linux-Enterprise NULL NULL なし None なし None NULL NULL HULFT8 for Linux-Enterprise HULFT8 for Linux-Enterprise
HULFT8 for Linux-Enterprise HULFT8 for Linux-Enterprise NULL NULL なし None あり Yes NULL NULL HULFT8 for Linux-Enterprise AES暗号オプション付 HULFT8 for Linux-Enterprise with AES Cipher Option
HULFT8 for Linux-Enterprise HULFT8 for Linux-Enterprise NULL NULL あり(アクティブ機-CL) Yes (Active-CL) なし None NULL NULL HULFT8 for Linux-Enterprise CL HULFT8 for Linux-Enterprise CL
HULFT8 for Linux-Enterprise HULFT8 for Linux-Enterprise NULL NULL あり(アクティブ機-CL) Yes (Active-CL) あり Yes NULL NULL HULFT8 for Linux-Enterprise CL AES暗号オプション付 HULFT8 for Linux-Enterprise CL with AES Cipher Option
HULFT8 for Linux-Enterprise HULFT8 for Linux-Enterprise NULL NULL あり(スタンバイ機(新規)-CL Add) Yes (Stand-By(New) CL Add) なし None NULL NULL HULFT8 for Linux-Enterprise CL Add HULFT8 for Linux-Enterprise CL Add
HULFT8 for Linux-Enterprise HULFT8 for Linux-Enterprise NULL NULL あり(スタンバイ機(追加)-CL Add) Yes (Stand-By(Add) CL Add) なし None NULL NULL HULFT8 for Linux-Enterprise CL Add HULFT8 for Linux-Enterprise CL Add
HULFT8 for Linux-Enterprise HULFT8 for Linux-Enterprise NULL NULL あり(スタンバイ機(新規)-CL Add) Yes (Stand-By(New) CL Add) あり Yes NULL NULL HULFT8 for Linux-Enterprise CL Add AES暗号オプション付 HULFT8 for Linux-Enterprise CL Add with AES Cipher Option
HULFT8 for Linux-Enterprise HULFT8 for Linux-Enterprise NULL NULL あり(スタンバイ機(追加)-CL Add) Yes (Stand-By(Add) CL Add) あり Yes NULL NULL HULFT8 for Linux-Enterprise CL Add AES暗号オプション付 HULFT8 for Linux-Enterprise CL Add with AES Cipher Option
HULFT8 for Windows-Server HULFT8 for Windows-Server NULL NULL なし None なし None なし None HULFT8 for Windows-Server HULFT8 for Windows-Server
HULFT8 for Windows-Server HULFT8 for Windows-Server NULL NULL なし None なし None あり Yes HULFT8 for Windows-Server Scriptオプション付 HULFT8 for Windows-Server with Script Option
HULFT8 for Windows-Server HULFT8 for Windows-Server NULL NULL なし None あり Yes なし None HULFT8 for Windows-Server AES暗号オプション付 HULFT8 for Windows-Server with AES Cipher Option
HULFT8 for Windows-Server HULFT8 for Windows-Server NULL NULL なし None あり Yes あり Yes HULFT8 for Windows-Server AES暗号・Scriptオプション付 HULFT8 for Windows-Server with AES Cipher Option and Script Option
HULFT8 for Windows-Server HULFT8 for Windows-Server NULL NULL あり(アクティブ機-CL) Yes (Active-CL) なし None なし None HULFT8 for Windows-Server CL HULFT8 for Windows-Server CL
HULFT8 for Windows-Server HULFT8 for Windows-Server NULL NULL あり(アクティブ機-CL) Yes (Active-CL) なし None あり Yes HULFT8 for Windows-Server CL Scriptオプション付 HULFT8 for Windows-Server CL with Script Option
HULFT8 for Windows-Server HULFT8 for Windows-Server NULL NULL あり(アクティブ機-CL) Yes (Active-CL) あり Yes なし None HULFT8 for Windows-Server CL AES暗号オプション付 HULFT8 for Windows-Server CL with AES Cipher Option
HULFT8 for Windows-Server HULFT8 for Windows-Server NULL NULL あり(アクティブ機-CL) Yes (Active-CL) あり Yes あり Yes HULFT8 for Windows-Server CL AES暗号・Scriptオプション付 HULFT8 for Windows-Server CL with AES Cipher Option and Script Option
HULFT8 for Windows-Server HULFT8 for Windows-Server NULL NULL あり(スタンバイ機(新規)-CL Add) Yes (Stand-By(New) CL Add) なし None なし None HULFT8 for Windows-Server CL Add HULFT8 for Windows-Server CL Add
HULFT8 for Windows-Server HULFT8 for Windows-Server NULL NULL あり(スタンバイ機(追加)-CL Add) Yes (Stand-By(Add) CL Add) なし None なし None HULFT8 for Windows-Server CL Add HULFT8 for Windows-Server CL Add
HULFT8 for Windows-Server HULFT8 for Windows-Server NULL NULL あり(スタンバイ機(新規)-CL Add) Yes (Stand-By(New) CL Add) なし None あり Yes HULFT8 for Windows-Server CL Add Scriptオプション付 HULFT8 for Windows-Server CL Add with Script Option
HULFT8 for Windows-Server HULFT8 for Windows-Server NULL NULL あり(スタンバイ機(追加)-CL Add) Yes (Stand-By(Add) CL Add) なし None あり Yes HULFT8 for Windows-Server CL Add Scriptオプション付 HULFT8 for Windows-Server CL Add with Script Option
HULFT8 for Windows-Server HULFT8 for Windows-Server NULL NULL あり(スタンバイ機(新規)-CL Add) Yes (Stand-By(New) CL Add) あり Yes なし None HULFT8 for Windows-Server CL Add AES暗号オプション付 HULFT8 for Windows-Server CL Add with AES Cipher Option
HULFT8 for Windows-Server HULFT8 for Windows-Server NULL NULL あり(スタンバイ機(追加)-CL Add) Yes (Stand-By(Add) CL Add) あり Yes なし None HULFT8 for Windows-Server CL Add AES暗号オプション付 HULFT8 for Windows-Server CL Add with AES Cipher Option
HULFT8 for Windows-Server HULFT8 for Windows-Server NULL NULL あり(スタンバイ機(新規)-CL Add) Yes (Stand-By(New) CL Add) あり Yes あり Yes HULFT8 for Windows-Server CL Add AES暗号・Scriptオプション付 HULFT8 for Windows-Server CL Add with AES Cipher Option and Script Option
HULFT8 for Windows-Server HULFT8 for Windows-Server NULL NULL あり(スタンバイ機(追加)-CL Add) Yes (Stand-By(Add) CL Add) あり Yes あり Yes HULFT8 for Windows-Server CL Add AES暗号・Scriptオプション付 HULFT8 for Windows-Server CL Add with AES Cipher Option and Script Option
HULFT8 Manager HULFT8 Manager NULL NULL NULL NULL NULL NULL NULL NULL HULFT8 Manager HULFT8 Manager

Use En when Language=en

Not required when NULL

  • Power Systems / FastDNS / Hybrid Cloud with GCP / Hybrid Cloud with AWS

Multiple settings are possible for GenericModel. For PowerSystems, Models must be empty.

<?xml version="1.0"?>
<GenericModels xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OrderId>{OrderId}</OrderId>
  <CustomerEMailAddress>{CustomerEMailAddress}</CustomerEMailAddress>
  <Language>{Language}</Language>
  <Models>
    <GenericModel>
      <Uuid>{Uuid}</Uuid>
      <Id>{Id}</Id>
      <RowNumber>{RowNumber}</RowNumber>
      <Number>{Number}</Number>
      <Status>{Status}</Status>
    </GenericModel>
  </Models>
</GenericModels>
Item description
name description format
OrderId OrderId to identify this proposal(reqired when update)
CustomerEMailAddress e-mail address
Language Corresponding language 'ja'or'en'
Uuid uuid to identify this item UUID
Id ID of Plans. Choose 'Id' below  
RowNumber number to identify this row(from 1 to ...) number
Number number of add plans number
Status
fixed '1'
Id
Id ServiceId Name NameEn
401 4 2FQDN Plan 2FQDN Plan
402 4 5FQDN Plan 5FQDN Plan
801 8 1zone Plan 1zone Plan
802 8 2zone Plan 2zone Plan
803 8 3zone Plan 3zone Plan
804 8 4zone Plan 4zone Plan
805 8 5zone Plan 5zone Plan
806 8 6zone Plan 6zone Plan
807 8 7zone Plan 7zone Plan
808 8 8zone Plan 8zone Plan
1301 13 標準プラン basic plan

Response

HTTP Response Header

Format

HTTP/1.1 <response code> <message> (ex. 200 OK)
  • <response_code>: see "HTTP Responses" section
  • <message>: message based on the response code

Response Code

Response Codes
response code condition
200 Success
400 Bad Request
403 Forbidden
404 Not Found

HTTP Response Body

Format

{
    "OrderId": "OrderId",
    "Result": true
}

Response Parameter

Response Parameters
item format description
OrderId String OrderId to identify this proposal
Result Boolean Request result