Versions Compared

Version Old Version 3 New Version Current
Changes made by

Nidhi Bhandari (Unlicensed)

NIDHI BHANDARI

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This event is emitted Applies to: (tick) Kyvos Enterprise  (tick) Kyvos Cloud (SaaS on AWS) (tick) Kyvos AWS Marketplace

(tick) Kyvos Azure Marketplace   (tick) Kyvos GCP Marketplace (tick) Kyvos Single Node Installation (Kyvos SNI)

...

This event is triggered when a workbook is saved.

...

Code Block
{
"msgId": "",
"msgName": "kyvos.viewer.saveWorkbook"}

Here,

  • wbId = workbook identifier

  • wbName = workbook name

Examples

  1. Success

    Code Block
    {
"msgId": "16697102479679127084072174132303",
"msgName": "kyvos.viewer.onWorkbookSave",
"integrationId": "INT_15984490249402127061084151067457",
"payload": {
"info": {
"status": "success",
"desc": "Entity saved successfully",
"code": 0
},
"data": {
"wbId": "Workbook16696262783109127077025192299897",
"wbName": "Workbook 1"
}
API: kyvos.viewer.revertWorkbook
This event would request Kyvos to revert the workbook
Interface
}
}

  2. Failure

    Code Block
    {
"msgId": "16697102479679127084072174132303",
"msgName": "kyvos.viewer.onWorkbookSave", "integrationId": "INT_15984490249402127061084151067457",
"payload": {
"info": {
"status": "failure",
"code": -1,
"desc": "Error in saving an entity."
},
"data": {
"wbId": "Workbook16696262783109127077025192299897",
"wbName": "Workbook 1"
}
}
}

  3. Timeout

    Code Block
    {
"msgId": "16697102479679127084072174132303",
"msgName": "kyvos.viewer.onWorkbookSave", "integrationId": "INT_15984490249402127061084151067457",
"payload": {
"info": {
"status": "failure",
"code": -2,
"desc": "Timeout error."
}
}
}