Platform Explorer / Nuxeo Platform 11.3

371 Operations

Start workflow

Workflow Context Context.StartWorkflow Require Workflow

Run a bulk command

Services Bulk.RunAction


Chain SeamActions.GET

Watermarks a Video with a Picture

Files Video.AddWatermark

Removes an Entry From a Multivalued Property

Document Document.RemoveItemFromListProperty

Adds an Entry Into a Multivalued Complex Property

Document Document.AddItemToListProperty
Alias Document.AddItemToListProperty


javascript javascript.RenderPdf


Chain simpleChooseNextOption1AndDone

PDF: Watermark with Text

Conversion PDF.WatermarkWithText


Chain nextAssignee

Update comments number on the document

Routing Document.Routing.UpdateCommentsInfoOnDocument

Resume Step

Routing Document.Routing.Resume.Step


Chain NRD-AC-PR-ChooseParticipants-Output

Get Versions

Document Document.GetVersions

Nuxeo Drive: Set versioning options

Services NuxeoDrive.SetVersioningOptions

Get Quota info

Quotas Quotas.GetInfo

Set Context Variable From a Simple Configuration Parameter

Local Configuration LocalConfiguration.SetSimpleConfigurationParameterAsVar

Login As

Users & Groups Auth.LoginAs

Block Permission Inheritance

Document Document.BlockPermissionInheritance

Get a Directory Projection

Services Directory.Projection Since 5.7.2


Document CSV.ImportLog


Chain simpleTask

Resize a picture

Conversion Picture.Resize
Alias Picture.resize

Nuxeo Drive: Update file

Services NuxeoDrive.UpdateFile

Resume workflow

Workflow Context Workflow.ResumeNode
Alias Workflow.ResumeNodeOperation
Require Workflow


Business Business.BusinessUpdateOperation

Nuxeo Drive: Get the top level folder

Services NuxeoDrive.GetTopLevelFolder


Chain setTaskDone

Create or Update Group

Users & Groups Group.CreateOrUpdate


Chain NRD-AC-PR-ValidateNode-Output


Chain reinitAssigneeComment


Document Document.Reload


Document Document.Delete


Document Document.PublishToSections
Alias Document.MultiPublish

Query Audit Service

Services Audit.Query

Set Task Done

Routing Document.Routing.EvaluateCondition


Chain zipTreeExportRendition

Recompute Thumbnails

Services RecomputeThumbnails Since 10.10

Create Document in UI

User Interface Seam.CreateDocumentInUI Require Seam

PDF: Extract Info

Document PDF.ExtractInfo


Chain voidChain

Set Node Variable

Workflow Context Workflow.SetNodeVariable
Alias Context.SetWorkflowNodeVar
Require Workflow

PDF: Encrypt

Conversion PDF.Encrypt


Chain cancelWorkflow

Apply mapping on input task doc

Workflow Context Task.ApplyDocumentMapping
Alias Context.ApplyMappingOnTask
Require Workflow

Context Document(s)

Fetch Context.FetchDocument

Unblock Permission Inheritance

Document Document.UnblockPermissionInheritance

Invite a user

Users & Groups User.Invite

Copy Schema

Document Document.CopySchema

Sign PDF

Services Services.SignPDF

Imports document

Services StreamImporter.runDocumentConsumers Since 9.1


Users & Groups Auth.Logout

Choose branch

Routing Update.NextStep.ConditionalFolder

Pop Document

Push & Pop Context.PopDocument
Alias Document.Pop


Chain Image.Blob.Resize


javascript javascript.FilterTemplatesByType


Chain VersionAndAttachFiles

Check Out

Document Document.CheckOut

Raise Seam events

User Interface Seam.RaiseEvents
Alias WebUI.RaiseSeamEvents
Require Seam

Suggesters launcher

User Interface Search.SuggestersLauncher


Document CSV.Import

Change Current Tab

User Interface Navigation.ChangeCurrentTab
Alias Seam.ChangeTab
Require Seam


Chain downloadFilesZip

Gets a document rendition

Files Document.GetRendition

Get directory entries

Services Directory.Entries

Complete task

Workflow Context WorkflowTask.Complete
Alias Workflow.CompleteTaskOperation
Require Workflow


Document CSV.ImportResult

