インスタンス (エンティティ)
インスタンス (エンティティ) は、1つの不具合や1つのアプリケーションモジュールなど、コレクションの単一のメンバーです。
概要
インスタンス (エンティティ) は、不具合やアプリケーションモジュールなどのコレクションの単一のメンバーです。
エンティティのフィールドは、エンティティのフィールドメタデータREST APIによって定義されたとおりです。
REST APIで記述されている各インスタンスには、IDで直接アクセスできます。
-
リソースインスタンスは、サーバー側のオブジェクトを表します。
-
リソースインスタンスは、関連するコンテキストでの一意のIDによって識別されます。
-
エンティティはリソースインスタンスです。
-
リソースインスタンスは、次の構文を使用して識別されます。
<context>/<resource collection>/<resource instance id>
URI
不具合インスタンスのIDが追加された包含コレクションのURIの例:
.../api/shared_spaces/<space_id/workspaces/<workspace_id>/defects/2005
注: URIでパラメーターを指定するための構文については、変数と値を参照してください。
サポートされているリクエストメソッド
インスタンスリソースは、次のHTTPリクエストメソッドをサポートしています。
方法 |
説明 |
サポート |
---|---|---|
GET |
データを取得する |
エンティティを読む サポート:フィールド選択 |
PUT |
既存のエンティティを更新する |
|
DELETE |
既存のエンティティを削除する |
|
例
以下に、不具合リソースインスタンスのGET要求と、対応する応答を示します。
GET .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/defects/1003
{
"type": "defect",
"creation_time": "2014-01-27T13:01:52Z",
"parent": {
"type": "work_item_root",
"id": "1002"
},
"logical_name": "1nq47mymd4o28sxkyeker7l86",
"version_stamp": 1,
"release": {
"type": "release",
"id": "1002"
},
"description": "<html><body>\ndefect 1\n</body></html>",
"id": "1003",
"last_modified": "2016-01-27T13:01:52Z",
"severity": {
"type": "list_node",
"id": "1073"
},
"phase": {
"type": "phase",
"id": "1015"
},
"priority": null,
"name": "def1",
}
インスタンスに対するアクション
参照情報: