Outline · Example Payload

Documentsduplicate

Documents

Documentsduplicate 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": "documentsDuplicate",
  "path": "/documents.duplicate",
  "method": "POST",
  "summary": "Duplicate 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."
      },
      "title": {
        "type": "string",
        "description": "New title for the duplicated document"
      },
      "recursive": {
        "type": "boolean",
        "description": "Whether child documents should also be duplicated"
      },
      "publish": {
        "type": "boolean",
        "description": "Whether the new document should be published"
      },
      "collectionId": {
        "type": "string",
        "format": "uuid",
        "description": "Identifier for the collection the document should be copied to"
      },
      "parentDocumentId": {
        "type": "string",
        "format": "uuid",
        "description": "Identifier for the parent document the document should be copied to"
      }
    },
    "required": [
      "id"
    ]
  }
}