REST API - get

vapi metadata privilege service operation: get

Retrieves the privilege information about an operation element corresponding to operation_id contained in the service element corresponding to service_id.

Request:

HTTP request

POST https://{server}/rest/com/vmware/vapi/metadata/privilege/service/operation/id:{service_id}?~action=get

Path Parameters

Name	Type	Description
Required
service_id	string	Identifier of the service element.

{
"operation_id": "obj-103"
}

<?xml version="1.0" ?>
<ns0:Get-Input xmlns:ns0="http://vmware.com/vapi/metadata/privilege/service/operation" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<operation_id>obj-103</operation_id>
</ns0:Get-Input>

Request Body Parameters:

Name	Type	Description
bold = required
operation_id	string	Identifier of the operation element.

Response:

HTTP Status Code: 200

Representations:

JSON
XML

{
    "value": {
        "privilege_info": [
            {
                "privileges": [
                    "string",
                    "string"
                ],
                "property_path": "string"
            },
            {
                "privileges": [
                    "string",
                    "string"
                ],
                "property_path": "string"
            }
        ],
        "privileges": [
            "string",
            "string"
        ]
    }
}

<?xml version="1.0" ?>
<ns0:Get-Result xmlns:ns0="http://vmware.com/vapi/metadata/privilege/service/operation" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value>
    <privilege_info-array>
      <array-item>
        <privileges-array>
          <array-item>string</array-item>
          <array-item>string</array-item>
        </privileges-array>
        <property_path>string</property_path>
      </array-item>
      <array-item>
        <privileges-array>
          <array-item>string</array-item>
          <array-item>string</array-item>
        </privileges-array>
        <property_path>string</property_path>
      </array-item>
    </privilege_info-array>
    <privileges-array>
      <array-item>string</array-item>
      <array-item>string</array-item>
    </privileges-array>
  </value>
</ns0:Get-Result>

Response Type:

Name	Type	Description
bold = required
value	operation_info	The vapi.metadata.privilege.operation_info instance that corresponds to `operation_id`.
value.privileges	string[]	List of all privileges assigned to the operation element.
value.privilege_info	privilege_info[]	Privilege information of all the parameter elements of the operation element. For an explanation of containment of privilege information within parameter elements, see vapi.metadata.privilege.privilege_info.
value.privilege_info[].property_path	string	The `property_path` points to an entity that is used in the operation element. An entity can either be present in one of the parameter elements or if a parameter is a structure element, it could also be present in one of the field elements. If the privilege is assigned to an entity used in the parameter, `property_path` will just contain the name of the parameter field. If the privilege is assigned to an entity in one of the field elements of a parameter element that is a structure element, then `property_path` will contain a path to the field element starting from the parameter name.
value.privilege_info[].privileges	string[]	List of privileges assigned to the entity that is being referred by vapi.metadata.privilege.privilege_info.property_path.

Errors:

HTTP Status Code	Type	Description
404	not_found	if the service element associated with `service_id` does not exist.