Skip to content

Objects

add_object async 

add_object(
    auth: Annotated[
        Auth, Depends(authorize(AuthStrategy.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.

Input:

  • the user's authentification status

  • the current database

  • the event id

  • the object template id

  • the request body

Output:

  • the added object

add_object_depr async 

add_object_depr(
    auth: Annotated[
        Auth, Depends(authorize(AuthStrategy.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

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

Input:

  • the user's authentification status

  • the current database

  • the event id

  • the object template id

  • the request body

Output:

  • the added object

delete_object async 

delete_object(
    auth: Annotated[
        Auth, Depends(authorize(AuthStrategy.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.

Input:

  • the user's authentification status

  • the current database

  • the object id

  • hard delete

Output:

  • the deleted object

delete_object_depr async 

delete_object_depr(
    auth: Annotated[
        Auth, Depends(authorize(AuthStrategy.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.

Input:

  • the user's authentification status

  • the current database

  • the object id

  • hard delete

Output:

  • the deleted object

get_object_details async 

get_object_details(
    auth: Annotated[
        Auth, Depends(authorize(AuthStrategy.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.

Input:

  • the user's authentification status

  • the current database

  • the object id

Output:

  • the details of the object

get_object_details_depr async 

get_object_details_depr(
    auth: Annotated[
        Auth, Depends(authorize(AuthStrategy.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.

Input:

  • the user's authentification status

  • the current database

  • the object id

Output:

  • the details of the object

restsearch async 

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

Search for objects based on various filters.

Input:

  • the user's authentification status

  • the current database

  • the request body

Output:

  • the objects found by search