Update custom report
POST/reports/custom/{report_id}Update a custom report.
Roles with endpoint access
| Role | Permission |
|---|---|
| Partner | |
| Partner View | |
| Custom Partner | |
| Fleet Manager | |
| Group Manager | |
| User | |
| Custom User |
Request
Path Params
report_id
string
required
Body Params multipart/form-data
name
string
optional
Update report name
fields
enum<string>
optional
Update fields in report by passing a comma-separated string of fields
Allowed values:
vehicle_namevincritical_gsensorharshbrakingcustomharshacceldrivercamera_blockspeedinginput_sensordistractionyawningseatbeltdrowsinesssmokingphone_useadas_ldwadas_fcwadas_pcwadas_hwno_sd_cardtailgatingfirst_connected_tslast_connected_tsimeimanufacturermodelversion
users
string
optional
Update users subscribed to report by passing a comma-separated string of RoscoLive user emails
vehicles
string
optional
Update vehicles added to report by passing a comma-separated string of device IDs
is_favorite
boolean
optional
Update report favorite flag
Request samples
Responses
Success(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
meta
object
required
Request metadata object
code
string
required
HTTP status code returned by server
response
object (Custom Report)
required
Contains response data
device_ids
array[integer]
required
List of device IDs for report
driver_ids
array[integer]
required
List of driver IDs to include in report if type is driver
fields
array[string]
required
Fields included in report
group_ids
array[integer]
required
List of group IDs included in report
id
integer
required
Report ID
>= 0
is_favorite
boolean
required
Flag if report is favorited by user
name
string
required
Report name
owner_id
integer
required
Report owner user ID
>= 0
type
enum<string>
required
Report type
Allowed values:
vehicledriver
users
array[string <email>]
required
List of user emails report is shared with
result
enum<string>
required
"OK" if request successful, otherwise "Failed"
Allowed values:
OKFailed
Example
{
"meta": {
"code": 200
},
"response": {
"device_ids": [],
"driver_ids": [],
"fields": [
"vehicle_name",
"vin",
"critical_gsensor",
"harshbraking",
"custom",
"harshaccel",
"driver",
"camera_block",
"speeding",
"input_sensor",
"distraction",
"yawning",
"seatbelt",
"drowsiness",
"smoking",
"phone_use",
"adas_fcw",
"adas_pcw",
"adas_hw",
"tailgating",
"adas_ldw",
"first_connected_ts",
"last_connected_ts",
"no_sd_card",
"imei",
"manufacturer",
"model",
"version"
],
"group_ids": [],
"id": 2213,
"is_favorite": false,
"name": "New Custom Report",
"owner_id": 1321,
"type": "vehicle",
"users": [
"nelsonh@example.com",
"codyh@example.com"
]
},
"result": "OK"
}Last modified: 3 months ago