Luc Morissette: Updated link to httprestapi, since it was not working with .gz

2023-08-11T13:36:50Z

Updated link to httprestapi, since it was not working with .gz

← Older revision		Revision as of 09:36, 11 August 2023
Line 1:		Line 1:
	{{DISPLAYTITLE:Northbound interface: Ruby Implementation}}		{{DISPLAYTITLE:Northbound interface: Ruby Implementation}}
	This ruby script ([[Media:~~Httprestapi~~.~~rb.gz‎~~\|httprestapi]]) is an example of how to use TelcoBridges RESTful Northbound Interface.		This ruby script ([[Media:httprestapi.zip‎\|httprestapi]]) is an example of how to use TelcoBridges RESTful Northbound Interface.
	* The script can be executed from any computer having access to the management web interface.		* The script can be executed from any computer having access to the management web interface.
	* The script can also be copied on the internal host of a ''T''media and executed from a SSH client (as shown in the examples below using <nowiki>127.0.0.1:12358</nowiki>).		* The script can also be copied on the internal host of a ''T''media and executed from a SSH client (as shown in the examples below using <nowiki>127.0.0.1:12358</nowiki>).

	== Download script ==		== Download script ==
	* [[Media:~~Httprestapi~~.~~rb.gz‎~~\|httprestapi.rb [click to download]]]		* [[Media:httprestapi.zip‎\|httprestapi.rb [click to download]]]

	== Usage ==		== Usage ==

Luc Morissette: New page for restful API ruby implementation

2023-08-07T18:56:12Z

New page for restful API ruby implementation

New page

{{DISPLAYTITLE:Northbound interface: Ruby Implementation}}
This ruby script ([[Media:Httprestapi.rb.gz‎|httprestapi]]) is an example of how to use TelcoBridges RESTful Northbound Interface.
* The script can be executed from any computer having access to the management web interface.
* The script can also be copied on the internal host of a ''T''media and executed from a SSH client (as shown in the examples below using <nowiki>127.0.0.1:12358</nowiki>).

== Download script ==
* [[Media:Httprestapi.rb.gz‎|httprestapi.rb [click to download]]]

== Usage ==
./httprestapi.rb <URI> <user> <password> <http request>

With <URI> = <nowiki>http://ip:port</nowiki>
Example: <nowiki>./httprestapi.rb 'http://127.0.0.1:12358' 'root' 'password' <http request></nowiki>

With <http request> = <GET|PUT|POST|DELETE> <element path> [json | -i jsonfile | -o jsonfile]
-i jsonfile = input json file used for PUT or POST http request
-o jsonfile = output json file used for GET http request

== GET ==
Get the configuration collection list and display the JSON returned in the body of the HTTP response.
<nowiki>./httprestapi.rb 'http://127.0.0.1:12358' GET '/configurations'</nowiki>

Show the use of "recursive=yes" to get all sub-element of configuration. Put the returned JSON in "test_configuration.json" file.
<nowiki>./httprestapi.rb 'http://127.0.0.1:12358' GET '/configurations/test?recursive=yes' '-o test_configuration.json'</nowiki>

Use "documentation=yes" to return documentation of all attributes of an element. Below example returns documentation for a new route element.
<nowiki>./httprestapi.rb 'http://127.0.0.1:12358' GET '/configurations/test/routes/new?documentation=yes'</nowiki>

Get request can also be used to retrieve the status of some elements of the '''active''' configuration.
<nowiki>./httprestapi.rb 'http://127.0.0.1:12358' GET '/configurations/test/naps/xtel/status'</nowiki>

== PUT ==
Modify attributes of an element. Below example renames the route element named "Test" to "NewName".
<nowiki>./httprestapi.rb 'http://127.0.0.1:12358' PUT '/configurations/test/routes/test_route' '{"name":"new_route_name"}' </nowiki>

Modify attributes of an element using a JSON file for the HTTP request.
<nowiki>./httprestapi.rb 'http://127.0.0.1:12358' PUT '/configurations/test/routes/test_route' '-i modified_route.json' </nowiki>

Activate "demo" configuration
<nowiki>./httprestapi.rb 'http://127.0.0.1:12358' PUT '/systems/system_1' '{"target_configuration":"demo"}' </nowiki>

== POST ==
Create a new element. Below example add a new route named "xtel_to_SBC_1".
<nowiki>./httprestapi.rb 'http://127.0.0.1:12358' POST '/configurations/test/routes' '{"name":"xtel_to_SBC_1","nap":"xtel","remapped_nap":"SBC_1"}' </nowiki>

Create a new element using a JSON file for the HTTP request.
<nowiki>./httprestapi.rb 'http://127.0.0.1:12358' POST '/configurations/test/routes' '-i new_route.json' </nowiki>

Create a new configuration using a JSON file for the HTTP request.
<nowiki>./httprestapi.rb 'http://127.0.0.1:12358' POST '/configurations' '-i test_configuration.json' </nowiki>

== DELETE ==
Delete an element. Below example delete the route named "xtel_to_SBC_1".
<nowiki>./httprestapi.rb 'http://127.0.0.1:12358' DELETE '/configurations/test/routes/xtel_to_SBC_1' </nowiki>

== Using JSON files ==
=== Modify an element ===
1. Get route configuration in JSON file
<nowiki>./httprestapi.rb 'http://127.0.0.1:12358' GET '/configurations/test/routes/test_route' '-o routes.json'</nowiki>
2. Edit JSON file attributes
vi route.json
3. Modify element from JSON file
<nowiki>./httprestapi.rb 'http://127.0.0.1:12358' PUT '/configurations/test/routes/test_route' '-i routes.json'</nowiki>

=== Create a new element ===
1. Get an element default attributes value in a JSON file
<nowiki>./httprestapi.rb 'http://127.0.0.1:12358' GET '/configurations/test/routes/new' '-o routes.json'</nowiki>
2. Edit JSON file attributes
vi route.json
3. Create new element from JSON file
<nowiki>./httprestapi.rb 'http://127.0.0.1:12358' POST '/configurations/test/routes/new_route' '-i routes.json'</nowiki>

Restful api ruby implementation - Revision history

Luc Morissette: Updated link to httprestapi, since it was not working with .gz

Luc Morissette: New page for restful API ruby implementation