# {py:mod}`nexusLIMS.utils.cdcs`

```{py:module} nexusLIMS.utils.cdcs
```

```{autodoc2-docstring} nexusLIMS.utils.cdcs
:parser: autodoc2_docstrings_parser
:allowtitles:
```

## Module Contents

### Classes

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`CDCSDataRecord <nexusLIMS.utils.cdcs.CDCSDataRecord>`
  - ```{autodoc2-docstring} nexusLIMS.utils.cdcs.CDCSDataRecord
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### Functions

````{list-table}
:class: autosummary longtable
:align: left

* - {py:obj}`get_cdcs_url <nexusLIMS.utils.cdcs.get_cdcs_url>`
  - ```{autodoc2-docstring} nexusLIMS.utils.cdcs.get_cdcs_url
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`get_workspace_id <nexusLIMS.utils.cdcs.get_workspace_id>`
  - ```{autodoc2-docstring} nexusLIMS.utils.cdcs.get_workspace_id
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`get_template_id <nexusLIMS.utils.cdcs.get_template_id>`
  - ```{autodoc2-docstring} nexusLIMS.utils.cdcs.get_template_id
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`delete_record <nexusLIMS.utils.cdcs.delete_record>`
  - ```{autodoc2-docstring} nexusLIMS.utils.cdcs.delete_record
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`search_records <nexusLIMS.utils.cdcs.search_records>`
  - ```{autodoc2-docstring} nexusLIMS.utils.cdcs.search_records
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`download_record <nexusLIMS.utils.cdcs.download_record>`
  - ```{autodoc2-docstring} nexusLIMS.utils.cdcs.download_record
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`upload_record_content <nexusLIMS.utils.cdcs.upload_record_content>`
  - ```{autodoc2-docstring} nexusLIMS.utils.cdcs.upload_record_content
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
* - {py:obj}`upload_record_files <nexusLIMS.utils.cdcs.upload_record_files>`
  - ```{autodoc2-docstring} nexusLIMS.utils.cdcs.upload_record_files
    :parser: autodoc2_docstrings_parser
    :summary:
    ```
````

### API

````{py:exception} AuthenticationError(message)
:canonical: nexusLIMS.utils.cdcs.AuthenticationError

Bases: {py:obj}`Exception`

```{autodoc2-docstring} nexusLIMS.utils.cdcs.AuthenticationError
:parser: autodoc2_docstrings_parser
```

````

````{py:class} CDCSDataRecord()
:canonical: nexusLIMS.utils.cdcs.CDCSDataRecord

Bases: {py:obj}`typing.Dict`\[{py:obj}`str`\, {py:obj}`typing.Any`\]

```{autodoc2-docstring} nexusLIMS.utils.cdcs.CDCSDataRecord
:parser: autodoc2_docstrings_parser
```

````

````{py:function} get_cdcs_url() -> str
:canonical: nexusLIMS.utils.cdcs.get_cdcs_url

```{autodoc2-docstring} nexusLIMS.utils.cdcs.get_cdcs_url
:parser: autodoc2_docstrings_parser
```
````

````{py:function} get_workspace_id() -> int
:canonical: nexusLIMS.utils.cdcs.get_workspace_id

```{autodoc2-docstring} nexusLIMS.utils.cdcs.get_workspace_id
:parser: autodoc2_docstrings_parser
```
````

````{py:function} get_template_id() -> str
:canonical: nexusLIMS.utils.cdcs.get_template_id

```{autodoc2-docstring} nexusLIMS.utils.cdcs.get_template_id
:parser: autodoc2_docstrings_parser
```
````

````{py:function} delete_record(record_id: str)
:canonical: nexusLIMS.utils.cdcs.delete_record

```{autodoc2-docstring} nexusLIMS.utils.cdcs.delete_record
:parser: autodoc2_docstrings_parser
```
````

````{py:function} search_records(title: str | None = None, template_id: str | None = None, keyword: str | None = None) -> list[nexusLIMS.utils.cdcs.CDCSDataRecord]
:canonical: nexusLIMS.utils.cdcs.search_records

```{autodoc2-docstring} nexusLIMS.utils.cdcs.search_records
:parser: autodoc2_docstrings_parser
```
````

````{py:function} download_record(record_id: str) -> str
:canonical: nexusLIMS.utils.cdcs.download_record

```{autodoc2-docstring} nexusLIMS.utils.cdcs.download_record
:parser: autodoc2_docstrings_parser
```
````

````{py:function} upload_record_content(xml_content: str, title: str) -> tuple[typing.Any, int | None]
:canonical: nexusLIMS.utils.cdcs.upload_record_content

```{autodoc2-docstring} nexusLIMS.utils.cdcs.upload_record_content
:parser: autodoc2_docstrings_parser
```
````

````{py:function} upload_record_files(files_to_upload: typing.List[pathlib.Path] | None, *, progress: bool = False) -> tuple[typing.List[pathlib.Path], typing.List[int]]
:canonical: nexusLIMS.utils.cdcs.upload_record_files

```{autodoc2-docstring} nexusLIMS.utils.cdcs.upload_record_files
:parser: autodoc2_docstrings_parser
```
````