Species

Update part of a species

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

Request

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

Path parameters

idstring uuid required

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

appearancestring nullable

Typical physical or form features of the species. null stores ''.

instinctsstring nullable

Innate behavioral drives and survival tendencies. null stores ''.

socialitystring nullable

Typical patterns of social behavior. null stores ''.

temperamentstring nullable

Overall behavioral disposition. null stores ''.

communicationstring nullable

Typical methods and approaches of interaction. null stores ''.

rolestring nullable

The species' ecological or cultural function in the world. null stores ''.

life_spaninteger nullable

Average or typical life expectancy of an individual, defined in world TIME units.

weightinteger nullable

Average or typical adult weight, in the world's mass unit (World mass_unit).

aggressioninteger nullable

General aggressiveness level, on relative scale of 0 to 100.

parent_speciesstring uuid nullable

Species that the species is considered a subspecies of. Links a Species: an existing one in this world.

nourishmentstring[] nullable

Other species consumed as food sources. Links Species elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

reproductionstring[] nullable

Reproductive method(s) of the species. Links Construct elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

adaptationsstring[] nullable

Special physiological or evolutionary abilities. Links Ability elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

traitsstring[] nullable

Behavioral patterns associated with the species. Links Trait elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

locationsstring[] nullable

Locations associated with the species or its habitat. Links Location elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

zonesstring[] nullable

Zones associated with the species or its habitat. Links Zone elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

affinitiesstring[] nullable

Phenomena associated with the species or its behavior. Links Phenomenon 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'species' 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.

appearancestring required

Typical physical or form features of the species.

instinctsstring required

Innate behavioral drives and survival tendencies.

socialitystring required

Typical patterns of social behavior.

temperamentstring required

Overall behavioral disposition.

communicationstring required

Typical methods and approaches of interaction.

rolestring required

The species' ecological or cultural function in the world.

life_spaninteger nullable required

Average or typical life expectancy of an individual, defined in world TIME units.

weightinteger nullable required

Average or typical adult weight, in the world's mass unit (World mass_unit).

aggressioninteger nullable required

General aggressiveness level, on relative scale of 0 to 100.

parent_speciesstring uuid nullable required

Species that the species is considered a subspecies of. A Species's id.

nourishmentstring[] required

Other species consumed as food sources. Species ids.

reproductionstring[] required

Reproductive method(s) of the species. Construct ids.

adaptationsstring[] required

Special physiological or evolutionary abilities. Ability ids.

traitsstring[] required

Behavioral patterns associated with the species. Trait ids.

locationsstring[] required

Locations associated with the species or its habitat. Location ids.

zonesstring[] required

Zones associated with the species or its habitat. Zone ids.

affinitiesstring[] required

Phenomena associated with the species or its behavior. Phenomenon 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