Tasks

A unit of work to be performed for a project. Use tasks to:

  • Track project work by task and assigned resources.
  • Identify which tasks are billable to the customer.
  • Enter estimated and planned hours, track percent completed as the task progresses, and create recurring schedules.
  • Create task dependencies so one task doesn't start until another finishes.
  • Set other optional information, such as the priority or status of the task.
    Please be aware that this object is currently "Uncertified" in our open beta, signifying that it has not undergone the complete review process and the design may change during ongoing refinement. Users are advised to exercise discretion in using this object and are encouraged to provide feedback.

List tasks

get/objects/projects/task

Returns up to 100 object references from the collection with a key, ID, and link for each task. This operation is mostly for use in testing; use query to find tasks that meet certain criteria and to specify properties that are returned.

Permissions and other requirements
SubscriptionProjects
User typeBusiness, Employee, Project Manager, Warehouse
PermissionsList Tasks
SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "T-1",
      • "href": "/objects/projects/task/1"
      },
    • {
      • "key": "2",
      • "id": "T-2",
      • "href": "/objects/projects/task/2"
      },
    • {
      • "key": "3",
      • "id": "T-3",
      • "href": "/objects/projects/task/3"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 3,
    • "next": 0,
    • "previous": 0
    }
}
Create a task
post/objects/projects/task
Creates a new project task.



Permissions and other requirements



SubscriptionProjects


User typeBusiness, Project Manager


PermissionsAdd Tasks







SecurityOAuth2 
Request 
Request Body schema: application/json
New task definition


name
required
string
Task name. Must be unique within the project.


 
 Example:  "Task 1"
required
object
The project that the task is associated with.


 
key
string
System-assigned key of the project.


 
 Example:  "114"
id
string
Unique identifier of the project.


 
 Example:  "15-GAR"
id
string
Identifier for the task. Must be unique within the project. 20 characters max.


 
 Example:  "01-010"
object
The parent task if this task is the child of another, larger task.


 
key
string or null
System-assigned key of the parent task.


 
 Example:  "11"
object
Work item that this task is assigned to. A task must be assigned to an item for it to be invoiced.


 
key
string or null
System-assigned key of the item.


 
 Example:  "311"
id
string or null
Unique identifier of the item.


 
 Example:  "Project Item 1"
object
Planned start and end dates for the task.


 
startDate
string or null <date> 
Planned start date.


 
 Example:  "2023-04-01"
endDate
string or null <date> 
Planned end date.


 
 Example:  "2023-05-05"
object
Task-related durations.


 
planned
number or null
Task planned duration (hours).


 
 Example:  100
estimated
number or null
Task estimated duration (hours).


 
 Example:  100
description
string or null
Task description.


 
 Example:  "First task"
isMilestone
boolean
 Default:  false
Set to true to indicate that the task is a milestone.


 
 Example:  true
isUtilized
boolean
 Default:  false
Set to true to mark this task as utilized. A utilized task is one spent making progress on a customer project or internal project. A non-utilized task is one spent not working on a customer project or internal project, for example, time spent filling in an expense report or timesheet.


 
 Example:  true
isBillable
boolean
 Default:  false
Set to true to bill the work for the task. Set to false to mark the task as non-billable.


 
 Example:  true
wbsCode
string or null
Work breakdown structure code.


 
 Example:  "1"
priority
number or null
A numeric value indicating the task priority.


 
 Example:  2
status
string
 Default:  "inProgress"
Current status of the task. If the task status is Completed, employees can't enter time for the task on timesheets.


 Enum: "completed" "inProgress" "notStarted" "onHold" "planned"  
 Example:  "completed"
object
Time type used when posting labor costs to the general ledger or for tracking and reporting how work time is spent.


 
key
string or null
System-assigned key of the time type.


 
 Example:  "2"
id
string or null
Unique identifier of the time type. Same as name.


 
 Example:  "overtime"
object
Class dimension associated with the task.


 
key
string or null
System-assigned key of the class.


 
 Example:  "19"
id
string or null
Class ID.


 
 Example:  "DES"
object
Documents associated with the task, such as statements of work, specifications, or agreements.


 
key
string or null
System-assigned key of the attachment.


 
 Example:  "12"
