unfileDocAttachmentFromCurrentCase operation

Draft comment:
This topic only applies to BAW, and is located in the BAW repository. Last updated on 2025-03-13 12:15
Draft comment:
This topic was viewed 2 times since its publication
Unfiles the specified document attachment from the folder or subfolder of the specified case. Upon successful completion of this method, the document is no longer filed in the folder.

If a case type is configured so that users can attach documents from repositories other than the case management target object store, you can use this operation to unfile attachments from an external repository. To unfile an attachment from an external repository, the attachment must be filed in the current case along with the information that is needed to reference the external document.

Tip: Multiple requests to unfile the document in the same folder are ignored, although the requests appear to be successful. If the request is ignored, the attachment that is returned is empty. Otherwise, the attachment that is returned is the folder or subfolder from which the document was unfiled.
Parameter Type Description
caseId String The identifier of the case.

You must set the expression for the caseID parameter to the F_CaseFolder business object field in the Expression Builder window.

subfolderPath String Path to the subfolder, relative to the Case folder. If the document to be unfiled is in the root of the case folder, this can be the empty string or "/".
sourceDocument Attachment An Attachment object for the document attachment to unfile.
return_value Attachment The folder or subfolder from which the attachment was unfiled, or an empty attachment if the attachment was not unfiled.