POST api/Task/GetTaskListSummary

Get Task list summary based on query condition.

Request Information

URI Parameters

None.

Body Parameters

TaskListSummaryBinder
NameDescriptionTypeAdditional information
ProjectId

integer

None.

ShowStoryOption

0: Do not show story, 1: Show all story items met with query conditions, 2: Only show the parent story items of task met with query condition

integer

None.

Condition

StandardQueryCondition

None.

Request Formats

application/json, text/json

Sample:
{
  "ProjectId": 1,
  "ShowStoryOption": 2,
  "Condition": {
    "TaskId": "sample string 1",
    "StoryId": "sample string 2",
    "Keyword": "sample string 3",
    "Subproject": {
      "SubIds": [
        1,
        2
      ],
      "IncludeChildren": true,
      "IncludeClosed": true,
      "IncludeBacklog": true
    },
    "Status": [
      {
        "Id": 1,
        "Option": 2
      },
      {
        "Id": 1,
        "Option": 2
      }
    ],
    "Owner": [
      {
        "Id": 1,
        "Option": 2
      },
      {
        "Id": 1,
        "Option": 2
      }
    ],
    "TaskBoardAssignedOption": 4,
    "FiltersByTeamMemberField": [
      {
        "TeamMemberFieldIds": [
          1,
          2
        ],
        "MemberIds": [
          {
            "Id": 1,
            "Option": 2
          },
          {
            "Id": 1,
            "Option": 2
          }
        ]
      },
      {
        "TeamMemberFieldIds": [
          1,
          2
        ],
        "MemberIds": [
          {
            "Id": 1,
            "Option": 2
          },
          {
            "Id": 1,
            "Option": 2
          }
        ]
      }
    ],
    "DateTimeFields": [
      {
        "FieldId": 1,
        "From": "2020-11-25 03:55:24",
        "To": "2020-11-25 03:55:24"
      },
      {
        "FieldId": 1,
        "From": "2020-11-25 03:55:24",
        "To": "2020-11-25 03:55:24"
      }
    ],
    "NumericFields": [
      {
        "FieldId": 1,
        "From": 1,
        "To": 1
      },
      {
        "FieldId": 1,
        "From": 1,
        "To": 1
      }
    ],
    "TextFields": [
      {
        "FieldId": 1,
        "Word": "sample string 2"
      },
      {
        "FieldId": 1,
        "Word": "sample string 2"
      }
    ],
    "DropdownFields": [
      {
        "FieldId": 1,
        "ChoiceIds": [
          1,
          2
        ]
      },
      {
        "FieldId": 1,
        "ChoiceIds": [
          1,
          2
        ]
      }
    ]
  }
}

application/xml, text/xml

Sample:
<TaskListSummaryBinder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Binding">
  <Condition xmlns:d2p1="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Binding.TaskQuery">
    <d2p1:DateTimeFields>
      <d2p1:DateTimeFieldQueryObject>
        <d2p1:FieldId>1</d2p1:FieldId>
        <d2p1:From>2020-11-25T03:55:24.8245775-08:00</d2p1:From>
        <d2p1:To>2020-11-25T03:55:24.8245775-08:00</d2p1:To>
      </d2p1:DateTimeFieldQueryObject>
      <d2p1:DateTimeFieldQueryObject>
        <d2p1:FieldId>1</d2p1:FieldId>
        <d2p1:From>2020-11-25T03:55:24.8245775-08:00</d2p1:From>
        <d2p1:To>2020-11-25T03:55:24.8245775-08:00</d2p1:To>
      </d2p1:DateTimeFieldQueryObject>
    </d2p1:DateTimeFields>
    <d2p1:DropdownFields>
      <d2p1:EnumerableFieldQueryObjects>
        <d2p1:ChoiceIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1</d5p1:int>
          <d5p1:int>2</d5p1:int>
        </d2p1:ChoiceIds>
        <d2p1:FieldId>1</d2p1:FieldId>
      </d2p1:EnumerableFieldQueryObjects>
      <d2p1:EnumerableFieldQueryObjects>
        <d2p1:ChoiceIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1</d5p1:int>
          <d5p1:int>2</d5p1:int>
        </d2p1:ChoiceIds>
        <d2p1:FieldId>1</d2p1:FieldId>
      </d2p1:EnumerableFieldQueryObjects>
    </d2p1:DropdownFields>
    <d2p1:FiltersByTeamMemberField>
      <d2p1:TeamMemberFieldQueryObjects>
        <d2p1:MemberIds xmlns:d5p1="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Common">
          <d5p1:MemberIdObject>
            <d5p1:Id>1</d5p1:Id>
            <d5p1:Option>2</d5p1:Option>
          </d5p1:MemberIdObject>
          <d5p1:MemberIdObject>
            <d5p1:Id>1</d5p1:Id>
            <d5p1:Option>2</d5p1:Option>
          </d5p1:MemberIdObject>
        </d2p1:MemberIds>
        <d2p1:TeamMemberFieldIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1</d5p1:int>
          <d5p1:int>2</d5p1:int>
        </d2p1:TeamMemberFieldIds>
      </d2p1:TeamMemberFieldQueryObjects>
      <d2p1:TeamMemberFieldQueryObjects>
        <d2p1:MemberIds xmlns:d5p1="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Common">
          <d5p1:MemberIdObject>
            <d5p1:Id>1</d5p1:Id>
            <d5p1:Option>2</d5p1:Option>
          </d5p1:MemberIdObject>
          <d5p1:MemberIdObject>
            <d5p1:Id>1</d5p1:Id>
            <d5p1:Option>2</d5p1:Option>
          </d5p1:MemberIdObject>
        </d2p1:MemberIds>
        <d2p1:TeamMemberFieldIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>1</d5p1:int>
          <d5p1:int>2</d5p1:int>
        </d2p1:TeamMemberFieldIds>
      </d2p1:TeamMemberFieldQueryObjects>
    </d2p1:FiltersByTeamMemberField>
    <d2p1:Keyword>sample string 3</d2p1:Keyword>
    <d2p1:NumericFields>
      <d2p1:NumericFieldQueryObject>
        <d2p1:FieldId>1</d2p1:FieldId>
        <d2p1:From>1</d2p1:From>
        <d2p1:To>1</d2p1:To>
      </d2p1:NumericFieldQueryObject>
      <d2p1:NumericFieldQueryObject>
        <d2p1:FieldId>1</d2p1:FieldId>
        <d2p1:From>1</d2p1:From>
        <d2p1:To>1</d2p1:To>
      </d2p1:NumericFieldQueryObject>
    </d2p1:NumericFields>
    <d2p1:Owner xmlns:d3p1="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Common">
      <d3p1:MemberIdObject>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:Option>2</d3p1:Option>
      </d3p1:MemberIdObject>
      <d3p1:MemberIdObject>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:Option>2</d3p1:Option>
      </d3p1:MemberIdObject>
    </d2p1:Owner>
    <d2p1:Status xmlns:d3p1="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Common">
      <d3p1:StatusIdObject>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:Option>2</d3p1:Option>
      </d3p1:StatusIdObject>
      <d3p1:StatusIdObject>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:Option>2</d3p1:Option>
      </d3p1:StatusIdObject>
    </d2p1:Status>
    <d2p1:StoryId>sample string 2</d2p1:StoryId>
    <d2p1:Subproject>
      <d2p1:IncludeBacklog>true</d2p1:IncludeBacklog>
      <d2p1:IncludeChildren>true</d2p1:IncludeChildren>
      <d2p1:IncludeClosed>true</d2p1:IncludeClosed>
      <d2p1:SubIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </d2p1:SubIds>
    </d2p1:Subproject>
    <d2p1:TaskBoardAssignedOption>4</d2p1:TaskBoardAssignedOption>
    <d2p1:TaskId>sample string 1</d2p1:TaskId>
    <d2p1:TextFields>
      <d2p1:TextFieldQueryObject>
        <d2p1:FieldId>1</d2p1:FieldId>
        <d2p1:Word>sample string 2</d2p1:Word>
      </d2p1:TextFieldQueryObject>
      <d2p1:TextFieldQueryObject>
        <d2p1:FieldId>1</d2p1:FieldId>
        <d2p1:Word>sample string 2</d2p1:Word>
      </d2p1:TextFieldQueryObject>
    </d2p1:TextFields>
  </Condition>
  <ProjectId>1</ProjectId>
  <ShowStoryOption>2</ShowStoryOption>
