Register Setting Sheet

Overview

Register Setting Sheet

Classification

  • Post

API Operation Object

  • Setting Sheet

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • POST

HTTP Request Path

{api_endpoint}/v1/ordersheet/update/{tenant_id}

HTTP Request Header

Format

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

HTTP Request Body

Format

{
    "Language": 1,
    "ServiceId": 4,
    "OrderSheetId": "3aa46354-e80e-41c2-b19d-a8d9a0c394f1",
    "OrderId": "OrderId",
    "FileName": "SettingSheet.xlsm",
    "ContentType": "application/vnd.ms-excel.sheet.macroEnabled.12",
    "Data": "{data}",
    "OperationType": "11"
}

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
OrderSheetId Body String(UUID) ID to identify the Sheet required
OrderID Body String OrderId to identify this proposal required
FileName Body String Name of file name required
ContentType Body String ContentType required
Data Body binary(BASE64 encoded) Data of file required
OperationType Body String Choose 'OperationType' below required
language_id
language_id Language
1 Japanese
2 English
service_id
service_id Service Name
5 Power Systems
8 FastDNS
13 Hybrid Cloud with GCP
OperationType
OperationType description
11 Add
12 Change
13 Delete

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

  • none
Delete Proposal
Get Setting Sheet Latest