Arbeitsblätter extrahieren aus Excel

PDF4me Arbeitsblätter extrahieren ist ein REST Endpunkt, der ausgewählte Blätter aus einem Excel Arbeitsmappe und gibt sie als neuen Arbeitsmappeninhalt zurück. POST die Datei als Base64 Zu office/ApiV2Excel/ExcelExtractWorksheetBenennen Sie die Tabellenblätter oder listen Sie deren nullbasierte Indizes auf und speichern Sie das dekodierte Ergebnis. Wenn Sie keinen Selektor senden, werden alle Tabellenblätter extrahiert.

Was dieser Endpunkt bewirkt

Teilt eine Arbeitsmappe in einzelne Tabellenblätter auf. Sie senden die gesamte Datei einmal und beschreiben, welche Tabellenblätter Sie darin haben möchten. Aktion extrahierenArbeitsblattInExcelDie Verteilung kann anhand des exakten Tabellennamens (Groß-/Kleinschreibung beachten), des nullbasierten Index oder beider gleichzeitig erfolgen (die Vereinigung wird berücksichtigt). Diese Funktion ersetzt das manuelle Rechtsklicken und die Auswahl von „Verschieben“ oder „Kopieren“ für die Berichtsverteilung, die Aufteilung nach Teams und alle Workflows, in denen Empfänger nur ihr eigenes Tabellenblatt sehen sollen.

Verwandte Blog-Beiträge

Zu dieser Funktion gibt es noch keinen Blogbeitrag – folgt in Kürze.

Schauen Sie sich in der Zwischenzeit im PDF4me-Blog Tutorials und Arbeitsabläufe für alle Plattformen an.

Besuchen Sie den Blog →

Authentifizierung Ihres API Anfrage

Jeder PDF4me REST Der Anruf muss Ihre API Schlüssel im Authorization Header als Basic Auth. Ihren Schlüssel erhalten oder ändern Sie ihn im Entwickler-Dashboard.

Get your API Key

Endpunkt

POSToffice/ApiV2Excel/ExcelExtractWorksheet

Postbote URLhttps://api.pdf4me.com/office/ApiV2Excel/ExcelExtractWorksheet

Wichtige Fakten, die Sie nicht verpassen sollten

Namen + Indizes = Vereinigung, keines von beiden = alles

Bieten Arbeitsblattnamen, ArbeitsblattindizesOder beides; jedes Tabellenblatt, das einer der beiden Listen entspricht, wird extrahiert. Lässt man beides weg, werden ALLE Tabellenblätter extrahiert, was bei einer gezielten Aufteilung selten gewünscht ist.

Indizes beginnen bei 0, Namen unterscheiden Groß- und Kleinschreibung.

Index 0 ist das erste Tabellenblatt. Ein Name, der sich in der Groß-/Kleinschreibung vom tatsächlichen Tabellenblattnamen unterscheidet, führt zu keiner Übereinstimmung. Daher bedeutet ein unerwartet fehlendes Tabellenblatt in der Ausgabe in der Regel einen Fehler in der Groß-/Kleinschreibung und nicht einen Fehler in der Schreibweise. API Fehler.

Büro API Familie, unterschiedliche Wegform

Excel Der Betrieb läuft unter office/ApiV2Excel/ auf demselben Host, nicht unter /api/v2/Der Body ist ebenfalls verschachtelt: ein Aktionsobjekt (Aktion extrahierenArbeitsblattInExcel) anstelle von flachen Wurzelkörpern.

HTTP aufstellen

Verfahren: POST
URL: https://api.pdf4me.com/office/ApiV2Excel/ExcelExtractWorksheet
Inhaltstyp: application/json
Authorization: Basic <Ihre PDF4me API Schlüssel>

Die Antwort lautet: JSON: Überprüfen Sie die success Flagge, dann Base64-Dekodieren Sie den zurückgegebenen Arbeitsmappeninhalt und speichern Sie ihn mit einem .xlsx Verlängerung.

Welche Tabellenblätter werden extrahiert: Namen oder Indizes?

Die Auswahl erfolgt deklarativ. Sie müssen die Reihenfolge nie ändern oder Schleifen verwenden; Sie beschreiben die Zielblätter einmalig, und die Engine gleicht sie mit der Arbeitsmappe ab.

Namen vs. Indizes	Sie senden	Was wird extrahiert?
Nur Namen	`"worksheetNames": ["Sheet1", "Summary"]`	Tabellenblätter, deren Tab-Name exakt übereinstimmt (Groß-/Kleinschreibung beachten)
Nur Indizes	`"worksheetIndexes": [0, 2]`	Tabellenblätter an diesen 0-basierten Positionen
Beide	Namen + Indizes	Die Vereinigung: alles, was einer der beiden Listen entspricht
Weder	`{}` Aktionsobjekt	Jedes Arbeitsblatt im Arbeitsheft

API Körperfelder

