Toolpack:Add Edit Routeset Files RestFul A - Revision history

Allyntree at 15:40, 3 March 2023

2023-03-03T15:40:50Z

← Older revision		Revision as of 11:40, 3 March 2023
Line 1:		Line 1:
	{{DISPLAYTITLE:Add and Edit Routeset files with ~~RestFul~~ API}}		{{DISPLAYTITLE:Add and Edit Routeset files with RESTFul API}}

	You can Add and Edit routeset files in your system with RestFul API using JSON ~~format. The JSON must be~~ in the following format:		You can Add and Edit routeset files in your system with RestFul API using JSON, in the following format:
	<pre>		<pre>
	{		{
Line 24:		Line 24:
	ProSBC will create a new Routeset file from the name in the JSON file.		ProSBC will create a new Routeset file from the name in the JSON file.

	Example: ~~We use~~ the Postman tool ~~in this example and~~ the URL is:		Example: Using the Postman tool, the URL is:

	http://192.168.1.25:12358/configurations/config_2/file_dbs/File_DB/routesets_definitions/		http://192.168.1.25:12358/configurations/config_2/file_dbs/File_DB/routesets_definitions/
Line 30:		Line 30:
	[[Image:RestFul_routeset_Post_Send.png\|800px\| ]]		[[Image:RestFul_routeset_Post_Send.png\|800px\| ]]

	If the import is successful, the following message is returned ~~in the Postman Tool~~		If the import is successful, the following message is returned:

	[[Image:RestFul_Routeset_Post_Response.png\|800px\| ]]		[[Image:RestFul_Routeset_Post_Response.png\|800px\| ]]
Line 39:		Line 39:
	PUT http://ProSBCIP:12358/configurations/Configurationname/file_dbs/File_DB/routesets_definitions/routesetfilename%2Ecsv		PUT http://ProSBCIP:12358/configurations/Configurationname/file_dbs/File_DB/routesets_definitions/routesetfilename%2Ecsv

	Example: ~~We use~~ the Postman tool ~~in this example and~~ the URL is http://192.168.1.25:12358/configurations/config_2/file_dbs/File_DB/routesets_definitions/routeset_1%2Ecsv		Example: Using the Postman tool, the URL is:

			http://192.168.1.25:12358/configurations/config_2/file_dbs/File_DB/routesets_definitions/routeset_1%2Ecsv

	[[Image:RestFul_Routeset_Put_Send.png\|800px\| ]]		[[Image:RestFul_Routeset_Put_Send.png\|800px\| ]]

	If the update is successful, the following message is returned ~~in the Postman Tool~~		If the update is successful, the following message is returned:

	[[Image:RestFul_Routeset_Put_Response.png\|800px\| ]]		[[Image:RestFul_Routeset_Put_Response.png\|800px\| ]]

Allyntree at 15:53, 22 February 2023

2023-02-22T15:53:27Z

← Older revision		Revision as of 11:53, 22 February 2023
Line 1:		Line 1:
	{{DISPLAYTITLE:Add/Edit Routeset files with RestFul API}}		{{DISPLAYTITLE:Add and Edit Routeset files with RestFul API}}

	You can Add and Edit routeset files in your system with RestFul API using JSON format. The JSON must be in the following format:		You can Add and Edit routeset files in your system with RestFul API using JSON format. The JSON must be in the following format:

Allyntree at 15:53, 22 February 2023

2023-02-22T15:53:01Z

← Older revision		Revision as of 11:53, 22 February 2023
Line 1:		Line 1:
	{{DISPLAYTITLE:Add/Edit Routeset files with RestFul API}}		{{DISPLAYTITLE:Add/Edit Routeset files with RestFul API}}

	You can Add/Edit routeset files in your system with RestFul API using JSON format. The JSON must be in the following format:		You can Add and Edit routeset files in your system with RestFul API using JSON format. The JSON must be in the following format:
	<pre>		<pre>
	{		{
Line 30:		Line 30:
	[[Image:RestFul_routeset_Post_Send.png\|800px\| ]]		[[Image:RestFul_routeset_Post_Send.png\|800px\| ]]

	If the import is successful ~~you will see~~ the following ~~information~~ in the Postman Tool		If the import is successful, the following message is returned in the Postman Tool

	[[Image:RestFul_Routeset_Post_Response.png\|800px\| ]]		[[Image:RestFul_Routeset_Post_Response.png\|800px\| ]]
Line 43:		Line 43:
	[[Image:RestFul_Routeset_Put_Send.png\|800px\| ]]		[[Image:RestFul_Routeset_Put_Send.png\|800px\| ]]

	If the update is successful ~~you will see~~ the following ~~information~~ in the Postman Tool		If the update is successful, the following message is returned in the Postman Tool

	[[Image:RestFul_Routeset_Put_Response.png\|800px\| ]]		[[Image:RestFul_Routeset_Put_Response.png\|800px\| ]]


	~~You can get more information~~ about how to use RestFul API and Postman Tool from the following link [[Northbound_interface:RESTful]]		Learn about how to use RestFul API and Postman Tool from the following link [[Northbound_interface:RESTful]]

Serdar Civici: Created page with "{{DISPLAYTITLE:Add/Edit Routeset files with RestFul API}} You can Add/Edit routeset files in your system with RestFul API using JSON format. The JSON must be in the following..."

2023-01-05T08:55:04Z

Created page with "{{DISPLAYTITLE:Add/Edit Routeset files with RestFul API}} You can Add/Edit routeset files in your system with RestFul API using JSON format. The JSON must be in the following..."

New page

{{DISPLAYTITLE:Add/Edit Routeset files with RestFul API}}

You can Add/Edit routeset files in your system with RestFul API using JSON format. The JSON must be in the following format:
<pre>
{
"***meta***": {
"version": "3.1.135",
"src_path": ""
},
"name": "routeset_1.csv",
"content": "routeset_name,priority,weight\r\nNAP_1,3,100\r\nNAP_2,4,100"
}
</pre>

*name: routeset file name
*\r\n: new line. Each routesets you entered must start with the new line.

==Adding a new Routeset File==

You can add a new Routeset file with the POST command:

POST http://ProSBCIP:12358/configurations/Configurationname/file_dbs/File_DB/routesets_definitions/

ProSBC will create a new Routeset file from the name in the JSON file.

Example: We use the Postman tool in this example and the URL is:

http://192.168.1.25:12358/configurations/config_2/file_dbs/File_DB/routesets_definitions/

[[Image:RestFul_routeset_Post_Send.png|800px| ]]

If the import is successful you will see the following information in the Postman Tool

[[Image:RestFul_Routeset_Post_Response.png|800px| ]]

==Updating a Routeset File==
You can update the existing Routeset file with the PUT command:

PUT http://ProSBCIP:12358/configurations/Configurationname/file_dbs/File_DB/routesets_definitions/routesetfilename%2Ecsv

Example: We use the Postman tool in this example and the URL is http://192.168.1.25:12358/configurations/config_2/file_dbs/File_DB/routesets_definitions/routeset_1%2Ecsv

[[Image:RestFul_Routeset_Put_Send.png|800px| ]]

If the update is successful you will see the following information in the Postman Tool

[[Image:RestFul_Routeset_Put_Response.png|800px| ]]

You can get more information about how to use RestFul API and Postman Tool from the following link [[Northbound_interface:RESTful]]