QuickBuild Documentation
|
Access build by build idSyntaxBuild can be accessed by id using http GET method through below url: http://localhost:8810/rest/builds/<build id>
The response is of mime type application/xml, and the content is XML representation of the build. SecurityYou will need to use http BASIC authentication to login as an authorized QuickBuild user if the anonymous does not have permission to access belonging configuration of requested build. DemoBelow curl command demostrates how to access XML representation of build with id 14: curl -u admin:admin http://localhost:8810/rest/builds/14
Access build status by build idSyntaxBuild status can be accessed by build id using http GET method through below url: http://localhost:8810/rest/builds/<build id>/status
The response is of mime type text/plain, and the content is string representation of the build status. SecurityYou will need to use http BASIC authentication to login as an authorized QuickBuild user if the anonymous does not have permission to access belonging configuration of requested build. DemoBelow curl command demostrates how to access status of build with id 14: curl -u admin:admin http://localhost:8810/rest/builds/14/status
Access build begin date by build idSyntaxBuild begin date can be accessed by build id using http GET method through below url: http://localhost:8810/rest/builds/<build id>/begin_date
The response is of mime type text/plain, and the content is string representation of build begin date (mill-seconds since January 1, 1970, 00:00:00 GMT) SecurityYou will need to use http BASIC authentication to login as an authorized QuickBuild user if the anonymous does not have permission to access belonging configuration of requested build. DemoBelow curl command demostrates how to access begin date of build with id 14: curl -u admin:admin http://localhost:8810/rest/builds/14/begin_date
Access build version by build idSyntaxBuild version can be accessed by build id using http GET method through below url: http://localhost:8810/rest/builds/<build id>/version
The response is of mime type text/plain, and the content is string representation of the build version. SecurityYou will need to use http BASIC authentication to login as an authorized QuickBuild user if the anonymous does not have permission to access belonging configuration of requested build. DemoBelow curl command demostrates how to access version of build with id 14: curl -u admin:admin http://localhost:8810/rest/builds/14/version
Access build duration by build idSyntaxBuild duration can be accessed by build id using http GET method through below url: http://localhost:8810/rest/builds/<build id>/duration
The response is of mime type text/plain, and the content is string representation of the build duration (milli-seconds). Status 204 (No Content) will be returned if build is not finished. SecurityYou will need to use http BASIC authentication to login as an authorized QuickBuild user if the anonymous does not have permission to access belonging configuration of requested build. DemoBelow curl command demostrates how to access duration of build with id 14: curl -u admin:admin http://localhost:8810/rest/builds/14/duration
Get build request id by build idSyntaxBuild request id can be accessed by build id using http GET method through below url: http://localhost:8810/rest/builds/<build id>/request_id
The response is of mime type text/plain, and the content is string representation of the build request id. Status 204 (No Content) will be returned if build is finished. SecurityYou will need to use http BASIC authentication to login as an authorized QuickBuild user if the anonymous does not have permission to access belonging configuration of requested build. DemoBelow curl command demostrates how to get request id of build with id 14: curl -u admin:admin http://localhost:8810/rest/builds/14/request_id
Access executed steps by build idSyntaxExecuted steps of a build can be accessed by build id using http GET method through below url: http://localhost:8810/rest/builds/<build id>/steps
The response is of mime type application/xml, and the content is XML representation of the list of steps executed in the build. SecurityYou will need to use http BASIC authentication to login as authorized QuickBuild user if the anonymous does not have permission to access settings of belonging configuration. DemoBelow curl command demostrates how to access executed steps by build with id 14: curl -u admin:admin http://localhost:8810/rest/builds/14/steps
Access used repositories by build idSyntaxUsed repositories of a build can be accessed by build id using http GET method through below url: http://localhost:8810/rest/builds/<build id>/repositories
The response is of mime type application/xml, and the content is XML representation of the list of repositories used in the build. SecurityYou will need to use http BASIC authentication to login as authorized QuickBuild user if the anonymous does not have permission to access settings of belonging configuration. DemoBelow curl command demostrates how to access used repositories by build with id 14: curl -u admin:admin http://localhost:8810/rest/builds/14/repositories
Search BuildsSyntaxBuilds can be searched using http GET method through below url: http://localhost:8810/rest/builds?<search criteria1>=<value1>&<search criteria2>=<value2>&...
Query string part of the url represents various search criterias to restrict the search result. Supported search criterias are:
The response is of mime type application/xml, and the content is XML representation of list of matched builds. If no any search criterias are specified, all builds in the system will be returned. SecurityYou will need to use http BASIC authentication to login as authorized QuickBuild user if the anonymous does not have permission to access returned builds. DemoBelow curl commands demonstrates how to combine different criterias to perform search:
Update buildSyntaxBuild can be updated by posting XML representation of the build to below url: http://localhost:8810/rest/builds
Please note that the configuration element denotes id of the belonging configuration. SecurityYou will need to use http BASIC authentication to login as authorized QuickBuild user if the anonymous does not have SAVE_BUILD permission on the belonging configuration. DemoWe will use curl to demonstrate how to move the build to be under another configuration. Let's assume the build id is 100, and the destination configuration id is 6.
Create buildSyntaxBuild object can be created by posting XML representation of the build to below url: http://localhost:8810/rest/builds
Please note that:
SecurityYou will need to use http BASIC authentication to login as administrator if the anonymous does not have administrative rights. DemoWe will use curl to demonstrate how to create a new build by copying an existing build with id 100.
Delete BuildSyntaxBuild can be deleted using http DELETE method through below url: http://localhost:8810/rest/builds/<build id>
SecurityYou will need to use http BASIC authentication to login as authorized QuickBuild user if the anonymous does not have DELETE_BUILD permission on the belonging configuration. DemoBelow curl command demonstrates how to delete the build with id 100: curl -X DELETE -u admin:admin http://localhost:8810/rest/builds/100
|