ngsiv2

FIWARE-NGSI v2 Specification

• API version: 1.0

• Build date: 2025-04-27T19:56:40.594359+09:00[Asia/Tokyo]

• Generator version: 7.12.0

TODO: Add a description

Automatically generated by the OpenAPI Generator

Like below

openapi-generator-cli generate \
  -i https://raw.githubusercontent.com/FIWARE/specifications/master/OpenAPI/ngsiv2/ngsiv2-openapi.json \
  -g java \
  --library restclient \
  --additional-properties=invokerPackage=city.makeour.ngsi.v2.invoker,apiPackage=city.makeour.ngsi.v2.api,modelPackage=city.makeour.ngsi.v2.model,groupId=city.makeour.ngsi.v2,artifactId=ngsiv2,artifactVersion=1.0.0 \
  -o ./ngsiv2-java

Requirements

Building the API client library requires:

1. Java 17+
2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

with jit pack

    <dependency>
      <groupId>com.github.makeOurCity</groupId>
      <artifactId>ngsiv2-java</artifactId>
      <version>0.0.2</version>
    </dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'ngsiv2' jar has been published to maven central.
    mavenLocal()       // Needed if the 'ngsiv2' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "city.makeour.ngsi.v2:ngsiv2:1.0"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/ngsiv2-1.0.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import city.makeour.ngsi.v2.invoker.*;
import city.makeour.ngsi.v2.invoker.auth.*;
import city.makeour.ngsi.v2.model.*;
import city.makeour.ngsi.v2.api.ApiEntryPointApi;

public class ApiEntryPointApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = new ApiClient();
        defaultClient.setBasePath("http://orion.lab.fiware.org");
        
        ApiEntryPointApi apiInstance = new ApiEntryPointApi(defaultClient);
        try {
            RetrieveApiResourcesResponse result = apiInstance.retrieveAPIResources();
            System.out.println(result);
        } catch (HttpStatusCodeException e) {
            System.err.println("Exception when calling ApiEntryPointApi#retrieveAPIResources");
            System.err.println("Status code: " + e.getStatusCode().value());
            System.err.println("Reason: " + e.getResponseBodyAsString());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to http://orion.lab.fiware.org

Class	Method	HTTP request	Description
ApiEntryPointApi	retrieveAPIResources	GET /v2	Retrieve API Resources
AttributeValueApi	getAttributeValue	GET /v2/entities/{entityId}/attrs/{attrName}/value	Get Attribute Value
AttributeValueApi	updateAttributeValue	PUT /v2/entities/{entityId}/attrs/{attrName}/value	Update Attribute Value
AttributesApi	getAttributeData	GET /v2/entities/{entityId}/attrs/{attrName}	Get attribute data
AttributesApi	removeASingleAttribute	DELETE /v2/entities/{entityId}/attrs/{attrName}	Remove a Single Attribute
AttributesApi	updateAttributeData	PUT /v2/entities/{entityId}/attrs/{attrName}	Update Attribute Data
BatchOperationsApi	notify	POST /v2/op/notify	Notify
BatchOperationsApi	query	POST /v2/op/query	Query
BatchOperationsApi	update	POST /v2/op/update	Update
EntitiesApi	createEntity	POST /v2/entities	Create Entity
EntitiesApi	listEntities	GET /v2/entities	List Entities
EntitiesApi	removeEntity	DELETE /v2/entities/{entityId}	Remove Entity
EntitiesApi	replaceAllEntityAttributes	PUT /v2/entities/{entityId}/attrs	Replace all entity attributes
EntitiesApi	retrieveEntity	GET /v2/entities/{entityId}	Retrieve Entity
EntitiesApi	retrieveEntityAttributes	GET /v2/entities/{entityId}/attrs	Retrieve Entity Attributes
EntitiesApi	updateExistingEntityAttributes	PATCH /v2/entities/{entityId}/attrs	Update Existing Entity Attributes
EntitiesApi	updateOrAppendEntityAttributes	POST /v2/entities/{entityId}/attrs	Update or Append Entity Attributes
RegistrationsApi	createRegistration	POST /v2/registrations	Create Registration
RegistrationsApi	deleteRegistration	DELETE /v2/registrations/{registrationId}	Delete Registration
RegistrationsApi	listRegistrations	GET /v2/registrations	List Registrations
RegistrationsApi	retrieveRegistration	GET /v2/registrations/{registrationId}	Retrieve Registration
RegistrationsApi	updateRegistration	PATCH /v2/registrations/{registrationId}	Update Registration
SubscriptionsApi	createSubscription	POST /v2/subscriptions	Create Subscription
SubscriptionsApi	deleteSubscription	DELETE /v2/subscriptions/{subscriptionId}	Delete subscription
SubscriptionsApi	listSubscriptions	GET /v2/subscriptions	List Subscriptions
SubscriptionsApi	retrieveSubscription	GET /v2/subscriptions/{subscriptionId}	Retrieve Subscription
SubscriptionsApi	updateSubscription	PATCH /v2/subscriptions/{subscriptionId}	Update Subscription
TypesApi	listEntityTypes	GET /v2/types/	List Entity Types
TypesApi	retrieveEntityType	GET /v2/types/{entityType}	Retrieve entity type

Documentation for Models

• CreateEntityRequest
• CreateRegistrationRequest
• CreateSubscriptionRequest
• GetAttributeDataResponse
• GetAttributeValueResponse
• ListEntitiesResponse
• ListEntityTypesResponse
• ListRegistrationsResponse
• ListSubscriptionsResponse
• NotifyRequest
• Options
• Options10
• Options12
• Options20
• Options23
• Options3
• Options6
• QueryRequest
• QueryResponse
• ReplaceAllEntityAttributesRequest
• RetrieveApiResourcesResponse
• RetrieveEntityAttributesResponse
• RetrieveEntityResponse
• RetrieveEntityTypeResponse
• RetrieveRegistrationResponse
• UpdateAttributeDataRequest
• UpdateAttributeValueRequest
• UpdateExistingEntityAttributesRequest
• UpdateOrAppendEntityAttributesRequest
• UpdateRegistrationRequest
• UpdateRequest
• UpdateSubscriptionRequest

Documentation for Authorization

Endpoints do not require authorization.

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author