Skip to content

plantdb_client

plantdb.client.plantdb_client Link

PlantDB Client Module

A client library for interacting with the PlantDB API, providing a streamlined interface for managing plant-related data including scans, filesets, and associated metadata.

Key Features
  • Scan Management: Create new scans and manage scan metadata
  • Fileset Operations: Create and manage collections of files associated with scans
  • File Handling: Upload and manage individual files within filesets
  • Metadata Management: Comprehensive CRUD operations for scan, fileset, and file metadata
  • RESTful Interface: Implements standard HTTP methods for API communication
Usage Examples

Start a test REST API server first:Link

$ fsdb_rest_api --testLink

from plantdb.client.plantdb_client import PlantDBClient from plantdb.client.rest_api import base_url client = PlantDBClient(base_url())

Create a new scanLink

scan_id = client.create_scan( ... name="Plant Sample 001", ... description="Arabidopsis specimen under controlled conditions" ... )

Create a fileset for the scanLink

fileset_id = client.create_fileset( ... scan_id=scan_id, ... name="RGB Images", ... description="Top view RGB images" ... )

PlantDBClient Link

PlantDBClient(base_url)

Client for interacting with the PlantDB REST API.

Source code in plantdb/client/plantdb_client.py 
46
47
48
def __init__(self, base_url):
    self.base_url = base_url
    self.session = requests.Session()

create_file Link

create_file(file_path, name, ext, scan_id, fileset_name, metadata=None)

Create a new file in a fileset and upload its data.

Parameters:

Name Type Description Default
file_path str or Path

Path to the file to upload

 required
name str

Name to give the file in the database

 required
ext str

File extension (must be one of the valid extensions)

 required
scan_id str

ID of the scan containing the fileset

 required
fileset_name str

Name of the fileset to create the file in

 required
metadata dict

Additional metadata for the file

 None

Returns:

Type Description
dict

Server response containing creation confirmation message

Raises:

Type Description
RequestException

If the request fails
ValueError

If required parameters are missing or invalid

Examples:

>>> # Start a test REST API server first:
>>> # $ fsdb_rest_api --test
>>> from plantdb.client.plantdb_client import PlantDBClient
>>> from plantdb.client.rest_api import base_url
>>> client = PlantDBClient(base_url())
>>> metadata = {'description': 'Test document', 'author': 'John Doe'}
>>> response = client.create_file(
...     'path/to/file.yaml',
...     name='new_file',
...     ext='yaml',
...     scan_id='real_plant',
...     fileset_name='images',
...     metadata=metadata
... )
>>> print(response)
{'message': "File 'new_file.yaml' created and written successfully in fileset 'images'."}
Source code in plantdb/client/plantdb_client.py 
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
def create_file(self, file_path, name, ext, scan_id, fileset_name, metadata=None):
    """Create a new file in a fileset and upload its data.

    Parameters
    ----------
    file_path : str or Path
        Path to the file to upload
    name : str
        Name to give the file in the database
    ext : str
        File extension (must be one of the valid extensions)
    scan_id : str
        ID of the scan containing the fileset
    fileset_name : str
        Name of the fileset to create the file in
    metadata : dict, optional
        Additional metadata for the file

    Returns
    -------
    dict
        Server response containing creation confirmation message

    Raises
    ------
    requests.exceptions.RequestException
        If the request fails
    ValueError
        If required parameters are missing or invalid

    Examples
    --------
    >>> # Start a test REST API server first:
    >>> # $ fsdb_rest_api --test
    >>> from plantdb.client.plantdb_client import PlantDBClient
    >>> from plantdb.client.rest_api import base_url
    >>> client = PlantDBClient(base_url())
    >>> metadata = {'description': 'Test document', 'author': 'John Doe'}
    >>> response = client.create_file(
    ...     'path/to/file.yaml',
    ...     name='new_file',
    ...     ext='yaml',
    ...     scan_id='real_plant',
    ...     fileset_name='images',
    ...     metadata=metadata
    ... )
    >>> print(response)
    {'message': "File 'new_file.yaml' created and written successfully in fileset 'images'."}
    """
    url = f"{self.base_url}/api/file"

    # Prepare form data
    data = {
        'name': name,
        'ext': ext.lstrip('.'),  # Remove leading dot if present
        'scan_id': scan_id,
        'fileset_name': fileset_name
    }

    # Add metadata if provided
    if metadata:
        data['metadata'] = json.dumps(metadata)

    # Prepare file data
    with open(file_path, 'rb') as file_handle:
        files = {
            'file': (os.path.basename(file_path), file_handle, 'application/octet-stream')
        }
        response = self.session.post(url, files=files, data=data)

    response.raise_for_status()
    return response.json()

