Entities

Link an entity to another

One asserted relation FROM this entity, checked by the app's rules: wears, carries (character, look or skin to a prop, product or skin), owns, includes, rides (to a prop or character), lives_in, born_in (single: a new one replaces the old), found_in, interior (prop to place), family_of, friend_of, enemy_of, works_for, related_to (character to character). The target is yours and of the kind to_type names. Idempotent: a repeat answers 200 with the link that already says it; a new one is 201. Free.

post/v1/entities/{id}/links

Request

  • Base URL: https://nanostudiopro.com/api
  • URL: https://nanostudiopro.com/api/v1/entities/{id}/links
  • Auth: HTTP bearer

Request body

relationstring required
to_type'character' | 'prop' | 'location' | 'skin' | 'product' required
to_idstring required
notestring nullable

Example request

{
  "relation": "rides"
}

Response

The link already existed

Example response

{
  "link": {
    "relation": "carries",
    "label": "carries",
    "to": {
      "type": "prop",
      "name": "Katana"
    }
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.