API Visualizations

GET /projects/{project}/datasets/{dataset}/inferences/{inference}/visualizations

Description: Retrieves the specified page of visualizations

Request:

URI Params:
- project (String) Project identifier
- dataset (String) Dataset identifier
- inference (String) Inference identifier
Query String:
- page (Integer, Optional) Page to retrieve. Default value is 0
Example:

curl --location --request GET 'http://localhost:8080/projects/8fdaea41-23ca-42cc-a3aa-063bb42bb842/datasets/eb6e9c65-8230-4b75-9ecf-d7d453b67102/inferences/4af95b39-7ca8-40f8-87f8-617dd961fb73/visualizations?provider=google'
--header 'Authorization: Bearer {Access Token}'

Success Response:

Status Code: 200 OK
Content: A list of objects with the resumed information of the visualizations
Content Type:
- application/json
Schema:

[
   {
      "id": String
   },
   ...
]

Example:

[{"id": "c965f4ae-f31c-48ad-8fcf-266c8d0281aa"}, {"id": "12c1da88-e997-49d8-be2e-9820245f6ce1"}]

Error Responses:

400 Bad Request
401 Unauthorized

Role: User

GET /projects/{project}/datasets{dataset}/inferences/{inference}/visualizations/{visualization}

Description: Retrieves the specified visualization

Request:

URI Params:
- project (String) Project identifier
- dataset (String) Dataset identifier
- inference (String) Inference identifier
- visualization (String) Visualization identifier
Example:

curl --location --request GET 'http://localhost:8080/projects/8fdaea41-23ca-42cc-a3aa-063bb42bb842/datasets/eb6e9c65-8230-4b75-9ecf-d7d453b67102/inferences/4af95b39-7ca8-40f8-87f8-617dd961fb73/visualizations/c965f4ae-f31c-48ad-8fcf-266c8d0281aa?provider=google'
--header 'Authorization: Bearer {Access Token}'

Success Response:

Status Code: 200 OK
Content: An object with the information of the visualization
Content Type:
- application/json
Schema:

{
   "project_id": String
   "dataset_id": String
   "inference_id": String
   "id": String
   "deprecated": Boolean
   "algorithm": String
   "tree": [{"profile_id": String, "component": Integer, "x": Double, "y": Double}]
}

Example:

{
   "project_id": "8fdaea41-23ca-42cc-a3aa-063bb42bb842",
   "dataset_id": "eb6e9c65-8230-4b75-9ecf-d7d453b67102",
   "inference_id": "4af95b39-7ca8-40f8-87f8-617dd961fb73",
   "id": "c965f4ae-f31c-48ad-8fcf-266c8d0281aa",
   "deprecated": false,
   "algorithm": "radial",
   "tree": [{"profile_id": "1", "component": "1", "x": 1.75, "y": 0.0}]
}

Error Responses:

404 Not Found
401 Unauthorized

Role: User

DELETE /projects/{project}/datasets{dataset}/inferences/{inference}/visualizations/{visualization}

Description: Deprecates the specified visualization

Request:

URI Params:
- project (String) Project identifier
- dataset (String) Dataset identifier
- inference (String) Inference identifier
- visualization (String) Visualization identifier
Example:

curl --location --request DELETE 'http://localhost:8080/projects/8fdaea41-23ca-42cc-a3aa-063bb42bb842/datasets/eb6e9c65-8230-4b75-9ecf-d7d453b67102/inferences/4af95b39-7ca8-40f8-87f8-617dd961fb73/visualizations/c965f4ae-f31c-48ad-8fcf-266c8d0281aa?provider=google'
--header 'Authorization: Bearer {Access Token}'

Success Response: