The content of this page has changed - you will be redirected to the updated content at our infoXpert web site shortly.

The link to the new content is http://www.infoxpert.com.au/features/modules/web-services-api-command-list/

Web Services API Command List

infoXpert includes a complete Web Services API which allows programmers to develop custom solutions based on the infoXpert Document Management Software.

The list of available Web Services API commands for infoXpert Version 8 include:

AddDocumentComment
Adds a comment to the specified document

AddManagerToDomain
Adds a domain/library manager to the specified domain/library. User must already be a domain/library member. Only system administrator can perform this action.

AddPropertySetField
Adds a field to the specified custom propertset definition.

AddPropertySetFieldOption
Adds a option value to the specified custom propertset field.

AddPropertySetRow
Adds a property set row to a document or a folder in the specified path.

AddUserAsDomainMember
Adds a user to the specified domain/library

AddUserGroupAsDomainMember
Adds a global user group to the specified domain/library.

AddUserToDocumentSubscribers
Adds the specifed user to the document subscription list

AddUserToFolderSubscribers
Adds the specified user to the folder subscription list

AddUsergroupMember
Adds a user to the specified user group.

ApplyInheritedAccessList
Applies inherited access list to a document or a folder in the specified path.

ArchiveDomain
Archives specified domain/library.

AssociateDocument
Creates an association between the specified document and the specified item.

AssociateFolder
Creates an association between the specified folder and the specified item.

AssociatedDocuments
Gets the list of associated documents of the specified document or folder.

AssociatedFolders
Gets the list of associated folders of the specified document or folder.

AssociatedFoldersAndDocuments
Gets the list of associated items of the specified document or folder.

AssociationTypes
Returns the association types.

AuthenticateUser
Authenticates the specified user against infoXpert.

ChangeUserPassword
Changes the password of the specified user.

ChangeUserStatus
Changes the status of the specified user account.

Copy
Copies an existing document and or folder to the specified destination path.

CreateDocumentUsingTemplate
Creates a document or a new version of a document on the specified path using specified template and given xml data.

CreateDomain
Creates an infoXpert domain/library.

CreateFolder
Creates the specified path. Multiple sub-folders can be created. Top level folder (domain/library) must exist.

CreatePropertySetDefinition
Creates a property set.

CreateTicketforUser
Creates a ticket using trusted user password. The Trusted user account password is defined in the web.config

CreateURL
Creates and Updates URL file in the specified path.

CreateUploadHandler
Creates new upload handler to allow large file uploads in chunks.

CreateUser
Creates an infoXpert user. To create a global user set Domain Name/Library Name to empty string. Do not specify a password parameter authenticated by external users.

CreateUserGroup
Creates a user group. To create a local user group, specify an existing domain/library name.

DeleteDocument
Deletes a document in the specified path.

DeleteDocumentComment
Deletes the specified comment from a document

DeleteDocumentVersion
Deletes the given version of the document in the specified path.

DeleteDomain
Deletes an infoXpert domain/library.

DeleteDownloadHandler
Delete existing download handler.

DeleteFolder
Deletes a folder in the specified path. The top-level folders (domains/libraries) cannot be deleted using this method. To delete top-level folders, use DeleteDomain instead.

DeletePropertySetDefinition
Deletes specified property set definition. WARNING: This function also deletes all applied data associated with this property set.

DeletePropertySetField
Deletes specified field from the specified custom propertset definition. WARNING: This operation also deletes all applied values to this field.

DeletePropertySetFieldOption
Deletes specified option value from the specified custom property set field.

DeletePropertySetRow
Deletes a property set row on a document or a folder in the specified path.

DeleteUploadHandler
Delete existing upload handler.

DeleteUser
Deletes an infoXpert user.

DeleteUsergroup
Deletes the specified user group.

DocumentExists
Determines whether the given path refers to an existing document.

DomainExists
Determines whether the given domain/library name refers to an existing domain/library.

DownloadDocument
Downloads a document in byte array format.

DownloadDocumentVersion
Downloads a specific version of a document in byte array format.

DownloadFileChunk
Download a partial chunk of the file.

DownloadZip
Zips and downloads the specified folders and documents in byte array format.

EmptyRecycleBin
Empties the Recycle Bin contents of the current user.

FolderExists
Determines whether the given path refers to an existing folder.

GetAccessList
Returns the access list for a document or a folder in the specified path.

GetAccessListHistory
Returns the historical records of the access list for a document or a folder in the specified path.

GetAddInInfo
Returns information about specified Add-ins.

