Skip to content

Add device type module

POST
/api/device-types/{id}/modules
curl --request POST \
--url http://localhost:3000/api/device-types/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/modules \
--header 'Content-Type: application/json' \
--cookie session=<session> \
--data '{ "sku": "example", "name": "example", "description": "example", "slotLabel": "example", "connectorType": "example", "speeds": [ "example" ], "portCount": 1, "poeStandard": "example", "poeWatts": 1, "notes": "example", "sortOrder": 0 }'
id
required
string format: uuid
Media type application/json
object
sku
required
string
name
required
string
description
string
slotLabel
string
connectorType
string
speeds
Array<string>
portCount
integer
poeStandard
string
poeWatts
integer
notes
string
sortOrder
integer
0

Module created

Media type application/json
object
data
object
id
required
string format: uuid
deviceTypeId
required
string format: uuid
sku
required
string
name
required
string
description
string
nullable
slotLabel
string
nullable
connectorType
string
nullable
speeds
Array<string>
portCount
integer
nullable
poeStandard
string
nullable
poeWatts
integer
nullable
notes
string
nullable
sortOrder
integer
source
string
Allowed values: vendor customer
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
{
"data": {
"source": "vendor"
}
}

Validation error

Media type application/json
object
error
required
string
Example
{
"error": "Not found"
}

Not authenticated

Media type application/json
object
error
required
string
Example
{
"error": "Not found"
}

Device type not found

Media type application/json
object
error
required
string
Example
{
"error": "Not found"
}