Outline · Example Payload

Eventslist

Events

Eventslist 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": "eventsList",
  "path": "/events.list",
  "method": "POST",
  "summary": "List all events",
  "tags": [
    "Events"
  ],
  "requestSchema": {
    "allOf": [
      {
        "$ref": "#/components/schemas/Pagination"
      },
      {
        "$ref": "#/components/schemas/Sorting"
      },
      {
        "type": "object",
        "properties": {
          "name": {
            "type": "string",
            "description": "Filter to a specific event, e.g. \"collections.create\". Event names are in the format \"objects.verb\""
          },
          "actorId": {
            "type": "string",
            "format": "uuid",
            "description": "Filter to events performed by the selected user"
          },
          "documentId": {
            "type": "string",
            "format": "uuid",
            "description": "Filter to events performed in the selected document"
          },
          "collectionId": {
            "type": "string",
            "format": "uuid",
            "description": "Filter to events performed in the selected collection"
          },
          "auditLog": {
            "type": "boolean",
            "description": "Whether to return detailed events suitable for an audit log. Without this flag less detailed event types will be returned."
          }
        }
      }
    ]
  }
}