Query users

Users & Groups User.Query
Alias Services.QueryUsers


Chain NRD-AC-PR-storeTaskInfo

Add document to collection

Document Document.AddToCollection
Alias Collection.AddToCollection

Elasticsearch Indexing

Services Elasticsearch.BulkIndex Since 10.3


Chain setNextStep


Chain logInAudit

Create Document from file

Services FileManager.ImportWithProperties

Get documents from favorites

Document Favorite.GetDocuments
Alias Collection.GetElementsInFavorite

Create Document from file in User's workspace

Services UserWorkspace.CreateDocumentFromBlob

UI Worklist

Fetch Seam.FetchFromWorklist Require Seam

Restore input blobs from a script

Execution Context Context.RestoreBlobsInputFromScript

List repository names on the server

Fetch GetRepositories

Context File(s)

Fetch Context.FetchFile

Remove from collection

Document Collection.RemoveFromCollection

PDF: Encrypt Read Only

Conversion PDF.EncryptReadOnly

Restore File Input

Execution Context Context.RestoreBlobInput


Chain Blob.ImportWorklist
Alias ImportWorklist

Run File Chain

Execution Flow RunFileOperation
Alias Context.RunFileOperation

Push File List

Push & Pop Context.PushBlobList
Alias Blob.PushList

Clear Worklist

User Interface Seam.ClearWorklist
Alias WebUI.ClearWorklist
Require Seam

Remove All Document Tags

Services Services.RemoveDocumentTags Since 7.1

Get Principal Emails

Users & Groups Context.GetEmailsWithPermissionOnDoc
Alias Document.GetPrincipalEmails

Get Document File

Files Document.GetBlob
Alias Blob.Get

Restore input document from a script

Execution Context Context.RestoreDocumentInputFromScript

Nuxeo Drive: Move

Services NuxeoDrive.Move

Nuxeo Drive: Get change summary

Services NuxeoDrive.GetChangeSummary

Remove Facet

Document Document.RemoveFacet
Alias Document.RemoveFacet


Chain setDone

Nuxeo Drive: Delete

Services NuxeoDrive.Delete


Chain decideNextStepAndSimpleValidate

Unsubscribe document

Document Document.Unsubscribe


User Interface Seam.Refresh Require Seam

Remove Permission

Document Document.RemovePermission

Get rendition definition suggestion

Services RenditionDefinition.Suggestion


Chain updateCommentsOnDoc


Chain followLifeCycleTransitionTask

Executes Works stored in the dead letter queue

Services WorkManager.RunWorkInFailure

Pull File List

Push & Pop Context.PullBlobList
Alias Blob.PullList

Filter List

Document Document.Filter


Document Document.Lock


Chain NRD-AC-PR-LockDocument

Nuxeo Drive: Create test documents

Services NuxeoDrive.CreateTestDocuments

PDF: Convert to Pictures

Conversion PDF.ConvertToPictures

Bulk Restart Workflow

Workflow Context WorkflowModel.BulkRestartInstances
Alias BulkRestartWorkflow


Chain notifyInitiatorEndOfWorkflow

UI Selected documents from list

Fetch Seam.GetDocumentsFromSelectionList Require Seam

Json Error Stack Display

Execution Context JsonStack.ToggleDisplay Since 6.0


Files Blob.CreateZip

Create a collection

Document Collection.Create
Alias Collection.CreateCollection


Document Document.Create

Render with template

Conversion TemplateProcessor.Render


Chain FileManager.ImportWithMetaData

Run operation in Seam Context

User Interface Seam.RunOperation
Alias WebUI.RunOperationInSeam

Produces random blobs

Services StreamImporter.runRandomDocumentProducers Since 9.1

Get collection suggestion

Services Collection.Suggestion

Pop File List

Push & Pop Context.PopBlobList
Alias Blob.PopList

PDF: Merge with Blob(s)

Conversion PDF.MergeWithBlobs

Update Property

Document Document.SetProperty

Attach File or files to the currentDocument.

Files BlobHolder.AttachOnCurrentDocument
Alias BlobHolder.Attach

Nuxeo Drive: Get file system item

Services NuxeoDrive.GetFileSystemItem

Order Document

Document Document.Order Since 10.1

File From URL

