Create new device

28 Oct 2024
1 Minute to read
Contributors

Print
Dark
Light
PDF

Create new device

Updated on 28 Oct 2024
1 Minute to read
Contributors

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Post

/devices/

Operation is used to create new device. Available from product version 3.0.24.

Security

API Key

Header parameter nameAuthorization

Token issued for API consumer.

Body parameters

device to be created

object

comments

string

Remarks

connectorCount

integer

Connector count

createdBy

string

creator

createdTs

string (date-time)

Creation date and time

identification

string Required

Identification

interface

string

Interface

locationArea

string

Location area. Available from product version 3.6.

locationRack

string

Location rack. Available from product version 3.6.

locationRackRow

string

Location rack row. Available from product version 3.6.

locationSide

string

Location side. Available from product version 3.6.

locationSlot

string

Location slot. Available from product version 3.6.

locationSubSlot

string

Location sub slot. Available from product version 3.6.

locationSubrack

string

Location sub rack. Available from product version 3.6.

managementAddress

string

Management address

managementAddress2

string

Management address 2

orderNo

integer

Order number

owner

integer

Device owner

parent

integer

Parent terminal id

premise

integer Required

Telecom premises

renter

integer

Device renter

sourceSystem

integer

Source system id. Available from product version 3.4.

sourceSystemKey

integer

source system key. Available from product version 3.4.

startPin

integer

Start connector

type

integer Required

Terminal type

updatedBy

string

Last updater

updatedTs

string (date-time)

Last update date time

usageState

integer

Terminal state

Responses

201

A created Device

{
  "comments": "",
  "connectorCount": 100,
  "createdBy": "user@keypro.fi",
  "createdTs": "2099-12-18T11:00:51Z",
  "id": 12345,
  "identification": "test111",
  "interface": "",
  "managementAddress": "testAddress",
  "managementAddress2": "testAddress2",
  "orderNo": "111",
  "owner": 23679,
  "parent": 15837,
  "premise": 1300,
  "renter": 23679,
  "startPin": 1,
  "type": 2246,
  "updatedBy": "user@keypro.fi",
  "updatedTs": "2099-12-18T11:00:51Z",
  "usageState": 1463
}

object

comments

string

Remarks

connectorCount

integer

Connector count

createdBy

string

creator

createdTs

string (date-time)

Creation date and time

integer

Primary key

identification

string

Identification

interface

string

Interface

locationArea

string

Location area. Available from product version 3.6.

locationRack

string

Location rack. Available from product version 3.6.

locationRackRow

string

Location rack row. Available from product version 3.6.

locationSide

string

Location side. Available from product version 3.6.

locationSlot

string

Location slot. Available from product version 3.6.

locationSubSlot

string

Location sub slot. Available from product version 3.6.

locationSubrack

string

Location sub rack. Available from product version 3.6.

managementAddress

string

Management address

managementAddress2

string

Management address 2

orderNo

integer

Order number

owner

integer

Device owner

parent

integer

Parent terminal id

premise

integer

Telecom premises

renter

integer

Device renter

sourceSystem

integer

Source system id. Available from product version 3.4.

sourceSystemKey

integer

source system key. Available from product version 3.4.

startPin

integer

Start connector

type

integer

Terminal type

updatedBy

string

Last updater

updatedTs

string (date-time)

Last update date time

usageState

integer

Terminal state

400

There was an error in request. Usually field validation failed.

object

Fields which failed validation

property*

Array of string additionalProperties

List of validation errors for this fieldname

string

Validation error

401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}

object

details

string

Detailed description of error

Was this article helpful?

What's Next

Delete device