TOM

::: {.app-desc} TOM API :::

::: {.app-desc} More information: https://helloreverb.com :::

::: {.app-desc} Contact Info: hello\@helloreverb.com :::

::: {.app-desc} Version: 1.0.0 :::

::: {.app-desc} BasePath:/ :::

::: {.license-info} All rights reserved :::

::: {.license-url} http://apache.org/licenses/LICENSE-2.0.html :::

Access

[Methods]{#__Methods}

[ Jump to Models ]

Table of Contents

::: {.method-summary} :::

Default

• get /analyze
• get /comparGraph
• get /correlation
• get /explain
• get /explainGraph
• get /head
• get /read
• get /tail

[Default]{#Default}

::: {.method} []{#analyzeGet}

::: {.method-path} Up{.up}

get /analyze

:::

::: {.method-summary} analyze data ([analyzeGet]{.nickname}) :::

::: {.method-notes} to order the data TOM analysis :::

Query parameters {#query-parameters .field-label}

::: {.field-items} ::: {.param} input (required) :::

::: {.param-desc} [Query Parameter]{.param-type} --- pasted input variables names (seperated by:). Improvement/next version -> give an array of string default: deploy_scenario:version:pod_name:runner_id format: string :::

::: {.param} output (required) :::

::: {.param-desc} [Query Parameter]{.param-type} --- the output variable name default: bandwidth.MBps. format: string ::: :::

Return type {#return-type .field-label}

::: {.return-type} array[Success] :::

Example data {#example-data .field-label}

::: {.example-data-content-type} Content-Type: application/json :::

[ {
  "result" : "aeiou",
  "durationInSeconds" : "aeiou"
} ]

Produces {#produces .field-label}

This API call produces the following media types according to the [Accept]{.header} request header; the media type will be conveyed by the [Content-Type]{.heaader} response header.

• application/json

Responses {#responses .field-label}

200 {#section .field-label}

analyzing file succeeded

default {#default-2 .field-label}

Unexpected error Error :::

---

::: {.method} []{#comparGraphGet}

::: {.method-path} Up{.up}

get /comparGraph

:::

::: {.method-summary} compare different contexts ([comparGraphGet]{.nickname}) :::

::: {.method-notes} compare different contexts using boxplots :::

Query parameters {#query-parameters-1 .field-label}

::: {.field-items} ::: {.param} input (required) :::

::: {.param-desc} [Query Parameter]{.param-type} --- pasted input variables names (seperated by:). Improvement/next version -> give an array of string default: deploy_scenario:version:pod_name:runner_id format: string :::

::: {.param} output (required) :::

::: {.param-desc} [Query Parameter]{.param-type} --- the output variable name default: bandwidth.MBps. format: string :::

::: {.param} limit (optional) :::

::: {.param-desc} [Query Parameter]{.param-type} --- number of contexts to limit the results on default: 10 format: integer ::: :::

Return type {#return-type-1 .field-label}

::: {.return-type} array[Graph] :::

Example data {#example-data-1 .field-label}

::: {.example-data-content-type} Content-Type: application/json :::

[ { } ]

Produces {#produces-1 .field-label}

This API call produces the following media types according to the [Accept]{.header} request header; the media type will be conveyed by the [Content-Type]{.heaader} response header.

• application/json

Responses {#responses-1 .field-label}

200 {#section-1 .field-label}

contexts boxplots

default {#default-3 .field-label}

Unexpected error Error :::

---

::: {.method} []{#correlationGet}

::: {.method-path} Up{.up}

get /correlation

:::

::: {.method-summary} bivariate correlations ([correlationGet]{.nickname}) :::

::: {.method-notes} get bivariate correlations between input and output :::

Return type {#return-type-2 .field-label}

::: {.return-type} array[Value] :::

Example data {#example-data-2 .field-label}

::: {.example-data-content-type} Content-Type: application/json :::

[ {
  "value" : 0.8008281904610115
} ]

Produces {#produces-2 .field-label}

This API call produces the following media types according to the [Accept]{.header} request header; the media type will be conveyed by the [Content-Type]{.heaader} response header.

• application/json

Responses {#responses-2 .field-label}

200 {#section-2 .field-label}

correlation values

default {#default-4 .field-label}

Unexpected error Error :::

---

::: {.method} []{#explainGet}

::: {.method-path} Up{.up}

get /explain

:::

::: {.method-summary} growing mutual correlations ([explainGet]{.nickname}) :::

::: {.method-notes} get growing mutual correlation values between output and subsets of input :::

Return type {#return-type-3 .field-label}

::: {.return-type} array[Value] :::

Example data {#example-data-3 .field-label}

::: {.example-data-content-type} Content-Type: application/json :::

[ {
  "value" : 0.8008281904610115
} ]

Produces {#produces-3 .field-label}

This API call produces the following media types according to the [Accept]{.header} request header; the media type will be conveyed by the [Content-Type]{.heaader} response header.

• application/json

Responses {#responses-3 .field-label}

200 {#section-3 .field-label}

mutual correlation values

default {#default-5 .field-label}

Unexpected error Error :::

---

::: {.method} []{#explainGraphGet}

::: {.method-path} Up{.up}

get /explainGraph

:::

::: {.method-summary} growing mutual correlations graph ([explainGraphGet]{.nickname}) :::

::: {.method-notes} get growing mutual correlation values graph between output and subsets of input :::

Return type {#return-type-4 .field-label}

::: {.return-type} array[Graph] :::

Example data {#example-data-4 .field-label}

::: {.example-data-content-type} Content-Type: application/json :::

[ { } ]

Produces {#produces-4 .field-label}

This API call produces the following media types according to the [Accept]{.header} request header; the media type will be conveyed by the [Content-Type]{.heaader} response header.

• application/json

Responses {#responses-4 .field-label}

200 {#section-4 .field-label}

mutual correlation values graph

default {#default-6 .field-label}

Unexpected error Error :::

---

::: {.method} []{#headGet}

::: {.method-path} Up{.up}

get /head

:::

::: {.method-summary} head contexts according to input ([headGet]{.nickname}) :::

::: {.method-notes} get head median output values of single contexts defined by input variables :::

Query parameters {#query-parameters-2 .field-label}

::: {.field-items} ::: {.param} input (required) :::

::: {.param-desc} [Query Parameter]{.param-type} --- pasted input variables names (seperated by:). Improvement/next version -> give an array of string default: deploy_scenario:version:pod_name:runner_id format: string :::

::: {.param} output (required) :::

::: {.param-desc} [Query Parameter]{.param-type} --- the output variable name default: bandwidth.MBps. format: string :::

::: {.param} limit (optional) :::

::: {.param-desc} [Query Parameter]{.param-type} --- number of contexts to limit the results on default: 5 format: integer ::: :::

Return type {#return-type-5 .field-label}

::: {.return-type} array[Value] :::

Example data {#example-data-5 .field-label}

::: {.example-data-content-type} Content-Type: application/json :::

[ {
  "value" : 0.8008281904610115
} ]

Produces {#produces-5 .field-label}

This API call produces the following media types according to the [Accept]{.header} request header; the media type will be conveyed by the [Content-Type]{.heaader} response header.

• application/json

Responses {#responses-5 .field-label}

200 {#section-5 .field-label}

mutual correlation values

default {#default-7 .field-label}

Unexpected error Error :::

---

::: {.method} []{#readGet}

::: {.method-path} Up{.up}

get /read

:::

::: {.method-summary} load data ([readGet]{.nickname}) :::

::: {.method-notes} to order the data loading :::

Query parameters {#query-parameters-3 .field-label}

::: {.field-items} ::: {.param} file (required) :::

::: {.param-desc} [Query Parameter]{.param-type} --- path of the file to load. default: examples/test_opnfv_yardstick_tc012.csv format: string ::: :::

Return type {#return-type-6 .field-label}

::: {.return-type} array[Success] :::

Example data {#example-data-6 .field-label}

::: {.example-data-content-type} Content-Type: application/json :::

[ {
  "result" : "aeiou",
  "durationInSeconds" : "aeiou"
} ]

Produces {#produces-6 .field-label}

This API call produces the following media types according to the [Accept]{.header} request header; the media type will be conveyed by the [Content-Type]{.heaader} response header.

• application/json

Responses {#responses-6 .field-label}

200 {#section-6 .field-label}

reading file succeeded

default {#default-8 .field-label}

Unexpected error Error :::

---

::: {.method} []{#tailGet}

::: {.method-path} Up{.up}

get /tail

:::

::: {.method-summary} tail contexts according to input ([tailGet]{.nickname}) :::

::: {.method-notes} get tail median output values of single contexts defined by input variables :::

Query parameters {#query-parameters-4 .field-label}

::: {.field-items} ::: {.param} input (required) :::

::: {.param-desc} [Query Parameter]{.param-type} --- pasted input variables names (seperated by:). Improvement/next version -> give an array of string default: deploy_scenario:version:pod_name:runner_id format: string :::

::: {.param} output (required) :::

::: {.param-desc} [Query Parameter]{.param-type} --- the output variable name default: bandwidth.MBps. format: string :::

::: {.param} limit (optional) :::

::: {.param-desc} [Query Parameter]{.param-type} --- number of contexts to limit the results on default: 5 format: integer ::: :::

Return type {#return-type-7 .field-label}

::: {.return-type} array[Value] :::

Example data {#example-data-7 .field-label}

::: {.example-data-content-type} Content-Type: application/json :::

[ {
  "value" : 0.8008281904610115
} ]

Produces {#produces-7 .field-label}

This API call produces the following media types according to the [Accept]{.header} request header; the media type will be conveyed by the [Content-Type]{.heaader} response header.

• application/json

Responses {#responses-7 .field-label}

200 {#section-7 .field-label}

mutual correlation values

default {#default-9 .field-label}

Unexpected error Error :::

---

[Models]{#__Models}

[ Jump to Methods ]

Table of Contents

1. Error -
2. Graph -
3. Success -
4. Value -

::: {.model}

[Error -]{#Error} Up{.up}

::: {.model-description} :::

::: {.field-items} ::: {.param} code (optional) :::

::: {.param-desc} [Integer]{.param-type} format: int32 :::

::: {.param} message (optional) :::

::: {.param-desc} [String]{.param-type} :::

::: {.param} fields (optional) :::

::: {.param-desc} [String]{.param-type} ::: ::: :::

::: {.model}

[Graph -]{#Graph} Up{.up}

::: {.model-description} :::

::: {.field-items} ::: :::

::: {.model}

[Success -]{#Success} Up{.up}

::: {.model-description} :::

::: {.field-items} ::: {.param} result (optional) :::

::: {.param-desc} [String]{.param-type} :::

::: {.param} durationInSeconds (optional) :::

::: {.param-desc} [String]{.param-type} ::: ::: :::

::: {.model}

[Value -]{#Value} Up{.up}

::: {.model-description} :::

::: {.field-items} ::: {.param} value (optional) :::

::: {.param-desc} [Double]{.param-type} Value format: double ::: ::: :::