Event

Update part of an event

Changed on
patch/api/v2/event/{id}

Request

  • Base URL: https://www.onlyworlds.com
  • URL: https://www.onlyworlds.com/api/v2/event/{id}
  • Auth: API key in header API-Key and API key in header API-Pin

Path parameters

idstring uuid required

The event's id (a malformed id is a 422).

Headers

If-Matchstring

Apply only if the element's change_seq is still this number (quoted or bare; * or no header means unconditional). When the element has moved, 412 precondition_failed with the live element as current beside the envelope; nothing is written and nothing is merged.

X-OW-Agentstring

Send it (any non-empty value) when an agent makes this write: the change is recorded with changed_via declared (a delete's tombstone with deleted_via). An agent seat's key and MCP are recorded as agent-made without it. The value is never stored.

Request body

idstring uuid

POST: optional client-minted id (any RFC 4122 UUID; the server mints a UUIDv7 otherwise). PUT/PATCH: ignored, the path id wins.

namestring nullable

Name of the element. null stores ''.

descriptionstring nullable

Any kind of details about the element. null stores ''.

supertypestring nullable

The top level category to which the element belongs. null stores ''.

subtypestring nullable

The sub level category through which the element is further classified. null stores ''.

image_urlstring nullable

URL to an image representing the element. null stores ''.

historystring nullable

Historical context and background of the event. null stores ''.

challengesstring nullable

Adversity or difficulties faced during the event. null stores ''.

consequencesstring nullable

Outcomes and impacts resulting from the event. null stores ''.

start_dateinteger nullable

Date on which the event began.

end_dateinteger nullable

Date on which the event concluded.

triggersstring[] nullable

Events that precipitated this event. Links Event elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

charactersstring[] nullable

Characters who know about the event: they were present, aware of it, or involved in it. Links Character elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

objectsstring[] nullable

Objects relevant to the event. Links Object elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

locationsstring[] nullable

Locations relevant to the event. Links Location elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

speciesstring[] nullable

Species relevant to the event. Links Species elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

creaturesstring[] nullable

Creatures relevant to the event. Links Creature elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

institutionsstring[] nullable

Institutions relevant to the event. Links Institution elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

traitsstring[] nullable

Traits relevant to the event. Links Trait elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

collectivesstring[] nullable

Groups or collectives relevant to the event. Links Collective elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

zonesstring[] nullable

Zones relevant to the event. Links Zone elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

abilitiesstring[] nullable

Abilities relevant to the event. Links Ability elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

phenomenastring[] nullable

Natural or supernatural phenomena relevant to the event. Links Phenomenon elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

languagesstring[] nullable

Languages relevant to the event. Links Language elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

familiesstring[] nullable

Families relevant to the event. Links Family elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

relationsstring[] nullable

Interpersonal or political relations relevant to the event. Links Relation elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

titlesstring[] nullable

Titles relevant to the event. Links Title elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

constructsstring[] nullable

Concepts, laws, or built entities relevant to the event. Links Construct elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

worldunknown
created_byunknown
changed_byunknown
changed_viaunknown

Response

Updated: the full element.

type'event' required
idstring uuid required
namestring required

Name of the element.

descriptionstring required

Any kind of details about the element.

supertypestring required

The top level category to which the element belongs.

subtypestring required

The sub level category through which the element is further classified.

image_urlstring required

URL to an image representing the element.

historystring required

Historical context and background of the event.

challengesstring required

Adversity or difficulties faced during the event.

consequencesstring required

Outcomes and impacts resulting from the event.

start_dateinteger nullable required

Date on which the event began.

end_dateinteger nullable required

Date on which the event concluded.

triggersstring[] required

Events that precipitated this event. Event ids.

charactersstring[] required

Characters who know about the event: they were present, aware of it, or involved in it. Character ids.

objectsstring[] required

Objects relevant to the event. Object ids.

locationsstring[] required

Locations relevant to the event. Location ids.

speciesstring[] required

Species relevant to the event. Species ids.

creaturesstring[] required

Creatures relevant to the event. Creature ids.

institutionsstring[] required

Institutions relevant to the event. Institution ids.

traitsstring[] required

Traits relevant to the event. Trait ids.

collectivesstring[] required

Groups or collectives relevant to the event. Collective ids.

zonesstring[] required

Zones relevant to the event. Zone ids.

abilitiesstring[] required

Abilities relevant to the event. Ability ids.

phenomenastring[] required

Natural or supernatural phenomena relevant to the event. Phenomenon ids.

languagesstring[] required

Languages relevant to the event. Language ids.

familiesstring[] required

Families relevant to the event. Family ids.

relationsstring[] required

Interpersonal or political relations relevant to the event. Relation ids.

titlesstring[] required

Titles relevant to the event. Title ids.

constructsstring[] required

Concepts, laws, or built entities relevant to the event. Construct ids.

created_atstring date-time required
updated_atstring date-time required
change_seqinteger required

The world change sequence at this element's last write.

created_bystring uuid nullable required

The world membership that created this element, or null when the world's owner did.

changed_bystring uuid nullable required

The world membership that last changed this element, or null when the world's owner (or the server) did, or no write has touched it since doors were recorded.

changed_via'seat' | 'mcp' | 'declared' | 'api' | 'v1' | 'sync' | 'server' | 'null' nullable required

The door of the last change: seat (an agent seat), mcp (the MCP server), declared (the request sent an X-OW-Agent header), api, v1, sync (the mobile app's sync) or server (the server, on its own behalf). The first three mean an agent made it. Null: no write since doors were recorded.

known_oftrue

Present, and true, only on an element this reader knows of but does not see whole: a guest or player reaches it only because its own Character's sheet links to it (one step out). Such a row keeps id, type, name, description, supertype, subtype, image_url, created_at, updated_at and change_seq; every other field reads as unset (text "", numbers and single links null, multi links [], created_by, changed_by and changed_via null, no extension fields), its files are 404, and search matches only its name and description. Absent: the element is whole. Any other grant (it names the reader's Character, the reader knows it, it is on the roster, the reader made it) makes it whole; a hidden element is never even a stub.

Changes

  • 4dd5b1cd0687Revision changes
    • warning

      added the new character_taken enum value to the // response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the // response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status