ApplicationXtender Web Services

The following operations are supported. For a formal definition, please review the Service Description.

• AddPageVersion
  Add a page version to a specified document page. Return AxPage object
• AddPageVersionFromStream
  Add a page version to a specified document page from bytes stream. Return AxPage object
• ApplyAutoIndex
  Apply a specified auto index item to a given document index. Return AxDocumentIndex object
• ApplyAutoIndexByAppId
  Apply a specified auto index item to a new document index. Return AxDocumentIndex object
• ApplyAutoIndexByRef
  Apply a specified auto index item to a given document index. Return AxDocumentIndex object
• AttachBatchPagesByRef
  Attach multiple batch page specified by reference string to a document
• BrowseApplicationIndexResultsByAppId
  Retrieve a range of document indexes from an application specified by application ID. Return AxDocumentIndexResults object
• BrowseApplicationIndexResultsByAppName
  Retrieve a range of document indexes from an application specified by application name. Return AxDocumentIndexResults object
• BrowseAutoIndexResultsByAppId
  Retrieve auto indexes from an application specified by application ID. Return AxDocumentIndexResults object
• BrowseAutoIndexResultsByAppName
  Retrieve auto indexes from an application specified by application name. Return AxDocumentIndexResults object
• BrowseCheckedOutDocumentResults
  Retrieve a range of checked out documents. Returns AxCheckoutDocumentResults object
• BrowseDocumentIndexResults
  Retrieve a range of document indexes resulted from the previous load operation. Return AxDocumentIndexResults object
• BrowseDocumentIndexResultsByRef
  Retrieve a range of document indexes resulted from the previous load operation. Return AxDocumentIndexResults object
• BrowseDocumentResults
  Retrieve query results. Return AxSearchResults object
• BrowseLockedDocumentResults
  Retrieve a range of locked documents. Returns AxLockDocumentResults object
• BrowseUserSessionResults
  Retrieve a portion of active user session list. Return AxUserSessionResults object
• CancelCheckOutDocument
  Cancel check out a specified document. Returns AxDocument object
• CancelCheckOutDocumentByRef
  Cancel check out a document specified by reference. Returns AxDocument object
• ChangeBatchMemoByRef
  Change the memo of a batch document specified by reference string
• ChangeBatchNameByRef
  Change the name of a batch document specified by reference string
• ChangePassword
  Change currently logged-in user's password to new one
• CheckInDocument
  Check In a specified document. Returns AxDocument object
• CheckInDocumentByRef
  Check In a document specified by reference. Returns AxDocument object
• CheckOutDocument
  Check out a specified document. Returns AxDocument object
• CheckOutDocumentByRef
  Check out a document specified by reference. Returns AxDocument object
• CloseBatchDocumentByRef
  Cloes a batch document specified by reference string
• CloseDocument
  Close document specified by pointer
• CloseDocumentByRef
  Close document specified by reference
• CreateBatchFromDocumentPages
  Create Batch from Document pages
• CreateBatchPage
  Append an uploaded image file as a new batch page to a batch document specified by batch name
• CreateBatchPageByRef
  Append an uploaded image file as a new batch page to a batch document specified by object reference string
• CreateDocumentFromBatchPageByRef
  Create a new document from a batch page specified by reference string
• CreateNewDocument
  Create a new document from a file and index field values. Returns AxDocumentCreationResult object
• DeleteAutoIndex
  Delete an auto index item from an application
• DeleteAutoIndexByAppName
  Delete an auto index item from an application identified by application name
• DeleteBatchDocumentByRef
  Delete a batch document specified by reference string
• DeleteBatchDocumentsByRef
  Delete multiple batch documents specified by reference string
• DeleteBatchPages
  Delete multiple batch pages specified by object reference strings
• DeleteDocument
  Delete a specified document. Returns message
• DeleteDocumentByRef
  Delete a specified document. Returns message
• DeleteDocumentIndex
  Delete a document index
• DeleteDocumentIndexByRef
  Delete a document index of a document identified by object reference string
• DeleteDocumentPage
  Delete a specified document page. Returns AxDocument object
• DeleteDocumentPageByRef
  Delete a document page specified by object reference reference. Returns AxDocument object
• DeleteDocumentRevision
  Delete a document revision. Returns AxRevisionHistory object
• DeleteDocumentRevisionByRef
  Delete a document revisions by object reference. Returns AxRevisionHistory object
