Interface IApplicationServerApi
-
- All Superinterfaces:
IRpcService
public interface IApplicationServerApi extends IRpcService
V3 application server API. Detailed documentation on how to use the API together code examples in both Java and Javascript can be found at "openBIS V3 API" openBIS WIKI page.The required access rights of the methods are the default ones. They can be configured with a capability-role map. For more details see "Installation and Administrator Guide of the openBIS Server" openBIS WIKI page.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
JSON_SERVICE_URL
static java.lang.String
SERVICE_NAME
Name of this service for which it is registered at the RPC name server.static java.lang.String
SERVICE_URL
Application part of the URL to access this service remotely.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
archiveDataSets(java.lang.String sessionToken, java.util.List<? extends IDataSetId> dataSetIds, DataSetArchiveOptions options)
Archives data sets with the providedIDataSetId
ids.void
confirmDeletions(java.lang.String sessionToken, java.util.List<? extends IDeletionId> deletionIds)
Confirms deletions with the providedIDeletionId
ids (i.e.java.util.List<AuthorizationGroupPermId>
createAuthorizationGroups(java.lang.String sessionToken, java.util.List<AuthorizationGroupCreation> newAuthorizationGroups)
Creates authorization groups basing on the providedAuthorizationGroupCreation
objects.java.util.List<java.lang.String>
createCodes(java.lang.String sessionToken, java.lang.String prefix, EntityKind entityKind, int count)
Generates identifiers that are unique for a given entity kind and consist of a prefix and a sequence generated number (e.g.java.util.List<DataSetPermId>
createDataSets(java.lang.String sessionToken, java.util.List<DataSetCreation> newDataSets)
Creates data sets basing on the providedDataSetCreation
objects.java.util.List<EntityTypePermId>
createDataSetTypes(java.lang.String sessionToken, java.util.List<DataSetTypeCreation> newDataSetTypes)
Creates data set types basing on the providedDataSetTypeCreation
objects.java.util.List<ExperimentPermId>
createExperiments(java.lang.String sessionToken, java.util.List<ExperimentCreation> newExperiments)
Creates experiments basing on the providedExperimentCreation
objects.java.util.List<EntityTypePermId>
createExperimentTypes(java.lang.String sessionToken, java.util.List<ExperimentTypeCreation> newExperimentTypes)
Creates experiment types basing on the providedExperimentTypeCreation
objects.java.util.List<ExternalDmsPermId>
createExternalDataManagementSystems(java.lang.String sessionToken, java.util.List<ExternalDmsCreation> newExternalDataManagementSystems)
Creates external data management systems basing on the providedExternalDmsCreation
objects.java.util.List<MaterialPermId>
createMaterials(java.lang.String sessionToken, java.util.List<MaterialCreation> newMaterials)
Creates materials basing on the providedMaterialCreation
objects.java.util.List<EntityTypePermId>
createMaterialTypes(java.lang.String sessionToken, java.util.List<MaterialTypeCreation> newMaterialTypes)
Creates material types basing on the providedMaterialTypeCreation
objects.java.util.List<java.lang.String>
createPermIdStrings(java.lang.String sessionToken, int count)
Generates globally unique identifiers that consist of a timestamp and a sequence generated number (e.g.java.util.List<PersonPermId>
createPersons(java.lang.String sessionToken, java.util.List<PersonCreation> newPersons)
Creates persons basing on the providedPersonCreation
objects.java.util.List<PluginPermId>
createPlugins(java.lang.String sessionToken, java.util.List<PluginCreation> newPlugins)
Creates plugins (i.e.java.util.List<ProjectPermId>
createProjects(java.lang.String sessionToken, java.util.List<ProjectCreation> newProjects)
Creates projects basing on the providedProjectCreation
objects.java.util.List<PropertyTypePermId>
createPropertyTypes(java.lang.String sessionToken, java.util.List<PropertyTypeCreation> newPropertyTypes)
Creates property types basing on the providedPropertyTypeCreation
objects.java.util.List<QueryTechId>
createQueries(java.lang.String sessionToken, java.util.List<QueryCreation> newQueries)
Creates queries basing on the providedQueryCreation
objects.java.util.List<RoleAssignmentTechId>
createRoleAssignments(java.lang.String sessionToken, java.util.List<RoleAssignmentCreation> newRoleAssignments)
Creates role assignments basing on the providedRoleAssignmentCreation
objects.java.util.List<SamplePermId>
createSamples(java.lang.String sessionToken, java.util.List<SampleCreation> newSamples)
Creates samples basing on the providedSampleCreation
objects.java.util.List<EntityTypePermId>
createSampleTypes(java.lang.String sessionToken, java.util.List<SampleTypeCreation> newSampleTypes)
Creates sample types basing on the providedSampleTypeCreation
objects.java.util.List<SemanticAnnotationPermId>
createSemanticAnnotations(java.lang.String sessionToken, java.util.List<SemanticAnnotationCreation> newAnnotations)
Creates semantic annotations basing on the providedSemanticAnnotationCreation
objects.java.util.List<SpacePermId>
createSpaces(java.lang.String sessionToken, java.util.List<SpaceCreation> newSpaces)
Creates spaces basing on the providedSpaceCreation
objects.java.util.List<TagPermId>
createTags(java.lang.String sessionToken, java.util.List<TagCreation> newTags)
Creates tags basing on the providedTagCreation
objects.java.util.List<VocabularyPermId>
createVocabularies(java.lang.String sessionToken, java.util.List<VocabularyCreation> newVocabularies)
Creates vocabularies and vocabulary terms (optionally) basing on the providedVocabularyCreation
objects.java.util.List<VocabularyTermPermId>
createVocabularyTerms(java.lang.String sessionToken, java.util.List<VocabularyTermCreation> newVocabularyTerms)
Creates vocabulary terms basing on the providedVocabularyTermCreation
objects.void
deleteAuthorizationGroups(java.lang.String sessionToken, java.util.List<? extends IAuthorizationGroupId> groupIds, AuthorizationGroupDeletionOptions deletionOptions)
Permanently deletes authorization groups with the providedIAuthorizationGroupId
ids.IDeletionId
deleteDataSets(java.lang.String sessionToken, java.util.List<? extends IDataSetId> dataSetIds, DataSetDeletionOptions deletionOptions)
Moves data sets with the providedIDataSetId
ids to trash.void
deleteDataSetTypes(java.lang.String sessionToken, java.util.List<? extends IEntityTypeId> dataSetTypeIds, DataSetTypeDeletionOptions deletionOptions)
Permanently deletes data set types with the providedIEntityTypeId
ids.IDeletionId
deleteExperiments(java.lang.String sessionToken, java.util.List<? extends IExperimentId> experimentIds, ExperimentDeletionOptions deletionOptions)
Moves experiments with the providedIExperimentId
ids to trash.void
deleteExperimentTypes(java.lang.String sessionToken, java.util.List<? extends IEntityTypeId> experimentTypeIds, ExperimentTypeDeletionOptions deletionOptions)
Permanently deletes experiment types with the providedIEntityTypeId
ids.void
deleteExternalDataManagementSystems(java.lang.String sessionToken, java.util.List<? extends IExternalDmsId> externalDmsIds, ExternalDmsDeletionOptions deletionOptions)
Permanently deletes external data management systems with the providedIExternalDmsId
ids.void
deleteMaterials(java.lang.String sessionToken, java.util.List<? extends IMaterialId> materialIds, MaterialDeletionOptions deletionOptions)
Permanently deletes materials with the providedIMaterialId
ids.void
deleteMaterialTypes(java.lang.String sessionToken, java.util.List<? extends IEntityTypeId> materialTypeIds, MaterialTypeDeletionOptions deletionOptions)
Permanently deletes material types with the providedIEntityTypeId
ids.void
deleteOperationExecutions(java.lang.String sessionToken, java.util.List<? extends IOperationExecutionId> executionIds, OperationExecutionDeletionOptions deletionOptions)
Permanently deletes operation executions with the providedIOperationExecutionId
ids.void
deletePersons(java.lang.String sessionToken, java.util.List<? extends IPersonId> personIds, PersonDeletionOptions deletionOptions)
Permanently deletes persons with the providedIPersonId
ids.void
deletePlugins(java.lang.String sessionToken, java.util.List<? extends IPluginId> pluginIds, PluginDeletionOptions deletionOptions)
Permanently deletes plugins (i.e.void
deleteProjects(java.lang.String sessionToken, java.util.List<? extends IProjectId> projectIds, ProjectDeletionOptions deletionOptions)
Permanently deletes projects with the providedIProjectId
ids.void
deletePropertyTypes(java.lang.String sessionToken, java.util.List<? extends IPropertyTypeId> propertyTypeIds, PropertyTypeDeletionOptions deletionOptions)
Permanently deletes property types with the providedIPropertyTypeId
ids.void
deleteQueries(java.lang.String sessionToken, java.util.List<? extends IQueryId> queryIds, QueryDeletionOptions deletionOptions)
Permanently deletes queries with the providedIQueryId
ids.void
deleteRoleAssignments(java.lang.String sessionToken, java.util.List<? extends IRoleAssignmentId> assignmentIds, RoleAssignmentDeletionOptions deletionOptions)
Permanently deletes role assignments with the providedIRoleAssignmentId
ids.IDeletionId
deleteSamples(java.lang.String sessionToken, java.util.List<? extends ISampleId> sampleIds, SampleDeletionOptions deletionOptions)
Moves samples with the providedISampleId
ids to trash.void
deleteSampleTypes(java.lang.String sessionToken, java.util.List<? extends IEntityTypeId> sampleTypeIds, SampleTypeDeletionOptions deletionOptions)
Permanently deletes sample types with the providedIEntityTypeId
ids.void
deleteSemanticAnnotations(java.lang.String sessionToken, java.util.List<? extends ISemanticAnnotationId> annotationIds, SemanticAnnotationDeletionOptions deletionOptions)
Permanently deletes semantic annotations with the providedISemanticAnnotationId
ids.void
deleteSpaces(java.lang.String sessionToken, java.util.List<? extends ISpaceId> spaceIds, SpaceDeletionOptions deletionOptions)
Permanently deletes spaces with the providedISpaceId
ids.void
deleteTags(java.lang.String sessionToken, java.util.List<? extends ITagId> tagIds, TagDeletionOptions deletionOptions)
Permanently deletes tags with the providedITagId
ids.void
deleteVocabularies(java.lang.String sessionToken, java.util.List<? extends IVocabularyId> ids, VocabularyDeletionOptions deletionOptions)
Permanently deletes vocabularies with the providedIVocabularyId
ids.void
deleteVocabularyTerms(java.lang.String sessionToken, java.util.List<? extends IVocabularyTermId> termIds, VocabularyTermDeletionOptions deletionOptions)
Permanently deletes vocabulary terms with the providedIVocabularyTermId
ids.PluginEvaluationResult
evaluatePlugin(java.lang.String sessionToken, PluginEvaluationOptions options)
Evaluates the provided plugin (e.g.TableModel
executeAggregationService(java.lang.String sessionToken, IDssServiceId serviceId, AggregationServiceExecutionOptions options)
Executes an aggregation service with the providedIDssServiceId
id.java.lang.Object
executeCustomASService(java.lang.String sessionToken, ICustomASServiceId serviceId, CustomASServiceExecutionOptions options)
Executes a custom application server service with the providedICustomASServiceId
id.IOperationExecutionResults
executeOperations(java.lang.String sessionToken, java.util.List<? extends IOperation> operations, IOperationExecutionOptions options)
Executes all provided operations in one transaction.void
executeProcessingService(java.lang.String sessionToken, IDssServiceId serviceId, ProcessingServiceExecutionOptions options)
Executes a processing service with the providedIDssServiceId
id.TableModel
executeQuery(java.lang.String sessionToken, IQueryId queryId, QueryExecutionOptions options)
Executes a query with the providedIQueryId
id.TableModel
executeReportingService(java.lang.String sessionToken, IDssServiceId serviceId, ReportingServiceExecutionOptions options)
Executes a reporting service with the providedIDssServiceId
id.SearchResult<SearchDomainServiceExecutionResult>
executeSearchDomainService(java.lang.String sessionToken, SearchDomainServiceExecutionOptions options)
Executes a search domain service.TableModel
executeSql(java.lang.String sessionToken, java.lang.String sql, SqlExecutionOptions options)
Executes the provided SQL.java.util.Map<IAuthorizationGroupId,AuthorizationGroup>
getAuthorizationGroups(java.lang.String sessionToken, java.util.List<? extends IAuthorizationGroupId> groupIds, AuthorizationGroupFetchOptions fetchOptions)
Gets authorization groups for the providedIAuthorizationGroupId
ids.java.util.Map<IDataSetId,DataSet>
getDataSets(java.lang.String sessionToken, java.util.List<? extends IDataSetId> dataSetIds, DataSetFetchOptions fetchOptions)
Gets data sets for the providedIDataSetId
ids.java.util.Map<IEntityTypeId,DataSetType>
getDataSetTypes(java.lang.String sessionToken, java.util.List<? extends IEntityTypeId> dataSetTypeIds, DataSetTypeFetchOptions fetchOptions)
Gets data set types for the providedIEntityTypeId
ids.java.util.Map<IExperimentId,Experiment>
getExperiments(java.lang.String sessionToken, java.util.List<? extends IExperimentId> experimentIds, ExperimentFetchOptions fetchOptions)
Gets experiments for the providedIExperimentId
ids.java.util.Map<IEntityTypeId,ExperimentType>
getExperimentTypes(java.lang.String sessionToken, java.util.List<? extends IEntityTypeId> experimentTypeIds, ExperimentTypeFetchOptions fetchOptions)
Gets experiment types for the providedIEntityTypeId
ids.java.util.Map<IExternalDmsId,ExternalDms>
getExternalDataManagementSystems(java.lang.String sessionToken, java.util.List<? extends IExternalDmsId> externalDmsIds, ExternalDmsFetchOptions fetchOptions)
Gets external data management systems for the providedIExternalDmsId
ids.java.util.Map<IMaterialId,Material>
getMaterials(java.lang.String sessionToken, java.util.List<? extends IMaterialId> materialIds, MaterialFetchOptions fetchOptions)
Gets materials for the providedIMaterialId
ids.java.util.Map<IEntityTypeId,MaterialType>
getMaterialTypes(java.lang.String sessionToken, java.util.List<? extends IEntityTypeId> materialTypeIds, MaterialTypeFetchOptions fetchOptions)
Gets material types for the providedIEntityTypeId
ids.java.util.Map<IOperationExecutionId,OperationExecution>
getOperationExecutions(java.lang.String sessionToken, java.util.List<? extends IOperationExecutionId> executionIds, OperationExecutionFetchOptions fetchOptions)
Gets operation executions for the providedIOperationExecutionId
ids.java.util.Map<IPersonId,Person>
getPersons(java.lang.String sessionToken, java.util.List<? extends IPersonId> ids, PersonFetchOptions fetchOptions)
Gets persons for the providedIPersonId
ids.java.util.Map<IPluginId,Plugin>
getPlugins(java.lang.String sessionToken, java.util.List<? extends IPluginId> pluginIds, PluginFetchOptions fetchOptions)
Gets plugins (i.e.java.util.Map<IProjectId,Project>
getProjects(java.lang.String sessionToken, java.util.List<? extends IProjectId> projectIds, ProjectFetchOptions fetchOptions)
Gets projects for the providedIProjectId
ids.java.util.Map<IPropertyTypeId,PropertyType>
getPropertyTypes(java.lang.String sessionToken, java.util.List<? extends IPropertyTypeId> typeIds, PropertyTypeFetchOptions fetchOptions)
Gets property types for the providedIPropertyTypeId
ids.java.util.Map<IQueryId,Query>
getQueries(java.lang.String sessionToken, java.util.List<? extends IQueryId> queryIds, QueryFetchOptions fetchOptions)
Gets queries for the providedIQueryId
ids.java.util.Map<IQueryDatabaseId,QueryDatabase>
getQueryDatabases(java.lang.String sessionToken, java.util.List<? extends IQueryDatabaseId> queryDatabaseIds, QueryDatabaseFetchOptions fetchOptions)
Gets query databases for the providedIQueryDatabaseId
ids.java.util.Map<IObjectId,Rights>
getRights(java.lang.String sessionToken, java.util.List<? extends IObjectId> ids, RightsFetchOptions fetchOptions)
Gets authorization rights for the providedIObjectId
ids.java.util.Map<IRoleAssignmentId,RoleAssignment>
getRoleAssignments(java.lang.String sessionToken, java.util.List<? extends IRoleAssignmentId> ids, RoleAssignmentFetchOptions fetchOptions)
Gets role assignments for the providedIRoleAssignmentId
ids.java.util.Map<ISampleId,Sample>
getSamples(java.lang.String sessionToken, java.util.List<? extends ISampleId> sampleIds, SampleFetchOptions fetchOptions)
Gets samples for the providedISampleId
ids.java.util.Map<IEntityTypeId,SampleType>
getSampleTypes(java.lang.String sessionToken, java.util.List<? extends IEntityTypeId> sampleTypeIds, SampleTypeFetchOptions fetchOptions)
Gets sample types for the providedIEntityTypeId
ids.java.util.Map<ISemanticAnnotationId,SemanticAnnotation>
getSemanticAnnotations(java.lang.String sessionToken, java.util.List<? extends ISemanticAnnotationId> annotationIds, SemanticAnnotationFetchOptions fetchOptions)
Gets semantic annotations for the providedISemanticAnnotationId
ids.java.util.Map<java.lang.String,java.lang.String>
getServerInformation(java.lang.String sessionToken)
Returns a map with additional server information: api-version : major and minor version of the API (e.g.java.util.Map<java.lang.String,java.lang.String>
getServerPublicInformation()
Returns a map with additional server public information: authentication-service : currently used authenticated service (e.g.SessionInformation
getSessionInformation(java.lang.String sessionToken)
Returns detailed information about a user's session.java.util.Map<ISpaceId,Space>
getSpaces(java.lang.String sessionToken, java.util.List<? extends ISpaceId> spaceIds, SpaceFetchOptions fetchOptions)
Gets spaces for the providedISpaceId
ids.java.util.Map<ITagId,Tag>
getTags(java.lang.String sessionToken, java.util.List<? extends ITagId> tagIds, TagFetchOptions fetchOptions)
Gets tags for the providedITagId
ids.java.util.Map<IVocabularyId,Vocabulary>
getVocabularies(java.lang.String sessionToken, java.util.List<? extends IVocabularyId> vocabularyIds, VocabularyFetchOptions fetchOptions)
Gets vocabularies for the providedIVocabularyId
ids.java.util.Map<IVocabularyTermId,VocabularyTerm>
getVocabularyTerms(java.lang.String sessionToken, java.util.List<? extends IVocabularyTermId> vocabularyTermIds, VocabularyTermFetchOptions fetchOptions)
Gets vocabulary terms for the providedIVocabularyTermId
ids.boolean
isSessionActive(java.lang.String sessionToken)
Returns true if a user's session is active.void
lockDataSets(java.lang.String sessionToken, java.util.List<? extends IDataSetId> dataSetIds, DataSetLockOptions options)
Locks data sets with the providedIDataSetId
ids.java.lang.String
login(java.lang.String userId, java.lang.String password)
Authenticates a user basing on the provided user id and password.java.lang.String
loginAs(java.lang.String userId, java.lang.String password, java.lang.String asUserId)
Authenticates a user basing on the provided user id and password and makes the session look like as if it was a different user.java.lang.String
loginAsAnonymousUser()
Authenticates as an anonymous user who does not require a password.void
logout(java.lang.String sessionToken)
Terminates a user's session.void
revertDeletions(java.lang.String sessionToken, java.util.List<? extends IDeletionId> deletionIds)
Reverts deletions with the providedIDeletionId
ids (i.e.SearchResult<AggregationService>
searchAggregationServices(java.lang.String sessionToken, AggregationServiceSearchCriteria searchCriteria, AggregationServiceFetchOptions fetchOptions)
Searches for aggregation services basing on the providedAggregationServiceSearchCriteria
.SearchResult<AuthorizationGroup>
searchAuthorizationGroups(java.lang.String sessionToken, AuthorizationGroupSearchCriteria searchCriteria, AuthorizationGroupFetchOptions fetchOptions)
Searches for authorization groups basing on the providedAuthorizationGroupSearchCriteria
.SearchResult<CustomASService>
searchCustomASServices(java.lang.String sessionToken, CustomASServiceSearchCriteria searchCriteria, CustomASServiceFetchOptions fetchOptions)
Searches for custom application server services basing on the providedCustomASServiceSearchCriteria
.SearchResult<DataSet>
searchDataSets(java.lang.String sessionToken, DataSetSearchCriteria searchCriteria, DataSetFetchOptions fetchOptions)
Searches for data sets basing on the providedDataSetSearchCriteria
.SearchResult<DataSetType>
searchDataSetTypes(java.lang.String sessionToken, DataSetTypeSearchCriteria searchCriteria, DataSetTypeFetchOptions fetchOptions)
Searches for data set types basing on the providedDataSetTypeSearchCriteria
.SearchResult<DataStore>
searchDataStores(java.lang.String sessionToken, DataStoreSearchCriteria searchCriteria, DataStoreFetchOptions fetchOptions)
Searches for data stores basing on the providedDataStoreSearchCriteria
.SearchResult<Deletion>
searchDeletions(java.lang.String sessionToken, DeletionSearchCriteria searchCriteria, DeletionFetchOptions fetchOptions)
Searches for deletions basing on the providedDeletionSearchCriteria
.SearchResult<Event>
searchEvents(java.lang.String sessionToken, EventSearchCriteria searchCriteria, EventFetchOptions fetchOptions)
Searches for events basing on the providedEventSearchCriteria
.SearchResult<Experiment>
searchExperiments(java.lang.String sessionToken, ExperimentSearchCriteria searchCriteria, ExperimentFetchOptions fetchOptions)
Searches for experiments basing on the providedExperimentSearchCriteria
.SearchResult<ExperimentType>
searchExperimentTypes(java.lang.String sessionToken, ExperimentTypeSearchCriteria searchCriteria, ExperimentTypeFetchOptions fetchOptions)
Searches for experiment types basing on the providedExperimentTypeSearchCriteria
.SearchResult<ExternalDms>
searchExternalDataManagementSystems(java.lang.String sessionToken, ExternalDmsSearchCriteria searchCriteria, ExternalDmsFetchOptions fetchOptions)
Searches for external data management systems basing on the providedExternalDmsSearchCriteria
.SearchResult<GlobalSearchObject>
searchGlobally(java.lang.String sessionToken, GlobalSearchCriteria searchCriteria, GlobalSearchObjectFetchOptions fetchOptions)
Searches for experiments, samples, data sets and materials at once basing on the providedGlobalSearchCriteria
.SearchResult<Material>
searchMaterials(java.lang.String sessionToken, MaterialSearchCriteria searchCriteria, MaterialFetchOptions fetchOptions)
Searches for materials basing on the providedMaterialSearchCriteria
.SearchResult<MaterialType>
searchMaterialTypes(java.lang.String sessionToken, MaterialTypeSearchCriteria searchCriteria, MaterialTypeFetchOptions fetchOptions)
Searches for material types basing on the providedMaterialTypeSearchCriteria
.SearchResult<ObjectKindModification>
searchObjectKindModifications(java.lang.String sessionToken, ObjectKindModificationSearchCriteria searchCriteria, ObjectKindModificationFetchOptions fetchOptions)
Searches for object kind modifications basing on the providedObjectKindModificationSearchCriteria
.SearchResult<OperationExecution>
searchOperationExecutions(java.lang.String sessionToken, OperationExecutionSearchCriteria searchCriteria, OperationExecutionFetchOptions fetchOptions)
Searches for operation executions basing on the providedOperationExecutionSearchCriteria
.SearchResult<Person>
searchPersons(java.lang.String sessionToken, PersonSearchCriteria searchCriteria, PersonFetchOptions fetchOptions)
Searches for persons basing on the providedPersonSearchCriteria
.SearchResult<Plugin>
searchPlugins(java.lang.String sessionToken, PluginSearchCriteria searchCriteria, PluginFetchOptions fetchOptions)
Searches for plugins (i.e.SearchResult<ProcessingService>
searchProcessingServices(java.lang.String sessionToken, ProcessingServiceSearchCriteria searchCriteria, ProcessingServiceFetchOptions fetchOptions)
Searches for processing services basing on the providedProcessingServiceSearchCriteria
.SearchResult<Project>
searchProjects(java.lang.String sessionToken, ProjectSearchCriteria searchCriteria, ProjectFetchOptions fetchOptions)
Searches for projects basing on the providedProjectSearchCriteria
.SearchResult<PropertyAssignment>
searchPropertyAssignments(java.lang.String sessionToken, PropertyAssignmentSearchCriteria searchCriteria, PropertyAssignmentFetchOptions fetchOptions)
Searches for property assignments basing on the providedPropertyAssignmentSearchCriteria
.SearchResult<PropertyType>
searchPropertyTypes(java.lang.String sessionToken, PropertyTypeSearchCriteria searchCriteria, PropertyTypeFetchOptions fetchOptions)
Searches for property types basing on the providedPropertyTypeSearchCriteria
.SearchResult<Query>
searchQueries(java.lang.String sessionToken, QuerySearchCriteria searchCriteria, QueryFetchOptions fetchOptions)
Searches for queries basing on the providedQuerySearchCriteria
.SearchResult<QueryDatabase>
searchQueryDatabases(java.lang.String sessionToken, QueryDatabaseSearchCriteria searchCriteria, QueryDatabaseFetchOptions fetchOptions)
Searches for query databases basing on the providedQueryDatabaseSearchCriteria
.SearchResult<ReportingService>
searchReportingServices(java.lang.String sessionToken, ReportingServiceSearchCriteria searchCriteria, ReportingServiceFetchOptions fetchOptions)
Searches for reporting services basing on the providedReportingServiceSearchCriteria
.SearchResult<RoleAssignment>
searchRoleAssignments(java.lang.String sessionToken, RoleAssignmentSearchCriteria searchCriteria, RoleAssignmentFetchOptions fetchOptions)
Searches for role assignments basing on the providedRoleAssignmentSearchCriteria
.SearchResult<Sample>
searchSamples(java.lang.String sessionToken, SampleSearchCriteria searchCriteria, SampleFetchOptions fetchOptions)
Searches for samples basing on the providedSampleSearchCriteria
.SearchResult<SampleType>
searchSampleTypes(java.lang.String sessionToken, SampleTypeSearchCriteria searchCriteria, SampleTypeFetchOptions fetchOptions)
Searches for sample types basing on the providedSampleTypeSearchCriteria
.SearchResult<SearchDomainService>
searchSearchDomainServices(java.lang.String sessionToken, SearchDomainServiceSearchCriteria searchCriteria, SearchDomainServiceFetchOptions fetchOptions)
Searches for search domain services basing on the providedSearchDomainServiceSearchCriteria
.SearchResult<SemanticAnnotation>
searchSemanticAnnotations(java.lang.String sessionToken, SemanticAnnotationSearchCriteria searchCriteria, SemanticAnnotationFetchOptions fetchOptions)
Searches for semantic annotations basing on the providedSemanticAnnotationSearchCriteria
.SearchResult<Space>
searchSpaces(java.lang.String sessionToken, SpaceSearchCriteria searchCriteria, SpaceFetchOptions fetchOptions)
Searches for spaces basing on the providedSpaceSearchCriteria
.SearchResult<Tag>
searchTags(java.lang.String sessionToken, TagSearchCriteria searchCriteria, TagFetchOptions fetchOptions)
Searches for tags basing on the providedTagSearchCriteria
.SearchResult<Vocabulary>
searchVocabularies(java.lang.String sessionToken, VocabularySearchCriteria searchCriteria, VocabularyFetchOptions fetchOptions)
Searches for vocabularies basing on the providedVocabularySearchCriteria
.SearchResult<VocabularyTerm>
searchVocabularyTerms(java.lang.String sessionToken, VocabularyTermSearchCriteria searchCriteria, VocabularyTermFetchOptions fetchOptions)
Searches for vocabulary terms basing on the providedVocabularyTermSearchCriteria
.void
unarchiveDataSets(java.lang.String sessionToken, java.util.List<? extends IDataSetId> dataSetIds, DataSetUnarchiveOptions options)
Unarchives data sets with the providedIDataSetId
ids.void
unlockDataSets(java.lang.String sessionToken, java.util.List<? extends IDataSetId> dataSetIds, DataSetUnlockOptions options)
Unlocks data sets with the providedIDataSetId
ids.void
updateAuthorizationGroups(java.lang.String sessionToken, java.util.List<AuthorizationGroupUpdate> authorizationGroupUpdates)
Updates authorization groups basing on the providedAuthorizationGroupUpdate
objects.void
updateDataSets(java.lang.String sessionToken, java.util.List<DataSetUpdate> dataSetUpdates)
Updates data sets basing on the providedDataSetUpdate
objects.void
updateDataSetTypes(java.lang.String sessionToken, java.util.List<DataSetTypeUpdate> dataSetTypeUpdates)
Updates data set types basing on the providedDataSetTypeUpdate
objects.void
updateExperiments(java.lang.String sessionToken, java.util.List<ExperimentUpdate> experimentUpdates)
Updates experiments basing on the providedExperimentUpdate
objects.void
updateExperimentTypes(java.lang.String sessionToken, java.util.List<ExperimentTypeUpdate> experimentTypeUpdates)
Updates experiment types basing on the providedExperimentTypeUpdate
objects.void
updateExternalDataManagementSystems(java.lang.String sessionToken, java.util.List<ExternalDmsUpdate> externalDmsUpdates)
Updates external data management systems basing on the providedExternalDmsUpdate
objects.void
updateMaterials(java.lang.String sessionToken, java.util.List<MaterialUpdate> materialUpdates)
Updates materials basing on the providedMaterialUpdate
objects.void
updateMaterialTypes(java.lang.String sessionToken, java.util.List<MaterialTypeUpdate> materialTypeUpdates)
Updates material types basing on the providedMaterialTypeUpdate
objects.void
updateOperationExecutions(java.lang.String sessionToken, java.util.List<OperationExecutionUpdate> executionUpdates)
Updates operation executions basing on the providedOperationExecutionUpdate
objects.void
updatePersons(java.lang.String sessionToken, java.util.List<PersonUpdate> personUpdates)
Updates persons basing on the providedPersonUpdate
objects.void
updatePlugins(java.lang.String sessionToken, java.util.List<PluginUpdate> pluginUpdates)
Updates plugins (i.e.void
updateProjects(java.lang.String sessionToken, java.util.List<ProjectUpdate> projectUpdates)
Updates projects basing on the providedProjectUpdate
objects.void
updatePropertyTypes(java.lang.String sessionToken, java.util.List<PropertyTypeUpdate> propertyTypeUpdates)
Updates property types basing on the providedPropertyTypeUpdate
objects.void
updateQueries(java.lang.String sessionToken, java.util.List<QueryUpdate> queryUpdates)
Updates queries basing on the providedQueryUpdate
objects.void
updateSamples(java.lang.String sessionToken, java.util.List<SampleUpdate> sampleUpdates)
Updates samples basing on the providedSampleUpdate
objects.void
updateSampleTypes(java.lang.String sessionToken, java.util.List<SampleTypeUpdate> sampleTypeUpdates)
Updates sample types basing on the providedSampleTypeUpdate
objects.void
updateSemanticAnnotations(java.lang.String sessionToken, java.util.List<SemanticAnnotationUpdate> annotationUpdates)
Updates semantic annotations basing on the providedSemanticAnnotationUpdate
objects.void
updateSpaces(java.lang.String sessionToken, java.util.List<SpaceUpdate> spaceUpdates)
Updates spaces basing on the providedSpaceUpdate
objects.void
updateTags(java.lang.String sessionToken, java.util.List<TagUpdate> tagUpdates)
Updates tags basing on the providedTagUpdate
objects.void
updateVocabularies(java.lang.String sessionToken, java.util.List<VocabularyUpdate> vocabularyUpdates)
Updates vocabularies basing on the providedVocabularyUpdate
objects.void
updateVocabularyTerms(java.lang.String sessionToken, java.util.List<VocabularyTermUpdate> vocabularyTermUpdates)
Updates vocabulary terms basing on the providedVocabularyTermUpdate
objects.-
Methods inherited from interface ch.systemsx.cisd.common.api.IRpcService
getMajorVersion, getMinorVersion
-
-
-
-
Field Detail
-
SERVICE_NAME
static final java.lang.String SERVICE_NAME
Name of this service for which it is registered at the RPC name server.- See Also:
- Constant Field Values
-
SERVICE_URL
static final java.lang.String SERVICE_URL
Application part of the URL to access this service remotely.- See Also:
- Constant Field Values
-
JSON_SERVICE_URL
static final java.lang.String JSON_SERVICE_URL
- See Also:
- Constant Field Values
-
-
Method Detail
-
login
java.lang.String login(java.lang.String userId, java.lang.String password)
Authenticates a user basing on the provided user id and password. If the authentication is successful, then returns a session token. Otherwise returns null.- Throws:
UserFailureException
- in case of any problems
-
loginAs
java.lang.String loginAs(java.lang.String userId, java.lang.String password, java.lang.String asUserId)
Authenticates a user basing on the provided user id and password and makes the session look like as if it was a different user. If the authentication is successful, then returns a session token. Otherwise returns null. The provided user id and password must represent anINSTANCE_ADMIN
account.- Throws:
UserFailureException
- in case of any problems
-
loginAsAnonymousUser
java.lang.String loginAsAnonymousUser()
Authenticates as an anonymous user who does not require a password.- Throws:
UserFailureException
- in case of any problems
-
logout
void logout(java.lang.String sessionToken)
Terminates a user's session.- Throws:
UserFailureException
- in case of any problems
-
getSessionInformation
SessionInformation getSessionInformation(java.lang.String sessionToken)
Returns detailed information about a user's session.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
isSessionActive
boolean isSessionActive(java.lang.String sessionToken)
Returns true if a user's session is active. Otherwise returns false.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
createSpaces
java.util.List<SpacePermId> createSpaces(java.lang.String sessionToken, java.util.List<SpaceCreation> newSpaces)
Creates spaces basing on the providedSpaceCreation
objects. Returns ids of the newly created spaces where nth id corresponds to nth creation object.Required access rights:
SPACE_ADMIN
or stronger- Throws:
UserFailureException
- in case of any problems, e.g. incorrectSpaceCreation
objects, insufficient access rights etc.
-
createProjects
java.util.List<ProjectPermId> createProjects(java.lang.String sessionToken, java.util.List<ProjectCreation> newProjects)
Creates projects basing on the providedProjectCreation
objects. Returns ids of the newly created projects where nth id corresponds to nth creation object.Required access rights:
SPACE_POWER_USER
or stronger- Throws:
UserFailureException
- in case of any problems, e.g. incorrectProjectCreation
objects, insufficient access rights etc.
-
createExperiments
java.util.List<ExperimentPermId> createExperiments(java.lang.String sessionToken, java.util.List<ExperimentCreation> newExperiments)
Creates experiments basing on the providedExperimentCreation
objects. Returns ids of the newly created experiments where nth id corresponds to nth creation object.Required access rights:
PROJECT_USER
or stronger- Throws:
UserFailureException
- in case of any problems, e.g. incorrectExperimentCreation
objects, insufficient access rights etc.
-
createExperimentTypes
java.util.List<EntityTypePermId> createExperimentTypes(java.lang.String sessionToken, java.util.List<ExperimentTypeCreation> newExperimentTypes)
Creates experiment types basing on the providedExperimentTypeCreation
objects. Returns ids of the newly created experiment types where nth id corresponds to nth creation object.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems, e.g. incorrectExperimentTypeCreation
objects, insufficient access rights etc.
-
createSamples
java.util.List<SamplePermId> createSamples(java.lang.String sessionToken, java.util.List<SampleCreation> newSamples)
Creates samples basing on the providedSampleCreation
objects. Returns ids of the newly created samples where nth id corresponds to nth creation object.Required access rights:
PROJECT_USER
or stronger- Throws:
UserFailureException
- in case of any problems, e.g. incorrectSampleCreation
objects, insufficient access rights etc.
-
createSampleTypes
java.util.List<EntityTypePermId> createSampleTypes(java.lang.String sessionToken, java.util.List<SampleTypeCreation> newSampleTypes)
Creates sample types basing on the providedSampleTypeCreation
objects. Returns ids of the newly created sample types where nth id corresponds to nth creation object.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems, e.g. incorrectSampleTypeCreation
objects, insufficient access rights etc.
-
createDataSets
java.util.List<DataSetPermId> createDataSets(java.lang.String sessionToken, java.util.List<DataSetCreation> newDataSets)
Creates data sets basing on the providedDataSetCreation
objects. Returns ids of the newly created data sets where nth id corresponds to nth creation object.Required access rights:
SPACE_ETL_SERVER
or stronger- Throws:
UserFailureException
- in case of any problems, e.g. incorrectDataSetCreation
objects, insufficient access rights etc.
-
createDataSetTypes
java.util.List<EntityTypePermId> createDataSetTypes(java.lang.String sessionToken, java.util.List<DataSetTypeCreation> newDataSetTypes)
Creates data set types basing on the providedDataSetTypeCreation
objects. Returns ids of the newly created data set types where nth id corresponds to nth creation object.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems, e.g. incorrectDataSetTypeCreation
objects, insufficient access rights etc.
-
createMaterials
java.util.List<MaterialPermId> createMaterials(java.lang.String sessionToken, java.util.List<MaterialCreation> newMaterials)
Creates materials basing on the providedMaterialCreation
objects. Returns ids of the newly created materials where nth id corresponds to nth creation object.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems, e.g. incorrectMaterialCreation
objects, insufficient access rights etc.
-
createMaterialTypes
java.util.List<EntityTypePermId> createMaterialTypes(java.lang.String sessionToken, java.util.List<MaterialTypeCreation> newMaterialTypes)
Creates material types basing on the providedMaterialTypeCreation
objects. Returns ids of the newly created material types where nth id corresponds to nth creation object.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems, e.g. incorrectMaterialTypeCreation
objects, insufficient access rights etc.
-
createPropertyTypes
java.util.List<PropertyTypePermId> createPropertyTypes(java.lang.String sessionToken, java.util.List<PropertyTypeCreation> newPropertyTypes)
Creates property types basing on the providedPropertyTypeCreation
objects. Returns ids of the newly created property types where nth id corresponds to nth creation object.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems, e.g. incorrectPropertyTypeCreation
objects, insufficient access rights etc.
-
createPlugins
java.util.List<PluginPermId> createPlugins(java.lang.String sessionToken, java.util.List<PluginCreation> newPlugins)
Creates plugins (i.e. dynamic property evaluators, managed property handlers, entity validators) basing on the providedPluginCreation
objects. Returns ids of the newly created plugins where nth id corresponds to nth creation object.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems, e.g. incorrectPluginCreation
objects, insufficient access rights etc.
-
createVocabularies
java.util.List<VocabularyPermId> createVocabularies(java.lang.String sessionToken, java.util.List<VocabularyCreation> newVocabularies)
Creates vocabularies and vocabulary terms (optionally) basing on the providedVocabularyCreation
objects. Returns ids of the newly created vocabularies where nth id corresponds to nth creation object.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems, e.g. incorrectVocabularyCreation
objects, insufficient access rights etc.
-
createVocabularyTerms
java.util.List<VocabularyTermPermId> createVocabularyTerms(java.lang.String sessionToken, java.util.List<VocabularyTermCreation> newVocabularyTerms)
Creates vocabulary terms basing on the providedVocabularyTermCreation
objects. Returns ids of the newly created vocabulary terms where nth id corresponds to nth creation object.-
Required access rights:
- unofficial terms -
PROJECT_USER
or stronger - official terms -
PROJECT_POWER_USER
or stronger - internally managed -
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems, e.g. incorrectVocabularyTermCreation
objects, insufficient access rights etc.
- unofficial terms -
-
createTags
java.util.List<TagPermId> createTags(java.lang.String sessionToken, java.util.List<TagCreation> newTags)
Creates tags basing on the providedTagCreation
objects. Returns ids of the newly created tags where nth id corresponds to nth creation object. Tags are only visible to a user who created them.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems, e.g. incorrectTagCreation
objects, insufficient access rights etc.
-
createAuthorizationGroups
java.util.List<AuthorizationGroupPermId> createAuthorizationGroups(java.lang.String sessionToken, java.util.List<AuthorizationGroupCreation> newAuthorizationGroups)
Creates authorization groups basing on the providedAuthorizationGroupCreation
objects. Returns ids of the newly created authorization groups where nth id corresponds to nth creation object.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems, e.g. incorrectAuthorizationGroupCreation
objects, insufficient access rights etc.
-
createRoleAssignments
java.util.List<RoleAssignmentTechId> createRoleAssignments(java.lang.String sessionToken, java.util.List<RoleAssignmentCreation> newRoleAssignments)
Creates role assignments basing on the providedRoleAssignmentCreation
objects. Returns ids of the newly created role assignments where nth id corresponds to nth creation object.-
Required access rights:
- instance roles -
INSTANCE_ADMIN
- space roles -
SPACE_ADMIN
or stronger - project roles -
PROJECT_ADMIN
or stronger
- Throws:
UserFailureException
- in case of any problems, e.g. incorrectRoleAssignmentCreation
objects, insufficient access rights etc.
- instance roles -
-
createPersons
java.util.List<PersonPermId> createPersons(java.lang.String sessionToken, java.util.List<PersonCreation> newPersons)
Creates persons basing on the providedPersonCreation
objects. Returns ids of the newly created persons where nth id corresponds to nth creation object.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems, e.g. incorrectPersonCreation
objects, insufficient access rights etc.
-
createExternalDataManagementSystems
java.util.List<ExternalDmsPermId> createExternalDataManagementSystems(java.lang.String sessionToken, java.util.List<ExternalDmsCreation> newExternalDataManagementSystems)
Creates external data management systems basing on the providedExternalDmsCreation
objects. Returns ids of the newly created external data management systems where nth id corresponds to nth creation object.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems, e.g. incorrectExternalDmsCreation
objects, insufficient access rights etc.
-
createQueries
java.util.List<QueryTechId> createQueries(java.lang.String sessionToken, java.util.List<QueryCreation> newQueries)
Creates queries basing on the providedQueryCreation
objects. Returns ids of the newly created queries where nth id corresponds to nth creation object.Required access rights: depends on a query database (more details at "Custom Database Queries" openBIS WIKI page)
- Throws:
UserFailureException
- in case of any problems, e.g. incorrectExternalDmsCreation
objects, insufficient access rights etc.
-
createSemanticAnnotations
java.util.List<SemanticAnnotationPermId> createSemanticAnnotations(java.lang.String sessionToken, java.util.List<SemanticAnnotationCreation> newAnnotations)
Creates semantic annotations basing on the providedSemanticAnnotationCreation
objects. Returns ids of the newly created semantic annotations where nth id corresponds to nth creation object.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems, e.g. incorrectSemanticAnnotationCreation
objects, insufficient access rights etc.
-
updateSpaces
void updateSpaces(java.lang.String sessionToken, java.util.List<SpaceUpdate> spaceUpdates)
Updates spaces basing on the providedSpaceUpdate
objects.Required access rights:
SPACE_ADMIN
or stronger- Throws:
UserFailureException
- in case of any problems, e.g. incorrectSpaceUpdate
objects, insufficient access rights etc.
-
updateProjects
void updateProjects(java.lang.String sessionToken, java.util.List<ProjectUpdate> projectUpdates)
Updates projects basing on the providedProjectUpdate
objects.Required access rights:
SPACE_POWER_USER
/PROJECT_ADMIN
or stronger- Throws:
UserFailureException
- in case of any problems, e.g. incorrectProjectUpdate
objects, insufficient access rights etc.
-
updateExperiments
void updateExperiments(java.lang.String sessionToken, java.util.List<ExperimentUpdate> experimentUpdates)
Updates experiments basing on the providedExperimentUpdate
objects.Required access rights:
PROJECT_USER
or stronger- Throws:
UserFailureException
- in case of any problems, e.g. incorrectExperimentUpdate
objects, insufficient access rights etc.
-
updateExperimentTypes
void updateExperimentTypes(java.lang.String sessionToken, java.util.List<ExperimentTypeUpdate> experimentTypeUpdates)
Updates experiment types basing on the providedExperimentTypeUpdate
objects.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems, e.g. incorrectExperimentTypeUpdate
objects, insufficient access rights etc.
-
updateSamples
void updateSamples(java.lang.String sessionToken, java.util.List<SampleUpdate> sampleUpdates)
Updates samples basing on the providedSampleUpdate
objects.Required access rights:
PROJECT_USER
or stronger- Throws:
UserFailureException
- in case of any problems, e.g. incorrectSampleUpdate
objects, insufficient access rights etc.
-
updateSampleTypes
void updateSampleTypes(java.lang.String sessionToken, java.util.List<SampleTypeUpdate> sampleTypeUpdates)
Updates sample types basing on the providedSampleTypeUpdate
objects.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems, e.g. incorrectSampleTypeUpdate
objects, insufficient access rights etc.
-
updateDataSets
void updateDataSets(java.lang.String sessionToken, java.util.List<DataSetUpdate> dataSetUpdates)
Updates data sets basing on the providedDataSetUpdate
objects.Required access rights:
PROJECT_POWER_USER
or stronger- Throws:
UserFailureException
- in case of any problems, e.g. incorrectDataSetUpdate
objects, insufficient access rights etc.
-
updateDataSetTypes
void updateDataSetTypes(java.lang.String sessionToken, java.util.List<DataSetTypeUpdate> dataSetTypeUpdates)
Updates data set types basing on the providedDataSetTypeUpdate
objects.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems, e.g. incorrectDataSetTypeUpdate
objects, insufficient access rights etc.
-
updateMaterials
void updateMaterials(java.lang.String sessionToken, java.util.List<MaterialUpdate> materialUpdates)
Updates materials basing on the providedMaterialUpdate
objects.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems, e.g. incorrectMaterialUpdate
objects, insufficient access rights etc.
-
updateMaterialTypes
void updateMaterialTypes(java.lang.String sessionToken, java.util.List<MaterialTypeUpdate> materialTypeUpdates)
Updates material types basing on the providedMaterialTypeUpdate
objects.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems, e.g. incorrectMaterialTypeUpdate
objects, insufficient access rights etc.
-
updateExternalDataManagementSystems
void updateExternalDataManagementSystems(java.lang.String sessionToken, java.util.List<ExternalDmsUpdate> externalDmsUpdates)
Updates external data management systems basing on the providedExternalDmsUpdate
objects.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems, e.g. incorrectExternalDmsUpdate
objects, insufficient access rights etc.
-
updatePropertyTypes
void updatePropertyTypes(java.lang.String sessionToken, java.util.List<PropertyTypeUpdate> propertyTypeUpdates)
Updates property types basing on the providedPropertyTypeUpdate
objects.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems, e.g. incorrectPropertyTypeUpdate
objects, insufficient access rights etc.
-
updatePlugins
void updatePlugins(java.lang.String sessionToken, java.util.List<PluginUpdate> pluginUpdates)
Updates plugins (i.e. dynamic property evaluators, managed property handlers, entity validators) basing on the providedPluginUpdate
objects.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems, e.g. incorrectPluginUpdate
objects, insufficient access rights etc.
-
updateVocabularies
void updateVocabularies(java.lang.String sessionToken, java.util.List<VocabularyUpdate> vocabularyUpdates)
Updates vocabularies basing on the providedVocabularyUpdate
objects.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems, e.g. incorrectVocabularyUpdate
objects, insufficient access rights etc.
-
updateVocabularyTerms
void updateVocabularyTerms(java.lang.String sessionToken, java.util.List<VocabularyTermUpdate> vocabularyTermUpdates)
Updates vocabulary terms basing on the providedVocabularyTermUpdate
objects.-
Required access rights:
- unofficial terms -
PROJECT_USER
or stronger - official terms -
PROJECT_POWER_USER
or stronger - internally managed -
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems, e.g. incorrectVocabularyTermUpdate
objects, insufficient access rights etc.
- unofficial terms -
-
updateTags
void updateTags(java.lang.String sessionToken, java.util.List<TagUpdate> tagUpdates)
Updates tags basing on the providedTagUpdate
objects. A user can only update own tags (i.e. tags a user has created).Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems, e.g. incorrectTagUpdate
objects, insufficient access rights etc.
-
updateAuthorizationGroups
void updateAuthorizationGroups(java.lang.String sessionToken, java.util.List<AuthorizationGroupUpdate> authorizationGroupUpdates)
Updates authorization groups basing on the providedAuthorizationGroupUpdate
objects.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems, e.g. incorrectAuthorizationGroupUpdate
objects, insufficient access rights etc.
-
updatePersons
void updatePersons(java.lang.String sessionToken, java.util.List<PersonUpdate> personUpdates)
Updates persons basing on the providedPersonUpdate
objects.-
Required access rights:
- activate/deactivate -
INSTANCE_ADMIN
- home space - user himself/herself /
SPACE_ADMIN
or stronger - webapp settings - user himself/herself /
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems, e.g. incorrectPersonUpdate
objects, insufficient access rights etc.
- activate/deactivate -
-
updateOperationExecutions
void updateOperationExecutions(java.lang.String sessionToken, java.util.List<OperationExecutionUpdate> executionUpdates)
Updates operation executions basing on the providedOperationExecutionUpdate
objects.Required access rights: user who created the operation execution /
INSTANCE_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems, e.g. incorrectOperationExecutionUpdate
objects, insufficient access rights etc.
-
updateSemanticAnnotations
void updateSemanticAnnotations(java.lang.String sessionToken, java.util.List<SemanticAnnotationUpdate> annotationUpdates)
Updates semantic annotations basing on the providedSemanticAnnotationUpdate
objects.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems, e.g. incorrectSemanticAnnotationUpdate
objects, insufficient access rights etc.
-
updateQueries
void updateQueries(java.lang.String sessionToken, java.util.List<QueryUpdate> queryUpdates)
Updates queries basing on the providedQueryUpdate
objects.Required access rights: depends on a query and a query database (more details at "Custom Database Queries" openBIS WIKI page)
- Throws:
UserFailureException
- in case of any problems, e.g. incorrectQueryUpdate
objects, insufficient access rights etc.
-
getRights
java.util.Map<IObjectId,Rights> getRights(java.lang.String sessionToken, java.util.List<? extends IObjectId> ids, RightsFetchOptions fetchOptions)
Gets authorization rights for the providedIObjectId
ids. A result map contains an entry for a given id only if an object for that id has been found and that object can be accessed by the user.- Throws:
UserFailureException
- in case of any problems
-
getSpaces
java.util.Map<ISpaceId,Space> getSpaces(java.lang.String sessionToken, java.util.List<? extends ISpaceId> spaceIds, SpaceFetchOptions fetchOptions)
Gets spaces for the providedISpaceId
ids. A result map contains an entry for a given id only if a space for that id has been found and that space can be accessed by the user.By default the returned spaces contain only basic information. Any additional information to be fetched has to be explicitly requested via
SpaceFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger (a project user can see a space if it has access to any of the projects in that space)- Throws:
UserFailureException
- in case of any problems
-
getProjects
java.util.Map<IProjectId,Project> getProjects(java.lang.String sessionToken, java.util.List<? extends IProjectId> projectIds, ProjectFetchOptions fetchOptions)
Gets projects for the providedIProjectId
ids. A result map contains an entry for a given id only if a project for that id has been found and that project can be accessed by the user.By default the returned projects contain only basic information. Any additional information to be fetched has to be explicitly requested via
ProjectFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
getExperiments
java.util.Map<IExperimentId,Experiment> getExperiments(java.lang.String sessionToken, java.util.List<? extends IExperimentId> experimentIds, ExperimentFetchOptions fetchOptions)
Gets experiments for the providedIExperimentId
ids. A result map contains an entry for a given id only if an experiment for that id has been found and that experiment can be accessed by the user.By default the returned experiments contain only basic information. Any additional information to be fetched has to be explicitly requested via
ExperimentFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
getExperimentTypes
java.util.Map<IEntityTypeId,ExperimentType> getExperimentTypes(java.lang.String sessionToken, java.util.List<? extends IEntityTypeId> experimentTypeIds, ExperimentTypeFetchOptions fetchOptions)
Gets experiment types for the providedIEntityTypeId
ids. A result map contains an entry for a given id only if an experiment type for that id has been found and that experiment type can be accessed by the user.By default the returned experiment types contain only basic information. Any additional information to be fetched has to be explicitly requested via
ExperimentTypeFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
getSamples
java.util.Map<ISampleId,Sample> getSamples(java.lang.String sessionToken, java.util.List<? extends ISampleId> sampleIds, SampleFetchOptions fetchOptions)
Gets samples for the providedISampleId
ids. A result map contains an entry for a given id only if a sample for that id has been found and that sample can be accessed by the user.By default the returned samples contain only basic information. Any additional information to be fetched has to be explicitly requested via
SampleFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
getSampleTypes
java.util.Map<IEntityTypeId,SampleType> getSampleTypes(java.lang.String sessionToken, java.util.List<? extends IEntityTypeId> sampleTypeIds, SampleTypeFetchOptions fetchOptions)
Gets sample types for the providedIEntityTypeId
ids. A result map contains an entry for a given id only if an sample type for that id has been found and that sample type can be accessed by the user.By default the returned sample types contain only basic information. Any additional information to be fetched has to be explicitly requested via
SampleTypeFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
getDataSets
java.util.Map<IDataSetId,DataSet> getDataSets(java.lang.String sessionToken, java.util.List<? extends IDataSetId> dataSetIds, DataSetFetchOptions fetchOptions)
Gets data sets for the providedIDataSetId
ids. A result map contains an entry for a given id only if a data set for that id has been found and that data set can be accessed by the user.By default the returned data sets contain only basic information. Any additional information to be fetched has to be explicitly requested via
DataSetFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
getDataSetTypes
java.util.Map<IEntityTypeId,DataSetType> getDataSetTypes(java.lang.String sessionToken, java.util.List<? extends IEntityTypeId> dataSetTypeIds, DataSetTypeFetchOptions fetchOptions)
Gets data set types for the providedIEntityTypeId
ids. A result map contains an entry for a given id only if a data set type for that id has been found and that data set type can be accessed by the user.By default the returned data set types contain only basic information. Any additional information to be fetched has to be explicitly requested via
DataSetTypeFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
getMaterials
java.util.Map<IMaterialId,Material> getMaterials(java.lang.String sessionToken, java.util.List<? extends IMaterialId> materialIds, MaterialFetchOptions fetchOptions)
Gets materials for the providedIMaterialId
ids. A result map contains an entry for a given id only if a material for that id has been found and that material can be accessed by the user.By default the returned materials contain only basic information. Any additional information to be fetched has to be explicitly requested via
MaterialFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
getMaterialTypes
java.util.Map<IEntityTypeId,MaterialType> getMaterialTypes(java.lang.String sessionToken, java.util.List<? extends IEntityTypeId> materialTypeIds, MaterialTypeFetchOptions fetchOptions)
Gets material types for the providedIEntityTypeId
ids. A result map contains an entry for a given id only if a material type for that id has been found and that material type can be accessed by the user.By default the returned material types contain only basic information. Any additional information to be fetched has to be explicitly requested via
MaterialTypeFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
getPropertyTypes
java.util.Map<IPropertyTypeId,PropertyType> getPropertyTypes(java.lang.String sessionToken, java.util.List<? extends IPropertyTypeId> typeIds, PropertyTypeFetchOptions fetchOptions)
Gets property types for the providedIPropertyTypeId
ids. A result map contains an entry for a given id only if a property type for that id has been found and that property type can be accessed by the user.By default the returned property types contain only basic information. Any additional information to be fetched has to be explicitly requested via
PropertyTypeFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
getPlugins
java.util.Map<IPluginId,Plugin> getPlugins(java.lang.String sessionToken, java.util.List<? extends IPluginId> pluginIds, PluginFetchOptions fetchOptions)
Gets plugins (i.e. dynamic property evaluators, managed property handlers, entity validators) for the providedIPluginId
ids. A result map contains an entry for a given id only if a plugin for that id has been found and that plugin can be accessed by the user.By default the returned plugins contain only basic information. Any additional information to be fetched has to be explicitly requested via
PluginFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
getVocabularies
java.util.Map<IVocabularyId,Vocabulary> getVocabularies(java.lang.String sessionToken, java.util.List<? extends IVocabularyId> vocabularyIds, VocabularyFetchOptions fetchOptions)
Gets vocabularies for the providedIVocabularyId
ids. A result map contains an entry for a given id only if a vocabulary for that id has been found and that vocabulary can be accessed by the user.By default the returned vocabularies contain only basic information. Any additional information to be fetched has to be explicitly requested via
VocabularyFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
getVocabularyTerms
java.util.Map<IVocabularyTermId,VocabularyTerm> getVocabularyTerms(java.lang.String sessionToken, java.util.List<? extends IVocabularyTermId> vocabularyTermIds, VocabularyTermFetchOptions fetchOptions)
Gets vocabulary terms for the providedIVocabularyTermId
ids. A result map contains an entry for a given id only if a vocabulary term for that id has been found and that vocabulary term can be accessed by the user.By default the returned vocabulary terms contain only basic information. Any additional information to be fetched has to be explicitly requested via
VocabularyTermFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
getTags
java.util.Map<ITagId,Tag> getTags(java.lang.String sessionToken, java.util.List<? extends ITagId> tagIds, TagFetchOptions fetchOptions)
Gets tags for the providedITagId
ids. A result map contains an entry for a given id only if a tag for that id has been found and that tag can be accessed by the user. A user can get own tags only (i.e. tags a user has created).By default the returned tags contain only basic information. Any additional information to be fetched has to be explicitly requested via
TagFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
getAuthorizationGroups
java.util.Map<IAuthorizationGroupId,AuthorizationGroup> getAuthorizationGroups(java.lang.String sessionToken, java.util.List<? extends IAuthorizationGroupId> groupIds, AuthorizationGroupFetchOptions fetchOptions)
Gets authorization groups for the providedIAuthorizationGroupId
ids. A result map contains an entry for a given id only if an authorization group for that id has been found and that authorization group can be accessed by the user.By default the returned authorization groups contain only basic information. Any additional information to be fetched has to be explicitly requested via
AuthorizationGroupFetchOptions
.Required access rights:
PROJECT_ADMIN
or stronger- Throws:
UserFailureException
- in case of any problems
-
getRoleAssignments
java.util.Map<IRoleAssignmentId,RoleAssignment> getRoleAssignments(java.lang.String sessionToken, java.util.List<? extends IRoleAssignmentId> ids, RoleAssignmentFetchOptions fetchOptions)
Gets role assignments for the providedIRoleAssignmentId
ids. A result map contains an entry for a given id only if a role assignment for that id has been found and that role assignment can be accessed by the user.By default the returned role assignments contain only basic information. Any additional information to be fetched has to be explicitly requested via
RoleAssignmentFetchOptions
.Required access rights:
PROJECT_ADMIN
or stronger- Throws:
UserFailureException
- in case of any problems
-
getPersons
java.util.Map<IPersonId,Person> getPersons(java.lang.String sessionToken, java.util.List<? extends IPersonId> ids, PersonFetchOptions fetchOptions)
Gets persons for the providedIPersonId
ids. A result map contains an entry for a given id only if a person for that id has been found and that person can be accessed by the user.By default the returned persons contain only basic information. Any additional information to be fetched has to be explicitly requested via
PersonFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
getExternalDataManagementSystems
java.util.Map<IExternalDmsId,ExternalDms> getExternalDataManagementSystems(java.lang.String sessionToken, java.util.List<? extends IExternalDmsId> externalDmsIds, ExternalDmsFetchOptions fetchOptions)
Gets external data management systems for the providedIExternalDmsId
ids. A result map contains an entry for a given id only if an external data management system for that id has been found and that external data management system can be accessed by the user.By default the returned external data management systems contain only basic information. Any additional information to be fetched has to be explicitly requested via
ExternalDmsFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
getSemanticAnnotations
java.util.Map<ISemanticAnnotationId,SemanticAnnotation> getSemanticAnnotations(java.lang.String sessionToken, java.util.List<? extends ISemanticAnnotationId> annotationIds, SemanticAnnotationFetchOptions fetchOptions)
Gets semantic annotations for the providedISemanticAnnotationId
ids. A result map contains an entry for a given id only if a semantic annotation for that id has been found and that semantic annotation can be accessed by the user.By default the returned semantic annotations contain only basic information. Any additional information to be fetched has to be explicitly requested via
SemanticAnnotationFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
getOperationExecutions
java.util.Map<IOperationExecutionId,OperationExecution> getOperationExecutions(java.lang.String sessionToken, java.util.List<? extends IOperationExecutionId> executionIds, OperationExecutionFetchOptions fetchOptions)
Gets operation executions for the providedIOperationExecutionId
ids. A result map contains an entry for a given id only if an operation execution for that id has been found and that operation execution can be accessed by the user.By default the returned operation executions contain only basic information. Any additional information to be fetched has to be explicitly requested via
OperationExecutionFetchOptions
.Required access rights: user who created the operation execution /
INSTANCE_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
getQueries
java.util.Map<IQueryId,Query> getQueries(java.lang.String sessionToken, java.util.List<? extends IQueryId> queryIds, QueryFetchOptions fetchOptions)
Gets queries for the providedIQueryId
ids. A result map contains an entry for a given id only if a query for that id has been found and that query can be accessed by the user.By default the returned queries contain only basic information. Any additional information to be fetched has to be explicitly requested via
QueryFetchOptions
.Required access rights: depends on a query and a query database (more details at "Custom Database Queries" openBIS WIKI page)
- Throws:
UserFailureException
- in case of any problems
-
getQueryDatabases
java.util.Map<IQueryDatabaseId,QueryDatabase> getQueryDatabases(java.lang.String sessionToken, java.util.List<? extends IQueryDatabaseId> queryDatabaseIds, QueryDatabaseFetchOptions fetchOptions)
Gets query databases for the providedIQueryDatabaseId
ids. A result map contains an entry for a given id only if a query database for that id has been found and that query database can be accessed by the user.By default the returned query databases contain only basic information. Any additional information to be fetched has to be explicitly requested via
QueryDatabaseFetchOptions
.Required access rights: depends on a query database (more details at "Custom Database Queries" openBIS WIKI page)
- Throws:
UserFailureException
- in case of any problems
-
searchSpaces
SearchResult<Space> searchSpaces(java.lang.String sessionToken, SpaceSearchCriteria searchCriteria, SpaceFetchOptions fetchOptions)
Searches for spaces basing on the providedSpaceSearchCriteria
.By default the returned spaces contain only basic information. Any additional information to be fetched has to be explicitly requested via
SpaceFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger (a project user can see a space if it has access to any of the projects in that space)- Throws:
UserFailureException
- in case of any problems
-
searchProjects
SearchResult<Project> searchProjects(java.lang.String sessionToken, ProjectSearchCriteria searchCriteria, ProjectFetchOptions fetchOptions)
Searches for projects basing on the providedProjectSearchCriteria
.By default the returned projects contain only basic information. Any additional information to be fetched has to be explicitly requested via
ProjectFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
searchExperiments
SearchResult<Experiment> searchExperiments(java.lang.String sessionToken, ExperimentSearchCriteria searchCriteria, ExperimentFetchOptions fetchOptions)
Searches for experiments basing on the providedExperimentSearchCriteria
.By default the returned experiments contain only basic information. Any additional information to be fetched has to be explicitly requested via
ExperimentFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
searchExperimentTypes
SearchResult<ExperimentType> searchExperimentTypes(java.lang.String sessionToken, ExperimentTypeSearchCriteria searchCriteria, ExperimentTypeFetchOptions fetchOptions)
Searches for experiment types basing on the providedExperimentTypeSearchCriteria
.By default the returned experiment types contain only basic information. Any additional information to be fetched has to be explicitly requested via
ExperimentTypeFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
searchSamples
SearchResult<Sample> searchSamples(java.lang.String sessionToken, SampleSearchCriteria searchCriteria, SampleFetchOptions fetchOptions)
Searches for samples basing on the providedSampleSearchCriteria
.By default the returned samples contain only basic information. Any additional information to be fetched has to be explicitly requested via
SampleFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
searchSampleTypes
SearchResult<SampleType> searchSampleTypes(java.lang.String sessionToken, SampleTypeSearchCriteria searchCriteria, SampleTypeFetchOptions fetchOptions)
Searches for sample types basing on the providedSampleTypeSearchCriteria
.By default the returned sample types contain only basic information. Any additional information to be fetched has to be explicitly requested via
SampleTypeFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
searchDataSets
SearchResult<DataSet> searchDataSets(java.lang.String sessionToken, DataSetSearchCriteria searchCriteria, DataSetFetchOptions fetchOptions)
Searches for data sets basing on the providedDataSetSearchCriteria
.By default the returned data sets contain only basic information. Any additional information to be fetched has to be explicitly requested via
DataSetFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
searchDataSetTypes
SearchResult<DataSetType> searchDataSetTypes(java.lang.String sessionToken, DataSetTypeSearchCriteria searchCriteria, DataSetTypeFetchOptions fetchOptions)
Searches for data set types basing on the providedDataSetTypeSearchCriteria
.By default the returned data set types contain only basic information. Any additional information to be fetched has to be explicitly requested via
DataSetTypeFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
searchMaterials
SearchResult<Material> searchMaterials(java.lang.String sessionToken, MaterialSearchCriteria searchCriteria, MaterialFetchOptions fetchOptions)
Searches for materials basing on the providedMaterialSearchCriteria
.By default the returned materials contain only basic information. Any additional information to be fetched has to be explicitly requested via
MaterialFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
searchExternalDataManagementSystems
SearchResult<ExternalDms> searchExternalDataManagementSystems(java.lang.String sessionToken, ExternalDmsSearchCriteria searchCriteria, ExternalDmsFetchOptions fetchOptions)
Searches for external data management systems basing on the providedExternalDmsSearchCriteria
.By default the returned external data management systems contain only basic information. Any additional information to be fetched has to be explicitly requested via
ExternalDmsFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
searchMaterialTypes
SearchResult<MaterialType> searchMaterialTypes(java.lang.String sessionToken, MaterialTypeSearchCriteria searchCriteria, MaterialTypeFetchOptions fetchOptions)
Searches for material types basing on the providedMaterialTypeSearchCriteria
.By default the returned material types contain only basic information. Any additional information to be fetched has to be explicitly requested via
MaterialTypeFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
searchPlugins
SearchResult<Plugin> searchPlugins(java.lang.String sessionToken, PluginSearchCriteria searchCriteria, PluginFetchOptions fetchOptions)
Searches for plugins (i.e. dynamic property evaluators, managed property handlers, entity validators) basing on the providedPluginSearchCriteria
.By default the returned plugins contain only basic information. Any additional information to be fetched has to be explicitly requested via
PluginFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
searchVocabularies
SearchResult<Vocabulary> searchVocabularies(java.lang.String sessionToken, VocabularySearchCriteria searchCriteria, VocabularyFetchOptions fetchOptions)
Searches for vocabularies basing on the providedVocabularySearchCriteria
.By default the returned vocabularies contain only basic information. Any additional information to be fetched has to be explicitly requested via
VocabularyFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
searchVocabularyTerms
SearchResult<VocabularyTerm> searchVocabularyTerms(java.lang.String sessionToken, VocabularyTermSearchCriteria searchCriteria, VocabularyTermFetchOptions fetchOptions)
Searches for vocabulary terms basing on the providedVocabularyTermSearchCriteria
.By default the returned vocabulary terms contain only basic information. Any additional information to be fetched has to be explicitly requested via
VocabularyTermFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
searchTags
SearchResult<Tag> searchTags(java.lang.String sessionToken, TagSearchCriteria searchCriteria, TagFetchOptions fetchOptions)
Searches for tags basing on the providedTagSearchCriteria
. A user can find own tags only (i.e. tags a user has created).By default the returned tags contain only basic information. Any additional information to be fetched has to be explicitly requested via
TagFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
searchAuthorizationGroups
SearchResult<AuthorizationGroup> searchAuthorizationGroups(java.lang.String sessionToken, AuthorizationGroupSearchCriteria searchCriteria, AuthorizationGroupFetchOptions fetchOptions)
Searches for authorization groups basing on the providedAuthorizationGroupSearchCriteria
.By default the returned authorization groups contain only basic information. Any additional information to be fetched has to be explicitly requested via
AuthorizationGroupFetchOptions
.Required access rights:
PROJECT_ADMIN
or stronger- Throws:
UserFailureException
- in case of any problems
-
searchRoleAssignments
SearchResult<RoleAssignment> searchRoleAssignments(java.lang.String sessionToken, RoleAssignmentSearchCriteria searchCriteria, RoleAssignmentFetchOptions fetchOptions)
Searches for role assignments basing on the providedRoleAssignmentSearchCriteria
.By default the returned role assignments contain only basic information. Any additional information to be fetched has to be explicitly requested via
RoleAssignmentFetchOptions
.Required access rights:
PROJECT_ADMIN
or stronger- Throws:
UserFailureException
- in case of any problems
-
searchPersons
SearchResult<Person> searchPersons(java.lang.String sessionToken, PersonSearchCriteria searchCriteria, PersonFetchOptions fetchOptions)
Searches for persons basing on the providedPersonSearchCriteria
.By default the returned persons contain only basic information. Any additional information to be fetched has to be explicitly requested via
PersonFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
searchCustomASServices
SearchResult<CustomASService> searchCustomASServices(java.lang.String sessionToken, CustomASServiceSearchCriteria searchCriteria, CustomASServiceFetchOptions fetchOptions)
Searches for custom application server services basing on the providedCustomASServiceSearchCriteria
. More details on the custom application server services can be found at "Custom Application Server Services" openBIS WIKI page.By default the returned custom application server services contain only basic information. Any additional information to be fetched has to be explicitly requested via
CustomASServiceFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
searchSearchDomainServices
SearchResult<SearchDomainService> searchSearchDomainServices(java.lang.String sessionToken, SearchDomainServiceSearchCriteria searchCriteria, SearchDomainServiceFetchOptions fetchOptions)
Searches for search domain services basing on the providedSearchDomainServiceSearchCriteria
. More details on the search domain services can be found at "Search Domain Services" openBIS WIKI page.By default the returned search domain services contain only basic information. Any additional information to be fetched has to be explicitly requested via
SearchDomainServiceFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
searchAggregationServices
SearchResult<AggregationService> searchAggregationServices(java.lang.String sessionToken, AggregationServiceSearchCriteria searchCriteria, AggregationServiceFetchOptions fetchOptions)
Searches for aggregation services basing on the providedAggregationServiceSearchCriteria
. More details on the aggregation services can be found at "Reporting Plugins" openBIS WIKI page (type: AGGREGATION_TABLE_MODEL).By default the returned aggregation services contain only basic information. Any additional information to be fetched has to be explicitly requested via
AggregationServiceFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
searchReportingServices
SearchResult<ReportingService> searchReportingServices(java.lang.String sessionToken, ReportingServiceSearchCriteria searchCriteria, ReportingServiceFetchOptions fetchOptions)
Searches for reporting services basing on the providedReportingServiceSearchCriteria
. More details on the reporting services can be found at "Reporting Plugins" openBIS WIKI page (type: TABLE_MODEL).By default the returned reporting services contain only basic information. Any additional information to be fetched has to be explicitly requested via
ReportingServiceFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
searchProcessingServices
SearchResult<ProcessingService> searchProcessingServices(java.lang.String sessionToken, ProcessingServiceSearchCriteria searchCriteria, ProcessingServiceFetchOptions fetchOptions)
Searches for processing services basing on the providedProcessingServiceSearchCriteria
. More details on the processing services can be found at "Processing Plugins" openBIS WIKI page.By default the returned processing services contain only basic information. Any additional information to be fetched has to be explicitly requested via
ProcessingServiceFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
searchObjectKindModifications
SearchResult<ObjectKindModification> searchObjectKindModifications(java.lang.String sessionToken, ObjectKindModificationSearchCriteria searchCriteria, ObjectKindModificationFetchOptions fetchOptions)
Searches for object kind modifications basing on the providedObjectKindModificationSearchCriteria
. An object kind modification contains information on when a given kind of operation was last performed for a given kind of object, e.g. when was the last sample update or when was the last property type creation etc.By default the returned object kind modifications contain only basic information. Any additional information to be fetched has to be explicitly requested via
ObjectKindModificationFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
searchGlobally
SearchResult<GlobalSearchObject> searchGlobally(java.lang.String sessionToken, GlobalSearchCriteria searchCriteria, GlobalSearchObjectFetchOptions fetchOptions)
Searches for experiments, samples, data sets and materials at once basing on the providedGlobalSearchCriteria
.By default the returned objects contain only basic information. Any additional information to be fetched has to be explicitly requested via
GlobalSearchObjectFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
searchOperationExecutions
SearchResult<OperationExecution> searchOperationExecutions(java.lang.String sessionToken, OperationExecutionSearchCriteria searchCriteria, OperationExecutionFetchOptions fetchOptions)
Searches for operation executions basing on the providedOperationExecutionSearchCriteria
.By default the returned operation executions contain only basic information. Any additional information to be fetched has to be explicitly requested via
OperationExecutionFetchOptions
.Required access rights: user who created the operation execution /
INSTANCE_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
searchDataStores
SearchResult<DataStore> searchDataStores(java.lang.String sessionToken, DataStoreSearchCriteria searchCriteria, DataStoreFetchOptions fetchOptions)
Searches for data stores basing on the providedDataStoreSearchCriteria
.By default the returned data stores contain only basic information. Any additional information to be fetched has to be explicitly requested via
DataStoreFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
searchSemanticAnnotations
SearchResult<SemanticAnnotation> searchSemanticAnnotations(java.lang.String sessionToken, SemanticAnnotationSearchCriteria searchCriteria, SemanticAnnotationFetchOptions fetchOptions)
Searches for semantic annotations basing on the providedSemanticAnnotationSearchCriteria
.By default the returned semantic annotations contain only basic information. Any additional information to be fetched has to be explicitly requested via
SemanticAnnotationFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
searchPropertyTypes
SearchResult<PropertyType> searchPropertyTypes(java.lang.String sessionToken, PropertyTypeSearchCriteria searchCriteria, PropertyTypeFetchOptions fetchOptions)
Searches for property types basing on the providedPropertyTypeSearchCriteria
.By default the returned property types contain only basic information. Any additional information to be fetched has to be explicitly requested via
PropertyTypeFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
searchPropertyAssignments
SearchResult<PropertyAssignment> searchPropertyAssignments(java.lang.String sessionToken, PropertyAssignmentSearchCriteria searchCriteria, PropertyAssignmentFetchOptions fetchOptions)
Searches for property assignments basing on the providedPropertyAssignmentSearchCriteria
.By default the returned property assignments contain only basic information. Any additional information to be fetched has to be explicitly requested via
PropertyAssignmentFetchOptions
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
searchQueries
SearchResult<Query> searchQueries(java.lang.String sessionToken, QuerySearchCriteria searchCriteria, QueryFetchOptions fetchOptions)
Searches for queries basing on the providedQuerySearchCriteria
.By default the returned queries contain only basic information. Any additional information to be fetched has to be explicitly requested via
QueryFetchOptions
.Required access rights: depends on a query and a query database (more details at "Custom Database Queries" openBIS WIKI page)
- Throws:
UserFailureException
- in case of any problems
-
searchQueryDatabases
SearchResult<QueryDatabase> searchQueryDatabases(java.lang.String sessionToken, QueryDatabaseSearchCriteria searchCriteria, QueryDatabaseFetchOptions fetchOptions)
Searches for query databases basing on the providedQueryDatabaseSearchCriteria
.By default the returned query databases contain only basic information. Any additional information to be fetched has to be explicitly requested via
QueryDatabaseFetchOptions
.Required access rights: depends on a query database (more details at "Custom Database Queries" openBIS WIKI page)
- Throws:
UserFailureException
- in case of any problems
-
deleteSpaces
void deleteSpaces(java.lang.String sessionToken, java.util.List<? extends ISpaceId> spaceIds, SpaceDeletionOptions deletionOptions)
Permanently deletes spaces with the providedISpaceId
ids. Additional deletion options (e.g. deletion reason) can be set viaSpaceDeletionOptions
.Required access rights:
SPACE_ADMIN
or stronger- Throws:
UserFailureException
- in case of any problems
-
deleteProjects
void deleteProjects(java.lang.String sessionToken, java.util.List<? extends IProjectId> projectIds, ProjectDeletionOptions deletionOptions)
Permanently deletes projects with the providedIProjectId
ids. Additional deletion options (e.g. deletion reason) can be set viaProjectDeletionOptions
.Required access rights:
SPACE_POWER_USER
/PROJECT_ADMIN
or stronger- Throws:
UserFailureException
- in case of any problems
-
deleteExperiments
IDeletionId deleteExperiments(java.lang.String sessionToken, java.util.List<? extends IExperimentId> experimentIds, ExperimentDeletionOptions deletionOptions)
Moves experiments with the providedIExperimentId
ids to trash. ReturnsIDeletionId
object which can be used either inconfirmDeletions
call to delete the experiments permanently or inrevertDeletions
call to bring the trashed experiments back to life. Additional deletion options (e.g. deletion reason) can be set viaExperimentDeletionOptions
.Required access rights:
PROJECT_POWER_USER
or stronger- Throws:
UserFailureException
- in case of any problems- See Also:
confirmDeletions(String, List)
,revertDeletions(String, List)
-
deleteSamples
IDeletionId deleteSamples(java.lang.String sessionToken, java.util.List<? extends ISampleId> sampleIds, SampleDeletionOptions deletionOptions)
Moves samples with the providedISampleId
ids to trash. ReturnsIDeletionId
object which can be used either inconfirmDeletions
call to delete the samples permanently or inrevertDeletions
call to bring the trashed samples back to life. Additional deletion options (e.g. deletion reason) can be set viaSampleDeletionOptions
.Required access rights:
PROJECT_POWER_USER
or stronger- Throws:
UserFailureException
- in case of any problems- See Also:
confirmDeletions(String, List)
,revertDeletions(String, List)
-
deleteDataSets
IDeletionId deleteDataSets(java.lang.String sessionToken, java.util.List<? extends IDataSetId> dataSetIds, DataSetDeletionOptions deletionOptions)
Moves data sets with the providedIDataSetId
ids to trash. ReturnsIDeletionId
object which can be used either inconfirmDeletions
call to delete the data sets permanently or inrevertDeletions
call to bring the trashed data sets back to life. Additional deletion options (e.g. deletion reason) can be set viaDataSetDeletionOptions
.Required access rights:
PROJECT_POWER_USER
or stronger- Throws:
UserFailureException
- in case of any problems- See Also:
confirmDeletions(String, List)
,revertDeletions(String, List)
-
deleteMaterials
void deleteMaterials(java.lang.String sessionToken, java.util.List<? extends IMaterialId> materialIds, MaterialDeletionOptions deletionOptions)
Permanently deletes materials with the providedIMaterialId
ids. Additional deletion options (e.g. deletion reason) can be set viaMaterialDeletionOptions
.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems
-
deletePlugins
void deletePlugins(java.lang.String sessionToken, java.util.List<? extends IPluginId> pluginIds, PluginDeletionOptions deletionOptions)
Permanently deletes plugins (i.e. dynamic property evaluators, managed property handlers, entity validators) with the providedIPluginId
ids. Additional deletion options (e.g. deletion reason) can be set viaPluginDeletionOptions
.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems
-
deletePropertyTypes
void deletePropertyTypes(java.lang.String sessionToken, java.util.List<? extends IPropertyTypeId> propertyTypeIds, PropertyTypeDeletionOptions deletionOptions)
Permanently deletes property types with the providedIPropertyTypeId
ids. Additional deletion options (e.g. deletion reason) can be set viaPropertyTypeDeletionOptions
.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems
-
deleteVocabularies
void deleteVocabularies(java.lang.String sessionToken, java.util.List<? extends IVocabularyId> ids, VocabularyDeletionOptions deletionOptions)
Permanently deletes vocabularies with the providedIVocabularyId
ids. Additional deletion options (e.g. deletion reason) can be set viaVocabularyDeletionOptions
.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems
-
deleteVocabularyTerms
void deleteVocabularyTerms(java.lang.String sessionToken, java.util.List<? extends IVocabularyTermId> termIds, VocabularyTermDeletionOptions deletionOptions)
Permanently deletes vocabulary terms with the providedIVocabularyTermId
ids. Additional deletion options (e.g. deletion reason) can be set viaVocabularyTermDeletionOptions
.-
Required access rights:
- unofficial and official terms -
PROJECT_POWER_USER
or stronger - internally managed -
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems
- unofficial and official terms -
-
deleteExperimentTypes
void deleteExperimentTypes(java.lang.String sessionToken, java.util.List<? extends IEntityTypeId> experimentTypeIds, ExperimentTypeDeletionOptions deletionOptions)
Permanently deletes experiment types with the providedIEntityTypeId
ids. Additional deletion options (e.g. deletion reason) can be set viaExperimentTypeDeletionOptions
.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems
-
deleteSampleTypes
void deleteSampleTypes(java.lang.String sessionToken, java.util.List<? extends IEntityTypeId> sampleTypeIds, SampleTypeDeletionOptions deletionOptions)
Permanently deletes sample types with the providedIEntityTypeId
ids. Additional deletion options (e.g. deletion reason) can be set viaSampleTypeDeletionOptions
.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems
-
deleteDataSetTypes
void deleteDataSetTypes(java.lang.String sessionToken, java.util.List<? extends IEntityTypeId> dataSetTypeIds, DataSetTypeDeletionOptions deletionOptions)
Permanently deletes data set types with the providedIEntityTypeId
ids. Additional deletion options (e.g. deletion reason) can be set viaDataSetTypeDeletionOptions
.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems
-
deleteMaterialTypes
void deleteMaterialTypes(java.lang.String sessionToken, java.util.List<? extends IEntityTypeId> materialTypeIds, MaterialTypeDeletionOptions deletionOptions)
Permanently deletes material types with the providedIEntityTypeId
ids. Additional deletion options (e.g. deletion reason) can be set viaMaterialTypeDeletionOptions
.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems
-
deleteExternalDataManagementSystems
void deleteExternalDataManagementSystems(java.lang.String sessionToken, java.util.List<? extends IExternalDmsId> externalDmsIds, ExternalDmsDeletionOptions deletionOptions)
Permanently deletes external data management systems with the providedIExternalDmsId
ids. Additional deletion options (e.g. deletion reason) can be set viaExternalDmsDeletionOptions
.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems
-
deleteTags
void deleteTags(java.lang.String sessionToken, java.util.List<? extends ITagId> tagIds, TagDeletionOptions deletionOptions)
Permanently deletes tags with the providedITagId
ids. Additional deletion options (e.g. deletion reason) can be set viaTagDeletionOptions
. A user can only delete own tags (i.e. tags a user has created).Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
deleteAuthorizationGroups
void deleteAuthorizationGroups(java.lang.String sessionToken, java.util.List<? extends IAuthorizationGroupId> groupIds, AuthorizationGroupDeletionOptions deletionOptions)
Permanently deletes authorization groups with the providedIAuthorizationGroupId
ids. Additional deletion options (e.g. deletion reason) can be set viaAuthorizationGroupDeletionOptions
.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems
-
deleteRoleAssignments
void deleteRoleAssignments(java.lang.String sessionToken, java.util.List<? extends IRoleAssignmentId> assignmentIds, RoleAssignmentDeletionOptions deletionOptions)
Permanently deletes role assignments with the providedIRoleAssignmentId
ids. Additional deletion options (e.g. deletion reason) can be set viaRoleAssignmentDeletionOptions
.-
Required access rights:
- instance roles -
INSTANCE_ADMIN
- space roles -
SPACE_ADMIN
or stronger - project roles -
PROJECT_ADMIN
or stronger
- Throws:
UserFailureException
- in case of any problems
- instance roles -
-
deleteOperationExecutions
void deleteOperationExecutions(java.lang.String sessionToken, java.util.List<? extends IOperationExecutionId> executionIds, OperationExecutionDeletionOptions deletionOptions)
Permanently deletes operation executions with the providedIOperationExecutionId
ids. Additional deletion options (e.g. deletion reason) can be set viaOperationExecutionDeletionOptions
.Required access rights: user who created the operation execution /
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems
-
deleteSemanticAnnotations
void deleteSemanticAnnotations(java.lang.String sessionToken, java.util.List<? extends ISemanticAnnotationId> annotationIds, SemanticAnnotationDeletionOptions deletionOptions)
Permanently deletes semantic annotations with the providedISemanticAnnotationId
ids. Additional deletion options (e.g. deletion reason) can be set viaSemanticAnnotationDeletionOptions
.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems
-
deleteQueries
void deleteQueries(java.lang.String sessionToken, java.util.List<? extends IQueryId> queryIds, QueryDeletionOptions deletionOptions)
Permanently deletes queries with the providedIQueryId
ids. Additional deletion options (e.g. deletion reason) can be set viaQueryDeletionOptions
.Required access rights: depends on a query and a query database (more details at "Custom Database Queries" openBIS WIKI page)
- Throws:
UserFailureException
- in case of any problems
-
deletePersons
void deletePersons(java.lang.String sessionToken, java.util.List<? extends IPersonId> personIds, PersonDeletionOptions deletionOptions)
Permanently deletes persons with the providedIPersonId
ids. Additional deletion options (e.g. deletion reason) can be set viaPersonDeletionOptions
.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems
-
searchDeletions
SearchResult<Deletion> searchDeletions(java.lang.String sessionToken, DeletionSearchCriteria searchCriteria, DeletionFetchOptions fetchOptions)
Searches for deletions basing on the providedDeletionSearchCriteria
.By default the returned deletions contain only basic information. Any additional information to be fetched has to be explicitly requested via
DeletionFetchOptions
.Required access rights:
PROJECT_USER
- Throws:
UserFailureException
- in case of any problems
-
searchEvents
SearchResult<Event> searchEvents(java.lang.String sessionToken, EventSearchCriteria searchCriteria, EventFetchOptions fetchOptions)
Searches for events basing on the providedEventSearchCriteria
.By default the returned events contain only basic information. Any additional information to be fetched has to be explicitly requested via
EventFetchOptions
.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems
-
revertDeletions
void revertDeletions(java.lang.String sessionToken, java.util.List<? extends IDeletionId> deletionIds)
Reverts deletions with the providedIDeletionId
ids (i.e. takes the entities out of trash and brings them back to life).Required access rights:
PROJECT_USER
or stronger- Throws:
UserFailureException
- in case of any problems- See Also:
deleteExperiments(String, List, ExperimentDeletionOptions)
,deleteSamples(String, List, SampleDeletionOptions)
,deleteDataSets(String, List, DataSetDeletionOptions)
-
confirmDeletions
void confirmDeletions(java.lang.String sessionToken, java.util.List<? extends IDeletionId> deletionIds)
Confirms deletions with the providedIDeletionId
ids (i.e. permanently deletes the entities).Required access rights:
PROJECT_ADMIN
or stronger- Throws:
UserFailureException
- in case of any problems- See Also:
deleteExperiments(String, List, ExperimentDeletionOptions)
,deleteSamples(String, List, SampleDeletionOptions)
,deleteDataSets(String, List, DataSetDeletionOptions)
-
executeCustomASService
java.lang.Object executeCustomASService(java.lang.String sessionToken, ICustomASServiceId serviceId, CustomASServiceExecutionOptions options)
Executes a custom application server service with the providedICustomASServiceId
id. Additional execution options (e.g. parameters) can be set viaCustomASServiceExecutionOptions
. More details on the custom application server services can be found at "Custom Application Server Services" openBIS WIKI page.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
executeSearchDomainService
SearchResult<SearchDomainServiceExecutionResult> executeSearchDomainService(java.lang.String sessionToken, SearchDomainServiceExecutionOptions options)
Executes a search domain service. Execution options (e.g. preferred search domain, search string, parameters) can be set viaSearchDomainServiceExecutionOptions
. More details on the search domain services can be found at "Search Domain Services" openBIS WIKI page.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
executeAggregationService
TableModel executeAggregationService(java.lang.String sessionToken, IDssServiceId serviceId, AggregationServiceExecutionOptions options)
Executes an aggregation service with the providedIDssServiceId
id. Additional execution options (e.g. parameters) can be set viaAggregationServiceExecutionOptions
. More details on the aggregation services can be found at "Reporting Plugins" openBIS WIKI page (type: AGGREGATION_TABLE_MODEL).Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
executeReportingService
TableModel executeReportingService(java.lang.String sessionToken, IDssServiceId serviceId, ReportingServiceExecutionOptions options)
Executes a reporting service with the providedIDssServiceId
id. Additional execution options (e.g. data set codes) can be set viaReportingServiceExecutionOptions
. More details on the reporting services can be found at "Reporting Plugins" openBIS WIKI page (type: TABLE_MODEL).Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
executeProcessingService
void executeProcessingService(java.lang.String sessionToken, IDssServiceId serviceId, ProcessingServiceExecutionOptions options)
Executes a processing service with the providedIDssServiceId
id. Additional execution options (e.g. data set codes, parameters) can be set viaProcessingServiceExecutionOptions
. More details on the processing services can be found at "Processing Plugins" openBIS WIKI page.Required access rights:
PROJECT_USER
or stronger- Throws:
UserFailureException
- in case of any problems
-
executeQuery
TableModel executeQuery(java.lang.String sessionToken, IQueryId queryId, QueryExecutionOptions options)
Executes a query with the providedIQueryId
id. Additional execution options (e.g. parameters) can be set viaQueryExecutionOptions
.Required access rights: depends on a query and a query database (more details at "Custom Database Queries" openBIS WIKI page)
- Throws:
UserFailureException
- in case of any problems
-
executeSql
TableModel executeSql(java.lang.String sessionToken, java.lang.String sql, SqlExecutionOptions options)
Executes the provided SQL. Only SELECT statements are allowed. Additional execution options (e.g. databaseId, parameters) can be set viaSqlExecutionOptions
.Required access rights: depends on a database (more details at "Custom Database Queries" openBIS WIKI page)
- Throws:
UserFailureException
- in case of any problems
-
evaluatePlugin
PluginEvaluationResult evaluatePlugin(java.lang.String sessionToken, PluginEvaluationOptions options)
Evaluates the provided plugin (e.g. a dynamic property plugin or an entity validation plugin). Parameters to be passed to the plugin can be set viaPluginEvaluationOptions
subclasses. The method returns appropriate subclasses ofPluginEvaluationResult
depending on the plugin type.Required access rights:
INSTANCE_ADMIN
- Throws:
UserFailureException
- in case of any problems
-
archiveDataSets
void archiveDataSets(java.lang.String sessionToken, java.util.List<? extends IDataSetId> dataSetIds, DataSetArchiveOptions options)
Archives data sets with the providedIDataSetId
ids. Additional archiving options can be set viaDataSetArchiveOptions
.Required access rights:
PROJECT_POWER_USER
or stronger- Throws:
UserFailureException
- in case of any problems
-
unarchiveDataSets
void unarchiveDataSets(java.lang.String sessionToken, java.util.List<? extends IDataSetId> dataSetIds, DataSetUnarchiveOptions options)
Unarchives data sets with the providedIDataSetId
ids. Additional unarchiving options can be set viaDataSetUnarchiveOptions
.Required access rights:
PROJECT_USER
or stronger- Throws:
UserFailureException
- in case of any problems
-
lockDataSets
void lockDataSets(java.lang.String sessionToken, java.util.List<? extends IDataSetId> dataSetIds, DataSetLockOptions options)
Locks data sets with the providedIDataSetId
ids. Additional locking options can be set viaDataSetLockOptions
.Required access rights:
PROJECT_ADMIN
or stronger- Throws:
UserFailureException
- in case of any problems
-
unlockDataSets
void unlockDataSets(java.lang.String sessionToken, java.util.List<? extends IDataSetId> dataSetIds, DataSetUnlockOptions options)
Unlocks data sets with the providedIDataSetId
ids. Additional unlocking options can be set viaDataSetUnlockOptions
.Required access rights:
PROJECT_ADMIN
or stronger- Throws:
UserFailureException
- in case of any problems
-
executeOperations
IOperationExecutionResults executeOperations(java.lang.String sessionToken, java.util.List<? extends IOperation> operations, IOperationExecutionOptions options)
Executes all provided operations in one transaction. Depending on the chosen execution options (SynchronousOperationExecutionOptions
orAsynchronousOperationExecutionOptions
) the operations are executed synchronously (i.e. in the same thread) or asynchronously (i.e. are scheduled for later execution in a separate thread). Synchronous execution returnsSynchronousOperationExecutionResults
object. Asynchronous execution returnsAsynchronousOperationExecutionResults
.Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems- See Also:
getOperationExecutions(String, List, OperationExecutionFetchOptions)
,searchOperationExecutions(String, OperationExecutionSearchCriteria, OperationExecutionFetchOptions)
,updateOperationExecutions(String, List)
,deleteOperationExecutions(String, List, OperationExecutionDeletionOptions)
-
getServerInformation
java.util.Map<java.lang.String,java.lang.String> getServerInformation(java.lang.String sessionToken)
Returns a map with additional server information:- api-version : major and minor version of the API (e.g. "3.4")
- project-samples-enabled : true/false
- archiving-configured : true/false
- enabled-technologies : comma-separated list of enabled technologies (core-plugins modules)
- authentication-service : currently used authenticated service (e.g. "ldap-authentication-service")
- authentication-service.switch-aai.link : link for SSO authentication via SWITCHaai
- authentication-service.switch-aai.label : label for SSO authentication via SWITCHaai
Required access rights:
PROJECT_OBSERVER
or stronger- Throws:
UserFailureException
- in case of any problems
-
getServerPublicInformation
java.util.Map<java.lang.String,java.lang.String> getServerPublicInformation()
Returns a map with additional server public information:- authentication-service : currently used authenticated service (e.g. "ldap-authentication-service")
- authentication-service.switch-aai.link : link for SSO authentication via SWITCHaai
- authentication-service.switch-aai.label : label for SSO authentication via SWITCHaai
Required access rights: none
- Throws:
UserFailureException
- in case of any problems
-
createPermIdStrings
java.util.List<java.lang.String> createPermIdStrings(java.lang.String sessionToken, int count)
Generates globally unique identifiers that consist of a timestamp and a sequence generated number (e.g. "20180531170854641-944"). This method uses one global sequence.Required access rights:
PROJECT_USER
or stronger- Throws:
UserFailureException
- in case of any problems
-
createCodes
java.util.List<java.lang.String> createCodes(java.lang.String sessionToken, java.lang.String prefix, EntityKind entityKind, int count)
Generates identifiers that are unique for a given entity kind and consist of a prefix and a sequence generated number (e.g. "MY-PREFIX-147"); this method uses a dedicated sequence for each entity kind.Required access rights:
PROJECT_USER
or stronger- Throws:
UserFailureException
- in case of any problems
-
-