Object

Update part of an object

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

Request

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

Path parameters

idstring uuid required

The object'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 ''.

aestheticsstring nullable

Appearance, design, or visual presentation of the object. null stores ''.

utilitystring nullable

Intended purpose or primary use of the object. null stores ''.

originsstring nullable

Background or history of the object. null stores ''.

weightinteger nullable

Approximate or exact mass of the object, in the world's mass unit (World mass_unit).

amountinteger nullable

The number of identical units in this object entry.

parent_objectstring uuid nullable

Larger object that this one is part of or contained within. Links an Object: an existing one in this world.

locationstring uuid nullable

Physical place where the object is currently located or stored. Links a Location: an existing one in this world.

languagestring uuid nullable

Required to read, understand, or activate the object. Links a Language: an existing one in this world.

materialsstring[] nullable

The physical matter that constitutes the object. Links Construct elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

technologystring[] nullable

Mechanisms relating to the object's design or operation. Links Construct elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

effectsstring[] nullable

Phenomena potentially triggered or emitted on object use. Links Phenomenon elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

abilitiesstring[] nullable

Abilities that the object grants or enables. Links Ability elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

consumesstring[] nullable

What might be used or depleted on object use. Links Construct elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

affinitiesstring[] nullable

Traits that resonate with or enhance the object's use, function, or effects. Links Trait 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'object' 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.

aestheticsstring required

Appearance, design, or visual presentation of the object.

utilitystring required

Intended purpose or primary use of the object.

originsstring required

Background or history of the object.

weightinteger nullable required

Approximate or exact mass of the object, in the world's mass unit (World mass_unit).

amountinteger nullable required

The number of identical units in this object entry.

parent_objectstring uuid nullable required

Larger object that this one is part of or contained within. An Object's id.

locationstring uuid nullable required

Physical place where the object is currently located or stored. A Location's id.

languagestring uuid nullable required

Required to read, understand, or activate the object. A Language's id.

materialsstring[] required

The physical matter that constitutes the object. Construct ids.

technologystring[] required

Mechanisms relating to the object's design or operation. Construct ids.

effectsstring[] required

Phenomena potentially triggered or emitted on object use. Phenomenon ids.

abilitiesstring[] required

Abilities that the object grants or enables. Ability ids.

consumesstring[] required

What might be used or depleted on object use. Construct ids.

affinitiesstring[] required

Traits that resonate with or enhance the object's use, function, or effects. Trait 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, and its type's public fields (none for an object); 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 what it keeps. 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, whatever its public fields. Read-only: a write carrying known_of is refused (known_of_not_writable).

Changes

  • 78df39c4c62eRevision changes
    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

  • 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