FastSim
◎ 中文
← Server REST API  /  geometry
HTTPv1

Frames & geometry

Current Server Frames & geometry 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
frames_catalogframe_transformgeometry_capabilitiesgeometry_cataloggeometry_resourcegeometry_transforms

Endpoints 6

GET/api/v1/frames/catalogframes_catalog
200dict[str, object]

Frames catalog

Handlerframes_catalog
Signatureasync frames_catalog(frame_id: _FilterValues=None, entity_id: _FilterValues=None, kind: _FilterValues=None, offset: int=Query(default=0, ge=0, le=100000), limit: int=Query(default=100, ge=1, le=1000)) -> JSONResponse
SourceL3262
REQUEST
curl -X GET \
  http://127.0.0.1:8000/api/v1/frames/catalog
GET/api/v1/frames/transformframe_transform
200dict[str, object]

Frame transform

Handlerframe_transform
Signatureasync frame_transform(source: str=Query(min_length=1, max_length=256, pattern=_ENTITY_PATTERN), target: str=Query(min_length=1, max_length=256, pattern=_ENTITY_PATTERN), generation: int | None=Query(default=None, ge=1, le=2 ** 63 - 1)) -> JSONResponse
SourceL3278
REQUEST
curl -X GET \
  http://127.0.0.1:8000/api/v1/frames/transform
GET/api/v1/geometry/capabilitiesgeometry_capabilities
200dict[str, object]

Geometry capabilities

Handlergeometry_capabilities
Signatureasync geometry_capabilities() -> JSONResponse
SourceL3313
REQUEST
curl -X GET \
  http://127.0.0.1:8000/api/v1/geometry/capabilities
GET/api/v1/geometry/cataloggeometry_catalog
200dict[str, object]

Geometry catalog

Handlergeometry_catalog
Signatureasync geometry_catalog(entity_id: _FilterValues=None, motion_class: _FilterValues=None, collision_layer: _FilterValues=None, purpose: _FilterValues=None, representation: _FilterValues=None, offset: int=Query(default=0, ge=0, le=100000), limit: int=Query(default=100, ge=1, le=1000)) -> JSONResponse
SourceL3322
REQUEST
curl -X GET \
  http://127.0.0.1:8000/api/v1/geometry/catalog
GET/api/v1/geometry/resources/{geometry_id:path}geometry_resource
200dict[str, object]

Geometry resource

Handlergeometry_resource
Signatureasync geometry_resource(request: Request, geometry_id: str=Path(min_length=1, max_length=256, pattern=_ENTITY_PATTERN), representation: str | None=Query(default=None, min_length=1, max_length=64), offset: int=Query(default=0, ge=0, le=2 ** 63 - 1), length: int | None=Query(default=None, ge=1, le=_GEOMETRY_RANGE_LIMIT_BYTES), range_header: _RangeHeader=None) -> Response
SourceL3369
REQUEST
curl -X GET \
  http://127.0.0.1:8000/api/v1/geometry/resources/{geometry_id:path}
GET/api/v1/geometry/transformsgeometry_transforms
200dict[str, object]

Geometry transforms

Handlergeometry_transforms
Signatureasync geometry_transforms(entity_id: _FilterValues=None, motion_class: _FilterValues=None, collision_layer: _FilterValues=None, purpose: _FilterValues=None, representation: _FilterValues=None) -> JSONResponse
SourceL3346
REQUEST
curl -X GET \
  http://127.0.0.1:8000/api/v1/geometry/transforms