Outline · Example Payload

Documentsexport

Documents

Documentsexport is an example object payload from Outline, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdpathmethodsummarytagsrequestSchema

Example Payload

Raw ↑ 
{
  "operationId": "documentsExport",
  "path": "/documents.export",
  "method": "POST",
  "summary": "Export a document.",
  "tags": [
    "Documents"
  ],
  "requestSchema": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string",
        "description": "Unique identifier for the document. Either the UUID or the urlId is acceptable."
      },
      "paperSize": {
        "type": "string",
        "description": "Paper size for PDF export (e.g., \"A4\", \"Letter\")"
      },
      "signedUrls": {
        "type": "number",
        "description": "How long signed URLs should remain valid for attachment links (in seconds)"
      },
      "includeChildDocuments": {
        "type": "boolean",
        "description": "Whether to include child documents in the export. Using this option will always return a zip file.",
        "default": false
      }
    },
    "required": [
      "id"
    ]
  }
}