Jump to

• Request
• Response
• Examples

Update Widget Privilege

put

/serviceapi/savedsearchModel/privilege

To share a widget, the user executing the call must have MANAGE privileges or be the OMC admin.

• sharePublic defines if the widget is going to be public
• privilegeType defines if the widget is going to be shared with VIEW or MANAGE privilege
• userName is optional, not defining this will make the widget available to all

Request

Body ()

This is the object you must send in the body to update a privilege.

Root Schema : UpdateWidgetPrivilege

Type: object

This is the object you must send in the body to update a privilege.

Show Source

• privilegeType: integer(int32)

  The type of privilege you want to update.

  0 = VIEW

  1 = MANAGE

  Example: 1
• searchId: string(BigInteger)
  The widget id.

  Example: 1234
• sharePublic: integer(int32)
  This value determines if this privilege is available to the public.

  Example: 0
• userName: string
  The name of the user.

  Example: demouser

{
    "type":"object",
    "required":[
        "searchId",
        "privilegeType",
        "sharePublic",
        "userName"
    ],
    "properties":{
        "searchId":{
            "type":"string",
            "format":"BigInteger",
            "example":1234,
            "description":"The widget id."
        },
        "privilegeType":{
            "type":"integer",
            "format":"int32",
            "example":"1",
            "description":"<p>The type of privilege you want to update.\n</p><p>0 = VIEW</p><p>1 = MANAGE</p>"
        },
        "sharePublic":{
            "type":"integer",
            "format":"int32",
            "example":"0",
            "description":"This value determines if this privilege is available to the public."
        },
        "userName":{
            "type":"string",
            "example":"demouser",
            "description":"The name of the user."
        }
    },
    "description":"<p>This is the object you must send in the body to update a privilege.</p>"
}

Back to Top

Response

Supported Media Types

• application/json

204 Response

Success

Back to Top

Examples

Create a new JSON file called update.json and paste the following:

{
  "searchId": "5432361245",
  "privilegeType": 0,
  "sharePublic": 0,
  "userName": "demouser"
}

This cURL call will update the privileges of demouser for the widget with searchId: 5432361245:

curl -u ${OMC_USERNAME}:${PASSWORD} -X PUT -H "Content-Type:application/json" "https://{OMC_URL}/serviceapi/savedSearchModel/privilege" -d "@update.json"

Example of Response

The following shows an example of the response body.

{
  "searchId": "5432361245",
  "id": "10",
  "privilegeType": 0,
  "sharePublic": 0,
  "userName": "demouser"
}

Back to Top