Overview
HTTP verbs
RESTful notes tries to adhere as closely as possible to standard HTTP and REST conventions in its use of HTTP verbs.
| Verb | Usage |
|---|---|
|
Used to retrieve a resource |
|
Used to create a new resource |
|
Used to update an existing resource |
|
Used to delete an existing resource |
RESTful notes tries to adhere as closely as possible to standard HTTP and REST conventions in its use of HTTP status codes.
| Status code | Usage |
|---|---|
|
The request completed successfully |
|
A new resource has been created successfully. The resource’s URI is available from the response’s
|
|
An update to an existing resource has been applied successfully |
|
The request was malformed. The response body will include an error providing further information |
|
The requested resource did not exist |
Hypermedia
RESTful Notes uses hypermedia and resources include links to other resources in their
responses. Responses are in Hypertext Application
from resource to resource.
Language (HAL) format. Links can be found beneath the _links key. Users of the API should
not create URIs themselves, instead they should use the above-described links to navigate
B2METRIC AI Web Service Documentation
Db Source Related Operations
The Db Source entry point into the service.
Get All Db Sources
A GET request is a used get all to access the db source.
Request structure
Unresolved directive in api.adoc - include::/home/murat/Documents/B2Metric-Projects/dashboard-server/target/generated-snippets/db-source-getall/http-request.adoc[]
Example response
Unresolved directive in api.adoc - include::/home/murat/Documents/B2Metric-Projects/dashboard-server/target/generated-snippets/db-source-getall/http-response.adoc[]
CURL request
Unresolved directive in api.adoc - include::/home/murat/Documents/B2Metric-Projects/dashboard-server/target/generated-snippets/db-source-getall/curl-request.adoc[]
Create Db Source
A POST request is a used to access the db source create.
Request structure
Unresolved directive in api.adoc - include::/home/murat/Documents/B2Metric-Projects/dashboard-server/target/generated-snippets/db-source-save/http-request.adoc[]
Example response
Unresolved directive in api.adoc - include::/home/murat/Documents/B2Metric-Projects/dashboard-server/target/generated-snippets/db-source-save/http-response.adoc[]
CURL request
Unresolved directive in api.adoc - include::/home/murat/Documents/B2Metric-Projects/dashboard-server/target/generated-snippets/db-source-save/curl-request.adoc[]
Delete the Db Source
A DELETE request is used to access the db source delete.
Request structure
Unresolved directive in api.adoc - include::/home/murat/Documents/B2Metric-Projects/dashboard-server/target/generated-snippets/db-source-delete/http-request.adoc[]
Path Parameters
Unresolved directive in api.adoc - include::/home/murat/Documents/B2Metric-Projects/dashboard-server/target/generated-snippets/db-source-delete/path-parameters.adoc[]
Example response
Unresolved directive in api.adoc - include::/home/murat/Documents/B2Metric-Projects/dashboard-server/target/generated-snippets/db-source-delete/http-response.adoc[]
CURL request
Unresolved directive in api.adoc - include::/home/murat/Documents/B2Metric-Projects/dashboard-server/target/generated-snippets/db-source-delete/curl-request.adoc[]
Get the Db Source
A GET request is used to access the db source.
Request structure
Unresolved directive in api.adoc - include::/home/murat/Documents/B2Metric-Projects/dashboard-server/target/generated-snippets/db-source-get/http-request.adoc[]
Path Parameters
Unresolved directive in api.adoc - include::/home/murat/Documents/B2Metric-Projects/dashboard-server/target/generated-snippets/db-source-get/path-parameters.adoc[]
Example response
Unresolved directive in api.adoc - include::/home/murat/Documents/B2Metric-Projects/dashboard-server/target/generated-snippets/db-source-get/http-response.adoc[]
CURL request
Unresolved directive in api.adoc - include::/home/murat/Documents/B2Metric-Projects/dashboard-server/target/generated-snippets/db-source-get/curl-request.adoc[]
Experiment Related Operations
The experiment entry point into the service.
Get All Experiments
A GET request is a used get all to access the experiments.
Request structure
Unresolved directive in api.adoc - include::/home/murat/Documents/B2Metric-Projects/dashboard-server/target/generated-snippets/experiment-getall/http-request.adoc[]
Example response
Unresolved directive in api.adoc - include::/home/murat/Documents/B2Metric-Projects/dashboard-server/target/generated-snippets/experiment-getall/http-response.adoc[]
CURL request
Unresolved directive in api.adoc - include::/home/murat/Documents/B2Metric-Projects/dashboard-server/target/generated-snippets/experiment-getall/curl-request.adoc[]
Create Experiment
A POST request is a used to access the experiment create.
Request structure
Unresolved directive in api.adoc - include::/home/murat/Documents/B2Metric-Projects/dashboard-server/target/generated-snippets/experiment-save/http-request.adoc[]
Example response
Unresolved directive in api.adoc - include::/home/murat/Documents/B2Metric-Projects/dashboard-server/target/generated-snippets/experiment-save/http-response.adoc[]
CURL request
Unresolved directive in api.adoc - include::/home/murat/Documents/B2Metric-Projects/dashboard-server/target/generated-snippets/experiment-save/curl-request.adoc[]
Delete the Experiment
A DELETE request is used to access the experiment delete.
Request structure
Unresolved directive in api.adoc - include::/home/murat/Documents/B2Metric-Projects/dashboard-server/target/generated-snippets/experiment-delete/http-request.adoc[]
Path Parameters
Unresolved directive in api.adoc - include::/home/murat/Documents/B2Metric-Projects/dashboard-server/target/generated-snippets/experiment-delete/path-parameters.adoc[]
Example response
Unresolved directive in api.adoc - include::/home/murat/Documents/B2Metric-Projects/dashboard-server/target/generated-snippets/experiment-delete/http-response.adoc[]
CURL request
Unresolved directive in api.adoc - include::/home/murat/Documents/B2Metric-Projects/dashboard-server/target/generated-snippets/experiment-delete/curl-request.adoc[]
Get the Experiment
A GET request is used to access the experiment.
Request structure
Unresolved directive in api.adoc - include::/home/murat/Documents/B2Metric-Projects/dashboard-server/target/generated-snippets/experiment-get/http-request.adoc[]
Path Parameters
Unresolved directive in api.adoc - include::/home/murat/Documents/B2Metric-Projects/dashboard-server/target/generated-snippets/experiment-get/path-parameters.adoc[]
Example response
Unresolved directive in api.adoc - include::/home/murat/Documents/B2Metric-Projects/dashboard-server/target/generated-snippets/experiment-get/http-response.adoc[]
CURL request
Unresolved directive in api.adoc - include::/home/murat/Documents/B2Metric-Projects/dashboard-server/target/generated-snippets/experiment-get/curl-request.adoc[]