POST api/Task/TaskBoardsByPlanDate
Get task board data grouped by owner
Request Information
URI Parameters
None.
Body Parameters
TaskQueryBinder| Name | Description | Type | Additional information |
|---|---|---|---|
| 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. |
| ShowAll |
Indicate whether show all tasks or only show tasks by paging. |
boolean |
None. |
| PageSize |
Indicate the amount of tasks per page |
integer |
None. |
| PageIndex |
Indicate which page will show, PageIndex is one-based. To get first page, please set PageIndex to be 1. |
integer |
None. |
| GetCount |
Indicate whether return the count of all tasks or not. |
boolean |
None. |
| SortFieldId |
Indicate which field the list of tasks will be sorted by and whether the list of tasks will use ascending order or descending order, if value grater less 0, then use descending order, else use ascending order. e.g. -101: sorted by title and use descending order. 101: sorted by title and use ascending order |
integer |
None. |
| Condition |
Search condition. Include keyword, task id, status, owner, subproject etc. |
StandardQueryCondition |
None. |
| ShowTasks2DTT |
Indicate whether show that tasks which have linked to DevTest's templates or tasks. |
boolean |
None. |
| ProjectId | integer |
None. |
|
| FieldIds |
These fields's value will be returned. e.g. 101:Title, 108:Owner, 601:Status, please refer to DevSuite Admin to get more info about field id. |
Collection of integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"ShowStoryOption": 1,
"ShowAll": true,
"PageSize": 3,
"PageIndex": 4,
"GetCount": true,
"SortFieldId": 6,
"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
}
],
"IssueType": [
1,
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": "2024-12-21 14:55:27",
"To": "2024-12-21 14:55:27",
"Ranges": [
{
"OnlyUnassigned": true,
"From": "2024-12-21 14:55:27",
"To": "2024-12-21 14:55:27"
},
{
"OnlyUnassigned": true,
"From": "2024-12-21 14:55:27",
"To": "2024-12-21 14:55:27"
}
]
},
{
"FieldId": 1,
"From": "2024-12-21 14:55:27",
"To": "2024-12-21 14:55:27",
"Ranges": [
{
"OnlyUnassigned": true,
"From": "2024-12-21 14:55:27",
"To": "2024-12-21 14:55:27"
},
{
"OnlyUnassigned": true,
"From": "2024-12-21 14:55:27",
"To": "2024-12-21 14:55:27"
}
]
}
],
"NumericFields": [
{
"FieldId": 1,
"From": 1,
"To": 1,
"Ranges": [
{
"OnlyUnassigned": true,
"From": 1,
"To": 1
},
{
"OnlyUnassigned": true,
"From": 1,
"To": 1
}
],
"Values": [
1,
2
],
"OperationType": 2
},
{
"FieldId": 1,
"From": 1,
"To": 1,
"Ranges": [
{
"OnlyUnassigned": true,
"From": 1,
"To": 1
},
{
"OnlyUnassigned": true,
"From": 1,
"To": 1
}
],
"Values": [
1,
2
],
"OperationType": 2
}
],
"TextFields": [
{
"FieldId": 1,
"Word": "sample string 2",
"NotInclude": true
},
{
"FieldId": 1,
"Word": "sample string 2",
"NotInclude": true
}
],
"DropdownFields": [
{
"FieldId": 1,
"ChoiceIds": [
1,
2
],
"NotInclude": true
},
{
"FieldId": 1,
"ChoiceIds": [
1,
2
],
"NotInclude": true
}
],
"DefinedQueryId": 5
},
"ShowTasks2DTT": true,
"ProjectId": 8,
"FieldIds": [
1,
2
]
}
application/xml, text/xml
Sample:
<TaskQueryBinder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Binding">
<FieldIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</FieldIds>
<ProjectId>8</ProjectId>
<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>2024-12-21T18:55:27.9208999-08:00</d2p1:From>
<d2p1:Ranges>
<d2p1:ValueRangeOfdateTime>
<d2p1:From>2024-12-21T18:55:27.9208999-08:00</d2p1:From>
<d2p1:OnlyUnassigned>true</d2p1:OnlyUnassigned>
<d2p1:To>2024-12-21T18:55:27.9208999-08:00</d2p1:To>
</d2p1:ValueRangeOfdateTime>
<d2p1:ValueRangeOfdateTime>
<d2p1:From>2024-12-21T18:55:27.9208999-08:00</d2p1:From>
<d2p1:OnlyUnassigned>true</d2p1:OnlyUnassigned>
<d2p1:To>2024-12-21T18:55:27.9208999-08:00</d2p1:To>
</d2p1:ValueRangeOfdateTime>
</d2p1:Ranges>
<d2p1:To>2024-12-21T18:55:27.9208999-08:00</d2p1:To>
</d2p1:DateTimeFieldQueryObject>
<d2p1:DateTimeFieldQueryObject>
<d2p1:FieldId>1</d2p1:FieldId>
<d2p1:From>2024-12-21T18:55:27.9208999-08:00</d2p1:From>
<d2p1:Ranges>
<d2p1:ValueRangeOfdateTime>
<d2p1:From>2024-12-21T18:55:27.9208999-08:00</d2p1:From>
<d2p1:OnlyUnassigned>true</d2p1:OnlyUnassigned>
<d2p1:To>2024-12-21T18:55:27.9208999-08:00</d2p1:To>
</d2p1:ValueRangeOfdateTime>
<d2p1:ValueRangeOfdateTime>
<d2p1:From>2024-12-21T18:55:27.9208999-08:00</d2p1:From>
<d2p1:OnlyUnassigned>true</d2p1:OnlyUnassigned>
<d2p1:To>2024-12-21T18:55:27.9208999-08:00</d2p1:To>
</d2p1:ValueRangeOfdateTime>
</d2p1:Ranges>
<d2p1:To>2024-12-21T18:55:27.9208999-08:00</d2p1:To>
</d2p1:DateTimeFieldQueryObject>
</d2p1:DateTimeFields>
<d2p1:DefinedQueryId>5</d2p1:DefinedQueryId>
<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:NotInclude>true</d2p1:NotInclude>
</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:NotInclude>true</d2p1:NotInclude>
</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:IssueType xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:int>1</d3p1:int>
<d3p1:int>2</d3p1:int>
</d2p1:IssueType>
<d2p1:Keyword>sample string 3</d2p1:Keyword>
<d2p1:NumericFields>
<d2p1:NumericFieldQueryObject>
<d2p1:FieldId>1</d2p1:FieldId>
<d2p1:From>1</d2p1:From>
<d2p1:OperationType>2</d2p1:OperationType>
<d2p1:Ranges>
<d2p1:ValueRangeOfint>
<d2p1:From>1</d2p1:From>
<d2p1:OnlyUnassigned>true</d2p1:OnlyUnassigned>
<d2p1:To>1</d2p1:To>
</d2p1:ValueRangeOfint>
<d2p1:ValueRangeOfint>
<d2p1:From>1</d2p1:From>
<d2p1:OnlyUnassigned>true</d2p1:OnlyUnassigned>
<d2p1:To>1</d2p1:To>
</d2p1:ValueRangeOfint>
</d2p1:Ranges>
<d2p1:To>1</d2p1:To>
<d2p1:Values xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:int>1</d5p1:int>
<d5p1:int>2</d5p1:int>
</d2p1:Values>
</d2p1:NumericFieldQueryObject>
<d2p1:NumericFieldQueryObject>
<d2p1:FieldId>1</d2p1:FieldId>
<d2p1:From>1</d2p1:From>
<d2p1:OperationType>2</d2p1:OperationType>
<d2p1:Ranges>
<d2p1:ValueRangeOfint>
<d2p1:From>1</d2p1:From>
<d2p1:OnlyUnassigned>true</d2p1:OnlyUnassigned>
<d2p1:To>1</d2p1:To>
</d2p1:ValueRangeOfint>
<d2p1:ValueRangeOfint>
<d2p1:From>1</d2p1:From>
<d2p1:OnlyUnassigned>true</d2p1:OnlyUnassigned>
<d2p1:To>1</d2p1:To>
</d2p1:ValueRangeOfint>
</d2p1:Ranges>
<d2p1:To>1</d2p1:To>
<d2p1:Values xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:int>1</d5p1:int>
<d5p1:int>2</d5p1:int>
</d2p1:Values>
</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:NotInclude>true</d2p1:NotInclude>
<d2p1:Word>sample string 2</d2p1:Word>
</d2p1:TextFieldQueryObject>
<d2p1:TextFieldQueryObject>
<d2p1:FieldId>1</d2p1:FieldId>
<d2p1:NotInclude>true</d2p1:NotInclude>
<d2p1:Word>sample string 2</d2p1:Word>
</d2p1:TextFieldQueryObject>
</d2p1:TextFields>
</Condition>
<GetCount>true</GetCount>
<PageIndex>4</PageIndex>
<PageSize>3</PageSize>
<ShowAll>true</ShowAll>
<ShowTasks2DTT>true</ShowTasks2DTT>
<SortFieldId>6</SortFieldId>
<ShowStoryOption>1</ShowStoryOption>
</TaskQueryBinder>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Get task board data grouped by owner
API_Data_ListOfDataOfOwnerOfTaskListModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Success | boolean |
None. |
|
| Error | ErrorInfo |
None. |
|
| Data | Collection of DataOfOwnerOfTaskListModel |
None. |
Response Formats
application/json, text/json
Sample:
{
"Success": true,
"Error": {
"ErrorCode": 1,
"ErrorMessage": "sample string 1"
},
"Data": [
{
"Owner": {
"MemberId": {
"Id": 1,
"Option": 2
},
"MemberName": "sample string 1"
},
"Data": {
"Tasks": [
{
"ItemId": {
"Id": 1,
"Option": 2
},
"IfClosed": 1,
"StoryItemId": 1,
"StoryDisplayId": "sample string 1",
"LinkedRequirementItemId": 1,
"LinkedRequirementProjectId": 1,
"LinkedDevTestTemplateIDs": [
1,
2
],
"Values": [
{
"Id": 1,
"Name": "sample string 2",
"Value": "sample string 3",
"ChoiceId": {}
},
{
"Id": 1,
"Name": "sample string 2",
"Value": "sample string 3",
"ChoiceId": {}
}
],
"Children": [],
"IssueTypeValue": {
"TypeId": 1,
"TypeName": "sample string 2",
"IconIndex": 1,
"SystemTypeId": 3,
"LinkedFieldId": 4
}
},
{
"ItemId": {
"Id": 1,
"Option": 2
},
"IfClosed": 1,
"StoryItemId": 1,
"StoryDisplayId": "sample string 1",
"LinkedRequirementItemId": 1,
"LinkedRequirementProjectId": 1,
"LinkedDevTestTemplateIDs": [
1,
2
],
"Values": [
{
"Id": 1,
"Name": "sample string 2",
"Value": "sample string 3",
"ChoiceId": {}
},
{
"Id": 1,
"Name": "sample string 2",
"Value": "sample string 3",
"ChoiceId": {}
}
],
"Children": [],
"IssueTypeValue": {
"TypeId": 1,
"TypeName": "sample string 2",
"IconIndex": 1,
"SystemTypeId": 3,
"LinkedFieldId": 4
}
}
],
"Total": 1
}
},
{
"Owner": {
"MemberId": {
"Id": 1,
"Option": 2
},
"MemberName": "sample string 1"
},
"Data": {
"Tasks": [
{
"ItemId": {
"Id": 1,
"Option": 2
},
"IfClosed": 1,
"StoryItemId": 1,
"StoryDisplayId": "sample string 1",
"LinkedRequirementItemId": 1,
"LinkedRequirementProjectId": 1,
"LinkedDevTestTemplateIDs": [
1,
2
],
"Values": [
{
"Id": 1,
"Name": "sample string 2",
"Value": "sample string 3",
"ChoiceId": {}
},
{
"Id": 1,
"Name": "sample string 2",
"Value": "sample string 3",
"ChoiceId": {}
}
],
"Children": [],
"IssueTypeValue": {
"TypeId": 1,
"TypeName": "sample string 2",
"IconIndex": 1,
"SystemTypeId": 3,
"LinkedFieldId": 4
}
},
{
"ItemId": {
"Id": 1,
"Option": 2
},
"IfClosed": 1,
"StoryItemId": 1,
"StoryDisplayId": "sample string 1",
"LinkedRequirementItemId": 1,
"LinkedRequirementProjectId": 1,
"LinkedDevTestTemplateIDs": [
1,
2
],
"Values": [
{
"Id": 1,
"Name": "sample string 2",
"Value": "sample string 3",
"ChoiceId": {}
},
{
"Id": 1,
"Name": "sample string 2",
"Value": "sample string 3",
"ChoiceId": {}
}
],
"Children": [],
"IssueTypeValue": {
"TypeId": 1,
"TypeName": "sample string 2",
"IconIndex": 1,
"SystemTypeId": 3,
"LinkedFieldId": 4
}
}
],
"Total": 1
}
}
]
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.