Fetch Blob.CreateFromURL
Alias Blob.Create


Services Metrics.Start


Chain simpleUndo

Read Metadata From Binary

Files Blob.ReadMetadata
Alias Binary.ReadMetadata
Since 7.1

Push to Seam Context

User Interface Seam.PushDocument
Alias WebUI.PushDocumentToSeamContext
Require Seam

Pull Document List

Push & Pop Context.PullDocumentList
Alias Document.PullList

PDF: Extract Pages

Conversion PDF.ExtractPages

Read Metadata From Binary to Context

Execution Context Context.SetMetadataFromBlob
Alias Context.ReadMetadataFromBinary
Since 7.1

Add Message

User Interface Seam.AddMessage
Alias WebUI.AddMessage
Require Seam

Get image view

Conversion Picture.GetView
Alias Picture.getView

Pop File

Push & Pop Context.PopBlob
Alias Blob.Pop


Document Document.Save

Publish Document's Rendition

Document Document.PublishToSection
Alias Document.PublishRendition

Get documents from collection

Document Collection.GetDocumentsFromCollection

Elasticsearch Indexing

Services Elasticsearch.Index Since 8.1

Export to File

Files Blob.ExportToFS
Alias Blob.ToFile

Updates directory entries

Services Directory.UpdateEntries

Add Info Message

User Interface Seam.AddInfoMessage
Alias WebUI.AddInfoMessage
Require Seam

Create Picture

Services Picture.Create

Get collections

Document User.GetCollections
Alias Collection.GetCollections

Get graph

Routing Document.Routing.GetGraph


Chain sendTaskCreatedNotificationMail

Nuxeo Drive: Setup integration tests

Services NuxeoDrive.SetupIntegrationTests


Fetch Repository.ResultSetPageProvider
Alias Resultset.PageProvider

Convert To PDF

Conversion Blob.ToPDF

Restore Documents Input

Execution Context Context.RestoreDocumentsInput

Reset Schema

Document Document.ResetSchema

Delete Relation

Services Document.DeleteRelation
Alias Relations.DeleteRelation


Chain acceptComment

Push Document

Push & Pop Context.PushDocument
Alias Document.Push


Chain simpleValidate


Document Document.Unlock

PDF: Watermark with PDF

Conversion PDF.WatermarkWithPDF

Nuxeo Drive: Get children

Services NuxeoDrive.GetChildren

UI Current Workspace

Fetch Seam.GetCurrentWorkspace Require Seam

Run Document Chain

Execution Flow RunDocumentOperation
Alias Context.RunDocumentOperation

Check In

Document Document.CheckIn


Chain validateDocument

Extracts closed captions from the video.

Conversion Video.ExtractClosedCaptions

Bulk Download

Files Blob.BulkDownload

Set Context Variable

Execution Context Context.SetVar

Get Users and Groups

Users & Groups Context.GetUsersGroupIdsWithPermissionOnDoc
Alias Document.GetUsersAndGroups

Restore Files Input

Execution Context Context.RestoreBlobsInput

Pop Document List

Push & Pop Context.PopDocumentList
Alias Document.PopList


Execution Context Traces.ToggleRecording


Chain simpleChooseNextOption2AndDone

Nuxeo Drive: Tear down integration tests

Services NuxeoDrive.TearDownIntegrationTests

Get suggested directory entries

Services Directory.SuggestEntries

Get tag suggestion

Services Tag.Suggestion

Nuxeo Drive: Create folder

Services NuxeoDrive.CreateFolder

Restore input documents from a script

Execution Context Context.RestoreDocumentsInputFromScript

UI Clipboard

Fetch Seam.FetchFromClipboard Require Seam

Sign PDF

Services Services.SignPDFDocument

Nuxeo Drive: File system item exists

Services NuxeoDrive.FileSystemItemExists

Nuxeo Drive: Get Roots

Services NuxeoDrive.GetRoots


Document Document.Trash

Deletes directory entries

Services Directory.DeleteEntries


Files Blob.PostToURL
Alias Blob.Post


Chain followLifeCycleTransition

Set Current Step from Task

Routing Document.Routing.SetRunningStepFromTask

Attach File

Files Blob.AttachOnDocument
Alias Blob.Attach

PDF: Add Page Numbers

