openapi-java-client

Landscape omnikeeper REST API

• API version: v1
  • Build date: 2024-05-23T10:57:32.968333211Z[Etc/UTC]
  • Generator version: 7.7.0-SNAPSHOT

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

1. Java 1.8+
2. Maven (3.8.3+)/Gradle (7.2+)

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

Add this dependency to your project's POM:

<dependency>
  <groupId>org.openapitools</groupId>
  <artifactId>openapi-java-client</artifactId>
  <version>v1</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

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

  dependencies {
     implementation "org.openapitools:openapi-java-client:v1"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/openapi-java-client-v1.jar
• target/lib/*.jar

Getting Started

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

// Import classes:
import org.openapitools.client.ApiClient;
import org.openapitools.client.ApiException;
import org.openapitools.client.Configuration;
import org.openapitools.client.auth.*;
import org.openapitools.client.models.*;
import org.openapitools.client.api.AnsibleInventoryScanIngestApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure OAuth2 access token for authorization: oauth2
    OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
    oauth2.setAccessToken("YOUR ACCESS TOKEN");

    // Configure OAuth2 access token for authorization: oauth2
    OAuth oauth2 = (OAuth) defaultClient.getAuthentication("oauth2");
    oauth2.setAccessToken("YOUR ACCESS TOKEN");

    AnsibleInventoryScanIngestApi apiInstance = new AnsibleInventoryScanIngestApi(defaultClient);
    String writeLayerID = "writeLayerID_example"; // String | 
    List<String> searchLayerIDs = Arrays.asList(); // List<String> | 
    String version = "version_example"; // String | 
    AnsibleInventoryScanDTO ansibleInventoryScanDTO = new AnsibleInventoryScanDTO(); // AnsibleInventoryScanDTO | 
    try {
      apiInstance.ansibleInventoryScanIngestIngestAnsibleInventoryScan(writeLayerID, searchLayerIDs, version, ansibleInventoryScanDTO);
    } catch (ApiException e) {
      System.err.println("Exception when calling AnsibleInventoryScanIngestApi#ansibleInventoryScanIngestIngestAnsibleInventoryScan");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AnsibleInventoryScanIngestApi	ansibleInventoryScanIngestIngestAnsibleInventoryScan	POST /api/v{version}/Ingest/AnsibleInventoryScan
AttributeValueImageApi	attributeValueImageGet	GET /api/v{version}/AttributeValueImage
AttributeValueImageApi	attributeValueImagePost	POST /api/v{version}/AttributeValueImage
AuthRedirectApi	authRedirectIndex	GET /.well-known/openid-configuration
CytoscapeApi	cytoscapeTraitCentric	GET /api/v{version}/Cytoscape/traitCentric
GraphQlApi	graphQLDebug	POST /graphql-debug
GraphQlApi	graphQLGet	GET /graphql
GraphQlApi	graphQLIndex	POST /graphql
GraphvizDotApi	graphvizDotLayerCentric	GET /api/v{version}/GraphvizDot/layerCentric
GraphvizDotApi	graphvizDotTraitCentric	GET /api/v{version}/GraphvizDot/traitCentric
GridViewApi	gridViewAddContext	POST /api/v{version}/GridView/context	Adds new context
GridViewApi	gridViewChangeData	POST /api/v{version}/GridView/contexts/{context}/change	Saves grid view row changes and returns change results
GridViewApi	gridViewDeleteContext	DELETE /api/v{version}/GridView/context/{name}	Deletes specific context
GridViewApi	gridViewEditContext	PUT /api/v{version}/GridView/context/{name}	Edits specific context
GridViewApi	gridViewGetData	GET /api/v{version}/GridView/contexts/{context}/data	Returns grid view data for specific context
GridViewApi	gridViewGetGridViewContext	GET /api/v{version}/GridView/context/{name}	Returns a single context in full
GridViewApi	gridViewGetGridViewContexts	GET /api/v{version}/GridView/contexts	Returns a list of contexts for grid view.
GridViewApi	gridViewGetSchema	GET /api/v{version}/GridView/contexts/{context}/schema	Returns grid view schema for specific context
ImportExportLayerApi	importExportLayerExportLayer	GET /api/v{version}/ImportExportLayer/exportLayer
ImportExportLayerApi	importExportLayerImportLayer	POST /api/v{version}/ImportExportLayer/importLayer
MetadataApi	metadataGetMetadata	GET /api/odata/{context}/$metadata
MetadataApi	metadataGetServiceDocument	GET /api/odata/{context}
OkPluginGenericJsonIngestApi	manageContextGetAllContexts	GET /api/v{version}/ingest/genericJSON/manage/context
OkPluginGenericJsonIngestApi	manageContextGetContext	GET /api/v{version}/ingest/genericJSON/manage/context/{id}
OkPluginGenericJsonIngestApi	manageContextRemoveContext	DELETE /api/v{version}/ingest/genericJSON/manage/context/{id}
OkPluginGenericJsonIngestApi	manageContextUpsertContext	POST /api/v{version}/ingest/genericJSON/manage/context
OkPluginGenericJsonIngestApi	passiveDataIngest	POST /api/v{version}/ingest/genericJSON/data
OkPluginGenericJsonIngestApi	passiveFilesIngest	POST /api/v{version}/ingest/genericJSON/files
OkPluginInsightDiscoveryIngestApi	ingestFileIngest	POST /api/v{version}/ingest/insight-discovery/file
RestartApplicationApi	restartApplicationRestart	GET /api/v{version}/RestartApplication/restart
UsageStatsApi	usageStatsFetch	GET /api/v{version}/UsageStats/fetch

Documentation for Models

• AbstractInboundIDMethod
• AddContextRequest
• AnsibleInventoryScanDTO
• AttributeValueDTO
• AttributeValueType
• ChangeDataCell
• ChangeDataRequest
• EditContextRequest
• EdmContainerElementKind
• EdmExpressionKind
• EdmSchemaElementKind
• EdmTypeKind
• GenericInboundAttribute
• GenericInboundCI
• GenericInboundCIIdMethod
• GenericInboundData
• GenericInboundRelation
• GraphQLQuery
• GridViewColumn
• GridViewConfiguration
• IEdmEntityContainer
• IEdmEntityContainerElement
• IEdmExpression
• IEdmModel
• IEdmSchemaElement
• IEdmTerm
• IEdmType
• IEdmTypeReference
• IEdmVocabularyAnnotation
• InboundIDMethodByAttribute
• InboundIDMethodByAttributeModifiers
• InboundIDMethodByByUnion
• InboundIDMethodByData
• InboundIDMethodByIntersect
• InboundIDMethodByRelatedTempID
• InboundIDMethodByTemporaryCIID
• NoFoundTargetCIHandling
• ODataEntitySetInfo
• ODataFunctionImportInfo
• ODataServiceDocument
• ODataSingletonInfo
• ODataTypeAnnotation
• ProblemDetails
• SameTargetCIHandling
• SameTempIDHandling
• SparseRow

Documentation for Authorization

Authentication schemes defined for the API:

oauth2

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes: N/A

oauth2

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://[keycloak-url]/auth/realms/acme/protocol/openid-connect/auth
• Scopes: N/A

Recommendation

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

Author