API device EN - История изменений

IronBot: Fix Ukrainian API localization

2026-05-10T11:37:29Z

Fix Ukrainian API localization

← Предыдущая версия		Версия от 11:37, 10 мая 2026
Строка 14:		Строка 14:
	''Modified in 3.19beta1 (object_type parameter removed)''		''Modified in 3.19beta1 (object_type parameter removed)''

	Description: ~~Adding~~ a mark		Description: Add a mark
	~~Obligatory~~ parameters:		Required parameters:
	object_type - Device type [switch] ''(before version 3.19beta1)''		object_type - Device type [switch] ''(before version 3.19beta1)''
	object_id - device id		object_id - device id
Строка 23:		Строка 23:
	''Added in: 3.14.13''		''Added in: 3.14.13''

	Description: ~~Obtain~~ information about connected ~~ONUs~~ to OLT ''(stored information ~~from the database~~. Direct polling is not performed)''		Description: Get information about ONUs connected to an OLT ''(stored database information. Direct polling is not performed)''
	Optional parameters:		Optional parameters:
	device_id - OLT ID ''(can be comma separated)''		device_id - OLT ID ''(can be comma separated)''
Строка 33:		Строка 33:
	''Added with: 3.16dev4''		''Added with: 3.16dev4''

	Description: Get ~~some~~ current information ~~on ONU~~ ''(directly from OLT)''		Description: Get current ONU information ''(directly from OLT)''
	Required parameters:		Required parameters:
	id - device id ''(ONU)''		id - device id ''(ONU)''
Строка 43:		Строка 43:

	''Modified in: 3.12.95 (added possible mac value to data_typer)''		''Modified in: 3.12.95 (added possible mac value to data_typer)''
	Description: Retrieve device ID from ~~incoming~~ data		Description: Retrieve device ID from input data
	Required parameters:		Required parameters:
	object_type - device type [switch] ''(before version 3.19beta1)''		object_type - device type [switch] ''(before version 3.19beta1)''
Строка 66:		Строка 66:
	''Modified in: 3.12.38 (added object_type=all)''		''Modified in: 3.12.38 (added object_type=all)''
	Description: Retrieve device information		Description: Retrieve device information
	~~Obligatory~~ parameters:		Required parameters:
	object_type - Device type [switch\|onu\|olt\|radio\|all]		object_type - Device type [switch\|onu\|olt\|radio\|all]
	Optional parameters:		Optional parameters:
Строка 75:		Строка 75:
	is_hide_access_data - flag - hide information on equipment access parameters		is_hide_access_data - flag - hide information on equipment access parameters
	is_with_ip - flag - only with IP addresses		is_with_ip - flag - only with IP addresses
	node_id - id ~~of the communication facility~~ ''(can be comma separated)''		node_id - infrastructure facility id ''(can be comma separated)''
	object_id - id of the object to be selected		object_id - id of the object to be selected

Строка 82:		Строка 82:
	''Added with: 3.17dev1''		''Added with: 3.17dev1''

	Description: Get current information ~~on interfaces~~ ''(directly from the device)''		Description: Get current interface information ''(directly from the device)''
	Required parameters:		Required parameters:
	id - device id		id - device id
Строка 101:		Строка 101:

	Description: Get a list of MAC addresses that were found on the device		Description: Get a list of MAC addresses that were found on the device
	~~Obligatory~~ parameters:		Required parameters:
	object_type - Device type [switch] ''(before version 3.19beta1)''		object_type - Device type [switch] ''(before version 3.19beta1)''
	Optional parameters:		Optional parameters:
Строка 113:		Строка 113:

	Description: Get the latest information on ONU		Description: Get the latest information on ONU
	~~Obligatory~~ parameters:		Required parameters:
	id - MAC address or serial number ''(id)''		id - MAC address or serial number ''(id)''
	or		or
Строка 127:		Строка 127:
	''Added from: 3.12.53''		''Added from: 3.12.53''

	Description: ~~Obtain history of~~ PON signal ~~levels by~~ ONU		Description: Get PON signal level history for an ONU
	~~Obligatory~~ parameters:		Required parameters:
	onu_name - MAC address or serial number of ONU ''(without separators)''		onu_name - MAC address or serial number of ONU ''(without separators)''
	or		or
Строка 135:		Строка 135:
	onu_device_id - device id ''(ONU)''		onu_device_id - device id ''(ONU)''
	Optional parameters:		Optional parameters:
	limit - ~~limit of the list of~~ output data		limit - output data limit
	order_by - data sorting field		order_by - data sorting field
	is_desc - flag - sorting in reverse order		is_desc - flag - sorting in reverse order
Строка 143:		Строка 143:
	''Modified in 3.19beta1 (object_type parameter removed)''		''Modified in 3.19beta1 (object_type parameter removed)''

	Description: ~~Mark removal~~		Description: Remove a mark
	~~Obligatory~~ parameters:		Required parameters:
	object_type - Device type [switch] ''(before version 3.19beta1)''		object_type - Device type [switch] ''(before version 3.19beta1)''
	object_id - device id		object_id - device id
