GET v2/tasks/{id}

Gets task detail by id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Task Id

integer

Required

Body Parameters

None.

Response Information

Resource Description

Task Details for given Task Id

TaskDetail
NameDescriptionTypeAdditional information
Id

Task unique Id - auto generated by the system

integer

None.

Title

string

None.

Type

IdNamePair

None.

Status

IdNamePair

None.

Priority

IdNamePair

None.

Customer

Customer associated with the task

CustomerRef

None.

Location

Customer location associated with the task

IdNamePair

None.

Description

string

None.

Budget

decimal number

None.

TaskPercentageComplete

decimal number

None.

StartDateTime

Start date and time in ISO 8601 format.

date

None.

DueDateTime

Due date and time in ISO 8601 format.

date

None.

SalesOrder

Sales Order associated to the task

SalesOrderRef

None.

Project

Project associated to the task

IdNamePair

None.

Milestone

Milestone associated to the task

IdNamePair

None.

RequestedBy

TaskRequestedBy

None.

InfoCustomFields

List of task information custom fields related to task type

Collection of CustomFieldValue

None.

MarkDoneCustomFields

List of custom fields for marking task done

Collection of CustomFieldValue

None.

Assignments

List of task assignments

Collection of TaskAssignment

None.

Candidates

List of associated candidates

Collection of IdNamePair

None.

Assets

List of customer assets

Collection of IdNamePair

None.

UseSubContractor

boolean

None.

PurchaseOrder

Purchase order associated to a subcontracted task

PurchaseOrderRef

None.

SubcontractedWorkStatus

IdNamePair

None.

Labels

All the labels applied to the task

Collection of IdNamePair

None.

AttachmentCount

# of attachments task has

integer

None.

DateCreated

Created date and time will be in ISO 8601 format.

date

None.

CreatedBy

StrivenUser

None.

DateModified

Modified date and time will be in ISO 8601 format.

date

None.

ModifiedBy

StrivenUser

None.

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "title": "sample string 2",
  "type": {
    "id": 1,
    "name": "sample string 2"
  },
  "status": {
    "id": 1,
    "name": "sample string 2"
  },
  "priority": {
    "id": 1,
    "name": "sample string 2"
  },
  "customer": {
    "id": 1,
    "number": "sample string 2",
    "name": "sample string 3"
  },
  "location": {
    "id": 1,
    "name": "sample string 2"
  },
  "description": "sample string 3",
  "budget": 4.0,
  "taskPercentageComplete": 5.0,
  "startDateTime": "2022-07-01T04:45:06-04:00",
  "dueDateTime": "2022-07-01T04:45:06-04:00",
  "salesOrder": {
    "id": 1,
    "number": "sample string 2",
    "name": "sample string 3"
  },
  "project": {
    "id": 1,
    "name": "sample string 2"
  },
  "milestone": {
    "id": 1,
    "name": "sample string 2"
  },
  "requestedBy": {
    "id": 1,
    "name": "sample string 2",
    "type": "sample string 3"
  },
  "infoCustomFields": [
    {
      "id": 1,
      "name": "sample string 2",
      "value": "sample string 3",
      "valueText": "sample string 4"
    },
    {
      "id": 1,
      "name": "sample string 2",
      "value": "sample string 3",
      "valueText": "sample string 4"
    }
  ],
  "markDoneCustomFields": [
    {
      "id": 1,
      "name": "sample string 2",
      "value": "sample string 3",
      "valueText": "sample string 4"
    },
    {
      "id": 1,
      "name": "sample string 2",
      "value": "sample string 3",
      "valueText": "sample string 4"
    }
  ],
  "assignments": [
    {
      "id": 1,
      "name": "sample string 2",
      "type": "sample string 3"
    },
    {
      "id": 1,
      "name": "sample string 2",
      "type": "sample string 3"
    }
  ],
  "candidates": [
    {
      "id": 1,
      "name": "sample string 2"
    },
    {
      "id": 1,
      "name": "sample string 2"
    }
  ],
  "assets": [
    {
      "id": 1,
      "name": "sample string 2"
    },
    {
      "id": 1,
      "name": "sample string 2"
    }
  ],
  "useSubContractor": true,
  "purchaseOrder": {
    "id": 1,
    "number": "sample string 2",
    "name": "sample string 3"
  },
  "subcontractedWorkStatus": {
    "id": 1,
    "name": "sample string 2"
  },
  "labels": [
    {
      "id": 1,
      "name": "sample string 2"
    },
    {
      "id": 1,
      "name": "sample string 2"
    }
  ],
  "attachmentCount": 7,
  "dateCreated": "2022-07-01T04:45:06-04:00",
  "createdBy": {
    "id": 1,
    "name": "sample string 2",
    "type": "sample string 3"
  },
  "dateModified": "2022-07-01T04:45:06-04:00",
  "modifiedBy": {
    "id": 1,
    "name": "sample string 2",
    "type": "sample string 3"
  }
}