create_fileset Link

create_fileset(name, scan_id, metadata=None)

Create a new fileset associated with a scan.

Parameters:

Name Type Description Default
name str

Name of the fileset to create

 required
scan_id str

ID of the scan to associate the fileset with

 required
metadata dict

Additional metadata for the fileset

 None

Returns:

Type Description
dict

Server response containing creation confirmation message

Raises:

Type Description
RequestException

If the request fails

Examples:

>>> # Start a test REST API server first:
>>> # $ fsdb_rest_api --test
>>> from plantdb.client.plantdb_client import PlantDBClient
>>> from plantdb.client.rest_api import base_url
>>> client = PlantDBClient(base_url())
>>> metadata = {'description': 'This is a test fileset'}
>>> response = client.create_fileset('my_fileset', 'real_plant', metadata=metadata)
>>> print(response)
{'message': "Fileset 'my_fileset' created successfully in 'real_plant'."}
Source code in plantdb/client/plantdb_client.py 
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
def create_fileset(self, name, scan_id, metadata=None):
    """Create a new fileset associated with a scan.

    Parameters
    ----------
    name : str
        Name of the fileset to create
    scan_id : str
        ID of the scan to associate the fileset with
    metadata : dict, optional
        Additional metadata for the fileset

    Returns
    -------
    dict
        Server response containing creation confirmation message

    Raises
    ------
    requests.exceptions.RequestException
        If the request fails

    Examples
    --------
    >>> # Start a test REST API server first:
    >>> # $ fsdb_rest_api --test
    >>> from plantdb.client.plantdb_client import PlantDBClient
    >>> from plantdb.client.rest_api import base_url
    >>> client = PlantDBClient(base_url())
    >>> metadata = {'description': 'This is a test fileset'}
    >>> response = client.create_fileset('my_fileset', 'real_plant', metadata=metadata)
    >>> print(response)
    {'message': "Fileset 'my_fileset' created successfully in 'real_plant'."}
    """
    url = f"{self.base_url}/api/fileset"
    data = {
        'name': name,
        'scan_id': scan_id
    }
    if metadata:
        data['metadata'] = metadata
    response = self.session.post(url, json=data)
    response.raise_for_status()
    return response.json()

create_scan Link

create_scan(name, metadata=None)

Create a new scan in the database.

Parameters:

Name Type Description Default
name str

Name of the scan to create

 required
metadata dict

Additional metadata for the scan

 None

Returns:

Type Description
dict

Server response containing creation confirmation message

Raises:

Type Description
RequestException

If the request fails

Examples:

