REST API Requests and Responses
8 min
submission methods api requests can be submitted using the following http methods rest api http head method docid\ eqnd3zptd6dwf3go3ufox rest api http get method docid 7hm2r py7e84xk2msf11b rest api http post method docid\ hsi lzxs8g rx ydudzkg rest api http patch method docid\ rcjvhrlby6de zgkehxui rest api http delete method docid\ vnmdtbrg59iwf4suh4zey supported formats response formats the blueprint rest api supports the following response formats json (default) to use json format, add the following information to your request header accept application/json xml to use xml format, add the following information to your request header accept application/xml request formats the blueprint rest api supports the following request formats json to use json format for your request body, add the following information to your request header content type text/json xml to use xml format for your request body, add the following information to your request header content type text/xml xml data in the request body must adhere to the blueprint rest api xml schema pagination blueprint limits the number of results that can be returned in a single response in order to ensure optimal performance paging is controlled using the offset and limit parameters offset (optional) defines the paging offset (that is, index) at which the results start offset the default is 0 limit (optional) defines the number of items (projects, artifacts, etc) to retrieve per query this parameter can be set to an integer the default is 100 the minimum value is 1 and the maximum value is 500 when pagination is in effect, response will always be returned with an http status code of 206 partial content when this happens, the response header always contains a content range parameter that indicates the items included in the response and the total number of matches if the total number of matches is unknown, an asterisk appears instead for example, the following response header indicates that there are a total of 122 users and the response includes users at position 13 to 15 {'content length' '822', 'expires' ' 1', 'server' 'blueprint', 'content range' 'users 13 15/122', 'pragma' 'no cache', 'cache control' 'no cache', 'date' 'sat, 04 may 2013 11 59 23 gmt', 'content type' 'application/json; charset=utf 8'} pagination examples this request returns the first 50 artifacts (that is, artifacts 0 49) https //production blueprintcloud com/api/v1/projects/220870/artifacts?offset=0\&limit=50 this request returns the next 100 artifacts (that is, artifacts 50 149) https //production blueprintcloud com/api/v1/projects/220870/artifacts?offset=50\&limit=100 this request returns the next 25 artifacts (that is, artifacts 150 174) https //production blueprintcloud com/api/v1/projects/220870/artifacts?offset=150\&limit=25