REST API - list

appliance recovery backup parts: list

Get a list of the backup parts

Request:

HTTP request

GET https://{server}/rest/appliance/recovery/backup/parts

No request parameters

Response:

HTTP Status Code: 200

Representations:

JSON
XML

{
    "value": [
        {
            "description": {
                "args": [
                    "string",
                    "string"
                ],
                "default_message": "string",
                "id": "string"
            },
            "id": "obj-103",
            "name": {
                "args": [
                    "string",
                    "string"
                ],
                "default_message": "string",
                "id": "string"
            },
            "optional": true,
            "selected_by_default": true
        },
        {
            "description": {
                "args": [
                    "string",
                    "string"
                ],
                "default_message": "string",
                "id": "string"
            },
            "id": "obj-103",
            "name": {
                "args": [
                    "string",
                    "string"
                ],
                "default_message": "string",
                "id": "string"
            },
            "optional": true,
            "selected_by_default": true
        }
    ]
}

<?xml version="1.0" ?>
<ns0:List-Result xmlns:ns0="http://vmware.com/appliance/recovery/backup/parts" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <value-array>
    <array-item>
      <id>obj-103</id>
      <description>
        <default_message>string</default_message>
        <id>string</id>
        <args-array>
          <array-item>string</array-item>
          <array-item>string</array-item>
        </args-array>
      </description>
      <optional>true</optional>
      <selected_by_default>true</selected_by_default>
      <name>
        <default_message>string</default_message>
        <id>string</id>
        <args-array>
          <array-item>string</array-item>
          <array-item>string</array-item>
        </args-array>
      </name>
    </array-item>
    <array-item>
      <id>obj-103</id>
      <description>
        <default_message>string</default_message>
        <id>string</id>
        <args-array>
          <array-item>string</array-item>
          <array-item>string</array-item>
        </args-array>
      </description>
      <optional>true</optional>
      <selected_by_default>true</selected_by_default>
      <name>
        <default_message>string</default_message>
        <id>string</id>
        <args-array>
          <array-item>string</array-item>
          <array-item>string</array-item>
        </args-array>
      </name>
    </array-item>
  </value-array>
</ns0:List-Result>

Response Type:

Name	Type	Description
bold = required
value	part[]	list of parts.
value[].id	string	part ID When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `com.vmware.appliance.recovery.backup.parts`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `com.vmware.appliance.recovery.backup.parts`.
value[].name	localizable_message	part name id in message bundle
value[].name.id	string	id in message bundle
value[].name.default_message	string	text in english
value[].name.args	string[]	nested data
value[].description	localizable_message	part description id in message bundle
value[].description.id	string	id in message bundle
value[].description.default_message	string	text in english
value[].description.args	string[]	nested data
value[].selected_by_default	boolean	Is part selected by default in UI
value[].optional	boolean	Estimated size of this piece

Errors:

HTTP Status Code	Type	Description
500	error	Generic error