Associate existing schedule policy to existing plan

This operation associates an existing schedule policy to an existing plan.

Path Parameters

planId string required

Header Parameters

Accept string required

application/json

Request Body

summary object
plan object
planId integer
schedule object
task object
taskId integer

Responses

application/json

Schema
Example (from schema)
Example 1

Schema

plan object
definesStorage object
definesEntity boolean
overrideEntity integer
securityAssociations object
associations object[]
userOrGroup object[]
userGroupName string
userGroupId integer
_type_ integer
properties object
isCreatorAssociation boolean
role object
_type_ integer
roleId integer
roleName string
ownerAssociations object
featureInfo object
edgedriveInfo object
enableNotificationsForShares boolean
auditDriveActivities boolean
edgeDriveAssociations object
definesEdgeDriveInfo object
definesEntity boolean
overrideEntity integer
inheritance object
isSealed boolean
storage object
storagePolicy object
storagePolicyName string
storagePolicyId integer
copy object[]
copyType integer
active integer
isDefault integer
isSnapCopy integer
copyPrecedence integer
dedupeFlags object
enableDASHFull integer
pauseAndRecoverCurrentDDB integer
useGlobalDedupStore integer
automaticallyPauseAndRecoverDDB integer
enableDeduplication integer
enableClientSideDedup integer
retentionRules object
retainBackupDataForCycles integer
jobs integer
retainArchiverDataForDays integer
retainBackupDataForDays integer
StoragePolicyCopy object
copyId integer
copyName string
extendedFlags object
drivePool object
drivePoolName string
drivePoolId integer
library object
libraryName string
libraryId integer
useGlobalPolicy object
storagePolicyName string
storagePolicyId integer
definesSchedule object
definesEntity boolean
overrideEntity integer
laptop object
features object
categoryPermission object
accessPolicies object
categoryPermission object
definesAccessPolicies object
definesEntity boolean
overrideEntity integer
content object
definesSubclientWin object
definesEntity boolean
overrideEntity integer
definesSubclientMac object
definesEntity boolean
overrideEntity integer
definesSubclientLin object
definesEntity boolean
overrideEntity integer
users object
definesFeatures object
definesEntity boolean
overrideEntity integer
operationWindow object
ruleId integer
replicationTargets object
database object
slaInMinutes integer
rpoInMinutes integer
scheduleLog object
task object
storageLog object
storagePolicy object
definesScheduleLog object
definesEntity boolean
overrideEntity integer
definesStorageLog object
definesEntity boolean
overrideEntity integer
options object
forcedArchiving boolean
quota integer
encryptionInfo object
encryptKeyLength integer
directMediaAccess integer
cipherType integer
encryptionSettings integer
definition object
possible integer[]
required integer[]
definesEEPolicy object
definesEntity boolean
overrideEntity integer
summary object
slaInMinutes integer
restrictions integer
type integer
slaInterval integer
planStatusFlag integer
numDevices integer
rpoInMinutes integer
subtype integer
isElastic boolean
numUsers integer
addons object
permissions object[]
permissionId integer
planOwner object
_type_ integer
userName string
userId integer
plan object
planSubtype integer
_type_ integer
planType integer
planName string
planId integer
fullOperationWindow object
ruleId integer
alerts object
schedule object
task object
taskId integer
associatedEntitiesCount object
snapSubclients integer
eDiscoveryInfo object
definesContentAnalyzerCloud object
definesEntity boolean
overrideEntity integer
definesAnalyticsIndexServer object
definesEntity boolean
overrideEntity integer
exchange object
definesMBRetention object
definesEntity boolean
overrideEntity integer
definesMBCleanup object
definesEntity boolean
overrideEntity integer
definesMBArchiving object
definesEntity boolean
overrideEntity integer
definesMBJournal object
definesEntity boolean
overrideEntity integer
definesCIPolicy object
definesEntity boolean
overrideEntity integer
errors object[]
entity object
status object
errorMessage string
errorCode integer

