Standard tasks

Use standard tasks to create a catalog (library) of definitions that can be used to populate new project tasks with specific values, improving consistency across an organization.

List standard tasks

get/objects/construction/standard-task

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

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "1-000",
      • "href": "/objects/construction/standard-task/1"
      },
    • {
      • "key": "2",
      • "id": "3-010",
      • "href": "/objects/construction/standard-task/2"
      },
    • {
      • "key": "3",
      • "id": "1-020",
      • "href": "/objects/construction/standard-task/3"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a standard task
post/objects/construction/standard-task
Creates a new standard task.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
Standard task to create


id
required
string
Unique identifier of the standard task.


 
 Example:  "1-010"
name
required
string
Name of the standard task.


 
 Example:  "Summary of Work"
description
string
Description of the standard task.


 
 Example:  "Summary of Work"
productionUnitDescription
string
Production unit description of the standard task.


 
 Example:  "days"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
object
Reference to an item.


 
key
string
Item key.


 
 Example:  "319"
id
string
Item ID.


 
 Example:  "Overhead"
isBillable
boolean
 Default:  false
Set to true if tasks created from this standard task are billable.


 
 Example:  true
isMilestone
boolean
 Default:  false
Set to true if tasks created from this standard task are milestones.


 
 Example:  false
isUtilized
boolean
 Default:  false
Set to `true if tasks created from this standard task are utilized. A utilized task indicates progress on a customer project or internal project.


 
 Example:  true
priority
number
Priority of tasks created from the standard task.


 
 Example:  "1"
object
Time type of the standard task.


 
key
string
Time type key.


 
 Example:  "2"
wbsCode
string
Work breakdown structure code of the standard task.


 
 Example:  "1"
object
Reference to the parent standard task of this standard task.


 
key
string
Key of parent standard task.


 
 Example:  "1"
id
string
ID of parent standard task.


 
 Example:  "1-000"
object
 
id
string
Class ID


 
 Example:  "1-Goods"
key
string
Class key


 
 Example:  "42"
Array of objects
Array of standard cost types.


 
 Array 
key
string
Standard cost type key.


 
 Example:  "7"
id
string
Standard cost type ID.


 
 Example:  "LABOR"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "1-010",
  • "name": "Summary of Work",
  • "description": "Summary of Work",
  • "status": "active",
  • "isBillable": false,
  • "isMilestone": false,
  • "isUtilized": false,
  • "parent": {
    • "id": "1-000"
    },
  • "standardCostTypes": [
    • {
      • "id": "EQ"
      },
    • {
      • "id": "EQ-Owned"
      },
    • {
      • "id": "EQ-Rental"
      },
    • {
      • "id": "LAB"
      },
    • {
      • "id": "LAB-OT"
      },
    • {
      • "id": "LAB-REG"
      },
    • {
      • "id": "LAB-SALARY"
      },
    • {
      • "id": "LAB-BURDEN"
      },
    • {
      • "id": "MAT"
      },
    • {
      • "id": "OH"
      },
    • {
      • "id": "OTH"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "2",
    • "id": "1-010",
    • "href": "/objects/construction/standard-task/2"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a standard task
get/objects/construction/standard-task/{key}
Returns detailed information for a specified standard task.


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


 
 Example:  312
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "312",
    • "id": "1-010",
    • "name": "Summary of Work",
    • "description": "General Conditions: Summary of Work",
    • "productionUnitDescription": "days",
    • "status": "active",
    • "item": {
      • "key": "318",
      • "id": "Other",
      • "name": "Other",
      • "href": "/objects/inventory-control/item/318"
      },
    • "isBillable": false,
    • "isMilestone": false,
    • "isUtilized": true,
    • "timeType": {
      • "key": "11",
      • "name": "Design"
      },
    • "wbsCode": "S",
    • "parent": {
      • "key": "1",
      • "id": "1-000",
      • "name": "GENERAL CONDITIONS",
      • "href": "/objects/construction/standard-task/1"
      },
    • "class": {
      • "key": "8",
      • "id": "CON",
      • "name": "Construction",
      • "href": "/objects/company-config/class/8"
      },
    • "audit": {
      • "createdDateTime": "2021-11-23T23:57:52Z",
      • "modifiedDateTime": "2021-11-29T23:15:38Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "standardCostTypes": [
      • {
        },
      • {
        }
      ],
    • "href": "/objects/construction/standard-task/312"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a standard task
patch/objects/construction/standard-task/{key}
Updates an existing standard task by setting field values. Any fields not provided remain unchanged.


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


 
 Example:  312
Request Body schema: application/json
name
string
Name of the standard task.


 
 Example:  "Summary of Work"
description
string
Description of the standard task.


 
 Example:  "Summary of Work"
productionUnitDescription
string
Production unit description of the standard task.


 
 Example:  "days"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
object
Reference to an item.


 
key
string
Item key.


 
 Example:  "319"
id
string
Item ID.


 
 Example:  "Overhead"
isBillable
boolean
 Default:  false
Set to true if tasks created from this standard task are billable.


 
 Example:  true
isMilestone
boolean
 Default:  false
Set to true if tasks created from this standard task are milestones.


 
 Example:  false
isUtilized
boolean
 Default:  false
Set to `true if tasks created from this standard task are utilized. A utilized task indicates progress on a customer project or internal project.


 
 Example:  true
priority
number
Priority of tasks created from the standard task.


 
 Example:  "1"
object
Time type of the standard task.


 
key
string
Time type key.


 
 Example:  "2"
wbsCode
string
Work breakdown structure code of the standard task.


 
 Example:  "1"
object
Reference to the parent standard task of this standard task.


 
key
string
Key of parent standard task.


 
 Example:  "1"
id
string
ID of parent standard task.


 
 Example:  "1-000"
object
 
id
string
Class ID


 
 Example:  "1-Goods"
key
string
Class key


 
 Example:  "42"
Array of objects
Array of standard cost types.


 
 Array 
key
string
Standard cost type key.


 
 Example:  "7"
id
string
Standard cost type ID.


 
 Example:  "LABOR"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "description": "General Conditions: Summary of Work",
  • "productionUnitDescription": "days",
  • "isUtilized": true,
  • "class": {
    • "id": "3"
    },
  • "standardCostTypes": [
    • {
      • "id": "SUB"
      }
    ]
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "2",
    • "id": "1-010",
    • "href": "/objects/construction/standard-task/2"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a standard task
delete/objects/construction/standard-task/{key}
Deletes a standard task.


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


 
 Example:  312
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}