コレクション

リソースコレクションは、リソースインスタンスのセットです。たとえば、不具合コレクションには、不具合を表すリソースが含まれています。

概要

リソースコレクションは、リソースインスタンスのセットです。たとえば、不具合コレクションには、不具合を表すリソースが含まれています。

  • リソースコレクションには、0->N個のリソースインスタンスが含まれる場合があります。

  • エンティティコレクションは、エンティティのリソースコレクションです (インスタンスを参照)。

  • リソースコレクションは、次の構文を使用して識別されます。 

    <scheme name>:<authority>/admin/<resource_collection>

    サイトレベルの権限が適用されます。

    <scheme name>:<authority>/api/shared_spaces/<space_id>/workspaces/<workspace_id>/<resource_collection>

    		 ワークスペースレベルの権限が適用されます。

    <scheme name>:<authority>/api/shared_spaces/<space_id>/<resource_collection>

    スペースレベルの権限が適用されます。

トップに戻る

URI

ワークスペース、共有スペース、およびサイトレベルのURI形式は次のとおりです。

https://<server>:<port>/api/shared_spaces/<space_id>/workspaces/{workspace_id}/<entity_collection>

https://<server>:<port>/api/shared_spaces/<space_id>/<entity_collection>

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

不具合コレクションの使用

https://<server>:<port>/api/shared_spaces/<space_id>/workspaces/<workspace_id>/defects

URIでパラメーターを指定するための構文については、変数と値を参照してください。

注:

このドキュメント全体を通して、サンプルURIは省略されており、サーバーとポートのコンテキストは含まれていません。

http://<server>:<port>/api/shared_spaces/<space_id>/workspaces/<workspace_id>/<entities>

になる:

.../api/shared_spaces/<space_id>/workspaces/<workspace_id>/<entities>

トップに戻る

サポートされているリクエストメソッド

リソースコレクションは、次のHTTPリクエストメソッドをサポートしています。

方法

説明

サポート...

GET

データを取得する

サポート: フィルタリング、フィールド選択、ソート、およびページ付け。

POST

新しいエンティティを作成する

 

PUT

既存のエンティティを更新する

サポート: フィルタリング。

DELETE

既存のエンティティを削除する

サポート: フィルターで削除。

トップに戻る

コレクションに対するアクション

トップに戻る

参照情報: