Jump to

• Request
• Response
• Examples

List Dashboard History

get

/serviceapi/dashboardModel/history/dashboards/{dashboardId}

Get all the actions that were performed on the dashboard with this dashboard id.

Request

Path Parameters

• dashboardId: string(BigInteger)
  The id of the dashboard. The id of a dashboard is displayed as a query parameter in the URL while using Oracle Management Cloud through the user interface.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : Action

Type: object

This is the object that is returned whenever an action is performed.

Show Source

• actionDetail: string
  The value of the action type.

  Values: SHARE_VIEW_PRIVILEGE | REVOKE_VIEW_PRIVILEGE |SHARE_MANAGE_PRIVILEGE |REVOKE_MANAGE_PRIVILEGE |CREATE | EDIT | DELETE | CHANGE_OWNER | WIDGET_DELETE_OUTSIDE | WIDGET_NAMECHANGE_OUTSIDE

  Example: CREATE
• actionTime: string(date-time)
  The time in UTC when the action completed.

  Example: 2017-12-23T21:08:45.998Z
• actionType: string
  The type of action that was performed. Values: DATA_CHANGE | PRIVILEGE_CHANGE

  Example: DATA_CHANGE
• changedData(optional): string
  What data was changed for this action.

  Example: demouser1
• dashboardId: string(BigInteger)
  The id of the dashboard.

  Example: 5432361245
• dashboardName: string
  The name of this dashboard.

  Example: A Public Single Dashboard
• id: string(BigInteger)
  The id of this action.

  Example: 1111
• userName: string
  The user who is receiving this action.

  Example: demouser

{
    "type":"object",
    "required":[
        "id",
        "dashboardId",
        "dashboardName",
        "actionTime",
        "userName",
        "actionDetail",
        "actionType"
    ],
    "properties":{
        "id":{
            "type":"string",
            "format":"BigInteger",
            "example":"1111",
            "description":"The id of this action."
        },
        "dashboardId":{
            "type":"string",
            "format":"BigInteger",
            "example":"5432361245",
            "description":"The id of the dashboard."
        },
        "dashboardName":{
            "type":"string",
            "example":"A Public Single Dashboard",
            "description":"The name of this dashboard."
        },
        "actionTime":{
            "type":"string",
            "format":"date-time",
            "example":"2017-12-23T21:08:45.998Z",
            "description":"The time in UTC when the action completed."
        },
        "userName":{
            "type":"string",
            "example":"demouser",
            "description":"The user who is receiving this action."
        },
        "changedData":{
            "type":"string",
            "example":"demouser1",
            "description":"What data was changed for this action."
        },
        "actionDetail":{
            "type":"string",
            "example":"CREATE",
            "description":"The value of the action type.<p>Values: <tt>SHARE_VIEW_PRIVILEGE | REVOKE_VIEW_PRIVILEGE |SHARE_MANAGE_PRIVILEGE |REVOKE_MANAGE_PRIVILEGE |CREATE | EDIT | DELETE | CHANGE_OWNER | WIDGET_DELETE_OUTSIDE | WIDGET_NAMECHANGE_OUTSIDE</tt></p>"
        },
        "actionType":{
            "type":"string",
            "example":"DATA_CHANGE",
            "description":"The type of action that was performed. Values: <tt>DATA_CHANGE | PRIVILEGE_CHANGE</tt>"
        }
    },
    "description":"<p>This is the object that is returned whenever an action is performed.</p>"
}

Back to Top

Examples

This cURL call will get all the actions that were performed on the dashboard with dashboardId: 5432361245:

curl -u ${OMC_USERNAME}:${PASSWORD} -X GET "https://{OMC_URL}/serviceapi/dashboardModel/history/dashboards/5432361245"

Example of Response

The following shows an example of the response body.

[
    {
        "id": "1",
        "dashboardId": "5432361245",
        "dashboardName": "A Public Single Dashboard",
        "actionTime": "2019-04-23T12:46:13.346+0000",
        "userName": "demouser",
        "changedData": "demouser1",
        "actionDetail": "REVOKE_MANAGER_PRIVILEGE",
        "actionType": "PRIVILEGE_CHANGE"
    },
    {
        "id": "2",
        "dashboardId": "5432361245",
        "dashboardName": "A Public Single Dashboard",
        "actionTime": "2019-04-23T12:39:38.563+0000",
        "userName": "demouser",
        "changedData": "demouser1",
        "actionDetail": "REVOKE_VIEW_PRIVILEGE",
        "actionType": "PRIVILEGE_CHANGE"
    },
    {
        "id": "3",
        "dashboardId": "5432361245",
        "dashboardName": "A Public Single Dashboard",
        "actionTime": "2019-04-23T11:55:35.838+0000",
        "userName": "demouser",
        "changedData": "demouser1",
        "actionDetail": "SHARE_MANAGER_PRIVILEGE",
        "actionType": "PRIVILEGE_CHANGE"
    },
    {
        "id": "4",
        "dashboardId": "5432361245",
        "dashboardName": "A Public Single Dashboard",
        "actionTime": "2019-04-23T09:14:19.096+0000",
        "userName": "demouser",
        "changedData": "SHARE_PUBLIC",
        "actionDetail": "SHARE_VIEW_PRIVILEGE",
        "actionType": "PRIVILEGE_CHANGE"
    },
    {
        "id": "5",
        "dashboardId": "5432361245",
        "dashboardName": "A Public Single Dashboard",
        "actionTime": "2019-04-23T09:05:51.512+0000",
        "userName": "demouser",
        "actionDetail": "EDIT",
        "actionType": "DATA_CHANGE"
    },
    {
        "id": "6",
        "dashboardId": "5432361245",
        "dashboardName": "A Public Single Dashboard",
        "actionTime": "2019-04-23T09:00:26.377+0000",
        "userName": "demouser",
        "actionDetail": "CREATE",
        "actionType": "DATA_CHANGE"
    }
]

Back to Top