Operation: bpm::workflowGet


General Description

Invoke this operation to get the BPM definition.

Operation Notes

System Privileges Mail Privileges Calendar Privileges Database Privileges
-- -- -- db.[default_db].h_bpm_processes.browse

Request Message

Input Parameters

The workflowGet method takes the following input parameters. It is important to note that the parameters must be passed to the operation in the same order as they appear here in order to satisfy the requirement of the input validation checks.

Name Type Attributes Description
application appNameType optional Specify the name of the application this operation relates to. If not specified then "system" is assumed.
name xs:string required once The name of the business process definition.
version xs:unsignedInt optional If not specified this method will return the currently active version. To get the draft workflow, you should specify 0. Otherwise providing a version will return the version specified

Input Data


Response Message

Output Parameters

Name Type Attributes Description
type bpmType required once PRELIMINARY: The type of workflow.
title xs:string optional The title of the business process definition.
description xs:string optional A description to help describe the purpose of the workflow
owner xs:string optional The Co-worker ID of the business process owner
definition bpmDefinitionType required once The BPM XML document
graph anyDataType optional The Graph
version xs:unsignedInt required once The current version
active xs:boolean required once Indicates if the process is active or not
createdOn xs:datetime required once The date/time this process was created
createdBy xs:string required once The person who created this process
lastUpdatedOn xs:datetime optional The last time this process was updated
lastUpdatedBy xs:string optional The person who last updated this process
lastUsedOn xs:string optional The last time this process was used to initiate a running workflow
entity xs:string optional PRELIMINARY: The entity this process relates to.
category xs:string optional The category of the workflow
accessUpdate xs:string required once True if the current user can update this business process

Output Data


Code Generation & Samples

The links below will generate sample code in the respective languages. You can use these links as a convenient way of generating the correct code needed to invoke this method

JavaScript   PHP   C#   Java   C++   [ hide code ]  

Powered by Hornbill, for more information click here. (page served by , .)