Jump to

• Request
• Response
• Examples

List Widget User History

get

/serviceapi/savedsearchModel/history/users/{userName}

Get all the actions that this user has performed on widgets.

Request

Path Parameters

• userName: string
  The name of the user.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ActionWidget

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
• id: string(BigInteger)
  The id of this action.

  Example: 1111
• searchId: string(BigInteger)
  The id of the widget.

  Example: 5432361245
• searchName: string
  The name of this widget.

  Example: A Public Single Widget
• userName: string
  The user who is receiving this action.

  Example: demouser

{
    "type":"object",
    "required":[
        "id",
        "searchId",
        "searchName",
        "actionTime",
        "userName",
        "actionDetail",
        "actionType"
    ],
    "properties":{
        "id":{
            "type":"string",
            "format":"BigInteger",
            "example":"1111",
            "description":"The id of this action."
        },
        "searchId":{
            "type":"string",
            "format":"BigInteger",
            "example":"5432361245",
            "description":"The id of the widget."
        },
        "searchName":{
            "type":"string",
            "example":"A Public Single Widget",
            "description":"The name of this widget."
        },
        "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 the user with name demouser11 has performed on every saved search:

curl -u ${OMC_USERNAME}:${PASSWORD} -X GET "https://{OMC_URL}/serviceapi/savedsearchModel/history/users/demouser11"

Example of Response

The following shows an example of the response body.

[
  {
    "id": "179512147445335010401639165218493455674",
    "searchId": "224539289422508326854773742250788775317",
    "searchName": "Target - Demo Widget",
    "actionTime": "2019-04-23T14:45:25.215Z",
    "userName": "demouser11",
    "changedData": "SHARE_PUBLIC",
    "actionDetail": "REVOKE_VIEW_PRIVILEGE",
    "actionType": "PRIVILEGE_CHANGE"
  },
  {
    "id": "77706015873064916931271251334886964675",
    "searchId": "224539289422508326854773742250788775317",
    "searchName": "Target - Demo Widget",
    "actionTime": "2019-04-23T14:43:41.895Z",
    "userName": "demouser11",
    "changedData": "SHARE_PUBLIC",
    "actionDetail": "SHARE_VIEW_PRIVILEGE",
    "actionType": "PRIVILEGE_CHANGE"
  },
  {
    "id": "275296792035496777079871095615163281208",
    "searchId": "224539289422508326854773742250788775317",
    "searchName": "Target - Demo Widget",
    "actionTime": "2019-04-23T14:34:15.999Z",
    "userName": "demouser11",
    "changedData": "demouser12",
    "actionDetail": "SHARE_MANAGER_PRIVILEGE",
    "actionType": "PRIVILEGE_CHANGE"
  },
  {
    "id": "22453928942250832685477374225078877531700",
    "searchId": "224539289422508326854773742250788775317",
    "searchName": "Target - Demo Widget",
    "actionTime": "2019-04-23T09:06:33.674Z",
    "userName": "demouser11",
    "actionDetail": "CREATE",
    "actionType": "DATA_CHANGE"
  }
]

Back to Top