Web service workflow actions

From KnowledgeTree Document Management Made Simple

Contents 1 starting a workflow on a document 2 stopping a workflow on a document 3 perform a workflow transition 4 getting workflow information

starting a workflow on a document

To start a workflow on a document, use:

start_document_workflow ( session : string, document_id : integer, workflow : string ) :  kt_document_detail 

The parameters:

• session
• document_id
• workflow

When a workflow is assigned to a document, the document will be assigned the workflow's default state.

stopping a workflow on a document

If a workflow must be stopped, use:

delete_document_workflow ( session : string, document_id : integer ) :  kt_document_detail 

The parameters:

• session
• document_id

All state information will be lost when this action is performed.

perform a workflow transition

perform_document_workflow_transition ( session : string, document_id : integer, transition : string, reason : string ) :  kt_document_detail 

The parameters:

• session
• document_id
• transition
• reason

getting workflow information

get_document_workflow_state ( session : string, document_id : integer ) :  kt_response 
get_document_workflow_transitions ( session : string, document_id : integer ) :  kt_workflow_transitions_response 

The parameters:

• session
• document_id