Plans For Entity Id

Select

SaaS

Customer Managed

Returns information on a plan for different Entities.

Entities

Path Parameters

• PlanId string required
• entityName string required

Query Parameters

• propertyLevel string

Responses

• 200

---

OK

application/json

• Schema
• Example (from schema)
• Plan - Mailbox Policy Retention
• Plan - Mailbox Policy Archiving - All Properties
• Plan Associated Users and User Groups
• Plan - Log Schedule Policy - All Properties
• Plan - Mailbox Policy Cleanup - All Properties

---

Schema

• policyEntity object

  policyId integer

{
  "policyEntity": {
    "policyId": 0
  }
}

{
  "policyEntity": {
    "policyId": 2
  }
}

{
  "policyType": 1,
  "flags": 536870912,
  "agentType": {
    "appTypeId": 0
  },
  "detail": {
    "emailPolicy": {
      "emailPolicyType": 1,
      "journalPolicy": {
        "exchMailboxOptions": {},
        "contentIndexProps": {
          "previewPathDir": {
            "userAccount": {}
          }
        },
        "excludeMessageClassFilter": {},
        "includeFolderFilter": {},
        "contentStoreOptions": {},
        "excludeFolderFilter": {}
      },
      "archivePolicy": {
        "includeMsgsLargerThan": 0,
        "primaryMailbox": false,
        "includeMsgsOlderThan": 0,
        "archiveMailbox": false,
        "disabledMailbox": true,
        "includeFolderFilter": {},
        "excludeFolderFilter": {},
        "contentIndexProps": {
          "enableContentIndex": false,
          "enablePreviewGeneration": false,
          "deferredDays": 0,
          "previewPathDir": {
            "userAccount": {}
          }
        },
        "excludeMessageClassFilter": {}
      },
      "retentionPolicy": {
        "mediaRetention": 3
      },
      "cleanupPolicy": {
        "excludeMessageClassFilter": {},
        "additionalSettings": {},
        "includeFolderFilter": {},
        "excludeFolderFilter": {}
      }
    },
    "filePolicy": {
      "retentionPolicy": {},
      "contentIndexingPolicy": {
        "dataAccessNodes": {}
      }
    }
  },
  "policyEntity": {
    "policyId": 1,
    "policyName": "Default user mailbox plan Archiving policy"
  }
}

{
  "users": [
    {
      "externalUserGroup": {
        "externalGroupName": "Tenant Users",
        "providerId": 2,
        "groupId": 11,
        "providerDomainName": "Garrett"
      }
    },
    {
      "externalUserGroup": {
        "externalGroupName": "Tenant testadmin",
        "providerId": 4,
        "groupId": 12,
        "providerDomainName": "MS"
      }
    },
    {
      "externalUserGroup": {
        "externalGroupName": "Domain Users",
        "providerId": 5,
        "groupId": 20,
        "providerDomainName": "testlab"
      }
    }
  ]
}

