API docs by Redocly

SampleAPI (1.0.0)

Download OpenAPI specification:Download

License: PolyForm Shield License 1.0.0

Sample API

customer(顧客マスタ)の登録

customer(顧客マスタ)を新規登録する

Request Body schema: application/json
customerId
required
number <number> (顧客ID)
name
string (氏名) <= 16 characters
address
string (住所) <= 128 characters

Responses

Request samples

Content type
application/json
{
  • "customerId": 0,
  • "name": "string",
  • "address": "string"
}

Response samples

Content type
application/json
{
  • "customerId": 0,
  • "name": "string",
  • "address": "string"
}

customer(顧客マスタ)の抽出

customer(顧客マスタ)を検索する

query Parameters
name
Array of strings
address
Array of strings
limit
integer [ 1 .. 100 ]
Default: 100

最大件数

customerId
number <number>

（検索済み）

Responses

Response samples

Content type
application/json
[
  • {
    }
]

customer(顧客マスタ)の取得

識別子で指定したcustomer(顧客マスタ)を取得する

path Parameters
customerId
number <number>

Responses

Response samples

Content type
application/json
{
  • "customerId": 0,
  • "name": "string",
  • "address": "string"
}

customer(顧客マスタ)の更新

識別子で指定したcustomer(顧客マスタ)を更新する

path Parameters
customerId
number <number>
Request Body schema: application/json
customerId
number <number> (顧客ID)
name
string (氏名) <= 16 characters
address
string (住所) <= 128 characters

Responses

Request samples

Content type
application/json
{
  • "customerId": 0,
  • "name": "string",
  • "address": "string"
}

Response samples

Content type
application/json
{
  • "customerId": 0,
  • "name": "string",
  • "address": "string"
}

customer(顧客マスタ)の削除

識別子で指定したcustomer(顧客マスタ)を削除する

path Parameters
customerId
number <number>

Responses