• DeleteDocuments
  Delete multiple documents specified by query result set items. Return AxDocumentDeletionResult object
• DeleteDocumentsByRef
  Delete multiple documents specified by object references. Return AxDocumentDeletionResult object
• DeleteJobs
  Delete a specific job(s) in a processing queue
• DeletePageVersion
  Delete a specified page version. Return AxPage object
• DeleteQuery
  Delete a document query
• DownloadImageStream
  Stream a image from the source file. Returns AxStreamResult object
• ExportDocumentPages
  Export document pages in a one specified format (PDF or TIFF)
• ExportDocumentPagesByRef
  Export document pages in a one specified format (PDF or TIFF)
• GetAnnGroupSecurityMgr
  Return xml-encoded Annotation Group Security Manager
• GetApplicationBusinessProcessList
  Gets the list of available business processes for an application
• GetApplicationFields
  Returns fields for a specified application in data source (a of AxApplicationFieldArray object)
• GetApplicationList
  Returns a list of applications from a specified data source (a AxApplicationArray object)
• GetApplicationQueries
  Returns queries for a specified application in data source (a AxApplicationQueryArray object)
• GetApplicationsData
  Returns data for a specified list of applications in data source (AxApplicationDataCollection object)
• GetApplicationsHoldLabels
  Returns a list of all the hold labels documents are using for the application
• GetAxUsers
  Obtains a page of users records from AX data source
• GetAxViewerLicense
  Provides Ax Viewer license
• GetBatchDocumentListByAppId
  Return array of batch document objects in xml
• GetBatchDocumentListByAppName
  Return array of batch document objects in xml
• GetBatchMemoByRef
  Get the memo of the batch document specified by reference string
• GetBatchPageListByRef
  Return array of pages from a batch document specified by object reference string
• GetCAQConfiguration
  Returns Cross Application Query configuration information for a specified query in an application in data source (a AxCAQConfiguration object)
• GetCAQQueries
  Returns CAQ queries for data source (a AxApplicationQueryArray object)
• GetCertificates
  Returns certificates list available on the server
• GetDataSourceNameList
  Enumerate data sources configured in Ax Services
• GetDigitalSignatureHistory
  Retrieve digital signature history for a specified version
• GetDocIdsWithHoldLabel
  Get all document id's with the given hold label
• GetDocumentDisplayUrl
  Get relative URL for displaying or printing a document.
• GetDocumentDisplayUrlByRef
  Get a URL for displaying or printing a document.
• GetDocumentHoldLabel
  Gets the hold label for a document
• GetDocumentIndex
  Retrieves an document index object identified by document reference string and the row identifier in the index result set. This method is valid only after a call to the query document indexes.
• GetDocumentIndexForEdit
  Retrieves an document index object identified by document reference string and the row identifier in the index result set. The index values rae formatted forediting. This method is valid only after a call to the query document indexes.
• GetDocumentPageList
  Retrieve a range of pages under a specified document. Return array of AxPage object
• GetDocumentPageListByRef
  Retrieve a range of pages under a document specified by object reference reference. Return array of AxPage object
• GetDocumentProperty
  Get document property. Returns AxDocumentProperty object
• GetDocumentPropertyByRef
  Get document property by object reference. Returns AxDocumentProperty object
• GetDocumentRetentionEndDateAsFiletime
  Gets the date and time that a document was placed on retention, in Filetime
• GetDocumentRetentionStartDateAsFiletime
  Gets the date and time that a document was placed on retention, in Filetime
• GetDocumentRevisions
  Get document revisions. Returns array of AxRevisionHistory objects
• GetDocumentRevisionsByRef
  Get document revisions by object reference. Returns AxRevisionHistory object
• GetEncryptionKey
  Get key for credentials encryption
• GetExportDocumentPagesResult
  Retrieve the document pages as a result of a asynchronous export job. Return AxStringArray object
• GetFAMJobErrorMsg
  Returns the error message of a Centera job
• GetFAMJobStatus
  Returns the current staus of a job
• GetFileInfo
  Retrieve information about an image file
• GetFileInfoByDocRef
  Retrieve information about an image file
• GetFormOverlayById
  Retrieve form overlay information by form id. Return AxFormOverlayItem object
• GetFormOverlayByRef
  Retrieve form overlay information by form pointer(name and form type). Return AxFormOverlayItem object