{
  "associations": [
    {
      "srmReportSet": 0,
      "srmTemplateId": 0,
      "subclientId": 0,
      "clientGroupId": 1006,
      "storagePolicyId": 0,
      "copyId": 0,
      "applicationId": 0,
      "backupsetId": 0,
      "instanceId": 0,
      "sidbStoreId": 0,
      "clientId": 0,
      "srmTemplateName": "",
      "agentlessPolicyId": 0,
      "mediaAgentId": 0,
      "workflowId": 0,
      "clientGroupName": "Plan A clients",
      "_type_": 28,
      "trackingPolicyId": 0,
      "flags": {
        "exclude": false
      }
    }
  ],
  "task": {
    "description": "",
    "ownerId": 1,
    "runUserId": 1,
    "taskType": 4,
    "ownerName": "Administrator",
    "alertId": 0,
    "GUID": "50f7fc36-fa5f-4ff9-8d2c-51dc4b11588b",
    "policyType": 0,
    "associatedObjects": 0,
    "taskName": "Plan A",
    "taskId": 67,
    "securityAssociations": {
      "ownerAssociations": {}
    },
    "originalCC": {
      "commCellId": 2
    },
    "taskSecurity": {
      "associatedUserGroups": [
        {
          "userGroupId": 1,
          "_type_": 15,
          "userGroupName": "master"
        },
        {
          "userGroupId": 3,
          "_type_": 15,
          "userGroupName": "View All"
        }
      ],
      "ownerCapabilities": {}
    },
    "createAs": {
      "user": {
        "user": {
          "userName": "testadmin",
          "userId": 1
        }
      }
    },
    "taskFlags": {
      "isEdgeDrive": false,
      "isEZOperation": false,
      "forDDB": false,
      "uninstalled": false,
      "isSystem": false,
      "disabled": false
    },
    "task": {
      "taskName": "Plan A",
      "taskId": 67
    }
  },
  "appGroup": {},
  "subTasks": [
    {
      "subTask": {
        "subTaskOrder": 0,
        "subTaskName": "Incremental Automatic schedule",
        "subTaskType": 2,
        "flags": 65536,
        "operationType": 2,
        "subTaskId": 68,
        "subTask": {
          "subtaskId": 68,
          "subtaskName": "Incremental Automatic schedule"
        }
      },
      "pattern": {
        "active_end_occurence": 0,
        "freq_subday_interval": 0,
        "freq_type": 1024,
        "patternId": 16,
        "flags": 0,
        "description": "",
        "active_end_time": 0,
        "active_end_date": 0,
        "skipOccurence": 0,
        "skipDayNumber": 0,
        "active_start_time": 0,
        "freq_restart_interval": 0,
        "active_start_date": 1505347200,
        "freq_interval": 0,
        "freq_relative_interval": 0,
        "name": "Incremental Automatic schedule",
        "freq_recurrence_factor": 0,
        "calendar": {
          "calendarName": "Standard",
          "calendarId": 1
        },
        "timeZone": {
          "TimeZoneID": 1000
        }
      },
      "options": {
        "backupOpts": {
          "backupLevel": 2,
          "incLevel": 1,
          "runIncrementalBackup": true,
          "cdrOptions": {
            "incremental": true
          },
          "dataOpt": {
            "useCatalogServer": true,
            "followMountPoints": true,
            "daysBetweenSyntheticBackup": 0
          }
        },
        "commonOpts": {
          "automaticSchedulePattern": {
            "maxBackupInterval": 24,
            "ignoreOpWindowPastMaxInterval": false,
            "minBackupIntervalMinutes": 0,
            "maxBackupIntervalMinutes": 0,
            "minSyncInterval": 0,
            "minBackupInterval": 8,
            "minSyncIntervalMinutes": 2,
            "stopIfOnBattery": {
              "enabled": false
            },
            "acPower": {
              "enabled": false
            },
            "specfificNetwork": {
              "enabled": false,
              "ipAddress": {
                "subnet": 24,
                "address": "0.0.0.0"
              }
            },
            "stopSleepIfBackUp": {
              "enabled": false
            },
            "newOrModifiedFile": {
              "enabled": true
            },
            "wiredNetworkConnection": {
              "enabled": false
            },
            "minNetworkBandwidth": {
              "enabled": false
            }
          }
        }
      }
    },
    {
      "subTask": {
        "subTaskOrder": 0,
        "subTaskName": "Space Reclamation",
        "subTaskType": 2,
        "flags": 0,
        "operationType": 2,
        "subTaskId": 69,
        "subTask": {
          "subtaskId": 69,
          "subtaskName": "Space Reclamation"
        }
      },
      "pattern": {
        "active_end_occurence": 0,
        "freq_subday_interval": 0,
        "freq_type": 1024,
        "patternId": 17,
        "flags": 0,
        "description": "",
        "active_end_time": 0,
        "active_end_date": 0,
        "skipOccurence": 0,
        "skipDayNumber": 0,
        "active_start_time": 0,
        "freq_restart_interval": 0,
        "active_start_date": 1505347200,
        "freq_interval": 0,
        "freq_relative_interval": 0,
        "name": "Space Reclamation",
        "freq_recurrence_factor": 0,
        "calendar": {
          "calendarName": "Standard",
          "calendarId": 1
        },
        "timeZone": {
          "TimeZoneID": 1000
        }
      },
      "options": {
        "backupOpts": {
          "truncateLogsOnSource": false,
          "backupLevel": 4,
          "incLevel": 0,
          "runIncrementalBackup": false,
          "doNotTruncateLog": false,
          "vsaBackupOptions": {
            "backupFailedVMsOnly": false
          },
          "dataOpt": {
            "useCatalogServer": true,
            "followMountPoints": true,
            "enforceTransactionLogUsage": false,
            "skipConsistencyCheck": false,
            "createNewIndex": true,
            "daysBetweenSyntheticBackup": 90,
            "autoCopy": true
          }
        },
        "commonOpts": {
          "automaticSchedulePattern": {
            "maxBackupInterval": 72,
            "ignoreOpWindowPastMaxInterval": true,
            "minBackupIntervalMinutes": 15,
            "maxBackupIntervalMinutes": 0,
            "minSyncInterval": 0,
            "minBackupInterval": 0,
            "minSyncIntervalMinutes": 0,
            "stopIfOnBattery": {
              "enabled": false
            },
            "acPower": {
              "enabled": false
            },
            "specfificNetwork": {
              "enabled": false,
              "ipAddress": {
                "subnet": 24,
                "address": "0.0.0.0"
              }
            },
            "stopSleepIfBackUp": {
              "enabled": false
            },
            "newOrModifiedFile": {
              "enabled": false
            },
            "wiredNetworkConnection": {
              "enabled": false
            },
            "minNetworkBandwidth": {
              "enabled": false
            }
          }
        }
      }
    }
  ]
}