GetAddInPart
Returns specified add-in part in byte array

GetAllUsers
Returns a list of all infoXpert users.

getApplicationParameters
Gets an infoXpert application parameter.

GetCheckedoutDocuments
Returns list of checked out documents by the current user.

GetCoWorkers
Returns a list of co-workers of the current user.

GetDeleteLog
Returns the delete log for the specified criteria.

GetDocument
Returns the properties of the document in the specified path.

GetDocumentAbstract
Returns the abstract of the document in the specified path.

GetDocumentComments
Returns the comments of the document in the specified path.

GetDocumentKeywords
Returns the user defined keywords of the document in the specified path.

GetDocumentReadLogHistory
Returns the Read log history for one person of the document in the specified path.

GetDocumentTextOnlyContent
Returns the text only content of the latest version of the specified document, if applied.

GetDocumentTypes
Returns defined document types.

GetDocumentVersions
Return the versions of the document in the specified path.

GetDocumentViewLog
Returns the view log of the document in the specified path.

GetDocuments
Returns a list of documents and properties of the documents in the specified path.

GetDocuments1
Returns the list of documents in the specified path in short form.

GetDocumentsByPage
Returns the page of documents in the specified path in short form.

GetDomain
Returns the properties of the specified domain/library.

GetDomainFlows
Returns Worflow definitions of the specified domain/library.

GetDomainGroups
Returns a list of all user groups (defined localy or globaly) in the specified domain/library .

GetDomainMembers
Returns a list of users and user groups who are members of the specified domain/library.

GetDomainUsers
Returns a list of all users who are members (directly or indirectly, localy or globaly) of the specified domain/library.

GetDomains
Returns a list of infoXpert domains/libraries

GetDownloadHandler
Returns a document download handler and information.

GetDownloadHandlerByVersion
Returns a document download handler for a specific version of a document.

GetDownloadInfo
Returns download information of a document.

GetDownloadInfoByVersion
Returns the download information for a specific version of a document

GetDownloadQue
Returns list of documents and folders in the download queue of the current user.

GetFavorites
Returns list of favorite documents and folders of the current user.

GetFolder
Returns the properties of the folder in the specified path.

GetFolderCatalog
Returns the catalog information for the specified folder.

GetFolderFlows
Returns Workflow definitions of the specified folder.

GetFolderRules
Returns the rules of the specified folder.

GetFolders
Returns the list of sub folders and properties in the specified path.

GetFolders1
Returns the list of sub folders in the specified path in short form.

GetFoldersAndDocuments
Returns a list of documents and folders in the specified path.

GetFoldersAndDocuments1
Returns a list of documents and folders in the specified path in short form.

GetFoldersAndDocumentsByPage
Returns the first page (1 to 20) of documents and folders in the specified path

GetFoldersByPage
Returns the first page (1 to 20) of folders in the specified path

GetGlobalGroups
Returns a list of the infoXpert global user groups

GetLocalGroups
Returns a list of local user groups in the specified domain/library.

GetLocalUsers
Returns a list of local users of the specified domain/library.

GetManagers
Returns a list of the managers of the specified domain/library.

GetMyDocumentsAndFolders
Returns list of documents and folders owned by the current user.

GetNextSearchPage
Gets next search page of the prepared search results.

GetOwner
Returns the owner of a document or a folder in the specified path.

GetParentFolderIDs
Returns the parent ids of the specified folder id.

GetPreviousSearchPage
Gets previous search page of the prepared search results.

GetPropertySetDefinition
Returns the information of the specified propertset with field definitions.

GetPropertySetDefinitions
Returns the list of property sets defined in the system.

GetPropertySetDefinitions1
Returns the list of property sets defined in the system.

GetPropertySetFieldOptions
Returns the static or dynamic options of the specified property set field.

GetPropertySets
Returns the property sets that have been applied to documents and folders in the specified path.

GetRecentDocuments
Returns list of recent documents of the current user.

GetRecycleBinContent
Gets the recycle bin content of the current user.

GetSubFoldersCount
Returns the count of the subfolders

GetSubscribers
Returns the subscriber list of the document or folder in the specified path.

GetSubscriptions
Returns list of subscribed documents and folders of the current user.

GetUser
Returns the properties of the specified user.

GetUserGroup
Returns information on the specified user group.

GetUserGroupMembers
Returns a list of members of the specified user group.

GetVersionTextOnlyContent
Returns the text only content of the specified version of the specified document, if applied.

isValidTicket
Determines whether the given ticket is still valid or not.

Lock
Locks a document or documents in the specified path.

