Data: art

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

artifact
artifacts
details

The following types are members of this namespace:

artifact
artifactgroup
artifact-link
artifacts
control-type
details
parent-process
qc-flag
reagent-label
sample
status
workflow-stage

Element artifact

Type: artifact

The detailed representation of an Artifact.

An Artifact represents the inputs to or outputs from a process. An Artifact is classified by its type (Analyte, ResultFile, etc).

Artifacts do not support HTTP POST requests.

Example XML

<?xml version="1.0" encoding="UTF-8"?>
<art:artifact xmlns:art="http://genologics.com/ri/artifact" limsid="..." uri="...">
  <name>
    <!--content of type 'string'-->
    ...
  </name>
  <type>
    <!--content of type 'string'-->
    ...
  </type>
  <output-type>
    <!--content of type 'string'-->
    ...
  </output-type>
  <parent-process limsid="..." uri="...">
    <!--content of type 'parent-process'-->
  </parent-process>
  <qc-flag>
    <!--content of type 'qc-flag'-->
    ...
  </qc-flag>
  <location>
    <!--content of type 'location'-->
    <container limsid="..." uri="...">
      <!--content of type 'container'-->
    </container>
    <value>
      <!--content of type 'string'-->
      ...
    </value>
  </location>
  <working-flag>
    <!--content of type 'boolean'-->
    ...
  </working-flag>
  <sample limsid="..." uri="...">
    <!--content of type 'sample'-->
  </sample>
  <sample>
    <!--(another 'sample' type)-->
  </sample>
  <!--...more "sample" elements...-->
  <reagent-label name="...">
    <!--content of type 'reagent-label'-->
  </reagent-label>
  <reagent-label>
    <!--(another 'reagent-label' type)-->
  </reagent-label>
  <!--...more "reagent-label" elements...-->
  <control-type uri="...">
    <!--content of type 'control-type'-->
  </control-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>
  <artifact-group uri="..." name="...">
    <!--content of type 'artifactgroup'-->
  </artifact-group>
  <artifact-group>
    <!--(another 'artifactgroup' type)-->
  </artifact-group>
  <!--...more "artifact-group" elements...-->
  <workflow-stages>
    <workflow-stage uri="..." name="..." status="...">
      <!--content of type 'workflow-stage'-->
    </workflow-stage>
    <workflow-stage>
      <!--(another 'workflow-stage' type)-->
    </workflow-stage>
    <!--...more "workflow-stage" elements...-->
  </workflow-stages>
</art:artifact>

Element artifacts

Type: artifacts

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

Element details

Type: details

The representation of a list of resource details.

Example XML

<?xml version="1.0" encoding="UTF-8"?>
<art:details xmlns:art="http://genologics.com/ri/artifact">
  <art:artifact limsid="..." uri="...">
    <!--content of type 'artifact'-->
    <name>
      <!--content of type 'string'-->
      ...
    </name>
    <type>
      <!--content of type 'string'-->
      ...
    </type>
    <output-type>
      <!--content of type 'string'-->
      ...
    </output-type>
    <parent-process limsid="..." uri="...">
      <!--content of type 'parent-process'-->
    </parent-process>
    <qc-flag>
      <!--content of type 'qc-flag'-->
      ...
    </qc-flag>
    <location>
      <!--content of type 'location'-->
      <container limsid="..." uri="...">
        <!--content of type 'container'-->
      </container>
      <value>
        <!--content of type 'string'-->
        ...
      </value>
    </location>
    <working-flag>
      <!--content of type 'boolean'-->
      ...
    </working-flag>
    <sample limsid="..." uri="...">
      <!--content of type 'sample'-->
    </sample>
    <sample>
      <!--(another 'sample' type)-->
    </sample>
    <!--...more "sample" elements...-->
    <reagent-label name="...">
      <!--content of type 'reagent-label'-->
    </reagent-label>
    <reagent-label>
      <!--(another 'reagent-label' type)-->
    </reagent-label>
    <!--...more "reagent-label" elements...-->
    <control-type uri="...">
      <!--content of type 'control-type'-->
    </control-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>
    <artifact-group uri="..." name="...">
      <!--content of type 'artifactgroup'-->
    </artifact-group>
    <artifact-group>
      <!--(another 'artifactgroup' type)-->
    </artifact-group>
    <!--...more "artifact-group" elements...-->
    <workflow-stages>
      <workflow-stage uri="..." name="..." status="...">
        <!--content of type 'workflow-stage'-->
      </workflow-stage>
      <workflow-stage>
        <!--(another 'workflow-stage' type)-->
      </workflow-stage>
      <!--...more "workflow-stage" elements...-->
    </workflow-stages>
  </art:artifact>
  <art:artifact>
    <!--(another 'artifact' type)-->
  </art:artifact>
  <!--...more "artifact" elements...-->
