Class: DocumentService

tibco.objectapi.service.DocumentService

new DocumentService()

Methods

createDocument(request, callback)

Creates a document in a case folder.
Parameters:
Name Type Description
request tibco.objectapi.service.request.CreateDocumentRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type CreateDocumentResponseType.

deleteDocument(request, callback)

Deletes the specified document from the CMS.
Parameters:
Name Type Description
request tibco.objectapi.service.request.DeleteDocumentRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type DeleteDocumentResponseType.

deleteOrphanedFolders(request, callback)

Deletes orphaned case folders, that is, case folders whose case objects have been deleted.
Parameters:
Name Type Description
request tibco.objectapi.service.request.DeleteOrphanedFoldersRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type DeleteOrphanedFoldersResponseType.

documentHelp(request, callback)

Returns help information about options available in bpm/rest/document/...
Parameters:
Name Type Description
request tibco.objectapi.service.request.DocumentHelpRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type StringResponse.

findDocuments(request, callback)

Returns references to documents that are linked to a specified case.
Parameters:
Name Type Description
request tibco.objectapi.service.request.FindDocumentsRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type FindDocumentsResponseType.

getDocumentContent(request, callback)

Returns the content of the specified document.
Parameters:
Name Type Description
request tibco.objectapi.service.request.GetDocumentContentRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type GetDocumentContentResponseType.

getDocumentMetadata(request, callback)

Returns the metadata for the specified document.
Parameters:
Name Type Description
request tibco.objectapi.service.request.GetDocumentMetadataRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type GetDocumentMetadataResponseType.

getFolderContent(request, callback)

Returns the content of the specified case folder, and optionally, sub-folders.
Parameters:
Name Type Description
request tibco.objectapi.service.request.GetFolderContentRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type GetFolderContentResponseType.

getRepositoryInfo(request, callback)

Obtains information about the repository and its capabilities.
Parameters:
Name Type Description
request tibco.objectapi.service.request.GetRepositoryInfoRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type GetRepositoryInfoResponseType.

linkDocument(request, callback)

Links a document to a specified case.
Parameters:
Name Type Description
request tibco.objectapi.service.request.LinkDocumentRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type LinkDocumentResponseType.

moveDocument(request, callback)

Moves the specified document from one case folder to another case folder.
Parameters:
Name Type Description
request tibco.objectapi.service.request.MoveDocumentRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type MoveDocumentResponseType.

unlinkDocument(request, callback)

Unlinks a document from a case, which removes the document from the case folder.
Parameters:
Name Type Description
request tibco.objectapi.service.request.UnlinkDocumentRequest A request set with data for this service call.
callback tibco.objectapi.service.Callback A callback to handle the service response of type UnlinkDocumentResponseType.