CheckOut Process Definition

API Type

Web Services

Description

This method is used to manage process definition versioning by setting the process definition status to CheckedOut based on a given process definition ID. Only process definitions with the status of Released can transition into the CheckedOut status.

Syntax

public virtual string CheckoutProcDef(string processTemplateID)

Parameters

Name	Description
processTemplateID	Definition: The unique identifier for the process definition to be checked out for modification. Type string Allowed Values: A valid process template ID

Output

The process definition, in XML format, that has been checked out.

Example

IWFWorkflowService svc = GetWorkflowService();

try
	{
    string processTemplateID = … // process definition to be checked out
    stringprocessDefinitionXML =
    svc.CheckoutProcDef(processTemplateID);
	}

catch (Exception ex)
	{
    Console.WriteLine("Failed! " + ShUtil.GetSoapMessage( ex ) );
	}

Supported Versions

3.2.0.4 or higher