Wialon development portal: unlock the potential of API and SDK en:sidebar:remoteapi:apiref:core

Executing several commands

2013-11-29T13:31:00+00:00

Executing several commands Several commands can be executed at one request. For this, use core/batch: svc=core/batch¶ms=[ { "svc":, "params":{} } ] This command also can be called by following request: svc=core/batch¶ms={ "params": [{ "svc":, "params":{} }], "flags":}

Getting unit access rights list for child users

2015-10-09T08:50:21+00:00

Getting unit access rights list for child users In order to get unit access rights list for child users please invoke core/check_accessors command: svc=core/check_accessors¶ms={"items":[], "flags":} Parameters Name Description

Items access rights check

2020-09-02T09:04:00+00:00

Items access rights check To check current user access rights on items, use the command core/check_items_billing: svc=core/check_items_billing¶ms={"items":[], "accessFlags":, "serviceName":} While processing a request, available services and access rights on items are checked. For example, a user has a right to create POIs in some resource, however, according to service's cost table, the limit of allowed POIs has been reached, so this resource will n…

Check item unique

2021-11-15T08:32:54+00:00

Check item unique To check unique name of user or resource, use command core/check_unique: svc=core/check_unique¶ms={"type":, "value":} Params Name Description type item type (user, avl_resource) value item name Response

Core

2013-11-29T13:31:00+00:00

Core In this chapter, you will find basic Wialon commands such as login, logout, searching and creating items. . index

Create authorization hash

2013-11-29T13:31:00+00:00

Create authorization hash Instead of core/duplicate request you can use combination of this one and core/use_auth_hash. To create an authorization hash, use the command core/create_auth_hash: svc=core/create_auth_hash¶ms={} :!: Generated hash is valid from creation moment to first usage during 2 minutes!

Create resource

2015-06-18T18:58:00+00:00

Create resource To create a new resource, use the command core/create_resource: svc=core/create_resource¶ms={"creatorId":, "name":, "dataFlags":, "skipCreatorCheck":}

Create retranslator

2024-10-07T11:01:37+00:00

Create retranslator To create a new retranslator, use the command core/create_retranslator: svc=core/create_retranslator¶ms={"creatorId":, "name":, "config":{ "protocol":, "server":, "port":, "auth":, "ssl":, "debug":, "v6type":, "attach_sensors": }, "dataFlags":}

Create route

2014-04-07T08:29:00+00:00

Create route To create a new route, use the command core/create_route: svc=core/create_route¶ms={"creatorId":, "name":, "dataFlags":} Parameters Name Description creatorId ID of a user who will be assigned a creator for a new route

Create unit

2020-02-25T08:15:14+00:00

Create unit To create a new unit, use the command core/create_unit: svc=core/create_unit¶ms={"creatorId":, "name":, "hwTypeId":, "dataFlags":} :!: You can find an example of this request in the sample

Create unit group

2014-04-07T08:27:00+00:00

Create unit group To create a new unit group, use the command core/create_unit_group: svc=core/create_unit_group¶ms={"creatorId":, "name":, "dataFlags":} Parameters Name Description creatorId ID of a user who will be assigned a creator for a new unit group

Create user

2014-04-07T08:26:00+00:00

Create user To create a new user, use the command core/create_user: svc=core/create_user¶ms={"creatorId":, "name":, "password":, "dataFlags":} Parameters Name Description creatorId ID of a user who will be assigned a creator for a new user

Operate As

2021-06-03T11:27:08+00:00

Operate As To login to the system on behalf of other user, you need to execute the command core/duplicate: svc=core/duplicate¶ms={"operateAs":, "continueCurrentSession":} It duplicates the active session. Parameters Name

Export of items search result as xlsx

2018-06-06T06:57:29+00:00

Export of items search result as xlsx To export items search results as xlsx, us command core/export_file: svc=core/export_file¶ms={"spec":{ "itemsType":, "propName":, "propValueMask":, "sortType": }, "force":, "flags": /* columns flags */ }

Current account details

2017-12-14T17:39:04+00:00

Current account details To get information about billing plan settings of current user (billing plan name, balance, days left, available services), account and combined settings, use the command core/get_account_data: svc=core/get_account_data¶ms={"type":}

List of available commands

2015-09-22T09:12:10+00:00

List of available commands To get the list of commands available to a unit or a hardware type or even get command templates use the command core/get_hw_cmds: svc=core/get_hw_cmds¶ms={"deviceTypeId":, "unitId":, "template": "lang":}

Hardware types

2021-03-04T12:57:05+00:00

Hardware types To get the list of available hardware types, use the command core/get_hw_types: svc=core/get_hw_types¶ms={"filterType":, "filterValue":[|], "includeType":, "ignoreRename":}

Login

2021-01-15T13:21:29+00:00

Logout

2013-11-29T13:31:00+00:00

Logout To exit Wialon correctly, use the command core/logout: svc=core/logout¶ms={} :!: You can find an example of this request in the sample Login/logout. Response { "error": /* error code */ } Errors Code Value 0 exit successful 1

Password reset

2013-11-29T13:31:00+00:00

Password reset To finish the procedure of changing password, use the command core/reset_password_perform: svc=core/reset_password_perform¶ms={"user":, "code":} Parameters After executing reset_password_request, an e-mail with link will be sent to the user. The link will lead to the

Password reset request

2020-07-31T07:16:55+00:00

Password reset request To send a password reset request, use the command core/reset_password_request: svc=core/reset_password_request¶ms={"user":, "url":, "email":} Request execution is 1 time per 1 minute, in other case returns

Search item by ID

2014-04-07T08:29:00+00:00

Search item by ID To find an item with certain ID, use the command core/search_item: svc=core/search_item¶ms={"id":, "flags":} :!: You can find an example of this request in the sample Item search. Parameters Name Description

Search items by property

2022-10-24T10:27:18+00:00

Search items by property To search items possessing certain property, use the command core/search_items: svc=core/search_items¶ms={"spec":{ "itemsType":, "propName":, "propValueMask":, "sortType":, "propType":, "or_logic": }, "force":, "flags":, "from":, "to":}

Session property

2024-09-12T05:09:48+00:00

Session property This request allows to set up the session property to skip data from deactivated units After Token login you can execute this request that is all JSON responses from requests search_items/update_data_flags will contains information only about activated units. svc=core/set_session_property¶ms={"prop_name":"skip_nonactive_items", "prop_value": 1}

Item events management

2018-05-15T15:00:04+00:00

Item events management To get events from items, you need to add them to the session. To stop watching item state, remove it from the session. To add/remove items to/from a session, use the command core/update_data_flags: svc=core/update_data_flags¶ms={"spec":[ { "type":, "data":, "flags":, "mode":, "max_items": } ]}

Use authorization hash

2016-04-06T13:38:21+00:00

Use authorization hash Instead of core/duplicate request you can use combination of this one and core/create_auth_hash. To do “operate as” operation using authorization hash, apply the command core/use_auth_hash: svc=core/use_auth_hash¶ms={"authHash":, "operateAs":, "checkService":}