このページを共有
GET: すべてのインスタンスを読む
このトピックでは、GET操作を使用してすべてのエンティティに関する情報を取得する方法について説明します。
概要
インスタンスは、情報の完全な機能単位です。たとえば、単一の不具合です。インスタンスのプロパティは、JSON形式のデータで表されます。
インスタンスはコレクションのメンバーです。コレクションを参照してください。
エンティティのリソースを取得するには、エンティティコレクションのURIを使用します。
GET .../api/shared_spaces/{shared_space_uid}/workspaces/{workspace_id}/defects
注: インスタンスを取得する場合、RESTAPIは必ずしもインスタンスのすべてのフィールドを表示するわけではありません。使用可能なフィールドの完全なリストについては、メタデータの取得を参照してください。
例
すべての不具合を取得する例GET .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/defects
*** Response ***
{
"total_count": 3,
"data": [{
"type": "defect",
"creation_time": "2016-10-27T10:35:46Z",
"parent": {
"type": "work_item_root",
"id": "1001"
},
"version_stamp": 9,
"description": "<html><body>\n<p>Emptying out items in cart takes way too long. It could take more than 45 seconds. </p> \n</body></html>",
"id": "1014",
"severity": {
"type": "list_node",
"id": "1005"
},
"name": "Emptying out items in cart takes way too long",
...
},
{
"type": "defect",
"creation_time": "2016-10-27T10:32:23Z",
"parent": {
"type": "feature",
"id": "1007"
},
"version_stamp": 8,
"description": "<html><body>\n<p>Shortcut key for deleting all items in cart does not work when there are more than 10 items in the cart.</p> \n</body></html>",
"id": "1012",
"severity": {
"type": "list_node",
"id": "1003"
},
"name": "Shortcut key for deleting all items in cart does not work.",
...
},
{
"type": "defect",
"creation_time": "2016-10-27T10:33:03Z",
"parent": {
"type": "feature",
"id": "1007"
},
"version_stamp": 9,
"description": "<html><body>\n<p>When adding one item to cart, it appears as if the item was added two times. In actuality, it is only added once. If the user refreshes the screen, it appears correctly. This only happens in Chrome.</p> \n</body></html>",
"id": "1013",
"severity": {
"type": "list_node",
"id": "1005"
},
"name": "When adding one item to cart, it appears as if the item was added two times.",
...
}],
"exceeds_total_count": false
}
すべてのスペースを取得する例GET .../api/shared_spaces
*** Response ***
{
"total_count": 1,
"data": [
{
"type": "shared_space",
"name": "Default Isolated Space",
"id": "1001"
}
],
"exceeds_total_count": false
}
特定の共有スペース内のすべてのワークスペースを取得する例現在のユーザーのワークスペースのみが返されます。
GET .../api/shared_spaces/<space_id>/workspaces/<workspace_id>/workspaces
*** Response ***
{
"total_count": 2,
"data": [
{
"type": "workspace",
"creation_time": "2017-05-20T19:08:12Z",
"version_stamp": 1,
"name": "default_workspace",
"id": "1002",
"last_modified": "2017-05-20T19:08:12Z"
},
{
"type": "workspace",
"creation_time": "2017-05-21T08:03:25Z",
"version_stamp": 1,
"name": "MyWorkspace",
"id": "1003",
"last_modified": "2017-05-21T08:03:25Z"
}
],
"exceeds_total_count": false
}
例: 削除されたワークスペースの履歴のGETリクエストこの例は、スペース管理者がスペースコンテキストで削除されたワークスペースの履歴を取得する方法を示しています。この例では、特別なリソースdelete-workspacesを使用します。この場合、PayrollとLogisticsの2つのワークスペースが削除されました。
ワークスペースを削除する方法の例については、例: 特定のワークスペースを削除するを参照してください。
POST .../api/shared_spaces/1001/deleted-workspaces
*** Sample response ***
[
{
"time": "2018-05-27T19:06:59Z",
"workspace_id": 2001,
"workspace_name": "Payroll",
"user_name": "marta@MyCompany.com",
"session_id": "9a1d3ee5-4f63-4fcf-aa99-fd660944fcd1"
},
{
"time": "2018-05-27T19:11:24Z",
"workspace_id": 2002,
"workspace_name": "Logistics",
"user_name": "Lee@MyCompany.com",
"session_id": "bb983a8a-b0ca-42b5-b359-b405f0e8c577"
}
]
参照情報:
