WorkflowDocumentRepository Data Type

Official Content
This documentation is valid for:

Description

This object represents the documents repository.

Properties

Property Type Access Description
EnableDocuments Boolean Read/Write Allows enabling/disabling the use of documents
Error WorkflowError Read Error

Methods

  • ListDocumentDefinitions

This method returns a collection with all the documents definitions matching the specified filters.

ListDocumentDefinitions (filter): Collection (WorkflowDocumentDefinition)

Name Type Movement Description
Filter WorkflowFilter Valid filters: Name Input Filter

 

  • ListDocumentDefinitionsOrderBy

This method returns a collection with all the document definitions matching the specified filters in the specified order.

ListDocumentDefinitionsOrderBy (filter, order): Collection (WorkflowDocumentDefinition)

Name Type Movement Description
filter WorkflowFilter Valid filters: Name Input Filter
order Numeric (WorkflowOrder.ID_ASC  WorkflowOrder.ID_DESC  WorkflowOrder.NAME_ASC  WorkflowOrder.NAME_DESC) Input Order

 

  • ListDocumentInstances

 This method returns a collection with all the document instances matching the specified filters.

 ListDocumentInstances (filter): Collection (WorkflowDocumentInstance)

Name Type Movement Description
filter WorkflowFilter Valid filters: From, To, Name, User, State, DocumentDefinition Input Filter

 

  • ListDocumentInstancesOrderBy

 This method returns a collection with all document instances matching the specified filters in the specified order.

 ListDocumentInstancesOrderBy (filter, order): Collection (WorkflowDocumentInstance)

Name Type Movement Description
filter WorkflowFilter Valid filters: From, To, Name, User, State, DocumentDefinition Input Filter
order Numeric (WorkflowOrder.ID_ASC,  WorkflowOrder.ID_DESC,  WorkflowOrder.NAME_ASC,  WorkflowOrder.NAME_DESC,  WorkflowOrder.STATE_ASC,  WorkflowOrder.STATE_DESC,  WorkflowOrder.VERSION_ASC,  WorkflowOrder.VERSION_DESC,  WorkflowOrder.AUTHOR_ASC,  WorkflowOrder.AUTHOR_DESC,  WorkflowOrder.CREATED_ASC,  WorkflowOrder.CREATED_DESC,  WorkflowOrder.UPDATED_ASC,  WorkflowOrder.UPDATED_DESC, WorkflowOrder.DOCUMENT_DEFINITION_ASC, WorkflowOrder.DOCUMENT_DEFINITION_ASC) Input Order

 

  • GetDocumentDefinitionById

 This methods return a document definition by its Id.

 GetDocumentDefinitionById (id): WorkflowDocumentDefinition

Name Type Movement Description
id Numeric Input Document Definition Identifier

 

  • GetDocumentDefinitionByName

 This method returns a document definition by its name.

 GetDocumentDefinitionByName (name): WorkflowDocumentDefinition

Name Type Movement Description
name Character Input Document Definition Name

 

  • GetDocumentInstanceById

 This method returns a document instance by its Identifier.

 GetDocumentInstanceById(id, version): WorkflowDocumentInstance

Name Type Movement Description
id Numeric Input Document Definition Identifier
Version Numeric Input Document version. Cero value allows to get the last version available.

See Also