Webservice: Tag

Tags management and search

Index Method Request(s) Response Description
1 setDocumentTags sid
docId
tag
 sets the tags of a document
2 addDocumentTags sid
docId
tag
 adds tags to a document
3 getDocumentTags sid
docId
 tag retrieves all the tags of a document
4 setFolderTags sid
folderId
tag
 sets the tags of a folder
5 addFolderTags sid
folderId
tag
 adds tags to a folder
6 findDocumentsByTag sid
tag
 document finds authorized documents for the current user having a specified tag
7 findFoldersByTag sid
tag
 folder finds authorized folders for the current user having a specified tag
8 getTags sid
 tag retrieves all the tags in the repository
9 getTagsPreset sid
 tag retrieves all the tags specified in the preset, empty if input mode is free
10 getFolderTags sid
folderId
 tag retrieves all the tags of a folder
11 getTagCloud sid
 tagCloud retrieves all tag clouds in the repository

Method #1: setDocumentTags

sets the tags of a document

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y identifier of the document
     tag
String Y Y

Method #2: addDocumentTags

adds tags to a document

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y identifier of the document
     tag
String Y Y

Method #3: getDocumentTags

retrieves all the tags of a document

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     docId
Long Y identifier of the document

Response

Name Type Required Multiple Description
     tag
String Y Y

Method #4: setFolderTags

sets the tags of a folder

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     folderId
Long Y
     tag
String Y Y

Method #5: addFolderTags

adds tags to a folder

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     folderId
Long Y
     tag
String Y Y

Method #6: findDocumentsByTag

finds authorized documents for the current user having a specified tag

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     tag
String Y

Response

Name Type Required Multiple Description
     document
WSDocument Y Y
          id
Long Y unique identifier
          fileSize
Long Y
          status
Int 0 = unlocked, 1 = checked out, 2 = locked
          exportStatus
Int
          version
String
          fileVersion
String
          date
String Y last publication date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          publisher
String
          publisherId
Long
          creator
String
          creatorId
Long
          type
String Y
          lockUserId
Long
          creation
String the date when the document was created; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          fileName
String Y
          indexed
Int 0 = to index, 1 = indexed, 2 = skip indexing
          signed
Int
          stamped
Int 1 if the document contains at least one stamp
          tags
String Y tags applied to the document
          folderId
Long Y parent folder
          templateId
Long id of the template assigned to the document
          customId
String unique custom identifier
          immutable
Int 0 = not immutable, 1 = immutable
          digest
String
          exportName
String
          exportId
Long
          docRef
Long used for aliases, refers to another document
          docRefType
String if used, defines the reference type (use pdf for the PDF Conversion)
          deleteUserId
Long user that has deleted the document
          attributes
WSAttribute Y array of attributes
               name
String Y name of the attribute
               stringValue
String
               intValue
Long
               doubleValue
Double
               dateValue
String the date value; format must be 'yyyy-MM-dd'
               type
Int Y 0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id, 7 = document (intValue represents the document's id), 8 = section
               mandatory
Int Y
               hidden
Int Y
               readonly
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set
               multiple
Int Y 0 = single value, 1 = one or more values
               parent
String The reference attribute name, used for multi value attributes
               dependsOn
String Name of another attribute on which the value of this attribute also depends, used for managing linked presets
               stringValues
String Read only. In case of multiple string values, contains the values separated by a comma
               validation
String Optional validation script
               initialization
String Optional initialization script
          language
String language of the document; See specification
          summary
String contains the snippet search text
          score
Integer full text search score
          icon
String
          comment
String
          lastModified
String
          rating
Integer
          workflowStatus
String current workflow's status where the document is in
          workflowStatusDisplay
String current workflow's status display informations
          color
String optional color assigned to the document
          published
Int if it is not set to 1, the document is marked as not published
          startPublishing
String
          stopPublishing
String
          pages
Int number of pages (default 1)
          nature
Int 0 = document, 1 = form
          formId
Long the last modified date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
          passwordProtected
Integer indicates whether the document is protected by a password
          ocrTemplateId
Long identifier of the Zonal OCR template to use to process this document
          ocrd
Int indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed
          barcodeTemplateId
Long identifier of the barcode template to use to process this document
          barcoded
Int indicates if the document has been processed by the barcode processor: 0 = to process, 1 = processed

Method #7: findFoldersByTag

finds authorized folders for the current user having a specified tag

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     tag
String Y

Response

Name Type Required Multiple Description
     folder
WSFolder Y Y
          id
Long Y unique identifier of the folder
          name
String Y
          parentId
Long Y identifier of the parent folder
          description
String Y
          lastModified
String the last modified date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
          type
Int Y 0 = Folder, 1 = Workspace
          templateId
Long template assigned to folder
          templateLocked
Int Y 0 = the template is unlocked, 1 = the template is locked
          creation
String the creation date (format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd')
          creator
String who created the folder
          position
Int Y
          hidden
Int Y 0 = visible, 1 = hidden
          foldRef
Long the referenced folder, used in case of folder alias
          securityRef
Long another folder to inherit the security from
          attributes
WSAttribute Y array of attributes
               name
String Y name of the attribute
               stringValue
String
               intValue
Long
               doubleValue
Double
               dateValue
String the date value; format must be 'yyyy-MM-dd'
               type
Int Y 0 = String, 1 = int, 2 = double, 3 = date, 4 = user (intValue represents the user's id), 5 = boolean (intValue must be 0 or 1), 6 = folder (intValue represents the folders's id, 7 = document (intValue represents the document's id), 8 = section
               mandatory
Int Y
               hidden
Int Y
               readonly
Int Y
               position
Int
               label
String
               editor
Int Y 0 = free, 1 = preset
               setId
Long Id of the attribute set
               multiple
Int Y 0 = single value, 1 = one or more values
               parent
String The reference attribute name, used for multi value attributes
               dependsOn
String Name of another attribute on which the value of this attribute also depends, used for managing linked presets
               stringValues
String Read only. In case of multiple string values, contains the values separated by a comma
               validation
String Optional validation script
               initialization
String Optional initialization script
          storage
Integer the storage to use for new files. Valid only in case of workspace.
          tags
String Y tags applied to the document
          ocrTemplateId
Long identifier of the Zonal OCR template to use to process the documents inside this folder
          barcodeTemplateId
Long identifier of the barcode template to use to process the documents inside this folder
          maxVersions
Integer maximum number of versions maintaned in the workspace
          color
String optional color assigned to the folder
          tile
String optional tile image(Base64 encoded) of the folder

Method #8: getTags

retrieves all the tags in the repository

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session

Response

Name Type Required Multiple Description
     tag
String Y Y

Method #9: getTagsPreset

retrieves all the tags specified in the preset, empty if input mode is free

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session

Response

Name Type Required Multiple Description
     tag
String Y Y

Method #10: getFolderTags

retrieves all the tags of a folder

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session
     folderId
Long Y

Response

Name Type Required Multiple Description
     tag
String Y Y

Method #11: getTagCloud

retrieves all tag clouds in the repository

Request

Name Type Required Multiple Description
     sid
String Y identifier of the session

Response

Name Type Required Multiple Description
     tagCloud
WSTagCloud Y Y
          tag
String Y
          count
Long Y
          scale
Int Y