id
string or null
Attachment ID.


 
 Example:  "P8-29"
object
Task that must be completed before this task can start.


 
key
string or null
System-assigned key of the task that this task is dependent on.


 
 Example:  "1330"
object
Production Units


 
estimate
number or null
Production unit estimate.


 
 Example:  1200
description
string or null
Production unit description, such as "cubic yards" or "window assembly".


 
 Example:  "linear feet siding"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "Task-1",
  • "name": "General Overhead",
  • "project": {
    • "id": "NET-XML30-1"
    },
  • "status": "planned"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "6",
    • "id": "6",
    • "href": "/objects/projects/task/6"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Get a task
get/objects/projects/task/{key}
Returns detailed information for a specified task.



Permissions and other requirements



SubscriptionProjects


User typeBusiness, Employee, Project Manager, Warehouse


PermissionsView Tasks







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the task.


 
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1",
    • "id": "T-1",
    • "parent": {
      • "key": "11",
      • "id": "T-11",
      • "name": "Cabinet design",
      • "href": "/objects/projects/task/11"
      },
    • "name": "Project Task",
    • "project": {
      • "key": "1",
      • "id": "NET-XML30-1",
      • "name": "Created by XML 3.0",
      • "startDate": "2023-02-25",
      • "endDate": "2023-04-25",
      • "href": "/objects/projects/project/56"
      },
    • "customer": {
      • "key": "1",
      • "id": "101",
      • "name": "Corley Energy",
      • "href": "/objects/accounts-receivable/customer/41"
      },
    • "productionUnits": {
      • "estimate": 1200,
      • "description": "linear feet siding"
      },
    • "item": {
      • "key": "311",
      • "id": "Project Item 1",
      • "name": "Extension pack",
      • "href": "/objects/inventory-control/item/311"
      },
    • "planned": {
      • "startDate": "2023-02-25",
      • "endDate": "2023-06-25"
      },
    • "actual": {
      • "startDate": "2023-02-25",
      • "endDate": "2023-11-25"
      },
    • "duration": {
      • "planned": 100,
      • "estimated": 100,
      • "actual": 0,
      • "remaining": 0,
      • "approved": 0,
      • "plannedBillable": 0,
      • "estimatedBillable": 0,
      • "actualBillable": 0,
      • "approvedBillable": 0
      },
    • "percentComplete": 0.25,
    • "observerPercentComplete": 0.3,
    • "description": "Task Description",
    • "isMilestone": false,
    • "isUtilized": false,
    • "isBillable": false,
    • "wbsCode": "1",
    • "priority": 1,
    • "status": "inProgress",
    • "timeType": {
      • "key": "2",
      • "id": "overtime",
      • "href": "/objects/time/time-type/2"
      },
    • "class": {
      • "key": "19",
      • "id": "DES",
      • "name": "Design",
      • "href": "/objects/company-config/class/19"
      },
    • "audit": {
      • "createdDateTime": "2021-08-12T17:25:29Z",
      • "modifiedDateTime": "2021-08-12T17:25:29Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "dependentOn": {
      • "key": "1",
      • "id": "T-1",
      • "name": "Design review",
      • "href": "/objects/projects/task/1"
      },
    • "root": {
      • "key": "1",
      • "id": "ID1",
      • "name": "Task 1",
      • "href": "/objects/projects/task/1"
      },
    • "standardTask": {
      • "key": "1",
      • "id": "1",
      • "name": "1",
      • "href": "/objects/construction/standard-task/1"
      },
    • "attachment": {
      • "id": "1"
      },
    • "href": "/objects/projects/task/1"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Update a task
patch/objects/projects/task/{key}
Updates an existing task by setting field values. Any fields not provided remain unchanged.



Permissions and other requirements



SubscriptionProjects


User typeBusiness, Project Manager


PermissionsEdit Tasks







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the task.


 
Request Body schema: application/json
name
string
Task name. Must be unique within the project.


 
 Example:  "Task 1"
object
The parent task if this task is the child of another, larger task.


 
key
string or null
System-assigned key of the parent task.


 
 Example:  "11"
