Jump to

• Request
• Response

N-Nearest Neighbour Search

post

/essbase/rest/v1/ai/applications/{applicationName}/databases/{databaseName}/nnearestneighboursearch

Retrieves the N-Nearest Neighbour.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• applicationName(required): string

  Application name.

• databaseName(required): string

  Database name.

Query Parameters

• aliasType: string

  Alias Table Name.

• responseParam(required): string

  Response paramter.

• threshold: number(double)

  Threshold.

  Default Value: 1
• topMatches(required): integer(int32)

  Top matches.

  Default Value: 1

Body ()

N-Nearest neighbour body data.

Root Schema : NNearestNeighbourDTO

Type: object

Show Source

• data: object data
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "properties":{
        "data":{
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "additionalProperties":{
                    "type":"array",
                    "items":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : data

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "additionalProperties":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

OK

N-Nearest neighbour retrieved successfully.

400 Response

Bad Request

Failed to retrieve n-nearest neighbour.

Back to Top