Retrieve details of a specific widget like widget name by its ID.

GET 
/visualization/widgets/:id

This endpoint retrieves detailed information about a specific widget using its unique ID. The widget details include widget name, description, category, widget timeline details and other relevant data that can be used to identify the widget. This endpoint is useful for users who need to identify the widget for further performance metrics retrieval from the widget.

Request

Path Parameters

id integerrequired

The unique identifier of the widget to retrieve.

Responses

200

Successful retrieval of the widget details.

application/json

Schema

Schema

oneOf
Widget_Get_By_ID_Response
response-code integerrequired
status stringrequired
result object[]required
Array [
visualization objectrequired
name stringrequired
description stringrequired
category stringrequired
type stringrequired
Visualization.timeline object
relative.timeline string
properties objectrequired
chart object[]required
Array [
legend stringrequired
label stringrequired
]
id integerrequired
]
Widget_Get_By_ID_Response
response-code integerrequired
status stringrequired
result object[]required
Array [
visualization objectrequired
name stringrequired
description stringrequired
category stringrequired
type stringrequired
Visualization.timeline object
relative.timeline string
properties objectrequired
chart object[]required
Array [
legend stringrequired
label stringrequired
]
id integerrequired
]

Example (from schema)

{}

400

The request could not be understood or was missing required parameters.

application/json

Schema

Schema

response-code integer
status string
message string
error.code string

Example (from schema)

{
  "response-code": 400,
  "status": "fail",
  "message": "Bad request",
  "error.code": "MD031"
}

403

The user does not have the necessary permissions to access this widget.

application/json

Schema

Schema

response-code integer
message string
error.code string

Example (from schema)

{
  "response-code": 403,
  "message": "Unauthorized access: Client is not allowed to access API",
  "error.code": "MD022"
}

500

An unexpected error occurred on the server.

application/json

Schema

Schema

result object[]
Array [
response-code integer
status string
message string
error.code string
error string
]

Example (from schema)

{
  "result": [
    {
      "response-code": 500,
      "status": "fail",
      "message": "Internal server exception, Possible reason: Cannot invoke \"String.length()\" because \"content\" is null",
      "error.code": "MD031",
      "error": "io.vertx.core.json.jackson.DatabindCodec.createParser(DatabindCodec.java:116)\n\tat io.vertx.core.json.jackson.DatabindCodec.fromString(DatabindCodec.java:90)\n\tat io.vertx.core.json.Json.decodeValue(Json.java:83)\n\tat io.vertx.core.json.Json.decodeValue(Json.java:95)\n\tat"
    }
  ]
}

Loading...