Workflow API – LabCollector

Knowledge Base

Search Knowledge Base by Keyword

Workflow API

You are here:
← All Topics
SUMMARY:

The WF API works on the same logic as the LC API. Please see our manual on LabCollector and our manual on Workflow API.

Required headers:

• X-LC-APP-Auth (authentication)
• Accept (return type)

PUT Actions:

execute_job

Used to start an job in the WF addon. This start has all the same functionalities as a normal job start from the WF addon (like automatic start).

Required Parameters:

1. name (name of new job)
2. template (template of new job) -> can be the template name or the template ID

Example:

http://[my_labcollector_url]/extra_modules/workflow/webservice/?action=execute_job&na me=XXXX&template=XXXX

—————————————————————————————————————

complete_node

Used to trigger the completion of node API Execution type.

Required Parameters:

1. job (name of job where the node is) -> can be the job name or the job ID
2. node_id (node indentifier) -> always a negative number (can be seen in the API Execution node in the template side)

Example:

http://[my_labcollector_url]/extra_modules/workflow/webservice/?action=complete_node&j ob=XXXX&node_id=-XX

 

Error Status:

Required Parameters:

  1. job (name of job where the node is) -> can be the job name or the job ID
  2. node_id (node indentifier) -> always a negative number (can be seen in the API Execution node in the template side)
  3. obs (when setting a error status observations related to that error are mandatory)

Example:

http://[my_labcollector_url]/extra_modules/workflow/webservice/?action=complete_node&job=XXXX&node_id=-XX&status=E&obs=XXX

Related topics: