REST API - List Groups Request
9 min
/api/v1/groups?offset={offset}&limit={limit}Description
Retrieves a list of all groups in this Blueprint instance.
URL Structure
[Blueprint_URI]/api/v1/groupsSupported Methods
- HEAD
- GET
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, Traces, Offset or Limit parameters.
- A required value has not been provided.
- 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=0Response 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=0Response 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" }]