update_report

To create, edit, and delete report templates, use the report/update_report method.

svc=report/update_report&params={
  "itemId":<long>,
  "id":<long>,
  "callMode":"<text>",
  "n":"<text>",
  "ct":"<text>",
  "p":"<text>",
  "tbl":[
    {
      "n":"<text>",
      "l":"<text>",
      "c":"<text>",
      "cl":"<text>",
      "cp":"<text>",
      "s":"<text>",
      "sl":"<text>",
      "filter_order":"<text>",
      "p":"<text>",
      "sch":{"f1":<uint>,"f2":<uint>,"t1":<uint>,"t2":<uint>,"m":<uint>,"y":<uint>,"w":<uint>,"fl":<uint>},
      "f":<uint>
    }
  ]
}

The request must contain the following parameters:

Other parameters are only required to create and edit templates. They are described on the get_report_data page.

The tbl[].n parameter is the system table name. It depends on the template type specified in ct. For details, see Table names and types.

The p parameter specifies the grouping of the table and other settings. Some settings are available only for specific tables.

The grouping parameter defines how the rows in the table are grouped:

"p":"{
    \"grouping\":\"   
        {\"type\":\"total\",\"nested\":    /* enable grouping \"Total\" */
            {\"type\":\"year\"}}\"         /* enable nested grouping \"Year\" */
}"

Basic grouping types:

To see the advanced grouping types, get the table information using the get_report_tables request (the gt parameter).

For the account_tree table, the following parameters can be used:

"p": "{
    \"account_tree\": {
        \"group\": <bool>,
        \"types\": \"<text>\"
    }
}"

Example (all double quotes within the value must be escaped):

    "p":"{\"account_tree\":{\"group\":1,\"types\":\"avl_account,avl_resource,user,avl_unit,avl_unit_group,avl_retranslator,avl_route\"}}"

For the driver_ddd table, the drv_activity (Driver activity source) parameter can be used:

"p": "{
	\"drv_activity\":"<text>"
	}" 

The drv_activity parameter can have the following values:

For the driver_orders table (Orders), order_filter (Filtration) parameter can be used:

"p":"{
	\"order_filter\":<uint>
}"

The order_filter parameter can have the following values:

For the unit_counter_sensors (Counter sensors), the following parameters can be used:

• sensor_val:min (minimum sensor value);
• sensor_val:max (maximum sensor value).

"p": "{
	\"sensor_val\":{\"min\":\"10\",\"max\":\"14\"}
}" 

To split shifts in the tables with shifts, use the following parameters:

"p":{\"split_shifts\":1},
"s":{\"split_shifts\"}

A chart is a table in a template. For charts, the following parameters can be used:

"p":"{
	\"sensor_mask\":"<text>",		/* sensor mask */
	\"instant_speed_base\":{
		\"mask\":"<text>"}}	/* sensor mask to colour the chart line by sensor */

To add markers to the chart, add the marker table to the template and the marker flags to the chart table. Marker table code sample:

{"n":"unit_events",
 "l":"",
 "f":0,
 "c":"",
 "cl":"",
 "p":"",
 "sch":{
   "y":0,
   "m":0,
   "w":0,
   "f1":0,
   "f2":0,
   "t1":0,
   "t2":0},
 "sl":"",
 "s":"[\"chart_events_markers\"]"},

Code sample for marker flags:

"p":"{
  \"chart_markers\":{
    \"f\":2556}
  }"

Available markers/states:

The 0x4 flag also adds the violation markers to the chart.

The intervals of events such as trips, stops, parkings, connection losses, and engine hours can be used as a chart background. For details on how the background looks in the interface, see Chart properties.

The background requires two objects of the tbl array: the source table, which provides the intervals, and the chart table.

In the source table, add the name of one of the columns with intervals to the s parameter. For example, to show the intervals of trips, add the following to the unit_trips object:

"s":"[\"chart_trips_regions\"]"

In the chart table, add the chart_regions object to the p parameter:

"p":"{
  \"chart_regions\":{
    \"0\":{
      \"id\":\"<text>\",
      \"name\":\"<text>\",
      \"color\":<uint>,
      \"priority\":<uint>}
  }}"

The keys of the object are the indexes of the intervals, starting from 0. To show several types of intervals on one chart, add an object for each of them.

If id or name is empty, the interval isn’t added to the chart.

If you don’t need the rows of the source table in the report, leave its c and cl parameters empty. The table is still calculated and supplies the intervals for the chart.

The following columns are available:

Every template setting is a table column. To activate an option, add the corresponding column to the template.

The following settings are available:

Address format, time format, shift, and measurement system are specified in the p parameter.

If the request is completed successfully, a response in the following format is returned.

For creation and modification requests:

[
	<long>,		/* template ID */
	{
		"id":<long>,	/* template ID */
		"n":"<text>",	/* name */
		"ct":"<text>",	/* template type */
		"c":<uint>	/* check sum (crc16) */
	}
]

For deletion requests:

[
	<long>,		/* template ID */
	null
]

Template types are described in the Template types section on the get_report_data page.

Otherwise, an error code is returned.