Page tree
Skip to end of metadata
Go to start of metadata

openBIS Service Facade

This is a facade which allow Java clients

  • to search for meta-data,
  • to upload/download data sets.

The JAR files of the generic DSS client distribution are needed to access openBIS via this facade.


The facade object is created by ch.systemsx.cisd.openbis.dss.client.api.v1.OpenbisServiceFacadeFactory. It creates an instance of ch.systemsx.cisd.openbis.dss.client.api.v1.IOpenbisServiceFacade which is an extension of ch.systemsx.cisd.openbis.dss.client.api.v1.ISimpleOpenbisServiceFacade .


The implementation of the inteface is here



IOpenbisServiceFacade facade = OpenbisServiceFacadeFactory.tryCreate("user", "password", "https://my-openbis", 60000); 
List<DataSet> dataSets = facade.listDataSetsForExperiments(Arrays.asList("/MY-SPACE/MY-PROJECT/MY-EXPERIMENT"));
for (DataSet dataSet : dataSets)

Use Enums in Jython
from java.util import EnumSet
from ch.systemsx.cisd.openbis.generic.shared.api.v1.dto import SampleFetchOption

def genInf(service):
  fetchOptions = EnumSet.of(SampleFetchOption.ANCESTORS, SampleFetchOption.PROPERTIES)
  sc = SearchCriteria();
  sc.addMatchClause(SearchCriteria.MatchClause.createAttributeMatch(SearchCriteria.MatchClauseAttribute.CODE, "C0Y3UACXX:C0Y3UACXX_S1"));
  dList = service.searchForSamples(sc, fetchOptions)
  • No labels