Skip to content

Commit f33c2cb

Browse files
author
sreeder
committed
add datasetsvalues docstrings
1 parent 91ee0c3 commit f33c2cb

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

odm2api/ODM2/services/readService.py

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -776,6 +776,30 @@ def getDataSetsResults(self, ids= None, codes=None, uuids=None, dstype=None):
776776
return None
777777

778778
def getDataSetsValues(self, ids=None, codes=None, uuids=None, dstype=None):
779+
"""
780+
Retrieve a list of datavalues associated with the given dataset info
781+
782+
**Must specify either DataSetID OR DataSetUUID OR DataSetCode)**
783+
Args:
784+
ids (list, optional): List of DataSetsIDs.
785+
codes (list, optional): List of DataSet Codes.
786+
uuids (list, optional): List of Dataset UUIDs string.
787+
dstype (str, optional): Type of Dataset from
788+
`controlled vocabulary name <http://vocabulary.odm2.org/datasettype/>`_.
789+
790+
791+
Returns:
792+
list: List of Result Values Objects
793+
794+
Examples:
795+
>>> READ = ReadODM2(SESSION_FACTORY)
796+
>>> READ.getDataSetsValues(ids=[39, 40])
797+
>>> READ.getDataSetsValues(codes=['HOME', 'FIELD'])
798+
>>> READ.getDataSetsValues(uuids=['a6f114f1-5416-4606-ae10-23be32dbc202',
799+
... '5396fdf3-ceb3-46b6-aaf9-454a37278bb4'])
800+
>>> READ.getDataSetsValues(dstype='singleTimeSeries')
801+
802+
"""
779803

780804
dsr = self.getDataSetsResults(ids, codes, uuids, dstype)
781805

0 commit comments

Comments
 (0)