REST API - get

REST API - get

com.vmware.vapi.metadata.privilege.component

The component service provides operations to retrieve privilege information of a component element.

A component element is said to contain privilege information if any one of package elements in it contains privilege information.

get

GET /com/vmware/vapi/metadata/privilege/component/id:{component_id}
POST /com/vmware/vapi/metadata/privilege/component/id:{component_id}?~action=get
POST /com/vmware/vapi/metadata/privilege/component?~action=get

Retrieves privilege information about the component element corresponding to component_id.

The com.vmware.vapi.metadata.privilege.component_data contains the privilege information about the component element and its fingerprint. It contains information about all the package elements that belong to this component element.

Request:
Representations:
{
    "component_id": "obj-103"
}
<?xml version="1.0" ?>
<ns0:Get-Input xmlns:ns0="http://vmware.com/vapi/metadata/privilege/component" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <component_id>obj-103</component_id>
</ns0:Get-Input>
POST /com/vmware/vapi/metadata/privilege/component?~action=get
&component_id=obj-103

Parameters:
Name Type Required Description
component_id
 *
 ID Yes Identifier of the component element. Id of type com.vmware.vapi.component.

Response:
Representations:
{
    "value": {
        "fingerprint": "string",
        "info": {
            "packages": [
                {
                    "key": "obj-103",
                    "value": {
                        "privileges": [
                            "string",
                            "string"
                        ],
                        "services": [
                            {
                                "key": "obj-103",
                                "value": {
                                    "operations": [
                                        {
                                            "key": "obj-103",
                                            "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/component" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value>
    <fingerprint>string</fingerprint>
    <info>
      <packages-array>
        <array-item>
          <value>
            <services-array>
              <array-item>
                <value>
                  <operations-array>
                    <array-item>
                      <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>
                      <key>obj-103</key>
                    </array-item>
                  </operations-array>
                </value>
                <key>obj-103</key>
              </array-item>
            </services-array>
            <privileges-array>
              <array-item>string</array-item>
              <array-item>string</array-item>
            </privileges-array>
          </value>
          <key>obj-103</key>
        </array-item>
      </packages-array>
    </info>
  </value>
</ns0:Get-Result>

Parameters:
Name Type Required Description
result component_data Yes The com.vmware.vapi.metadata.privilege.component_data instance that corresponds to component_id

Errors:
Type Description HTTP Status Code
not_found if the component element associated with component_id does not have any privilege information. 404

Copyright © 2014. All Rights Reserved.