Events
Classes for Events resources group
Classes:
| Name | Description |
|---|---|
Events |
Events resources method group main class |
Classes
Events
Bases: outline_wiki_api.resources.base.Resources
Events are an audit trail of important events that happen in the knowledge base.
Methods:
| Name | Description |
|---|---|
list |
List all events |
Functions
list
List all events
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name
|
str | None
|
Filter to a specific event, e.g. "collections.create". Event names are in the format "objects.verb" |
None
|
actor_id
|
str | uuid.UUID | None
|
Filter to events performed by the selected user |
None
|
document_id
|
str | uuid.UUID | None
|
Filter to events performed in the selected document |
None
|
collection_id
|
str | uuid.UUID | None
|
Filter to events performed in the selected collection |
None
|
audit_log
|
bool | None
|
Whether to return detailed events suitable for an audit log. Without this flag less detailed event types will be returned. |
None
|
pagination
|
outline_wiki_api.models.response.Pagination | None
|
Pagination parameters |
None
|
sorting
|
outline_wiki_api.models.response.Sort | None
|
Sorting parameters |
None
|
Returns:
| Type | Description |
|---|---|
|
List of events |