Collections

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

In this topic:

Overview

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

• Resource collections may contain 0->N resource instances.

• An entity collection is a resource collection of entities (see instances).

• A resource collection is identified using the following syntax.

  Level	Syntax
  Workspace	<scheme name>:<authority>/api/shared_spaces/<space_id>/workspaces/<workspace_id>/<resource_collection> Workspace level permissions are applied.
  Space	<scheme name>:<authority>/api/shared_spaces/<space_id>/<resource_collection> Space level permissions are applied.

Back to top

URIs

The following are the URI formats for the different levels.

Level	Syntax
Workspace	https://<server>:<port>/api/shared_spaces/<space_id>/workspaces/{workspace_id}/<entity_collection>
Space	https://<server>:<port>/api/shared_spaces/<space_id>/<entity_collection>

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

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	None
PUT	Update existing entities	Supports: Filtering.
DELETE	Delete existing entities	Supports: Delete by filter.

Back to top

Actions on collections

You can perform the following actions on resource collections:

• Query a collection

• POST: Create instances in a collection

• PUT: Update multiple instances

• DELETE: Delete a collection

Back to top

See also:

• Interactive API client
• Entry points
• Instances (Entities)

• Relations