Skip to content

Objects

add_object async 

add_object(auth: Annotated[Auth, Depends(authorize(HYBRID, []))], db: Annotated[Session, Depends(get_db)], event_id: Annotated[int, Path(alias=eventId)], object_template_id: Annotated[int, Path(alias=objectTemplateId)], body: ObjectCreateBody) -> ObjectResponse

Add a new object to a specific event using a template.

args:

  • the user’s authentification status

  • the current database

  • the event id

  • the object template id

  • the request body

returns:

  • the added object

add_object_depr async 

add_object_depr(auth: Annotated[Auth, Depends(authorize(HYBRID, []))], db: Annotated[Session, Depends(get_db)], event_id: Annotated[int | UUID, Path(alias=eventId)], object_template_id: Annotated[int | UUID, Path(alias=objectTemplateId)], body: ObjectCreateBody) -> ObjectResponse

Deprecated. Add an object to an event using the old route.

Parameters:

Name Type Description Default
auth Annotated[Auth, Depends(authorize(HYBRID, []))]

user’s authentification status

 required
db Annotated[Session, Depends(get_db)]

the current database

 required
event_id Annotated[int | UUID, Path(alias=eventId)]

event id

 required
object_template_id Annotated[int | UUID, Path(alias=objectTemplateId)]

the object template id

 required
body ObjectCreateBody

the request body

 required

Returns:

Type Description
ObjectResponse

the added object

delete_object async 

delete_object(auth: Annotated[Auth, Depends(authorize(HYBRID, []))], db: Annotated[Session, Depends(get_db)], object_id: Annotated[int, Path(alias=objectId)], hard_delete: Annotated[bool, Path(alias=hardDelete)]) -> StandardStatusResponse

Delete a specific object. The hardDelete parameter determines if it’s a hard or soft delete.

args:

  • the user’s authentification status

  • the current database

  • the object id

  • hard delete

returns:

  • the deleted object

delete_object_depr async 

delete_object_depr(auth: Annotated[Auth, Depends(authorize(HYBRID, []))], db: Annotated[Session, Depends(get_db)], object_id: Annotated[int, Path(alias=objectId)], hard_delete: Annotated[bool, Path(alias=hardDelete)]) -> StandardStatusResponse

Deprecated. Delete a specific object using the old route. The hardDelete parameter determines if it’s a hard or soft delete.

args:

  • the user’s authentification status

  • the current database

  • the object id

  • hard delete

returns:

  • the deleted object

get_object_details async 

get_object_details(auth: Annotated[Auth, Depends(authorize(HYBRID))], db: Annotated[Session, Depends(get_db)], object_id: Annotated[int, Path(alias=objectId)]) -> ObjectResponse

View details of a specific object including its attributes and related event.

args:

  • the user’s authentification status

  • the current database

  • the object id

returns:

  • the details of the object

get_object_details_depr async 

get_object_details_depr(auth: Annotated[Auth, Depends(authorize(HYBRID))], db: Annotated[Session, Depends(get_db)], object_id: Annotated[int, Path(alias=objectId)]) -> ObjectResponse

Deprecated. View details of a specific object using the old route.

args:

  • the user’s authentification status

  • the current database

  • the object id

returns:

  • the details of the object

restsearch async 

restsearch(auth: Annotated[Auth, Depends(authorize(HYBRID))], db: Annotated[Session, Depends(get_db)], body: ObjectSearchBody) -> ObjectSearchResponse

Search for objects based on various filters.

args:

  • the user’s authentification status

  • the current database

  • the request body

returns:

  • the objects found by search