API docs by Redocly

aivis Engine v2 - Constraint Navigator Inference Service - Web-API (0.0.0-master.5224.aec3e3c7x)

Download OpenAPI specification:Download

User Guide

For a high-level understanding of the concepts of this engine, please have a look at the Constraint Navigator User Guide.

The following is a description how to setup and configure this service. All configuration classes are described here.

Failures of the application can lead to following errors:

Get app information (JSON)

Get app information (JSON)

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "label": "string",
  • "project": "string",
  • "build": {
    }
}

Get app information (HTML)

Get app information (HTML)

Responses

Get api contract (ZIP)

Get api contract (ZIP)

Responses

Get api documentation (ZIP)

Get api documentation (ZIP)

Responses

Get api documentation (HTML)

Get api documentation (HTML)

Responses

A request to get all inferences

A request to get all inferences

amf-is: ["X400","X404","X405","X406","X415"]

Responses

Response samples

Content type
application/json
[
  • {
    }
]

A request to get a certain inference

A request to get a certain inference

amf-is: ["X400","X404","X405","X406","X415"]
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "deploymentStatus": "SUCCESS"
}

A request to get a deployed model of a certain inf

A request to get a deployed model of a certain inference id

amf-is: ["X400","X404","X405","X406","X409","X415"]
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "functions": [
    ],
  • "inferenceDataSpecification": {
    },
  • "modelSpecifications": [
    ],
  • "features": [
    ]
}

A request to get inferences of specific timestamps

A request to get inferences of specific timestamps of a certain inference id

amf-is: ["X400","X404","X405","X406","X409","X415","X500"]
path Parameters
id
required
string
query Parameters
timestamps
required
Array of integers <int64> (DtoTime) [ items <int64 > >= 0 ]

The timestamps the inference is desired at

Request Body schema: application/zip
any

The inference data, containing a certain history before each inference timestamp as defined in the model's inference data specification

Responses

Response samples

Content type
application/json
{
  • "_type": "string",
  • "dataPoints": [
    ]
}

A request to get inferences of specific timestamps

A request to get inferences of specific timestamps of a certain inference id with next normal values

amf-is: ["X400","X404","X405","X406","X409","X415","X500"]
path Parameters
id
required
string
query Parameters
timestamps
required
Array of integers <int64> (DtoTime) [ items <int64 > >= 0 ]

The timestamps the inference is desired at

Request Body schema: application/zip
any

The inference data, containing a certain history before each inference timestamp as defined in the model's inference data specification

Responses

Response samples

Content type
application/json
{
  • "_type": "string",
  • "dataPoints": [
    ]
}