Skip to content
Qualia Docs

Events_UndoEvent_Workspace

POST
/v1/accounts/{account}/workspaces/{workspace}/events/{event}:undo
 
curl --request POST \
  --url https://dev-api.qualiastudios.dev/v1/accounts/example/workspaces/example/events/example:undo \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "name": "example" }'

Undoes an event. The service that wrote it does the undo, in its own transaction, and records it as a new event whose undoes is this event’s id; the event itself never changes. Each event is undone at most once.

FAILED_PRECONDITION, with the reason in the message, when the event is not undoable (its kind can’t be undone, or this one was written so), when it was undone already, or when what it changed has changed since (an episode ruled or edited again, an issue edited or dismissed). ABORTED when the episodes it edited move while the undo runs: send it again. Needs spaces:read and datasets:write on the event’s workspace (only qds events undo today); an event of the organization itself needs spaces:read and spaces:members on the organization. An API key needs data:write.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
account
required
string

The account id.

workspace
required
string

The workspace id.

event
required
string

The event id.

Request Body required

Section titled “Request Body required ”
Media type application/json

Request for Events.UndoEvent.

object
name
required

The event to undo, by its name: accounts/{account}/workspaces/{workspace}/events/{event} for a workspace’s, accounts/{account}/events/{event} for the organization’s own. A workspace’s event named by the organization path is refused.

string
Example generated
{
  "name": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

Response for Events.UndoEvent.

object
event

The event that records the undo, named under the same parent as the request; its undoes is the undone event’s id. It reaches the record, and GetEvent, ListEvents and the live stream, when the relay copies it, normally within a second.

string
Example generated
{
  "event": "example"
}

default

Section titled “default ”

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32
message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string
details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object
@type

The type of the serialized message.

string
key
additional properties
any
Example generated
{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}