Synapcus Developers (EN)

Workflow (wkf)

Workflow entity represents a defined, orchestrated and repeatable pattern of activities transitions.

Database level

The entity's attributes are shown below. Mandatory fields are marked with a red star:

Name

Type

Label

Description

form *

String

Form

Represents the entity form. Will always be "wkf".

wkf_name *

String

Name

The object name

wkf_created_from *

String


Represents the parent entity type "under which the template has been created and referenced.

wkf_date *

Date/Time


Represent the creation date and time of the object.

wkf_end *

Date/Time


Represent the end date and time of the object.

wkf_start *

Date/Time


Represent the start date and time of the object.

wkf_json *

JSON


Represents the workflow JSON

wkf_nr *

Number


Represents the workflow number. Will always be "WKF-YYxxxx" as serial number, that automatically increments by 1 as each new record is added. (e.g. "WKF-200045")

wkf_per_name *

String


Represents the full name of the person which creates the workflow, as first name and last name.

wkf_per_unid *

String


The unique ID of the person document

wkf_prj_name

String


The name of the project document  under which the workflow has been created and referenced.

wkf_prj_unid

String


The unique ID of the project document under which the workflow has been created and referenced.

wkf_proc_unid *

String


The unique ID of the process under which the workflow has been created and referenced.

wkf_state *

Number


Represents the state of the activity as number.

wkf_state_text

String


Represents the state of the activity as label.

wkf_type *

String


Represents the state of the activity as code.

wkf_type_text

String


Represents the state of the activity as label.

QEE classes level

The class representing the Workflow is QEEWkf

Inherits from: QEEObject

REST level

The endpoints dealing with Workflow are:

xrWkf (GET, POST, PUT, DELETE)

xrWkfs (GET, PUT, DELETE)