API: kyvos.viewer.db.openLinkCardsDialog

This event is used to request Kyvos to open the Link Cards dialog box.

This API will only work in Design Mode.
This API will not work if the dashboard has not been loaded or if cards are still loading in the dashboard.

{
  "msgId": "",
  "msgName": "kyvos.viewer.db.openLinkCardsDialog",
  "payload": {}
}

Example

{
    "msgId": 1699992099368,
    "msgName": "kyvos.viewer.db.openLinkCardsDialog",
    "payload": {}
}

EVENT: kyvos.viewer.db.onLinkCardsDialogOpen

This event would be emitted when link cards dialog has been opened.

{
    "msgId": '',
    "msgName": "kyvos.viewer.db.onLinkCardsDialogOpen",
    "payload": {
        "info": {
            "status": "",
            "desc": ".",
            "extDesc": "",
            "code": 0
        }
    }
}

Example

{
      "msgId": 1699991339314,
    "msgName": "kyvos.viewer.db.onLinkCardsDialogOpen",
    "payload": {
        "info": {
            "status": "failure",
            "desc": "Unable to open link card dialog as cards are still loading on dashboard.",
            "extDesc": "",
            "code": -1
        },
        "data": null
    }
}
{
       "msgId": 1699991866607,
    "msgName": "kyvos.viewer.db.onLinkCardsDialogOpen",
    "payload": {
        "info": {
            "status": "failure",
            "desc": "Unable to open link card dialog in the view mode.",
            "extDesc": "",
            "code": -1
        }
    }
}
{
    "msgId": 1699992099368,
    "msgName": "kyvos.viewer.db.onLinkCardsDialogOpen",
    "payload": {
        "info": {
            "status": "success",
            "desc": "Link cards dialog opened successfully.",
            "extDesc": "",
            "code": 0
        },
        "data": null
    }
}

EVENT: kyvos.viewer.db.onLinkCardsSave

This event is triggered when save button is clicked.

Changes made in the Link Card dialog are saved locally only; the HostApp needs to save the workbook to persist changes made in the Link Card dialog.

{
    "msgId": "",
    "msgName": "kyvos.viewer.db.onLinkCardsSave",
    "payload": {
        "info": {
            "status": "",
            "desc": ".",
            "extDesc": "",
            "code": 0
        },
        "data": {
            "wbId": "",
            "wbName": "",
            "dbId": ""
        }
    }
}

Example

{
    "integrationId": "",
    "msgId": "17000303566349127093020180894970",
    "msgName": "kyvos.viewer.db.onLinkCardsSave",
    "payload": {
        "info": {
            "status": "success",
            "desc": "Cards linking has been saved successfully.",
            "extDesc": "",
            "code": 0
        },
        "data": {
            "wbId": "Workbook16923503201220127012065183529073",
            "wbName": "WidgetIssue",
            "dbId": "Dashboard16923504218561127089022178620568"
        }
    }
}

HTTP Status 429 – Too Many Requests

API: kyvos.viewer.db.openLinkCardsDialog

EVENT: kyvos.viewer.db.onLinkCardsDialogOpen

EVENT: kyvos.viewer.db.onLinkCardsSave

HTTP Status 429 – Too Many Requests