Skip to main content
PATCH
Update a npc by entity_id

Path Parameters

project_id
string
required
entity_id
string
required

Body

application/json

PATCH /v1/projects/{project_id}/{pack}/{term}/{entity_id} - partial update.

All fields are optional; only those present in the body are applied. The canonical type is fixed by the URL and cannot be changed via PATCH - to convert an entity to a different type, delete and re-create.

name
string | null

New display name. Omit to leave unchanged.

Required string length: 1 - 200
properties
Properties · object | null

New properties. When properties_merge=True (default false), supplied keys are shallow-merged over the existing properties; when false, the entire properties object is replaced.

properties_merge
boolean
default:false

If true, properties is shallow-merged onto the existing object; if false (default), it replaces the existing object.

Response

Successful Response

Entity resource representation.

id
string
required

Entity ID (ent_ prefixed)

project_id
string
required

Parent project ID

external_id
string
required

Developer-provided stable identifier

type
string
required

Entity type

name
string
required

Display name

created_at
string<date-time>
required

Creation timestamp (UTC)

updated_at
string<date-time>
required

Last update timestamp (UTC)

properties
Properties · object

Domain-specific properties

valid_from_seq
integer | null

KG temporal anchor: first valid sequence

valid_to_seq
integer | null

KG temporal anchor: last valid sequence (null = current)

parent_id
string | null

System ID (ent_ prefixed) of the parent entity. None for root entities.

location_path
string | null

Materialized path string for subtree queries. Format: '/{external_id}' for roots, '/{ancestor}/{...}/{own_ext_id}' for children. None for entities that have never had a parent set.

Link that caused this shadow entity. None for native entities.

source_entity_id
string | null

Originating entity ID in the source project. None for native entities.

source_project_id
string | null

Originating project ID. None for native entities.