{ "key": "Nuxeo-unknown", "hidden": false, "bundleIds": [ "org.nuxeo.apidoc.core", "org.nuxeo.apidoc.repo", "org.nuxeo.directory.mongodb", "org.nuxeo.ecm.actions", "org.nuxeo.ecm.automation.core", "org.nuxeo.ecm.automation.features", "org.nuxeo.ecm.automation.io", "org.nuxeo.ecm.automation.scripting", "org.nuxeo.ecm.automation.server", "org.nuxeo.ecm.config", "org.nuxeo.ecm.core", "org.nuxeo.ecm.core.api", "org.nuxeo.ecm.core.bulk", "org.nuxeo.ecm.core.bulk.test", "org.nuxeo.ecm.core.cache", "org.nuxeo.ecm.core.convert", "org.nuxeo.ecm.core.convert.plugins", "org.nuxeo.ecm.core.event", "org.nuxeo.ecm.core.event.test", "org.nuxeo.ecm.core.io", "org.nuxeo.ecm.core.management", "org.nuxeo.ecm.core.mimetype", "org.nuxeo.ecm.core.query", "org.nuxeo.ecm.core.schema", "org.nuxeo.ecm.core.storage", "org.nuxeo.ecm.core.storage.dbs", "org.nuxeo.ecm.core.storage.mem", "org.nuxeo.ecm.core.storage.mongodb", "org.nuxeo.ecm.core.storage.sql", "org.nuxeo.ecm.core.storage.sql.test", "org.nuxeo.ecm.core.test", "org.nuxeo.ecm.directory", "org.nuxeo.ecm.directory.api", "org.nuxeo.ecm.directory.sql", "org.nuxeo.ecm.directory.types.contrib", "org.nuxeo.ecm.platform.api", "org.nuxeo.ecm.platform.commandline.executor", "org.nuxeo.ecm.platform.content.template", "org.nuxeo.ecm.platform.dublincore", "org.nuxeo.ecm.platform.el", "org.nuxeo.ecm.platform.forms.layout.export", "org.nuxeo.ecm.platform.login", "org.nuxeo.ecm.platform.query.api", "org.nuxeo.ecm.platform.usermanager", "org.nuxeo.ecm.platform.usermanager.api", "org.nuxeo.ecm.platform.web.common", "org.nuxeo.ecm.webengine.core", "org.nuxeo.ecm.webengine.jaxrs", "org.nuxeo.elasticsearch.core", "org.nuxeo.osgi.app", "org.nuxeo.runtime", "org.nuxeo.runtime.cluster", "org.nuxeo.runtime.datasource", "org.nuxeo.runtime.jtajca", "org.nuxeo.runtime.kv", "org.nuxeo.runtime.management", "org.nuxeo.runtime.metrics", "org.nuxeo.runtime.migration", "org.nuxeo.runtime.mongodb", "org.nuxeo.runtime.pubsub", "org.nuxeo.runtime.reload", "org.nuxeo.runtime.stream", "org.nuxeo.runtime.stream.test" ], "componentIds": [ "DublinCoreStorageService", "org.nuxeo.apidoc.adapterContrib", "org.nuxeo.apidoc.directoryContrib", "org.nuxeo.apidoc.directoryUIContrib", "org.nuxeo.apidoc.doctypeContrib", "org.nuxeo.apidoc.documentation.DocumentationComponent", "org.nuxeo.apidoc.layout.contrib", "org.nuxeo.apidoc.lifecycle.contrib", "org.nuxeo.apidoc.listener.contrib", "org.nuxeo.apidoc.schemaContrib", "org.nuxeo.apidoc.snapshot.SnapshotManagerComponent", "org.nuxeo.apidoc.test.works", "org.nuxeo.apidoc.uiContrib", "org.nuxeo.automation.scripting.classfilter", "org.nuxeo.automation.scripting.internals.AutomationScriptingComponent", "org.nuxeo.core.LocalConfigurationService", "org.nuxeo.directory.mongodb.MongoDBDirectoryFactory", "org.nuxeo.directory.test.sql", "org.nuxeo.ecm.automation.core.impl.ReloadListener", "org.nuxeo.ecm.automation.core.impl.workmanager", "org.nuxeo.ecm.automation.io.services.IOComponent", "org.nuxeo.ecm.automation.io.services.IOComponent.codec.contrib", "org.nuxeo.ecm.automation.rest.pageprovider.contrib", "org.nuxeo.ecm.automation.server.AutomationServer", "org.nuxeo.ecm.automation.server.BatchManager", "org.nuxeo.ecm.automation.server.auth.config", "org.nuxeo.ecm.automation.server.batch.handler.DefaultBatchHandler", "org.nuxeo.ecm.automation.server.bindings", "org.nuxeo.ecm.automation.server.marshallers", "org.nuxeo.ecm.core.CoreExtensions", "org.nuxeo.ecm.core.CoreService", "org.nuxeo.ecm.core.DocumentModel.resolver", "org.nuxeo.ecm.core.LifecycleCoreExtensions", "org.nuxeo.ecm.core.api.CoreSessionServiceImpl", "org.nuxeo.ecm.core.api.DocumentAdapterService", "org.nuxeo.ecm.core.api.DocumentValidationService", "org.nuxeo.ecm.core.api.DocumentValidationService.activations", "org.nuxeo.ecm.core.api.blobholder.BlobHolderAdapterComponent", "org.nuxeo.ecm.core.api.blohodlers.adapters", "org.nuxeo.ecm.core.api.local.dummy.login", "org.nuxeo.ecm.core.api.pathsegment.PathSegmentService", "org.nuxeo.ecm.core.api.properties", "org.nuxeo.ecm.core.api.propertiesmapping.PropertiesMappingComponent", "org.nuxeo.ecm.core.api.repository.RepositoryManager", "org.nuxeo.ecm.core.api.thumbnail.ThumbnailService", "org.nuxeo.ecm.core.api.thumbnail.adapter", "org.nuxeo.ecm.core.api.versioning.VersioningService", "org.nuxeo.ecm.core.automation.contextContrib", "org.nuxeo.ecm.core.automation.core.properties", "org.nuxeo.ecm.core.automation.coreContrib", "org.nuxeo.ecm.core.automation.features.bindings", "org.nuxeo.ecm.core.automation.features.bulk", "org.nuxeo.ecm.core.automation.features.operations", "org.nuxeo.ecm.core.automation.marshallers", "org.nuxeo.ecm.core.automation.scripting.contextContrib", "org.nuxeo.ecm.core.blob.BlobManager", "org.nuxeo.ecm.core.blob.DocumentBlobManager", "org.nuxeo.ecm.core.bulk", "org.nuxeo.ecm.core.bulk.config", "org.nuxeo.ecm.core.bulk.io", "org.nuxeo.ecm.core.bulk.tests", "org.nuxeo.ecm.core.cache.CacheService", "org.nuxeo.ecm.core.coldstorage.contrib", "org.nuxeo.ecm.core.convert.configuration", "org.nuxeo.ecm.core.convert.plugins", "org.nuxeo.ecm.core.convert.service.ConversionServiceImpl", "org.nuxeo.ecm.core.deletion.config", "org.nuxeo.ecm.core.document.characterFiltering.contrib", "org.nuxeo.ecm.core.event.EventServiceComponent", "org.nuxeo.ecm.core.event.lifecycle.listener", "org.nuxeo.ecm.core.event.orphanVersionRemoval.listener", "org.nuxeo.ecm.core.filter.CharacterFilteringService", "org.nuxeo.ecm.core.io.DocumentXMLExporter", "org.nuxeo.ecm.core.io.MarshallerRegistry", "org.nuxeo.ecm.core.io.MarshallerRegistry.marshallers", "org.nuxeo.ecm.core.io.avro.factories", "org.nuxeo.ecm.core.io.download.DownloadService", "org.nuxeo.ecm.core.lifecycle.LifeCycleService", "org.nuxeo.ecm.core.management.CoreManagementComponent", "org.nuxeo.ecm.core.management.contribs", "org.nuxeo.ecm.core.management.es.tests", "org.nuxeo.ecm.core.management.listener", "org.nuxeo.ecm.core.management.runtime.management.contribs", "org.nuxeo.ecm.core.management.typesContrib", "org.nuxeo.ecm.core.managemment.standby", "org.nuxeo.ecm.core.operation.OperationServiceComponent", "org.nuxeo.ecm.core.orphanVersionsCleanup", "org.nuxeo.ecm.core.query.properties", "org.nuxeo.ecm.core.repository.RepositoryService", "org.nuxeo.ecm.core.repository.RepositoryServiceComponent", "org.nuxeo.ecm.core.retention.contrib", "org.nuxeo.ecm.core.scheduler.SchedulerService", "org.nuxeo.ecm.core.schedulers", "org.nuxeo.ecm.core.schema.ObjectResolverService", "org.nuxeo.ecm.core.schema.TypeService", "org.nuxeo.ecm.core.scroll.contrib.default", "org.nuxeo.ecm.core.scroll.service", "org.nuxeo.ecm.core.security.SecurityService", "org.nuxeo.ecm.core.security.acl.properties", "org.nuxeo.ecm.core.security.defaultPermissions", "org.nuxeo.ecm.core.security.defaultPolicies", "org.nuxeo.ecm.core.storage.dbs.DBSRepositoryService", "org.nuxeo.ecm.core.storage.lock.LockManagerService", "org.nuxeo.ecm.core.storage.mem.MemRepositoryService", "org.nuxeo.ecm.core.storage.mongodb.MongoDBRepositoryService", "org.nuxeo.ecm.core.storage.mongodb.configuration", "org.nuxeo.ecm.core.storage.sql.RepositoryService", "org.nuxeo.ecm.core.storage.sql.jdbc.QueryMakerService", "org.nuxeo.ecm.core.storage.sql.jdbc.querymaker.contrib", "org.nuxeo.ecm.core.storage.sql.softdelete", "org.nuxeo.ecm.core.storage.sql.test.repo.repository", "org.nuxeo.ecm.core.test.blobmanager", "org.nuxeo.ecm.core.transientstore.TransientStorageComponent", "org.nuxeo.ecm.core.trash.TrashService", "org.nuxeo.ecm.core.trash.service.migrator", "org.nuxeo.ecm.core.uidgen.UIDGeneratorService", "org.nuxeo.ecm.core.uidseq.keyvaluestore", "org.nuxeo.ecm.core.versioning.VersioningDocumentAdapter", "org.nuxeo.ecm.core.versioning.default-policies", "org.nuxeo.ecm.core.work.config", "org.nuxeo.ecm.core.work.service", "org.nuxeo.ecm.core.work.test.default.queuing", "org.nuxeo.ecm.directory.DirectoryServiceImpl", "org.nuxeo.ecm.directory.GenericDirectory", "org.nuxeo.ecm.directory.actions.core", "org.nuxeo.ecm.directory.core.CoreDirectoryFactory", "org.nuxeo.ecm.directory.local.configuration", "org.nuxeo.ecm.directory.marshallers", "org.nuxeo.ecm.directory.resolver", "org.nuxeo.ecm.directory.sql.SQLDirectoryFactory", "org.nuxeo.ecm.directory.types", "org.nuxeo.ecm.platform.actions.ActionService", "org.nuxeo.ecm.platform.actions.ActionService.properties", "org.nuxeo.ecm.platform.audit.PageProviderservice.automation.contrib", "org.nuxeo.ecm.platform.commandline.executor.service.CommandLineExecutorComponent", "org.nuxeo.ecm.platform.commandline.executor.service.defaultContrib", "org.nuxeo.ecm.platform.computedgroups.ComputedGroupsServiceImpl", "org.nuxeo.ecm.platform.computedgroups.UserManager.companyComputerContrib", "org.nuxeo.ecm.platform.content.template.listener", "org.nuxeo.ecm.platform.content.template.service.ContentTemplateService", "org.nuxeo.ecm.platform.content.template.service.ContentTemplateService.defaultContrib", "org.nuxeo.ecm.platform.contentview.json.marshallers", "org.nuxeo.ecm.platform.convert.commandline.pdf2text", "org.nuxeo.ecm.platform.directory.pageproviders", "org.nuxeo.ecm.platform.el.service", "org.nuxeo.ecm.platform.filters", "org.nuxeo.ecm.platform.mimetype.service.MimetypeRegistryService", "org.nuxeo.ecm.platform.query.api.PageProviderService", "org.nuxeo.ecm.platform.test.directory.sql.storage", "org.nuxeo.ecm.platform.ui.web.auth.WebEngineConfig", "org.nuxeo.ecm.platform.ui.web.auth.defaultConfig", "org.nuxeo.ecm.platform.ui.web.auth.service.PluggableAuthenticationService", "org.nuxeo.ecm.platform.ui.web.cors", "org.nuxeo.ecm.platform.ui.web.login", "org.nuxeo.ecm.platform.usermanager.UserManagerImpl", "org.nuxeo.ecm.platform.usermanager.UserService", "org.nuxeo.ecm.platform.usermanager.adapter", "org.nuxeo.ecm.platform.usermanager.marshallers", "org.nuxeo.ecm.platform.usermanager.pageproviders", "org.nuxeo.ecm.platform.usermanager.properties", "org.nuxeo.ecm.platform.usermanager.resolver", "org.nuxeo.ecm.platform.web.common.adminStatusListener.contrib", "org.nuxeo.ecm.platform.web.common.exceptionhandling.service.ExceptionHandlingContrib", "org.nuxeo.ecm.platform.web.common.exceptionhandling.service.ExceptionHandlingService", "org.nuxeo.ecm.platform.web.common.locale", "org.nuxeo.ecm.platform.web.common.locale.default.contrib", "org.nuxeo.ecm.platform.web.common.requestcontroller.service.RequestControllerService", "org.nuxeo.ecm.platform.web.common.requestcontroller.service.RequestControllerService.defaultContrib", "org.nuxeo.ecm.platform.web.common.test.login.as", "org.nuxeo.ecm.webengine.WebEngineComponent", "org.nuxeo.ecm.webengine.core.service.json", "org.nuxeo.ecm.webengine.jaxrs.servlet.config.ServletRegistryComponent", "org.nuxeo.elasticsearch.ElasticSearchComponent", "org.nuxeo.elasticsearch.ElasticSearchComponent.contrib", "org.nuxeo.elasticsearch.core.bulk.contrib", "org.nuxeo.elasticsearch.core.listener", "org.nuxeo.elasticsearch.hint.contrib", "org.nuxeo.elasticsearch.managment.contrib", "org.nuxeo.elasticsearch.marshallers", "org.nuxeo.elasticsearch.scroll.contrib", "org.nuxeo.elasticsearch.test.contrib", "org.nuxeo.elasticsearch.work.config", "org.nuxeo.runtime.ConfigurationService", "org.nuxeo.runtime.EventService", "org.nuxeo.runtime.LoginAsComponent", "org.nuxeo.runtime.LoginComponent", "org.nuxeo.runtime.RuntimeComponent", "org.nuxeo.runtime.avro", "org.nuxeo.runtime.avro.contrib", "org.nuxeo.runtime.cluster.ClusterService", "org.nuxeo.runtime.cluster.test.feature", "org.nuxeo.runtime.codec.service", "org.nuxeo.runtime.datasource", "org.nuxeo.runtime.jtajca.JtaActivator", "org.nuxeo.runtime.kv.KeyValueService", "org.nuxeo.runtime.management.ResourcePublisher", "org.nuxeo.runtime.management.ServerLocator", "org.nuxeo.runtime.management.counters", "org.nuxeo.runtime.management.metrics", "org.nuxeo.runtime.metrics.MetricsService", "org.nuxeo.runtime.migration.MigrationService", "org.nuxeo.runtime.model.persistence", "org.nuxeo.runtime.mongodb.MongoDBComponent", "org.nuxeo.runtime.pubsub.PubSubService", "org.nuxeo.runtime.reload", "org.nuxeo.runtime.services.resource.ResourceService", "org.nuxeo.runtime.started", "org.nuxeo.runtime.stream.kafka.service", "org.nuxeo.runtime.stream.service", "org.nuxeo.runtime.stream.service.managment.contrib", "org.nuxeo.runtime.trackers.files", "org.nuxeo.runtime.trackers.files.threadstracking.config" ], "serviceIds": [ "org.apache.avro.message.SchemaStore", "org.nuxeo.apidoc.documentation.DocumentationService", "org.nuxeo.apidoc.search.ArtifactSearcher", "org.nuxeo.apidoc.snapshot.SnapshotManager", "org.nuxeo.automation.scripting.api.AutomationScriptingService", "org.nuxeo.ecm.automation.AutomationAdmin", "org.nuxeo.ecm.automation.AutomationService", "org.nuxeo.ecm.automation.context.ContextService", "org.nuxeo.ecm.automation.core.events.EventHandlerRegistry", "org.nuxeo.ecm.automation.core.trace.TracerFactory", "org.nuxeo.ecm.automation.io.services.codec.ObjectCodecService", "org.nuxeo.ecm.automation.server.AutomationServer", "org.nuxeo.ecm.automation.server.jaxrs.batch.BatchManager", "org.nuxeo.ecm.core.CoreService", "org.nuxeo.ecm.core.api.CoreSessionService", "org.nuxeo.ecm.core.api.adapter.DocumentAdapterService", "org.nuxeo.ecm.core.api.blobholder.BlobHolderAdapterService", "org.nuxeo.ecm.core.api.localconfiguration.LocalConfigurationService", "org.nuxeo.ecm.core.api.pathsegment.PathSegmentService", "org.nuxeo.ecm.core.api.propertiesmapping.PropertiesMappingService", "org.nuxeo.ecm.core.api.repository.RepositoryManager", "org.nuxeo.ecm.core.api.scroll.ScrollService", "org.nuxeo.ecm.core.api.security.AdministratorGroupsProvider", "org.nuxeo.ecm.core.api.security.PermissionProvider", "org.nuxeo.ecm.core.api.thumbnail.ThumbnailService", "org.nuxeo.ecm.core.api.trash.TrashService", "org.nuxeo.ecm.core.api.validation.DocumentValidationService", "org.nuxeo.ecm.core.api.versioning.VersioningService", "org.nuxeo.ecm.core.blob.BlobManager", "org.nuxeo.ecm.core.blob.DocumentBlobManager", "org.nuxeo.ecm.core.bulk.BulkAdminService", "org.nuxeo.ecm.core.bulk.BulkService", "org.nuxeo.ecm.core.cache.CacheService", "org.nuxeo.ecm.core.convert.api.ConversionService", "org.nuxeo.ecm.core.convert.service.MimeTypeTranslationHelper", "org.nuxeo.ecm.core.event.EventProducer", "org.nuxeo.ecm.core.event.EventService", "org.nuxeo.ecm.core.event.EventServiceAdmin", "org.nuxeo.ecm.core.event.EventStats", "org.nuxeo.ecm.core.filter.CharacterFilteringService", "org.nuxeo.ecm.core.io.DocumentXMLExporter", "org.nuxeo.ecm.core.io.download.DownloadService", "org.nuxeo.ecm.core.io.registry.MarshallerRegistry", "org.nuxeo.ecm.core.lifecycle.LifeCycleService", "org.nuxeo.ecm.core.management.api.AdministrativeStatusManager", "org.nuxeo.ecm.core.management.api.GlobalAdministrativeStatusManager", "org.nuxeo.ecm.core.management.api.ProbeManager", "org.nuxeo.ecm.core.repository.RepositoryService", "org.nuxeo.ecm.core.scheduler.SchedulerService", "org.nuxeo.ecm.core.schema.PropertyCharacteristicHandler", "org.nuxeo.ecm.core.schema.SchemaManager", "org.nuxeo.ecm.core.schema.TypeProvider", "org.nuxeo.ecm.core.schema.types.resolver.ObjectResolverService", "org.nuxeo.ecm.core.security.SecurityPolicyService", "org.nuxeo.ecm.core.security.SecurityService", "org.nuxeo.ecm.core.storage.dbs.DBSRepositoryService", "org.nuxeo.ecm.core.storage.lock.LockManagerService", "org.nuxeo.ecm.core.storage.mem.MemRepositoryService", "org.nuxeo.ecm.core.storage.mongodb.MongoDBRepositoryService", "org.nuxeo.ecm.core.storage.sql.coremodel.SQLRepositoryService", "org.nuxeo.ecm.core.storage.sql.jdbc.QueryMakerService", "org.nuxeo.ecm.core.transientstore.api.TransientStoreService", "org.nuxeo.ecm.core.trash.TrashService", "org.nuxeo.ecm.core.trash.TrashServiceImpl", "org.nuxeo.ecm.core.uidgen.UIDGeneratorService", "org.nuxeo.ecm.core.uidgen.UIDSequencer", "org.nuxeo.ecm.core.versioning.VersioningService", "org.nuxeo.ecm.core.work.api.WorkManager", "org.nuxeo.ecm.directory.api.DirectoryService", "org.nuxeo.ecm.platform.actions.ejb.ActionManager", "org.nuxeo.ecm.platform.commandline.executor.api.CommandLineExecutorService", "org.nuxeo.ecm.platform.computedgroups.ComputedGroupsService", "org.nuxeo.ecm.platform.content.template.service.ContentTemplateService", "org.nuxeo.ecm.platform.dublincore.service.DublinCoreStorageService", "org.nuxeo.ecm.platform.el.ELService", "org.nuxeo.ecm.platform.mimetype.interfaces.MimetypeRegistry", "org.nuxeo.ecm.platform.query.api.PageProviderService", "org.nuxeo.ecm.platform.ui.web.auth.service.PluggableAuthenticationService", "org.nuxeo.ecm.platform.usermanager.MultiTenantUserManager", "org.nuxeo.ecm.platform.usermanager.UserManager", "org.nuxeo.ecm.platform.web.common.exceptionhandling.service.ExceptionHandlingService", "org.nuxeo.ecm.platform.web.common.locale.LocaleProvider", "org.nuxeo.ecm.platform.web.common.requestcontroller.service.RequestControllerManager", "org.nuxeo.ecm.webengine.JsonFactoryManager", "org.nuxeo.ecm.webengine.WebEngine", "org.nuxeo.elasticsearch.api.ElasticSearchAdmin", "org.nuxeo.elasticsearch.api.ElasticSearchIndexing", "org.nuxeo.elasticsearch.api.ElasticSearchService", "org.nuxeo.runtime.api.login.Authenticator", "org.nuxeo.runtime.api.login.LoginAs", "org.nuxeo.runtime.api.login.LoginService", "org.nuxeo.runtime.avro.AvroService", "org.nuxeo.runtime.cluster.ClusterService", "org.nuxeo.runtime.codec.CodecService", "org.nuxeo.runtime.datasource.PooledDataSourceRegistry", "org.nuxeo.runtime.kafka.KafkaConfigService", "org.nuxeo.runtime.kv.KeyValueService", "org.nuxeo.runtime.management.ResourcePublisher", "org.nuxeo.runtime.management.ServerLocator", "org.nuxeo.runtime.management.counters.CounterManager", "org.nuxeo.runtime.management.metrics.MetricEnabler", "org.nuxeo.runtime.management.metrics.MetricSerializer", "org.nuxeo.runtime.metrics.MetricsService", "org.nuxeo.runtime.migration.MigrationService", "org.nuxeo.runtime.model.persistence.ContributionPersistenceManager", "org.nuxeo.runtime.mongodb.MongoDBConnectionService", "org.nuxeo.runtime.pubsub.PubSubService", "org.nuxeo.runtime.reload.ReloadService", "org.nuxeo.runtime.services.config.ConfigurationService", "org.nuxeo.runtime.services.event.EventService", "org.nuxeo.runtime.services.resource.ResourceService", "org.nuxeo.runtime.stream.StreamService" ], "extensionPointIds": [ "org.nuxeo.automation.scripting.internals.AutomationScriptingComponent--classFilter", "org.nuxeo.automation.scripting.internals.AutomationScriptingComponent--operation", "org.nuxeo.directory.mongodb.MongoDBDirectoryFactory--directories", "org.nuxeo.ecm.automation.io.services.IOComponent--codecs", "org.nuxeo.ecm.automation.server.AutomationServer--bindings", "org.nuxeo.ecm.automation.server.AutomationServer--marshallers", "org.nuxeo.ecm.automation.server.BatchManager--handlers", "org.nuxeo.ecm.core.CoreService--orphanVersionRemovalFilter", "org.nuxeo.ecm.core.CoreService--versionRemovalPolicy", "org.nuxeo.ecm.core.api.DocumentAdapterService--adapters", "org.nuxeo.ecm.core.api.DocumentValidationService--activations", "org.nuxeo.ecm.core.api.blobholder.BlobHolderAdapterComponent--BlobHolderFactory", "org.nuxeo.ecm.core.api.blobholder.BlobHolderAdapterComponent--ExternalBlobAdapter", "org.nuxeo.ecm.core.api.pathsegment.PathSegmentService--pathSegmentService", "org.nuxeo.ecm.core.api.propertiesmapping.PropertiesMappingComponent--mapping", "org.nuxeo.ecm.core.api.repository.RepositoryManager--repositories", "org.nuxeo.ecm.core.api.thumbnail.ThumbnailService--thumbnailFactory", "org.nuxeo.ecm.core.api.versioning.VersioningService--filters", "org.nuxeo.ecm.core.api.versioning.VersioningService--policies", "org.nuxeo.ecm.core.api.versioning.VersioningService--restrictions", "org.nuxeo.ecm.core.api.versioning.VersioningService--versioningRules", "org.nuxeo.ecm.core.api.versioning.VersioningService--versioningService", "org.nuxeo.ecm.core.blob.BlobManager--configuration", "org.nuxeo.ecm.core.blob.DocumentBlobManager--configuration", "org.nuxeo.ecm.core.bulk--actions", "org.nuxeo.ecm.core.cache.CacheService--caches", "org.nuxeo.ecm.core.convert.service.ConversionServiceImpl--configuration", "org.nuxeo.ecm.core.convert.service.ConversionServiceImpl--converter", "org.nuxeo.ecm.core.event.EventServiceComponent--dispatcher", "org.nuxeo.ecm.core.event.EventServiceComponent--listener", "org.nuxeo.ecm.core.event.EventServiceComponent--pipe", "org.nuxeo.ecm.core.filter.CharacterFilteringService--filtering", "org.nuxeo.ecm.core.io.MarshallerRegistry--marshallers", "org.nuxeo.ecm.core.io.download.DownloadService--permissions", "org.nuxeo.ecm.core.io.download.DownloadService--redirectResolver", "org.nuxeo.ecm.core.lifecycle.LifeCycleService--lifecycle", "org.nuxeo.ecm.core.lifecycle.LifeCycleService--types", "org.nuxeo.ecm.core.management.CoreManagementComponent--healthCheck", "org.nuxeo.ecm.core.management.CoreManagementComponent--probes", "org.nuxeo.ecm.core.management.CoreManagementComponent--serviceDefinition", "org.nuxeo.ecm.core.management.CoreManagementComponent--storageConfiguration", "org.nuxeo.ecm.core.management.CoreManagementComponent--storageHandlers", "org.nuxeo.ecm.core.operation.OperationServiceComponent--adapters", "org.nuxeo.ecm.core.operation.OperationServiceComponent--automationFilter", "org.nuxeo.ecm.core.operation.OperationServiceComponent--chainException", "org.nuxeo.ecm.core.operation.OperationServiceComponent--chains", "org.nuxeo.ecm.core.operation.OperationServiceComponent--contextHelpers", "org.nuxeo.ecm.core.operation.OperationServiceComponent--event-handlers", "org.nuxeo.ecm.core.operation.OperationServiceComponent--operations", "org.nuxeo.ecm.core.repository.RepositoryService--repository", "org.nuxeo.ecm.core.scheduler.SchedulerService--schedule", "org.nuxeo.ecm.core.schema.ObjectResolverService--resolvers", "org.nuxeo.ecm.core.schema.TypeService--configuration", "org.nuxeo.ecm.core.schema.TypeService--deprecation", "org.nuxeo.ecm.core.schema.TypeService--doctype", "org.nuxeo.ecm.core.schema.TypeService--schema", "org.nuxeo.ecm.core.scroll.service--scroll", "org.nuxeo.ecm.core.security.SecurityService--permissions", "org.nuxeo.ecm.core.security.SecurityService--permissionsVisibility", "org.nuxeo.ecm.core.security.SecurityService--policies", "org.nuxeo.ecm.core.storage.lock.LockManagerService--lockmanager", "org.nuxeo.ecm.core.storage.mem.MemRepositoryService--repository", "org.nuxeo.ecm.core.storage.mongodb.MongoDBRepositoryService--repository", "org.nuxeo.ecm.core.storage.sql.RepositoryService--repository", "org.nuxeo.ecm.core.storage.sql.jdbc.QueryMakerService--queryMaker", "org.nuxeo.ecm.core.transientstore.TransientStorageComponent--store", "org.nuxeo.ecm.core.uidgen.UIDGeneratorService--generators", "org.nuxeo.ecm.core.uidgen.UIDGeneratorService--sequencers", "org.nuxeo.ecm.core.work.service--implementation", "org.nuxeo.ecm.core.work.service--queues", "org.nuxeo.ecm.directory.DirectoryServiceImpl--factoryDescriptor", "org.nuxeo.ecm.directory.GenericDirectory--directories", "org.nuxeo.ecm.directory.core.CoreDirectoryFactory--directories", "org.nuxeo.ecm.directory.sql.SQLDirectoryFactory--directories", "org.nuxeo.ecm.platform.actions.ActionService--actions", "org.nuxeo.ecm.platform.actions.ActionService--filters", "org.nuxeo.ecm.platform.actions.ActionService--typeCompatibility", "org.nuxeo.ecm.platform.commandline.executor.service.CommandLineExecutorComponent--command", "org.nuxeo.ecm.platform.commandline.executor.service.CommandLineExecutorComponent--commandTester", "org.nuxeo.ecm.platform.commandline.executor.service.CommandLineExecutorComponent--environment", "org.nuxeo.ecm.platform.computedgroups.ComputedGroupsServiceImpl--computer", "org.nuxeo.ecm.platform.computedgroups.ComputedGroupsServiceImpl--computerChain", "org.nuxeo.ecm.platform.content.template.service.ContentTemplateService--factory", "org.nuxeo.ecm.platform.content.template.service.ContentTemplateService--factoryBinding", "org.nuxeo.ecm.platform.content.template.service.ContentTemplateService--postContentCreationHandlers", "org.nuxeo.ecm.platform.el.service--elContextFactory", "org.nuxeo.ecm.platform.mimetype.service.MimetypeRegistryService--extension", "org.nuxeo.ecm.platform.mimetype.service.MimetypeRegistryService--mimetype", "org.nuxeo.ecm.platform.query.api.PageProviderService--providers", "org.nuxeo.ecm.platform.query.api.PageProviderService--replacers", "org.nuxeo.ecm.platform.ui.web.auth.service.PluggableAuthenticationService--authenticators", "org.nuxeo.ecm.platform.ui.web.auth.service.PluggableAuthenticationService--chain", "org.nuxeo.ecm.platform.ui.web.auth.service.PluggableAuthenticationService--loginScreen", "org.nuxeo.ecm.platform.ui.web.auth.service.PluggableAuthenticationService--openUrl", "org.nuxeo.ecm.platform.ui.web.auth.service.PluggableAuthenticationService--sessionManager", "org.nuxeo.ecm.platform.ui.web.auth.service.PluggableAuthenticationService--specificChains", "org.nuxeo.ecm.platform.ui.web.auth.service.PluggableAuthenticationService--startURL", "org.nuxeo.ecm.platform.usermanager.UserService--userManager", "org.nuxeo.ecm.platform.web.common.exceptionhandling.service.ExceptionHandlingService--errorhandlers", "org.nuxeo.ecm.platform.web.common.exceptionhandling.service.ExceptionHandlingService--exceptionhandler", "org.nuxeo.ecm.platform.web.common.exceptionhandling.service.ExceptionHandlingService--listener", "org.nuxeo.ecm.platform.web.common.exceptionhandling.service.ExceptionHandlingService--requestdump", "org.nuxeo.ecm.platform.web.common.locale--providers", "org.nuxeo.ecm.platform.web.common.requestcontroller.service.RequestControllerService--corsConfig", "org.nuxeo.ecm.platform.web.common.requestcontroller.service.RequestControllerService--filterConfig", "org.nuxeo.ecm.platform.web.common.requestcontroller.service.RequestControllerService--responseHeaders", "org.nuxeo.ecm.webengine.WebEngineComponent--guard", "org.nuxeo.ecm.webengine.WebEngineComponent--rendering-extension", "org.nuxeo.ecm.webengine.WebEngineComponent--request-configuration", "org.nuxeo.ecm.webengine.WebEngineComponent--resource", "org.nuxeo.ecm.webengine.jaxrs.servlet.config.ServletRegistryComponent--filters", "org.nuxeo.ecm.webengine.jaxrs.servlet.config.ServletRegistryComponent--resources", "org.nuxeo.ecm.webengine.jaxrs.servlet.config.ServletRegistryComponent--servlets", "org.nuxeo.ecm.webengine.jaxrs.servlet.config.ServletRegistryComponent--subresources", "org.nuxeo.elasticsearch.ElasticSearchComponent--elasticSearchClient", "org.nuxeo.elasticsearch.ElasticSearchComponent--elasticSearchDocWriter", "org.nuxeo.elasticsearch.ElasticSearchComponent--elasticSearchEmbeddedServer", "org.nuxeo.elasticsearch.ElasticSearchComponent--elasticSearchHints", "org.nuxeo.elasticsearch.ElasticSearchComponent--elasticSearchIndex", "org.nuxeo.runtime.ConfigurationService--configuration", "org.nuxeo.runtime.EventService--listeners", "org.nuxeo.runtime.LoginAsComponent--implementation", "org.nuxeo.runtime.avro--factory", "org.nuxeo.runtime.avro--mapper", "org.nuxeo.runtime.avro--replacement", "org.nuxeo.runtime.avro--schema", "org.nuxeo.runtime.cluster.ClusterService--configuration", "org.nuxeo.runtime.codec.service--codec", "org.nuxeo.runtime.datasource--datasources", "org.nuxeo.runtime.datasource--sorter", "org.nuxeo.runtime.kv.KeyValueService--configuration", "org.nuxeo.runtime.management.ResourcePublisher--factories", "org.nuxeo.runtime.management.ResourcePublisher--services", "org.nuxeo.runtime.management.ResourcePublisher--shortcuts", "org.nuxeo.runtime.management.ServerLocator--locators", "org.nuxeo.runtime.metrics.MetricsService--configuration", "org.nuxeo.runtime.metrics.MetricsService--reporter", "org.nuxeo.runtime.migration.MigrationService--configuration", "org.nuxeo.runtime.model.persistence--listeners", "org.nuxeo.runtime.mongodb.MongoDBComponent--connection", "org.nuxeo.runtime.pubsub.PubSubService--configuration", "org.nuxeo.runtime.services.resource.ResourceService--resources", "org.nuxeo.runtime.stream.kafka.service--kafkaConfig", "org.nuxeo.runtime.stream.service--logConfig", "org.nuxeo.runtime.stream.service--streamProcessor", "org.nuxeo.runtime.trackers.files--configs" ], "contributionIds": [ "DublinCoreStorageService--configuration", "DublinCoreStorageService--listener", "org.nuxeo.apidoc.adapterContrib--adapters", "org.nuxeo.apidoc.directoryContrib--directories", "org.nuxeo.apidoc.directoryUIContrib--directories", "org.nuxeo.apidoc.doctypeContrib--doctype", "org.nuxeo.apidoc.layout.contrib--layouts", "org.nuxeo.apidoc.layout.contrib--widgettypes", "org.nuxeo.apidoc.lifecycle.contrib--types", "org.nuxeo.apidoc.listener.contrib--listener", "org.nuxeo.apidoc.schemaContrib--schema", "org.nuxeo.apidoc.test.works--queues", "org.nuxeo.apidoc.test.works--queues1", "org.nuxeo.apidoc.uiContrib--types", "org.nuxeo.automation.scripting.classfilter--classFilter", "org.nuxeo.automation.scripting.internals.AutomationScriptingComponent--configuration", "org.nuxeo.directory.test.sql--datasources", "org.nuxeo.directory.test.sql--directories", "org.nuxeo.ecm.automation.core.impl.ReloadListener--listeners", "org.nuxeo.ecm.automation.core.impl.workmanager--queues", "org.nuxeo.ecm.automation.io.services.IOComponent.codec.contrib--codecs", "org.nuxeo.ecm.automation.rest.pageprovider.contrib--providers", "org.nuxeo.ecm.automation.server.auth.config--authenticators", "org.nuxeo.ecm.automation.server.auth.config--specificChains", "org.nuxeo.ecm.automation.server.batch.handler.DefaultBatchHandler--handlers", "org.nuxeo.ecm.automation.server.bindings--bindings", "org.nuxeo.ecm.automation.server.marshallers--marshallers", "org.nuxeo.ecm.core.CoreExtensions--configuration", "org.nuxeo.ecm.core.CoreExtensions--doctype", "org.nuxeo.ecm.core.CoreExtensions--listener", "org.nuxeo.ecm.core.CoreExtensions--schema", "org.nuxeo.ecm.core.DocumentModel.resolver--resolvers", "org.nuxeo.ecm.core.LifecycleCoreExtensions--lifecycle", "org.nuxeo.ecm.core.LifecycleCoreExtensions--types", "org.nuxeo.ecm.core.api.DocumentValidationService.activations--activations", "org.nuxeo.ecm.core.api.blohodlers.adapters--adapters", "org.nuxeo.ecm.core.api.local.dummy.login--implementation", "org.nuxeo.ecm.core.api.properties--configuration", "org.nuxeo.ecm.core.api.thumbnail.adapter--adapters", "org.nuxeo.ecm.core.automation.contextContrib--configuration", "org.nuxeo.ecm.core.automation.contextContrib--contextHelpers", "org.nuxeo.ecm.core.automation.core.properties--configuration", "org.nuxeo.ecm.core.automation.coreContrib--operations", "org.nuxeo.ecm.core.automation.features.bindings--bindings", "org.nuxeo.ecm.core.automation.features.bulk--actions", "org.nuxeo.ecm.core.automation.features.bulk--streamProcessor", "org.nuxeo.ecm.core.automation.features.operations--chains", "org.nuxeo.ecm.core.automation.features.operations--operations", "org.nuxeo.ecm.core.automation.marshallers--marshallers", "org.nuxeo.ecm.core.automation.scripting.contextContrib--contextHelpers", "org.nuxeo.ecm.core.bulk.config--actions", "org.nuxeo.ecm.core.bulk.config--configuration", "org.nuxeo.ecm.core.bulk.config--logConfig", "org.nuxeo.ecm.core.bulk.config--streamProcessor", "org.nuxeo.ecm.core.bulk.config--streamProcessor1", "org.nuxeo.ecm.core.bulk.io--marshallers", "org.nuxeo.ecm.core.bulk.tests--configuration", "org.nuxeo.ecm.core.bulk.tests--logConfig", "org.nuxeo.ecm.core.coldstorage.contrib--listener", "org.nuxeo.ecm.core.coldstorage.contrib--notifications", "org.nuxeo.ecm.core.coldstorage.contrib--schedule", "org.nuxeo.ecm.core.coldstorage.contrib--templates", "org.nuxeo.ecm.core.convert.configuration--configuration", "org.nuxeo.ecm.core.convert.plugins--converter", "org.nuxeo.ecm.core.deletion.config--actions", "org.nuxeo.ecm.core.deletion.config--streamProcessor", "org.nuxeo.ecm.core.document.characterFiltering.contrib--filtering", "org.nuxeo.ecm.core.event.lifecycle.listener--configuration", "org.nuxeo.ecm.core.event.lifecycle.listener--listener", "org.nuxeo.ecm.core.event.orphanVersionRemoval.listener--listener", "org.nuxeo.ecm.core.io.MarshallerRegistry.marshallers--marshallers", "org.nuxeo.ecm.core.io.avro.factories--factory", "org.nuxeo.ecm.core.io.avro.factories--mapper", "org.nuxeo.ecm.core.io.download.DownloadService--configuration", "org.nuxeo.ecm.core.management.contribs--healthCheck", "org.nuxeo.ecm.core.management.contribs--probes", "org.nuxeo.ecm.core.management.contribs--serviceDefinition", "org.nuxeo.ecm.core.management.es.tests--storageConfiguration", "org.nuxeo.ecm.core.management.listener--listener", "org.nuxeo.ecm.core.management.runtime.management.contribs--factories", "org.nuxeo.ecm.core.management.typesContrib--doctype", "org.nuxeo.ecm.core.management.typesContrib--schema", "org.nuxeo.ecm.core.operation.OperationServiceComponent--adapters", "org.nuxeo.ecm.core.operation.OperationServiceComponent--listener", "org.nuxeo.ecm.core.orphanVersionsCleanup--configuration", "org.nuxeo.ecm.core.orphanVersionsCleanup--listener", "org.nuxeo.ecm.core.orphanVersionsCleanup--schedule", "org.nuxeo.ecm.core.query.properties--configuration", "org.nuxeo.ecm.core.retention.contrib--actions", "org.nuxeo.ecm.core.retention.contrib--listener", "org.nuxeo.ecm.core.retention.contrib--policies", "org.nuxeo.ecm.core.retention.contrib--schedule", "org.nuxeo.ecm.core.retention.contrib--streamProcessor", "org.nuxeo.ecm.core.schedulers--listener", "org.nuxeo.ecm.core.schedulers--queues", "org.nuxeo.ecm.core.schedulers--schedule", "org.nuxeo.ecm.core.scroll.contrib.default--scroll", "org.nuxeo.ecm.core.security.acl.properties--configuration", "org.nuxeo.ecm.core.security.defaultPermissions--permissions", "org.nuxeo.ecm.core.security.defaultPermissions--permissionsVisibility", "org.nuxeo.ecm.core.security.defaultPolicies--policies", "org.nuxeo.ecm.core.storage.mongodb.configuration--configuration", "org.nuxeo.ecm.core.storage.sql.jdbc.querymaker.contrib--queryMaker", "org.nuxeo.ecm.core.storage.sql.softdelete--listener", "org.nuxeo.ecm.core.storage.sql.softdelete--schedule", "org.nuxeo.ecm.core.storage.sql.test.repo.repository--datasources", "org.nuxeo.ecm.core.storage.sql.test.repo.repository--repository", "org.nuxeo.ecm.core.test.blobmanager--configuration", "org.nuxeo.ecm.core.transientstore.TransientStorageComponent--listener", "org.nuxeo.ecm.core.transientstore.TransientStorageComponent--schedule", "org.nuxeo.ecm.core.trash.TrashService--configuration", "org.nuxeo.ecm.core.trash.service.migrator--configuration", "org.nuxeo.ecm.core.uidgen.UIDGeneratorService--listener", "org.nuxeo.ecm.core.uidseq.keyvaluestore--configuration", "org.nuxeo.ecm.core.versioning.VersioningDocumentAdapter--adapters", "org.nuxeo.ecm.core.versioning.default-policies--filters", "org.nuxeo.ecm.core.versioning.default-policies--policies", "org.nuxeo.ecm.core.work.config--implementation", "org.nuxeo.ecm.core.work.config--queues", "org.nuxeo.ecm.core.work.test.default.queuing--implementation", "org.nuxeo.ecm.directory.DirectoryServiceImpl--listeners", "org.nuxeo.ecm.directory.actions.core--filters", "org.nuxeo.ecm.directory.local.configuration--adapters", "org.nuxeo.ecm.directory.local.configuration--doctype", "org.nuxeo.ecm.directory.local.configuration--schema", "org.nuxeo.ecm.directory.marshallers--marshallers", "org.nuxeo.ecm.directory.resolver--resolvers", "org.nuxeo.ecm.directory.types--schema", "org.nuxeo.ecm.platform.actions.ActionService.properties--configuration", "org.nuxeo.ecm.platform.audit.PageProviderservice.automation.contrib--providers", "org.nuxeo.ecm.platform.commandline.executor.service.defaultContrib--commandTester", "org.nuxeo.ecm.platform.commandline.executor.service.defaultContrib--environment", "org.nuxeo.ecm.platform.computedgroups.UserManager.companyComputerContrib--computer", "org.nuxeo.ecm.platform.content.template.listener--listener", "org.nuxeo.ecm.platform.content.template.service.ContentTemplateService.defaultContrib--factory", "org.nuxeo.ecm.platform.content.template.service.ContentTemplateService.defaultContrib--factoryBinding", "org.nuxeo.ecm.platform.contentview.json.marshallers--marshallers", "org.nuxeo.ecm.platform.convert.commandline.pdf2text--command", "org.nuxeo.ecm.platform.directory.pageproviders--providers", "org.nuxeo.ecm.platform.filters--filters", "org.nuxeo.ecm.platform.mimetype.service.MimetypeRegistryService--extension", "org.nuxeo.ecm.platform.mimetype.service.MimetypeRegistryService--mimetype", "org.nuxeo.ecm.platform.query.api.PageProviderService--configuration", "org.nuxeo.ecm.platform.test.directory.sql.storage--directories", "org.nuxeo.ecm.platform.ui.web.auth.WebEngineConfig--authenticators", "org.nuxeo.ecm.platform.ui.web.auth.WebEngineConfig--chain", "org.nuxeo.ecm.platform.ui.web.auth.WebEngineConfig--sessionManager", "org.nuxeo.ecm.platform.ui.web.auth.WebEngineConfig--startURL", "org.nuxeo.ecm.platform.ui.web.auth.defaultConfig--authenticators", "org.nuxeo.ecm.platform.ui.web.auth.defaultConfig--chain", "org.nuxeo.ecm.platform.ui.web.auth.defaultConfig--startURL", "org.nuxeo.ecm.platform.ui.web.auth.service.PluggableAuthenticationService--implementation", "org.nuxeo.ecm.platform.ui.web.cors--configuration", "org.nuxeo.ecm.platform.ui.web.login--loginScreen", "org.nuxeo.ecm.platform.usermanager.UserManagerImpl--userManager", "org.nuxeo.ecm.platform.usermanager.adapter--adapters", "org.nuxeo.ecm.platform.usermanager.marshallers--marshallers", "org.nuxeo.ecm.platform.usermanager.pageproviders--providers", "org.nuxeo.ecm.platform.usermanager.properties--configuration", "org.nuxeo.ecm.platform.usermanager.properties--configuration1", "org.nuxeo.ecm.platform.usermanager.resolver--resolvers", "org.nuxeo.ecm.platform.web.common.adminStatusListener.contrib--listeners", "org.nuxeo.ecm.platform.web.common.exceptionhandling.service.ExceptionHandlingContrib--errorhandlers", "org.nuxeo.ecm.platform.web.common.exceptionhandling.service.ExceptionHandlingContrib--exceptionhandler", "org.nuxeo.ecm.platform.web.common.exceptionhandling.service.ExceptionHandlingContrib--listener", "org.nuxeo.ecm.platform.web.common.exceptionhandling.service.ExceptionHandlingContrib--requestdump", "org.nuxeo.ecm.platform.web.common.locale.default.contrib--providers", "org.nuxeo.ecm.platform.web.common.requestcontroller.service.RequestControllerService.defaultContrib--filterConfig", "org.nuxeo.ecm.platform.web.common.requestcontroller.service.RequestControllerService.defaultContrib--responseHeaders", "org.nuxeo.ecm.platform.web.common.test.login.as--implementation", "org.nuxeo.ecm.webengine.WebEngineComponent--filterConfig", "org.nuxeo.ecm.webengine.WebEngineComponent--rendering-extension", "org.nuxeo.elasticsearch.ElasticSearchComponent.contrib--elasticSearchDocWriter", "org.nuxeo.elasticsearch.core.bulk.contrib--actions", "org.nuxeo.elasticsearch.core.bulk.contrib--streamProcessor", "org.nuxeo.elasticsearch.core.listener--listener", "org.nuxeo.elasticsearch.hint.contrib--elasticSearchHints", "org.nuxeo.elasticsearch.managment.contrib--healthCheck", "org.nuxeo.elasticsearch.managment.contrib--probes", "org.nuxeo.elasticsearch.marshallers--marshallers", "org.nuxeo.elasticsearch.scroll.contrib--scroll", "org.nuxeo.elasticsearch.test.contrib--elasticSearchClient", "org.nuxeo.elasticsearch.test.contrib--elasticSearchEmbeddedServer", "org.nuxeo.elasticsearch.test.contrib--elasticSearchIndex", "org.nuxeo.elasticsearch.work.config--queues", "org.nuxeo.runtime.avro.contrib--replacement", "org.nuxeo.runtime.cluster.test.feature--configuration", "org.nuxeo.runtime.codec.service--codec", "org.nuxeo.runtime.datasource--sorter", "org.nuxeo.runtime.kv.KeyValueService--configuration", "org.nuxeo.runtime.management.ResourcePublisher--services", "org.nuxeo.runtime.stream.service.managment.contrib--healthCheck", "org.nuxeo.runtime.stream.service.managment.contrib--probes", "org.nuxeo.runtime.trackers.files.threadstracking.config--configs" ], "operations": [ { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.ResetSchema", "version": "unknown", "aliases": [], "description": "Reset all properties for a given schema or xpath. If saveDocument is true, the document is saved. If save is true, the session is saved (setting save to true and saveDocument to false has no effect, the session will not be saved).
WARNING: Default values are true for both saveDocument and save, which means the document is saved by default. saveDocument must be set to false when the operation is used in the context of an event that will fail if the document is saved (empty document created, about to create, before modification, ...).
", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.ResetSchema", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.ResetSchema", "label": "Reset Schema", "requires": null, "since": "", "params": [ { "name": "save", "description": "", "type": "boolean", "widget": null, "values": [ "true" ], "order": 0, "isRequired": false }, { "name": "saveDocument", "description": "", "type": "boolean", "widget": null, "values": [ "true" ], "order": 0, "isRequired": false }, { "name": "schema", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "xpath", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Audit.QueryWithPageProvider", "version": "unknown", "aliases": [ "Audit.PageProvider" ], "description": "Perform a query or a named provider query against Audit logs. Result is paginated. The query result will become the input for the next operation. If no query or provider name is given, a query based on default Audit page provider will be executed.", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.AuditPageProviderOperation", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "void", "paginable" ], "category": "Fetch", "url": "Audit.QueryWithPageProvider", "label": "Audit Query With Page Provider", "requires": null, "since": "", "params": [ { "name": "currentPageIndex", "description": "", "type": "integer", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "language", "description": "", "type": "string", "widget": "Option", "values": [ "NXQL" ], "order": 0, "isRequired": false }, { "name": "maxResults", "description": "", "type": "integer", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "namedQueryParams", "description": "", "type": "properties", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "page", "description": "", "type": "integer", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "pageSize", "description": "", "type": "integer", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "providerName", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "query", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "queryParams", "description": "", "type": "stringlist", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "sortBy", "description": "Sort by properties (separated by comma)", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "sortInfo", "description": "", "type": "stringlist", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "sortOrder", "description": "Sort order, ASC or DESC", "type": "string", "widget": "Option", "values": [ "ASC", "DESC" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.PublishToSection", "version": "unknown", "aliases": [ "Document.Publish" ], "description": "Publish the input document into the target section. Existing proxy is overrided if the override attribute is set. Return the created proxy.", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.PublishDocument", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.PublishToSection", "label": "Publish Document", "requires": null, "since": "", "params": [ { "name": "target", "description": "", "type": "document", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "override", "description": "", "type": "boolean", "widget": null, "values": [ "true" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.Unlock", "version": "unknown", "aliases": [], "description": "Unlock the input document. The unlock will be executed in the name of the current user. An user can unlock a document only if has the UNLOCK permission granted on the document or if it the same user as the one that locked the document. Return the unlocked document", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.UnlockDocument", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.Unlock", "label": "Unlock", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.AddFacet", "version": "unknown", "aliases": [ "Document.AddFacet" ], "description": "Adds the facet to the document.WARNING: The save parameter is true by default, which means the document is saved in the database after adding the facet. It must be set to false when the operation is used in the context of an event that will fail if the document is saved (empty document created, about to create, before modification, ...).
", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.AddFacet", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.AddFacet", "label": "Add Facet", "requires": null, "since": "", "params": [ { "name": "facet", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "save", "description": "", "type": "boolean", "widget": null, "values": [ "true" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Blob.RemoveFromDocument", "version": "unknown", "aliases": [ "Blob.Remove" ], "description": "Remove the file attached to the input document as specified by the 'xpath' parameter. If the 'xpath' point to a blob list then the list will be cleared. If the file to remove is part of a list it will be removed from the list otherwise the 'xpath' should point to a blob property that will be removed. If the save parameter is set the document modification will be automatically saved. Return the document.", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.RemoveDocumentBlob", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Files", "url": "Blob.RemoveFromDocument", "label": "Remove File", "requires": null, "since": "", "params": [ { "name": "save", "description": "", "type": "boolean", "widget": null, "values": [ "true" ], "order": 0, "isRequired": false }, { "name": "xpath", "description": "", "type": "string", "widget": null, "values": [ "file:content" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.RemoveProperty", "version": "unknown", "aliases": [], "description": "Remove the given property of the input document(s) as specified by the 'xpath' parameter. If the property points to a list then clear the list. Removing a property means setting it to null. Return the document(s).", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.RemoveProperty", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.RemoveProperty", "label": "Remove Property", "requires": null, "since": "", "params": [ { "name": "xpath", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "save", "description": "", "type": "boolean", "widget": null, "values": [ "true" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Blob.CreateFromURL", "version": "unknown", "aliases": [ "Blob.Create" ], "description": "Creates a file from a given URL. The file parameter specifies how to retrieve the file content. It should be an URL to the file you want to use as the source. You can also use an expression to get an URL from the context. Returns the created file.", "operationClass": "org.nuxeo.ecm.automation.core.operations.blob.CreateBlob", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "blob" ], "category": "Fetch", "url": "Blob.CreateFromURL", "label": "File From URL", "requires": null, "since": "", "params": [ { "name": "file", "description": "", "type": "resource", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "encoding", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "filename", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "mime-type", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Collection.Create", "version": "unknown", "aliases": [ "Collection.CreateCollection" ], "description": "Create a new collection. This is returning the document serialization of the created collection.", "operationClass": "org.nuxeo.ecm.automation.core.operations.collections.CreateCollectionOperation", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "void", "document", "document", "document" ], "category": "Document", "url": "Collection.Create", "label": "Create a collection", "requires": null, "since": "", "params": [ { "name": "name", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "description", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Business.BusinessUpdateOperation", "version": "unknown", "aliases": [], "description": "This operation map pojo client side to document adapter server side and update the related NX document.", "operationClass": "org.nuxeo.ecm.automation.core.operations.business.BusinessUpdateOperation", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "businessadapter", "businessadapter" ], "category": "Business", "url": "Business.BusinessUpdateOperation", "label": "BusinessUpdateOperation", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "VersionAndAttachFile", "version": "unknown", "aliases": [], "description": null, "operationClass": "org.nuxeo.ecm.automation.core.impl.OperationChainCompiler.CompiledChainImpl", "contributingComponent": "BuiltIn", "signature": [ "bloblist", "document" ], "category": "Chain", "url": "VersionAndAttachFile", "label": "VersionAndAttachFile", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Log", "version": "unknown", "aliases": [ "LogOperation" ], "description": "Logging with log4j", "operationClass": "org.nuxeo.ecm.automation.core.operations.LogOperation", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "void" ], "category": "Notification", "url": "Log", "label": "Log", "requires": null, "since": "", "params": [ { "name": "level", "description": "", "type": "string", "widget": "Option", "values": [ "info", "debug", "warn", "error" ], "order": 0, "isRequired": true }, { "name": "message", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "category", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "User.GetUserWorkspace", "version": "unknown", "aliases": [ "UserWorkspace.Get" ], "description": "Retrieve user's personal workspace.", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.UserWorkspace", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "void", "document" ], "category": "Users & Groups", "url": "User.GetUserWorkspace", "label": "Get Home", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Blob.AttachOnDocument", "version": "unknown", "aliases": [ "Blob.Attach" ], "description": "Attach the input file to the document given as a parameter. If the xpath points to a blob list then the blob is appended to the list, otherwise the xpath should point to a blob property. If the save parameter is set the document modification will be automatically saved. Return the blob.", "operationClass": "org.nuxeo.ecm.automation.core.operations.blob.AttachBlob", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "blob", "blob", "bloblist", "bloblist" ], "category": "Files", "url": "Blob.AttachOnDocument", "label": "Attach File", "requires": null, "since": "", "params": [ { "name": "document", "description": "", "type": "document", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "save", "description": "", "type": "boolean", "widget": null, "values": [ "true" ], "order": 0, "isRequired": false }, { "name": "xpath", "description": "", "type": "string", "widget": null, "values": [ "file:content" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Blob.Convert", "version": "unknown", "aliases": [], "description": "Convert the input file to a file of the given mime-type and return the new file.", "operationClass": "org.nuxeo.ecm.automation.core.operations.blob.ConvertBlob", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "bloblist", "bloblist", "blob", "blob", "document", "blob" ], "category": "Conversion", "url": "Blob.Convert", "label": "Convert to given mime-type", "requires": null, "since": "5.7", "params": [ { "name": "mimeType", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.FollowLifecycleTransition", "version": "unknown", "aliases": [ "Document.SetLifeCycle" ], "description": "Follow the given transition on the input document life cycle state", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.SetDocumentLifeCycle", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.FollowLifecycleTransition", "label": "Follow Life Cycle Transition", "requires": null, "since": "", "params": [ { "name": "value", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "User.Get", "version": "unknown", "aliases": [ "NuxeoPrincipal.Get" ], "description": "Retrieve Nuxeo principal and export it as a DocumentModel, if login parameter is not set the Operation will return informations about the current user, otherwise Directory Administration rights are required.", "operationClass": "org.nuxeo.ecm.automation.core.operations.users.GetNuxeoPrincipal", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "void", "document" ], "category": "Users & Groups", "url": "User.Get", "label": "Get Nuxeo Principal", "requires": null, "since": "", "params": [ { "name": "login", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "FileManager.Import", "version": "unknown", "aliases": [], "description": "Create Document(s) from Blob(s) using the FileManagerService. The destination container must be passed in a Context variable named currentDocument.", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.FileManagerImport", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "bloblist", "documents", "blob", "document" ], "category": "Services", "url": "FileManager.Import", "label": "Create Document from file", "requires": null, "since": "", "params": [ { "name": "noMimeTypeCheck", "description": "", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "overwite", "description": "", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.AddACE", "version": "unknown", "aliases": [ "Document.SetACE" ], "description": "Set Acces Control Entry on the input document(s). Returns the document(s).", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.SetDocumentACE", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.AddACE", "label": "Set ACL", "requires": null, "since": "", "params": [ { "name": "permission", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "user", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "acl", "description": "", "type": "string", "widget": null, "values": [ "local" ], "order": 0, "isRequired": false }, { "name": "grant", "description": "", "type": "boolean", "widget": null, "values": [ "true" ], "order": 0, "isRequired": false }, { "name": "overwrite", "description": "", "type": "boolean", "widget": null, "values": [ "true" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Traces.Get", "version": "unknown", "aliases": [], "description": "Retrieve trace associated to a Chain or an Operation", "operationClass": "org.nuxeo.ecm.automation.core.operations.traces.AutomationTraceGetOperation", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "string" ], "category": "Execution Context", "url": "Traces.Get", "label": "Traces.getTrace", "requires": null, "since": "", "params": [ { "name": "index", "description": "", "type": "int", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "traceKey", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Repository.GetDocument", "version": "unknown", "aliases": [ "Document.Fetch" ], "description": "Fetch a document from the repository given its reference (path or UID). The document will become the input of the next operation.", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.FetchDocument", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "document" ], "category": "Fetch", "url": "Repository.GetDocument", "label": "Document", "requires": null, "since": "", "params": [ { "name": "value", "description": "", "type": "document", "widget": null, "values": [], "order": 0, "isRequired": true } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Context.RestoreBlobInputFromScript", "version": "unknown", "aliases": [], "description": "Run a script and return the result blob object of the script the output of the operation", "operationClass": "org.nuxeo.ecm.automation.core.operations.RestoreBlobInputFromScript", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "blob" ], "category": "Execution Context", "url": "Context.RestoreBlobInputFromScript", "label": "Restore input blob from a script", "requires": null, "since": "", "params": [ { "name": "script", "description": "", "type": "string", "widget": "TextArea", "values": [], "order": 0, "isRequired": true } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Audit.Restore", "version": "unknown", "aliases": [], "description": "Restore log entries from an audit storage implementation to the audit backend.", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.AuditRestore", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "void", "void" ], "category": "Services", "url": "Audit.Restore", "label": "Restore log entries", "requires": null, "since": "", "params": [ { "name": "auditStorage", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "batchSize", "description": "", "type": "int", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "keepAlive", "description": "", "type": "int", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Context.GetEmailsWithPermissionOnDoc", "version": "unknown", "aliases": [ "Document.GetPrincipalEmails" ], "description": "Fetch the principal emails that have a given permission on the input document and then set them in the context under the given key variable name. The operation returns the input document. You can later use the list of principals set by this operation on the context from another operation. The 'key' argument represents the variable name and the 'permission' argument the permission to check. If the 'ignore groups' argument is false then groups are recursively resolved, extracting user members of these groups. Be warned that this may be a very consuming operation.Save parameter has to be turned off when this operation is used in the context of the empty document created, about to create, before document modification, document modified events.
", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.AddItemToListProperty", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.AddItemToListProperty", "label": "Adds an Entry Into a Multivalued Complex Property", "requires": null, "since": "", "params": [ { "name": "complexJsonProperties", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "xpath", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "save", "description": "", "type": "boolean", "widget": null, "values": [ "true" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.DeleteRelation", "version": "unknown", "aliases": [ "Relations.DeleteRelation" ], "description": "Delete a relation between 2 documents. The subject of the relation will be the input of the operation and the object of the relation will be retrieved from the context using the 'object' field. The 'predicate' field specifies the relation predicate (When using a known predicate, use the full URL like 'purl.org/dc/terms/IsBasedOn', unknown predicates will be treated as plain strings and be the same on the subject and object). The 'outgoing' flag indicates the direction of the relation - the default is false which means the relation will go from the input object to the object specified as 'object' parameter. Return back the subject document.", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.DeleteRelation", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "document", "document", "documents", "documents" ], "category": "Services", "url": "Document.DeleteRelation", "label": "Delete Relation", "requires": null, "since": "", "params": [ { "name": "object", "description": "", "type": "document", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "predicate", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "outgoing", "description": "", "type": "boolean", "widget": null, "values": [ "false" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.Create", "version": "unknown", "aliases": [], "description": "Create a new document in the input folder. You can initialize the document properties using the 'properties' parameter. The properties are specified as key=value pairs separated by a new line. The key used for a property is the property xpath. To specify multi-line values, you can use a \\ character followed by a new line.Example:
dc:title=The Document Title. Returns the created document.", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.CreateDocument", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.Create", "label": "Create", "requires": null, "since": "", "params": [ { "name": "type", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "name", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "properties", "description": "", "type": "properties", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Context.PopDocumentList", "version": "unknown", "aliases": [ "Document.PopList" ], "description": "Restore the last saved input document list in the context input stack", "operationClass": "org.nuxeo.ecm.automation.core.operations.stack.PopDocumentList", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "documents" ], "category": "Push & Pop", "url": "Context.PopDocumentList", "label": "Pop Document List", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Context.PullDocumentList", "version": "unknown", "aliases": [ "Document.PullList" ], "description": "Restore the first saved input document list in the context input stack", "operationClass": "org.nuxeo.ecm.automation.core.operations.stack.PullDocumentList", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "documents" ], "category": "Push & Pop", "url": "Context.PullDocumentList", "label": "Pull Document List", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Directory.SuggestEntries", "version": "unknown", "aliases": [], "description": "Get the entries suggestions of a directory. This is returning a blob containing a serialized JSON array. Prefix parameter is used to filter the entries.", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.directory.SuggestDirectoryEntries", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "void", "blob" ], "category": "Services", "url": "Directory.SuggestEntries", "label": "Get suggested directory entries", "requires": null, "since": "", "params": [ { "name": "directoryName", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "absoluteLabelSeparator", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "canSelectParent", "description": "", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "caseSensitive", "description": "", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "contains", "description": "", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "dbl10n", "description": "", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "displayObsoleteEntries", "description": "", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "filterParent", "description": "", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "filters", "description": "", "type": "properties", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "keySeparator", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "labelFieldName", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "lang", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "limit", "description": "", "type": "int", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "localize", "description": "", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "searchTerm", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Blob.ToPDF", "version": "unknown", "aliases": [], "description": "Convert the input file to a PDF and return the new file.", "operationClass": "org.nuxeo.ecm.automation.core.operations.blob.BlobToPDF", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "bloblist", "bloblist", "blob", "blob", "document", "blob" ], "category": "Conversion", "url": "Blob.ToPDF", "label": "Convert To PDF", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Context.PushBlobList", "version": "unknown", "aliases": [ "Blob.PushList" ], "description": "Push the input file list on the context stack. The file list can be restored later as the input using the corrresponding pop operation. Returns the input file list.", "operationClass": "org.nuxeo.ecm.automation.core.operations.stack.PushBlobList", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "bloblist", "bloblist" ], "category": "Push & Pop", "url": "Context.PushBlobList", "label": "Push File List", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "User.Invite", "version": "unknown", "aliases": [], "description": "Stores a registration request and returns its ID.", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.UserInvite", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "nuxeoprincipal", "string" ], "category": "Users & Groups", "url": "User.Invite", "label": "Invite a user", "requires": null, "since": "", "params": [ { "name": "autoAccept", "description": "", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "comment", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "info", "description": "", "type": "map", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "validationMethod", "description": "", "type": "validationmethod", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Blob.ExportToFS", "version": "unknown", "aliases": [ "Blob.ToFile" ], "description": "Save the input blob(s) as a file(s) into the given target directory. The blob(s) filename is used as the file name. You can specify an optional prefix string to prepend to the file name. Return back the blob(s).", "operationClass": "org.nuxeo.ecm.automation.core.operations.blob.BlobToFile", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "blob", "blob", "bloblist", "bloblist" ], "category": "Files", "url": "Blob.ExportToFS", "label": "Export to File", "requires": null, "since": "", "params": [ { "name": "directory", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "prefix", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Bulk.WaitForAction", "version": "unknown", "aliases": [], "description": "Wait until Bulk computation is done. This operation is meant to be used for tests. Its usage in production is not recommended.", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.bulk.BulkWaitForAction", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "void", "boolean" ], "category": "Services", "url": "Bulk.WaitForAction", "label": "Wait for Bulk computation", "requires": null, "since": "10.2", "params": [ { "name": "commandId", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "timeoutSecond", "description": "", "type": "long", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "WorkManager.RunWorkInFailure", "version": "unknown", "aliases": [], "description": "Try to execute again Works that have been send to a dead letter queue by the WorkManager after failure", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.workmanager.WorkManagerRunWorkInFailure", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "void", "blob" ], "category": "Services", "url": "WorkManager.RunWorkInFailure", "label": "Executes Works stored in the dead letter queue", "requires": null, "since": "", "params": [ { "name": "timeoutSeconds", "description": "", "type": "long", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Metrics.Start", "version": "unknown", "aliases": [], "description": "Starts Metrics reporters.", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.MetricsStart", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "void", "void" ], "category": "Services", "url": "Metrics.Start", "label": "Metrics", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "RunOperation", "version": "unknown", "aliases": [ "Context.RunOperation" ], "description": "Run an operation chain in the current context. The 'parameters' injected are accessible in the subcontext ChainParameters. For instance, @{ChainParameters['parameterKey']}.", "operationClass": "org.nuxeo.ecm.automation.core.operations.execution.RunOperation", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "void" ], "category": "Execution Flow", "url": "RunOperation", "label": "Run Chain", "requires": null, "since": "", "params": [ { "name": "id", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "isolate", "description": "", "type": "boolean", "widget": null, "values": [ "false" ], "order": 0, "isRequired": false }, { "name": "parameters", "description": "Accessible in the subcontext ChainParameters. For instance, @{ChainParameters['parameterKey']}.", "type": "properties", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Audit.LogEvent", "version": "unknown", "aliases": [ "Audit.Log" ], "description": "Log events into audit for each of the input document. The operation accept as input one ore more documents that are returned back as the output.", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.AuditLog", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "document", "document", "documents", "documents" ], "category": "Services", "url": "Audit.LogEvent", "label": "Log Event In Audit", "requires": null, "since": "", "params": [ { "name": "event", "description": "", "type": "string", "widget": "AuditEvent", "values": [], "order": 0, "isRequired": true }, { "name": "category", "description": "", "type": "string", "widget": null, "values": [ "Automation" ], "order": 0, "isRequired": false }, { "name": "comment", "description": "", "type": "string", "widget": "TextArea", "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Render.DocumentFeed", "version": "unknown", "aliases": [], "description": "Get a list of documents as input and outputs a single blob containing the rendering of the document list. The template attribute may contain either the template content either a template URI. Template URis are strings in the form 'template:template_name' and will be located using the runtime resource service. Return the rendered blob", "operationClass": "org.nuxeo.ecm.automation.core.rendering.operations.RenderDocumentFeed", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "documents", "blob" ], "category": "Conversion", "url": "Render.DocumentFeed", "label": "Render Document Feed", "requires": null, "since": "", "params": [ { "name": "template", "description": "", "type": "string", "widget": "TemplateResource", "values": [], "order": 0, "isRequired": true }, { "name": "charset", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "filename", "description": "", "type": "string", "widget": null, "values": [ "output.ftl" ], "order": 0, "isRequired": false }, { "name": "mimetype", "description": "", "type": "string", "widget": null, "values": [ "text/xml" ], "order": 0, "isRequired": false }, { "name": "type", "description": "", "type": "string", "widget": "Option", "values": [ "ftl", "mvel" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Favorite.Fetch", "version": "unknown", "aliases": [], "description": "Fetch the favorites document root collection.", "operationClass": "org.nuxeo.ecm.automation.core.operations.collections.FetchFavorites", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "void", "document" ], "category": "Document", "url": "Favorite.Fetch", "label": "Fetch favorites root collection", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "RunOperationOnProvider", "version": "unknown", "aliases": [ "Context.RunOperationOnProvider" ], "description": "Run an operation for each page of the provider defined by the provider name, the operation input is the curent page ", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.RunOperationOnProvider", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "documents", "void" ], "category": "Execution Flow", "url": "RunOperationOnProvider", "label": "Run For Each Page", "requires": null, "since": "", "params": [ { "name": "id", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "isolate", "description": "", "type": "boolean", "widget": null, "values": [ "true" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "RunInputScript", "version": "unknown", "aliases": [ "Context.RunInputScript" ], "description": "Run a script from the input blob. A blob comtaining script result is returned.", "operationClass": "org.nuxeo.ecm.automation.core.operations.RunInputScript", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "blob", "blob" ], "category": "Scripting", "url": "RunInputScript", "label": "Run Input Script", "requires": null, "since": "", "params": [ { "name": "type", "description": "", "type": "string", "widget": "Option", "values": [ "mvel", "groovy" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.GetBlobsByProperty", "version": "unknown", "aliases": [ "Blob.GetList" ], "description": "Gets a list of files that are attached on the input document. The files location should be specified using the blob list property xpath. Returns a list of files.", "operationClass": "org.nuxeo.ecm.automation.core.operations.blob.GetDocumentBlobs", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "bloblist", "documents", "bloblist" ], "category": "Files", "url": "Document.GetBlobsByProperty", "label": "Get Document Files", "requires": null, "since": "", "params": [ { "name": "xpath", "description": "", "type": "string", "widget": null, "values": [ "files:files" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "RunOperationOnList", "version": "unknown", "aliases": [ "Context.RunOperationOnList" ], "description": "Run an operation for each element from the list defined by the 'list' parameter. The 'list' parameter is pointing to a context variable that represents the list which will be iterated. The 'item' parameter represents the name of the context variable which will point to the current element in the list at each iteration. You can use the 'isolate' parameter to specify whether or not the evalution context is the same as the parent context or a copy of it. If the 'isolate' parameter is 'true' then a copy of the current context is used and so that modifications in this context will not affect the parent context. Any input is accepted. The input is returned back as output when operation terminates. The 'parameters' injected are accessible in the subcontext ChainParameters. For instance, @{ChainParameters['parameterKey']}.", "operationClass": "org.nuxeo.ecm.automation.core.operations.execution.RunOperationOnList", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "void" ], "category": "Execution Flow", "url": "RunOperationOnList", "label": "Run For Each", "requires": null, "since": "", "params": [ { "name": "id", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "list", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "isolate", "description": "", "type": "boolean", "widget": null, "values": [ "true" ], "order": 0, "isRequired": false }, { "name": "item", "description": "", "type": "string", "widget": null, "values": [ "item" ], "order": 0, "isRequired": false }, { "name": "newTx", "description": "Define if the chain in parameter should be executed in new transaction.", "type": "boolean", "widget": null, "values": [ "false" ], "order": 0, "isRequired": false }, { "name": "parameters", "description": "Accessible in the subcontext ChainParameters. For instance, @{ChainParameters['parameterKey']}.", "type": "properties", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "rollbackGlobalOnError", "description": "Define if transaction should rollback or not (default to true)", "type": "boolean", "widget": null, "values": [ "true" ], "order": 0, "isRequired": false }, { "name": "timeout", "description": "Define transaction timeout (default to 60 sec).", "type": "integer", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Render.Document", "version": "unknown", "aliases": [], "description": "Get a document or a list of document in input and outputs one or more blobs that contain a rendered view for each input document given a rendering template. The template attribute may contain either the template content either a template URI. Template URis are strings in the form 'template:template_name' and will be located using the runtime resource service. Return the rendered file(s) as blob(s)", "operationClass": "org.nuxeo.ecm.automation.core.rendering.operations.RenderDocument", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "blob", "documents", "bloblist" ], "category": "Conversion", "url": "Render.Document", "label": "Render Document", "requires": null, "since": "", "params": [ { "name": "template", "description": "", "type": "string", "widget": "TemplateResource", "values": [], "order": 0, "isRequired": true }, { "name": "filename", "description": "", "type": "string", "widget": null, "values": [ "output.ftl" ], "order": 0, "isRequired": false }, { "name": "mimetype", "description": "", "type": "string", "widget": null, "values": [ "text/xml" ], "order": 0, "isRequired": false }, { "name": "type", "description": "", "type": "string", "widget": "Option", "values": [ "ftl", "mvel" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Context.RestoreDocumentInputFromScript", "version": "unknown", "aliases": [], "description": "Run a script and return the result Document object of the script the output of the operation", "operationClass": "org.nuxeo.ecm.automation.core.operations.RestoreDocumentInputFromScript", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "document" ], "category": "Execution Context", "url": "Context.RestoreDocumentInputFromScript", "label": "Restore input document from a script", "requires": null, "since": "", "params": [ { "name": "script", "description": "", "type": "string", "widget": "TextArea", "values": [], "order": 0, "isRequired": true } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Context.RunDocumentOperationInNewTx", "version": "unknown", "aliases": [], "description": "Run an operation chain in a separate tx. The 'parameters' injected are accessible in the subcontext ChainParameters. For instance, @{ChainParameters['parameterKey']}.", "operationClass": "org.nuxeo.ecm.automation.core.operations.execution.RunInNewTransaction", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "void" ], "category": "Execution Flow", "url": "Context.RunDocumentOperationInNewTx", "label": "Run Document Chain in new Tx", "requires": null, "since": "", "params": [ { "name": "id", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "isolate", "description": "", "type": "boolean", "widget": null, "values": [ "false" ], "order": 0, "isRequired": false }, { "name": "parameters", "description": "Accessible in the subcontext ChainParameters. For instance, @{ChainParameters['parameterKey']}.", "type": "properties", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "rollbackGlobalOnError", "description": "", "type": "boolean", "widget": null, "values": [ "false" ], "order": 0, "isRequired": false }, { "name": "timeout", "description": "", "type": "integer", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.Untrash", "version": "unknown", "aliases": [], "description": "Undeletes documents (and ancestors if needed to make them visible)..", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.UntrashDocument", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.Untrash", "label": "Untrash", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Context.RestoreDocumentsInput", "version": "unknown", "aliases": [], "description": "Restore the document list input from a context variable given its name. Return the document list.", "operationClass": "org.nuxeo.ecm.automation.core.operations.RestoreDocumentsInput", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "documents" ], "category": "Execution Context", "url": "Context.RestoreDocumentsInput", "label": "Restore Documents Input", "requires": null, "since": "", "params": [ { "name": "name", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Blob.ConcatenatePDFs", "version": "unknown", "aliases": [], "description": "Given a File document holding a pdf on the file:content property and 2 pdfs on the files:files property, the following operation will provide a pdf that is the result of the merge of all the pdfs, with the content of the one in file:content property first.", "operationClass": "org.nuxeo.ecm.automation.core.operations.blob.ConcatenatePDFs", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "bloblist", "blob", "blob", "blob" ], "category": "Conversion", "url": "Blob.ConcatenatePDFs", "label": "Concatenate PDFs", "requires": null, "since": "", "params": [ { "name": "filename", "description": "The merge pdf result filename.", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "blob_to_append", "description": "Optional blob reference in context to append in first place.", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Directory.Projection", "version": "unknown", "aliases": [], "description": "Executes a query using given filter and return only the column *columnName*. The result is assigned to the context variable *variableName*. The filters are specified as key=value pairs separated by a new line. The key used for a filter is the column name of the directory. To specify multi-line values you can use a \\ character followed by a new line.
dc:description=foo bar
Example:
firstName=JohnBy default, the search filters use exact match. You can do a fulltext search on some specific columns using the fulltextFields. it's specified as comma separated columnName, for instance :
lastName=doe
Example:
firstName,lastName", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.directory.DirectoryProjection", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "void", "void" ], "category": "Services", "url": "Directory.Projection", "label": "Get a Directory Projection", "requires": null, "since": "5.7.2", "params": [ { "name": "columnName", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "directoryName", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "variableName", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "filters", "description": "", "type": "properties", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "fulltextFields", "description": "", "type": "stringlist", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.GetVersions", "version": "unknown", "aliases": [], "description": "Gets the versions of the input document.", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.GetDocumentVersions", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "documents" ], "category": "Document", "url": "Document.GetVersions", "label": "Get Versions", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.GetLastVersion", "version": "unknown", "aliases": [ "Document.GetLastVersion" ], "description": "Returns the last version of the document if it exists.", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.GetLastDocumentVersion", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.GetLastVersion", "label": "Get Last version", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Blob.BulkDownload", "version": "unknown", "aliases": [], "description": "Prepare a Zip of a list of documents.", "operationClass": "org.nuxeo.ecm.automation.core.operations.blob.BulkDownload", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "documents", "blob" ], "category": "Files", "url": "Blob.BulkDownload", "label": "Bulk Download", "requires": null, "since": "", "params": [ { "name": "filename", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Collection.Suggestion", "version": "unknown", "aliases": [], "description": "Get the collection list accessible by the current user. This is returning a blob containing a serialized JSON array..", "operationClass": "org.nuxeo.ecm.automation.core.operations.collections.SuggestCollectionEntry", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "void", "blob" ], "category": "Services", "url": "Collection.Suggestion", "label": "Get collection suggestion", "requires": null, "since": "", "params": [ { "name": "currentPageIndex", "description": "", "type": "integer", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "lang", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "pageSize", "description": "", "type": "integer", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "searchTerm", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.Lock", "version": "unknown", "aliases": [], "description": "Lock the input document for the current user. Returns back the locked document.", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.LockDocument", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.Lock", "label": "Lock", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Metrics.Stop", "version": "unknown", "aliases": [], "description": "Stops Metrics rerporer.", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.MetricsStop", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "void", "void" ], "category": "Services", "url": "Metrics.Stop", "label": "Metrics", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "FileManager.ImportWithMetaData", "version": "unknown", "aliases": [], "description": null, "operationClass": "org.nuxeo.ecm.automation.core.impl.OperationChainCompiler.CompiledChainImpl", "contributingComponent": "BuiltIn", "signature": [ "bloblist", "documents", "blob", "document" ], "category": "Chain", "url": "FileManager.ImportWithMetaData", "label": "FileManager.ImportWithMetaData", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Business.BusinessCreateOperation", "version": "unknown", "aliases": [], "description": "This operation map pojo client side to document adapter server side and create NX document assuming that pojo and adapter have both properties in common.", "operationClass": "org.nuxeo.ecm.automation.core.operations.business.BusinessCreateOperation", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "businessadapter", "businessadapter" ], "category": "Business", "url": "Business.BusinessCreateOperation", "label": "BusinessCreateOperation", "requires": null, "since": "", "params": [ { "name": "name", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "parentPath", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "RunDocumentOperation", "version": "unknown", "aliases": [ "Context.RunDocumentOperation" ], "description": "Run an operation chain which is returning a document in the current context. The input for the chain ro run is the current input of the operation. Return the output of the chain as a document. The 'parameters' injected are accessible in the subcontext ChainParameters. For instance, @{ChainParameters['parameterKey']}.", "operationClass": "org.nuxeo.ecm.automation.core.operations.execution.RunDocumentChain", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Execution Flow", "url": "RunDocumentOperation", "label": "Run Document Chain", "requires": null, "since": "", "params": [ { "name": "id", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "isolate", "description": "", "type": "boolean", "widget": null, "values": [ "false" ], "order": 0, "isRequired": false }, { "name": "newTx", "description": "Define if the chain in parameter should be executed in new transaction.", "type": "boolean", "widget": null, "values": [ "false" ], "order": 0, "isRequired": false }, { "name": "parameters", "description": "Accessible in the subcontext ChainParameters. For instance, @{ChainParameters['parameterKey']}.", "type": "properties", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "rollbackGlobalOnError", "description": "Define if transaction should rollback or not (default to true)", "type": "boolean", "widget": null, "values": [ "true" ], "order": 0, "isRequired": false }, { "name": "timeout", "description": "Define transaction timeout (default to 60 sec).", "type": "integer", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Directory.UpdateEntries", "version": "unknown", "aliases": [], "description": "Updates directory entries. Entries to update are sent as a JSON array. Returns the updated entries ids as a JSON array of JSON objects containing all fields", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.directory.UpdateDirectoryEntries", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "void", "blob" ], "category": "Services", "url": "Directory.UpdateEntries", "label": "Updates directory entries", "requires": null, "since": "", "params": [ { "name": "directoryName", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "entries", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.Mail", "version": "unknown", "aliases": [ "Notification.SendMail" ], "description": "Send an email using the input document to the specified recipients. You can use the HTML parameter to specify whether you message is in HTML format or in plain text. Also you can attach any blob on the current document to the message by using the comma separated list of xpath expressions 'files'. If you xpath points to a blob list all blobs in the list will be attached. Return back the input document(s). If rollbackOnError is true, the whole chain will be rollbacked if an error occurs while trying to send the email (for instance if no SMTP server is configured), else a simple warning will be logged and the chain will continue.", "operationClass": "org.nuxeo.ecm.automation.core.operations.notification.SendMail", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "document", "document", "documents", "documents" ], "category": "Notification", "url": "Document.Mail", "label": "Send E-Mail", "requires": null, "since": "", "params": [ { "name": "from", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "message", "description": "", "type": "string", "widget": "MailTemplate", "values": [], "order": 0, "isRequired": true }, { "name": "subject", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "HTML", "description": "", "type": "boolean", "widget": null, "values": [ "false" ], "order": 0, "isRequired": false }, { "name": "Strict User Resolution", "description": "", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "bcc", "description": "", "type": "stringlist", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "cc", "description": "", "type": "stringlist", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "files", "description": "", "type": "stringlist", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "replyto", "description": "", "type": "stringlist", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "rollbackOnError", "description": "", "type": "boolean", "widget": null, "values": [ "true" ], "order": 0, "isRequired": false }, { "name": "to", "description": "", "type": "stringlist", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "viewId", "description": "", "type": "string", "widget": null, "values": [ "view_documents" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Repository.PageProvider", "version": "unknown", "aliases": [ "Document.PageProvider" ], "description": "Perform a named provider query on the repository. Result is paginated. The query result will become the input for the next operation.", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.DocumentPageProviderOperation", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "void", "documents" ], "category": "Fetch", "url": "Repository.PageProvider", "label": "PageProvider", "requires": null, "since": "", "params": [ { "name": "providerName", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "currentPageIndex", "description": "", "type": "integer", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "documentLinkBuilder", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "highlights", "description": "Highlight properties (separated by comma)", "type": "stringlist", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "language", "description": "", "type": "string", "widget": "Option", "values": [ "NXQL" ], "order": 0, "isRequired": false }, { "name": "namedParameters", "description": "Named parameters to pass to the page provider to fill in query variables.", "type": "properties", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "pageSize", "description": "", "type": "integer", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "queryParams", "description": "", "type": "stringlist", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "quickFilters", "description": "Quick filter properties (separated by comma)", "type": "stringlist", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "sortBy", "description": "Sort by properties (separated by comma)", "type": "stringlist", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "sortOrder", "description": "Sort order, ASC or DESC", "type": "stringlist", "widget": "Option", "values": [ "ASC", "DESC" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Repository.Query", "version": "unknown", "aliases": [ "Document.Query" ], "description": "Perform a query on the repository. The document list returned will become the input for the next operation.If no provider name is given, a query returning all the documents that the user has access to will be executed.", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.query.DocumentPaginatedQuery", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "void", "documents" ], "category": "Fetch", "url": "Repository.Query", "label": "Query", "requires": null, "since": "6.0", "params": [ { "name": "currentPageIndex", "description": "Target listing page.", "type": "integer", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "escapePatternParameters", "description": "", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "language", "description": "The query language.", "type": "string", "widget": "Option", "values": [ "NXQL" ], "order": 0, "isRequired": false }, { "name": "maxResults", "description": "", "type": "integer", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "namedParameters", "description": "Named parameters to pass to the page provider to fill in query variables.", "type": "properties", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "pageSize", "description": "Entries number per page.", "type": "integer", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "query", "description": "The query to perform.", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "queryParams", "description": "Ordered query parameters.", "type": "stringlist", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "quotePatternParameters", "description": "", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "sortBy", "description": "Sort by properties (separated by comma)", "type": "stringlist", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "sortOrder", "description": "Sort order, ASC or DESC", "type": "stringlist", "widget": "Option", "values": [ "ASC", "DESC" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Context.RestoreBlobInput", "version": "unknown", "aliases": [], "description": "Restore the file input from a context variable given its name. Return the file.", "operationClass": "org.nuxeo.ecm.automation.core.operations.RestoreBlobInput", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "blob" ], "category": "Execution Context", "url": "Context.RestoreBlobInput", "label": "Restore File Input", "requires": null, "since": "", "params": [ { "name": "name", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.Filter", "version": "unknown", "aliases": [], "description": "Filter the input list of documents given a condition. The condition can be expressed using 4 parameters: types, facets, lifecycle and condition. If more than one parameter is specified an AND will be used to group conditions.
Returns the list of documents that match the filter condition.", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.FilterDocuments", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "documents", "documents", "documents" ], "category": "Document", "url": "Document.Filter", "label": "Filter List", "requires": null, "since": "", "params": [ { "name": "class", "description": "", "type": "string", "widget": "Option", "values": [ "Any", "Regular Document", "Document Link", "Published Document", "Document Proxy", "Document Version", "Immutable Document", "Mutable Document" ], "order": 0, "isRequired": false }, { "name": "condition", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "facet", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "lifecycle", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "pathStartsWith", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "types", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.AddRelation", "version": "unknown", "aliases": [ "Relations.CreateRelation" ], "description": "Create a relation between 2 documents. The subject of the relation will be the input of the operation and the object of the relation will be retrieved from the context using the 'object' field. The 'predicate' field specifies the relation predicate (When using a known predicate, use the full URL like 'http://purl.org/dc/terms/IsBasedOn', unknown predicates will be treated as plain strings and be the same on the subject and object). The 'outgoing' flag indicates the direction of the relation - the default is false which means the relation will go from the input object to the object specified as 'object' parameter. Return back the subject document.", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.CreateRelation", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "document", "document", "documents", "documents" ], "category": "Services", "url": "Document.AddRelation", "label": "Create Relation", "requires": null, "since": "", "params": [ { "name": "object", "description": "", "type": "document", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "predicate", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "outgoing", "description": "", "type": "boolean", "widget": null, "values": [ "false" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.Trash", "version": "unknown", "aliases": [], "description": "Moves documents to the trash.", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.TrashDocument", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.Trash", "label": "Trash", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.CheckIn", "version": "unknown", "aliases": [], "description": "Checks in the input document. Returns back the document.", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.CheckInDocument", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.CheckIn", "label": "Check In", "requires": null, "since": "", "params": [ { "name": "version", "description": "", "type": "string", "widget": null, "values": [ "none", "minor", "major" ], "order": 0, "isRequired": true }, { "name": "comment", "description": "", "type": "string", "widget": null, "values": [], "order": 1, "isRequired": false }, { "name": "versionVarName", "description": "", "type": "string", "widget": null, "values": [], "order": 2, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Blob.CreateZip", "version": "unknown", "aliases": [], "description": "Creates a zip file from the input file(s). If no file name is given, the first file name in the input will be used. Returns the zip file.", "operationClass": "org.nuxeo.ecm.automation.core.operations.blob.CreateZip", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "bloblist", "blob", "blob", "blob" ], "category": "Files", "url": "Blob.CreateZip", "label": "Zip", "requires": null, "since": "", "params": [ { "name": "filename", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.RemoveFromFavorites", "version": "unknown", "aliases": [ "Collection.RemoveFromFavorites" ], "description": "Remove a list of documents from the favorites. No value is returned.", "operationClass": "org.nuxeo.ecm.automation.core.operations.collections.RemoveFromFavoritesOperation", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.RemoveFromFavorites", "label": "Remove from favorites", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "BlobHolder.AttachOnCurrentDocument", "version": "unknown", "aliases": [ "BlobHolder.Attach" ], "description": "Attach the input file(s) to the current document using the BlobHolder abstraction", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.BlobHolderAttach", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "bloblist", "document", "blob", "document" ], "category": "Files", "url": "BlobHolder.AttachOnCurrentDocument", "label": "Attach File or files to the currentDocument.", "requires": null, "since": "", "params": [ { "name": "useMainBlob", "description": "", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.RemovePermission", "version": "unknown", "aliases": [], "description": "Remove a permission given its id or all permissions for a given user on the input document(s). Parameter 'id' or 'user' must be set. Returns the document(s).", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.RemovePermission", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.RemovePermission", "label": "Remove Permission", "requires": null, "since": "", "params": [ { "name": "acl", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "id", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "user", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "User.CreateOrUpdate", "version": "unknown", "aliases": [ "Services.CreateUser" ], "description": "Create or Update User.", "operationClass": "org.nuxeo.ecm.automation.core.operations.users.CreateOrUpdateUser", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "void", "void" ], "category": "Users & Groups", "url": "User.CreateOrUpdate", "label": "Create or Update User", "requires": null, "since": "", "params": [ { "name": "username", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "company", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "email", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "firstName", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "groups", "description": "", "type": "stringlist", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "lastName", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "mode", "description": "", "type": "string", "widget": null, "values": [ "createOrUpdate", "create", "update" ], "order": 0, "isRequired": false }, { "name": "password", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "properties", "description": "", "type": "properties", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "tenantId", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Context.PullBlob", "version": "unknown", "aliases": [ "Blob.Pull" ], "description": "Restore the last saved input file in the context input stack. This operation must be used only if a PUSH operation was previously made. Return the first pushed file.", "operationClass": "org.nuxeo.ecm.automation.core.operations.stack.PullBlob", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "blob" ], "category": "Push & Pop", "url": "Context.PullBlob", "label": "Pull File", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.Order", "version": "unknown", "aliases": [], "description": "Given a parent document, order the source child before the destination child.", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.OrderDocument", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.Order", "label": "Order Document", "requires": null, "since": "10.1", "params": [ { "name": "before", "description": "", "type": "document", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Context.PopDocument", "version": "unknown", "aliases": [ "Document.Pop" ], "description": "Restore the last saved input document in the context input stack. This operation must be used only if a PUSH operation was previously made. Return the last pushed document.", "operationClass": "org.nuxeo.ecm.automation.core.operations.stack.PopDocument", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "document" ], "category": "Push & Pop", "url": "Context.PopDocument", "label": "Pop Document", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Favorite.GetDocuments", "version": "unknown", "aliases": [ "Collection.GetElementsInFavorite" ], "description": "Get the list of documents visible from the currentUser's favorites. This is returning a list of documents.", "operationClass": "org.nuxeo.ecm.automation.core.operations.collections.GetDocumentsFromFavoritesOperation", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "document", "documents" ], "category": "Document", "url": "Favorite.GetDocuments", "label": "Get documents from favorites", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.SetBlobName", "version": "unknown", "aliases": [ "Blob.SetFilename" ], "description": "Modify the filename of a file stored in the input document. The file is found in the input document given its xpath specified through the 'xpath' parameter. Return back the input document.", "operationClass": "org.nuxeo.ecm.automation.core.operations.blob.SetBlobFileName", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Files", "url": "Document.SetBlobName", "label": "Set File Name", "requires": null, "since": "", "params": [ { "name": "name", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "save", "description": "", "type": "boolean", "widget": null, "values": [ "true" ], "order": 0, "isRequired": false }, { "name": "xpath", "description": "", "type": "string", "widget": null, "values": [ "file:content" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Context.GetUsersGroupIdsWithPermissionOnDoc", "version": "unknown", "aliases": [ "Document.GetUsersAndGroups" ], "description": "Fetch the users and groups that have a given permission on the input document and then set them in the context under the given key variable name. The operation returns the input document. You can later use the list of identifiers set by this operation on the context from another operation. The 'key' argument represents the variable name and the 'permission' argument the permission to check. If the 'ignore groups' argument is false then groups will be part of the result. If the 'resolve groups' argument is true then groups are recursively resolved, adding user members of these groups in place of them. Be warned that this may be a very consuming operation. If the 'prefix identifiers' argument is true, then user identifiers are prefixed by 'user:' and groups identifiers are prefixed by 'group:'.", "operationClass": "org.nuxeo.ecm.automation.core.operations.users.GetDocumentUsersAndGroups", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "document", "document" ], "category": "Users & Groups", "url": "Context.GetUsersGroupIdsWithPermissionOnDoc", "label": "Get Users and Groups", "requires": null, "since": "", "params": [ { "name": "permission", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "variable name", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "ignore groups", "description": "", "type": "boolean", "widget": null, "values": [ "false" ], "order": 0, "isRequired": false }, { "name": "prefix identifiers", "description": "", "type": "boolean", "widget": null, "values": [ "false" ], "order": 0, "isRequired": false }, { "name": "resolve groups", "description": "", "type": "boolean", "widget": null, "values": [ "false" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.AddToFavorites", "version": "unknown", "aliases": [ "Collection.AddToFavorites" ], "description": "Add a list of documents in the favorites. No value is returned.", "operationClass": "org.nuxeo.ecm.automation.core.operations.collections.AddToFavoritesOperation", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.AddToFavorites", "label": "Add document to favorites", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "AttachFiles", "version": "unknown", "aliases": [], "description": null, "operationClass": "org.nuxeo.ecm.automation.core.impl.OperationChainCompiler.CompiledChainImpl", "contributingComponent": "BuiltIn", "signature": [ "bloblist", "document", "blob", "document" ], "category": "Chain", "url": "AttachFiles", "label": "AttachFiles", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Repository.ResultSetQuery", "version": "unknown", "aliases": [ "ResultSet.PaginatedQuery" ], "description": "Perform a query on the repository. The result set returned will become the input for the next operation. If no query or provider name is given, a query returning all the documents that the user has access to will be executed.", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.query.ResultSetPaginatedQuery", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "void", "recordset" ], "category": "Fetch", "url": "Repository.ResultSetQuery", "label": "ResultSet Query", "requires": null, "since": "6.0", "params": [ { "name": "query", "description": "The query to perform.", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "currentPageIndex", "description": "Target listing page.", "type": "integer", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "language", "description": "The query language.", "type": "string", "widget": "Option", "values": [ "NXQL", "CMIS" ], "order": 0, "isRequired": false }, { "name": "maxResults", "description": "", "type": "integer", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "namedParameters", "description": "Named parameters to pass to the page provider to fill in query variables.", "type": "properties", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "pageSize", "description": "Entries number per page.", "type": "integer", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "queryParams", "description": "Ordered query parameters.", "type": "stringlist", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "sortBy", "description": "Sort by properties (separated by comma)", "type": "stringlist", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "sortOrder", "description": "Sort order, ASC or DESC", "type": "stringlist", "widget": "Option", "values": [ "ASC", "DESC" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Context.PushDocument", "version": "unknown", "aliases": [ "Document.Push" ], "description": "Push the input document on the context stack. The document can be restored later as the input using the corrresponding pop operation. Returns the input document.", "operationClass": "org.nuxeo.ecm.automation.core.operations.stack.PushDocument", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document" ], "category": "Push & Pop", "url": "Context.PushDocument", "label": "Push Document", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.GetLinkedDocuments", "version": "unknown", "aliases": [ "Relations.GetRelations" ], "description": "Get the relations for the input document. The 'outgoing' parameter ca be used to specify whether outgoing or incoming relations should be returned. Retuns a document list.", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.GetRelations", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "document", "documents" ], "category": "Services", "url": "Document.GetLinkedDocuments", "label": "Get Linked Documents", "requires": null, "since": "", "params": [ { "name": "predicate", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "graphName", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "outgoing", "description": "", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Context.PopBlobList", "version": "unknown", "aliases": [ "Blob.PopList" ], "description": "Restore the last saved input file list in the context input stack", "operationClass": "org.nuxeo.ecm.automation.core.operations.stack.PopBlobList", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "bloblist" ], "category": "Push & Pop", "url": "Context.PopBlobList", "label": "Pop File List", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Business.BusinessFetchOperation", "version": "unknown", "aliases": [], "description": "This operation map pojo client side to document adapter server side and fetch the related NX document.", "operationClass": "org.nuxeo.ecm.automation.core.operations.business.BusinessFetchOperation", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "businessadapter", "businessadapter" ], "category": "Business", "url": "Business.BusinessFetchOperation", "label": "BusinessFetchOperation", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Context.FetchDocument", "version": "unknown", "aliases": [], "description": "Fetch the input of the context as a document or list of documents. The document will become the input for the next operation.", "operationClass": "org.nuxeo.ecm.automation.core.operations.FetchContextDocument", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Fetch", "url": "Context.FetchDocument", "label": "Context Document(s)", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Collection.GetDocumentsFromCollection", "version": "unknown", "aliases": [], "description": "Get the list of documents visible by the currentUser in a collection. This is returning a list of documents.", "operationClass": "org.nuxeo.ecm.automation.core.operations.collections.GetDocumentsFromCollectionOperation", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "document", "documents" ], "category": "Document", "url": "Collection.GetDocumentsFromCollection", "label": "Get documents from collection", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.CheckOut", "version": "unknown", "aliases": [], "description": "Checks out the input document. Returns back the document.", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.CheckOutDocument", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.CheckOut", "label": "Check Out", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "VersionAndAttachFiles", "version": "unknown", "aliases": [], "description": null, "operationClass": "org.nuxeo.ecm.automation.core.impl.OperationChainCompiler.CompiledChainImpl", "contributingComponent": "BuiltIn", "signature": [ "bloblist", "document" ], "category": "Chain", "url": "VersionAndAttachFiles", "label": "VersionAndAttachFiles", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.RemoveEntryOfMultivaluedProperty", "version": "unknown", "aliases": [ "RemoveEntryOfMultivaluedProperty" ], "description": "Remove the first entry of the giving value in the multivalued xpath, does nothing if does not exist:
Save parameter automatically saves the document in the database. It has to be turned off when this operation is used in the context of the empty document created, about to create, before document modification, document modified events.
", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.RemoveEntryOfMultiValuedProperty", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.RemoveEntryOfMultivaluedProperty", "label": "Remove Entry Of Multivalued Property", "requires": null, "since": "", "params": [ { "name": "value", "description": "", "type": "serializable", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "xpath", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "is Remove All", "description": "", "type": "boolean", "widget": null, "values": [ "true" ], "order": 0, "isRequired": false }, { "name": "save", "description": "", "type": "boolean", "widget": null, "values": [ "true" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Repository.ResultSetPageProvider", "version": "unknown", "aliases": [ "Resultset.PageProvider" ], "description": "Perform a named provider query on the repository. Result is paginated.The result is returned as a RecordSet (QueryAndFetch) rather than as a List of DocumentThe query result will become the input for the next operation.", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.ResultSetPageProviderOperation", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "void", "recordset" ], "category": "Fetch", "url": "Repository.ResultSetPageProvider", "label": "QueryAndFetch", "requires": null, "since": "", "params": [ { "name": "currentPageIndex", "description": "", "type": "integer", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "language", "description": "", "type": "string", "widget": "Option", "values": [ "NXQL", "CMIS" ], "order": 0, "isRequired": false }, { "name": "maxResults", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "namedParameters", "description": "Named parameters to pass to the page provider to fill in query variables.", "type": "properties", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "pageSize", "description": "", "type": "integer", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "providerName", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "queryParams", "description": "", "type": "stringlist", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "sortBy", "description": "Sort by properties (separated by comma)", "type": "stringlist", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "sortOrder", "description": "Sort order, ASC or DESC", "type": "stringlist", "widget": "Option", "values": [ "ASC", "DESC" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Proxy.GetSourceDocument", "version": "unknown", "aliases": [ "GetLiveDocument" ], "description": "Get the live document even if this is a Proxy or Version Document.", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.GetLiveDocument", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Proxy.GetSourceDocument", "label": "Get Live Document", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.EmptyTrash", "version": "unknown", "aliases": [], "description": "Emtpy a folder's trash by permanently deleting documents marked as trashed.", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.EmptyTrash", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "void" ], "category": "Document", "url": "Document.EmptyTrash", "label": "Empty Trash", "requires": null, "since": "", "params": [ { "name": "parent", "description": "A Folderish document whose trash will be emptied", "type": "document", "widget": null, "values": [], "order": 0, "isRequired": true } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "DocumentMultivaluedProperty.addItem", "version": "unknown", "aliases": [ "AddEntryToMultivaluedProperty" ], "description": "Add value into the field expressed by the xpath parameter. This field must be a multivalued metadata.'checkExists' parameter enables to add value only if doesn't already exists in the field:
Remark: only works for a field that stores a list of scalars (string, boolean, date, int, long) and not list of complex types.
Save parameter automatically saves the document in the database. It has to be turned off when this operation is used in the context of the empty document created, about to create, before document modification, document modified events.
", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.AddEntryToMultiValuedProperty", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "DocumentMultivaluedProperty.addItem", "label": "Add entry into multi-valued metadata", "requires": null, "since": "", "params": [ { "name": "value", "description": "", "type": "serializable", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "xpath", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "checkExists", "description": "", "type": "boolean", "widget": null, "values": [ "true" ], "order": 0, "isRequired": false }, { "name": "save", "description": "", "type": "boolean", "widget": null, "values": [ "true" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.RemoveProxies", "version": "unknown", "aliases": [ "Document.RemoveProxies" ], "description": "Will remove all proxies pointing on the input document. Useful for instance to unpublish a document. Notice: this operation will remove all proxies, including the ones pointing to the current document version (live proxies). Activating the save parameter forces the changes to be written in database immediately (at the cost of performance loss).", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.RemoveProxies", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.RemoveProxies", "label": "Remove Document Proxies", "requires": null, "since": "", "params": [ { "name": "save", "description": "", "type": "boolean", "widget": null, "values": [ "true" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.MoveToColdStorage", "version": "unknown", "aliases": [], "description": "Move the main document content to the cold storage.", "operationClass": "org.nuxeo.ecm.automation.core.operations.coldstorage.MoveToColdStorage", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "document", "document", "documents", "documents" ], "category": "Files", "url": "Document.MoveToColdStorage", "label": "Move to Cold Storage", "requires": null, "since": "", "params": [ { "name": "save", "description": "", "type": "boolean", "widget": null, "values": [ "true" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.Reload", "version": "unknown", "aliases": [], "description": "Reload the input document from the repository. Any previous modification made by the chain on this document will be lost if these modifications were not saved. Return the reloaded document.", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.ReloadDocument", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.Reload", "label": "Reset", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.Move", "version": "unknown", "aliases": [], "description": "Move the input document into the target folder.", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.MoveDocument", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.Move", "label": "Move", "requires": null, "since": "", "params": [ { "name": "target", "description": "", "type": "document", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "name", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Directory.DeleteEntries", "version": "unknown", "aliases": [], "description": "Deletes directory entries. Entries ids to delete are sent through a JSON array. Returns deleted entries id as a JSON array.", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.directory.DeleteDirectoryEntries", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "void", "blob" ], "category": "Services", "url": "Directory.DeleteEntries", "label": "Deletes directory entries", "requires": null, "since": "", "params": [ { "name": "directoryName", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "entries", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "markObsolete", "description": "", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Context.SetVar", "version": "unknown", "aliases": [], "description": "Set a context variable given a name and the value. To compute the value at runtime from the current context you should use an EL expression as the value. This operation works on any input type and return back the input as the output.", "operationClass": "org.nuxeo.ecm.automation.core.operations.SetVar", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "void" ], "category": "Execution Context", "url": "Context.SetVar", "label": "Set Context Variable", "requires": null, "since": "", "params": [ { "name": "name", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "value", "description": "", "type": "object", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "User.Query", "version": "unknown", "aliases": [ "Services.QueryUsers" ], "description": "Query users on a combination of their username, firstName and lastName fields, or on any of them (pattern).", "operationClass": "org.nuxeo.ecm.automation.core.operations.users.QueryUsers", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "void", "blob" ], "category": "Users & Groups", "url": "User.Query", "label": "Query users", "requires": null, "since": "", "params": [ { "name": "firstName", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "lastName", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "pattern", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "tenantId", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "username", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.ReplacePermission", "version": "unknown", "aliases": [], "description": "Replace a given permission on the input document(s). Returns the document(s).", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.ReplacePermission", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.ReplacePermission", "label": "Replace Permission", "requires": null, "since": "", "params": [ { "name": "id", "description": "ACE id.", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "permission", "description": "ACE permission.", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "username", "description": "ACE target user/group.", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "acl", "description": "ACL name.", "type": "string", "widget": null, "values": [ "local" ], "order": 0, "isRequired": false }, { "name": "begin", "description": "ACE begin date.", "type": "date", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "comment", "description": "Comment", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "end", "description": "ACE end date.", "type": "date", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "notify", "description": "Notify the user or not", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.BlockPermissionInheritance", "version": "unknown", "aliases": [], "description": "Block the permission inheritance on the input document(s). Returns the document(s).", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.BlockPermissionInheritance", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.BlockPermissionInheritance", "label": "Block Permission Inheritance", "requires": null, "since": "", "params": [ { "name": "acl", "description": "ACL name.", "type": "string", "widget": null, "values": [ "local" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.UnblockPermissionInheritance", "version": "unknown", "aliases": [], "description": "Unblock the permission inheritance on the input document(s). Returns the document(s).", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.UnblockPermissionInheritance", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.UnblockPermissionInheritance", "label": "Unblock Permission Inheritance", "requires": null, "since": "", "params": [ { "name": "acl", "description": "ACL name.", "type": "string", "widget": null, "values": [ "local" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Context.PopBlob", "version": "unknown", "aliases": [ "Blob.Pop" ], "description": "Restore the last saved input file in the context input stack. This operation must be used only if a PUSH operation was previously made. Return the last pushed file.", "operationClass": "org.nuxeo.ecm.automation.core.operations.stack.PopBlob", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "blob" ], "category": "Push & Pop", "url": "Context.PopBlob", "label": "Pop File", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.CopySchema", "version": "unknown", "aliases": [], "description": "Copy all the properties from the schema of the source into the input document. Either sourceId or sourcePath parameter should be filled. When both are filled, sourceId will be used. If saveDocument is true, the document is saved. If save is true, the session is saved (setting save to true and saveDocument to false has no effect, the session will not be saved)", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.CopySchema", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.CopySchema", "label": "Copy Schema", "requires": null, "since": "", "params": [ { "name": "schema", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "save", "description": "", "type": "boolean", "widget": null, "values": [ "true" ], "order": 0, "isRequired": false }, { "name": "saveDocument", "description": "", "type": "boolean", "widget": null, "values": [ "true" ], "order": 0, "isRequired": false }, { "name": "sourceId", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "sourcePath", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.FetchByProperty", "version": "unknown", "aliases": [], "description": "For each specified string property value, fetch all documents that match the property and the optional where clause. Matching documents are collected into a list and the returned to the next operation. The operation has no input.", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.FetchByProperty", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "documents" ], "category": "Fetch", "url": "Document.FetchByProperty", "label": "Fetch By Property", "requires": null, "since": "", "params": [ { "name": "property", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "values", "description": "", "type": "stringlist", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "query", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Traces.ToggleRecording", "version": "unknown", "aliases": [], "description": "Toggle Automation call tracing (you can set the 'enableTrace' parameter if you want to explicitly set the traceEnable value", "operationClass": "org.nuxeo.ecm.automation.core.operations.traces.AutomationTraceToggleOperation", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "boolean" ], "category": "Execution Context", "url": "Traces.ToggleRecording", "label": "Traces.toggleRecording", "requires": null, "since": "", "params": [ { "name": "enableTrace", "description": "", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "readOnly", "description": "", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.SetBlob", "version": "unknown", "aliases": [ "Blob.Set" ], "description": "Set the input file to the given property on the input document. If the xpath points to a blob list then the blob is appended to the list, otherwise the xpath should point to a blob property. If the save parameter is set the document modification will be automatically saved. Return the document.", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.SetDocumentBlob", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.SetBlob", "label": "Set File", "requires": null, "since": "", "params": [ { "name": "file", "description": "", "type": "blob", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "save", "description": "", "type": "boolean", "widget": null, "values": [ "true" ], "order": 0, "isRequired": false }, { "name": "xpath", "description": "", "type": "string", "widget": null, "values": [ "file:content" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.Copy", "version": "unknown", "aliases": [], "description": "Copy the input document into the given Folderish. The name parameter will be used as the copy name otherwise if not specified the original name will be preserved. The target Folderish can be specified as an absolute or relative path (relative to the input document) as an UID or by using an EL expression. Return the newly created document (the copy). The document is copied with its children recursively. The resetLifeCycle parameter allows to reset the life cycle of the copied document.", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.CopyDocument", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.Copy", "label": "Copy", "requires": null, "since": "", "params": [ { "name": "target", "description": "", "type": "document", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "name", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "resetLifeCycle", "description": "", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Blob.RunConverter", "version": "unknown", "aliases": [], "description": "Simply call a converter based on the 'converter' parameter. You can pass the converter properties with the 'properties' parameter.", "operationClass": "org.nuxeo.ecm.automation.core.operations.blob.RunConverter", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "blob", "blob" ], "category": "Conversion", "url": "Blob.RunConverter", "label": "Blob.RunConverter", "requires": null, "since": "7.1", "params": [ { "name": "converter", "description": "The name of the converter to call", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "parameters", "description": "The converter parameters to pass", "type": "properties", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "RunScript", "version": "unknown", "aliases": [ "Context.RunScript" ], "description": "Run a script which content is specified as text in the 'script' parameter", "operationClass": "org.nuxeo.ecm.automation.core.operations.RunScript", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "void" ], "category": "Scripting", "url": "RunScript", "label": "Run Script", "requires": null, "since": "", "params": [ { "name": "script", "description": "", "type": "string", "widget": "TextArea", "values": [], "order": 0, "isRequired": true } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Context.PushBlob", "version": "unknown", "aliases": [ "Blob.Push" ], "description": "Push the input file on the context stack. The file can be restored later as the input using the corrresponding pop operation. Returns the input file.", "operationClass": "org.nuxeo.ecm.automation.core.operations.stack.PushBlob", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "blob", "blob" ], "category": "Push & Pop", "url": "Context.PushBlob", "label": "Push File", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.MoveCollectionMember", "version": "unknown", "aliases": [], "description": "Move member1 of a collection right after member2 of the same collection. If member2 is not sepcified, the member1 is moved to first position. Returns true if successfully moved.", "operationClass": "org.nuxeo.ecm.automation.core.operations.collections.MoveCollectionMemberOperation", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "document", "boolean" ], "category": "Document", "url": "Document.MoveCollectionMember", "label": "Reorder members of a collection", "requires": null, "since": "", "params": [ { "name": "member1", "description": "", "type": "document", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "member2", "description": "", "type": "document", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Context.FetchFile", "version": "unknown", "aliases": [], "description": "Fetch the input of the context as a file or list of files. The file(s) will become the input for the next operation.", "operationClass": "org.nuxeo.ecm.automation.core.operations.FetchContextBlob", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "blob", "blob", "bloblist", "bloblist" ], "category": "Fetch", "url": "Context.FetchFile", "label": "Context File(s)", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "UserGroup.Suggestion", "version": "unknown", "aliases": [], "description": "Get the user/group list of the running instance. This is returning a blob containing a serialized JSON array..", "operationClass": "org.nuxeo.ecm.automation.core.operations.users.SuggestUserEntries", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "void", "blob" ], "category": "Services", "url": "UserGroup.Suggestion", "label": "Get user/group suggestion", "requires": null, "since": "", "params": [ { "name": "displayEmailInSuggestion", "description": "", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "firstLabelField", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "groupRestriction", "description": "Enter the id of a group to suggest only user from this group.", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "hideAdminGroups", "description": "If set, remove all administrator groups from the suggestions", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "hideFirstLabel", "description": "", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "hideIcon", "description": "", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "hidePowerUsersGroup", "description": "If set, remove power users group from the suggestions", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "hideSecondLabel", "description": "", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "hideThirdLabel", "description": "", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "lang", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "searchTerm", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "searchType", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "secondLabelField", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "thirdLabelField", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "userSuggestionMaxSearchResults", "description": "", "type": "integer", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.GetBlobs", "version": "unknown", "aliases": [ "Blob.GetAll" ], "description": "Gets a list of all blobs that are attached on the input document. Returns a list of files.", "operationClass": "org.nuxeo.ecm.automation.core.operations.blob.GetAllDocumentBlobs", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "bloblist", "documents", "bloblist" ], "category": "Files", "url": "Document.GetBlobs", "label": "Get All Document Files", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.GetParent", "version": "unknown", "aliases": [], "description": "Get the parent document of the input document. The parent document will become the input for the next operation. You can use the 'type' parameter to specify which parent to select from the document ancestors", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.GetDocumentParent", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.GetParent", "label": "Get Parent", "requires": null, "since": "", "params": [ { "name": "type", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.Delete", "version": "unknown", "aliases": [], "description": "Delete the input document. The previous context input will be restored for the next operation.", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.DeleteDocument", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.Delete", "label": "Delete", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Context.PushDocumentList", "version": "unknown", "aliases": [ "Document.PushList" ], "description": "Push the input document list on the context stack. The document list can be restored later as the input using the corrresponding pop operation. Returns the input document list.", "operationClass": "org.nuxeo.ecm.automation.core.operations.stack.PushDocumentList", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "documents", "documents" ], "category": "Push & Pop", "url": "Context.PushDocumentList", "label": "Push Document List", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Context.RestoreBlobsInputFromScript", "version": "unknown", "aliases": [], "description": "Run a script and return the result Blobs object of the script the output of the operation", "operationClass": "org.nuxeo.ecm.automation.core.operations.RestoreBlobsInputFromScript", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "bloblist" ], "category": "Execution Context", "url": "Context.RestoreBlobsInputFromScript", "label": "Restore input blobs from a script", "requires": null, "since": "", "params": [ { "name": "script", "description": "", "type": "string", "widget": "TextArea", "values": [], "order": 0, "isRequired": true } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.CreateVersion", "version": "unknown", "aliases": [], "description": "Create a new version for the input document. Any modification made on the document by the chain will be automatically saved. Increment version if this was specified through the 'snapshot' parameter. This operation should not be used in the context of the empty document created, about to create, before document modification, document modified events. Returns the live document (not the version).", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.CreateVersion", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.CreateVersion", "label": "Snapshot Version", "requires": null, "since": "", "params": [ { "name": "increment", "description": "", "type": "string", "widget": "Option", "values": [ "None", "Minor", "Major" ], "order": 0, "isRequired": false }, { "name": "saveDocument", "description": "Save the document in the session after versioning", "type": "boolean", "widget": "Check", "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Collection.RemoveFromCollection", "version": "unknown", "aliases": [], "description": "Remove a list of documents from a collection. No value is returned.", "operationClass": "org.nuxeo.ecm.automation.core.operations.collections.RemoveFromCollectionOperation", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Collection.RemoveFromCollection", "label": "Remove from collection", "requires": null, "since": "", "params": [ { "name": "collection", "description": "", "type": "document", "widget": null, "values": [], "order": 0, "isRequired": true } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Context.RestoreDocumentInput", "version": "unknown", "aliases": [], "description": "Restore the document input from a context variable given its name. Return the document.", "operationClass": "org.nuxeo.ecm.automation.core.operations.RestoreDocumentInput", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "document" ], "category": "Execution Context", "url": "Context.RestoreDocumentInput", "label": "Restore Document Input", "requires": null, "since": "", "params": [ { "name": "name", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.RemoveFacet", "version": "unknown", "aliases": [ "Document.RemoveFacet" ], "description": "Removes the facet from the document.WARNING: The save parameter is true by default, which means the document is saved in the database after removing the facet. It must be set to false when the operation is used in the context of an event that will fail if the document is saved (empty document created, about to create, before modification, ...).
", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.RemoveFacet", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.RemoveFacet", "label": "Remove Facet", "requires": null, "since": "", "params": [ { "name": "facet", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "save", "description": "", "type": "boolean", "widget": null, "values": [ "true" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Directory.Entries", "version": "unknown", "aliases": [], "description": "Get the entries of a directory. This is returning a blob containing a serialized JSON array. The input document, if specified, is used as a context for a potential local configuration of the directory.", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.GetDirectoryEntries", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "void", "blob", "document", "blob" ], "category": "Services", "url": "Directory.Entries", "label": "Get directory entries", "requires": null, "since": "", "params": [ { "name": "directoryName", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "lang", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "translateLabels", "description": "", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.RequestRetrievalFromColdStorage", "version": "unknown", "aliases": [], "description": "Request a retrieval from cold storage of the content associated with the document.", "operationClass": "org.nuxeo.ecm.automation.core.operations.coldstorage.RequestRetrievalFromColdStorage", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "document", "document", "documents", "documents" ], "category": "Files", "url": "Document.RequestRetrievalFromColdStorage", "label": "Request retrieval from cold storage", "requires": null, "since": "", "params": [ { "name": "numberOfDaysOfAvailability", "description": "The number of days that you want your cold storage content to be accessible.", "type": "int", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "save", "description": "", "type": "boolean", "widget": null, "values": [ "true" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Repository.SaveSession", "version": "unknown", "aliases": [ "Document.SaveSession" ], "description": "Commit any changes made by the operation on the documents. This can be used to explicitly commit changes. This operation can be executed on any type of input. The input of this operation will be preserved as the input for the next operation in the chain.", "operationClass": "org.nuxeo.ecm.automation.core.operations.execution.SaveSession", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "void" ], "category": "Execution Flow", "url": "Repository.SaveSession", "label": "Save Session", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Directory.ReadEntries", "version": "unknown", "aliases": [], "description": "Reads directory entries. Entries ids to read are sent as a JSON array. Returns the entries as a JSON array of JSON objects containing all fields.", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.directory.ReadDirectoryEntries", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "void", "blob" ], "category": "Services", "url": "Directory.ReadEntries", "label": "Reads directory entries", "requires": null, "since": "", "params": [ { "name": "directoryName", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "entries", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "lang", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "translateLabels", "description": "", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.AddToCollection", "version": "unknown", "aliases": [ "Collection.AddToCollection" ], "description": "Add a list of documents in a collection. No value is returned.", "operationClass": "org.nuxeo.ecm.automation.core.operations.collections.AddToCollectionOperation", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.AddToCollection", "label": "Add document to collection", "requires": null, "since": "", "params": [ { "name": "collection", "description": "", "type": "document", "widget": null, "values": [], "order": 0, "isRequired": true } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "JsonStack.ToggleDisplay", "version": "unknown", "aliases": [], "description": "Toggle stack display in json response for all rest api calls in Nuxeo", "operationClass": "org.nuxeo.ecm.automation.core.operations.traces.JsonStackToggleDisplayOperation", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "boolean" ], "category": "Execution Context", "url": "JsonStack.ToggleDisplay", "label": "Json Error Stack Display", "requires": null, "since": "6.0", "params": [ { "name": "enableTrace", "description": "", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Directory.LoadFromCSV", "version": "unknown", "aliases": [], "description": "Load directory entries from a CSV file. Depending on the data loading policy, duplicate entries are ignored, updated or trigger an error.", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.directory.LoadFromCSV", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "blob", "void" ], "category": "Services", "url": "Directory.LoadFromCSV", "label": "Load directory entries from CSV file", "requires": null, "since": "", "params": [ { "name": "dataLoadingPolicy", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "directoryName", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.Update", "version": "unknown", "aliases": [], "description": "Set multiple properties on the input document. The properties are specified as key=value pairs separated by a new line. The key used for a property is the property xpath. To specify multi-line values you can use a \\ character followed by a new line.Example:
dc:title=The Document TitleFor updating a date, you will need to expose the value as ISO 8601 format, for instance :
dc:description=foo bar
Example:
dc:title=The Document Title
dc:issued=@{org.nuxeo.ecm.core.schema.utils.DateParser.formatW3CDateTime(CurrentDate.date)}
Returns back the updated document.
To update a multi-valued field with multiple values:
custom:multivalued=a,b,c,d
Save parameter automatically saves the document in the database. It has to be turned off when this operation is used in the context of the empty document created, about to create, before document modification, document modified events.
", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.UpdateDocument", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.Update", "label": "Update Properties", "requires": null, "since": "", "params": [ { "name": "properties", "description": "", "type": "properties", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "changeToken", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "save", "description": "", "type": "boolean", "widget": null, "values": [ "true" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.GetBlob", "version": "unknown", "aliases": [ "Blob.Get" ], "description": "Gets a file attached to the input document. The file location is specified using an xpath to the blob property of the document. Returns the file.", "operationClass": "org.nuxeo.ecm.automation.core.operations.blob.GetDocumentBlob", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "blob", "documents", "bloblist" ], "category": "Files", "url": "Document.GetBlob", "label": "Get Document File", "requires": null, "since": "", "params": [ { "name": "xpath", "description": "", "type": "string", "widget": null, "values": [ "file:content" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.PublishToSections", "version": "unknown", "aliases": [ "Document.MultiPublish" ], "description": "Publish the input document(s) into several target sections. The target is evaluated to a document list (can be a path, UID or EL expression). Existing proxy is overridden if the override attribute is set. Returns a list with the created proxies.", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.MultiPublishDocument", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "documents", "documents", "documents" ], "category": "Document", "url": "Document.PublishToSections", "label": "Multi-Publish", "requires": null, "since": "", "params": [ { "name": "target", "description": "", "type": "documents", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "override", "description": "", "type": "boolean", "widget": null, "values": [ "true" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Auth.LoginAs", "version": "unknown", "aliases": [], "description": "Login As the given user. If no user is given a system login is performed. This is a void operations - the input will be returned back as the output.", "operationClass": "org.nuxeo.ecm.automation.core.operations.login.LoginAs", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "void", "document", "document" ], "category": "Users & Groups", "url": "Auth.LoginAs", "label": "Login As", "requires": null, "since": "", "params": [ { "name": "name", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Audit.Query", "version": "unknown", "aliases": [], "description": "Execute a JPA query against the Audit Service. This is returning a blob with the query result. The result is a serialized JSON array. You can use the context to set query variables but you must prefix using 'audit.query.' the context variable keys that match the ones in the query.", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.AuditQuery", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "void", "blob" ], "category": "Services", "url": "Audit.Query", "label": "Query Audit Service", "requires": null, "since": "", "params": [ { "name": "query", "description": "", "type": "string", "widget": "TextArea", "values": [], "order": 0, "isRequired": true }, { "name": "maxResults", "description": "", "type": "int", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "pageNo", "description": "", "type": "int", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.RemoveItemFromListProperty", "version": "unknown", "aliases": [], "description": "This operation removes an entry from a multivalued property, specified using a xpath (e.g.: contract:customers). A specific entry can be removed using its index number. If the index parameter is left empty, all entries in the property are removed. Activating the save parameter forces the changes to be written in database immediately (at the cost of performance loss), otherwise changes made to the document will be written in bulk when the chain succeeds.Save parameter has to be turned off when this operation is used in the context of the empty document created, about to create, before document modification, document modified events.
", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.RemoveItemFromListProperty", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.RemoveItemFromListProperty", "label": "Removes an Entry From a Multivalued Property", "requires": null, "since": "", "params": [ { "name": "xpath", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "index", "description": "", "type": "integer", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "save", "description": "", "type": "boolean", "widget": null, "values": [ "true" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.AddPermission", "version": "unknown", "aliases": [ "Document.AddACL" ], "description": "Add Permission on the input document(s). Returns the document(s).", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.AddPermission", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.AddPermission", "label": "Add Permission", "requires": null, "since": "", "params": [ { "name": "permission", "description": "ACE permission.", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "acl", "description": "ACL name.", "type": "string", "widget": null, "values": [ "local" ], "order": 0, "isRequired": false }, { "name": "begin", "description": "ACE begin date.", "type": "date", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "blockInheritance", "description": "Block inheritance or not.", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "comment", "description": "Comment", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "email", "description": "ACE target user/group.", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "end", "description": "ACE end date.", "type": "date", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "notify", "description": "Notify the user or not", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "username", "description": "ACE target user/group.", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "users", "description": "ACE target set of users and/or groups.", "type": "stringlist", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Context.PullBlobList", "version": "unknown", "aliases": [ "Blob.PullList" ], "description": "Restore the first saved input file list in the context input stack", "operationClass": "org.nuxeo.ecm.automation.core.operations.stack.PullBlobList", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "bloblist" ], "category": "Push & Pop", "url": "Context.PullBlobList", "label": "Pull File List", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Context.RestoreDocumentsInputFromScript", "version": "unknown", "aliases": [], "description": "Run a script and return the result documents object of the script the output of the operation", "operationClass": "org.nuxeo.ecm.automation.core.operations.RestoreDocumentsInputFromScript", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "documents" ], "category": "Execution Context", "url": "Context.RestoreDocumentsInputFromScript", "label": "Restore input documents from a script", "requires": null, "since": "", "params": [ { "name": "script", "description": "", "type": "string", "widget": "TextArea", "values": [], "order": 0, "isRequired": true } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Auth.Logout", "version": "unknown", "aliases": [], "description": "Perform a logout. This should be used only after using the Login As operation to restore original login. This is a void operations - the input will be returned back as the output.", "operationClass": "org.nuxeo.ecm.automation.core.operations.login.Logout", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "void", "document", "document" ], "category": "Users & Groups", "url": "Auth.Logout", "label": "Logout", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Blob.PostToURL", "version": "unknown", "aliases": [ "Blob.Post" ], "description": "Post the input file to a target HTTP URL. Returns back the input file.", "operationClass": "org.nuxeo.ecm.automation.core.operations.blob.PostBlob", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "blob", "blob", "bloblist", "bloblist" ], "category": "Files", "url": "Blob.PostToURL", "label": "HTTP Post", "requires": null, "since": "", "params": [ { "name": "url", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Actions.GET", "version": "unknown", "aliases": [], "description": "Retrieve list of available actions for a given category. Action context is built based on the Operation context (currentDocument will be fetched from Context if not provided as input). If this operation is executed in a chain that initialized the Seam context, it will be used for Action context", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.GetActions", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "void", "blob", "document", "blob" ], "category": "Services", "url": "Actions.GET", "label": "List available actions", "requires": null, "since": "", "params": [ { "name": "category", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "lang", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Event.Fire", "version": "unknown", "aliases": [ "Notification.SendEvent" ], "description": "Send a Nuxeo event.", "operationClass": "org.nuxeo.ecm.automation.core.events.operations.FireEvent", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "void" ], "category": "Notification", "url": "Event.Fire", "label": "Send Event", "requires": null, "since": "", "params": [ { "name": "name", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "properties", "description": "", "type": "properties", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Directory.CreateEntries", "version": "unknown", "aliases": [], "description": "Creates directory entries. Entries are sent as a JSON array. Returning the created entries ids as a JSON array.", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.directory.CreateDirectoryEntries", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "void", "blob" ], "category": "Services", "url": "Directory.CreateEntries", "label": "Creates directory entries", "requires": null, "since": "", "params": [ { "name": "directoryName", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "entries", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Counters.GET", "version": "unknown", "aliases": [], "description": "Retrieve data collected by one or more Counters", "operationClass": "org.nuxeo.ecm.automation.core.operations.management.GetCounters", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "void", "blob" ], "category": "Services", "url": "Counters.GET", "label": "Retrieve counters values", "requires": null, "since": "", "params": [ { "name": "counterNames", "description": "", "type": "stringlist", "widget": null, "values": [], "order": 0, "isRequired": true } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.RemoveACL", "version": "unknown", "aliases": [], "description": "Remove a named Acces Control List from the input document(s). Returns the document(s).", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.RemoveDocumentACL", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.RemoveACL", "label": "Remove ACL", "requires": null, "since": "", "params": [ { "name": "acl", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "FileManager.ImportWithProperties", "version": "unknown", "aliases": [], "description": "Create Document(s) from Blob(s) using the FileManagerService and set multiple properties on them.The destination container must be passed in a Context variable named currentDocument.The properties are specified as key=value pairs separated by a new line. The key used for a property is the property xpath. To specify multi-line values you can use a \\ character followed by a new line.
Example:
dc:title=The Document TitleFor updating a date, you will need to expose the value as ISO 8601 format, for instance :
dc:description=foo bar
Example:
dc:title=The Document Title
dc:issued=@{org.nuxeo.ecm.core.schema.utils.DateParser.formatW3CDateTime(CurrentDate.date)}
Returns back the updated document.
To update a multi-valued field with multiple values:
custom:multivalued=a,b,c,d", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.FileManagerImportWithProperties", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "bloblist", "documents", "blob", "document" ], "category": "Services", "url": "FileManager.ImportWithProperties", "label": "Create Document from file", "requires": null, "since": "", "params": [ { "name": "properties", "description": "", "type": "properties", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "mimeTypeCheck", "description": "Whether to check the blob's mime-type against the file name, defaults to true", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "overwrite", "description": "Whether to overwrite an existing file with the same title, defaults to false", "type": "boolean", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "RunFileOperation", "version": "unknown", "aliases": [ "Context.RunFileOperation" ], "description": "Run an operation chain which is returning a file in the current context. The input for the chain to run is a file or a list of files. Return the output of the chain as a file or a list of files. The 'parameters' injected are accessible in the subcontext ChainParameters. For instance, @{ChainParameters['parameterKey']}.", "operationClass": "org.nuxeo.ecm.automation.core.operations.execution.RunFileChain", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "bloblist", "bloblist", "blob", "blob" ], "category": "Execution Flow", "url": "RunFileOperation", "label": "Run File Chain", "requires": null, "since": "", "params": [ { "name": "id", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "isolate", "description": "", "type": "boolean", "widget": null, "values": [ "false" ], "order": 0, "isRequired": false }, { "name": "newTx", "description": "Define if the chain in parameter should be executed in new transaction.", "type": "boolean", "widget": null, "values": [ "false" ], "order": 0, "isRequired": false }, { "name": "parameters", "description": "Accessible in the subcontext ChainParameters. For instance, @{ChainParameters['parameterKey']}.", "type": "properties", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "rollbackGlobalOnError", "description": "Define if transaction should rollback or not (default to true)", "type": "boolean", "widget": null, "values": [ "true" ], "order": 0, "isRequired": false }, { "name": "timeout", "description": "Define transaction timeout (default to 60 sec).", "type": "integer", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "RunOperationOnListInNewTx", "version": "unknown", "aliases": [ "Context.RunOperationOnListInNewTx" ], "description": "Run an operation/chain in a new Transaction for each element from the list defined by the 'list' parameter. The 'list' parameter is pointing to a context variable that represents the list which will be iterated. The 'itemName' parameter represents the name of the context variable which will point to the current element in the list at each iteration. You can use the 'isolate' parameter to specify whether or not the evalution context is the same as the parent context or a copy of it. If the 'isolate' parameter is 'true' then a copy of the current context is used and so that modifications in this context will not affect the parent context. Any input is accepted. The input is returned back as output when operation terminates.", "operationClass": "org.nuxeo.ecm.automation.core.operations.execution.RunOperationOnListInNewTransaction", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "void" ], "category": "Execution Flow", "url": "RunOperationOnListInNewTx", "label": "Run For Each in new TX", "requires": null, "since": "", "params": [ { "name": "id", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "list", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "isolate", "description": "", "type": "boolean", "widget": null, "values": [ "true" ], "order": 0, "isRequired": false }, { "name": "itemName", "description": "", "type": "string", "widget": null, "values": [ "item" ], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Bulk.RunAction", "version": "unknown", "aliases": [], "description": "Run a bulk action on a set of documents expressed by a NXQL.", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.bulk.BulkRunAction", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "void", "bulkstatus" ], "category": "Services", "url": "Bulk.RunAction", "label": "Run a bulk command", "requires": null, "since": "", "params": [ { "name": "action", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "batchSize", "description": "", "type": "int", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "bucketSize", "description": "", "type": "int", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "namedParameters", "description": "Named parameters to pass to the page provider to fill in query variables.", "type": "properties", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "parameters", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "providerName", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "query", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "queryParams", "description": "", "type": "stringlist", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "quickFilters", "description": "Quick filter properties (separated by comma)", "type": "stringlist", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "repositoryName", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.GetChild", "version": "unknown", "aliases": [], "description": "Get a child document given its name. Take as input the parent document and return the child document.", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.GetDocumentChild", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.GetChild", "label": "Get Child", "requires": null, "since": "", "params": [ { "name": "name", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Group.CreateOrUpdate", "version": "unknown", "aliases": [], "description": "Create or Update Group", "operationClass": "org.nuxeo.ecm.automation.core.operations.users.CreateOrUpdateGroup", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "void", "void" ], "category": "Users & Groups", "url": "Group.CreateOrUpdate", "label": "Create or Update Group", "requires": null, "since": "", "params": [ { "name": "groupname", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "description", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "grouplabel", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "members", "description": "", "type": "stringlist", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "mode", "description": "", "type": "string", "widget": null, "values": [ "createOrUpdate", "create", "update" ], "order": 0, "isRequired": false }, { "name": "parentGroups", "description": "", "type": "stringlist", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "properties", "description": "", "type": "properties", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "subGroups", "description": "", "type": "stringlist", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "tenantId", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Context.SetInputAsVar", "version": "unknown", "aliases": [], "description": "Set a context variable that points to the current input object. You must give a name for the variable. This operation works on any input type and return back the input as the output.", "operationClass": "org.nuxeo.ecm.automation.core.operations.SetInputAsVar", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "void" ], "category": "Execution Context", "url": "Context.SetInputAsVar", "label": "Set Context Variable From Input", "requires": null, "since": "", "params": [ { "name": "name", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.GetChildren", "version": "unknown", "aliases": [], "description": "Get the children of a document. The list of children will become the input for the next operation", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.GetDocumentChildren", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "documents", "documents", "documents" ], "category": "Document", "url": "Document.GetChildren", "label": "Get Children", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Directory.CreateVocabularyEntry", "version": "unknown", "aliases": [], "description": "Add a new entry in the vocabularyName vocabulary only if id is not found (an existing entry isnot updated). If label is empty, it is set to the id. WARNING: Current user must have enough rights to write in a vocabulary.", "operationClass": "org.nuxeo.ecm.automation.core.operations.services.directory.CreateVocabularyEntry", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "void", "void" ], "category": "Services", "url": "Directory.CreateVocabularyEntry", "label": "Vocabulary: Add Entry", "requires": null, "since": "", "params": [ { "name": "id", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "vocabularyName", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "label", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "obsolete", "description": "", "type": "long", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "ordering", "description": "", "type": "long", "widget": null, "values": [], "order": 0, "isRequired": false }, { "name": "parent", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "User.GetCollections", "version": "unknown", "aliases": [ "Collection.GetCollections" ], "description": "Get the list of all the collections visible by the currentUser. This is returning a list of collections.", "operationClass": "org.nuxeo.ecm.automation.core.operations.collections.GetCollectionsOperation", "contributingComponent": "org.nuxeo.ecm.core.automation.features.operations", "signature": [ "void", "documents" ], "category": "Document", "url": "User.GetCollections", "label": "Get collections", "requires": null, "since": "", "params": [ { "name": "searchTerm", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.Save", "version": "unknown", "aliases": [], "description": "Save in the repository any modification that was done on the input document. This operation should not be used in the context of the empty document created, about to create, before document modification, document modified events. Returns the saved document.", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.SaveDocument", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.Save", "label": "Save", "requires": null, "since": "", "params": [] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.SetProperty", "version": "unknown", "aliases": [], "description": "Set a single property value on the input document. The property is specified using its xpath. Save parameter automatically saves the document in the database. It has to be turned off when this operation is used in the context of the empty document created, about to create, before document modification, document modified events. Returns the modified document.", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.SetDocumentProperty", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.SetProperty", "label": "Update Property", "requires": null, "since": "", "params": [ { "name": "xpath", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true }, { "name": "save", "description": "", "type": "boolean", "widget": null, "values": [ "true" ], "order": 0, "isRequired": false }, { "name": "value", "description": "", "type": "serializable", "widget": null, "values": [], "order": 0, "isRequired": false } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Document.CreateLiveProxy", "version": "unknown", "aliases": [ "CreateProxyLive" ], "description": "This operation will create a proxy that points the given document as input. This is like a symbolic link for File System. The proxy will be created into the destination specified as parameter.
The document returned is the proxy live.
Remark: you will have a strange behavior if the input is a folderish.", "operationClass": "org.nuxeo.ecm.automation.core.operations.document.CreateProxyLive", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "document", "document", "documents", "documents" ], "category": "Document", "url": "Document.CreateLiveProxy", "label": "Create Proxy Live", "requires": null, "since": "", "params": [ { "name": "Destination Path", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true } ] }, { "@class": "org.nuxeo.apidoc.introspection.OperationInfoImpl", "name": "Context.RestoreBlobsInput", "version": "unknown", "aliases": [], "description": "Restore the file list input from a context variable given its name. Return the files.", "operationClass": "org.nuxeo.ecm.automation.core.operations.RestoreBlobsInput", "contributingComponent": "org.nuxeo.ecm.core.automation.coreContrib", "signature": [ "void", "bloblist" ], "category": "Execution Context", "url": "Context.RestoreBlobsInput", "label": "Restore Files Input", "requires": null, "since": "", "params": [ { "name": "name", "description": "", "type": "string", "widget": null, "values": [], "order": 0, "isRequired": true } ] } ], "bundleGroups": [ { "@class": "org.nuxeo.apidoc.introspection.BundleGroupImpl", "id": "grp:org.nuxeo.ecm.core", "name": "org.nuxeo.ecm.core", "liveDoc": {}, "subGroups": [], "bundleIds": [ "org.nuxeo.ecm.core", "org.nuxeo.ecm.core.api", "org.nuxeo.ecm.core.bulk", "org.nuxeo.ecm.core.bulk.test", "org.nuxeo.ecm.core.cache", "org.nuxeo.ecm.core.convert", "org.nuxeo.ecm.core.convert.plugins", "org.nuxeo.ecm.core.event", "org.nuxeo.ecm.core.event.test", "org.nuxeo.ecm.core.io", "org.nuxeo.ecm.core.management", "org.nuxeo.ecm.core.mimetype", "org.nuxeo.ecm.core.query", "org.nuxeo.ecm.core.schema", "org.nuxeo.ecm.core.storage", "org.nuxeo.ecm.core.storage.dbs", "org.nuxeo.ecm.core.storage.mem", "org.nuxeo.ecm.core.storage.mongodb", "org.nuxeo.ecm.core.storage.sql", "org.nuxeo.ecm.core.storage.sql.test", "org.nuxeo.ecm.core.test", "org.nuxeo.ecm.platform.el" ], "version": "unknown", "parentIds": [] }, { "@class": "org.nuxeo.apidoc.introspection.BundleGroupImpl", "id": "grp:org.nuxeo.misc", "name": "org.nuxeo.misc", "liveDoc": {}, "subGroups": [], "bundleIds": [ "org.nuxeo.ecm.config" ], "version": "unknown", "parentIds": [] }, { "@class": "org.nuxeo.apidoc.introspection.BundleGroupImpl", "id": "grp:org.nuxeo.ecm.platform", "name": "org.nuxeo.ecm.platform", "liveDoc": {}, "subGroups": [ { "@class": "org.nuxeo.apidoc.introspection.BundleGroupImpl", "id": "grp:org.nuxeo.ecm.directory", "name": "org.nuxeo.ecm.directory", "liveDoc": {}, "subGroups": [], "bundleIds": [ "org.nuxeo.ecm.directory", "org.nuxeo.ecm.directory.api", "org.nuxeo.ecm.directory.sql", "org.nuxeo.ecm.directory.types.contrib" ], "version": "unknown", "parentIds": [ "grp:org.nuxeo.ecm.platform" ] }, { "@class": "org.nuxeo.apidoc.introspection.BundleGroupImpl", "id": "grp:org.nuxeo.ecm.platform.query", "name": "org.nuxeo.ecm.platform.query", "liveDoc": {}, "subGroups": [], "bundleIds": [ "org.nuxeo.ecm.platform.query.api" ], "version": "unknown", "parentIds": [ "grp:org.nuxeo.ecm.platform" ] }, { "@class": "org.nuxeo.apidoc.introspection.BundleGroupImpl", "id": "grp:org.nuxeo.ecm.platform.usermanager", "name": "org.nuxeo.ecm.platform.usermanager", "liveDoc": {}, "subGroups": [], "bundleIds": [ "org.nuxeo.ecm.platform.usermanager", "org.nuxeo.ecm.platform.usermanager.api" ], "version": "unknown", "parentIds": [ "grp:org.nuxeo.ecm.platform" ] } ], "bundleIds": [ "org.nuxeo.apidoc.core", "org.nuxeo.apidoc.repo", "org.nuxeo.directory.mongodb", "org.nuxeo.ecm.actions", "org.nuxeo.ecm.platform.api", "org.nuxeo.ecm.platform.commandline.executor", "org.nuxeo.ecm.platform.content.template", "org.nuxeo.ecm.platform.dublincore", "org.nuxeo.ecm.platform.forms.layout.export", "org.nuxeo.ecm.platform.login", "org.nuxeo.ecm.platform.web.common", "org.nuxeo.osgi.app" ], "version": "unknown", "parentIds": [] }, { "@class": "org.nuxeo.apidoc.introspection.BundleGroupImpl", "id": "grp:org.nuxeo.ecm.automation", "name": "org.nuxeo.ecm.automation", "liveDoc": {}, "subGroups": [], "bundleIds": [ "org.nuxeo.ecm.automation.core", "org.nuxeo.ecm.automation.features", "org.nuxeo.ecm.automation.io", "org.nuxeo.ecm.automation.scripting", "org.nuxeo.ecm.automation.server" ], "version": "unknown", "parentIds": [] }, { "@class": "org.nuxeo.apidoc.introspection.BundleGroupImpl", "id": "grp:org.nuxeo.runtime", "name": "org.nuxeo.runtime", "liveDoc": {}, "subGroups": [], "bundleIds": [ "org.nuxeo.runtime", "org.nuxeo.runtime.cluster", "org.nuxeo.runtime.datasource", "org.nuxeo.runtime.jtajca", "org.nuxeo.runtime.kv", "org.nuxeo.runtime.management", "org.nuxeo.runtime.metrics", "org.nuxeo.runtime.migration", "org.nuxeo.runtime.mongodb", "org.nuxeo.runtime.pubsub", "org.nuxeo.runtime.reload", "org.nuxeo.runtime.stream", "org.nuxeo.runtime.stream.test" ], "version": "unknown", "parentIds": [] }, { "@class": "org.nuxeo.apidoc.introspection.BundleGroupImpl", "id": "grp:org.nuxeo.ecm.webengine", "name": "org.nuxeo.ecm.webengine", "liveDoc": { "description": { "target": "grp:org.nuxeo.ecm.webengine", "targetType": "NXBundleGroup", "applicableVersion": [ "unknown" ], "typeLabel": "description" } }, "subGroups": [], "bundleIds": [ "org.nuxeo.ecm.webengine.core", "org.nuxeo.ecm.webengine.jaxrs" ], "version": "unknown", "parentIds": [] }, { "@class": "org.nuxeo.apidoc.introspection.BundleGroupImpl", "id": "grp:org.nuxeo.elasticsearch", "name": "org.nuxeo.elasticsearch", "liveDoc": { "description": { "target": "grp:org.nuxeo.elasticsearch", "targetType": "NXBundleGroup", "applicableVersion": [ "unknown" ], "typeLabel": "description" } }, "subGroups": [], "bundleIds": [ "org.nuxeo.elasticsearch.core" ], "version": "unknown", "parentIds": [] } ], "javaComponentIds": [ "org.nuxeo.runtime.codec.service", "org.nuxeo.runtime.avro", "org.nuxeo.runtime.stream.kafka.service", "org.nuxeo.runtime.stream.service", "org.nuxeo.ecm.core.event.EventServiceComponent", "org.nuxeo.ecm.core.work.service", "org.nuxeo.ecm.core.scheduler.SchedulerService", "org.nuxeo.ecm.core.schema.ObjectResolverService", "org.nuxeo.ecm.core.schema.TypeService", "org.nuxeo.runtime.jtajca.JtaActivator", "org.nuxeo.ecm.directory.sql.SQLDirectoryFactory", "org.nuxeo.ecm.core.storage.lock.LockManagerService", "org.nuxeo.ecm.core.operation.OperationServiceComponent", "org.nuxeo.ecm.platform.commandline.executor.service.CommandLineExecutorComponent", "org.nuxeo.ecm.webengine.core.service.json", "org.nuxeo.ecm.webengine.WebEngineComponent", "org.nuxeo.directory.mongodb.MongoDBDirectoryFactory", "org.nuxeo.ecm.core.api.CoreSessionServiceImpl", "org.nuxeo.ecm.core.security.SecurityService", "org.nuxeo.ecm.core.api.versioning.VersioningService", "org.nuxeo.ecm.core.CoreService", "org.nuxeo.ecm.core.filter.CharacterFilteringService", "org.nuxeo.ecm.core.uidgen.UIDGeneratorService", "org.nuxeo.ecm.core.blob.DocumentBlobManager", "org.nuxeo.ecm.core.lifecycle.LifeCycleService", "org.nuxeo.ecm.core.trash.TrashService", "org.nuxeo.ecm.core.repository.RepositoryServiceComponent", "org.nuxeo.runtime.cluster.ClusterService", "org.nuxeo.runtime.datasource", "org.nuxeo.ecm.core.management.CoreManagementComponent", "org.nuxeo.ecm.core.managemment.standby", "org.nuxeo.runtime.ConfigurationService", "org.nuxeo.runtime.trackers.files", "org.nuxeo.runtime.EventService", "org.nuxeo.runtime.LoginAsComponent", "org.nuxeo.runtime.RuntimeComponent", "org.nuxeo.runtime.LoginComponent", "org.nuxeo.runtime.services.resource.ResourceService", "org.nuxeo.runtime.model.persistence", "org.nuxeo.runtime.migration.MigrationService", "org.nuxeo.apidoc.snapshot.SnapshotManagerComponent", "org.nuxeo.apidoc.documentation.DocumentationComponent", "org.nuxeo.runtime.kv.KeyValueService", "org.nuxeo.ecm.directory.GenericDirectory", "org.nuxeo.ecm.directory.DirectoryServiceImpl", "org.nuxeo.ecm.directory.core.CoreDirectoryFactory", "org.nuxeo.ecm.platform.actions.ActionService", "org.nuxeo.ecm.core.scroll.service", "org.nuxeo.ecm.core.bulk", "org.nuxeo.ecm.webengine.jaxrs.servlet.config.ServletRegistryComponent", "org.nuxeo.runtime.metrics.MetricsService", "org.nuxeo.automation.scripting.internals.AutomationScriptingComponent", "org.nuxeo.ecm.platform.mimetype.service.MimetypeRegistryService", "org.nuxeo.runtime.pubsub.PubSubService", "org.nuxeo.ecm.core.storage.mem.MemRepositoryService", "org.nuxeo.ecm.core.storage.mongodb.MongoDBRepositoryService", "org.nuxeo.ecm.core.storage.sql.jdbc.QueryMakerService", "org.nuxeo.ecm.core.repository.RepositoryService", "org.nuxeo.ecm.core.storage.sql.RepositoryService", "org.nuxeo.ecm.core.api.DocumentAdapterService", "org.nuxeo.ecm.core.api.pathsegment.PathSegmentService", "org.nuxeo.ecm.core.api.blobholder.BlobHolderAdapterComponent", "org.nuxeo.ecm.core.api.repository.RepositoryManager", "org.nuxeo.core.LocalConfigurationService", "org.nuxeo.ecm.core.api.thumbnail.ThumbnailService", "org.nuxeo.ecm.core.api.propertiesmapping.PropertiesMappingComponent", "org.nuxeo.ecm.core.blob.BlobManager", "org.nuxeo.ecm.core.api.DocumentValidationService", "org.nuxeo.ecm.core.convert.service.ConversionServiceImpl", "org.nuxeo.ecm.platform.el.service", "org.nuxeo.ecm.platform.query.api.PageProviderService", "org.nuxeo.runtime.reload", "org.nuxeo.elasticsearch.ElasticSearchComponent", "DublinCoreStorageService", "org.nuxeo.runtime.management.ServerLocator", "org.nuxeo.runtime.management.ResourcePublisher", "org.nuxeo.runtime.management.metrics", "org.nuxeo.runtime.management.counters", "org.nuxeo.ecm.automation.server.BatchManager", "org.nuxeo.ecm.automation.server.AutomationServer", "org.nuxeo.runtime.mongodb.MongoDBComponent", "org.nuxeo.ecm.core.transientstore.TransientStorageComponent", "org.nuxeo.ecm.core.cache.CacheService", "org.nuxeo.ecm.core.io.MarshallerRegistry", "org.nuxeo.ecm.core.io.download.DownloadService", "org.nuxeo.ecm.core.io.DocumentXMLExporter", "org.nuxeo.ecm.core.storage.dbs.DBSRepositoryService", "org.nuxeo.ecm.platform.web.common.requestcontroller.service.RequestControllerService", "org.nuxeo.ecm.platform.web.common.exceptionhandling.service.ExceptionHandlingService", "org.nuxeo.ecm.platform.web.common.locale", "org.nuxeo.ecm.platform.ui.web.auth.service.PluggableAuthenticationService", "org.nuxeo.ecm.platform.content.template.service.ContentTemplateService", "org.nuxeo.ecm.automation.io.services.IOComponent", "org.nuxeo.ecm.platform.usermanager.UserService", "org.nuxeo.ecm.platform.computedgroups.ComputedGroupsServiceImpl" ], "xmlComponentIds": [ "org.nuxeo.apidoc.adapterContrib", "org.nuxeo.apidoc.directoryContrib", "org.nuxeo.apidoc.directoryUIContrib", "org.nuxeo.apidoc.doctypeContrib", "org.nuxeo.apidoc.layout.contrib", "org.nuxeo.apidoc.lifecycle.contrib", "org.nuxeo.apidoc.listener.contrib", "org.nuxeo.apidoc.schemaContrib", "org.nuxeo.apidoc.test.works", "org.nuxeo.apidoc.uiContrib", "org.nuxeo.automation.scripting.classfilter", "org.nuxeo.directory.test.sql", "org.nuxeo.ecm.automation.core.impl.ReloadListener", "org.nuxeo.ecm.automation.core.impl.workmanager", "org.nuxeo.ecm.automation.io.services.IOComponent.codec.contrib", "org.nuxeo.ecm.automation.rest.pageprovider.contrib", "org.nuxeo.ecm.automation.server.auth.config", "org.nuxeo.ecm.automation.server.batch.handler.DefaultBatchHandler", "org.nuxeo.ecm.automation.server.bindings", "org.nuxeo.ecm.automation.server.marshallers", "org.nuxeo.ecm.core.CoreExtensions", "org.nuxeo.ecm.core.DocumentModel.resolver", "org.nuxeo.ecm.core.LifecycleCoreExtensions", "org.nuxeo.ecm.core.api.DocumentValidationService.activations", "org.nuxeo.ecm.core.api.blohodlers.adapters", "org.nuxeo.ecm.core.api.local.dummy.login", "org.nuxeo.ecm.core.api.properties", "org.nuxeo.ecm.core.api.thumbnail.adapter", "org.nuxeo.ecm.core.automation.contextContrib", "org.nuxeo.ecm.core.automation.core.properties", "org.nuxeo.ecm.core.automation.coreContrib", "org.nuxeo.ecm.core.automation.features.bindings", "org.nuxeo.ecm.core.automation.features.bulk", "org.nuxeo.ecm.core.automation.features.operations", "org.nuxeo.ecm.core.automation.marshallers", "org.nuxeo.ecm.core.automation.scripting.contextContrib", "org.nuxeo.ecm.core.bulk.config", "org.nuxeo.ecm.core.bulk.io", "org.nuxeo.ecm.core.bulk.tests", "org.nuxeo.ecm.core.coldstorage.contrib", "org.nuxeo.ecm.core.convert.configuration", "org.nuxeo.ecm.core.convert.plugins", "org.nuxeo.ecm.core.deletion.config", "org.nuxeo.ecm.core.document.characterFiltering.contrib", "org.nuxeo.ecm.core.event.lifecycle.listener", "org.nuxeo.ecm.core.event.orphanVersionRemoval.listener", "org.nuxeo.ecm.core.io.MarshallerRegistry.marshallers", "org.nuxeo.ecm.core.io.avro.factories", "org.nuxeo.ecm.core.management.contribs", "org.nuxeo.ecm.core.management.es.tests", "org.nuxeo.ecm.core.management.listener", "org.nuxeo.ecm.core.management.runtime.management.contribs", "org.nuxeo.ecm.core.management.typesContrib", "org.nuxeo.ecm.core.orphanVersionsCleanup", "org.nuxeo.ecm.core.query.properties", "org.nuxeo.ecm.core.retention.contrib", "org.nuxeo.ecm.core.schedulers", "org.nuxeo.ecm.core.scroll.contrib.default", "org.nuxeo.ecm.core.security.acl.properties", "org.nuxeo.ecm.core.security.defaultPermissions", "org.nuxeo.ecm.core.security.defaultPolicies", "org.nuxeo.ecm.core.storage.mongodb.configuration", "org.nuxeo.ecm.core.storage.sql.jdbc.querymaker.contrib", "org.nuxeo.ecm.core.storage.sql.softdelete", "org.nuxeo.ecm.core.storage.sql.test.repo.repository", "org.nuxeo.ecm.core.test.blobmanager", "org.nuxeo.ecm.core.trash.service.migrator", "org.nuxeo.ecm.core.uidseq.keyvaluestore", "org.nuxeo.ecm.core.versioning.VersioningDocumentAdapter", "org.nuxeo.ecm.core.versioning.default-policies", "org.nuxeo.ecm.core.work.config", "org.nuxeo.ecm.core.work.test.default.queuing", "org.nuxeo.ecm.directory.actions.core", "org.nuxeo.ecm.directory.local.configuration", "org.nuxeo.ecm.directory.marshallers", "org.nuxeo.ecm.directory.resolver", "org.nuxeo.ecm.directory.types", "org.nuxeo.ecm.platform.actions.ActionService.properties", "org.nuxeo.ecm.platform.audit.PageProviderservice.automation.contrib", "org.nuxeo.ecm.platform.commandline.executor.service.defaultContrib", "org.nuxeo.ecm.platform.computedgroups.UserManager.companyComputerContrib", "org.nuxeo.ecm.platform.content.template.listener", "org.nuxeo.ecm.platform.content.template.service.ContentTemplateService.defaultContrib", "org.nuxeo.ecm.platform.contentview.json.marshallers", "org.nuxeo.ecm.platform.convert.commandline.pdf2text", "org.nuxeo.ecm.platform.directory.pageproviders", "org.nuxeo.ecm.platform.filters", "org.nuxeo.ecm.platform.test.directory.sql.storage", "org.nuxeo.ecm.platform.ui.web.auth.WebEngineConfig", "org.nuxeo.ecm.platform.ui.web.auth.defaultConfig", "org.nuxeo.ecm.platform.ui.web.cors", "org.nuxeo.ecm.platform.ui.web.login", "org.nuxeo.ecm.platform.usermanager.UserManagerImpl", "org.nuxeo.ecm.platform.usermanager.adapter", "org.nuxeo.ecm.platform.usermanager.marshallers", "org.nuxeo.ecm.platform.usermanager.pageproviders", "org.nuxeo.ecm.platform.usermanager.properties", "org.nuxeo.ecm.platform.usermanager.resolver", "org.nuxeo.ecm.platform.web.common.adminStatusListener.contrib", "org.nuxeo.ecm.platform.web.common.exceptionhandling.service.ExceptionHandlingContrib", "org.nuxeo.ecm.platform.web.common.locale.default.contrib", "org.nuxeo.ecm.platform.web.common.requestcontroller.service.RequestControllerService.defaultContrib", "org.nuxeo.ecm.platform.web.common.test.login.as", "org.nuxeo.elasticsearch.ElasticSearchComponent.contrib", "org.nuxeo.elasticsearch.core.bulk.contrib", "org.nuxeo.elasticsearch.core.listener", "org.nuxeo.elasticsearch.hint.contrib", "org.nuxeo.elasticsearch.managment.contrib", "org.nuxeo.elasticsearch.marshallers", "org.nuxeo.elasticsearch.scroll.contrib", "org.nuxeo.elasticsearch.test.contrib", "org.nuxeo.elasticsearch.work.config", "org.nuxeo.runtime.avro.contrib", "org.nuxeo.runtime.cluster.test.feature", "org.nuxeo.runtime.started", "org.nuxeo.runtime.stream.service.managment.contrib", "org.nuxeo.runtime.trackers.files.threadstracking.config" ], "contributions": [ { "@class": "org.nuxeo.apidoc.introspection.ExtensionInfoImpl", "id": "org.nuxeo.ecm.directory.marshallers--marshallers", "component": { "@class": "org.nuxeo.apidoc.introspection.ComponentInfoImpl", "@id": "05be5897-66b1-48a7-90ba-78737ac392e9", "bundle": { "@class": "org.nuxeo.apidoc.introspection.BundleInfoImpl", "bundleId": "org.nuxeo.ecm.directory", "fileName": "nuxeo-platform-directory-core-11.1-SNAPSHOT.jar", "manifest": "Manifest-Version: 1.0\r\nArchiver-Version: Plexus Archiver\r\nCreated-By: 1.6.0_20 (Sun Microsystems Inc.)\r\nBuilt-By: jenkins\r\nBuild-Jdk: 11.0.2\r\nBundle-ManifestVersion: 2\r\nBundle-Version: 0.0.0.SNAPSHOT\r\nExport-Package: org.nuxeo.ecm.directory;core=api,org.nuxeo.ecm.directo\r\n ry.memory,org.nuxeo.ecm.directory.constants\r\nBundle-ActivationPolicy: lazy\r\nBundle-ClassPath: .\r\nBundle-Category: web,stateful\r\nBundle-Name: Nuxeo Directory\r\nBundle-Localization: bundle\r\nBundle-RequiredExecutionEnvironment: JavaSE-1.6\r\nRequire-Bundle: org.nuxeo.ecm.directory.api;visibility:=reexport,org.n\r\n uxeo.ecm.core.schema\r\nBundle-Vendor: Nuxeo\r\nEclipse-LazyStart: true\r\nNuxeo-Component: OSGI-INF/DirectoryService.xml,OSGI-INF/GenericDirecto\r\n ry.xml,OSGI-INF/CoreDirectory.xml,OSGI-INF/directory-local-configurat\r\n ion.xml,OSGI-INF/directory-resolver-contrib.xml,OSGI-INF/marshallers-\r\n contrib.xml\r\nImport-Package: org.apache.commons.logging,org.nuxeo.common.xmap.annot\r\n ation,org.nuxeo.ecm.core;api=split,org.nuxeo.ecm.core.api;api=split,o\r\n rg.nuxeo.ecm.core.api.impl,org.nuxeo.ecm.core.api.model,org.nuxeo.ecm\r\n .core.schema,org.nuxeo.ecm.core.schema.types,org.nuxeo.ecm.directory.\r\n api,org.nuxeo.runtime,org.nuxeo.runtime.api,org.nuxeo.runtime.model\r\nBundle-SymbolicName: org.nuxeo.ecm.directory;singleton:=true\r\n\r\n", "requirements": null, "groupId": "org.nuxeo.ecm.platform", "artifactId": "nuxeo-platform-directory-core", "artifactVersion": "11.1-SNAPSHOT", "bundleGroup": { "@class": "org.nuxeo.apidoc.introspection.BundleGroupImpl", "id": "grp:org.nuxeo.ecm.directory", "name": "org.nuxeo.ecm.directory", "liveDoc": {}, "subGroups": [], "bundleIds": [ "org.nuxeo.ecm.directory", "org.nuxeo.ecm.directory.api", "org.nuxeo.ecm.directory.sql", "org.nuxeo.ecm.directory.types.contrib" ], "version": "unknown", "parentIds": [ "grp:org.nuxeo.ecm.platform" ] }, "liveDoc": {}, "parentLiveDoc": {}, "location": "/home/anahide/.m2/repository/org/nuxeo/ecm/platform/nuxeo-platform-directory-core/11.1-SNAPSHOT/nuxeo-platform-directory-core-11.1-SNAPSHOT.jar" }, "name": "org.nuxeo.ecm.directory.marshallers", "serviceNames": [], "services": [], "xmlFileUrl": "jar:file:/home/anahide/.m2/repository/org/nuxeo/ecm/platform/nuxeo-platform-directory-core/11.1-SNAPSHOT/nuxeo-platform-directory-core-11.1-SNAPSHOT.jar!/OSGI-INF/marshallers-contrib.xml", "componentClass": null, "documentation": "\n Core IO registered marshallers set.\n \n", "id": "org.nuxeo.ecm.directory.marshallers", "version": "11.1-SNAPSHOT", "artifactType": "NXComponent", "hierarchyPath": "/grp:org.nuxeo.ecm.platform/grp:org.nuxeo.ecm.directory/org.nuxeo.ecm.directory/org.nuxeo.ecm.directory.marshallers", "documentationHtml": "
\nCore IO registered marshallers set.\n", "xmlPureComponent": true, "xmlFileName": "/OSGI-INF/marshallers-contrib.xml", "xmlFileContent": "\n\n \n \n 0 \n 0 \n \n
\n\n The store tag supports 2 attributes:\n \n \n true \n \n
\n",
"id": "org.nuxeo.automation.scripting.internals.AutomationScriptingComponent",
"version": "11.1-SNAPSHOT",
"artifactType": "NXComponent",
"hierarchyPath": "/grp:org.nuxeo.ecm.automation/org.nuxeo.ecm.automation.scripting/org.nuxeo.automation.scripting.internals.AutomationScriptingComponent",
"documentationHtml": "\nAutomation Scripting is a Nuxeo module which provides ability to create and contribute Automation chain/operation in JavaScript.\n\nFor backward compatibility with version prior to 9.1, you may want to inline the context in the scripting parameters by contributing the\nextension\n <extension point=\"configuration\" target=\"org.nuxeo.runtime.ConfigurationService\">\n <property name=\"nuxeo.automation.scripting.inline-context-in-params\">true</property>\n </extension>\n
",
"xmlPureComponent": false,
"xmlFileName": "/OSGI-INF/automation-scripting-service.xml",
"xmlFileContent": "\n\n \n true \n \n
\n \n \n string \n string \n \n \n \n
\n \n \n java.util.ArrayList \n java.util.UUID \n java.io.File \n java.lang.Class \n \n
\n\n To deny everything from previous contributions and only allow specific classes, use:\n \n \n * \n java.util.ArrayList \n \n
\n\n Deals with mimetypes registration and mimetype detection (BETA).
\n\n\n @version 2.0\n @author Julien Anguenot\n\n @author Laurent Godard\n\n @author Olivier Grisel\n", "id": "org.nuxeo.ecm.platform.mimetype.service.MimetypeRegistryService", "version": "11.1-SNAPSHOT", "artifactType": "NXComponent", "hierarchyPath": "/grp:org.nuxeo.ecm.core/org.nuxeo.ecm.core.mimetype/org.nuxeo.ecm.platform.mimetype.service.MimetypeRegistryService", "documentationHtml": "\nCore mimetype registry service.\n\nDeals with mimetypes registration and mimetype detection (BETA).
\n\n@version 2.0\n", "xmlPureComponent": false, "xmlFileName": "/OSGI-INF/nxmimetype-service.xml", "xmlFileContent": "\n\nDeals with mimetypes registration and mimetype detection (BETA).
\n\n @version 2.0\n @author Julien Anguenot\n @author Laurent Godard\n @author Olivier Grisel\n\n\n \n \n application/pdf \n \n \n pdf \n \n \n\n
\n\n \n\n \n\n
\n\n \n \n jdbc:derby:/home/db;create=true\n \n nuxeo \n ******** \n \n
\n\n Or, for a XA datasource:\n\n \n \n /home/db \n create \n nuxeo \n ******** \n \n
\n\n The allowed attributes of a\n datasource\n element are:\n ConnectionException
\n RemoteDatabaseAccess
\n 08001
\n SQL Exceptions thrown are checked by the datasource for stating if the connnection should be\n evicted from the pool. The datasource exception sorter enable you to contribute fatal sqlcodes for\n a defined database. Each sorter contribution are identified uniquely by it's
The contributed SQL codes could be a classcode or a complete sqlcode. For easier configuration, you could use the enumeration labels defined\n for the standard SQL in
ConnectionException
\n RemoteDatabaseAccess
\n SystemError
\n ConnectionException
\n RemoteDatabaseAccess
\n SystemError
\n ConnectionException
\n RemoteDatabaseAccess
\n SystemError
\n