object
Work item that this task is assigned to. A task must be assigned to an item for it to be invoiced.


 
key
string or null
System-assigned key of the item.


 
 Example:  "311"
id
string or null
Unique identifier of the item.


 
 Example:  "Project Item 1"
object
Planned start and end dates for the task.


 
startDate
string or null <date> 
Planned start date.


 
 Example:  "2023-04-01"
endDate
string or null <date> 
Planned end date.


 
 Example:  "2023-05-05"
object
Task-related durations.


 
planned
number or null
Task planned duration (hours).


 
 Example:  100
estimated
number or null
Task estimated duration (hours).


 
 Example:  100
description
string or null
Task description.


 
 Example:  "First task"
isMilestone
boolean
 Default:  false
Set to true to indicate that the task is a milestone.


 
 Example:  true
isUtilized
boolean
 Default:  false
Set to true to mark this task as utilized. A utilized task is one spent making progress on a customer project or internal project. A non-utilized task is one spent not working on a customer project or internal project, for example, time spent filling in an expense report or timesheet.


 
 Example:  true
isBillable
boolean
 Default:  false
Set to true to bill the work for the task. Set to false to mark the task as non-billable.


 
 Example:  true
wbsCode
string or null
Work breakdown structure code.


 
 Example:  "1"
priority
number or null
A numeric value indicating the task priority.


 
 Example:  2
status
string
 Default:  "inProgress"
Current status of the task. If the task status is Completed, employees can't enter time for the task on timesheets.


 Enum: "completed" "inProgress" "notStarted" "onHold" "planned"  
 Example:  "completed"
object
Time type used when posting labor costs to the general ledger or for tracking and reporting how work time is spent.


 
key
string or null
System-assigned key of the time type.


 
 Example:  "2"
id
string or null
Unique identifier of the time type. Same as name.


 
 Example:  "overtime"
object
Class dimension associated with the task.


 
key
string or null
System-assigned key of the class.


 
 Example:  "19"
id
string or null
Class ID.


 
 Example:  "DES"
object
Documents associated with the task, such as statements of work, specifications, or agreements.


 
key
string or null
System-assigned key of the attachment.


 
 Example:  "12"
id
string or null
Attachment ID.


 
 Example:  "P8-29"
object
Task that must be completed before this task can start.


 
key
string or null
System-assigned key of the task that this task is dependent on.


 
 Example:  "1330"
object
Production Units


 
estimate
number or null
Production unit estimate.


 
 Example:  1200
description
string or null
Production unit description, such as "cubic yards" or "window assembly".


 
 Example:  "linear feet siding"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "status": "completed",
  • "duration": {
    • "estimated": 27
    }
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "6",
    • "id": "T-6",
    • "href": "/objects/projects/task/6"
    },
  • "ia::meta": {
    • "totalCount": 1
    }
}
Delete a task
delete/objects/projects/task/{key}
Deletes a task.



Permissions and other requirements



SubscriptionProjects


User typeBusiness, Project Manager


PermissionsDelete Tasks







SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned key for the task.


 
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "Payload contains errors",
      • "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
      • "errorId": "REST-1064",
      • "additionalInfo": {
        },
      • "details": [
        ]
      },
    • "ia::meta": {
      • "totalCount": 3,
      • "totalSuccess": 2,
      • "totalError": 1
      }
    },
  • "ia::error": {
    • "code": "invalidRequest",
    • "message": "Malformed URL",
    • "supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
    • "details": [
      • {
        }
      ]
    }
}
Query tasks
post/services/core/query
Queries an object for filtered data.


SecurityOAuth2 
Request 
Request Body schema: application/json
object
string
Object type to query, in the form <application-name>/<object name>. For custom objects use platform-apps/nsp::<object-name>.


 
 Example:  "projects/task"
fields
Array of strings
List of fields to include in the response. Can be any combination of these:


    

  • The name of a field in the object that you are querying, such as id.
    

    • 

  • The name of a field in a related object, using the form relatedObjectName.fieldName, such as vendor.id.
    

    • 

  • The result of an aggregate function run against the values in the returned objects. Use the form function:fieldName, such as min:startDate to return the earliest starting date. Valid function names are:
    

      

    • count
      • 

    • avg
      • 

    • sum
      • 

    • min
      • 

    • max
      • 

    

    • 

  • The result of an aggregate function run against the values in related objects, using the form function:relatedObjectName.fieldName, such as max:vendor.creditLimit. The same functions are supported as for object fields.
    

    • 



 
 Example:  ["key","id","max:vendor.creditLimit"]