</art:details>

Type artifact

The detailed representation of an Artifact.

An Artifact represents the inputs to or outputs from a process. An Artifact is classified by its type (Analyte, ResultFile, etc).

Artifacts do not support HTTP POST requests.

Attributes

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

Child Elements

name (type)	min/max occurs	description
name (string)	0/1	The name of the Artifact. Always returns with GET: Yes Updatable with PUT: Yes Required for PUT: Yes
type (string)	0/1	The type of Artifact. Artifact type describes the characteristics of the Artifact. For example, the type of the Artifact can be Analyte indicating it is a sample or submitted sample that resides in a container. Alternately, the type could be ResultFile indicating it is the output of instrument processing. Refer to the GenoLogics LIMS Help file for information on process inputs and outputs. Always returns with GET: Yes Updatable with PUT: No Required for PUT: No
output-type (string)	0/1	The output-type of the Artifact. In the client, this is a custom Display Name given to the Artifact type when configuring the process. Always returns with GET: Yes Updatable with PUT: No Required for PUT: No
parent-process (parent-process)	0/1	The process that produced the Artifact. The parent-process provides a URI linking to the detailed representation of the process that produced the Artifact. Always returns with GET: No, It is returned in all cases except the analyte artifact of the submitted sample case, which by definition cannot have a parent-process Updatable with PUT: No Required for PUT: No
qc-flag (qc-flag)	0/1	The qc-flag applied to the Artifact. Always returns with GET: Yes Updatable with PUT: Yes Required for PUT: No, but if not provided, QC is set to UNKNOWN.
location (location)	0/1	The Artifact's location in a container. Always returns with GET: No Updatable with PUT: No Required for PUT: No
working-flag (boolean)	0/1	The working-flag of the Artifact. In the client, this is referred to as the working status of an artifact. Working-flag indicates whether the Artifact is ready for use in additional Processes. Always returns with GET: No, only for Analytes Updatable with PUT: Yes, only supported for Analyte type Artifacts. Required for PUT: Yes, for Analyte only.
sample (sample)	0/unbounded	A submitted sample related to the Artifact. This element is repeated for each submitted sample that the artifact is related to. Each Sample provides a URI linking to the detailed representation of a submitted Sample for the Artifact. Always returns with GET: Yes Updatable with PUT: No Required for PUT: No
reagent-label (reagent-label)	0/unbounded	A reagent label applied to the Artifact. This element is repeated for each reagent label applied to the Artifact. Reagent labels can be explicitly added to Artifacts in different ways: in the client, when importing Samples; in the client, when running any Processes for adding Reagents; in the API, by updating an artifact representation to include reagent labels. Additionally, reagent labels will be automatically copied from inputs to outputs when a Process is run. Reagent labels are conventionally named after the type of reagent (see the Reagent Type endpoint) they correspond to. Always returns with GET: No Updatable with PUT: Yes Required for PUT: No, but if not provided, reagent labels are cleared
control-type (control-type)	0/1	The control type of the Artifact. Only control sample has control type. Always returns with GET: No, only for control sample Updatable with PUT: No Required for PUT: No
field ()	0/unbounded	A User-Defined Field that is associated with the Artifact. This element is repeated for each UDF associated with the Artifact. 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/1	File provides a URI linking to the detailed representation of the File associated with the Artifact. Always returns with GET: No Updatable with PUT: Yes, only supported for SearchResultFile, ResultFile, and SpotList type Artifacts. Required for PUT: No
artifact-group (artifactgroup)	0/unbounded	The artifact group that the Artifact belongs to. In the client, artifact groups are referred to as experiments. This element is repeated for each artifact group that the Artifact belongs to. Always returns with GET: No Updatable with PUT: Yes Required for PUT: No, but if not provided, existing ArtifactGroups are cleared from Artifact.
workflow-stages/workflow-stage (workflow-stage)	0/unbounded	The list of workflow stages that the artifact has completed or is presently active in. Always returns with GET: Yes Updatable with PUT: No Required for PUT: No