Строка 167:		Строка 167:
	''Modified in 3.12.74 (added possible value of comment to param)''		''Modified in 3.12.74 (added possible value of comment to param)''
	Description: Change device information		Description: Change device information
	~~Obligatory~~ parameters:		Required parameters:
	object_type - Device type [switch] ''(before version 3.19beta1)''		object_type - Device type [switch] ''(before version 3.19beta1)''
	object_id - device id		object_id - device id
Строка 176:		Строка 176:

	''Added with: 3.15beta3''		''Added with: 3.15beta3''
	Description: ~~Changes the~~ state ~~of the interface~~ on ~~the~~ device		Description: Change interface state on a device
	~~Obligatory~~ parameters:		Required parameters:
	device_id - device id		device_id - device id
	iface - interface number		iface - interface number
Строка 184:		Строка 184:
	==== find_mac ====		==== find_mac ====
	''Added in: 3.12beta25''		''Added in: 3.12beta25''
	Description: Search for MAC address in ~~the~~ polling history ~~by hardware~~		Description: Search for a MAC address in equipment polling history
	Required parameters:		Required parameters:
	mac - MAC address ''(upper case without separators)''		mac - MAC address ''(upper case without separators)''

IronBot: Add Ukrainian API docs and trilingual API links

2026-05-10T08:27:56Z

Add Ukrainian API docs and trilingual API links

← Предыдущая версия		Версия от 08:27, 10 мая 2026
Строка 1:		Строка 1:
	~~[[API_device\|ru]] \|~~ '''en'''		'''en''' \| [[API_device_UK\|uk]] \| [[API device\|ru]]

	Section '''[[API_EN\|API]]''' ERP "UserSide"		Section '''[[API_EN\|API]]''' ERP "UserSide"

IronBot: Normalize API language switcher

2026-05-09T19:46:29Z

Normalize API language switcher

← Предыдущая версия		Версия от 19:46, 9 мая 2026
Строка 1:		Строка 1:
	~~[[API_device_EN\|en]] \|~~ [[API_device\|ru]]		[[API_device\|ru]] \| '''en'''

	Section '''[[API_EN\|API]]''' ERP "UserSide"		Section '''[[API_EN\|API]]''' ERP "UserSide"

IronBot: Sync English API page with Russian API documentation

2026-05-09T19:22:22Z

Sync English API page with Russian API documentation

← Предыдущая версия		Версия от 19:22, 9 мая 2026
Строка 50:		Строка 50:

	==== get_data ====		==== get_data ====
			''Modified in 3.20.2 (added is_with_ip parameter)''

			''Modified in 3.19.15 (added customer_id parameter)''

	''Modified in 3.19beta1 (added dataset parameter)''		''Modified in 3.19beta1 (added dataset parameter)''

Строка 65:		Строка 69:
	object_type - Device type [switch\|onu\|olt\|radio\|all]		object_type - Device type [switch\|onu\|olt\|radio\|all]
	Optional parameters:		Optional parameters:
			customer_id - customer id ''(can be comma separated)''
	dataset - list of fields to output ''(comma separated)''		dataset - list of fields to output ''(comma separated)''
	is_online - flag - select only active devices ''(1 - active, -1 - inactive)''		is_online - flag - select only active devices ''(1 - active, -1 - inactive)''
	is_hide_ifaces_data - flag - hide detailed information on equipment interfaces		is_hide_ifaces_data - flag - hide detailed information on equipment interfaces
	is_hide_access_data - flag - hide information on equipment access parameters		is_hide_access_data - flag - hide information on equipment access parameters
			is_with_ip - flag - only with IP addresses
	node_id - id of the communication facility ''(can be comma separated)''		node_id - id of the communication facility ''(can be comma separated)''
	object_id - id of the object to be selected		object_id - id of the object to be selected
Строка 181:		Строка 187:
	Required parameters:		Required parameters:
	mac - MAC address ''(upper case without separators)''		mac - MAC address ''(upper case without separators)''

			==== get_relation_customers ====
			''Added in: 3.19.45''

			Description: Retrieve information about dependent customers
			Required parameters:
			device_id - device id
			Optional parameters:
			port_start - starting port number
			port_finish - ending port number

N.Skrypnik в 21:48, 26 апреля 2024

2024-04-26T21:48:53Z

← Предыдущая версия		Версия от 21:48, 26 апреля 2024
Строка 150:		Строка 150:

	==== set_data ====		==== set_data ====

			''Modified in 3.19beta1 (object_type parameter removed)''

	''Modified in 3.17dev1 (added possible value of date_last_activity to param)''		''Modified in 3.17dev1 (added possible value of date_last_activity to param)''