Array of equal (object) or not equal (object) or less than (object) or (less than or equal (object)) or greater than (object) or (greater than or equal (object)) or in (object) or not in (object) or between (object) or not between (object) or contains (object) or does not contain (object) or starts with (object) or does not start with (object) or ends with (object) or does not end with (object)
Filter conditions to select the objects to return based on their field values. You use operators and conditions to build your filter, such as {"$eq":{"status":"active"}} to select objects in which status is equal to "active".


 
 Example:  [{"$eq":{"status":"active"}},{"$gt":{"totalDue":"1000"}},{"$contains":{"name":"Acme"}}]
 Array 
Any of:
Field value must be equal to this specified value.


For date fields, you can use these macro values that are relative to the current date or the asOfDate in filterParameters, if set:







    

  • today

  • currentWeek

  • currentMonth

  • currentQuarter

  • currentYear





    

  • yesterday

  • lastWeek

  • priorMonth

  • priorQuarter

  • priorYear









These are most useful for queries that you want to save and use repeatedly, such as for views or reports. Just change the asOfDate each time to retrieve the same data set for different time periods.


For example, {"eq":{"postingDate":"priorYear"}}.


object
The field name and value to be compared with object values.


 
 Example:  {"status":"active"}
filterExpression
string
 Default:  "and"
Logical operators to apply when there are multiple filter conditions. The conditions in the filters array are implicitly numbered starting at 1. Supports and, or, and grouping with parentheses.


Shortcuts:


    

  • and by itself means that all conditions must be true.
    • 

  • or by itself means that at least one condition must be true.
    • 



 
 Example:  "(1 and 2) or 3"
object

Pre-defined filter options.


 
asOfDate
string <date> 
The "as of" date to use with any relative date comparisons in filters. For example, if asOfDate is set to "2022-04-01" then priorMonth will be "03".


The current date is used if asOfDate is not set.


 
 Example:  "2022-04-01"
includeHierarchyFields
boolean
 Default:  false
Set to true to include hierarchical structure information with each object in the response.


 
 Example:  false
caseSensitiveComparison
boolean
 Default:  true
Queries are case-sensitive by default. Set to false to ignore case in a query.


 
 Example:  true
includePrivate
boolean
 Default:  false
By default, in a multi-entity company, queries from the top-level entity do not access data in private entities. Set includePrivate to true if you want to query data in private entities.


 
 Example:  false
Array of objects
Set the order of the results by specifying field names to sort by and whether they should be in ascending or descending order.


 
 Example:  [{"totalDue":"asc"},{"lastPaymentMadeDate":"desc"}]
 Array 
property name*
additional property
string
 Enum: "asc" "desc"  
start
integer
First record of the result set to include in the response.


 
 Example:  1
size
integer
Number of records to include in the response.


 
 Example:  100
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "object": "projects/task",
  • "filters": [
    • {
      • "$eq": {
        }
      },
    • {
      • "$ne": {
        }
      }
    ],
  • "fields": [
    • "key",
    • "name",
    • "status",
    • "project.key",
    • "duration.planned",
    • "duration.actual",
    • "duration.remaining"
    ],
  • "orderBy": [
    • {
      • "name": "desc"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1326",
      • "name": "Selective Demolition",
      • "status": "inProgress",
      • "project.key": "132",
      • "duration.planned": null,
      • "duration.actual": null,
      • "duration.remaining": null
      },
    • {
      • "key": "1325",
      • "name": "Demolition",
      • "status": "inProgress",
      • "project.key": "132",
      • "duration.planned": null,
      • "duration.actual": null,
      • "duration.remaining": null
      },
    • {
      • "key": "1327",
      • "name": "Concrete Removal",
      • "status": "inProgress",
      • "project.key": "132",
      • "duration.planned": null,
      • "duration.actual": null,
      • "duration.remaining": null
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}