Jump to: navigation, search

Pulse Restful Web Service API

Create external data for display in Pulse by using the Pulse Restful Web Service API.

Important
The API is subject to change at any time without notice.


  • /api/wbrt/layouts

    [+] GET

    [+] POST

  • /api/wbrt/layouts/<id>

    [+] GET

    [+] PUT

    [+] DELETE

  • /api/wbrt/layouts/<id>/snapshot

    [+] GET

    [+] POST

  • /api/wbrt/layouts/<id>/snapshots

    [+] GET

  • /api/wbrt/widgets

    [+] POST

  • /api/wbrt/widgets/<id>

    [+] GET

    [+] PUT

    [+] DELETE

  • /api/wbrt/dashboards

    [+] GET

  • /api/wbrt/dashboards/<id>/widgets

    [+] GET

    [+] POST

  • /api/plugins/wbrt/health

    [+] GET

Generic Layout Definition Example

  [{
    "definition": {
        "tenant_dbid": 1,
        "refresh_interval": 15,
        "layout_type": "ltGENERIC",
        "column": [
            {
                "category": "ccDIMENSION",
                "is_delta_key": true,
                "id": "_Object$ID"
            },
            {
                "category": "ccDIMENSION",
                "is_delta_key": true,
                "id": "_Object$Type"
            },
            {
                "category": "ccDIMENSION",
                "id": "_Object$Name",
                "format": "string"
            },
            {
                "category": "ccMEASURE",
                "vt": "vINT",
                "id": "First_column",
                "type": "ctGENERIC",
                "format": "integer",
                "label": "First"
            },
            {
                "category": "ccMEASURE",
                "vt": "vINT",
                "id": "Second_column",
                "type": "ctGENERIC",
                "format": "time",
                "label": "Second"
            },
            {
                "category": "ccMEASURE",
                "vt": "vSTR",
                "id": "Third_column",
                "type": "ctGENERIC",
                "format": "string",
                "label": "Third"
            }
        ],
        "default_widget": {
            "threshold": [
                {
                    "value": [
                        0,
                        0,
                        0
                    ],
                    "direction_up": false,
                    "column_id": "First_column"
                }
            ],
            "view": [
                {
                    "column_selector": [
                        "Second_column"
                    ],
                    "sorting": [
                        {
                            "is_asc": true
                        }
                    ],
                    "type": "BarView"
                }
            ],
            "id": -1,
            "size": "1x4",
            "label": "Test  Widget"
        },
        "name": "Third party source",
        "description": "Example of third party source"
    },
    "id": 3,
    "state": {
        "requested_status": "stACTIVE",
        "body_hash_1": 583854940,
        "body_hash_2": 583854940
    }
}]

Layout Snapshot Example

 [{
    "layout_id": 3,
    "col": [
        {
            "v": [
                101,
                102,
                103,
                104,
                105,
                106,
                107,
                108,
                109,
                110
            ],
            "col": {
                "category": "ccDIMENSION",
                "is_delta_key": true,
                "vt": "vINT",
                "id": "_Object$ID"
            }
        },
        {
            "v": [
                "Agent",
                "Agent",
                "Agent",
                "Agent",
                "Agent",
                "Agent",
                "Agent",
                "Agent",
                "Agent",
                "Agent"
            ],
            "col": {
                "category": "ccDIMENSION",
                "vt": "vSTR",
                "id": "_Object$Type"
            }
        },
        {
            "v": [
                "Agent1",
                "Agent2",
                "Agent3",
                "Agent4",
                "Agent5",
                "Agent6",
                "Agent7",
                "Agent8",
                "Agent9",
                "Agent10"
            ],
            "col": {
                "category": "ccDIMENSION",
                "vt": "vSTR",
                "id": "_Object$Name"
            }
        },
        {
            "v": [
                60,
                120,
                180,
                234,
                123,
                531,
                521,
                231,
                541,
                634
            ],
            "col": {
                "category": "ccMEASURE",
                "vt": "vINT",
                "id": "First_column",
                "type": "ctGENERIC",
                "format": "integer",
                "label": "First"
            }
        },
        {
            "v": [
                523,
                0,
                312,
                543,
                631,
                434,
                423,
                642,
                743,
                135
            ],
            "col": {
                "category": "ccMEASURE",
                "vt": "vINT",
                "id": "Second_column",
                "type": "ctGENERIC",
                "format": "time",
                "label": "Second"
            }
        },
        {
            "v": [
                "Value1",
                "Value2",
                "Value3",
                "Value4",
                "Value5",
                "Value6",
                "Value7",
                "Value8",
                "Value9",
                "Value10"
            ],
            "col": {
                "category": "ccMEASURE",
                "vt": "vSTR",
                "id": "Third_column",
                "type": "ctGENERIC",
                "format": "string",
                "label": "Third"
            }
        }
    ],
    "state": {
        "current_status": "stACTIVE",
        "body_hash_1": 583854940,
        "body_hash_2": 583854940
    },
    "layout_type": "ltGENERIC",
    "timestamp": 1408098466350
}]

Widget Example

[{
    "id": 2,
    "layout_id": 3,
    "label": "MyWidget",
    "size": "1x4",
    "owner_user_name": "default",
    "view": [{
        "type": "BarView",
        "column_selector": ["Login_Duration"],
        "sorting": [{
            "is_asc": false
        }]
    }]
}]
Retrieved from "https://docs.genesys.com/Documentation:EZP:Deploy:Web:8.5.01 (2019-07-20 02:26:16)"
This page was last modified on December 16, 2014, at 13:38.

Feedback

Comment on this article:

blog comments powered by Disqus