POST api/storyboard/listByStatus
Get story board which is listed by Progress Status based on query condition.
Request Information
URI Parameters
None.
Body Parameters
StoryboardBinder4Status| Name | Description | Type | Additional information |
|---|---|---|---|
| ShowStoryOption |
0: Don't show story. 1: Show story as separate column 2: Show story as swim lane |
integer |
None. |
| MaxAmountPerCell | integer |
None. |
|
| GroupByStatusGroup | boolean |
None. |
|
| SubProjectId | integer |
None. |
|
| Setting | StoryboardSetting |
None. |
|
| Condition | AdvancedQueryCondition |
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,
"MaxAmountPerCell": 2,
"GroupByStatusGroup": true,
"SubProjectId": 4,
"Setting": {
"SortByFieldId": 1,
"IncludeChildSub": true,
"IncludeClosedSub": true,
"IncludeBacklogSub": true,
"FolderSearchOption": 5
},
"Condition": {
"TaskId": "sample string 1",
"StoryId": "sample string 2",
"Keyword": "sample string 3",
"Subproject": [
1,
2
],
"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:47:24",
"To": "2024-12-21 14:47:24",
"Ranges": [
{
"OnlyUnassigned": true,
"From": "2024-12-21 14:47:24",
"To": "2024-12-21 14:47:24"
},
{
"OnlyUnassigned": true,
"From": "2024-12-21 14:47:24",
"To": "2024-12-21 14:47:24"
}
]
},
{
"FieldId": 1,
"From": "2024-12-21 14:47:24",
"To": "2024-12-21 14:47:24",
"Ranges": [
{
"OnlyUnassigned": true,
"From": "2024-12-21 14:47:24",
"To": "2024-12-21 14:47:24"
},
{
"OnlyUnassigned": true,
"From": "2024-12-21 14:47:24",
"To": "2024-12-21 14:47:24"
}
]
}
],
"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
},
"ProjectId": 5,
"FieldIds": [
1,
2
]
}
application/xml, text/xml
Sample:
<StoryboardBinder4Status 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>5</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:47:24.0883531-08:00</d2p1:From>
<d2p1:Ranges>
<d2p1:ValueRangeOfdateTime>
<d2p1:From>2024-12-21T18:47:24.0883531-08:00</d2p1:From>
<d2p1:OnlyUnassigned>true</d2p1:OnlyUnassigned>
<d2p1:To>2024-12-21T18:47:24.0883531-08:00</d2p1:To>
</d2p1:ValueRangeOfdateTime>
<d2p1:ValueRangeOfdateTime>
<d2p1:From>2024-12-21T18:47:24.0883531-08:00</d2p1:From>
<d2p1:OnlyUnassigned>true</d2p1:OnlyUnassigned>
<d2p1:To>2024-12-21T18:47:24.0883531-08:00</d2p1:To>
</d2p1:ValueRangeOfdateTime>
</d2p1:Ranges>
<d2p1:To>2024-12-21T18:47:24.0883531-08:00</d2p1:To>
</d2p1:DateTimeFieldQueryObject>
<d2p1:DateTimeFieldQueryObject>
<d2p1:FieldId>1</d2p1:FieldId>
<d2p1:From>2024-12-21T18:47:24.0883531-08:00</d2p1:From>
<d2p1:Ranges>
<d2p1:ValueRangeOfdateTime>
<d2p1:From>2024-12-21T18:47:24.0883531-08:00</d2p1:From>
<d2p1:OnlyUnassigned>true</d2p1:OnlyUnassigned>
<d2p1:To>2024-12-21T18:47:24.0883531-08:00</d2p1:To>
</d2p1:ValueRangeOfdateTime>
<d2p1:ValueRangeOfdateTime>
<d2p1:From>2024-12-21T18:47:24.0883531-08:00</d2p1:From>
<d2p1:OnlyUnassigned>true</d2p1:OnlyUnassigned>
<d2p1:To>2024-12-21T18:47:24.0883531-08:00</d2p1:To>
</d2p1:ValueRangeOfdateTime>
</d2p1:Ranges>
<d2p1:To>2024-12-21T18:47:24.0883531-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 xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:int>1</d3p1:int>
<d3p1:int>2</d3p1:int>
</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>
<Setting>
<FolderSearchOption>5</FolderSearchOption>
<IncludeBacklogSub>true</IncludeBacklogSub>
<IncludeChildSub>true</IncludeChildSub>
<IncludeClosedSub>true</IncludeClosedSub>
<SortByFieldId>1</SortByFieldId>
</Setting>
<SubProjectId>4</SubProjectId>
<GroupByStatusGroup>true</GroupByStatusGroup>
<MaxAmountPerCell>2</MaxAmountPerCell>
<ShowStoryOption>1</ShowStoryOption>
</StoryboardBinder4Status>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Get story board which is listed by Progress Status based on query condition.
API_Data_StoryBoardByStatus| Name | Description | Type | Additional information |
|---|---|---|---|
| Success | boolean |
None. |
|
| Error | ErrorInfo |
None. |
|
| Data | StoryBoardByStatus |
None. |
Response Formats
application/json, text/json
Sample:
{
"Success": true,
"Error": {
"ErrorCode": 1,
"ErrorMessage": "sample string 1"
},
"Data": {
"StatusList": [
{
"StatusId": {
"Id": 1,
"Option": 2
},
"StatusName": "sample string 1",
"IfClosed": 1,
"Children": []
},
{
"StatusId": {
"Id": 1,
"Option": 2
},
"StatusName": "sample string 1",
"IfClosed": 1,
"Children": []
}
],
"StoryList": [
{
"StoryItem": {
"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
}
},
"DataItems": [
{
"Status": {
"Id": 1,
"Option": 2
},
"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
},
{
"Status": {
"Id": 1,
"Option": 2
},
"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
}
]
},
{
"StoryItem": {
"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
}
},
"DataItems": [
{
"Status": {
"Id": 1,
"Option": 2
},
"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
},
{
"Status": {
"Id": 1,
"Option": 2
},
"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.