Collective

Create or replace a collective by id

Changed on
put/api/v2/collective/{id}

Request

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

Path parameters

idstring uuid required

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

Headers

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 required

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

compositionstring nullable

Internal structure or demographic makeup of the collective. null stores ''.

activitystring nullable

Primary behaviors or actions the collective engages in. null stores ''.

dispositionstring nullable

Emotional control or volatility expressed by the collective. null stores ''.

statestring nullable

Current condition or operational status of the collective. null stores ''.

countinteger nullable

Number of members in the collective (approximate or exact).

formation_dateinteger nullable

Date the collective was formed, using world TIME units.

operatorstring uuid nullable

Institution that manages or directs the collective. Links an Institution: an existing one in this world.

equipmentstring[] nullable

Tools or gear in possession of and/or regularly used by the collective. Links Object elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

abilitiesstring[] nullable

Abilities commonly shared among members of the collective, or abilities of that collective as a whole. Links Ability elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

symbolismstring[] nullable

Cultural expressions, rituals, or symbols that unify or distinguish the collective. Links Construct elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

speciesstring[] nullable

Species that compose or participate in the collective. Links Species elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

charactersstring[] nullable

Characters who are members of the collective. Links Character elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

creaturesstring[] nullable

Creatures associated with or included in the collective. Links Creature elements; replaces the whole list (null is the same as []). Every id must name an existing one in this world.

phenomenastring[] nullable

Phenomena that influence or characterize the collective. 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

Replaced: the full element.

type'collective' 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.

compositionstring required

Internal structure or demographic makeup of the collective.

activitystring required

Primary behaviors or actions the collective engages in.

dispositionstring required

Emotional control or volatility expressed by the collective.

statestring required

Current condition or operational status of the collective.

countinteger nullable required

Number of members in the collective (approximate or exact).

formation_dateinteger nullable required

Date the collective was formed, using world TIME units.

operatorstring uuid nullable required

Institution that manages or directs the collective. An Institution's id.

equipmentstring[] required

Tools or gear in possession of and/or regularly used by the collective. Object ids.

abilitiesstring[] required

Abilities commonly shared among members of the collective, or abilities of that collective as a whole. Ability ids.

symbolismstring[] required

Cultural expressions, rituals, or symbols that unify or distinguish the collective. Construct ids.

speciesstring[] required

Species that compose or participate in the collective. Species ids.

charactersstring[] required

Characters who are members of the collective. Character ids.

creaturesstring[] required

Creatures associated with or included in the collective. Creature ids.

phenomenastring[] required

Phenomena that influence or characterize the collective. 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, and its type's public fields (none for a collective); 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

  • 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 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