Standard tasks

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

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 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 query to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2

Responses

200

OK

400

Bad Request

Request samples

curl
JavaScript
Node.js
PHP
C#

Response samples

200
400

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

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

key	string Item key Example: "319"
id	string Item ID Example: "Overhead"

isBillable

boolean

Default: false

Set to true if this standard task is billable.

Example: true

isMilestone

boolean

Default: false

Standard task is a milestone.

Example: false

isUtilized

boolean

Default: false

Standard task is utilized. A utilized task indicates progress on a customer project or internal project.

Example: true

priority

number

Priority

Example: "1"

object

Reference to a time type

key	string TimeType 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 Example: "1"
id	string 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 Example: "7"
id	string 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

201
400

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.

Responses

200

OK

400

Bad Request

Request samples

curl
JavaScript
Node.js
PHP
C#

Response samples

200
400

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": [{"key": "1",
"id": "EQ",
"href": "/objects/construction/standard-cost-type/1"
},
{"key": "3",
"id": "EQ-Owned",
"href": "/objects/construction/standard-cost-type/3"
}
],
"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.

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

key	string Item key Example: "319"
id	string Item ID Example: "Overhead"

isBillable

boolean

Default: false

Set to true if this standard task is billable.

Example: true

isMilestone

boolean

Default: false

Standard task is a milestone.

Example: false

isUtilized

boolean

Default: false

Standard task is utilized. A utilized task indicates progress on a customer project or internal project.

Example: true

priority

number

Priority

Example: "1"

object

Reference to a time type

key	string TimeType 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 Example: "1"
id	string 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 Example: "7"
id	string 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

200
400

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.

Responses

204

No Content

400

Bad Request

Request samples

curl
JavaScript
Node.js
PHP
C#

Response samples

400

application/json

{"ia::result": {"ia::error": {"code": "invalidRequest",
"message": "Payload contains errors",
"supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
"errorId": "REST-1064",
"additionalInfo": {"messageId": "IA.PAYLOAD_CONTAINS_ERRORS",
"placeholders": { },
"propertySet": { }
},
"details": [{"code": "invalidRequest",
"message": "/testDate is not a valid field",
"errorId": "REST-1043",
"target": "/testDate",
"additionalInfo": {"messageId": "IA.NOT_A_VALID_FIELD",
"placeholders": {"FIELD": "/testDate"
},
"propertySet": { }
}
}
]
},
"ia::meta": {"totalCount": 3,
"totalSuccess": 2,
"totalError": 1
}
},
"ia::error": {"code": "invalidRequest",
"message": "Malformed URL",
"supportId": "sQrM9%7EYdh5oDEWVb80mrn9xuHjoAAAABBQ",
"details": [{"code": "invalidRequest",
"message": "The content type is not valid",
"correction": "TODO"
}
]
}
}

Query standard 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: "construction/standard-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": "accounts-payable/vendor",
"fields": ["id",
"name",
"status",
"href"
],
"filters": [{"$eq": {"status": "active"
}
},
{"$eq": {"billingType": "openItem"
}
}
],
"filterExpression": "1 and 2",
"orderBy": [{"id": "asc"
}
]
}

Response samples

200
400

application/json

{"ia::result": [{"id": "Vend-00002",
"name": "Test vendor",
"status": "active",
"href": "/objects/accounts-payable/vendor/85"
},
{"id": "VEND-00010",
"name": "Design Works",
"status": "active",
"href": "/objects/accounts-payable/vendor/111"
}
],
"ia::meta": {"totalCount": 2,
"start": 1,
"pageSize": 100,
"next": null,
"previous": null
}
}