FastSim
◎ 中文
← Server REST API  /  scene
HTTPv1

Scene entities

Current Server Scene entities surface; paths, methods, status codes and handler signatures come directly from 0.8.4 source.

Source packages/fastsim-plugin-server/src/fastsim_plugin_server/application.py
deformableparticle_fluidscene_catalogattach_entitydetach_entitybegin_entity_dragcancel_entity_dragend_entity_dragupdate_entity_dragset_entity_posescene_state

Endpoints 11

GET/api/v1/deformables/{entity_id}/nodesdeformable
200dict[str, object]

Deformable

Handlerdeformable
Signatureasync deformable(entity_id: str=Path(min_length=1, max_length=140, pattern=_DEFORMABLE_ENTITY_PATTERN), timeout_s: _QueryTimeout=None) -> Response
SourceL2938
REQUEST
curl -X GET \
  http://127.0.0.1:8000/api/v1/deformables/{entity_id}/nodes
GET/api/v1/fluids/{entity_id}/particlesparticle_fluid
200dict[str, object]

Particle fluid

Handlerparticle_fluid
Signatureasync particle_fluid(entity_id: str=Path(min_length=1, max_length=135, pattern=_FLUID_ENTITY_PATTERN), timeout_s: _QueryTimeout=None) -> Response
SourceL2898
REQUEST
curl -X GET \
  http://127.0.0.1:8000/api/v1/fluids/{entity_id}/particles
GET/api/v1/scene/catalogscene_catalog
200dict[str, object]

Scene catalog

Handlerscene_catalog
Signatureasync scene_catalog(entity_id: _FilterValues=None, link_id: _FilterValues=None, kind: _FilterValues=None, enabled: bool | None=Query(default=None), offset: int=Query(default=0, ge=0, le=100000), limit: int=Query(default=100, ge=1, le=1000)) -> JSONResponse
SourceL2977
REQUEST
curl -X GET \
  http://127.0.0.1:8000/api/v1/scene/catalog
POST/api/v1/scene/entities/{entity_id}/attachmentsattach_entity
200dict[str, object]

Attach entity

Handlerattach_entity
Signatureasync attach_entity(payload: AttachEntityRequest, entity_id: str=Path(min_length=8, max_length=142, pattern=_SCENE_ENTITY_PATTERN), idempotency_key: _IdempotencyHeader=None, slot_generation: _SlotGenerationHeader=None) -> JSONResponse
SourceL3118
REQUEST
curl -X POST \
  http://127.0.0.1:8000/api/v1/scene/entities/{entity_id}/attachments \
  -H 'Content-Type: application/json' \
  -d @request.json
POST/api/v1/scene/entities/{entity_id}/attachments/{attachment_id:path}/detachdetach_entity
200dict[str, object]

Detach entity

Handlerdetach_entity
Signatureasync detach_entity(payload: DetachEntityRequest, entity_id: str=Path(min_length=8, max_length=142, pattern=_SCENE_ENTITY_PATTERN), attachment_id: str=Path(min_length=1, max_length=128, pattern=_SCENE_COMMAND_ID_PATTERN), idempotency_key: _IdempotencyHeader=None, slot_generation: _SlotGenerationHeader=None) -> JSONResponse
SourceL3145
REQUEST
curl -X POST \
  http://127.0.0.1:8000/api/v1/scene/entities/{entity_id}/attachments/{attachment_id:path}/detach \
  -H 'Content-Type: application/json' \
  -d @request.json
POST/api/v1/scene/entities/{entity_id}/dragsbegin_entity_drag
200dict[str, object]

Begin entity drag

Handlerbegin_entity_drag
Signatureasync begin_entity_drag(payload: BeginEntityDragRequest, entity_id: str=Path(min_length=8, max_length=142, pattern=_SCENE_ENTITY_PATTERN), idempotency_key: _IdempotencyHeader=None, slot_generation: _SlotGenerationHeader=None) -> JSONResponse
SourceL3168
REQUEST
curl -X POST \
  http://127.0.0.1:8000/api/v1/scene/entities/{entity_id}/drags \
  -H 'Content-Type: application/json' \
  -d @request.json
