POST api/Thing

Request Information

URI Parameters

None.

Body Parameters

RegisterRequest
NameDescriptionTypeAdditional information
thing_name

string

Required

String length: inclusive between 5 and 128

thing_type

string

Required

Matching regular expression pattern: ibase_esp32_board|ibase_mobile_app

thing_group

string

Required

Matching regular expression pattern: ibase_esp32_board|ibase_mobile_app

Request Formats

application/json, text/json

Sample:
{
  "thing_name": "sample string 1",
  "thing_type": "sample string 2",
  "thing_group": "sample string 3"
}

application/xml, text/xml

Sample:
<RegisterRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iBasement.Controllers">
  <ThingGroup>sample string 3</ThingGroup>
  <ThingName>sample string 1</ThingName>
  <ThingType>sample string 2</ThingType>
</RegisterRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'RegisterRequest'.

Response Information

Resource Description

RegisterResponse
NameDescriptionTypeAdditional information
thing_name

string

None.

thing_type

string

None.

thing_group

string

None.

root_certificate

string

None.

client_certificate

string

None.

client_private_key

string

None.

Response Formats

application/json, text/json

Sample:
{
  "thing_name": "sample string 1",
  "thing_type": "sample string 2",
  "thing_group": "sample string 3",
  "root_certificate": "sample string 4",
  "client_certificate": "sample string 5",
  "client_private_key": "sample string 6"
}

application/xml, text/xml

Sample:
<RegisterResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/iBasement.Controllers">
  <ClientCertificate>sample string 5</ClientCertificate>
  <ClientPrivateKey>sample string 6</ClientPrivateKey>
  <RootCertificate>sample string 4</RootCertificate>
  <ThingGroup>sample string 3</ThingGroup>
  <ThingName>sample string 1</ThingName>
  <ThingType>sample string 2</ThingType>
</RegisterResponse>