{
  "plan": {
    "definesStorage": {
      "definesEntity": true,
      "overrideEntity": 0
    },
    "securityAssociations": {
      "associations": [
        {
          "userOrGroup": [
            {
              "userGroupName": "string",
              "userGroupId": 0,
              "_type_": 0
            }
          ],
          "properties": {
            "isCreatorAssociation": true,
            "role": {
              "_type_": 0,
              "roleId": 0,
              "roleName": "string"
            }
          }
        }
      ],
      "ownerAssociations": {}
    },
    "featureInfo": {
      "edgedriveInfo": {
        "enableNotificationsForShares": true,
        "auditDriveActivities": true,
        "edgeDriveAssociations": {}
      },
      "definesEdgeDriveInfo": {
        "definesEntity": true,
        "overrideEntity": 0
      }
    },
    "inheritance": {
      "isSealed": true
    },
    "storage": {
      "storagePolicy": {
        "storagePolicyName": "string",
        "storagePolicyId": 0
      },
      "copy": [
        {
          "copyType": 0,
          "active": 0,
          "isDefault": 0,
          "isSnapCopy": 0,
          "copyPrecedence": 0,
          "dedupeFlags": {
            "enableDASHFull": 0,
            "pauseAndRecoverCurrentDDB": 0,
            "useGlobalDedupStore": 0,
            "automaticallyPauseAndRecoverDDB": 0,
            "enableDeduplication": 0,
            "enableClientSideDedup": 0
          },
          "retentionRules": {
            "retainBackupDataForCycles": 0,
            "jobs": 0,
            "retainArchiverDataForDays": 0,
            "retainBackupDataForDays": 0
          },
          "StoragePolicyCopy": {
            "copyId": 0,
            "copyName": "string"
          },
          "extendedFlags": {},
          "drivePool": {
            "drivePoolName": "string",
            "drivePoolId": 0
          },
          "library": {
            "libraryName": "string",
            "libraryId": 0
          },
          "useGlobalPolicy": {
            "storagePolicyName": "string",
            "storagePolicyId": 0
          }
        }
      ]
    },
    "definesSchedule": {
      "definesEntity": true,
      "overrideEntity": 0
    },
    "laptop": {
      "features": {
        "categoryPermission": {}
      },
      "accessPolicies": {
        "categoryPermission": {}
      },
      "definesAccessPolicies": {
        "definesEntity": true,
        "overrideEntity": 0
      },
      "content": {
        "definesSubclientWin": {
          "definesEntity": true,
          "overrideEntity": 0
        },
        "definesSubclientMac": {
          "definesEntity": true,
          "overrideEntity": 0
        },
        "definesSubclientLin": {
          "definesEntity": true,
          "overrideEntity": 0
        }
      },
      "users": {},
      "definesFeatures": {
        "definesEntity": true,
        "overrideEntity": 0
      }
    },
    "operationWindow": {
      "ruleId": 0
    },
    "replicationTargets": {},
    "database": {
      "slaInMinutes": 0,
      "rpoInMinutes": 0,
      "scheduleLog": {
        "task": {}
      },
      "storageLog": {
        "storagePolicy": {}
      },
      "definesScheduleLog": {
        "definesEntity": true,
        "overrideEntity": 0
      },
      "definesStorageLog": {
        "definesEntity": true,
        "overrideEntity": 0
      }
    },
    "options": {
      "forcedArchiving": true,
      "quota": 0,
      "encryptionInfo": {
        "encryptKeyLength": 0,
        "directMediaAccess": 0,
        "cipherType": 0,
        "encryptionSettings": 0
      }
    },
    "definition": {
      "possible": [
        0
      ],
      "required": [
        0
      ]
    },
    "definesEEPolicy": {
      "definesEntity": true,
      "overrideEntity": 0
    },
    "summary": {
      "slaInMinutes": 0,
      "restrictions": 0,
      "type": 0,
      "slaInterval": 0,
      "planStatusFlag": 0,
      "numDevices": 0,
      "rpoInMinutes": 0,
      "subtype": 0,
      "isElastic": true,
      "numUsers": 0,
      "addons": {},
      "permissions": [
        {
          "permissionId": 0
        }
      ],
      "planOwner": {
        "_type_": 0,
        "userName": "string",
        "userId": 0
      },
      "plan": {
        "planSubtype": 0,
        "_type_": 0,
        "planType": 0,
        "planName": "string",
        "planId": 0
      }
    },
    "fullOperationWindow": {
      "ruleId": 0
    },
    "alerts": {},
    "schedule": {
      "task": {
        "taskId": 0
      }
    },
    "associatedEntitiesCount": {
      "snapSubclients": 0
    },
    "eDiscoveryInfo": {
      "definesContentAnalyzerCloud": {
        "definesEntity": true,
        "overrideEntity": 0
      },
      "definesAnalyticsIndexServer": {
        "definesEntity": true,
        "overrideEntity": 0
      }
    },
    "exchange": {
      "definesMBRetention": {
        "definesEntity": true,
        "overrideEntity": 0
      },
      "definesMBCleanup": {
        "definesEntity": true,
        "overrideEntity": 0
      },
      "definesMBArchiving": {
        "definesEntity": true,
        "overrideEntity": 0
      },
      "definesMBJournal": {
        "definesEntity": true,
        "overrideEntity": 0
      }
    },
    "definesCIPolicy": {
      "definesEntity": true,
      "overrideEntity": 0
    }
  },
  "errors": [
    {
      "entity": {},
      "status": {
        "errorMessage": "string",
        "errorCode": 0
      }
    }
  ]
}

