Data: ptm
- Namespace: http://genologics.com/ri/processtemplate
- XML Schema File: processtemplate.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-template
- Type: process-template
The detailed representation of a Process Template.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<ptm:process-template xmlns:ptm="http://genologics.com/ri/processtemplate" uri="...">
<name>
<!--content of type 'string'-->
...
</name>
<type uri="...">...</type>
<technician uri="...">
<!--content of type 'technician'-->
<first-name>
<!--content of type 'string'-->
...
</first-name>
<last-name>
<!--content of type 'string'-->
...
</last-name>
</technician>
<instrument uri="...">
<!--content of type 'instrument'-->
</instrument>
<process-parameter name="...">
<!--content of type 'parameter'-->
</process-parameter>
<udf:type xmlns:udf="http://genologics.com/ri/userdefined">...</udf:type>
<udf:field xmlns:udf="http://genologics.com/ri/userdefined">...</udf:field>
<udf:field xmlns:udf="http://genologics.com/ri/userdefined">...</udf:field>
<!--...more "field" elements...-->
<is-default>
<!--content of type 'boolean'-->
...
</is-default>
</ptm:process-template>
Element process-templates
- Type: process-templates
The representation of a list of Process Template 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"?>
<ptm:process-templates xmlns:ptm="http://genologics.com/ri/processtemplate">
<process-template uri="...">
<!--content of type 'process-template-link'-->
<name>
<!--content of type 'string'-->
...
</name>
</process-template>
<process-template>
<!--(another 'process-template-link' type)-->
</process-template>
<!--...more "process-template" elements...-->
<previous-page uri="...">
<!--content of type 'page'-->
</previous-page>
<next-page uri="...">
<!--content of type 'page'-->
</next-page>
</ptm:process-templates>
Type instrument
The instrument is a child element of process-template that provides a URI to the instrument that is responsible for running a Process created using this Process Template.
Attributes
| name | type | description |
|---|---|---|
| uri | anyURI |
A URI that identifies and links to the desired Instrument.
Always returns with GET: Yes |
Type parameter
The parameter is a child element of process-template that integrates the Process this Process Template represents, with the External Program Integration plug-in (EPP). When a user runs the Process built from this Process Template, the system automatically issues a command configured in the process parameter this element represents.
Attributes
| name | type | description |
|---|---|---|
| name | string | The name of the process type parameter. |
Type process-template
The detailed representation of a Process Template.
Attributes
| name | type | description |
|---|---|---|
| uri | anyURI |
The URI of the Process Template.
Always returns with GET: Yes |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| name (string) | 0/1 |
The name of the Process Template.
Always returns with GET: Yes |
| type (process-type) | 0/1 |
The Process Type for this Process Template.
Always returns with GET: Yes, if the Process Type exists. |
| technician (technician) | 0/1 |
Technician provides a URI linking to the detailed representation of the technician that is
configured to run the Process that this Process Template populates.
Always returns with GET: No |
| instrument (instrument) | 0/1 |
Instrument provides a URI linking to the detailed representation of the instrument that is
configured to run the Process that this Process Template populates.
Always returns with GET: No |
| process-parameter (parameter) | 0/1 |
The process parameter configured for EPP for the Process Type that the Process Template is
configured for.
Always returns with GET: No |
| type () | 0/1 |
The user-defined type of the Process that this Process Template populates.
Always returns with GET: No |
| field () | 0/unbounded |
The user-defined fields of this Process that this Process Template populates.
Always returns with GET: No |
| is-default (boolean) | 0/1 |
True if this is the default process template, false otherwise.
Always returns with GET: Yes |
Type process-template-link
process-template-link is a child element type of Process Templates and provides a URI linking to the detailed representation of a Process Template.
Attributes
| name | type | description |
|---|---|---|
| uri | anyURI | The URI of the Process Template. |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| name (string) | 0/1 | The name of the Process Template. |
Type process-templates
The representation of a list of Process Template 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-template (process-template-link) | 0/unbounded | Provides a URI linking to the detailed representation of a Process Template. |
| previous-page (page) | 0/1 | When working with large lists of Process Templates, the previous-page element provides a URI that links to the previous page of Process Templates. |
| next-page (page) | 0/1 | When working with large lists of Process Templates, the next-page element provides a URI that links to the next page of Process Templates. |
Type process-type
Process-type is a child element of process-template that identifies and provides a URI linking to the detailed representation of the Process Type that the Process Template is associated with.
Attributes
| name | type | description |
|---|---|---|
| uri | anyURI |
The URI of the Process Type.
Always returns with GET: Yes |
Value
- Type: string
The name of the Process Type.
Always returns with GET: Yes
Type technician
Technician is a child element of process-template and provides a URI linking to the detailed representation of the technician that is configured to run a Process created using this Process Template.
Attributes
| name | type | description |
|---|---|---|
| uri | anyURI |
The URI of the technician.
Always returns with GET: Yes |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| first-name (string) | 0/1 |
The first name of the technician.
Always returns with GET: Yes |
| last-name (string) | 0/1 |
The last name of the technician.
Always returns with GET: Yes |