Строка 159:		Строка 162:
	Description: Change device information		Description: Change device information
	Obligatory parameters:		Obligatory parameters:
	object_type - Device type [switch]		object_type - Device type [switch] ''(before version 3.19beta1)''
	object_id - device id		object_id - device id
	param - type of parameter to change [ip\|mac\|comment\|iface_count\|downlink_port\|uplink_port\|date_last_activity]		param - type of parameter to change [ip\|mac\|comment\|iface_count\|downlink_port\|uplink_port\|date_last_activity]

N.Skrypnik в 21:46, 26 апреля 2024

2024-04-26T21:46:40Z

← Предыдущая версия		Версия от 21:46, 26 апреля 2024
Строка 134:		Строка 134:

	==== delete_mark ====		==== delete_mark ====

			''Modified in 3.19beta1 (object_type parameter removed)''

	Description: Mark removal		Description: Mark removal
	Obligatory parameters:		Obligatory parameters:
	object_type - Device type [switch]		object_type - Device type [switch] ''(before version 3.19beta1)''
	object_id - device id		object_id - device id
	mark_id - mark ID		mark_id - mark ID

N.Skrypnik в 21:44, 26 апреля 2024

2024-04-26T21:44:02Z

← Предыдущая версия		Версия от 21:44, 26 апреля 2024
Строка 81:		Строка 81:

	==== get_iface_mac ====		==== get_iface_mac ====
			''Modified in 3.19beta1 (object_type parameter removed)''

	''Added with: 3.12beta25''		''Added with: 3.12beta25''

	Description: List of interfaces with MAC addresses on the device		Description: List of interfaces with MAC addresses on the device
	Required parameters:		Required parameters:
	object_type - Device type [switch]		object_type - Device type [switch] ''(before version 3.19beta1)''
	object_id - id of the device to be sampled		object_id - id of the device to be sampled

N.Skrypnik в 21:41, 26 апреля 2024

2024-04-26T21:41:31Z

← Предыдущая версия		Версия от 21:41, 26 апреля 2024
Строка 88:		Строка 88:

	==== get_mac_list ====		==== get_mac_list ====

			''Modified in 3.19beta1 (object_type parameter removed, object_id list made optional)''

	Description: Get a list of MAC addresses that were found on the device		Description: Get a list of MAC addresses that were found on the device
	Obligatory parameters:		Obligatory parameters:
	object_type - Device type [switch]		object_type - Device type [switch] ''(before version 3.19beta1)''
	~~object_id - id of the device to be sampled~~
	Optional parameters:		Optional parameters:
	interface_list - Interface number for which to output the list (can be comma separated)		interface_list - Interface number for which to output the list (can be comma separated)
			object_id - id of the device to be sampled

	==== get_ont_data ====		==== get_ont_data ====

N.Skrypnik в 21:37, 26 апреля 2024

2024-04-26T21:37:49Z

← Предыдущая версия		Версия от 21:37, 26 апреля 2024
Строка 38:		Строка 38:

	==== get_device_id ====		==== get_device_id ====
			''Modified in 3.19beta1 (object_type parameter removed)''

	''Modified in: 3.13.63 (added possible serial_number value to data_typer)''		''Modified in: 3.13.63 (added possible serial_number value to data_typer)''

Строка 43:		Строка 45:
	Description: Retrieve device ID from incoming data		Description: Retrieve device ID from incoming data
	Required parameters:		Required parameters:
	object_type - device type [switch]		object_type - device type [switch] ''(before version 3.19beta1)''
	data_typer - type of data to be checked ''(possible values: ip, mac, inventory_number, serial_number, additional_field_XXX)''		data_typer - type of data to be checked ''(possible values: ip, mac, inventory_number, serial_number, additional_field_XXX)''
	data_value - value		data_value - value

N.Skrypnik в 21:35, 26 апреля 2024

2024-04-26T21:35:15Z

← Предыдущая версия		Версия от 21:35, 26 апреля 2024
Строка 48:		Строка 48:

	==== get_data ====		==== get_data ====
			''Modified in 3.19beta1 (added dataset parameter)''

	''Modified in: 3.18.4 (added is_hide_access_data parameter)''		''Modified in: 3.18.4 (added is_hide_access_data parameter)''

Строка 61:		Строка 63:
	object_type - Device type [switch\|onu\|olt\|radio\|all]		object_type - Device type [switch\|onu\|olt\|radio\|all]
	Optional parameters:		Optional parameters:
	~~node_id~~ - id of ~~the communication facility~~ ''(~~can be~~ comma separated)''		dataset - list of fields to output ''(comma separated)''
	~~object_id - id of the object to be selected~~
	is_online - flag - select only active devices ''(1 - active, -1 - inactive)''		is_online - flag - select only active devices ''(1 - active, -1 - inactive)''
	is_hide_ifaces_data - flag - hide detailed information on equipment interfaces		is_hide_ifaces_data - flag - hide detailed information on equipment interfaces
	is_hide_access_data - flag - hide information on equipment access parameters		is_hide_access_data - flag - hide information on equipment access parameters
			node_id - id of the communication facility ''(can be comma separated)''
			object_id - id of the object to be selected

	==== get_iface_info ====		==== get_iface_info ====