</TaskListSummaryBinder>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Get Task list summary based on query condition.

API_Data_TaskListSummaryModel
NameDescriptionTypeAdditional information
Success

boolean

None.

Error

ErrorInfo

None.

Data

TaskListSummaryModel

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Error": {
    "ErrorCode": 1,
    "ErrorMessage": "sample string 1"
  },
  "Data": {
    "TaskCount": 1,
    "StoryCount": 2,
    "EstTotal": "sample string 3",
    "TaskPoints": 4,
    "FinishedTaskPoints": 5.1,
    "StoryPoints": 6,
    "FinishedStoryPoints": 7.1,
    "TimeSpentWhole": "sample string 8",
    "TimeSpent": "sample string 9",
    "TimeRemain": "sample string 10",
    "TodayTimeSpent": "sample string 11",
    "FinishPercentage": "47%",
    "FinishedSpecPoints": 12.1,
    "SpecPoints": 13.1,
    "DingPoints": 14,
    "MemberCount": 15,
    "PlanningTotalHours": 16,
    "Workload": "4%",
    "RemainedWorkload": "2%",
    "PlanningRemainHours": 17,
    "DadingSummary": "22m"
  }
}

application/xml, text/xml

Sample:
<API_Data_TaskListSummaryModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Common">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Entities">
    <d2p1:DingPoints>14</d2p1:DingPoints>
    <d2p1:EstTotal>sample string 3</d2p1:EstTotal>
    <d2p1:FinishedSpecPoints>12.1</d2p1:FinishedSpecPoints>
    <d2p1:FinishedStoryPoints>7.1</d2p1:FinishedStoryPoints>
    <d2p1:FinishedTaskPoints>5.1</d2p1:FinishedTaskPoints>
    <d2p1:MemberCount>15</d2p1:MemberCount>
    <d2p1:PlanningRemainHours>17</d2p1:PlanningRemainHours>
    <d2p1:PlanningTotalHours>16</d2p1:PlanningTotalHours>
    <d2p1:SpecPoints>13.1</d2p1:SpecPoints>
    <d2p1:StoryCount>2</d2p1:StoryCount>
    <d2p1:StoryPoints>6</d2p1:StoryPoints>
    <d2p1:TaskCount>1</d2p1:TaskCount>
    <d2p1:TaskPoints>4</d2p1:TaskPoints>
    <d2p1:TimeRemain>sample string 10</d2p1:TimeRemain>
    <d2p1:TimeSpent>sample string 9</d2p1:TimeSpent>
    <d2p1:TimeSpentWhole>sample string 8</d2p1:TimeSpentWhole>
    <d2p1:TodayTimeSpent>sample string 11</d2p1:TodayTimeSpent>
  </Data>
  <Error>
    <ErrorCode>1</ErrorCode>
    <ErrorMessage>sample string 1</ErrorMessage>
  </Error>
  <Success>true</Success>
</API_Data_TaskListSummaryModel>