WorkflowProcessType Data Type

A workflow process is a workflow that was started for a particular document. Each workflow is started based on a workflow definition.

Properties
name data type description
createDate number Returns the creation date of the process.
documentReference DocumentReferenceType This getter gets the document reference.
name string Returns the process name.
owner UserListItemType Returns the owner of the process.
revisionReference DocumentRevisionReferenceType Return a reference to the document for which the workflow was started.
state WorkflowProcessStateEnum Return the workflow state.
timeInformation TimeInfoType Return the time information for the workflow.
type WorkflowProcessTypeEnum Returns the workflow process type.
workflowDefinition WorkflowDefinitionType Sets the workflow definition for the process.
Properties inherited from ResourceType
reference ReferenceType Returns the resource's object reference.

Example

{
  "createDate" : 12345,
  "documentReference" : {
    "ddcName" : "...",
    "sysRowId" : "..."
  },
  "name" : "...",
  "owner" : {
    "type" : "USER",
    "name" : "...",
    "deleted" : true,
    "reference" : {
      "id" : 12345,
      "type" : "USER"
    }
  },
  "revisionReference" : {
    "hdoc" : "..."
  },
  "state" : "UNKNOWN",
  "timeInformation" : {
    "duration" : 12345,
    "workingTime" : 12345,
    "estimatedWorkingTime" : 12345
  },
  "type" : "ADHOC",
  "workflowDefinition" : {
    "name" : "...",
    "version" : "...",
    "tenantSpecific" : true,
    "reference" : { }
  },
  "reference" : { }
}