Data: prc

Namespace: http://genologics.com/ri/process
XML Schema File: process.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:

process
processes

The following types are members of this namespace:

artifact
input-output-map
instrument
output-generation-type
parameter
parent-process
process
processes
process-link
process-type
technician

Element process

Type: process

The detailed representation of a process.

Example XML

<?xml version="1.0" encoding="UTF-8"?>
<prc:process xmlns:prc="http://genologics.com/ri/process" limsid="..." uri="...">
  <type uri="...">...</type>
  <date-run>
    <!--content of type 'string'-->
    ...
  </date-run>
  <technician uri="...">
    <!--content of type 'technician'-->
    <first-name>
      <!--content of type 'string'-->
      ...
    </first-name>
    <last-name>
      <!--content of type 'string'-->
      ...
    </last-name>
  </technician>
  <input-output-map>
    <!--content of type 'input-output-map'-->
    <input limsid="..." output-type="..." output-generation-type="..." uri="..." post-process-uri="...">
      <!--content of type 'artifact'-->
      <parent-process limsid="..." uri="...">
        <!--content of type 'parent-process'-->
      </parent-process>
    </input>
    <output limsid="..." output-type="..." output-generation-type="..." uri="..." post-process-uri="...">
      <!--content of type 'artifact'-->
      <parent-process limsid="..." uri="...">
        <!--content of type 'parent-process'-->
      </parent-process>
    </output>
  </input-output-map>
  <input-output-map>
    <!--(another 'input-output-map' type)-->
  </input-output-map>
  <!--...more "input-output-map" elements...-->
  <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...-->
  <file:file xmlns:file="http://genologics.com/ri/file">...</file:file>
  <file:file xmlns:file="http://genologics.com/ri/file">...</file:file>
  <!--...more "file" elements...-->
  <protocol-name>
    <!--content of type 'string'-->
    ...
  </protocol-name>
  <instrument uri="...">
    <!--content of type 'instrument'-->
  </instrument>
  <process-parameter name="...">
    <!--content of type 'parameter'-->
  </process-parameter>
</prc:process>

Element processes

Type: processes

The representation of a list of process 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"?>
<prc:processes xmlns:prc="http://genologics.com/ri/process">
  <process limsid="..." uri="...">
    <!--content of type 'process-link'-->
  </process>
  <process>
    <!--(another 'process-link' type)-->
  </process>
  <!--...more "process" elements...-->
  <previous-page uri="...">
    <!--content of type 'page'-->
  </previous-page>
  <next-page uri="...">
    <!--content of type 'page'-->
  </next-page>
</prc:processes>

Type artifact

Artifact is a child element of input-output-map and provides a link to an Artifact that was either an input or output of the Process for the input-output-map.

Attributes

name	type	description
limsid	string	The LIMSID of the Artifact. Always returns with GET: Yes Updatable with PUT: No Required for PUT: No
output-type	string	The output type of the Artifact. Always returns with GET: No Updatable with PUT: No Required for PUT: No
output-generation-type	output-generation-type	Specifies how the outputs were generated in relation to the inputs (COMPOUND, PER_REAGENT_LABEL, or PER_INPUT). Always returns with GET: Yes
uri	anyURI	The URI of the Artifact before the Process was run. Artifact URIs include a state query parameter, and the state changes as Processes are run on the Artifact. This allows linking to the values for the Artifact at a particular point in time, such as before executing the Process or after the Process completed. Values such as volume, concentration and qc-flag that are affected by Process execution are reflected for the particular state of the Artifact. Always returns with GET: Yes Updatable with PUT: No Required for PUT: No
post-process-uri	anyURI	The URI of the Artifact after the Process was run. Artifact URIs include a state query parameter, and the state changes as Processes are run on the Artifact. This allows linking to the values for the Artifact at a particular point in time, such as before executing the Process or after the Process completed. Values such as volume, concentration and qc-flag that are affected by Process execution are reflected for the particular state of the Artifact. Always returns with GET: Yes Updatable with PUT: No Required for PUT: No

Child Elements

name (type)	min/max occurs	description
parent-process (parent-process)	0/1	Parent-process provides a URI linking to the Process that created the Artifact. Always returns with GET: No Updatable with PUT: No Required for PUT: No

Type input-output-map

Input-output-map is a child element of Process and relates one of the Process inputs to one of the outputs that was produced for that input.

There will be a distinct input-output-map for each pairing of Process input to Process output.

If an input is not mapped to any outputs, the input will be listed with no outputs.

Child Elements

name (type)	min/max occurs	description
input (artifact)	0/1	Input provides a URI linking to the input Artifact for the input-output-map. Always returns with GET: Yes Updatable with PUT: No Required for PUT: No
output (artifact)	0/1	Output provides a URI linking to the output Artifact for the input-output-map. Always returns with GET: No Updatable with PUT: No Required for PUT: No