POST/api/v1/scene/entities/{entity_id}/drags/{drag_id:path}/cancelcancel_entity_drag
200dict[str, object]

Cancel entity drag

Handlercancel_entity_drag
Signatureasync cancel_entity_drag(payload: FinishEntityDragRequest, entity_id: str=Path(min_length=8, max_length=142, pattern=_SCENE_ENTITY_PATTERN), drag_id: str=Path(min_length=1, max_length=128, pattern=_SCENE_COMMAND_ID_PATTERN), idempotency_key: _IdempotencyHeader=None, slot_generation: _SlotGenerationHeader=None) -> JSONResponse
SourceL3239
REQUEST
curl -X POST \
  http://127.0.0.1:8000/api/v1/scene/entities/{entity_id}/drags/{drag_id:path}/cancel \
  -H 'Content-Type: application/json' \
  -d @request.json
POST/api/v1/scene/entities/{entity_id}/drags/{drag_id:path}/endend_entity_drag
200dict[str, object]

End entity drag

Handlerend_entity_drag
Signatureasync end_entity_drag(payload: FinishEntityDragRequest, entity_id: str=Path(min_length=8, max_length=142, pattern=_SCENE_ENTITY_PATTERN), drag_id: str=Path(min_length=1, max_length=128, pattern=_SCENE_COMMAND_ID_PATTERN), idempotency_key: _IdempotencyHeader=None, slot_generation: _SlotGenerationHeader=None) -> JSONResponse
SourceL3216
REQUEST
curl -X POST \
  http://127.0.0.1:8000/api/v1/scene/entities/{entity_id}/drags/{drag_id:path}/end \
  -H 'Content-Type: application/json' \
  -d @request.json
POST/api/v1/scene/entities/{entity_id}/drags/{drag_id:path}/updatesupdate_entity_drag
200dict[str, object]

Update entity drag

Handlerupdate_entity_drag
Signatureasync update_entity_drag(payload: UpdateEntityDragRequest, entity_id: str=Path(min_length=8, max_length=142, pattern=_SCENE_ENTITY_PATTERN), drag_id: str=Path(min_length=1, max_length=128, pattern=_SCENE_COMMAND_ID_PATTERN), idempotency_key: _IdempotencyHeader=None, slot_generation: _SlotGenerationHeader=None) -> JSONResponse
SourceL3191
REQUEST
curl -X POST \
  http://127.0.0.1:8000/api/v1/scene/entities/{entity_id}/drags/{drag_id:path}/updates \
  -H 'Content-Type: application/json' \
  -d @request.json
POST/api/v1/scene/entities/{entity_id}/poseset_entity_pose
200dict[str, object]

Set entity pose

Handlerset_entity_pose
Signatureasync set_entity_pose(payload: SetEntityPoseRequest, entity_id: str=Path(min_length=8, max_length=142, pattern=_SCENE_ENTITY_PATTERN), idempotency_key: _IdempotencyHeader=None, slot_generation: _SlotGenerationHeader=None) -> JSONResponse
SourceL3095
REQUEST
curl -X POST \
  http://127.0.0.1:8000/api/v1/scene/entities/{entity_id}/pose \
  -H 'Content-Type: application/json' \
  -d @request.json
GET/api/v1/scene/statescene_state
200dict[str, object]

Scene state

Handlerscene_state
Signatureasync scene_state(entity_id: _FilterValues=None, link_id: _FilterValues=None, kind: _FilterValues=None, enabled: bool | None=Query(default=None)) -> JSONResponse
SourceL2994
REQUEST
curl -X GET \
  http://127.0.0.1:8000/api/v1/scene/state