Data: ptp
- Namespace: http://genologics.com/ri/processtype
- XML Schema File: processtype.xsd
The data in this namespace is divided into elements and types. Types define the structure of the data. Elements define specific instances of the types, and are therefore more relevant to REST endpoints, which generally consume and/or produce elements.
The following elements are members of this namespace:
The following types are members of this namespace:
Element process-type
- Type: process-type
The process-type element contains the XML representation of a type of process configured in the system.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<ptp:process-type xmlns:ptp="http://genologics.com/ri/processtype" name="..." uri="...">
<field-definition name="..." uri="...">
<!--content of type 'field-link'-->
</field-definition>
<field-definition>
<!--(another 'field-link' type)-->
</field-definition>
<!--...more "field-definition" elements...-->
<parameter name="...">
<!--content of type 'parameter'-->
<file>
<!--content of type 'string'-->
...
</file>
<string>
<!--content of type 'string'-->
...
</string>
<run-program-per-event>
<!--content of type 'boolean'-->
...
</run-program-per-event>
<channel>
<!--content of type 'string'-->
...
</channel>
<invocation-type>
<!--content of type 'invocation-type'-->
...
</invocation-type>
</parameter>
<parameter>
<!--(another 'parameter' type)-->
</parameter>
<!--...more "parameter" elements...-->
<type-definition name="..." uri="...">
<!--content of type 'type-definition'-->
</type-definition>
<type-definition>
<!--(another 'type-definition' type)-->
</type-definition>
<!--...more "type-definition" elements...-->
<process-input>
<!--content of type 'process-input'-->
<artifact-type>
<!--content of type 'string'-->
...
</artifact-type>
<display-name>
<!--content of type 'string'-->
...
</display-name>
<remove-working-flag>
<!--content of type 'boolean'-->
...
</remove-working-flag>
</process-input>
<process-input>
<!--(another 'process-input' type)-->
</process-input>
<!--...more "process-input" elements...-->
<process-output>
<!--content of type 'process-output'-->
<artifact-type>
<!--content of type 'string'-->
...
</artifact-type>
<display-name>
<!--content of type 'string'-->
...
</display-name>
<output-generation-type>
<!--content of type 'output-generation-type'-->
...
</output-generation-type>
<variability-type>
<!--content of type 'variability-type'-->
...
</variability-type>
<number-of-outputs>
<!--content of type 'int'-->
...
</number-of-outputs>
<output-name>
<!--content of type 'string'-->
...
</output-name>
<field-definition name="..." uri="...">
<!--content of type 'field-link'-->
</field-definition>
<field-definition>
<!--(another 'field-link' type)-->
</field-definition>
<!--...more "field-definition" elements...-->
<assign-working-flag>
<!--content of type 'boolean'-->
...
</assign-working-flag>
</process-output>
<process-output>
<!--(another 'process-output' type)-->
</process-output>
<!--...more "process-output" elements...-->
<process-type-attribute name="...">...</process-type-attribute>
<process-type-attribute>
<!--(another 'process-type-attribute' type)-->
</process-type-attribute>
<!--...more "process-type-attribute" elements...-->
</ptp:process-type>
Element process-types
- Type: process-types
The representation for a list of process type links.
The system enforces a maximum number of elements when generating the list of links. When the size of the request result set is larger than the system maximum, the list represents a paged view of the overall results, and the previous-page and next-page elements provide URIs linking to the previous or next page of links in the overall results.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<ptp:process-types xmlns:ptp="http://genologics.com/ri/processtype">
<process-type name="..." uri="...">
<!--content of type 'process-type-link'-->
</process-type>
<process-type>
<!--(another 'process-type-link' type)-->
</process-type>
<!--...more "process-type" elements...-->
<previous-page uri="...">
<!--content of type 'page'-->
</previous-page>
<next-page uri="...">
<!--content of type 'page'-->
</next-page>
</ptp:process-types>
Type invocation-type
The available options for epp invocation type.
Possible Values
| value | description |
|---|---|
| PostProcess | The Epp script is invoked after the process is created |
| PreProcess | The Epp script is invoked before the process is created |
Type output-generation-type
The available options for output-type generation.
Possible Values
| value | description |
|---|---|
| PerInput | Output applies to individual Inputs |
| PerAllInputs | Output applies to all Inputs |
| PerReagentLabel | Output applies to Inputs per Reagent Label |
Type parameter
The parameter element integrates the process with the External Program Integration plug-in (EPP). When a user runs the process, the system automatically issue a command, or submits files and scripts to third-party programs for further processing. The parameter element is a child element of process-type.
Attributes
| name | type | description |
|---|---|---|
| name | string |
The name of the process type parameter.
Always returns with GET: Yes |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| file (string) | 0/1 |
The file of the parameter.
Always returns with GET: No |
| string (string) | 0/1 |
The value of the parameter.
Always returns with GET: No |
| run-program-per-event (boolean) | 0/1 |
Should the EPP run once for each process related event?
Always returns with GET: Yes |
| channel (string) | 0/1 |
The epp channel of this script.
Always returns with GET: No |
| invocation-type (invocation-type) | 0/1 |
The epp invocation type of this script.
Always returns with GET: Yes |
Type process-input
Process-input is a child element of process type specifying the available input types for the process
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| artifact-type (string) | 0/1 |
The artifact type for the input.
Always returns with GET: Yes |
| display-name (string) | 0/1 |
The display name for the input.
Always returns with GET: Yes |
| remove-working-flag (boolean) | 0/1 |
Whether the working flag should be removed from the input when the process runs.
Always returns with GET: Yes |
Type process-output
Process-output is a child element of process type specifying the configured output generation types for the process
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| artifact-type (string) | 0/1 |
Artifact type for this output.
Always returns with GET: Yes |
| display-name (string) | 0/1 |
The display name for the input.
Always returns with GET: Yes |
| output-generation-type (output-generation-type) | 0/1 |
Specifies how the outputs are generated in
relation to the inputs (COMPOUND, PER_REAGENT_LABEL, or PER_INPUT).
Always returns with GET: Yes |
| variability-type (variability-type) | 0/1 |
Specifies how the process determines the
number of outputs to generated (FIXED, VARIABLE, or VARIABLE_BY_INPUT).
Always returns with GET: Yes for FIXED output, No otherwise |
| number-of-outputs (int) | 0/1 |
Number of outputs to generate (only applies if variabilityType is FIXED).
Always returns with GET: Yes |
| output-name (string) | 0/1 |
Pattern for specifying how the output name is generated.
Always returns with GET: Yes |
| field-definition (field-link) | 0/unbounded |
Each field definition provides a URI linking to the configuration of a user-defined field for the output type.
Always returns with GET: No |
| assign-working-flag (boolean) | 0/1 |
Whether the working flag should be assigned to the output when the process runs.
Always returns with GET: Yes |
Type process-type
The process-type element contains the XML representation of a type of process configured in the system.
Attributes
| name | type | description |
|---|---|---|
| name | string |
The name of the process type.
Always returns with GET: Yes |
| uri | anyURI |
The URI of the process type.
Always returns with GET: Yes |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| field-definition (field-link) | 0/unbounded |
Each field definition provides a URI linking to the configuration of a user-defined field for the process type.
Always returns with GET: No |
| parameter (parameter) | 0/unbounded |
Each parameter is a named value or file for the process type.
Always returns with GET: No |
| type-definition (type-definition) | 0/unbounded |
Each type definition provides a URI linking to the configuration of a user-defined type for the process type.
Always returns with GET: No |
| process-input (process-input) | 0/unbounded |
List of enabled inputs for this process type.
Always returns with GET: Yes |
| process-output (process-output) | 0/unbounded |
List of enabled outputs for this process type.
Always returns with GET: No |
| process-type-attribute (process-type-attribute) | 0/unbounded |
List of configuration attributes for this process type.
Always returns with GET: No |
Type process-type-attribute
Process-type-attributes is a child element of process type containing key/value pairs for setting specific attributes that can be set for process types. This information contains internally used parameters that will change. These parameters are suitable for use when copying process types, but should not be manipulated.
Attributes
| name | type | description |
|---|---|---|
| name | string |
Specifies which attribute that the value will be set to.
Always returns with GET: Yes |
Value
- Type: string
Value to set for this attribute.
Always returns with GET: Yes
Type process-type-link
Process-type-link is a child element type of process types and provides a URI linking to the detailed representation of a process type.
Attributes
| name | type | description |
|---|---|---|
| name | string | The name of the process type. |
| uri | anyURI | The URI of the process type. |
Type process-types
The representation for a list of process type links.
The system enforces a maximum number of elements when generating the list of links. When the size of the request result set is larger than the system maximum, the list represents a paged view of the overall results, and the previous-page and next-page elements provide URIs linking to the previous or next page of links in the overall results.
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| process-type (process-type-link) | 0/unbounded | Process-type provides a URI linking to the detailed representation of a process type. |
| previous-page (page) | 0/1 | When working with large lists of process types, the previous-page element provides a URI that links to the previous page of process types. |
| next-page (page) | 0/1 | When working with large lists of process types, the next-page element provides a URI that links to the next page of process types. |
Type type-definition
Type-definition is a child element of process type providing a URI linking to the configuration of a user-defined type for the process type.
Attributes
| name | type | description |
|---|---|---|
| name | string |
The name of the user-defined type.
Always returns with GET: Yes |
| uri | anyURI |
The URI linking to the configuration of a user-defined type for the process type.
Always returns with GET: Yes |
Type variability-type
The available options for output-type variability.
Possible Values
| value | description |
|---|---|
| Fixed | Fixed number of Outputs applied to all Inputs (pre-configured) |
| Variable | Variable number of Outputs applied to all Inputs (entered at run-time) |
| VariableByInput | Variable number of Outputs per Input (entered at run-time) |