Conversion PDF.AddPageNumbers


Chain AttachFiles


Fetch Repository.PageProvider
Alias Document.PageProvider


Chain terminateWorkflow

Get user tasks

Services Task.GetAssigned
Alias Workflow.GetTask
Since 5.4

remove task

Services Workflow.RemoveRoutingTask Since 5.6

Run For Each

Execution Flow RunOperationOnList
Alias Context.RunOperationOnList

Add entry into multi-valued metadata

Document Document.AddEntryToMultivaluedProperty
Alias AddEntryToMultivaluedProperty DocumentMultivaluedProperty.addItem

Remove Entry Of Multivalued Property

Document Document.RemoveEntryOfMultivaluedProperty
Alias RemoveEntryOfMultivaluedProperty

Replace Permission

Document Document.ReplacePermission

UI Changeable Document

Fetch Seam.GetChangeableDocument Require Seam

Nuxeo Drive: Scroll descendants

Services NuxeoDrive.ScrollDescendants

Remove from favorites

Document Document.RemoveFromFavorites
Alias Collection.RemoveFromFavorites

Imports document into Redis

Services StreamImporter.runRedisDocumentConsumers Since 10.1


Document Document.Copy

Push Document List

Push & Pop Context.PushDocumentList
Alias Document.PushList

Trigger Metadata Mapping

Files Document.SetMetadataFromBlob
Alias Document.TriggerMetadataMapping
Since 7.1

Nuxeo Drive: Rename

Services NuxeoDrive.Rename


Services Metrics.Stop

Send Event

Notification Event.Fire
Alias Notification.SendEvent

Set Context Variable From Input

Execution Context Context.SetInputAsVar


Chain VersionAndAttachFile

Update Properties

Document Document.Update

Push File

Push & Pop Context.PushBlob
Alias Blob.Push

Add Permission

Document Document.AddPermission
Alias Document.AddACL

Send the notification email for a permission

Document Document.SendNotificationEmailForPermission


Chain Image.Blob.ConvertToPDF

Cancel Document Creation in UI

User Interface Navigation.GoBack
Alias Seam.CancelCreateDocumentInUI
Require Seam

Remove File

Files Blob.RemoveFromDocument
Alias Blob.Remove

Tag Document

Services Services.TagDocument Since 7.1


Chain NRD-AC-PR-UnlockDocument


Document Document.AddACE
Alias Document.SetACE

Get Document Files

Files Document.GetBlobsByProperty
Alias Blob.GetList

Init Seam Context

User Interface Seam.InitContext
Alias WebUI.InitSeamContext


Chain FileManager.ImportWithMetaDataInSeam

Add document to favorites

Document Document.AddToFavorites
Alias Collection.AddToFavorites

Import blobs

Services StreamImporter.runBlobConsumers Since 9.1

Destroy Seam Context

User Interface Seam.DestroyContext
Alias WebUI.DestroySeamContext

Wait for Elasticsearch Indexing

Services Elasticsearch.WaitForIndexing Since 8.1

Remove Property

Document Document.RemoveProperty

Create or Update User

Users & Groups User.CreateOrUpdate
Alias Services.CreateUser

PDF: Remove Encryption

Conversion PDF.RemoveEncryption

Subscribe document

Document Document.Subscribe

Get Home

Users & Groups User.GetUserWorkspace
Alias UserWorkspace.Get

Set File

Document Document.SetBlob
Alias Blob.Set

Put Simple Configuration parameters

Local Configuration LocalConfiguration.PutSimpleConfigurationParameters

ResultSet Query

Fetch Repository.ResultSetQuery
Alias ResultSet.PaginatedQuery
Since 6.0

Restore Version

Document Document.RestoreVersion

Get Last version

Document Document.GetLastVersion
Alias Document.GetLastVersion


Execution Context Traces.Get

UI Current Domain

Fetch Seam.GetCurrentDomain Require Seam

Document Export

Services Document.Export

Get Quota statistics

Quotas Quotas.GetStatistics

Create Relation

Services Document.AddRelation
Alias Relations.CreateRelation

Clear Clipboard

User Interface Seam.ClearClipboard
Alias WebUI.ClearClipboard
Require Seam


Chain NRD-AC-PR-force-validate

Create Proxy Live

