This documentation relates to QuickBuild 10.0.x
Select here if you are using a different version

RESTful API (JSON edition)

You are viewing an old version (v. 1) of this page.
The latest version is v. 2, last edited on Mar 01, 2020 (view differences | )
view page history | view next version >>

Starting from QuickBuild 10, A JSON based RESTful api is supported. It works exactly the same as the traditional XML based api, except that one has to specify http header Accept: application/json when retrieving json content from server, and specify http header Content-Type: application/json when posting json content back to server.

For instance, to get JSON representation of a configuration, you may refer to section Access configuration by id of page interact with configurations, and modify the demonstration command as below:

curl -u admin:admin -H "Accept: application/json" http://localhost:8810/rest/configurations/1

Or if you want to update a configuration, just refer to section Update configuration of the same page, and modify the demonstration command like below:

curl -X POST -u admin:admin -H "Content-Type: application/json" --data-binary "@tempfile.json" http://localhost:8810/rest/configurations
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.