Document Exports
7 Endpunkte. Basis-URL: https://xapi.ambertech.cloud/api/v1
List export history for the organization#
GET
/document-exportsTokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
template_id | Query | string | – |
status | Query | string | Werte: |
source | Query | string | Werte: |
page | Query | number | – |
pageSize | Query | number | – |
Antworten
- 200Export rows ({ data, count }).
Beispiel (cURL)
curl -X GET "https://xapi.ambertech.cloud/api/v1/document-exports" \
-H "Authorization: Bearer $XISUITE_TOKEN"Get one export history row#
GET
/document-exports/{id}TokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
idPflicht | Pfad | string | – |
Antworten
- 200Export row.
- 404Export not found.
Beispiel (cURL)
curl -X GET "https://xapi.ambertech.cloud/api/v1/document-exports/{id}" \
-H "Authorization: Bearer $XISUITE_TOKEN"Get a short-lived signed download URL#
GET
/document-exports/{id}/downloadTokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
idPflicht | Pfad | string | – |
Antworten
- 200Signed URL info ({ signedUrl, fileName, mimeType }).
- 404Export or file not found.
Beispiel (cURL)
curl -X GET "https://xapi.ambertech.cloud/api/v1/document-exports/{id}/download" \
-H "Authorization: Bearer $XISUITE_TOKEN"Export a document template (pdf / docx / html)#
POST
/document-templates/{id}/exportTokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
idPflicht | Pfad | string | – |
Request-Body
| Name | Typ | Beschreibung |
|---|---|---|
formatPflicht | string | Werte: |
scopePflicht | object | Item scope — exactly one of { savedFilterId } | { ids } | { query, source_space_ids } (validated in the service). |
delivery | string | Werte: |
fileName | string | File name without extension (sanitized server-side). |
Antworten
- 200delivery 'download' (default): the file as an attachment; delivery 'store': { record, download } JSON.
- 400Invalid scope or template.
- 404Template not found.
- 413Scope exceeds the item cap.
- 429Too many exports in flight.
- 501PDF rendering unavailable.
Beispiel (cURL)
curl -X POST "https://xapi.ambertech.cloud/api/v1/document-templates/{id}/export" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"format":"pdf","scope":{}}'Push a document template into a new wiki page#
POST
/document-templates/{templateId}/export-to-wikiTokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
templateIdPflicht | Pfad | string | – |
Request-Body
| Name | Typ | Beschreibung |
|---|---|---|
space_idPflicht | string | Target wiki space |
scopePflicht | object | Item scope — same shape as ExportDocumentDto.scope. |
parent_id | string | Optional parent wiki page UUID |
title | string | Defaults to the template name |
Antworten
- 200OK
Beispiel (cURL)
curl -X POST "https://xapi.ambertech.cloud/api/v1/document-templates/{templateId}/export-to-wiki" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"space_id":"…","scope":{}}'Re-push a document template onto an existing wiki page#
PUT
/document-templates/{templateId}/export-to-wiki/{pageId}TokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
templateIdPflicht | Pfad | string | – |
pageIdPflicht | Pfad | string | – |
Request-Body
| Name | Typ | Beschreibung |
|---|---|---|
space_idPflicht | string | Space the target page belongs to |
scopePflicht | object | – |
confirmed | boolean | Confirms overwriting a page that was hand-edited since the last push, or that has open comments. |
Antworten
- 200OK
Beispiel (cURL)
curl -X PUT "https://xapi.ambertech.cloud/api/v1/document-templates/{templateId}/export-to-wiki/{pageId}" \
-H "Authorization: Bearer $XISUITE_TOKEN" \
-H "Content-Type: application/json" \
-d '{"space_id":"…","scope":{}}'List prior wiki pushes for a template, scoped to one space#
GET
/document-templates/{templateId}/wiki-pushesTokenParameter
| Name | Ort | Typ | Beschreibung |
|---|---|---|---|
templateIdPflicht | Pfad | string | – |
spaceIdPflicht | Query | string | – |
Antworten
- 200OK
Beispiel (cURL)
curl -X GET "https://xapi.ambertech.cloud/api/v1/document-templates/{templateId}/wiki-pushes" \
-H "Authorization: Bearer $XISUITE_TOKEN"