• GetFormOverlayFileById
  Retrieve form overlay image file specified by form id. Return file path string
• GetFormOverlayFileByName
  Retrieve form overlay image file specified by form name and form type. Return file path string
• GetFormOverlaysByName
  Retrieve form overlay information by form name. Returns array of AxFormOverlayItem objects
• GetFullTextHitCount
  Return a full text hit count for a document
• GetFullTextHitCountByRef
  Return a full text hit count for a document
• GetFullTextHitInfo
  Return a full text hit object in xml
• GetFullTextHitInfoByRef
  Return a full text hit object in xml
• GetFullTextJobList
  Return array of full text job objects in xml
• GetFullTextJobQueueList
  Return array of full text job queue objects in xml
• GetHookMessage
  Get hook messge
• GetImageFile
  Retrieve an image file. Return XML encoded string of an AxmageFileResult object
• GetImageStream
  Retrieve an image stream or chunk of stream. Return XML encoded string of an AxImageStreamResult object
• GetIrmMembers
  Returns the IRM Server Member information (an AxIrmGroupCollection object)
• GetIrmPolicyTemplates
  Returns the IRM Policy Templates that can be used for protecting this document (an AxIrmPolicyInfoCollection object)
• GetJobElementList
  Return array of job element objects in xml
• GetJobList
  Return array of job objects in xml
• GetJobQueueList
  Return array of job queue objects in xml
• GetLicenseInfo
  info on license availability and usage
• GetLoggedOnDataSourceNameList
  Enumerate data sources configured in Ax Services
• GetODMAFields
  Returns ODMA fields for a specified application in data source (a AxApplicationFieldArray object)
• GetPermissionsDefinition
  Provides definition for AppXtender application permission flags (helper function)
• GetRenderImageStream
  Retrieve an image stream or chunk of stream for rendered page. Return XML encoded string of an AxImageRenderStreamResult object
• GetRenderingStatus
  Retrieve the status of a asynchronous rendering job. Return AxImageRenderResult object
• GetReportFields
  Returns AppXtender Reports Mgmt report fields for a specified application in data source (a AxApplicationFieldArray object)
• GetRetentionConfiguration
  Gets the manual retention configuration for an application
• GetRetentionProvider
  Returns who the retention provider is for the application, if there is one
• GetRubberStampFile
  Retrieve a rubber stamp image file. Return file path string
• GetRubberStampListByAppId
  Retrieve rubber stamps' information from an application specified by application ID. Returns array of AxRubberStamp objects
• GetRubberStampListByAppName
  Retrieve rubber stamps' information from an application specified by application name. Returns array of AxRubberStamp objects
• GetSessionFeatures
  Feature information for current session
• GetSessionTimeout
  Provides server timeout for abandoned sessions clean-up
• GetUserPermissions
  Returns User Permissions object
• GetWorkflowProvider
  Gets the vendor of the workflow provider for the data source
• KillUserSessions
  Terminate user sessions
• LockBatchDocumentByRef
  Lock a batch document specified by reference string
• LockDocument
  Aquire write lock on a specified document. Returns AxDocument object
• LockDocumentByRef
  Aquire write lock on a document specified by reference. Returns AxDocument object
• LogAuditEvent
  Return xml-encoded Annotation Group Security Manager
• Login
  Performs user login to data source with clear text credentials
• LoginSet
  Performs user login with Windows Integrated security
• Logout
  User Logout
• LookupKeyReference
  Perform key reference data lookup, given a key. Return AxDocumentIndex object
• LookupKeyReferenceByAppId
  Perform key reference data lookup for a new index that contains a key field. Return AxDocumentIndex object
• LookupKeyReferenceByRef
  Perform key reference data lookup, given a key. Returns AxDocumentIndex object
• MergePDFPages
  Merge all PDF pages from a document. Returns AxPDFMergeResult object
• MergePDFPagesByRef
  Merge all PDF pages from a document specified by object reference. Returns AxPDFMergeResult object
• ModifyDocumentIndex
  Modify existing document index values
• ModifyDocumentIndexByRef
  Modify existing document index values of a document identified by document reference string
• MoveDocumentPage
  Move document page from (pageNum) to (newPageNum)
• OpenBatchDocumentByRef
  Open a batch document specified by reference string
• OpenDocument
  Open document specified by pointer. Returns AxDocument object
