Portfolio bearbeiten

Mit dem portfolio Operation-Element können Dokumente zu Portfolio-Dokumenten zusammengefasst, daraus entfernt oder extrahiert werden.

 

hint

Wird ein leeres Dokument oder ein Dokument mit einer inhaltslosen Seite als Ausgangsdokument übergeben, so wird automatisch ein Standard-Portfolio-Basisdokument erzeugt.

 

hint

Dieser Webservice gestattet die Verwendung eines Portfolio-Dokuments als Ausgangsdokument.

 

 

add-Operation

 

Fügt dem Portfolio ein Dokument hinzu.

 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<operation xmlns="http://schema.webpdf.de/1.0/operation">
<portfolio>
  <add>
    <file path="a/b" fileName="xyz.json">
    <data>ewogIC...0KCg==</data>
    </file>

    <folder path="a/b"/>
  </add>
</portfolio>
</operation>

{
"portfolio": {
  "add": {
    "file": [

       {

        "path": "a/b",
        "fileName": "xyz.json",
        "data": {
          "value": "ewogICJmb3Jtcy...9Cn0KCg=="
         }
       },

     "folder": [

       {

        "path": "a/b"

      }

     ]
   }
 }
}

 

 

file-Element

 

Definiert ein einzelnes Dokument, das dem Portfolio hinzugefügt werden soll. Das Element kann mehrfach vorkommen, wenn mehrere Dokumente hinzugefügt werden sollen.

 

<file path="a/b" fileName="xyz.json">
  <data>ewogIC...0KCg==</data>
</file>
 

"file": [

 {

  "path": "a/b",
  "fileName": "xyz.json",
  "data": {
      "value": "ewogICJmb3Jtcy...9Cn0KCg=="
   }
 }

]

 

path (Default: "")

Definiert den Pfad/Ordner, unter dem das Dokument im Portfolio abgelegt wird.

 

fileName (Default: "")

Definiert den Namen, unter dem das Dokument im Portfolio abgelegt wird.

 

 

folder-Element

 

Definiert einen einzelnen Ordner, der dem Portfolio hinzugefügt werden soll. Das Element kann mehrfach vorkommen, wenn mehrere Ordner hinzugefügt werden sollen.

 

<folder path="a/b"/>
 

"folder": [

 {

  "path": "a/b"
 }

]

 

path (Default: "")

Definiert den Pfad/Ordner, der im Portfolio abgelegt wird.

 

 

data-Element

 

Enthält die anzuhängende Datei als "Base64 encoded".

 

<data>ewogIC...0KCg==</data>

"data": {
 "value": "ewogICJmb3Jtcy...9Cn0KCg=="
}

 

 

remove-Operation

 

Entfernt ein oder mehrere Dokumente aus dem Portfolio.

 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<operation xmlns="http://schema.webpdf.de/1.0/operation">
<portfolio>
  <remove>
    <selection path="a/b/*" fileName="*.xls"/>
  </remove>
</portfolio>
</operation>

{
"portfolio": {
  "remove": {
    "selection": [

       {

        "path":"*a/b/*",
        "fileName":"*.xls"
       }

     ]
   }
 }
}

 

 

selection-Element

 

Selektiert Dokumente, die den Selektionsregeln entsprechen, und entsprechend verarbeitet (extrahiert/gelöscht) werden sollen. Es können mehrere selection-Elemente verwendet werden.

 

<selection path="a/b/*" fileName="*.xls"/>

"selection": [

 {
  "path":"*a/b/*",
  "fileName":"*.xls"
 }

]

 

path

Filtert für die Selektion nach Pfad. "a/b/*", würde dafür sorgen, dass alle Unterordner von a/b nach passenden Dokumenten durchsucht werden. Ob ein Dokument als passend erachtet wird, hängt auch vom Parameter "fileName" ab. Ist dieser nicht gesetzt, so wird stattdessen hiermit der Pfad selbst gewählt (für die Extraktion/Löschung).

 

fileName

Filtert für die Selektion nach Dateinamen. "*.xls" würde dafür sorgen, dass alle xls-Dokumente selektiert werden. "xyz.json" würde Anhänge mit dem Namen "xyz.json" selektieren (für die Extraktion/Löschung).

 

hint

Die Parameter "path" und "fileName" folgen dem und realisieren das "Glob"-Selektionsmuster für Dateien und Pfade.

 

 

extract-Operation

 

Extrahiert ein oder mehrere Dokumente aus dem Portfolio. Das Ergebnis wird als ZIP-Dokument geliefert. Das ZIP-Dokument enthält nicht nur die extrahierten Dateien, sondern bildet auch die Ordnerstruktur, in der die Dokumente gefunden wurden, ab.

 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<operation xmlns="http://schema.webpdf.de/1.0/operation">
<portfolio>
  <extract singleFileAsZip="true">
    <selection path="a/b/*" fileName="*.xls"/>
  </extract>
</portfolio>
</operation>

 

{
"portfolio": {
  "extract": {

   "singleFileAsZip": true,
    "selection": [

       {
        "path":"*a/b/*",
        "fileName":"*.xls"
       }

     ]
   }
 }
}

 

 

extract-Element

 

<extract singleFileAsZip="true">
  <selection path="a/b/*" fileName="*.xls"/>
</extract>

 

"extract": {

 "singleFileAsZip": true,
"selection": [

    {
      "path":"*a/b/*",
      "fileName":"*.xls"
    }

 ]
}

 

singleFileAsZip (Default: "true")

Die zurückgelieferten Anhänge werden als ZIP-File erstellt, auch wenn über selection nur eine einzelne Datei ausgewählt wird. Dies kann umgestellt werden, wenn die Option auf "false" gesetzt wird. In diesem Fall wird die Datei nicht in ein Zip gepackt, sondern direkt zurück geliefert. Dies funktioniert allerdings nur, wenn die selection exakt eine Datei liefert.

 

 

selection-Element

Ist identisch mit dem selection-Element der vorher beschriebenen remove-Operation.