Data: artgr
- Namespace: http://genologics.com/ri/artifactgroup
- XML Schema File: artifactgroup.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 artifactgroup
- Type: artifactgroup
ArtifactGroups are created by the Lab Scientist interface for each workflow. The Operations Interface assigns samples to workflows by placing them into an artifactGroup. Seeing a sample in an artifactGroup in the API indicates that the sample has been assigned to a workflow of the same name.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<artgr:artifactgroup xmlns:artgr="http://genologics.com/ri/artifactgroup" uri="...">
<name>
<!--content of type 'string'-->
...
</name>
<artifacts uri="...">
<!--content of type 'artifacts'-->
</artifacts>
</artgr:artifactgroup>
Element artifactgroups
- Type: artifactgroups
The representation of a list of artifactGroup 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"?>
<artgr:artifactgroups xmlns:artgr="http://genologics.com/ri/artifactgroup">
<artifactgroup uri="...">
<!--content of type 'artifactgroup-link'-->
<name>
<!--content of type 'string'-->
...
</name>
</artifactgroup>
<artifactgroup>
<!--(another 'artifactgroup-link' type)-->
</artifactgroup>
<!--...more "artifactgroup" elements...-->
<previous-page uri="...">
<!--content of type 'page'-->
</previous-page>
<next-page uri="...">
<!--content of type 'page'-->
</next-page>
</artgr:artifactgroups>
Type artifactgroup
ArtifactGroups are created by the Lab Scientist interface for each workflow. The Operations Interface assigns samples to workflows by placing them into an artifactGroup. Seeing a sample in an artifactGroup in the API indicates that the sample has been assigned to a workflow of the same name.
Attributes
| name | type | description |
|---|---|---|
| uri | anyURI |
The URI of the artifactGroup.
Always returns with GET: Yes Creatable with POST: No Required for POST: No |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| name (string) | 0/1 |
The name of the artifactGroup.
Always returns with GET: Yes Creatable with POST: No Required for POST: No |
| artifacts (artifacts) | 0/1 |
Artifacts provides a URI linking to the detailed representation of the artifacts for the artifactGroup.
Always returns with GET: Yes Creatable with POST: No Required for POST: No |
Type artifactgroup-link
artifactGroup-link is a child element type of artifactGroup and provides a URI linking to the detailed representation of a artifactGroup.
Attributes
| name | type | description |
|---|---|---|
| uri | anyURI | The URI of the artifactGroup. |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| name (string) | 0/1 | The name of the artifactGroup. |
Type artifactgroups
The representation of a list of artifactGroup 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 |
|---|---|---|
| artifactgroup (artifactgroup-link) | 0/unbounded | artifactGroups provides a URI linking to the detailed representation of a artifactGroups. |
| previous-page (page) | 0/1 | When working with large lists of artifactGroups, the previous-page element provides a URI that links to the previous page of artifactGroups. |
| next-page (page) | 0/1 | When working with large lists of artifactGroups, the next-page element provides a URI that links to the next page of artifactGroups. |
Type artifacts
Artifacts is a link to 1...n child artifacts, that belong to the artifactGroup The link to an artifactList, filtered on artifactgroupID
Attributes
| name | type | description |
|---|---|---|
| uri | anyURI |
The URI of the artifacts filter.
Always returns with GET: Yes Creatable with POST: No Required for POST: No |