Skip to main content

Preset

Definition​

Preset Type
preset.json
{
  "id": 0,
  "camID": 0,
  "presetName": "",
  "presetDescription": "",
  "channel": 0,
  "presetIndex": 0,
  "createdAt": "",
  "updatedAt": "",
}

Get Presets​

curl -X GET "https://${baseUrl}/preset/?\$filter=&\$orderBy=&\$page=1&\$pageSize=10" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json"

Get Preset​

curl -X GET "https://${baseUrl}/preset/${id}" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json"

Apply Preset.ID​

curl -X POST "https://${baseUrl}/apply/preset/id/" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json"

Create Preset​

curl -X POST "https://${baseUrl}/preset/" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -d @preset.json
info
preset.json
{
  "camID": 0,
  "presetName": "",
  "presetDescription": "",
  "channel": 0,
  "presetIndex": 0,
}
tip

success status: 201

Update Preset​

curl -X PUT "https://${baseUrl}/preset/${id}" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -d @preset.json
info
preset.json
{
  "camID": 0,
  "presetName": "",
  "presetDescription": "",
  "channel": 0,
  "presetIndex": 0,
}

Update Preset Partial​

curl -X PATCH "https://${baseUrl}/preset/${id}" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json" \
   -H "Attrs: camID,presetName,presetDescription,channel,presetIndex" \
   -d @preset.json
info
preset.json
{
  "camID": 0,
  "presetName": "",
  "presetDescription": "",
  "channel": 0,
  "presetIndex": 0,
}

Destroy Preset​

curl -X DELETE "https://${baseUrl}/preset/${id}" \
   -H "Authorization: Bearer ${accessToken}" \
   -H "Content-Type: application/json" \
   -H "Accept: application/json"