LogOut
Logs out a user and clears user?s session variables.

MaintenanceBeat
Forces the server do perform self-maintenance (System use only)

Move
Moves a document or folder to the specified destination path.

PurgeRecycleBinItem
Purge Recycle Bin item.

RegisterEmail
Registers emails to the specified path.

RemoveAssociation
Removes the association between specified document or folder.

RemoveManagerFromDomain
Removes a domain/library manager from the specified domain/library.

RemoveUserFromDocumentSubscribers
Removes the specified user from the document subscription list

RemoveUserFromDomainMembership
Removes the specified user from the domain/library.

RemoveUserFromFolderSubscribers
Removes the specified user from the folder subscription list

RemoveUserGroupFromDomainMembership
Removes the specified user group from the specified domain/library.

RemoveUsergroupMember
Removes a member from the specified user group.

RestoreRecycleBinItem
Restore Recycle Bin item.

Search
Prepares a search results using given criteria in xml format.

ServerInfo
Returns information about the infoXpert Server instance.

ServerSideImport
Imports specified folders and documents located on the server to an infoXpert path.

SetAccessList
Sets the access list of a document or folder in the specified path.

SetDocumentCompletionStatus
Sets the completion status of the specified document. Completion Date must be 1900-1-1 for the incomplete documents

SetDocumentImportance
Sets the importance (0=Low;1=Normal;2=High;3=Vital) of the specified document.

SetDocumentRetention
Sets the Retention Period (0=No Retension;1=Forever;2=Until Specified Date) of the specified document.

SetDocumentTextOnlyContent
Updates the text only content of the latest version of the specified document.

SetFolderRules
Sets the rules of the specified folder.

SetOwner
Sets the owner of a document or a folder in the specified path.

SetPropertySetLookupFieldParametersForMYSQL
Sets the parameters of the specified property set's lookup field.

SetPropertySetLookupFieldParametersForORACLE
Sets the parameters of the specified property set's lookup field.

SetPropertySetLookupFieldParametersForSQLServer
Sets the parameters of the specified property set's lookup field.

SetVersionTextOnlyContent
Updates the text only content of the specified version of the specified document.

SubmitDocumentToFlow
Submits specified document to the specified workflow.

SubmitDocumentToFlow1
Submits specified document to the specified workflow. The call allows you to specify the task assignees at the time of the submission.

UnLock
Unlocks a document or documents in the specified path.

UnarchiveDomain
Un-archives the specified domain/library.

UpdateDocumentKeywords
Updates the keywords of the specified document.

UpdateDocumentProperties
Updates the properties of the specified document.

UpdateDocumentProperties1
Updates the properties of the specified document.

UpdateDocumentType
Updates the type of the document.

UpdateDomain
Updates the properties of the specified domain/library.

UpdateFolderProperties
Updates the properties of the specified folder.

UpdatePropertySetDefinition
Updates the information of the specified property set definition.

UpdatePropertySetRow
Updates a property set row on a document or a folder in the specified path.

UpdateUserEmail
Updates the email address of the specified user.

UpdateUserGroupName
Updates the specified user group name.

UpdateUserPreferences
Updates the preferences of the specified user.

UpdateUserProfile
Updates the user profile of the specified user.

UploadDocument
Uploads a new document or creates a new version of an existing document in byte array format to the specified path.

UploadDocument1
Uploads a new document or creates a new version of an existing document in byte array format to the specified path.

UploadDocument2
Uploads a new document or creates a new version of an existing document in byte array format to the specified path.

UploadDocument3
Uploads a new document or creates a new version of an existing document in byte array format to the specified path.

UploadDocumentWithHandler
Uploads a new document or creates a new version of an existing document in byte array format to the specified path.

UploadDocumentWithHandler1
Uploads a new document or creates a new version of an existing document in to the specified path.

UploadDocumentWithHandler2
Uploads a new document or creates a new version of an existing document in to the specified path.

UploadFileChunk
Uploads a partial chunk of the file.

UploadTiffAsPDF
Uploads a new Tiff Image. Tiff image will be converted to PDF.

UploadTiffAsPDFWithHandler
Uploads a new Tiff Image. Tiff image will be converted to PDF. uses upload handler

UserExists
Determines whether the given user name refers to an existing user.

For VB.NET or C#.NET code examples, contact infoXpert Support via our Contact page.

For a summary of the Web Services API, visit the Web Services API page. 

For a comprehensive list of features, visit our Features page.

To view a product demonstration, visit our Video Tours and Screen Examples pages.