>>> # Start a test REST API server first:
>>> # $ fsdb_rest_api --test
>>> from plantdb.client.plantdb_client import PlantDBClient
>>> from plantdb.client.rest_api import base_url
>>> client = PlantDBClient(base_url())
>>> metadata = {'description': 'Test plant scan'}
>>> response = client.create_scan('test_plant', metadata=metadata)
>>> print(response)
{'message': "Scan 'test_plant' created successfully."}
Source code in plantdb/client/plantdb_client.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
def create_scan(self, name, metadata=None):
    """Create a new scan in the database.

    Parameters
    ----------
    name : str
        Name of the scan to create
    metadata : dict, optional
        Additional metadata for the scan

    Returns
    -------
    dict
        Server response containing creation confirmation message

    Raises
    ------
    requests.exceptions.RequestException
        If the request fails

    Examples
    --------
    >>> # Start a test REST API server first:
    >>> # $ fsdb_rest_api --test
    >>> from plantdb.client.plantdb_client import PlantDBClient
    >>> from plantdb.client.rest_api import base_url
    >>> client = PlantDBClient(base_url())
    >>> metadata = {'description': 'Test plant scan'}
    >>> response = client.create_scan('test_plant', metadata=metadata)
    >>> print(response)
    {'message': "Scan 'test_plant' created successfully."}
    """
    url = f"{self.base_url}/api/scan"
    data = {'name': name}
    if metadata:
        data['metadata'] = metadata
    response = self.session.post(url, json=data)
    response.raise_for_status()
    return response.json()

get_file_metadata Link

get_file_metadata(scan_id, fileset_name, file_name, key=None)

Retrieve metadata for a specified file.

Parameters:

Name Type Description Default
scan_id str

The ID of the scan containing the fileset

 required
fileset_name str

The name of the fileset containing the file

 required
file_name str

The name of the file

 required
key str

If provided, returns only the value for this specific metadata key

 None

Returns:

Type Description
dict

Server response containing the metadata or specific key value

Raises:

Type Description
RequestException

If the request fails

Examples:

>>> # Start a test REST API server first:
>>> # $ fsdb_rest_api --test
>>> from plantdb.client.plantdb_client import PlantDBClient
>>> from plantdb.client.rest_api import base_url
>>> client = PlantDBClient(base_url())
>>> # Get all metadata
>>> metadata = client.get_file_metadata('test_plant', 'images', 'image_001')
>>> print(metadata)
{'metadata': {'description': 'Test file'}}
>>> # Get specific metadata key
>>> value = client.get_file_metadata('test_plant', 'images', 'image_001', key='description')
>>> print(value)
{'metadata': 'Test file'}
Source code in plantdb/client/plantdb_client.py 
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
def get_file_metadata(self, scan_id, fileset_name, file_name, key=None):
    """Retrieve metadata for a specified file.

    Parameters
    ----------
    scan_id : str
        The ID of the scan containing the fileset
    fileset_name : str
        The name of the fileset containing the file
    file_name : str
        The name of the file
    key : str, optional
        If provided, returns only the value for this specific metadata key

    Returns
    -------
    dict
        Server response containing the metadata or specific key value

    Raises
    ------
    requests.exceptions.RequestException
        If the request fails

    Examples
    --------
    >>> # Start a test REST API server first:
    >>> # $ fsdb_rest_api --test
    >>> from plantdb.client.plantdb_client import PlantDBClient
    >>> from plantdb.client.rest_api import base_url
    >>> client = PlantDBClient(base_url())
    >>> # Get all metadata
    >>> metadata = client.get_file_metadata('test_plant', 'images', 'image_001')
    >>> print(metadata)
    {'metadata': {'description': 'Test file'}}
    >>> # Get specific metadata key
    >>> value = client.get_file_metadata('test_plant', 'images', 'image_001', key='description')
    >>> print(value)
    {'metadata': 'Test file'}
    """
    url = f"{self.base_url}/api/file/{scan_id}/{fileset_name}/{file_name}/metadata"
    params = {'key': key} if key else None
    response = self.session.get(url, params=params)
    response.raise_for_status()
    return response.json()

get_fileset_metadata Link

get_fileset_metadata(scan_id, fileset_name, key=None)

Retrieve metadata for a specified fileset.

Parameters:

Name Type Description Default
scan_id str

The ID of the scan containing the fileset

 required
fileset_name str

The name of the fileset

 required
key str

If provided, returns only the value for this specific metadata key

 None

Returns:

Type Description
dict

Server response containing the metadata or specific key value

Raises:

Type Description
RequestException

If the request fails

Examples:

