Data: file
- Namespace: http://genologics.com/ri/file
- XML Schema File: file.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 details
- Type: details
The representation of a batch of file resources.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<file:details xmlns:file="http://genologics.com/ri/file">
<file:file limsid="..." uri="...">
<!--content of type 'file'-->
<attached-to>
<!--content of type 'anyURI'-->
...
</attached-to>
<content-location>
<!--content of type 'anyURI'-->
...
</content-location>
<original-location>
<!--content of type 'string'-->
...
</original-location>
<original-name>
<!--content of type 'string'-->
...
</original-name>
<is-published>
<!--content of type 'boolean'-->
...
</is-published>
</file:file>
<file:file>
<!--(another 'file' type)-->
</file:file>
<!--...more "file" elements...-->
</file:details>
Element file
- Type: file
The file element contains information about a file in the system.
Example XML
<?xml version="1.0" encoding="UTF-8"?>
<file:file xmlns:file="http://genologics.com/ri/file" limsid="..." uri="...">
<attached-to>
<!--content of type 'anyURI'-->
...
</attached-to>
<content-location>
<!--content of type 'anyURI'-->
...
</content-location>
<original-location>
<!--content of type 'string'-->
...
</original-location>
<original-name>
<!--content of type 'string'-->
...
</original-name>
<is-published>
<!--content of type 'boolean'-->
...
</is-published>
</file:file>
Element files
- Type: files
The representation for a list of file 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"?>
<file:files xmlns:file="http://genologics.com/ri/file">
<file uri="..." limsid="...">
<!--content of type 'file-link'-->
</file>
<file>
<!--(another 'file-link' type)-->
</file>
<!--...more "file" elements...-->
<previous-page uri="...">
<!--content of type 'page'-->
</previous-page>
<next-page uri="...">
<!--content of type 'page'-->
</next-page>
</file:files>
Type details
The representation of a batch of file resources.
Child Elements
| name (type) | min/max occurs |
description |
|---|---|---|
| file (file) | 0/unbounded | (no documentation provided) |
Type file
The file element contains information about a file in the system.
Attributes
| name | type | description |
|---|---|---|
| limsid | string |
The LIMS ID of the file.
Always returns with GET: Yes Creatable with POST: No Required for POST: No Updatable with PUT: No Required for PUT: No |
| uri | anyURI |
A URI that identifies the file.
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 |
|---|---|---|
| attached-to (anyURI) | 0/1 |
This element contains a URI that identifies and links to further information about the resource that
the file is attached to, such as a project, sample, process, or file-based artifact.
Always returns with GET: No Creatable with POST: Yes Required for POST: Yes, a file must always be attached to an entity, or capturedfile record. Updatable with PUT: Yes Required for PUT: Yes, a file must always be attached to an entity, or capturedfile record. |
| content-location (anyURI) | 0/1 |
This element contains a URI that identifies and links to the network location of the file,
which can be used to retrieve the file and process its contents.
It must be either within the content root path or the allowed list of directories that
are configured under the api.files.allowlist.dirs property.
Always returns with GET: Yes Creatable with POST: Yes, must be valid location for system to read inbound file uri information from. Required for POST: Yes Updatable with PUT: No Required for PUT: No |
| original-location (string) | 0/1 |
This element provides the original name and location of the file before it was imported into the system.
Note: If the file was uploaded from the Clarity web interface, the original-location element will not contain
the full file path due to browser security limitations. Only the original file name will be available.
Always returns with GET: Yes Creatable with POST: Yes, must be valid location for system to read inbound file location from. Required for POST: Yes Updatable with PUT: No Required for PUT: No |
| original-name (string) | 0/1 |
This element provides the original name of the file before it was imported into the system.
This is calculated from the original-location
Always returns with GET: Yes Creatable with POST: No Required for POST: No Updatable with PUT: No Required for PUT: No |
| is-published (boolean) | 0/1 |
This element specifies whether the file is displayed in LabLink.
To publish a file to LabLink, use 'true'.
Always returns with GET: Yes Creatable with POST: Yes Required for POST: No Updatable with PUT: Yes Required for PUT: No, but if not provided or empty, value is set to false. |
Type file-link
The file-link type provides a URI that links to information about a file in the system. Elements of this type are used for lists of files, or by resources that have attached files to identify and link to further information about the file.
Attributes
| name | type | description |
|---|---|---|
| uri | string | A URI that identifies and links to further information about the file. |
| limsid | string | The LIMSID of the file. |
Type files
The representation for a list of file 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 |
|---|---|---|
| file (file-link) | 0/unbounded | File provides a URI linking to the detailed representation of a file. |
| previous-page (page) | 0/1 | When working with large lists of files, the previous-page element provides a URI that links to the previous page of files. |
| next-page (page) | 0/1 | When working with large lists of files, the next-page element provides a URI that links to the next page of files. |