---
title: "Common Properties"
description: "Use this section to list the properties of a resource collection. For each property, specify its type and provide a short description."
canonical: "https://helpcenter.veeam.com/docs/styleguide/tw/rest_api_properties.html"
breadcrumb: "Style Guide > Structuring Content > Topic Types > Reference Topic > REST API Reference > Resource Сollection > Common Properties"
dateModified: "2026-09-03"
---

# Common Properties

Use this section to list the properties of a resource collection. For each property, specify its type and provide a short description.

::: note

For reference topics in Veeam technical documentation, we use slightly different rules from those defined in section [Articles](articles.md). However, these rules apply only to articles used in descriptions of parameters and properties. Particularly, when listing the properties of a REST API resource collection, we omit an article in a property description if it is the first word in the description.

:::

::: dropdown
## Example

The resources in the [/FailoverPlans]{.Code_Example} collection have properties that represent failover plan settings. Properties can be used in POST requests as well as for query parameter values in GET requests.

<table style="width:100%;" class="Blue_Table">
  <tr style="vertical-align:top">
    <th style="vertical-align:middle; width:20%;">
      <p>Property</p>
    </th>
    <th style="vertical-align:middle; width:20%;">
      <p>Type</p>
    </th>
    <th style="vertical-align:middle; width:65%;">
      <p>Description</p>
    </th>
  </tr>
  <tr style="vertical-align:top">
    <td style="vertical-align:top; width:20%;">
      <p>name</p>
    </td>
    <td style="vertical-align:top; width:20%;">
      <p>string</p>
    </td>
    <td style="vertical-align:top; width:65%;">
      <p>Name of a failover plan.</p>
    </td>
  </tr>
  <tr style="vertical-align:top">
    <td style="vertical-align:top; width:20%;">
      <p>id</p>
    </td>
    <td style="vertical-align:top; width:20%;">
      <p>string</p>
    </td>
    <td style="vertical-align:top; width:65%;">
      <p>System ID assigned to a failover plan in Orchestrator RESTful API.</p>
    </td>
  </tr>
  <tr style="vertical-align:top">
    <td style="vertical-align:top; width:20%;">
      <p>contactName</p>
    </td>
    <td style="vertical-align:top; width:20%;">
      <p>string</p>
    </td>
    <td style="vertical-align:top; width:65%;">
      <p>Contact name of a person responsible for monitoring Orchestrator performance.</p>
    </td>
  </tr>
  <tr style="vertical-align:top">
    <td style="vertical-align:top; width:20%;">
      <p>contactEmail</p>
    </td>
    <td style="vertical-align:top; width:20%;">
      <p>string</p>
    </td>
    <td style="vertical-align:top; width:65%;">
      <p>Contact email of a person responsible for monitoring Orchestrator performance.</p>
    </td>
  </tr>
  <tr style="vertical-align:top">
    <td style="vertical-align:top; width:20%;">
      <p>contactTel</p>
    </td>
    <td style="vertical-align:top; width:20%;">
      <p>string</p>
    </td>
    <td style="vertical-align:top; width:65%;">
      <p>Telephone number of a person responsible for monitoring Orchestrator performance.</p>
    </td>
  </tr>
  <tr style="vertical-align:top">
    <td style="vertical-align:top; width:20%;">
      <p>description</p>
    </td>
    <td style="vertical-align:top; width:20%;">
      <p>string</p>
    </td>
    <td style="vertical-align:top; width:65%;">
      <p>Description of a failover plan.</p>
    </td>
  </tr>
</table>

:::