Parameter	Erforderlich	Typ	Was es tut	Beispiel
`document`	Required	object	Document reference carrying Name, the source Excel filename with its extension.	`{ "Name": "data.xlsx" }`
`docContent`	Required	string	Base64-encoded bytes of the source workbook.	`UEsDBBQABgAIAAAA...`
`extractWorksheetToExcelAction`	Required	object	Action configuration object. Holds the worksheet selectors below; send it even when empty to extract all sheets.	`{ "worksheetNames": [...] }`
`worksheetNames`	Conditional	string[]	Inside the action object. Exact, case-sensitive sheet tab names to extract. Combine with indexes for a union.	`["Sheet1", "Summary"]`
`worksheetIndexes`	Conditional	int[]	Inside the action object. 0-based sheet positions to extract. Combine with names for a union.	`[0, 2]`
`cultureName`	Optional	string	Inside the action object. Culture code applied during processing.	`en-US`

Beispielnutzlasten

Zwei Blätter nach Namen extrahieren

{
 "document": { "Name": "data.xlsx" },
 "docContent": "UEsDBBQABgAIAAAA...",
 "extractWorksheetToExcelAction": {
 "worksheetNames": ["Sheet1", "Summary"]
 }
}

Extraktion mittels 0-basiertem Index

{
 "document": { "Name": "data.xlsx" },
 "docContent": "UEsDBBQABgAIAAAA...",
 "extractWorksheetToExcelAction": {
 "worksheetIndexes": [0, 2]
 }
}

Tipps zur Postboten-Abholung

Headers

Content-Type: application/json + Authorization: Basic <apiKey>.

Body

raw JSON. Note the nesting: selectors go INSIDE extractWorksheetToExcelAction, not at the root.

Response

JSON with a success flag and Base64 workbook content. Decode the content before saving as .xlsx.

Sheet names

Copy tab names from Excel exactly. Case matters, and a non-matching name is skipped silently rather than raising an error.

curl-Beispiel

curl -X POST https://api.pdf4me.com/office/ApiV2Excel/ExcelExtractWorksheet \
 -H "Content-Type: application/json" \
 -H "Authorization: Basic YOUR_API_KEY" \
 -d '{
 "document": { "Name": "data.xlsx" },
 "docContent": "'"$(base64 -w 0 data.xlsx)"'",
 "extractWorksheetToExcelAction": {
 "worksheetNames": ["Summary"]
 }
 }' \
 --output response.json

Was bedeutet das? API zurückkehren?

A JSON Ergebnis, das die Extraktion beschreibt und den neuen Arbeitsmappeninhalt enthält als Base64Die

Feld	Typ	Was es enthält
`document / documents`	String (Base64) / Array	The extracted workbook content. A single extraction returns one document; multi-sheet extraction can return an array, so handle both shapes.
`fileName`	String	Output filename for the extracted workbook.
`success`	Boolean	true when extraction succeeded. Check this before decoding content.
`errorMessage`	String	Populated when success is false; explains what went wrong.

Codebeispiele

Excel Büroendpunkte sind noch nicht durch die pro-language Beispielordner; das Beispiel-Repository enthält das Anfragemuster, das von jedem verwendet wird PDF4me Endpunktfamilie:

View API Samples Repository

Häufig gestellte Fragen

How do I extract a single sheet from an Excel workbook?+

Send the workbook as Base64 in docContent and put the sheet name in extractWorksheetToExcelAction.worksheetNames, for example ["Summary"]. The API returns a new workbook containing only that sheet.

What happens if I provide both worksheetNames and worksheetIndexes?+

The selections combine as a union: any sheet matching either a listed name or a listed index is extracted. If you provide neither field, every worksheet in the workbook is extracted.

Are worksheet indexes 0-based or 1-based?+

0-based. Index 0 is the first worksheet, index 1 the second, and so on. This matches the PDF4me Extract Worksheets documentation across platforms.

Are worksheet names case-sensitive?+

Yes. The name must match the sheet tab exactly, including case. A name that does not match any sheet is simply not extracted, so an unexpectedly missing sheet usually means a case mismatch rather than an API error.

Why is this endpoint not under /api/v2/?+

Excel operations belong to the PDF4me office API family, addressed as office/ApiV2Excel/ plus the action name on the same api.pdf4me.com host, with the same Basic Authorization header.

Does extraction change the source workbook?+

No. The source file you send is only read. The extracted sheets are returned as new workbook content in the response; nothing is written back to your original.

Can I extract every sheet into its own file?+

Sending an empty action object extracts all worksheets. For strict one-file-per-sheet splits, iterate your sheet list and call the endpoint once per name; each call returns a workbook containing just that sheet.

Warum Arbeitsblätter extrahieren über API statt manuell?

Der manuelle Weg ist Arbeitsblätter verschieben oder kopieren in ExcelKlicken Sie mit der rechten Maustaste auf die Registerkarte, wählen Sie „Verschieben oder Kopieren“, aktivieren Sie „Kopie erstellen“, speichern Sie die Datei als neue Datei und wiederholen Sie dies pro Tabellenblatt, pro Arbeitsmappe und pro Berichtszyklus. API Diese Schleife wird durch eine deterministische Anfrage pro Aufteilung ersetzt. Dies ist erwünscht, wenn die Arbeitsmappe planmäßig eintrifft und die Aufteilung andere Systeme speist. Die Ausgabe bleibt standardkonform. Büro geöffnet XML Arbeitsbuch ExcelLibreOffice und Google Sheets sind alle geöffnet.