Type artifactgroup

Artifact group is a child element of Artifact and provides a URI linking to the detailed representation of the artifact group that the Artifact belongs to. In the client, artifact groups are referred to as experiments.

Attributes

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

Type artifact-link

Artifact-link is a child element type of artifacts and provides a URI linking to the detailed representation of an artifact.

Attributes

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

Type artifacts

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

Type control-type

Provide a URI linking to the control type if this artifact is a control sample

Attributes

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

Type details

The representation of a list of resource details.

Child Elements

name (type)	min/max occurs	description
artifact (artifact)	0/unbounded	A list of detailed resource representations.

Type parent-process

Parent-process is a child element of Artifact and provides a URI linking to the detailed representation of the process that produced the Artifact.

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

Type qc-flag

The qc-flag enumeration lists the possible values of the qc-flag element for the Artifact.

Possible Values

value	description
UNKNOWN	UNKNOWN indicates that the qc-flag is unknown for the Artifact. The qc-flag can be unknown if no Quality Control (QC) step has been performed for the Artifact.
PASSED	PASSED indicates that the Artifact has successfully passed a QC check.
FAILED	FAILED indicates that the Artifact has failed a QC check.
CONTINUE	CONTINUE is a legacy value from the system and is not used.

Type reagent-label

Reagent-label is a child element of Artifact and provides the name of a label or reagent that has been added to the Artifact.

Attributes

name	type	description
name	string	The name of the label or reagent. Always returns with GET: Yes Updatable with PUT: Yes Required for PUT: No

Type sample

Sample is a child element of Artifact and provides a URI linking to the detailed representation of a submitted Sample for the Artifact.

Attributes

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

Type status

The workflow stage status for the artifact.

Possible Values

value	description
QUEUED	The artifact has been queued for this stage.
IN_PROGRESS	The artifact has been checked out for this stage. For QC protocols, all steps in the protocol share the same stage. So, an artifact in a QC protocol will be considered IN_PROGRESS if it has been checked out in any of the protocol steps within the protocol.
SKIPPED	The artifact has skipped this stage.
REMOVED	The artifact has been removed from this stage.
COMPLETE	The artifact has completed this stage.

Type workflow-stage

Provides links to workflow stages, stage names and their respective statuses.

Attributes

name	type	description
uri	anyURI	The URI of the workflow stage. Always returns with GET: Yes Updatable with PUT: No Required for PUT: No
name	string	The name of the protocol step for this workflow stage. For QC protocols, the stage name will be the protocol name. Always returns with GET: Yes Updatable with PUT: No Required for PUT: No
status	status	The status of the workflow stage. Always returns with GET: Yes Updatable with PUT: No Required for PUT: No

REST API

Data: art

Element artifact

Example XML

Element artifacts

Example XML

Element details

Example XML

Type artifact

Attributes

Child Elements

Type artifactgroup

Attributes

Type artifact-link

Attributes

Type artifacts

Child Elements

Type control-type

Attributes

Type details

Child Elements

Type parent-process

Attributes

Type qc-flag

Possible Values

Type reagent-label

Attributes

Type sample

Attributes

Type status

Possible Values

Type workflow-stage

Attributes

Home

REST Endpoints

XML Data Elements

XML Data Types