Data: prj
- Namespace: http://genologics.com/ri/project
- XML Schema File: project.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 project
- Type: project
The detailed representation of a Project.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<prj:project xmlns:prj="http://genologics.com/ri/project" limsid="..." uri="...">
<name>
<!--content of type 'string'-->
...
</name>
<open-date>
<!--content of type 'string'-->
...
</open-date>
<close-date>
<!--content of type 'string'-->
...
</close-date>
<invoice-date>
<!--content of type 'string'-->
...
</invoice-date>
<researcher uri="...">
<!--content of type 'researcher'-->
</researcher>
<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...-->
<ri:externalid xmlns:ri="http://genologics.com/ri">...</ri:externalid>
<ri:externalid xmlns:ri="http://genologics.com/ri">...</ri:externalid>
<!--...more "externalid" 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...-->
</prj:project>
Element projects
- Type: projects
The representation of a list of project 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"?>
<prj:projects xmlns:prj="http://genologics.com/ri/project">
<project limsid="..." uri="...">
<!--content of type 'project-link'-->
<name>
<!--content of type 'string'-->
...
</name>
</project>
<project>
<!--(another 'project-link' type)-->
</project>
<!--...more "project" elements...-->
<previous-page uri="...">
<!--content of type 'page'-->
</previous-page>
<next-page uri="...">
<!--content of type 'page'-->
</next-page>
</prj:projects>
Type project
The detailed representation of a Project.
Attributes
| name | type | description |
|---|---|---|
| limsid | string |
The LIMS ID of the Project.
Always returns with GET: Yes Creatable with POST: No Required for POST: No Updatable with PUT: No Required for PUT: No |
| uri | anyURI |
The URI of the Project.
Always returns with GET: Yes Creatable with POST: No Required for POST: No Updatable with PUT: No Required for PUT: No |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| name (string) | 0/1 |
The name of the Project.
Always returns with GET: Yes Creatable with POST: Yes Required for POST: Yes Updatable with PUT: Yes Required for PUT: Yes |
| open-date (string) | 0/1 |
The open date of the Project.
Always returns with GET: No Creatable with POST: Yes Required for POST: No, unless a close date is also provided. Updatable with PUT: Yes Required for PUT: No, unless a close date is also provided. |
| close-date (string) | 0/1 |
The close date of the Project.
Always returns with GET: No Creatable with POST: Yes Required for POST: No Updatable with PUT: Yes Required for PUT: No |
| invoice-date (string) | 0/1 |
The invoice date of the Project.
Always returns with GET: No Creatable with POST: Yes Required for POST: No Updatable with PUT: Yes Required for PUT: No |
| researcher (researcher) | 0/1 |
Researcher provides a URI linking to the detailed representation of the Researcher for the Project.
Always returns with GET: Yes Creatable with POST: Yes Required for POST: Yes Updatable with PUT: Yes Required for PUT: Yes |
| type () | 0/1 |
The UDT of the Project.
Always returns with GET: No Creatable with POST: Yes Required for POST: No, unless the UDT has been configured as required. 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 UDFs of the Project.
Always returns with GET: No Creatable with POST: Yes Required for POST: No, unless the UDF has been configured as required. 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. |
| externalid () | 0/unbounded |
Each external id is an identifier that allows looking up related information about the Project from an external system.
Always returns with GET: No Creatable with POST: Yes Required for POST: No Updatable with PUT: Yes Required for PUT: No |
| file () | 0/unbounded |
Each File provides a URI linking to the detailed representation of a File associated with the Project.
Always returns with GET: No Creatable with POST: Yes Required for POST: No Updatable with PUT: Yes Required for PUT: No |
Type project-link
Project-link is a child element type of projects and provides a URI linking to the detailed representation of a project.
Attributes
| name | type | description |
|---|---|---|
| limsid | string | The LIMSID of the project. |
| uri | anyURI | The URI of the project. |
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| name (string) | 0/1 | The name of the project. |
Type projects
The representation of a list of project 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 |
|---|---|---|
| project (project-link) | 0/unbounded | Project provides a URI linking to the detailed representation of a project. |
| previous-page (page) | 0/1 | When working with large lists of projects, the previous-page element provides a URI that links to the previous page of projects. |
| next-page (page) | 0/1 | When working with large lists of projects, the next-page element provides a URI that links to the next page of projects. |
Type researcher
Researcher is a child element of Project and provides a URI linking to the detailed representation of the Researcher for the Project.
Attributes
| name | type | description |
|---|---|---|
| uri | anyURI |
The URI of the Researcher.
Always returns with GET: Yes Creatable with POST: Yes Required for POST: Yes Updatable with PUT: Yes Required for PUT: Yes |