>>> # Start a test REST API server first:
>>> # $ fsdb_rest_api --test
>>> from plantdb.client.plantdb_client import PlantDBClient
>>> from plantdb.client.rest_api import base_url
>>> client = PlantDBClient(base_url())
>>> # Get all metadata
>>> metadata = client.get_fileset_metadata('real_plant', 'my_fileset')
>>> print(metadata)
{'metadata': {'description': 'This is a test fileset'}}
>>> # Get specific metadata key
>>> value = client.get_fileset_metadata('real_plant', 'my_fileset', key='description')
>>> print(value)
{'metadata': 'This is a test fileset'}
Source code in plantdb/client/plantdb_client.py 
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
def get_fileset_metadata(self, scan_id, fileset_name, key=None):
    """Retrieve metadata for a specified fileset.

    Parameters
    ----------
    scan_id : str
        The ID of the scan containing the fileset
    fileset_name : str
        The name of the fileset
    key : str, optional
        If provided, returns only the value for this specific metadata key

    Returns
    -------
    dict
        Server response containing the metadata or specific key value

    Raises
    ------
    requests.exceptions.RequestException
        If the request fails

    Examples
    --------
    >>> # Start a test REST API server first:
    >>> # $ fsdb_rest_api --test
    >>> from plantdb.client.plantdb_client import PlantDBClient
    >>> from plantdb.client.rest_api import base_url
    >>> client = PlantDBClient(base_url())
    >>> # Get all metadata
    >>> metadata = client.get_fileset_metadata('real_plant', 'my_fileset')
    >>> print(metadata)
    {'metadata': {'description': 'This is a test fileset'}}
    >>> # Get specific metadata key
    >>> value = client.get_fileset_metadata('real_plant', 'my_fileset', key='description')
    >>> print(value)
    {'metadata': 'This is a test fileset'}
    """
    url = f"{self.base_url}/api/fileset/{scan_id}/{fileset_name}/metadata"
    params = {'key': key} if key else None
    response = self.session.get(url, params=params)
    response.raise_for_status()
    return response.json()

get_scan_metadata Link

get_scan_metadata(scan_id, key=None)

Retrieve metadata for a specified scan.

Parameters:

Name Type Description Default
scan_id str

The ID of the scan

 required
key str

If provided, returns only the value for this specific metadata key

 None

Returns:

Type Description
dict

Server response containing the metadata or specific key value

Raises:

Type Description
RequestException

If the request fails

Examples:

>>> # Start a test REST API server first:
>>> # $ fsdb_rest_api --test
>>> from plantdb.client.plantdb_client import PlantDBClient
>>> from plantdb.client.rest_api import base_url
>>> client = PlantDBClient(base_url())
>>> # Get all metadata
>>> metadata = client.get_scan_metadata('test_plant')
>>> print(metadata)
{'metadata': {'owner': 'anonymous', 'description': 'Test plant scan'}}
>>> # Get specific metadata key
>>> value = client.get_scan_metadata('test_plant', key='description')
>>> print(value)
{'metadata': 'Test plant scan'}
Source code in plantdb/client/plantdb_client.py 
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
def get_scan_metadata(self, scan_id, key=None):
    """Retrieve metadata for a specified scan.

    Parameters
    ----------
    scan_id : str
        The ID of the scan
    key : str, optional
        If provided, returns only the value for this specific metadata key

    Returns
    -------
    dict
        Server response containing the metadata or specific key value

    Raises
    ------
    requests.exceptions.RequestException
        If the request fails

    Examples
    --------
    >>> # Start a test REST API server first:
    >>> # $ fsdb_rest_api --test
    >>> from plantdb.client.plantdb_client import PlantDBClient
    >>> from plantdb.client.rest_api import base_url
    >>> client = PlantDBClient(base_url())
    >>> # Get all metadata
    >>> metadata = client.get_scan_metadata('test_plant')
    >>> print(metadata)
    {'metadata': {'owner': 'anonymous', 'description': 'Test plant scan'}}
    >>> # Get specific metadata key
    >>> value = client.get_scan_metadata('test_plant', key='description')
    >>> print(value)
    {'metadata': 'Test plant scan'}
    """
    url = f"{self.base_url}/api/scan/{scan_id}/metadata"
    params = {'key': key} if key else None
    response = self.session.get(url, params=params)
    response.raise_for_status()
    return response.json()

