/{version}/processes

The following operations are supported on this resource:

• POST
• GET

POST

Creates (runs) a process.

When posting processes, the following rules apply:

• Before you can post a process, a process type with the provided name must exist in the system and be enabled.
• You must supply a reference to a Technician that corresponds with a user in the system. The user must have login credentials.
• The parameter is a child element of process execution that integrates the Process with the External Program Integration plug-in (EPP). When a user runs the Process, the system automatically issues a command configured in the process parameter this element represents.
  
  When working with input/output maps (the inputs and outputs of a process), the following rules apply:
• The inputs you specify must match what the process type is configured to accept as an input.
• The input artifacts you specify must exist in the system.
• The outputs you specify must match what the process type is configured to produce as an output.
• The output containers you specify must exist in the system. The specified well location must exist in the container and be available (empty and not unavailable).
• You cannot place more than one output into the same well of a container.
• You cannot associate two inputs with the same output, unless it is a shared output.
• A process always creates a variable number of outputs, which can equal zero.
• If a process has per-reagent-label outputs, it will create an output for each reagent label applied to an input. Outputs do not need to be provided in this case.

When working with process-level User-Defined Fields and User-Defined Types, the following rules apply:
• The UDFs and UDTs that you refer to must be configured for the type of process you are working with.
• You must provide any UDFs or UDTs that are configured in the system as a required item.

When working with QC options, the following rules apply:
• You can apply QC values to the inputs or outputs of any type of process.
• If an input has QC information specified multiple times (i.e. multiple outputs per input case), only the first setting is considered.
  
  Example XML to transfer a single sample to a new container where the server is localhost. The container, input and researcher uri's will need to match your system. <?xml version="1.0" encoding="UTF-8"?> <prx:process xmlns:prx="http://genologics.com/ri/processexecution"> <type>Transfer</type>
<technician uri="http://localhost:8080/api/v2/researchers/1"></technician> <input-output-map shared="false"> <input uri="http://localhost:8080/api/v2/artifacts/ADM1A1PA1"></input> <output type="Analyte"> <location> <container uri="http://localhost:8080/api/v2/containers/27-9"></container> <value>1:1</value> </location> </output> </input-output-map> </prx:process>

Input Payload

Output Payload

GET

Displays a list of processes that have been run in the system. If the number of processes returned exceeds the display maximum, the results are paged.

When submitting a GET request, you can use the following query parameters to filter the results. For more information about using query parameters, please refer to the Filtering list resources section under REST General Concepts.

Parameters

Output Payload