Document Document.CreateLiveProxy
Alias CreateProxyLive

Remove Document Proxies

Document Document.RemoveProxies
Alias Document.RemoveProxies

Fetch By Property

Fetch Document.FetchByProperty

Push to Worklist

User Interface Seam.AddToWorklist
Alias WebUI.AddToWorklist
Require Seam

Get Parent

Document Document.GetParent

UI Document From Seam

Fetch Seam.FetchDocument Require Seam

Restore Document Input

Execution Context Context.RestoreDocumentInput

Snapshot Version

Document Document.CreateVersion

Add Error Message

User Interface Seam.AddErrorMessage
Alias WebUI.AddErrorMessage
Require Seam


Chain xmlExportRendition

Remove ACL

Document Document.RemoveACL

Hot Reload Studio Snapshot Package

Services Service.HotReloadStudioSnapshot

Save Session

Execution Flow Repository.SaveSession
Alias Document.SaveSession

UI Selected documents

Fetch Seam.GetSelectedDocuments Require Seam


Business Business.BusinessFetchOperation


Chain undoRunningTask

Run Script

Scripting RunScript
Alias Context.RunScript

Pull Document

Push & Pop Context.PullDocument
Alias Document.Pull

PDF: Extract Text

Document PDF.ExtractText

Detach a template

Conversion TemplateProcessor.Detach

Get Nuxeo Principal

Users & Groups User.Get
Alias NuxeoPrincipal.Get

Nuxeo Drive: Can move

Services NuxeoDrive.CanMove

Produces blobs from a list of files

Services StreamImporter.runFileBlobProducers Since 10.2

Get Children

Document Document.GetChildren


Document Document.Untrash


Chain mainBlob

Get All Document Files

Files Document.GetBlobs
Alias Blob.GetAll

Concatenate PDFs

Conversion Blob.ConcatenatePDFs

Nuxeo Drive: Get client update information

Services NuxeoDrive.GetClientUpdateInfo

Load directory entries from CSV file

Services Directory.LoadFromCSV

Wait for Bulk computation

Services Bulk.WaitForAction Since 10.2

Write Metadata To Blob From Context

Files Blob.SetMetadataFromContext
Alias Binary.WriteMetadataFromContext
Since 7.1

Unpublish Document's Publications

Document Document.UnpublishAll

Send E-Mail

Notification Document.Mail
Alias Notification.SendMail

Get Linked Documents

Services Document.GetLinkedDocuments
Alias Relations.GetRelations

Produces random blobs

Services StreamImporter.runRandomBlobProducers Since 9.1

Render Document Feed

Conversion Render.DocumentFeed

Get Child

Document Document.GetChild


Chain publishTask


Chain FileManager.ImportInSeam

Untag Document

Services Services.UntagDocument Since 7.1


Fetch Repository.GetDocument
Alias Document.Fetch

Nuxeo Drive: Wait for async completion

Services NuxeoDrive.WaitForAsyncCompletion

Get Live Document

Document Proxy.GetSourceDocument
Alias GetLiveDocument


Document CSV.ImportStatus


Chain simpleRefuse

Convert to given mime-type

Conversion Blob.Convert Since 5.7

Set JSF Outcome

User Interface Seam.SetOutcome
Alias WebUI.SetJSFOutcome
Require Seam

Pull File

Push & Pop Context.PullBlob
Alias Blob.Pull

Run For Each Page

Execution Flow RunOperationOnProvider
Alias Context.RunOperationOnProvider


Chain CreateMailDocumentFromAutomation

Show Create Document Page

User Interface Seam.CreateDocumentForm
Alias WebUI.ShowCreateForm
Require Seam


Services Workflow.UserTaskPageProvider


Chain rejectComment


Document Document.Move

Run Input Script

Scripting RunInputScript
Alias Context.RunInputScript


Fetch Repository.Query
Alias Document.Query
Since 6.0

PDF: Merge with Document(s)

Conversion PDF.MergeWithDocs

Set Workflow Variable

Workflow Context Context.SetWorkflowVar Require Workflow

Set Step Done

Routing Document.Routing.Step.Done

Reorder members of a collection

Document Document.MoveCollectionMember

Nuxeo Drive: Attach blob

Services NuxeoDrive.AttachBlob

