POST api/tasklist/query

Get Tasks base on query condition.

Request Information

URI Parameters

None.

Body Parameters

TaskList2Binder
NameDescriptionTypeAdditional information
ProjectId

integer

None.

FieldIds

Collection of integer

None.

SubProjectId

integer

None.

Setting

TaskListSetting

None.

Condition

AdvancedQueryCondition

None.

Request Formats

application/json, text/json

Sample:
{
  "ProjectId": 1,
  "FieldIds": [
    1,
    2
  ],
  "SubProjectId": 1,
  "Setting": {
    "SortByFieldId": 1,
    "PageSize": 2,
    "PageIndex": 3,
    "GetCount": true,
    "ShowStoryOption": 5,
    "ShowTasks2DTT": true,
    "IncludeChildSub": true,
    "IncludeClosedSub": true,
    "IncludeBacklogSub": true,
    "FolderSearchOption": 11
  },
  "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-07-14 04:38:13",
        "To": "2024-07-14 04:38:13",
        "Ranges": [
          {
            "OnlyUnassigned": true,
            "From": "2024-07-14 04:38:13",
            "To": "2024-07-14 04:38:13"
          },
          {
            "OnlyUnassigned": true,
            "From": "2024-07-14 04:38:13",
            "To": "2024-07-14 04:38:13"
          }
        ]
      },
      {
        "FieldId": 1,
        "From": "2024-07-14 04:38:13",
        "To": "2024-07-14 04:38:13",
        "Ranges": [
          {
            "OnlyUnassigned": true,
            "From": "2024-07-14 04:38:13",
            "To": "2024-07-14 04:38:13"
          },
          {
            "OnlyUnassigned": true,
            "From": "2024-07-14 04:38:13",
            "To": "2024-07-14 04:38:13"
          }
        ]
      }
    ],
    "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
  }
}

application/xml, text/xml

Sample:
<TaskList2Binder 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>2024-07-14T09:38:13.5418883-07:00</d2p1:From>
        <d2p1:Ranges>
          <d2p1:ValueRangeOfdateTime>
            <d2p1:From>2024-07-14T09:38:13.5418883-07:00</d2p1:From>
            <d2p1:OnlyUnassigned>true</d2p1:OnlyUnassigned>
            <d2p1:To>2024-07-14T09:38:13.5418883-07:00</d2p1:To>
          </d2p1:ValueRangeOfdateTime>
          <d2p1:ValueRangeOfdateTime>
            <d2p1:From>2024-07-14T09:38:13.5418883-07:00</d2p1:From>
            <d2p1:OnlyUnassigned>true</d2p1:OnlyUnassigned>
            <d2p1:To>2024-07-14T09:38:13.5418883-07:00</d2p1:To>
          </d2p1:ValueRangeOfdateTime>
        </d2p1:Ranges>
        <d2p1:To>2024-07-14T09:38:13.5418883-07:00</d2p1:To>
      </d2p1:DateTimeFieldQueryObject>
      <d2p1:DateTimeFieldQueryObject>
        <d2p1:FieldId>1</d2p1:FieldId>
        <d2p1:From>2024-07-14T09:38:13.5418883-07:00</d2p1:From>
        <d2p1:Ranges>
          <d2p1:ValueRangeOfdateTime>
            <d2p1:From>2024-07-14T09:38:13.5418883-07:00</d2p1:From>
            <d2p1:OnlyUnassigned>true</d2p1:OnlyUnassigned>
            <d2p1:To>2024-07-14T09:38:13.5418883-07:00</d2p1:To>
          </d2p1:ValueRangeOfdateTime>
          <d2p1:ValueRangeOfdateTime>
            <d2p1:From>2024-07-14T09:38:13.5418883-07:00</d2p1:From>
            <d2p1:OnlyUnassigned>true</d2p1:OnlyUnassigned>
            <d2p1:To>2024-07-14T09:38:13.5418883-07:00</d2p1:To>
          </d2p1:ValueRangeOfdateTime>
        </d2p1:Ranges>
        <d2p1:To>2024-07-14T09:38:13.5418883-07: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>
  <FieldIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </FieldIds>
  <ProjectId>1</ProjectId>
  <Setting>
    <FolderSearchOption>11</FolderSearchOption>
    <IncludeBacklogSub>true</IncludeBacklogSub>
    <IncludeChildSub>true</IncludeChildSub>
    <IncludeClosedSub>true</IncludeClosedSub>
    <GetCount>true</GetCount>
    <PageIndex>3</PageIndex>
    <PageSize>2</PageSize>
    <ShowStoryOption>5</ShowStoryOption>
    <ShowTasks2DTT>true</ShowTasks2DTT>
    <SortByFieldId>1</SortByFieldId>
  </Setting>
  <SubProjectId>1</SubProjectId>
</TaskList2Binder>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Get Tasks base on query condition.

API_Data_TaskListModel
NameDescriptionTypeAdditional information
Success

boolean

None.

Error

ErrorInfo

None.

Data

TaskListModel

None.

Response Formats

application/json, text/json

Sample:
{
  "Success": true,
  "Error": {
    "ErrorCode": 1,
    "ErrorMessage": "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.