Worker data

The worker data structure describes a worker. It has a link to a primary group, and a child group (array of links) for connections. The connection_uuid, connection_name, connection_reference and connection_path refer to the connection group, not the connection node.

{
  "worker_uuid": "uuid",
  "worker_name": "Worker name",
  "worker_reference": "node.reference",
  "process_type_reference": "ref",
  "process_type_name": "name",
  "owner_id": "id",
  "owner_name": "Name",
  "process_identifier": "process-identifier",
  "worker_role": "role",
  "parent_worker_uuid": "uuid",
  "parent_worker_name": "Name",
  "worker_sequence": sequence,
  "child_workers": [
    {
      "child_worker_uuid": "uuid",
      "child_worker_name": "Name"
    }
  ],
  "group": {
    "group_uuid": "uuid",
    "group_name": "name",
    "group_reference": "node.reference",
    "group_path": "group/path"
  },
  "worker_connections": [
    {
      "connection_role": "role",
      "connection_uuid": "uuid",
      "connection_name": "name",
      "connection_reference": "node.reference",
      "connection_path": "group/path"
    }
  ]
}

In each case, the reference is the node reference, the uuid is the node uuid.

The parent_worker_name and child_workers properties are not sent with the worker data, but are derived from the database and are returned with the worker data. The child_workers is only returned when documents and events are returned.