REST API - List Groups Request

/api/v1/groups?offset={offset}\&limit={limit} description retrieves a list of all groups in this blueprint instance url structure \[blueprint uri]/api/v1/groups supported methods head docid\ eqnd3zptd6dwf3go3ufox get docid 7hm2r py7e84xk2msf11b request uri 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 http status codes 200 ok 201 successfully created 206 partial content 400 bad request this error can occur for a variety of reasons at least one uri or request body parameter is invalid, such as one of the filter docid\ sv9gjverxczcgqdn28j7u , traces, offset or limit parameters a required value has not been provided if you are submitting a post docid\ hsi lzxs8g rx ydudzkg or patch docid\ rcjvhrlby6de zgkehxui request and have not added the x http method override parameter to your request header 401 unauthorized the blueprint token is missing, invalid or expired 403 forbidden the applicable permissions are needed for example, this error can occur when an author or collaborate license is needed for access comment permissions are needed on the artifact edit permissions are needed on the change summary job 404 notfound item is not found in the project for example, this error can occur when artifact not found artifact type not found project not found alm target not found change summary job not found user does not have edit permissions for this artifact, project or alm target 409 conflict reason for failure can be found in the response body additional information may also be found in the log 411 length required if the content length header is missing in the request 413 request entity too large if the provided file size is larger than allowed 415 unsupported media type if the provided media type is not of mime multipart content "form data " 416 request range not satisfiable if offset points to a part of a collection that is not available 500 internal server error 501 not implemented examples xml example request uri https //production blueprintcloud com/api/v1/groups?limit=5\&offset=0 response header {'content length' '372', 'expires' ' 1', 'server' 'blueprint', 'content range' 'groups 0 4/74', 'pragma' 'no cache', 'cache control' 'no cache', 'date' 'sat, 04 may 2013 14 59 16 gmt', 'content type' 'application/xml; charset=utf 8'} response body \<?xml version="1 0" ?>\<groups xmlns="http //www blueprintsys com/blueprint/api/v1" xmlns\ i="http //www w3 org/2001/xmlschema instance"> \<group> \<id>1\</id> \<name>author\</name> \</group> \<group> \<id>2\</id> \<name>collaborator\</name> \</group> \<group> \<id>3\</id> \<name>dept sales\</name> \</group> \<group> \<id>4\</id> \<name>dept presales\</name> \</group> \<group> \<id>5\</id> \<name>dept services\</name> \</group>\</groups> json example request uri https //production blueprintcloud com/api/v1/groups?limit=5\&offset=0 response header {'content length' '316', 'expires' ' 1', 'server' 'blueprint', 'content range' 'groups 0 4/74', 'pragma' 'no cache', 'cache control' 'no cache', 'date' 'sat, 04 may 2013 11 43 00 gmt', 'content type' 'application/json; charset=utf 8'} response body \[ { "projectid" null, "type" "group", "id" 1, "name" "author" }, { "projectid" null, "type" "group", "id" 2, "name" "collaborator" }, { "projectid" null, "type" "group", "id" 3, "name" "dept sales" }, { "projectid" null, "type" "group", "id" 4, "name" "dept presales" }, { "projectid" null, "type" "group", "id" 5, "name" "dept services" }]