GET v1/Tasks/{TaskID}

Gets Task detail by TaskID.

Request Information

URI Parameters

Name	Description	Type	Additional information
TaskID	Provide TaskID to get details for	integer	Required

Body Parameters

None.

Response Information

Resource Description

Task

Name	Description	Type	Additional information
Id		integer	None.
TaskName		string	None.
TaskTypeId		integer	None.
TaskTypeName		string	None.
AccountId		integer	None.
AccountName		string	None.
LocationId		integer	None.
LocationName		string	None.
TaskDescription		string	None.
BudgetHours		decimal number	None.
TaskPercentComplete		decimal number	None.
DateRequested		date	None.
DesiredEndDate	The date and time (in company time zone)	date	None.
DesiredStartDate	The date and time (in company time zone)	date	None.
StatusId		integer	None.
Status		string	None.
PriorityId		integer	None.
PriorityName		string	None.
DivisionId		integer	None.
AssignedTo		string	None.
IsRecurring		boolean	None.
IsSticky		boolean	None.
RequestedBy		integer	None.
RequestedByName		string	None.
OrderId		integer	None.
OrderName		string	None.
ProjectId		integer	None.
ProjectName		string	None.
MilestoneId		integer	None.
MilestoneName		string	None.
UseSubcontractor		boolean	None.
AssignedVendorId		integer	None.
AssignedVendorName		string	None.
POId		integer	None.
POName		string	None.
POStatus		string	None.
SubContractedWorkStatusId		integer	None.
SubContractedWorkStatus		string	None.
CreatedBy		integer	None.
DateCreated	The date and time (in company time zone)	date	None.
ModifiedBy		integer	None.
DateModified	The date and time (in company time zone)	date	None.
AttachmentCount		integer	None.
NotesLogCount		integer	None.
CustomFields		Collection of CustomField	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "taskName": "sample string 2",
  "taskTypeId": 3,
  "taskTypeName": "sample string 4",
  "accountId": 5,
  "accountName": "sample string 6",
  "locationId": 7,
  "locationName": "sample string 8",
  "taskDescription": "sample string 9",
  "budgetHours": 10.0,
  "taskPercentComplete": 11.0,
  "dateRequested": "2024-04-26T20:06:18.0640575-04:00",
  "desiredEndDate": "2024-04-26T20:06:18.0640575-04:00",
  "desiredStartDate": "2024-04-26T20:06:18.0640575-04:00",
  "statusId": 15,
  "status": "sample string 16",
  "priorityId": 17,
  "priorityName": "sample string 18",
  "divisionId": 19,
  "assignedTo": "sample string 20",
  "isRecurring": true,
  "isSticky": true,
  "requestedBy": 23,
  "requestedByName": "sample string 24",
  "orderId": 25,
  "orderName": "sample string 26",
  "projectId": 27,
  "projectName": "sample string 28",
  "milestoneId": 29,
  "milestoneName": "sample string 30",
  "useSubcontractor": true,
  "assignedVendorId": 32,
  "assignedVendorName": "sample string 33",
  "poId": 34,
  "poName": "sample string 35",
  "poStatus": "sample string 36",
  "subContractedWorkStatus": "",
  "createdBy": 38,
  "dateCreated": "2024-04-26T20:06:18.0640575-04:00",
  "modifiedBy": 40,
  "dateModified": "2024-04-26T20:06:18.0640575-04:00",
  "attachmentCount": 42,
  "notesLogCount": 43,
  "customFields": [
    {
      "id": 1,
      "name": "sample string 2",
      "fieldType": {
        "id": 1,
        "name": "sample string 2"
      },
      "sourceId": 3,
      "value": "sample string 4",
      "valueText": "sample string 5",
      "isRequired": true
    },
    {
      "id": 1,
      "name": "sample string 2",
      "fieldType": {
        "id": 1,
        "name": "sample string 2"
      },
      "sourceId": 3,
      "value": "sample string 4",
      "valueText": "sample string 5",
      "isRequired": true
    }
  ]
}

application/xml, text/xml

Sample:

<Task xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models.Tasks">
  <AccountId>5</AccountId>
  <AccountName>sample string 6</AccountName>
  <AssignedTo>sample string 20</AssignedTo>
  <AssignedVendorId>32</AssignedVendorId>
  <AssignedVendorName>sample string 33</AssignedVendorName>
  <AttachmentCount>42</AttachmentCount>
  <BudgetHours>10</BudgetHours>
  <CreatedBy>38</CreatedBy>
  <CustomFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models.Core">
    <d2p1:CustomField>
      <d2p1:FieldType xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:FieldType>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsRequired>true</d2p1:IsRequired>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:SourceId>3</d2p1:SourceId>
      <d2p1:Value>sample string 4</d2p1:Value>
      <d2p1:ValueText>sample string 5</d2p1:ValueText>
    </d2p1:CustomField>
    <d2p1:CustomField>
      <d2p1:FieldType xmlns:d4p1="http://schemas.datacontract.org/2004/07/Striven.Common.Models">
        <d4p1:_x003C_Id_x003E_k__BackingField>1</d4p1:_x003C_Id_x003E_k__BackingField>
        <d4p1:_x003C_Name_x003E_k__BackingField>sample string 2</d4p1:_x003C_Name_x003E_k__BackingField>
      </d2p1:FieldType>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:IsRequired>true</d2p1:IsRequired>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:SourceId>3</d2p1:SourceId>
      <d2p1:Value>sample string 4</d2p1:Value>
      <d2p1:ValueText>sample string 5</d2p1:ValueText>
    </d2p1:CustomField>
  </CustomFields>
  <DateCreated>2024-04-26T20:06:18.0640575-04:00</DateCreated>
  <DateModified>2024-04-26T20:06:18.0640575-04:00</DateModified>
  <DateRequested>2024-04-26T20:06:18.0640575-04:00</DateRequested>
  <DesiredEndDate>2024-04-26T20:06:18.0640575-04:00</DesiredEndDate>
  <DesiredStartDate>2024-04-26T20:06:18.0640575-04:00</DesiredStartDate>
  <DivisionId>19</DivisionId>
  <Id>1</Id>
  <IsRecurring>true</IsRecurring>
  <IsSticky>true</IsSticky>
  <LocationId>7</LocationId>
  <LocationName>sample string 8</LocationName>
  <MilestoneId>29</MilestoneId>
  <MilestoneName>sample string 30</MilestoneName>
  <ModifiedBy>40</ModifiedBy>
  <NotesLogCount>43</NotesLogCount>
  <OrderId>25</OrderId>
  <OrderName>sample string 26</OrderName>
  <POId>34</POId>
  <POName>sample string 35</POName>
  <POStatus>sample string 36</POStatus>
  <PriorityId>17</PriorityId>
  <PriorityName>sample string 18</PriorityName>
  <ProjectId>27</ProjectId>
  <ProjectName>sample string 28</ProjectName>
  <RequestedBy>23</RequestedBy>
  <RequestedByName>sample string 24</RequestedByName>
  <Status>sample string 16</Status>
  <StatusId>15</StatusId>
  <TaskDescription>sample string 9</TaskDescription>
  <TaskName>sample string 2</TaskName>
  <TaskPercentComplete>11</TaskPercentComplete>
  <TaskTypeId>3</TaskTypeId>
  <TaskTypeName>sample string 4</TaskTypeName>
  <UseSubcontractor>true</UseSubcontractor>
</Task>