• OpenDocumentByRef
  Open document specified by reference. Returns AxDocument object
• QueryApplicationIndexesByAppId
  Query document indexes from an application specified by application ID. Return AxDocumentIndexResults object
• QueryApplicationIndexesByAppName
  Query document indexes from an application specified by application name. Return AxQueryResults object
• QueryAutoIndexesByAppId
  Query auto indexes from an application specified by application ID. Return AxDocumentIndexResults object
• QueryAutoIndexesByAppName
  Query auto indexes from an application specified by application name. Return AxDocumentIndexResults object
• QueryCheckedOutDocuments
  Query checked out documents. Returns AxCheckoutDocumentResults object
• QueryDocumentIndexes
  Get all indexes from a specified document until the number of indexes reaches the specified number. Return AxDocumentIndexResults object
• QueryDocumentIndexesByRef
  Get all indexes from a document specified by object reference until the number of indexes reaches the specified number. Return AxDocumentIndexResults object
• QueryDocuments
  Query various documents with the option of saving the query. Return AxSearchResults object
• QueryLockedDocuments
  Query locked documents. Returns AxLockDocumentResults object
• QueryUserSessions
  Query for active user sessions. Return AxUserSessionResults object
• ReleaseDocumentsLock
  Release (delete) documents locks specified by AxLockResultItems inside AxLockDocumentResults object
• RemoveDocumentRetentionHold
  Removes a retention hold on a document, returns the job ID
• RenderPageVersion
  Render a page version image for thin client display and printing. Return AxImageRenderResult object
• RenderPageVersionAsync
  Render a page version image for thin client display and printing asynchronously. Return AxImageRenderResult object
• RequeryApplicationIndexesByAppId
  Query document indexes from an application specified by application id by a given document index. Return AxDocumentIndexResults object
• RequeryApplicationIndexesByAppName
  Query document indexes from an application specified by application name by a given document index. Return AxDocumentIndexResults object
• ResubmitJobs
  Resubmit a specific job(s) in a processing queue
• SaveAndReturnDocumentIndex
  Creates, saves and return new index for a specified document. This method only applies to multi-index application
• SaveAndReturnDocumentIndexByRef
  Creates, saves and return new index for a specified document. This method only applies to multi-index application
• SaveCAQConfiguration
  Saves a cross application query configuration
• SaveDocumentIndex
  Creates and saves new index for a specified document. This method only applies to multi-index application
• SaveDocumentIndexByRef
  Creates and saves new index for document identified by document reference string. This method only applies to multi-index application
• SaveQuery
  Save a document query
• SecuredChangePassword
  Change currently logged-in user's password to new one
• SecuredLogin
  Performs user login to data source with encrypted credentials
• SetDocumentProperty
  Set document property
• SetDocumentPropertyByRef
  Set document property by object reference
• SetDocumentRetention
  Places a document on retention, returns the job ID
• SetDocumentRetentionHold
  Places a retention hold on a document, returns the job ID
• SignPageVersion
  Digital sign a specified page version
• StartBusinessProcessOnDocument
  Starts up a business process in the context of the supplied document.
• SubmitFullTextJob
  Submit a document for full text indexing
• SubmitFullTextJobByRef
  Submit a document for full text indexing
• UnlockBatchDocument
  Unlock a batch document specified by reference string
• UnlockBatchDocuments
  Unlock multiple batch documents specified by reference strings
• UnlockDocument
  Release the write lock on a specified document. Returns AxDocument object
• UnlockDocumentByRef
  Release the write lock on a document specified by object reference reference. Returns AxDocument object
• UnlockDocumentsByRef
  Release the write lock on multiple documents specified by object reference strings.
• UpdateAnnotationFile
  Update annotation image for a specified version. Return AxFileInfo object
• UpdateAnnotationFromStream
  Update annotation image for a specified version from stream. Return AxFileInfo object
• UploadDocumentPage
  Insert an image after a specified document page. Returns AxDocument object
• UploadDocumentPageByRef
  Insert an image after a specified page in a document specified by object reference. Returns AxDocument object
• UploadDocumentPageStreamByRef
  Insert an image delievered as a stream after a specified page in a document specified by object reference. Returns AxDocument object
• UploadImageStream
  Upload an object image stream or stream chunk to server. Returns key for upload continue
• WindowsLogin
  Performs user login with Windows Integrated security