Versions Compared

Key

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

This event would be emitted when workbook has been saved.

Interface

{"msgId": "",
"msgName": 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.

Interface

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

...

Here,

  • wbId

...

  • = workbook identifier

...

  • wbName

...

  • = workbook name

...

...

Examples1.

  1. Success

    Code Block
    {

...

  1. 
    "msgId": "16697102479679127084072174132303",

...

  1. 
    "msgName": "kyvos.viewer.onWorkbookSave",
    "integrationId": "INT_15984490249402127061084151067457",

...

  1. 
    "payload": {

...

  1. 
    "info": {

...

  1. 
    "status": "success",

...

  1. 
    "desc": "Entity saved successfully",
    "code": 0

...

  1. 
    },

...

  1. 
    "data": {

...

  1. 
    "wbId": "Workbook16696262783109127077025192299897",

...

  1. 
    "wbName": "Workbook 1"

...

  1. 
    }
    API: kyvos.viewer.revertWorkbook
    This event would request Kyvos to revert the workbook
    Interface
    }
    }
  2. Failure

    Code Block
    {
    "msgId": "16697102479679127084072174132303",

...

  1. 
    "msgName": "kyvos.viewer.onWorkbookSave", "integrationId": "INT_15984490249402127061084151067457",

...

  1. 
    "payload": {

...

  1. 
    "info": {

...

  1. 
    "status": "failure",

...

  1. 
    "code": -1,

...

  1. 
    "desc": "Error in saving an entity."

...

  1. 
    },

...

  1. 
    "data": {

...

  1. 
    "wbId": "Workbook16696262783109127077025192299897",

...

  1. 
    "wbName": "Workbook 1"

...

  1. 
    }

...

  1. 
    }

...

  1. 
    }

...

  1. Timeout

    Code Block
    {

...

  1. 
    "msgId": "16697102479679127084072174132303",

...

  1. 
    "msgName": "kyvos.viewer.onWorkbookSave", "integrationId": "INT_15984490249402127061084151067457",

...

  1. 
    "payload": {

...

  1. 
    "info": {

...

  1. 
    "status": "failure",

...

  1. 
    "code": -2,

...

  1. 
    "desc": "Timeout error."

...

  1. 
    }

...

  1. 
    }

...

  1. 
    }