Type instrument

The instrument element provides a URI to the instrument that is responsible for running the process.

Attributes

name	type	description
uri	anyURI	A URI that identifies and links to the desired Instrument. Creatable with PUT: No Required for PUT: No

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 is a child element of process 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.

Attributes

name	type	description
name	string	The name of the process type parameter.

Type parent-process

Parent-process is a child element of Artifact and provides a URI linking to the Process that created the Artifact.

Attributes

name	type	description
limsid	string	The LIMSID of the Process. Always returns with GET: Yes Updatable with PUT: No Required for PUT: No
uri	anyURI	The URI of the Process. Always returns with GET: Yes Updatable with PUT: No Required for PUT: No

Type process

The detailed representation of a process.

Attributes

name	type	description
limsid	string	The LIMS ID of the Process. Always returns with GET: Yes Updatable with PUT: No Required for PUT: No
uri	anyURI	The URI of the Process. Always returns with GET: Yes Updatable with PUT: No Required for PUT: No

Child Elements

name (type)	min/max occurs	description
type (process-type)	0/1	The type of the Process. Always returns with GET: Yes Updatable with PUT: No Required for PUT: No
date-run (string)	0/1	The date associated with the running of the Process, in YYYY-MM-DD format. Always returns with GET: No Updatable with PUT: Yes Required for PUT: No
technician (technician)	0/1	Technician provides a URI linking to the detailed representation of the technician that ran the Process. Always returns with GET: No Updatable with PUT: Yes Required for PUT: Yes
input-output-map (input-output-map)	0/unbounded	Each input-output-map relates one of the Process inputs to one of the outputs that was produced for that input. There will be a distinct input-output-map for each paring of Process input to Process output Always returns with GET: No Updatable with PUT: No Required for PUT: No
type ()	0/1	The user-defined type of this Process. Always returns with GET: No Updatable with PUT: Yes Required for PUT: No, unless the UDT has been configured as required. If a current UDT is not provided, existing values are deleted.
field ()	0/unbounded	The user-defined fields of this Process. Always returns with GET: No Updatable with PUT: Yes Required for PUT: No, unless the UDF has been configured as required. If a current UDF is not provided, existing values are deleted.
file ()	0/unbounded	Each file provides a URI linking to the detailed representation of a file associated with the Process. Always returns with GET: No Updatable with PUT: Yes Required for PUT: No
protocol-name (string)	0/1	The name of the protocol used to run the Process. Always returns with GET: No Updatable with PUT: No Required for PUT: No
instrument (instrument)	0/1	Instrument provides a URI linking to the detailed representation of the instrument that ran the Process. Always returns with GET: No Updatable with PUT: No Required for PUT: No
process-parameter (parameter)	0/1	The process parameter configured for EPP for the Process Type of the Process Always returns with GET: No Updatable with PUT: No Required for PUT: No

Type processes

The representation of a list of process 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 (process-link)	0/unbounded	Process provides a URI linking to the detailed representation of a process.
previous-page (page)	0/1	When working with large lists of processes, the previous-page element provides a URI that links to the previous page of processes.
next-page (page)	0/1	When working with large lists of processes, the next-page element provides a URI that links to the next page of processes.

Type process-link

Process-link is a child element type of process and provides a URI linking to the detailed representation of a process.

Attributes

name	type	description
limsid	string	The LIMSID of the process.
uri	anyURI	The URI of the process.

Type process-type

Process-type is a child element of process that identifies and provides a URI linking to the detailed representation of the process type that the process is associated with.

Attributes

name	type	description
uri	anyURI	The URI of the process type.

Value

Type: string

The name of the process type.

Type technician

Technician is a child element of Process and provides a URI linking to the detailed representation of the technician that ran the Process.

Attributes

name	type	description
uri	anyURI	The URI of the technician. Always returns with GET: Yes Updatable with PUT: Yes Required for PUT: 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 Updatable with PUT: No Required for PUT: No
last-name (string)	0/1	The last name of the technician. Always returns with GET: Yes Updatable with PUT: No Required for PUT: No

REST API

Data: prc

Element process

Example XML

Element processes

Example XML

Type artifact

Attributes

Child Elements

Type input-output-map

Child Elements

Type instrument

Attributes

Type output-generation-type

Possible Values

Type parameter

Attributes

Type parent-process

Attributes

Type process

Attributes

Child Elements

Type processes

Child Elements

Type process-link

Attributes

Type process-type

Attributes

Value

Type technician

Attributes

Child Elements

Home

REST Endpoints

XML Data Elements

XML Data Types