std:workunit

The std:workunit source adds information about work units associated with the object.

A top level workflows property is added to the object, containing an array of dictionaries, each representing a single WorkUnit. (The property is workflows because it is most often used with the std:workflow source.)

Work unit properties

property workType

The plugin defined work type.

property createdAt

The date and time this work unit was created, encoded as a string in ISO8601 format.

property openedAt

The date and time this work unit was opened, encoded as a string in ISO8601 format.

property deadline

The deadline for this work unit, encoded as a string in ISO8601 format.

property closed

Boolean. true if this work unit is closed.

property data

Data associated with this work unit.

property tags

Tags set on this work unit.

Example

A serialised object with a single work unit.

{
  "kind": "haplo:object:0",
  "sources": [
    "std:workunit"
  ],
  "ref": "83w92",
  // ...
  "workflows": [
    {
      "workType": "example:book-review",
      "createdAt": "2020-01-14T17:05:18.341Z",
      "openedAt": "2020-01-14T17:05:18Z",
      "deadline": null,
      "closed": true,
      "data": {},
      "tags": {}
    }
  ]
}