POST api/Task/Get

Get a task info based on task id

Request Information

URI Parameters

None.

Body Parameters

TaskDataBinder
NameDescriptionTypeAdditional information
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.
ProjectId

integer

None.
TaskId

integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "FieldIds": [
    1,
    2
  ],
  "ProjectId": 1,
  "TaskId": 2
}

application/xml, text/xml

Sample: 
<TaskDataBinder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Binding">
  <ProjectId>1</ProjectId>
  <TaskId>2</TaskId>
  <FieldIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </FieldIds>
</TaskDataBinder>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Get a task info based on task id

API_Data_TaskModel
NameDescriptionTypeAdditional information
Success

boolean

None.
Error

ErrorInfo

None.
Data

TaskModel

None.

Response Formats

application/json, text/json

Sample: 
{
  "Success": true,
  "Error": {
    "ErrorCode": 1,
    "ErrorMessage": "sample string 1"
  },
  "Data": {
    "TaskId": 1,
    "IfClosed": 1,
    "StoryItemId": 1,
    "StoryDisplayId": "sample string 2",
    "LinkedRequirementItemId": 1,
    "LinkedRequirementProjectId": 1,
    "Values": [
      {
        "Id": 1,
        "Name": "sample string 2",
        "Value": "sample string 3",
        "ChoiceId": {}
      },
      {
        "Id": 1,
        "Name": "sample string 2",
        "Value": "sample string 3",
        "ChoiceId": {}
      }
    ],
    "IssueTypeValue": {
      "TypeId": 1,
      "TypeName": "sample string 2",
      "IconIndex": 1,
      "SystemTypeId": 3,
      "LinkedFieldId": 4
    },
    "Comments": [
      {
        "ProjectID": 1,
        "BugID": 2,
        "NoteID": 3,
        "ProblemID": "sample string 4",
        "NoteType": "sample string 5",
        "DateCreated": "2024-12-21 15:28:07",
        "CreatedByPersonID": 1,
        "AttachedFileName": "sample string 6",
        "EMailStatusID": 1,
        "IsPublished": true,
        "NoteTitle": "sample string 8",
        "AttachType": 1,
        "CategoryID": 1,
        "AttachFileID": 1,
        "AttachedProjectID": 1,
        "AvailableToWeb": 1,
        "NoteTypeID": 1,
        "AttachedVersionNo": 1,
        "IfClosed": 1,
        "DateModified": "2024-12-21 15:28:07",
        "ModifiedByPersonID": 1,
        "BugNotesUcd": "sample string 9",
        "BugNotes": "sample string 10",
        "ParentID": 1,
        "ReplyUserID": 1,
        "ReferredByKWLink": 1,
        "CreatedByPersonName": "sample string 11",
        "ModifiedByPersonName": "sample string 12",
        "ReplyUserName": "sample string 13",
        "BugNoteHtml": "sample string 14"
      },
      {
        "ProjectID": 1,
        "BugID": 2,
        "NoteID": 3,
        "ProblemID": "sample string 4",
        "NoteType": "sample string 5",
        "DateCreated": "2024-12-21 15:28:07",
        "CreatedByPersonID": 1,
        "AttachedFileName": "sample string 6",
        "EMailStatusID": 1,
        "IsPublished": true,
        "NoteTitle": "sample string 8",
        "AttachType": 1,
        "CategoryID": 1,
        "AttachFileID": 1,
        "AttachedProjectID": 1,
        "AvailableToWeb": 1,
        "NoteTypeID": 1,
        "AttachedVersionNo": 1,
        "IfClosed": 1,
        "DateModified": "2024-12-21 15:28:07",
        "ModifiedByPersonID": 1,
        "BugNotesUcd": "sample string 9",
        "BugNotes": "sample string 10",
        "ParentID": 1,
        "ReplyUserID": 1,
        "ReferredByKWLink": 1,
        "CreatedByPersonName": "sample string 11",
        "ModifiedByPersonName": "sample string 12",
        "ReplyUserName": "sample string 13",
        "BugNoteHtml": "sample string 14"
      }
    ],
    "TimeTracking": {
      "TimeTrackingOption": 1,
      "TimeDisplayFormat": 2,
      "TimeSpent": {
        "Value": 1,
        "DisplayValue": "sample string 2"
      },
      "TimeRemain": {
        "Value": 1,
        "DisplayValue": "sample string 2"
      },
      "TimeTotal": {
        "Value": 1,
        "DisplayValue": "sample string 2"
      }
    }
  }
}