list_fileset_files Link

list_fileset_files(scan_id, fileset_name, query=None, fuzzy=False)

List all files in a specified fileset.

Parameters:

Name Type Description Default
scan_id str

The ID of the scan containing the fileset

 required
fileset_name str

The name of the fileset

 required
query str

Query string to filter files

 None
fuzzy bool

Whether to use fuzzy matching for the query

 False

Returns:

Type Description
dict

Server response containing the list of files

Raises:

Type Description
RequestException

If the request fails

Examples:

>>> # Start a test REST API server first:
>>> # $ fsdb_rest_api --test
>>> from plantdb.client.plantdb_client import PlantDBClient
>>> from plantdb.client.rest_api import base_url
>>> client = PlantDBClient(base_url())
>>> response = client.list_fileset_files('real_plant', 'images')
>>> print(response)
{'files': ['00000_rgb', '00001_rgb', '00002_rgb', ...]}
Source code in plantdb/client/plantdb_client.py 
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
def list_fileset_files(self, scan_id, fileset_name, query=None, fuzzy=False):
    """List all files in a specified fileset.

    Parameters
    ----------
    scan_id : str
        The ID of the scan containing the fileset
    fileset_name : str
        The name of the fileset
    query : str, optional
        Query string to filter files
    fuzzy : bool, optional
        Whether to use fuzzy matching for the query

    Returns
    -------
    dict
        Server response containing the list of files

    Raises
    ------
    requests.exceptions.RequestException
        If the request fails

    Examples
    --------
    >>> # Start a test REST API server first:
    >>> # $ fsdb_rest_api --test
    >>> from plantdb.client.plantdb_client import PlantDBClient
    >>> from plantdb.client.rest_api import base_url
    >>> client = PlantDBClient(base_url())
    >>> response = client.list_fileset_files('real_plant', 'images')
    >>> print(response)
    {'files': ['00000_rgb', '00001_rgb', '00002_rgb', ...]}
    """
    url = f"{self.base_url}/api/fileset/{scan_id}/{fileset_name}/files"
    params = {}
    if query is not None:
        params['query'] = query
    if fuzzy:
        params['fuzzy'] = fuzzy
    response = self.session.get(url, params=params)
    response.raise_for_status()
    return response.json()

list_scan_filesets Link

list_scan_filesets(scan_id, query=None, fuzzy=False)

List all filesets in a specified scan.

Parameters:

Name Type Description Default
scan_id str

The ID of the scan

 required
query str

Query string to filter filesets

 None
fuzzy bool

Whether to use fuzzy matching for the query

 False

Returns:

Type Description
dict

Server response containing the list of fileset IDs

Raises:

Type Description
RequestException

If the request fails

Examples:

>>> # Start a test REST API server first:
>>> # $ fsdb_rest_api --test
>>> from plantdb.client.plantdb_client import PlantDBClient
>>> from plantdb.client.rest_api import base_url
>>> client = PlantDBClient(base_url())
>>> response = client.list_scan_filesets('real_plant')
>>> print(response)
{'filesets': ['images']}
Source code in plantdb/client/plantdb_client.py 
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
def list_scan_filesets(self, scan_id, query=None, fuzzy=False):
    """List all filesets in a specified scan.

    Parameters
    ----------
    scan_id : str
        The ID of the scan
    query : str, optional
        Query string to filter filesets
    fuzzy : bool, optional
        Whether to use fuzzy matching for the query

    Returns
    -------
    dict
        Server response containing the list of fileset IDs

    Raises
    ------
    requests.exceptions.RequestException
        If the request fails

    Examples
    --------
    >>> # Start a test REST API server first:
    >>> # $ fsdb_rest_api --test
    >>> from plantdb.client.plantdb_client import PlantDBClient
    >>> from plantdb.client.rest_api import base_url
    >>> client = PlantDBClient(base_url())
    >>> response = client.list_scan_filesets('real_plant')
    >>> print(response)
    {'filesets': ['images']}
    """
    url = f"{self.base_url}/api/scan/{scan_id}/filesets"
    params = {}
    if query is not None:
        params['query'] = query
    if fuzzy:
        params['fuzzy'] = fuzzy
    response = self.session.get(url, params=params)
    response.raise_for_status()
    return response.json()