{
  "plan": {
    "definesStorage": {
      "definesEntity": true,
      "overrideEntity": 0
    },
    "securityAssociations": {
      "associations": [
        {
          "userOrGroup": [
            {
              "userGroupName": "master",
              "userGroupId": 1,
              "_type_": 15
            }
          ],
          "properties": {
            "isCreatorAssociation": true,
            "role": {
              "_type_": 120,
              "roleId": 10,
              "roleName": "Plan Creator Role"
            }
          }
        }
      ],
      "ownerAssociations": {}
    },
    "featureInfo": {
      "edgedriveInfo": {
        "enableNotificationsForShares": false,
        "auditDriveActivities": false,
        "edgeDriveAssociations": {}
      },
      "definesEdgeDriveInfo": {
        "definesEntity": false,
        "overrideEntity": 0
      }
    },
    "inheritance": {
      "isSealed": true
    },
    "storage": {
      "storagePolicy": {
        "storagePolicyName": "NewManPlan",
        "storagePolicyId": 59
      },
      "copy": [
        {
          "copyType": 1,
          "active": 1,
          "isDefault": 1,
          "isSnapCopy": 0,
          "copyPrecedence": 1,
          "dedupeFlags": {
            "enableDASHFull": 1,
            "pauseAndRecoverCurrentDDB": 1,
            "useGlobalDedupStore": 1,
            "automaticallyPauseAndRecoverDDB": 1,
            "enableDeduplication": 1,
            "enableClientSideDedup": 1
          },
          "retentionRules": {
            "retainBackupDataForCycles": 1,
            "jobs": 0,
            "retainArchiverDataForDays": -1,
            "retainBackupDataForDays": 30
          },
          "StoragePolicyCopy": {
            "copyId": 59,
            "copyName": "Primary"
          },
          "extendedFlags": {},
          "drivePool": {
            "drivePoolName": "DrivePool(bdcsrvtest04)30",
            "drivePoolId": 30
          },
          "library": {
            "libraryName": "testpoolLibrary",
            "libraryId": 30
          },
          "useGlobalPolicy": {
            "storagePolicyName": "testpool",
            "storagePolicyId": 42
          }
        }
      ]
    },
    "definesSchedule": {
      "definesEntity": true,
      "overrideEntity": 0
    },
    "laptop": {
      "features": {
        "categoryPermission": {}
      },
      "accessPolicies": {
        "categoryPermission": {}
      },
      "definesAccessPolicies": {
        "definesEntity": false,
        "overrideEntity": 0
      },
      "content": {
        "definesSubclientWin": {
          "definesEntity": false,
          "overrideEntity": 0
        },
        "definesSubclientMac": {
          "definesEntity": false,
          "overrideEntity": 0
        },
        "definesSubclientLin": {
          "definesEntity": false,
          "overrideEntity": 0
        }
      },
      "users": {},
      "definesFeatures": {
        "definesEntity": false,
        "overrideEntity": 0
      }
    },
    "operationWindow": {
      "ruleId": 0
    },
    "replicationTargets": {},
    "database": {
      "slaInMinutes": 0,
      "rpoInMinutes": 0,
      "scheduleLog": {
        "task": {}
      },
      "storageLog": {
        "storagePolicy": {}
      },
      "definesScheduleLog": {
        "definesEntity": false,
        "overrideEntity": 0
      },
      "definesStorageLog": {
        "definesEntity": false,
        "overrideEntity": 0
      }
    },
    "options": {
      "forcedArchiving": false,
      "quota": 0,
      "encryptionInfo": {
        "encryptKeyLength": 128,
        "directMediaAccess": 0,
        "cipherType": 2,
        "encryptionSettings": 3
      }
    },
    "definition": {
      "possible": [
        1,
        2,
        4,
        8,
        16,
        32,
        64,
        128,
        256,
        512,
        1024,
        2048,
        4096,
        8192,
        16384,
        32768,
        65536,
        65537,
        65538,
        65539,
        65540,
        65541,
        65542,
        65543,
        65544
      ],
      "required": [
        1,
        4
      ]
    },
    "definesEEPolicy": {
      "definesEntity": false,
      "overrideEntity": 0
    },
    "summary": {
      "slaInMinutes": 240,
      "restrictions": 1,
      "type": 2,
      "slaInterval": 0,
      "planStatusFlag": 0,
      "numDevices": 0,
      "rpoInMinutes": 240,
      "subtype": 33554437,
      "isElastic": false,
      "numUsers": 0,
      "addons": {},
      "permissions": [
        {
          "permissionId": 1
        },
        {
          "permissionId": 2
        },
        {
          "permissionId": 3
        },
        {
          "permissionId": 4
        },
        {
          "permissionId": 5
        },
        {
          "permissionId": 6
        },
        {
          "permissionId": 7
        },
        {
          "permissionId": 8
        },
        {
          "permissionId": 9
        },
        {
          "permissionId": 10
        },
        {
          "permissionId": 11
        },
        {
          "permissionId": 12
        },
        {
          "permissionId": 13
        },
        {
          "permissionId": 15
        },
        {
          "permissionId": 16
        },
        {
          "permissionId": 18
        },
        {
          "permissionId": 20
        },
        {
          "permissionId": 22
        },
        {
          "permissionId": 24
        },
        {
          "permissionId": 25
        },
        {
          "permissionId": 26
        },
        {
          "permissionId": 27
        },
        {
          "permissionId": 29
        },
        {
          "permissionId": 31
        },
        {
          "permissionId": 32
        },
        {
          "permissionId": 33
        },
        {
          "permissionId": 34
        },
        {
          "permissionId": 35
        },
        {
          "permissionId": 36
        },
        {
          "permissionId": 38
        },
        {
          "permissionId": 39
        },
        {
          "permissionId": 40
        },
        {
          "permissionId": 41
        },
        {
          "permissionId": 42
        },
        {
          "permissionId": 101
        },
        {
          "permissionId": 102
        },
        {
          "permissionId": 107
        },
        {
          "permissionId": 134
        },
        {
          "permissionId": 135
        },
        {
          "permissionId": 136
        },
        {
          "permissionId": 137
        },
        {
          "permissionId": 139
        },
        {
          "permissionId": 140
        },
        {
          "permissionId": 142
        },
        {
          "permissionId": 143
        },
        {
          "permissionId": 145
        },
        {
          "permissionId": 146
        },
        {
          "permissionId": 147
        },
        {
          "permissionId": 148
        },
        {
          "permissionId": 149
        },
        {
          "permissionId": 150
        },
        {
          "permissionId": 156
        },
        {
          "permissionId": 157
        },
        {
          "permissionId": 158
        },
        {
          "permissionId": 159
        },
        {
          "permissionId": 178
        },
        {
          "permissionId": 215
        },
        {
          "permissionId": 217
        }
      ],
      "planOwner": {
        "_type_": 13,
        "userName": "Administrator",
        "userId": 1
      },
      "plan": {
        "planSubtype": 33554437,
        "_type_": 158,
        "planType": 2,
        "planName": "NewManPlan",
        "planId": 2
      }
    },
    "fullOperationWindow": {
      "ruleId": 0
    },
    "alerts": {},
    "schedule": {
      "task": {
        "taskId": 1580
      }
    },
    "associatedEntitiesCount": {
      "snapSubclients": 0
    },
    "eDiscoveryInfo": {
      "definesContentAnalyzerCloud": {
        "definesEntity": false,
        "overrideEntity": 0
      },
      "definesAnalyticsIndexServer": {
        "definesEntity": false,
        "overrideEntity": 0
      }
    },
    "exchange": {
      "definesMBRetention": {
        "definesEntity": false,
        "overrideEntity": 0
      },
      "definesMBCleanup": {
        "definesEntity": false,
        "overrideEntity": 0
      },
      "definesMBArchiving": {
        "definesEntity": false,
        "overrideEntity": 0
      },
      "definesMBJournal": {
        "definesEntity": false,
        "overrideEntity": 0
      }
    },
    "definesCIPolicy": {
      "definesEntity": false,
      "overrideEntity": 0
    }
  },
  "errors": [
    {
      "entity": {},
      "status": {
        "errorMessage": "",
        "errorCode": 0
      }
    }
  ]
}

Associate existing schedule policy to existing plan​

Associate existing schedule policy to existing plan