application/xml, text/xml

Sample: 
<API_Data_TaskModel 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:Comments>
      <d2p1:NoteModel>
        <d2p1:AttachFileID>1</d2p1:AttachFileID>
        <d2p1:AttachType>1</d2p1:AttachType>
        <d2p1:AttachedFileName>sample string 6</d2p1:AttachedFileName>
        <d2p1:AttachedProjectID>1</d2p1:AttachedProjectID>
        <d2p1:AttachedVersionNo>1</d2p1:AttachedVersionNo>
        <d2p1:AvailableToWeb>1</d2p1:AvailableToWeb>
        <d2p1:BugID>2</d2p1:BugID>
        <d2p1:BugNoteHtml>sample string 14</d2p1:BugNoteHtml>
        <d2p1:BugNotes>sample string 10</d2p1:BugNotes>
        <d2p1:BugNotesUcd>sample string 9</d2p1:BugNotesUcd>
        <d2p1:CategoryID>1</d2p1:CategoryID>
        <d2p1:CreatedByPersonID>1</d2p1:CreatedByPersonID>
        <d2p1:CreatedByPersonName>sample string 11</d2p1:CreatedByPersonName>
        <d2p1:DateCreated>2024-12-21T19:28:07.8962171-08:00</d2p1:DateCreated>
        <d2p1:DateModified>2024-12-21T19:28:07.8962171-08:00</d2p1:DateModified>
        <d2p1:EMailStatusID>1</d2p1:EMailStatusID>
        <d2p1:IfClosed>1</d2p1:IfClosed>
        <d2p1:IsPublished>true</d2p1:IsPublished>
        <d2p1:ModifiedByPersonID>1</d2p1:ModifiedByPersonID>
        <d2p1:ModifiedByPersonName>sample string 12</d2p1:ModifiedByPersonName>
        <d2p1:NoteID>3</d2p1:NoteID>
        <d2p1:NoteTitle>sample string 8</d2p1:NoteTitle>
        <d2p1:NoteType>sample string 5</d2p1:NoteType>
        <d2p1:NoteTypeID>1</d2p1:NoteTypeID>
        <d2p1:ParentID>1</d2p1:ParentID>
        <d2p1:ProblemID>sample string 4</d2p1:ProblemID>
        <d2p1:ProjectID>1</d2p1:ProjectID>
        <d2p1:ReferredByKWLink>1</d2p1:ReferredByKWLink>
        <d2p1:ReplyUserID>1</d2p1:ReplyUserID>
        <d2p1:ReplyUserName>sample string 13</d2p1:ReplyUserName>
      </d2p1:NoteModel>
      <d2p1:NoteModel>
        <d2p1:AttachFileID>1</d2p1:AttachFileID>
        <d2p1:AttachType>1</d2p1:AttachType>
        <d2p1:AttachedFileName>sample string 6</d2p1:AttachedFileName>
        <d2p1:AttachedProjectID>1</d2p1:AttachedProjectID>
        <d2p1:AttachedVersionNo>1</d2p1:AttachedVersionNo>
        <d2p1:AvailableToWeb>1</d2p1:AvailableToWeb>
        <d2p1:BugID>2</d2p1:BugID>
        <d2p1:BugNoteHtml>sample string 14</d2p1:BugNoteHtml>
        <d2p1:BugNotes>sample string 10</d2p1:BugNotes>
        <d2p1:BugNotesUcd>sample string 9</d2p1:BugNotesUcd>
        <d2p1:CategoryID>1</d2p1:CategoryID>
        <d2p1:CreatedByPersonID>1</d2p1:CreatedByPersonID>
        <d2p1:CreatedByPersonName>sample string 11</d2p1:CreatedByPersonName>
        <d2p1:DateCreated>2024-12-21T19:28:07.8962171-08:00</d2p1:DateCreated>
        <d2p1:DateModified>2024-12-21T19:28:07.8962171-08:00</d2p1:DateModified>
        <d2p1:EMailStatusID>1</d2p1:EMailStatusID>
        <d2p1:IfClosed>1</d2p1:IfClosed>
        <d2p1:IsPublished>true</d2p1:IsPublished>
        <d2p1:ModifiedByPersonID>1</d2p1:ModifiedByPersonID>
        <d2p1:ModifiedByPersonName>sample string 12</d2p1:ModifiedByPersonName>
        <d2p1:NoteID>3</d2p1:NoteID>
        <d2p1:NoteTitle>sample string 8</d2p1:NoteTitle>
        <d2p1:NoteType>sample string 5</d2p1:NoteType>
        <d2p1:NoteTypeID>1</d2p1:NoteTypeID>
        <d2p1:ParentID>1</d2p1:ParentID>
        <d2p1:ProblemID>sample string 4</d2p1:ProblemID>
        <d2p1:ProjectID>1</d2p1:ProjectID>
        <d2p1:ReferredByKWLink>1</d2p1:ReferredByKWLink>
        <d2p1:ReplyUserID>1</d2p1:ReplyUserID>
        <d2p1:ReplyUserName>sample string 13</d2p1:ReplyUserName>
      </d2p1:NoteModel>
    </d2p1:Comments>
    <d2p1:IfClosed>1</d2p1:IfClosed>
    <d2p1:IssueTypeValue>
      <d2p1:IconIndex>1</d2p1:IconIndex>
      <d2p1:LinkedFieldId>4</d2p1:LinkedFieldId>
      <d2p1:SystemTypeId>3</d2p1:SystemTypeId>
      <d2p1:TypeId>1</d2p1:TypeId>
      <d2p1:TypeName>sample string 2</d2p1:TypeName>
    </d2p1:IssueTypeValue>
    <d2p1:LinkedRequirementItemId>1</d2p1:LinkedRequirementItemId>
    <d2p1:LinkedRequirementProjectId>1</d2p1:LinkedRequirementProjectId>
    <d2p1:StoryDisplayId>sample string 2</d2p1:StoryDisplayId>
    <d2p1:StoryItemId>1</d2p1:StoryItemId>
    <d2p1:TaskId>1</d2p1:TaskId>
    <d2p1:TimeTracking>
      <d2p1:TimeDisplayFormat>2</d2p1:TimeDisplayFormat>
      <d2p1:TimeRemain>
        <DisplayValue>sample string 2</DisplayValue>
        <Value>1</Value>
      </d2p1:TimeRemain>
      <d2p1:TimeSpent>
        <DisplayValue>sample string 2</DisplayValue>
        <Value>1</Value>
      </d2p1:TimeSpent>
      <d2p1:TimeTotal>
        <DisplayValue>sample string 2</DisplayValue>
        <Value>1</Value>
      </d2p1:TimeTotal>
      <d2p1:TimeTrackingOption>1</d2p1:TimeTrackingOption>
    </d2p1:TimeTracking>
    <d2p1:Values xmlns:d3p1="http://schemas.datacontract.org/2004/07/TechExcel.DTKService.Model.Task">
      <d3p1:TFieldValue>
        <d3p1:ChoiceId />
        <d3p1:Id>1</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
        <d3p1:Value>sample string 3</d3p1:Value>
      </d3p1:TFieldValue>
      <d3p1:TFieldValue>
        <d3p1:ChoiceId />
        <d3p1:Id>1</d3p1:Id>
        <d3p1:Name>sample string 2</d3p1:Name>
        <d3p1:Value>sample string 3</d3p1:Value>
      </d3p1:TFieldValue>
    </d2p1:Values>
  </Data>
  <Error>
    <ErrorCode>1</ErrorCode>
    <ErrorMessage>sample string 1</ErrorMessage>
  </Error>
  <Success>true</Success>
</API_Data_TaskModel>