Package org.fiware.ngsi.api

Interface EntitiesApi

@Generated(value="org.openapitools.codegen.languages.MicronautCodegen",
           date="2025-02-14T11:59:01.612183689Z[Etc/UTC]")
public interface EntitiesApi

Method Summary

Modifier and Type	Method	Description
io.micronaut.http.HttpResponse<Object>	appendEntityAttrs(URI entityId, EntityFragmentVO entityFragmentVO, String options)
io.micronaut.http.HttpResponse<BatchOperationResultVO>	batchEntityCreation(EntityListVO entityListVO)
io.micronaut.http.HttpResponse<BatchOperationResultVO>	batchEntityDelete(List<URI> javaNetURI)
io.micronaut.http.HttpResponse<BatchOperationResultVO>	batchEntityUpdate(EntityListVO entityListVO, String options)
io.micronaut.http.HttpResponse<BatchOperationResultVO>	batchEntityUpsert(EntityListVO entityListVO, String options)
io.micronaut.http.HttpResponse<Object>	createEntity(EntityVO entityVO)
io.micronaut.http.HttpResponse<Object>	partialAttrUpdate(URI entityId, String attrId, EntityFragmentVO entityFragmentVO)
io.micronaut.http.HttpResponse<EntityListVO>	queryEntities(String id, String idPattern, String type, String attrs, String q, String georel, String geometry, String coordinates, String geoproperty, String csf, Integer limit, String options)
io.micronaut.http.HttpResponse<Object>	removeEntityAttr(URI entityId, String attrId)
io.micronaut.http.HttpResponse<Object>	removeEntityById(URI entityId, String type)
io.micronaut.http.HttpResponse<EntityVO>	retrieveEntityById(URI entityId, String attrs, String type, String options)
io.micronaut.http.HttpResponse<Object>	updateEntityAttrs(URI entityId, EntityFragmentVO entityFragmentVO)

Method Details

appendEntityAttrs

@Post("/entities/{entityId}/attrs/")
@Consumes("application/ld+json")
@Produces("application/ld+json")
io.micronaut.http.HttpResponse<Object> appendEntityAttrs(@PathVariable(name="entityId")
 URI entityId,
 @Body
 EntityFragmentVO entityFragmentVO,
 @Nullable @QueryValue("options")
 String options)

batchEntityCreation

@Post("/entityOperations/create")
@Consumes("application/ld+json")
@Produces("application/ld+json")
io.micronaut.http.HttpResponse<BatchOperationResultVO> batchEntityCreation(@Body
 EntityListVO entityListVO)

batchEntityDelete

@Post("/entityOperations/delete")
@Consumes("application/ld+json")
@Produces("application/ld+json")
io.micronaut.http.HttpResponse<BatchOperationResultVO> batchEntityDelete(@Body
 List<URI> javaNetURI)

batchEntityUpdate

@Post("/entityOperations/update")
@Consumes("application/ld+json")
@Produces("application/ld+json")
io.micronaut.http.HttpResponse<BatchOperationResultVO> batchEntityUpdate(@Body
 EntityListVO entityListVO,
 @Nullable @QueryValue("options")
 String options)

batchEntityUpsert

@Post("/entityOperations/upsert")
@Consumes("application/ld+json")
@Produces("application/ld+json")
io.micronaut.http.HttpResponse<BatchOperationResultVO> batchEntityUpsert(@Body
 EntityListVO entityListVO,
 @Nullable @QueryValue("options")
 String options)

createEntity

@Post("/entities/")
@Consumes("application/ld+json")
@Produces("application/ld+json")
io.micronaut.http.HttpResponse<Object> createEntity(@Body
 EntityVO entityVO)

partialAttrUpdate

@Patch("/entities/{entityId}/attrs/{attrId}")
@Consumes("application/ld+json")
@Produces("application/ld+json")
io.micronaut.http.HttpResponse<Object> partialAttrUpdate(@PathVariable(name="entityId")
 URI entityId,
 @PathVariable(name="attrId")
 String attrId,
 @Body
 EntityFragmentVO entityFragmentVO)

queryEntities

@Get("/entities/")
@Produces("application/ld+json")
io.micronaut.http.HttpResponse<EntityListVO> queryEntities(@Nullable @QueryValue("id")
 String id,
 @Nullable @QueryValue("idPattern")
 String idPattern,
 @Nullable @QueryValue("type")
 String type,
 @Nullable @QueryValue("attrs")
 String attrs,
 @Nullable @QueryValue("q")
 String q,
 @Nullable @QueryValue("georel")
 String georel,
 @Nullable @QueryValue("geometry")
 String geometry,
 @Nullable @QueryValue("coordinates")
 String coordinates,
 @Nullable @QueryValue("geoproperty")
 String geoproperty,
 @Nullable @QueryValue("csf")
 String csf,
 @Nullable @QueryValue("limit")
 Integer limit,
 @Nullable @QueryValue("options")
 String options)

removeEntityAttr

@Delete("/entities/{entityId}/attrs/{attrId}")
@Produces("application/ld+json")
io.micronaut.http.HttpResponse<Object> removeEntityAttr(@PathVariable(name="entityId")
 URI entityId,
 @PathVariable(name="attrId")
 String attrId)

removeEntityById

@Delete("/entities/{entityId}")
@Produces("application/ld+json")
io.micronaut.http.HttpResponse<Object> removeEntityById(@PathVariable(name="entityId")
 URI entityId,
 @Nullable @QueryValue("type")
 String type)

retrieveEntityById

@Get("/entities/{entityId}")
@Produces("application/ld+json")
io.micronaut.http.HttpResponse<EntityVO> retrieveEntityById(@PathVariable(name="entityId")
 URI entityId,
 @Nullable @QueryValue("attrs")
 String attrs,
 @Nullable @QueryValue("type")
 String type,
 @Nullable @QueryValue("options")
 String options)

updateEntityAttrs

@Patch("/entities/{entityId}/attrs/")
@Consumes("application/ld+json")
@Produces("application/ld+json")
io.micronaut.http.HttpResponse<Object> updateEntityAttrs(@PathVariable(name="entityId")
 URI entityId,
 @Body
 EntityFragmentVO entityFragmentVO)