QuickBuild Documentation
|
Get child configurations of specified configurationSyntaxA list of child configurations can be accessed by parent configuration id using http GET method through below url: http://localhost:8810/rest/configurations?parent_id=<parent configuration id>
Here <parent configuration id> represents id of the parent configuration. The response is of mime type application/xml and the content is brief xml representation of list of all child configurations.
SecurityYou will need to use http BASIC authentication to login as an authorized QuickBuild user if the anonymous does not have permission to access any of the returned configuration. DemoBelow curl command demonstrates how to get child configurations under the configuration with id of 1: curl -u admin:admin http://localhost:8810/rest/configurations?parent_id=1
Get all descendent configurations of specified configurationSyntaxAll descendent configurations can be accessed by parent configuration id using http GET method through below url: http://localhost:8810/rest/configurations?parent_id=<parent configuration id>&recursive=true
Here <parent configuration id> represents id of the parent configuration. The response is of mime type application/xml and the content is brief xml representation of list of all descendent configurations.
SecurityYou will need to use http BASIC authentication to login as an authorized QuickBuild user if the anonymous does not have permission to access any of the returned configuration. DemoBelow curl command demonstrates how to get descendent configurations under the configuration with id of 1: curl -u admin:admin "http://localhost:8810/rest/configurations?id=1&recursive=true"
Get all configurations in the systemSyntaxAll configurations in the system can be accessed using http GET method through below url: http://localhost:8810/rest/configurations?recursive=true
The response is of mime type application/xml and the content is brief xml representation of list of all configurations.
SecurityYou will need to use http BASIC authentication to login as an authorized QuickBuild user if the anonymous does not have permission to access any of the returned configuration. DemoBelow curl command demonstrates how to get descendent configurations under the configuration with id of 1: curl -u admin:admin "http://localhost:8810/rest/configurations?recursive=true"
Access configuration by idSyntaxConfiguration can be accessed by id using http GET method through below url: http://qb-server:8810/rest/configurations/<configuration id>
Here <configuration id> stands for id of the configuration. The response is of mime type application/xml and the content is xml representation of the configuration. SecurityYou will need to use http BASIC authentication to login as an authorized QuickBuild user if the anonymous does not have the ACCESS_SETTINGS permission of the requested configuration. DemoBelow curl command demonstrates how to get xml representation of configuration with identifier 1 (the root configuration): curl -u admin:admin http://localhost:8810/rest/configurations/1
Access configuration path by idSyntaxConfiguration path can be accessed by id using http GET method through below url: http://localhost:8810/rest/configurations/<configuration id>/path
Here <configuration id> stands for id of the configuration. The response is of mime type plain/text and the content is string representation of the configuration path name. SecurityAny user can access this service including anonymous. DemoBelow curl command demonstrates how to get path name of configuration with id 2: curl http://localhost:8810/rest/configurations/2/path
Access configuration name by idSyntaxConfiguration name can be accessed by id using http GET method through below url: http://localhost:8810/rest/configurations/<configuration id>/name
Here <configuration id> stands for id of the configuration. The response is of mime type plain/text and the content is string representation of the configuration name. SecurityYou will need to use http BASIC authentication to login as an authorized QuickBuild user if the anonymous is not allowed to access the requested configuration. DemoBelow curl command demonstrates how to get name of configuration with id 2: curl -u admin:admin http://localhost:8810/rest/configurations/2/name
Access configuration description by idSyntaxConfiguration description can be accessed by id using http GET method through below url: http://localhost:8810/rest/configurations/<configuration id>/description
Here <configuration id> stands for id of the configuration. The response is of mime type plain/text and the content is string representation of the configuration description. Status code 204 (No Content) will be returned if the configuration does not have description. SecurityYou will need to use http BASIC authentication to login as an authorized QuickBuild user if the anonymous is not allowed to access the requested configuration. DemoBelow curl command demonstrates how to get description of configuration with id 2: curl -u admin:admin http://localhost:8810/rest/configurations/2/description
Access configuration error message by idSyntaxConfiguration error message can be accessed by id using http GET method through below url: http://localhost:8810/rest/configurations/<configuration id>/error_message
Here <configuration id> stands for id of the configuration. The response is of mime type plain/text and the content is string representation of the configuration error message. Status code 204 (No Content) will be returned if the configuration is not in error. SecurityYou will need to use http BASIC authentication to login as an authorized QuickBuild user if the anonymous is not allowed to access the requested configuration. DemoBelow curl command demonstrates how to get error message of configuration with id 2: curl -u admin:admin http://localhost:8810/rest/configurations/2/error_message
Access configuration run mode by idSyntaxConfiguration run mode can be accessed by id using http GET method through below url: http://localhost:8810/rest/configurations/<configuration id>/run_mode
Here <configuration id> stands for id of the configuration. The response is of mime type plain/text and the content is string representation of configuration run mode. Status code 204 (No Content) will be returned if run mode is inherited from parent configuration. SecurityAny user can access this service including anonymous. DemoBelow curl command demonstrates how to get run mode of configuration with id 2: curl http://localhost:8810/rest/configurations/2/run_mode
Access configuration schedule by idSyntaxConfiguration schedule can be accessed by id using http GET method through below url: http://localhost:8810/rest/configurations/<configuration id>/schedule
Here <configuration id> stands for id of the configuration. The response is of mime type application/xml and the content is XML representation of configuration schedule. Status code 204 (No Content) will be returned if schedule is inherited from parent configuration. SecurityAny user can access this service including anonymous. DemoBelow curl command demonstrates how to get schedule of configuration with id 2: curl http://localhost:8810/rest/configurations/2/schedule
Access parent configuration by idSyntaxParent configuration can be accessed by id using http GET method through below url: http://localhost:8810/rest/configurations/<configuration id>/parent
Here <configuration id> stands for id of the configuration. The response is of mime type plain/text and the content is string representation of id of parent configuration. Status code 204 (No Content) will be returned if the configuration is root configuration and does not have parent. SecurityAny user can access this service including anonymous. DemoBelow curl command demonstrates how to get parent of configuration with id 2: curl http://localhost:8810/rest/configurations/2/parent
Update configurationSyntaxConfiguration can be updated by posting xml representation of the configuration to below url: http://localhost:8810/rest/configurations
Please note that the parent element denotes id of the parent configuration.
SecurityYou will need to use http BASIC authentication to login as authorized QuickBuild user if the anonymous does not have EDIT_SETTINGS permission on the requested configuration. DemoWe will use curl to demonstrate how to modify description of configuration root/test:
Create configurationSyntaxConfiguration can be created by posting xml representation of the configuration to below url: http://localhost:8810/rest/configurations
Please note that:
SecurityYou will need to use http BASIC authentication to login as authorized QuickBuild user if the anonymous does not have ADD_CHILDREN permission on the parent configuration. DemoWe will use curl to demonstrate how to create a new configuration root/test-copy by copying the configuration root/test.
Delete configurationSyntaxConfiguration can be deleted using http DELETE method through below url: http://localhost:8810/rest/configurations/<configuration id>
Here <configuration id> stands for id of the configuration to be deleted and can be queried with id service. SecurityYou will need to use http BASIC authentication to login as authorized QuickBuild user if the anonymous does not have DELETE_CHILDREN on the parent configuration. DemoBelow curl command demonstrates how to delete the configuration with id 2: curl -X DELETE -u admin:admin http://localhost:8810/rest/configurations/2
|