ワークアイテムをID指定で取得

ID を指定してワークアイテムを取得するには、以下の API を使用します。

GET /api/workitem/workitems/{workitemIds}

以下の例は ID:64 のワークアイテムを取得します。

GET /api/workitem/workitems/64

レスポンスは以下のようになります。fields にワークアイテムが持つフィールドとその値が設定されます。

Response

[
  {
    "fields": {
      "Id": "64",
      "ProjectId": "4",
      "ProjectName": "R商品開発",
      "ProjectCode": "PRJ-001",
      "ItemTypeId": "3",
      "StatusTypeId": "3",
      "FolderId": "62",
      "FolderName": "開発",
      "ParentId": "63",
      "ParentName": "仕様",
      "ProcessCategoryId": "5",
      "TimeEntryCategoryId": "4",
      "Name": "要求ヒアリング",
      "Code": "RH",
      ...
    },
    "isWarning": false,
    "warnings":[],
    "aclId": "0",
    "permission": -1
  }
]

ID はカンマ区切りで複数指定できます。

GET /api/workitem/workitems/64,65,66

レスポンスは配列で、配列の各要素に指定した ID のワークアイテムが含まれます。

Response

[
  {
    "fields": {
      "Id": "64",
      "ProjectId": "4",
      "ProjectName": "R商品開発",
      "ProjectCode": "PRJ-001",
      "ItemTypeId": "3",
      "StatusTypeId": "3",
      "FolderId": "62",
      "FolderName": "開発",
      "ParentId": "63",
      "ParentName": "仕様",
      "ProcessCategoryId": "5",
      "TimeEntryCategoryId": "4",
      "Name": "要求ヒアリング",
      "Code": "RH",
      ...
    },
    ...
  },
  {
    "fields": {
      "Id": "65",
      ...
    },
    ...
  },
  {
    "fields": {
      "Id": "66",
      ...
    },
    ...
  }
]

注記

単一の ID を指定した場合でもレスポンスは配列です。

fields クエリパラメータに取得するフィールドを指定できます。省略した場合は、ワークアイテムが持つすべてのフィールドが返ります。

GET /api/workitem/workitems/64?fields=Name,ActualProgress,ActualTime

Response

[
  {
    "fields": {
      "Id": "64",
      "Name": "要求ヒアリング",
      "ActualProgress": 100.0,
      "ActualTime": 600,
      "IsAclInherited": false,
      "CanEdit": true
    },
    "isWarning": false,
    "warnings":[],
    "aclId": "0",
    "permission": -1
  }
]

注記

フィールドはシステム名で指定します。

注記

fields パラメータに指定したフィールド以外にも一部のフィールドが返されます。