Collections

A resource collection is a set of resource instances. For example, the defects collection contains resources that represent defects.

URIs

The URI formats for the workspace, shared space, and site levels are:

https://{server>:{port}/api/shared_spaces/{uid}/workspaces/{id}/<entity_collection>

https://{server>:{port}/api/shared_spaces/{uid}/<entity_collection>

https://<server>:<port>/admin/<entity_collection>

Example: Using the defects collection

https://{server}:{port}/api/shared_spaces/<shared_space_id>/workspaces/1003/defects

For the syntax for specifying parameters in URIs, see Variables and values.

Note: Throughout this document, the example URIs are abbreviated, without the server and port context.

https://{server}:{port}/api/shared_spaces/{uid}/workspaces/{id}/<entity_collection>

Becomes:

.../api/shared_spaces/{uid}/workspaces/{id}/<entity_collection>

Back to top

Supported request methods

Resource collection supports the following HTTP request methods:

Method

Description

Supports...

GET

Retrieve the data

Supports: Filtering, field selection, sorting, and pagination.

POST

Create new entities

 

PUT

Update existing entities

Supports: Filtering.

DELETE

Delete existing entities

Supports: Delete by filter.

Back to top

Actions on collections

Back to top

See also: