Skip to content
This repository was archived by the owner on Jul 14, 2021. It is now read-only.

REST API

Allan Deutsch edited this page Apr 1, 2018 · 1 revision

REST API v0.0

Game Properties

Description HTTP Verb Path
List of all available component types GET /Components
List of all available system types GET /Systems
List of all loaded worlds GET /Worlds
Create a new world PUT /Worlds/<Name>
Create a new Entity POST /Worlds/<Name>/Entities

Entity Properties

Description HTTP Verb Path
List of all components on an entity GET /Worlds/<World>/Entities/<ID>/Components
Read component by type GET /Worlds/<World>/Entities/<ID>/Components/<Type>
ID of the entity GET /Worlds/<World>/Entities?Name=<Name>
Modify all the data of a component PUT /Worlds/<World>/Entities/<ID>/Components/<Component>
Modify a single value of a component PATCH /Worlds/<World>/Entities/<ID>/Components/<Component>?Field=<Field>
Change the name of an entity PATCH /Worlds/<World>/Entities/<ID>
Add a component PUT /Worlds/<World>/Entities/<ID>/Components/<Component>
Remove a component DELETE /Worlds/<World>/Entities/<ID>/Components/<Component>
List of systems applying logic GET /Worlds/<World>/Systems?EntityID=<ID>

Core Engine Types

User Created Types

REST API Reference

Clone this wiki locally