Jump to

• Request
• Response
• Examples

List Widget Privileges

get

/serviceapi/savedsearchModel/privilege/searches/{searchId}

Get all users and their privileges for the widget with assigned searchId.

Request

Path Parameters

• searchId: string(BigInteger)
  The id of the widget. The id of a widget 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 : SuccessfulWidgetOperation

Type: object

Describes the status of a successful dashboard privilege job.

Show Source

• id: string(BigInteger)
  The id of this privilege.

  Example: 1111
• privilegeType: integer(int32)

  The type of privilege this user has.

  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. Values: 0 - Not shared to public | 1 - Shared to public

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

  Example: demouser

{
    "type":"object",
    "required":[
        "searchId",
        "id",
        "privilegeType",
        "sharePublic",
        "userName"
    ],
    "properties":{
        "searchId":{
            "type":"string",
            "format":"BigInteger",
            "example":"1234",
            "description":"The widget id."
        },
        "id":{
            "type":"string",
            "format":"BigInteger",
            "example":"1111",
            "description":"The id of this privilege."
        },
        "privilegeType":{
            "type":"integer",
            "format":"int32",
            "example":"1",
            "description":"<p>The type of privilege this user has.\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. Values: 0 - Not shared to public | 1 - Shared to public"
        },
        "userName":{
            "type":"string",
            "example":"demouser",
            "description":"The name of the user."
        }
    },
    "description":"<p>Describes the status of a successful dashboard privilege job.</p>"
}

Back to Top

Examples

This cURL call will get all privileges for the widget with searchId: 224539289422508326854773742250788775317:

curl -u ${OMC_USERNAME}:${PASSWORD} -X PUT -H "Content-Type:application/json" "https://{OMC_URL}/serviceapi/savedsearchModel/privilege/searches/224539289422508326854773742250788775317

Example of Response

The following shows an example of the response body.

[
  {
    "id": "224539289422508326854773742250788775317",
    "searchId": "224539289422508326854773742250788775317",
    "userName": "demouser11",
    "privilegeType": 1,
    "sharePublic": 0
  },
  {
    "id": "275296792035496777079871095615163281208",
    "searchId": "224539289422508326854773742250788775317",
    "userName": "demouser12",
    "privilegeType": 1,
    "sharePublic": 0
  },
  {
    "id": "16438695726700466074624371628058196045",
    "searchId": "224539289422508326854773742250788775317",
    "userName": "demouser12",
    "privilegeType": 0,
    "sharePublic": 0
  },
  {
    "id": "77706015873064916931271251334886964675",
    "searchId": "224539289422508326854773742250788775317",
    "userName": "demouser12",
    "privilegeType": 0,
    "sharePublic": 1
  }
]

Back to Top