Get Setting Sheet Template

Overview

Get Setting Sheet Template

Classification

  • Get

API Operation Object

  • Proposal

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{api_endpoint}/v1/ordersheet/template/{tenantId}/{service_id}

HTTP Request Header

Format

X-Auth-Token: <token_id>
Language: <language_id>

HTTP Request Body

  • none

Request Parameter

Request Parameters
name style format description required/optional
tenant_id URL String(UUID) Tenant which the user have role. required
service_id URL int Choose ‘service_id’ below required
token_id Header String(token_id) - required
language_id Header int Choose ‘language_id’ below required
service_id
service_id Service Name
4 Global Server Load Balance (Global Traffic Management)
5 Power Systems
8 FastDNS
10 VMware Cloud Foundation
11 Oracle License (Physical CPU Charge)
12 Oracle License (vCPU Charge)
13 Hybrid Cloud with GCP
language_id
language_id Language
1 Japanese
2 English

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 normal end
400 Bad Request
403 Unauthorized
404 not found a specified item

HTTP Response Body

Format

{
    "FileName":"template.xlsm",
    "OrderSheetTemplate":"{data}",
    "ContentType":"application/vnd.ms-excel.sheet.macroEnabled.12"
}

Response Parameter

Response Parameters
item format description
FileName String Name of Template file
OrderSheetTemplate binary(BASE64 encoded) Data of Template file
ContentType String ContentType