update_file_metadata Link

update_file_metadata(scan_id, fileset_name, file_name, metadata, replace=False)

Update metadata for a specified file.

Parameters:

Name Type Description Default
scan_id str

The ID of the scan containing the fileset

 required
fileset_name str

The name of the fileset containing the file

 required
file_name str

The name of the file

 required
metadata dict

The metadata to update/set

 required
replace bool

If True, replaces entire metadata. If False (default), updates only specified keys.

 False

Returns:

Type Description
dict

Server response containing the updated metadata

Raises:

Type Description
RequestException

If the request fails

Examples:

>>> # Start a test REST API server first:
>>> # $ fsdb_rest_api --test
>>> from plantdb.client.plantdb_client import PlantDBClient
>>> from plantdb.client.rest_api import base_url
>>> client = PlantDBClient(base_url())
>>> # Update metadata
>>> new_metadata = {'description': 'Updated description'}
>>> response = client.update_file_metadata(
...     'test_plant',
...     'images',
...     'image_001',
...     new_metadata
... )
>>> print(response)
{'metadata': {'description': 'Updated description'}}
Source code in plantdb/client/plantdb_client.py 
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
def update_file_metadata(self, scan_id, fileset_name, file_name, metadata, replace=False):
    """Update metadata for a specified file.

    Parameters
    ----------
    scan_id : str
        The ID of the scan containing the fileset
    fileset_name : str
        The name of the fileset containing the file
    file_name : str
        The name of the file
    metadata : dict
        The metadata to update/set
    replace : bool, optional
        If True, replaces entire metadata. If False (default),
        updates only specified keys.

    Returns
    -------
    dict
        Server response containing the updated metadata

    Raises
    ------
    requests.exceptions.RequestException
        If the request fails

    Examples
    --------
    >>> # Start a test REST API server first:
    >>> # $ fsdb_rest_api --test
    >>> from plantdb.client.plantdb_client import PlantDBClient
    >>> from plantdb.client.rest_api import base_url
    >>> client = PlantDBClient(base_url())
    >>> # Update metadata
    >>> new_metadata = {'description': 'Updated description'}
    >>> response = client.update_file_metadata(
    ...     'test_plant',
    ...     'images',
    ...     'image_001',
    ...     new_metadata
    ... )
    >>> print(response)
    {'metadata': {'description': 'Updated description'}}
    """
    url = f"{self.base_url}/api/file/{scan_id}/{fileset_name}/{file_name}/metadata"
    data = {
        'metadata': metadata,
        'replace': replace
    }
    response = self.session.post(url, json=data)
    response.raise_for_status()
    return response.json()

update_fileset_metadata Link

update_fileset_metadata(scan_id, fileset_name, metadata, replace=False)

Update metadata for a specified fileset.

Parameters:

Name Type Description Default
scan_id str

The ID of the scan containing the fileset

 required
fileset_name str

The name of the fileset

 required
metadata dict

The metadata to update/set

 required
replace bool

If True, replaces entire metadata. If False (default), updates only specified keys.

 False

Returns:

Type Description
dict

Server response containing the updated metadata

Raises:

Type Description
RequestException

If the request fails

Examples:

