Skip to content

Update device type module

PATCH
/api/device-types/{id}/modules/{moduleId}
 
curl --request PATCH \
  --url http://localhost:3000/api/device-types/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/modules/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --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": 1 }'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string format: uuid
moduleId
required
string format: uuid

Request Body required

Section titled “Request Body required ”
Media type application/json
object
sku
string
name
string
description
string
slotLabel
string
connectorType
string
speeds
Array<string>
portCount
integer
poeStandard
string
poeWatts
integer
notes
string
sortOrder
integer
Example generated
{
  "sku": "example",
  "name": "example",
  "description": "example",
  "slotLabel": "example",
  "connectorType": "example",
  "speeds": [
    "example"
  ],
  "portCount": 1,
  "poeStandard": "example",
  "poeWatts": 1,
  "notes": "example",
  "sortOrder": 1
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Module updated

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"
  }
}

400

Section titled “400 ”

Validation error

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

401

Section titled “401 ”

Not authenticated

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

404

Section titled “404 ”

Module not found

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