Skip to end of metadata
Go to start of metadata
Operation documentation

Remove File

Remove the file attached to the input document as specified by the 'xpath' parameter. If the 'xpath' point to a blob list then the list will be cleared. If the file to remove is part of a list it will be removed from the list otherwise the 'xpath' should point to a blob property that will be removed. If the save parameter is set the document modification will be automatically saved. Return the document.
General Information

Category: Files
Operation Id: Blob.Remove

Parameters

Name

Type

Required

Default Value

save

boolean

false

true

xpath

string

false

[file:content]

Signature

Inputs: document, documents
Outputs: document, documents

Links to sample use cases

There is currently no link.

See also

There is currently no link.

Something is not clear in the documentation ? We forgot to document a parameter ? Please use the "comment" feature on the wiki page to talk about your problem, we will be pleased to answer and share the information in the complementary information section, at the bottom of this page.
Complementary information

There is currently no complementary information. You can let a comment on this page to ask for more a specific information, we will be pleased to add it to this page.

Labels
  • None
  1. Nov 10, 2010

    Anonymous

    How can I remove a single file from the list? I succeeded removing the entire list, but I don't know how to remove only one file.

    1. Nov 10, 2010

      You need to specify the full xpath to the item you want to remove. This means you need to know the index in the list of the blob you want to remove.
      For example if you are using the files schema here is the xpath you need to use to remove the first blob in the list:

      To remove the second blob use:

      and so on...

      You will get an exception if the index is out of range.