L'API per aggiornare un segnale è
PUT https://api.databoom.com/v1/signals/{signalId}
Per effettuare la chiamata è necessario un OAuth token con permessi di Aggiornamento.
L'_id del segnale che si vuole aggiornare va inserito nell'URL al posto di {signalId}.
E' possibile aggiornare un segnale solo se si hanno i permessi di Creatore o Amministratore.
Nel body della richiesta vanno inseriti i campi che si vogliono aggiornare, nell'immagine d'esempio è visualizzato il cambio di descrizione di un segnale.
La stessa chiamata in cURL si presenta come
curl -X PUT \
https://api.databoom.com/v1/signals/5ccfe0e36cc4eab9a05c370f \
-H 'Authorization: Bearer <OAuth Token>' \
-H 'Content-Type: application/json' \
-d '{
"description":"New description"
}'
L'API risponde con il segnale completo di tutti i suoi campi, con le proprietà specificate nel body della richiesta aggiornati.
Un esempio di risposta è il seguente, il campo description è stato aggiornato.
{
"_id": "5ccfe0e36cc4eab9a05c370f",
"lastModUser": "5693799a2ce24d2300439324",
"revision": 1,
"device_token": "0rc0qi8qc0",
"device_description": "API test",
"device": "5cd2c794509393c4ac6427bb",
"type": "5718ca3f4ef29d440851589b",
"signal_token": "08atl0rfub",
"tags": [],
"created": "2019-05-08T12:12:18.278Z",
"lastModDate": "2019-05-08T12:12:18.434Z",
"deletedAt": null,
"deleted": false,
"public_obj": false,
"virtual_signal_list": [],
"children": [],
"inline_virtual": false,
"virtual_signal": false,
"partial_cache": false,
"is_cached": false,
"virtual_compute_granularity": {
"granularity": "*",
"compute": false
},
"accumulator": {
"is_a_sum": false,
"offset": 0,
"start_date": "2019-05-08T12:12:18.278Z",
"active": false
},
"skip_log": false,
"log_on": true,
"alarms_on": true,
"info": [],
"rescale": {
"max_value": {
"evaluated": 1000,
"original": 1000
},
"min_value": {
"evaluated": 0,
"original": 0
},
"active": false
},
"chart_scale": {
"max_chart_scale": 0,
"min_chart_scale": 0,
"active": false
},
"min_granularity": "*",
"chart_type": "LINE",
"manual_edit_active": false,
"autocomplete": false,
"values_filtering": {
"enable": false
},
"decimals": 2,
"unit_prefix": "",
"unit": [],
"status": "INIT",
"command_status": {
"status": "EXECUTED"
},
"showEvents": false,
"command_label_rules": [],
"command_enable": false,
"orders": [],
"last_value_rules": [],
"sampling_rate": 5,
"notes": "",
"description": "New description",
"name": "",
"__v": 0,
"role": "CREATOR"
}
0 Commenti