application/xml, text/xml

Sample:
<TaskDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BAPI.Models.V2.Tasks">
  <Assets xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:IdNamePair>
      <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
      <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
    </d2p1:IdNamePair>
    <d2p1:IdNamePair>
      <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
      <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
    </d2p1:IdNamePair>
  </Assets>
  <Assignments>
    <TaskAssignment>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Type>sample string 3</Type>
    </TaskAssignment>
    <TaskAssignment>
      <Id>1</Id>
      <Name>sample string 2</Name>
      <Type>sample string 3</Type>
    </TaskAssignment>
  </Assignments>
  <AttachmentCount>7</AttachmentCount>
  <Budget>4</Budget>
  <Candidates xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:IdNamePair>
      <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
      <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
    </d2p1:IdNamePair>
    <d2p1:IdNamePair>
      <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
      <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
    </d2p1:IdNamePair>
  </Candidates>
  <CreatedBy xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models.V2.Core">
    <d2p1:Id>1</d2p1:Id>
    <d2p1:Name>sample string 2</d2p1:Name>
    <d2p1:Type>sample string 3</d2p1:Type>
  </CreatedBy>
  <Customer xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:Id>1</d2p1:Id>
    <d2p1:Name>sample string 3</d2p1:Name>
    <d2p1:Number>sample string 2</d2p1:Number>
  </Customer>
  <DateCreated xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2022-07-01T20:45:06.2493549Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-240</d2p1:OffsetMinutes>
  </DateCreated>
  <DateModified xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2022-07-01T20:45:06.2493549Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-240</d2p1:OffsetMinutes>
  </DateModified>
  <Description>sample string 3</Description>
  <DueDateTime xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2022-07-01T20:45:06.2493549Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-240</d2p1:OffsetMinutes>
  </DueDateTime>
  <Id>1</Id>
  <InfoCustomFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models.V2.Core">
    <d2p1:CustomFieldValue>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Value>sample string 3</d2p1:Value>
      <d2p1:ValueText>sample string 4</d2p1:ValueText>
    </d2p1:CustomFieldValue>
    <d2p1:CustomFieldValue>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Value>sample string 3</d2p1:Value>
      <d2p1:ValueText>sample string 4</d2p1:ValueText>
    </d2p1:CustomFieldValue>
  </InfoCustomFields>
  <Labels xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:IdNamePair>
      <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
      <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
    </d2p1:IdNamePair>
    <d2p1:IdNamePair>
      <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
      <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
    </d2p1:IdNamePair>
  </Labels>
  <Location xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </Location>
  <MarkDoneCustomFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models.V2.Core">
    <d2p1:CustomFieldValue>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Value>sample string 3</d2p1:Value>
      <d2p1:ValueText>sample string 4</d2p1:ValueText>
    </d2p1:CustomFieldValue>
    <d2p1:CustomFieldValue>
      <d2p1:Id>1</d2p1:Id>
      <d2p1:Name>sample string 2</d2p1:Name>
      <d2p1:Value>sample string 3</d2p1:Value>
      <d2p1:ValueText>sample string 4</d2p1:ValueText>
    </d2p1:CustomFieldValue>
  </MarkDoneCustomFields>
  <Milestone xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </Milestone>
  <ModifiedBy xmlns:d2p1="http://schemas.datacontract.org/2004/07/BAPI.Models.V2.Core">
    <d2p1:Id>1</d2p1:Id>
    <d2p1:Name>sample string 2</d2p1:Name>
    <d2p1:Type>sample string 3</d2p1:Type>
  </ModifiedBy>
  <Priority xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </Priority>
  <Project xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </Project>
  <PurchaseOrder xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:Id>1</d2p1:Id>
    <d2p1:Name>sample string 3</d2p1:Name>
    <d2p1:Number>sample string 2</d2p1:Number>
  </PurchaseOrder>
  <RequestedBy>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <Type>sample string 3</Type>
  </RequestedBy>
  <SalesOrder xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:Id>1</d2p1:Id>
    <d2p1:Name>sample string 3</d2p1:Name>
    <d2p1:Number>sample string 2</d2p1:Number>
  </SalesOrder>
  <StartDateTime xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2022-07-01T20:45:06.2493549Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>-240</d2p1:OffsetMinutes>
  </StartDateTime>
  <Status xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </Status>
  <SubcontractedWorkStatus xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </SubcontractedWorkStatus>
  <TaskPercentageComplete>5</TaskPercentageComplete>
  <Title>sample string 2</Title>
  <Type xmlns:d2p1="http://schemas.datacontract.org/2004/07/BBM.BLL.Core">
    <d2p1:_x003C_Id_x003E_k__BackingField>1</d2p1:_x003C_Id_x003E_k__BackingField>
    <d2p1:_x003C_Name_x003E_k__BackingField>sample string 2</d2p1:_x003C_Name_x003E_k__BackingField>
  </Type>
  <UseSubContractor>true</UseSubContractor>
</TaskDetail>