{
  "policyType": 1,
  "flags": 536870912,
  "agentType": {
    "appTypeId": 0
  },
  "detail": {
    "emailPolicy": {
      "emailPolicyType": 2,
      "journalPolicy": {
        "exchMailboxOptions": {},
        "contentIndexProps": {
          "previewPathDir": {
            "userAccount": {}
          }
        },
        "excludeMessageClassFilter": {},
        "includeFolderFilter": {},
        "contentStoreOptions": {},
        "excludeFolderFilter": {}
      },
      "archivePolicy": {
        "includeFolderFilter": {},
        "excludeFolderFilter": {},
        "contentIndexProps": {
          "previewPathDir": {
            "userAccount": {}
          }
        },
        "excludeMessageClassFilter": {}
      },
      "retentionPolicy": {
        "mediaRetention": 3
      },
      "cleanupPolicy": {
        "usedDiskSpace": false,
        "createStubs": true,
        "usedDiskSpaceValue": 50,
        "pruneMsgs": false,
        "primaryMailbox": true,
        "disabledMailbox": true,
        "pruneErasedMsgsOrStubs": false,
        "collectMsgsDaysAfter": 0,
        "numOfDaysForSourcePruning": 730,
        "collectMsgsLargerThan": 0,
        "skipUnreadMsgs": false,
        "collectMsgWithAttach": false,
        "leaveMsgBody": false,
        "mailboxQuota": false,
        "truncateBody": false,
        "pruneStubs": false,
        "useExchangeRestriction": true,
        "backupDeletedItemRetention": false,
        "enableMessageRules": false,
        "archiveMailbox": false,
        "archiveIfSize": 90,
        "truncateBodyToBytes": 1024,
        "addRecallLink": true,
        "stopArchiveIfSize": 75,
        "excludeMessageClassFilter": {},
        "additionalSettings": {},
        "includeFolderFilter": {},
        "excludeFolderFilter": {}
      }
    },
    "filePolicy": {
      "retentionPolicy": {},
      "contentIndexingPolicy": {
        "dataAccessNodes": {}
      }
    }
  },
  "policyEntity": {
    "policyId": 3,
    "policyName": "Default user mailbox plan Clean-up policy"
  }
}

Loading...