>>> # Start a test REST API server first:
>>> # $ fsdb_rest_api --test
>>> from plantdb.client.plantdb_client import PlantDBClient
>>> from plantdb.client.rest_api import base_url
>>> client = PlantDBClient(base_url())
>>> # Update metadata
>>> new_metadata = {'description': 'Updated fileset description', 'author': 'John Doe'}
>>> response = client.update_fileset_metadata('real_plant', 'my_fileset', new_metadata)
>>> print(response)
{'metadata': {'description': 'Updated fileset description', 'author': 'John Doe'}}
Source code in plantdb/client/plantdb_client.py 
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
def update_fileset_metadata(self, scan_id, fileset_name, metadata, replace=False):
    """Update metadata for a specified fileset.

    Parameters
    ----------
    scan_id : str
        The ID of the scan containing the fileset
    fileset_name : str
        The name of the fileset
    metadata : dict
        The metadata to update/set
    replace : bool, optional
        If True, replaces entire metadata. If False (default),
        updates only specified keys.

    Returns
    -------
    dict
        Server response containing the updated metadata

    Raises
    ------
    requests.exceptions.RequestException
        If the request fails

    Examples
    --------
    >>> # Start a test REST API server first:
    >>> # $ fsdb_rest_api --test
    >>> from plantdb.client.plantdb_client import PlantDBClient
    >>> from plantdb.client.rest_api import base_url
    >>> client = PlantDBClient(base_url())
    >>> # Update metadata
    >>> new_metadata = {'description': 'Updated fileset description', 'author': 'John Doe'}
    >>> response = client.update_fileset_metadata('real_plant', 'my_fileset', new_metadata)
    >>> print(response)
    {'metadata': {'description': 'Updated fileset description', 'author': 'John Doe'}}
    """
    url = f"{self.base_url}/api/fileset/{scan_id}/{fileset_name}/metadata"
    data = {
        'metadata': metadata,
        'replace': replace
    }
    response = self.session.post(url, json=data)
    response.raise_for_status()
    return response.json()

update_scan_metadata Link

update_scan_metadata(scan_id, metadata, replace=False)

Update metadata for a specified scan.

Parameters:

Name Type Description Default
scan_id str

The ID of the scan to update metadata for

 required
metadata dict

The metadata to update/set

 required
replace bool

If True, replaces entire metadata. If False (default), updates only specified keys.

 False

Returns:

Type Description
dict

Server response containing the updated metadata

Raises:

Type Description
RequestException

If the request fails

Examples:

>>> # Start a test REST API server first:
>>> # $ fsdb_rest_api --test
>>> from plantdb.client.plantdb_client import PlantDBClient
>>> from plantdb.client.rest_api import base_url
>>> client = PlantDBClient(base_url())
>>> new_metadata = {'description': 'Updated scan description'}
>>> response = client.update_scan_metadata('test_plant', new_metadata)
>>> print(response)
{'metadata': {'owner': 'anonymous', 'description': 'Updated scan description'}}
Source code in plantdb/client/plantdb_client.py 
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
def update_scan_metadata(self, scan_id, metadata, replace=False):
    """Update metadata for a specified scan.

    Parameters
    ----------
    scan_id : str
        The ID of the scan to update metadata for
    metadata : dict
        The metadata to update/set
    replace : bool, optional
        If True, replaces entire metadata. If False (default),
        updates only specified keys.

    Returns
    -------
    dict
        Server response containing the updated metadata

    Raises
    ------
    requests.exceptions.RequestException
        If the request fails

    Examples
    --------
    >>> # Start a test REST API server first:
    >>> # $ fsdb_rest_api --test
    >>> from plantdb.client.plantdb_client import PlantDBClient
    >>> from plantdb.client.rest_api import base_url
    >>> client = PlantDBClient(base_url())
    >>> new_metadata = {'description': 'Updated scan description'}
    >>> response = client.update_scan_metadata('test_plant', new_metadata)
    >>> print(response)
    {'metadata': {'owner': 'anonymous', 'description': 'Updated scan description'}}
    """
    url = f"{self.base_url}/api/scan/{scan_id}/metadata"
    data = {
        'metadata': metadata,
        'replace': replace
    }
    response = self.session.post(url, json=data)
    response.raise_for_status()
    return response.json()