Audit Query With Page Provider

Fetch Audit.QueryWithPageProvider
Alias Audit.PageProvider


Chain publishDocument

Retrieve counters values

Services Counters.GET

List available actions

Services Actions.GET

Save Document in UI

User Interface Seam.SaveDocumentInUI Require Seam

Fetch favorites root collection

Document Favorite.Fetch


Chain evaluateCondition


Chain containerContentBlob


Chain conditionalTask

Restore log entries

Services Audit.Restore

Push to Clipboard

User Interface Seam.AddToClipboard
Alias WebUI.AddToClipboard
Require Seam


Business Business.BusinessCreateOperation


Conversion Blob.RunConverter Since 7.1


Notification Log
Alias LogOperation


Chain ProcessAttachment


Chain addCurrentDocumentToWorklist

Get open tasks

Workflow Context Workflow.GetOpenTasks
Alias Context.GetOpenTasks
Require Workflow

Cancel workflow

Workflow Context WorkflowInstance.Cancel
Alias Context.CancelWorkflow
Require Workflow

Navigate to Document

User Interface Seam.NavigateTo
Alias WebUI.NavigateTo
Require Seam

Nuxeo Drive: Register / Unregister Synchronization Root

Services NuxeoDrive.SetSynchronization

Write Metadata To Binary From Document

Files Blob.SetMetadataFromDocument
Alias Binary.WriteMetadataFromDocument
Since 7.1

Creates directory entries

Services Directory.CreateEntries

Clear Selected Documents

User Interface Seam.ClearSelectedDocuments
Alias WebUI.ClearSelectedDocuments
Require Seam Since 5.6


Chain initInitiatorComment

Run Chain

Execution Flow RunOperation
Alias Context.RunOperation


Chain blobToPDF

Archiving ACEs

Services PermissionsPurge

Follow Life Cycle Transition

Document Document.FollowLifecycleTransition
Alias Document.SetLifeCycle

Run For Each in new TX

Execution Flow RunOperationOnListInNewTx
Alias Context.RunOperationOnListInNewTx

Nuxeo Drive: Create file

Services NuxeoDrive.CreateFile

Follow publish or reject transition

Document Comment.Moderate

Create task

Services Workflow.CreateRoutingTask Since 5.6

Set File Name

Files Document.SetBlobName
Alias Blob.SetFilename

Render Document

Conversion Render.Document

Empty Trash

Document Document.EmptyTrash

Restore input blob from a script

Execution Context Context.RestoreBlobInputFromScript

PDF: Extract Links

Conversion PDF.ExtractLinks

Create Document from file

Services FileManager.Import

Add Facet

Document Document.AddFacet
Alias Document.AddFacet

Vocabulary: Add Entry

Services Directory.CreateVocabularyEntry

Get Task Translated Names

Workflow Context Context.GetTaskNames

Log Event In Audit

Services Audit.LogEvent
Alias Audit.Log

Get user/group suggestion

Services UserGroup.Suggestion

Nuxeo Drive: Add document to the 'Locally Edited' collection

Services NuxeoDrive.AddToLocallyEditedCollection


Chain Blob.ImportClipboard
Alias ImportClipboard

Create Folder

Services FileManager.CreateFolder

Reads directory entries

Services Directory.ReadEntries

Download file

User Interface Seam.DownloadFile
Alias WebUI.DownloadFile
Require Seam

Set Step back to a ready state

Routing Document.Routing.BackToReady

PDF: Watermark with Image

Conversion PDF.WatermarkWithImage

UI Current Document

Fetch Seam.GetCurrentDocument Require Seam

Recompute Picture Views

Services Picture.RecomputeViews Since 10.3

Put a Simple Configuration Parameter

Local Configuration LocalConfiguration.PutSimpleConfigurationParameter

Run Document Chain in new Tx

Execution Flow Context.RunDocumentOperationInNewTx

SliceVideo a Video in Parts with equal duration.

Conversion Video.SliceInParts
Alias Video.SliceInParts

Nuxeo Drive: Generate Conflicted Item Name

Services NuxeoDrive.GenerateConflictedItemName

Check Mail Inbox

Services Mail.CheckInbox

Create task

Services Task.Create
Alias Workflow.CreateTask
Since 5.3.2