|
APIs in Category: DfmSchedule |
API version 4.0 |
| DfmScheduleContentGet (supported) | [top] |
Get the content of a given schedule.
Input Name Type DfmScheduleContentGet DfmScheduleContentGet
Output Name Type DfmScheduleContentGetResult DfmScheduleContentGetResult
Error Name Description EACCESSDENIED EDATABASEERROR EOBJECTAMBIGUOUS ESCHEDULEINVALIDINPUT ESCHEDULENOTFOUND
| DfmScheduleCreate (supported) | [top] |
Create a new schedule with the given Name. The schedule Type may be daily, weekly, or monthly.
Input Name Type DfmScheduleCreate DfmScheduleCreate
Output Name Type DfmScheduleCreateResult DfmScheduleCreateResult
Error Name Description EDATABASEERROR ESCHEDULEDUPLICATE ESCHEDULEINVALIDINPUT
| DfmScheduleDailyAdd (supported) | [top] |
Create a single schedule within a daily schedule.
Input Name Type DfmScheduleDailyAdd DfmScheduleDailyAdd
Output Name Type DfmScheduleDailyAddResult DfmScheduleDailyAddResult
Error Name Description EACCESSDENIED EDATABASEERROR EOBJECTAMBIGUOUS ESCHEDULEINVALIDINPUT ESCHEDULENOTFOUND ESCHEDULENOTMODIFIABLE
| DfmScheduleDailyDelete (supported) | [top] |
Delete a single schedule within a daily schedule.
Input Name Type DfmScheduleDailyDelete DfmScheduleDailyDelete
Output Name Type DfmScheduleDailyDeleteResult DfmScheduleDailyDeleteResult
Error Name Description EACCESSDENIED EDATABASEERROR EOBJECTAMBIGUOUS ESCHEDULEINVALIDINPUT ESCHEDULENOTFOUND
| DfmScheduleDailyModify (supported) | [top] |
Modify a single schedule within a daily schedule. Sample schedules cannot be modified.
Input Name Type DfmScheduleDailyModify DfmScheduleDailyModify
Output Name Type DfmScheduleDailyModifyResult DfmScheduleDailyModifyResult
Error Name Description EACCESSDENIED EDATABASEERROR EOBJECTAMBIGUOUS ESCHEDULEINVALIDINPUT ESCHEDULENOTFOUND ESCHEDULENOTMODIFIABLE
| DfmScheduleDependency (supported) | [top] |
Return a list of other DP policies, report schedule and schedules using the specified schedule.
Input Name Type DfmScheduleDependency DfmScheduleDependency
Output Name Type DfmScheduleDependencyResult DfmScheduleDependencyResult
Error Name Description EACCESSDENIED EDATABASEERROR ESCHEDULENOTFOUND
| DfmScheduleDestroy (supported) | [top] |
Delete a schedule with the given Name or ID. A schedule that is used by another schedule(s) may not be deleted and an Error will be returned. Sample schedules cannot be destroyed.
Input Name Type DfmScheduleDestroy DfmScheduleDestroy
Output Name Type DfmScheduleDestroyResult DfmScheduleDestroyResult
Error Name Description EACCESSDENIED EDATABASEERROR EOBJECTAMBIGUOUS ESCHEDULEINUSE ESCHEDULEINVALIDINPUT ESCHEDULENOTFOUND ESCHEDULENOTMODIFIABLE
| DfmScheduleHourlyAdd (supported) | [top] |
Create an hourly schedule within a daily schedule. An hourly schedule specifies the Frequency of schedules To be run within the start time and end time.
Input Name Type DfmScheduleHourlyAdd DfmScheduleHourlyAdd
Output Name Type DfmScheduleHourlyAddResult DfmScheduleHourlyAddResult
Error Name Description EACCESSDENIED EDATABASEERROR EOBJECTAMBIGUOUS ESCHEDULEINVALIDINPUT ESCHEDULENOTFOUND ESCHEDULENOTMODIFIABLE
| DfmScheduleHourlyDelete (supported) | [top] |
Delete an hourly schedule within a daily schedule.
Input Name Type DfmScheduleHourlyDelete DfmScheduleHourlyDelete
Output Name Type DfmScheduleHourlyDeleteResult DfmScheduleHourlyDeleteResult
Error Name Description EACCESSDENIED EDATABASEERROR EOBJECTAMBIGUOUS ESCHEDULEINVALIDINPUT ESCHEDULENOTFOUND
| DfmScheduleHourlyModify (supported) | [top] |
Modify an hourly schedule within a daily schedule. Sample schedules cannot be modified.
Input Name Type DfmScheduleHourlyModify DfmScheduleHourlyModify
Output Name Type DfmScheduleHourlyModifyResult DfmScheduleHourlyModifyResult
Error Name Description EACCESSDENIED EDATABASEERROR EOBJECTAMBIGUOUS ESCHEDULEINVALIDINPUT ESCHEDULENOTFOUND ESCHEDULENOTMODIFIABLE
| DfmScheduleList (supported) | [top] |
List all existing schedule IDs and types.
Input Name Type DfmScheduleList DfmScheduleList
Output Name Type DfmScheduleListResult DfmScheduleListResult
Error Name Description EDATABASEERROR
| DfmScheduleListInfoIterEnd (supported) | [top] |
Tell the DFM station that the temporary store associated with the specified Tag is no longer necessary
Input Name Type DfmScheduleListInfoIterEnd DfmScheduleListInfoIterEnd
Output Name Type DfmScheduleListInfoIterEndResult DfmScheduleListInfoIterEndResult
Error Name Description EINVALIDTAG ESCHEDULEINVALIDINPUT
| DfmScheduleListInfoIterNext (supported) | [top] |
Iterate over the list of schedules stored in the temporary store. The DFM internally maintains a cursor pointing To the last record returned. Subsequent calls To this API will return the Records after the cursor up To the specified "Maximum" or number of actual Records left.
Input Name Type DfmScheduleListInfoIterNext DfmScheduleListInfoIterNext
Output Name Type DfmScheduleListInfoIterNextResult DfmScheduleListInfoIterNextResult
Error Name Description EINVALIDTAG ESCHEDULEINVALIDINPUT
| DfmScheduleListInfoIterStart (supported) | [top] |
The DfmScheduleListInfoIter* set of APIs are used To retrieve a list of schedule contents
Input Name Type DfmScheduleListInfoIterStart DfmScheduleListInfoIterStart
Output Name Type DfmScheduleListInfoIterStartResult DfmScheduleListInfoIterStartResult
Error Name Description EACCESSDENIED EDATABASEERROR EOBJECTAMBIGUOUS ESCHEDULEINVALIDINPUT ESCHEDULENOTFOUND
| DfmScheduleModify (supported) | [top] |
Modify a schedule's details in the database. When the zapi is called, all details within the schedule will be removed and replace by the new details specified in schedule-content. Sample schedules cannot be modified. ScheduleId and ScheduleType cannot be modified.
Input Name Type DfmScheduleModify DfmScheduleModify
Output Name Type DfmScheduleModifyResult DfmScheduleModifyResult
Error Name Description EACCESSDENIED EDATABASEERROR ESCHEDULEDUPLICATE ESCHEDULEINVALIDINPUT ESCHEDULENOTFOUND ESCHEDULENOTMODIFIABLE
| DfmScheduleMonthlyAdd (supported) | [top] |
Specify a single schedule within a monthly schedule. Either DayOfMonth, or both WeekOfMonth and DayOfWeek must be specified.
Input Name Type DfmScheduleMonthlyAdd DfmScheduleMonthlyAdd
Output Name Type DfmScheduleMonthlyAddResult DfmScheduleMonthlyAddResult
Error Name Description EACCESSDENIED EDATABASEERROR EOBJECTAMBIGUOUS ESCHEDULEINVALIDINPUT ESCHEDULENOTFOUND ESCHEDULENOTMODIFIABLE
| DfmScheduleMonthlyDelete (supported) | [top] |
Delete a single schedule within a monthly schedule
Input Name Type DfmScheduleMonthlyDelete DfmScheduleMonthlyDelete
Output Name Type DfmScheduleMonthlyDeleteResult DfmScheduleMonthlyDeleteResult
Error Name Description EACCESSDENIED EDATABASEERROR EOBJECTAMBIGUOUS ESCHEDULEINVALIDINPUT ESCHEDULENOTFOUND
| DfmScheduleMonthlyModify (supported) | [top] |
Modify a single schedule within a monthly schedule. Sample schedules cannot be modified.
Input Name Type DfmScheduleMonthlyModify DfmScheduleMonthlyModify
Output Name Type DfmScheduleMonthlyModifyResult DfmScheduleMonthlyModifyResult
Error Name Description EACCESSDENIED EDATABASEERROR EOBJECTAMBIGUOUS ESCHEDULEINVALIDINPUT ESCHEDULENOTFOUND ESCHEDULENOTMODIFIABLE
| DfmScheduleMonthlySubscheduleSet (supported) | [top] |
Specify a sub-schedule To be used by a monthly schedule. On top of the individual monthly Events, a monthly schedule may only have 1 daily subschedule OR 1 weekly schedule. If this monthly schedule already has a daily or weekly schedule, this command replaces the old one.
Input Name Type DfmScheduleMonthlySubscheduleSet DfmScheduleMonthlySubscheduleSet
Output Name Type DfmScheduleMonthlySubscheduleSetResult DfmScheduleMonthlySubscheduleSetResult
Error Name Description EACCESSDENIED EDATABASEERROR EOBJECTAMBIGUOUS ESCHEDULEINVALIDINPUT ESCHEDULENOTFOUND
| DfmScheduleMonthlySubscheduleUnset (supported) | [top] |
Unset a sub-schedule used by a monthly schedule.
Input Name Type DfmScheduleMonthlySubscheduleUnset DfmScheduleMonthlySubscheduleUnset
Output Name Type DfmScheduleMonthlySubscheduleUnsetResult DfmScheduleMonthlySubscheduleUnsetResult
Error Name Description EACCESSDENIED EDATABASEERROR EOBJECTAMBIGUOUS ESCHEDULEINVALIDINPUT ESCHEDULENOTFOUND
| DfmScheduleRename (supported) | [top] |
Rename a schedule. Sample schedules cannot be renamed.
Input Name Type DfmScheduleRename DfmScheduleRename
Output Name Type DfmScheduleRenameResult DfmScheduleRenameResult
Error Name Description EACCESSDENIED EDATABASEERROR EOBJECTAMBIGUOUS ESCHEDULEDUPLICATE ESCHEDULEINVALIDINPUT ESCHEDULENOTFOUND ESCHEDULENOTMODIFIABLE
| DfmScheduleWeeklyAdd (supported) | [top] |
Specify a single schedule within a weekly schedule.
Input Name Type DfmScheduleWeeklyAdd DfmScheduleWeeklyAdd
Output Name Type DfmScheduleWeeklyAddResult DfmScheduleWeeklyAddResult
Error Name Description EACCESSDENIED EDATABASEERROR EOBJECTAMBIGUOUS ESCHEDULEINVALIDINPUT ESCHEDULENOTFOUND ESCHEDULENOTMODIFIABLE
| DfmScheduleWeeklyDelete (supported) | [top] |
Delete a single schedule within a weekly schedule.
Input Name Type DfmScheduleWeeklyDelete DfmScheduleWeeklyDelete
Output Name Type DfmScheduleWeeklyDeleteResult DfmScheduleWeeklyDeleteResult
Error Name Description EACCESSDENIED EDATABASEERROR EOBJECTAMBIGUOUS ESCHEDULEINVALIDINPUT ESCHEDULENOTFOUND
| DfmScheduleWeeklyModify (supported) | [top] |
Modify a single schedule within a weekly schedule. Sample schedules canot be modified.
Input Name Type DfmScheduleWeeklyModify DfmScheduleWeeklyModify
Output Name Type DfmScheduleWeeklyModifyResult DfmScheduleWeeklyModifyResult
Error Name Description EACCESSDENIED EDATABASEERROR EOBJECTAMBIGUOUS ESCHEDULEINVALIDINPUT ESCHEDULENOTFOUND ESCHEDULENOTMODIFIABLE
| DfmScheduleWeeklySubscheduleAdd (supported) | [top] |
Specify which daily schedule will be used on a certain range of Days within a weekly schedule
Input Name Type DfmScheduleWeeklySubscheduleAdd DfmScheduleWeeklySubscheduleAdd
Output Name Type DfmScheduleWeeklySubscheduleAddResult DfmScheduleWeeklySubscheduleAddResult
Error Name Description EACCESSDENIED EDATABASEERROR EOBJECTAMBIGUOUS ESCHEDULEINVALIDINPUT ESCHEDULENOTFOUND ESCHEDULENOTMODIFIABLE
| DfmScheduleWeeklySubscheduleDelete (supported) | [top] |
Specify which daily schedule To be deleted within a weekly schedule
Input Name Type DfmScheduleWeeklySubscheduleDelete DfmScheduleWeeklySubscheduleDelete
Output Name Type DfmScheduleWeeklySubscheduleDeleteResult DfmScheduleWeeklySubscheduleDeleteResult
Error Name Description EACCESSDENIED EDATABASEERROR EOBJECTAMBIGUOUS ESCHEDULEINVALIDINPUT ESCHEDULENOTFOUND
| DfmScheduleWeeklySubscheduleModify (supported) | [top] |
Specify which daily schedule will be used on a certain range of Days within a weekly schedule. Permenent of sample schedules cannot be modified.
Input Name Type DfmScheduleWeeklySubscheduleModify DfmScheduleWeeklySubscheduleModify
Output Name Type DfmScheduleWeeklySubscheduleModifyResult DfmScheduleWeeklySubscheduleModifyResult
Error Name Description EACCESSDENIED EDATABASEERROR EOBJECTAMBIGUOUS ESCHEDULEINVALIDINPUT ESCHEDULENOTFOUND ESCHEDULENOTMODIFIABLE
| Element definition: DfmScheduleContentGet | [top] |
Get the content of a given schedule.
Name Type Description ScheduleCategory xsd:string
Specifies the category of the schedule. Possible Values are: 'dfm_schedule', 'dp_schedule'. ScheduleNameOrId ObjNameOrId
Name or ID of the schedule
| Element definition: DfmScheduleContentGetResult | [top] |
Name Type Description ScheduleContentInfo ScheduleContentInfo
Details of a schedule
| Element definition: DfmScheduleCreate | [top] |
Create a new schedule with the given Name. The schedule Type may be daily, weekly, or monthly.
Name Type Description ScheduleContentInfo ScheduleContentInfo
Details of a schedule
| Element definition: DfmScheduleCreateResult | [top] |
Name Type Description ScheduleId ObjId
A unique ID of the schedule
| Element definition: DfmScheduleDailyAdd | [top] |
Create a single schedule within a daily schedule.
Name Type Description DailyContent WrapperOfDailyInfo
Content of the daily schedule. DailyScheduleNameOrId ObjNameOrId
Name or ID of a daily schedule ScheduleCategory xsd:string
Specifies the category of the schedule. Possible Values are: 'dfm_schedule', 'dp_schedule'.
| Element definition: DfmScheduleDailyAddResult | [top] |
Name Type Description ItemId xsd:integer
An ID of the daily item within the schedule
| Element definition: DfmScheduleDailyDelete | [top] |
Delete a single schedule within a daily schedule.
Name Type Description DailyScheduleNameOrId ObjNameOrId
Name or ID of a daily schedule ItemId xsd:integer
An ID of the daily item within the schedule. Range: [1..(2^31)-1] ScheduleCategory xsd:string
Specifies the category of the schedule. Possible Values are: 'dfm_schedule', 'dp_schedule'.
| Element definition: DfmScheduleDailyDeleteResult | [top] |
[none]
| Element definition: DfmScheduleDailyModify | [top] |
Modify a single schedule within a daily schedule. Sample schedules cannot be modified.
Name Type Description DailyContent WrapperOfDailyInfo
Content of the daily schedule. DailyScheduleNameOrId ObjNameOrId
Name or ID of a daily schedule ScheduleCategory xsd:string
Specifies the category of the schedule. Possible Values are: 'dfm_schedule', 'dp_schedule'.
| Element definition: DfmScheduleDailyModifyResult | [top] |
[none]
| Element definition: DfmScheduleDependency | [top] |
Return a list of other DP policies, report schedule and schedules using the specified schedule.
Name Type Description ScheduleCategory xsd:string
Specifies the category of the schedule. Possible Values are: 'dfm_schedule', 'dp_schedule'. ScheduleNameOrId ObjNameOrId
Name or identifier of a schedule.
| Element definition: DfmScheduleDependencyResult | [top] |
Name Type Description ScheduleAssignees ArrayOfScheduleAssignee
List of other DP policies, report schedules and schedules using the specified schedule. The list returned will depend on the schedule category. For schedule catedory 'dfm_schedule' only report schedules and the DFM schedules using this schedule will be returned. For schedule category 'dp_schedule' only DP policies and the DP schedules using this schedule will be returned. The list excludes DP policies, report schedules or schedules that the caller has no permissions To read. ScheduleInUse xsd:boolean
For schedule category 'dfm_schedule' this is true if its used by report schedules or DFM schedules. For schedule category 'dp_schedule' this is true if its used by DP policies or DP schedules.
| Element definition: DfmScheduleDestroy | [top] |
Delete a schedule with the given Name or ID. A schedule that is used by another schedule(s) may not be deleted and an Error will be returned. Sample schedules cannot be destroyed.
Name Type Description ScheduleCategory xsd:string
Specifies the category of the schedule. Possible Values are: 'dfm_schedule', 'dp_schedule'. ScheduleNameOrId ObjNameOrId
Name or ID of the schedule
| Element definition: DfmScheduleDestroyResult | [top] |
[none]
| Element definition: DfmScheduleHourlyAdd | [top] |
Create an hourly schedule within a daily schedule. An hourly schedule specifies the Frequency of schedules To be run within the start time and end time.
Name Type Description DailyScheduleNameOrId ObjNameOrId
Name or ID of a daily schedule HourlyContent WrapperOfHourlyInfo
Content of the hourly schedule. ScheduleCategory xsd:string
Specifies the category of the schedule. Possible Values are: 'dfm_schedule', 'dp_schedule'.
| Element definition: DfmScheduleHourlyAddResult | [top] |
Name Type Description ItemId xsd:integer
An ID of the hourly item within the schedule
| Element definition: DfmScheduleHourlyDelete | [top] |
Delete an hourly schedule within a daily schedule.
Name Type Description DailyScheduleNameOrId ObjNameOrId
Name or ID of a daily schedule ItemId xsd:integer
An ID of the hourly item within the schedule. Range: [1..(2^31)-1] ScheduleCategory xsd:string
Specifies the category of the schedule. Possible Values are: 'dfm_schedule', 'dp_schedule'.
| Element definition: DfmScheduleHourlyDeleteResult | [top] |
[none]
| Element definition: DfmScheduleHourlyModify | [top] |
Modify an hourly schedule within a daily schedule. Sample schedules cannot be modified.
Name Type Description DailyScheduleNameOrId ObjNameOrId
Name or ID of a daily schedule HourlyContent WrapperOfHourlyInfo
Content of the hourly schedule. ScheduleCategory xsd:string
Specifies the category of the schedule. Possible Values are: 'dfm_schedule', 'dp_schedule'.
| Element definition: DfmScheduleHourlyModifyResult | [top] |
[none]
| Element definition: DfmScheduleList | [top] |
List all existing schedule IDs and types.
Name Type Description ScheduleCategory xsd:string
Specifies the category of the schedule. Possible Values are: 'dfm_schedule', 'dp_schedule'.
| Element definition: DfmScheduleListInfoIterEnd | [top] |
Tell the DFM station that the temporary store associated with the specified Tag is no longer necessary
Name Type Description Tag xsd:string
An opaque handle used by the DFM station To identify a temporary store.
| Element definition: DfmScheduleListInfoIterEndResult | [top] |
[none]
| Element definition: DfmScheduleListInfoIterNext | [top] |
Iterate over the list of schedules stored in the temporary store. The DFM internally maintains a cursor pointing To the last record returned. Subsequent calls To this API will return the Records after the cursor up To the specified "Maximum" or number of actual Records left.
Name Type Description Maximum xsd:integer
Maximum number of schedules To retrieve Tag xsd:string
An opaque handle used by the DFM station To identify a temporary store.
| Element definition: DfmScheduleListInfoIterNextResult | [top] |
Name Type Description Records xsd:integer
The number of Records actually returned. ScheduleContentList ArrayOfScheduleContentInfo
List of detailed schedule contents
| Element definition: DfmScheduleListInfoIterStart | [top] |
The DfmScheduleListInfoIter* set of APIs are used To retrieve a list of schedule contents
Name Type Description ScheduleCategory xsd:string
Specifies the category of the schedule. Possible Values are: 'dfm_schedule', 'dp_schedule'. ScheduleNameOrId ObjNameOrId
optional
Name or ID of the schedule. If specified, only this schedule is listed.
| Element definition: DfmScheduleListInfoIterStartResult | [top] |
Name Type Description Records xsd:integer
Number of items saved for future retrieval Tag xsd:string
An opaque handle used by the DFM station To identify a temporary store.
| Element definition: DfmScheduleListResult | [top] |
Name Type Description ScheduleList ArrayOfScheduleIdInfo
List of schedule IDs
| Element definition: DfmScheduleModify | [top] |
Modify a schedule's details in the database. When the zapi is called, all details within the schedule will be removed and replace by the new details specified in schedule-content. Sample schedules cannot be modified. ScheduleId and ScheduleType cannot be modified.
Name Type Description ScheduleContentInfo ScheduleContentInfo
Details of a schedule
| Element definition: DfmScheduleModifyResult | [top] |
[none]
| Element definition: DfmScheduleMonthlyAdd | [top] |
Specify a single schedule within a monthly schedule. Either DayOfMonth, or both WeekOfMonth and DayOfWeek must be specified.
Name Type Description MonthlyContent WrapperOfMonthlyInfo
Content of the monthly schedule. MonthlyScheduleNameOrId ObjNameOrId
Name or ID of a weekly schedule ScheduleCategory xsd:string
Specifies the category of the schedule. Possible Values are: 'dfm_schedule', 'dp_schedule'.
| Element definition: DfmScheduleMonthlyAddResult | [top] |
Name Type Description ItemId xsd:integer
An ID of the monthly item within the schedule
| Element definition: DfmScheduleMonthlyDelete | [top] |
Delete a single schedule within a monthly schedule
Name Type Description ItemId xsd:integer
An ID of the monthly item within the schedule. Range: [1..(2^31)-1] MonthlyScheduleNameOrId ObjNameOrId
Name or ID of a weekly schedule ScheduleCategory xsd:string
Specifies the category of the schedule. Possible Values are: 'dfm_schedule', 'dp_schedule'.
| Element definition: DfmScheduleMonthlyDeleteResult | [top] |
[none]
| Element definition: DfmScheduleMonthlyModify | [top] |
Modify a single schedule within a monthly schedule. Sample schedules cannot be modified.
Name Type Description MonthlyContent WrapperOfMonthlyInfo
Content of the monthly schedule. MonthlyScheduleNameOrId ObjNameOrId
Name or ID of a monthly schedule ScheduleCategory xsd:string
Specifies the category of the schedule. Possible Values are: 'dfm_schedule', 'dp_schedule'.
| Element definition: DfmScheduleMonthlyModifyResult | [top] |
[none]
| Element definition: DfmScheduleMonthlySubscheduleSet | [top] |
Specify a sub-schedule To be used by a monthly schedule. On top of the individual monthly Events, a monthly schedule may only have 1 daily subschedule OR 1 weekly schedule. If this monthly schedule already has a daily or weekly schedule, this command replaces the old one.
Name Type Description MonthlyScheduleNameOrId ObjNameOrId
Name or ID of the monthly schedule ScheduleCategory xsd:string
Specifies the category of the schedule. Possible Values are: 'dfm_schedule', 'dp_schedule'. SubscheduleNameOrId ObjNameOrId
Name or ID of the schedule To be used by the monthly schedule
| Element definition: DfmScheduleMonthlySubscheduleSetResult | [top] |
[none]
| Element definition: DfmScheduleMonthlySubscheduleUnset | [top] |
Unset a sub-schedule used by a monthly schedule.
Name Type Description MonthlyScheduleNameOrId ObjNameOrId
Name or ID of the monthly schedule ScheduleCategory xsd:string
Specifies the category of the schedule. Possible Values are: 'dfm_schedule', 'dp_schedule'.
| Element definition: DfmScheduleMonthlySubscheduleUnsetResult | [top] |
[none]
| Element definition: DfmScheduleRename | [top] |
Rename a schedule. Sample schedules cannot be renamed.
Name Type Description NewScheduleName xsd:string
A new unique Name of the schedule ScheduleCategory xsd:string
Specifies the category of the schedule. Possible Values are: 'dfm_schedule', 'dp_schedule'. ScheduleNameOrId ObjNameOrId
Name or ID of the schedule
| Element definition: DfmScheduleRenameResult | [top] |
[none]
| Element definition: DfmScheduleWeeklyAdd | [top] |
Specify a single schedule within a weekly schedule.
Name Type Description ScheduleCategory xsd:string
Specifies the category of the schedule. Possible Values are: 'dfm_schedule', 'dp_schedule'. WeeklyContent WrapperOfWeeklyInfo
Content of the weekly schedule. WeeklyScheduleNameOrId ObjNameOrId
Name or ID of a weekly schedule
| Element definition: DfmScheduleWeeklyAddResult | [top] |
Name Type Description ItemId xsd:integer
An ID of the weekly item within the schedule
| Element definition: DfmScheduleWeeklyDelete | [top] |
Delete a single schedule within a weekly schedule.
Name Type Description ItemId xsd:integer
An ID of the weekly item within the schedule. Range: [1..(2^31)-1] ScheduleCategory xsd:string
Specifies the category of the schedule. Possible Values are: 'dfm_schedule', 'dp_schedule'. WeeklyScheduleNameOrId ObjNameOrId
Name or ID of a weekly schedule
| Element definition: DfmScheduleWeeklyDeleteResult | [top] |
[none]
| Element definition: DfmScheduleWeeklyModify | [top] |
Modify a single schedule within a weekly schedule. Sample schedules canot be modified.
Name Type Description ScheduleCategory xsd:string
Specifies the category of the schedule. Possible Values are: 'dfm_schedule', 'dp_schedule'. WeeklyContent WrapperOfWeeklyInfo
Content of the weekly schedule. WeeklyScheduleNameOrId ObjNameOrId
Name or ID of a weekly schedule
| Element definition: DfmScheduleWeeklyModifyResult | [top] |
[none]
| Element definition: DfmScheduleWeeklySubscheduleAdd | [top] |
Specify which daily schedule will be used on a certain range of Days within a weekly schedule
Name Type Description DailyScheduleNameOrId ObjNameOrId
Name or ID of a daily schedule EndDayOfWeek xsd:integer
Day of week for the schedule. Range: [0..6] (0 = "Sun") ScheduleCategory xsd:string
Specifies the category of the schedule. Possible Values are: 'dfm_schedule', 'dp_schedule'. StartDayOfWeek xsd:integer
Day of week for the schedule. Range: [0..6] (0 = "Sun") WeeklyScheduleNameOrId ObjNameOrId
Name or ID of a weekly schedule
| Element definition: DfmScheduleWeeklySubscheduleAddResult | [top] |
Name Type Description ItemId xsd:integer
An ID of the weekly use item within the schedule. Range: [1..(2^31)-1]
| Element definition: DfmScheduleWeeklySubscheduleDelete | [top] |
Specify which daily schedule To be deleted within a weekly schedule
Name Type Description ItemId xsd:integer
An ID of the weekly use item within the schedule. Range: [1..(2^31)-1] ScheduleCategory xsd:string
Specifies the category of the schedule. Possible Values are: 'dfm_schedule', 'dp_schedule'. WeeklyScheduleNameOrId ObjNameOrId
Name or ID of a weekly schedule
| Element definition: DfmScheduleWeeklySubscheduleDeleteResult | [top] |
[none]
| Element definition: DfmScheduleWeeklySubscheduleModify | [top] |
Specify which daily schedule will be used on a certain range of Days within a weekly schedule. Permenent of sample schedules cannot be modified.
Name Type Description DailyScheduleNameOrId ObjNameOrId
Name or ID of a weekly schedule EndDayOfWeek xsd:integer
Day of week for the schedule. Range: [0..6] (0 = "Sun") ItemId xsd:integer
An ID of the weekly use item within the schedule. Range: [1..(2^31)-1] ScheduleCategory xsd:string
Specifies the category of the schedule. Possible Values are: 'dfm_schedule', 'dp_schedule'. StartDayOfWeek xsd:integer
Day of week for the schedule. Range: [0..6] (0 = "Sun") WeeklyScheduleNameOrId ObjNameOrId
Name or ID of a weekly schedule
| Element definition: DfmScheduleWeeklySubscheduleModifyResult | [top] |
[none]
| Element definition: ArrayOfScheduleAssignee | [top] |
Name Type Description ScheduleAssignee ScheduleAssignee[]
| Element definition: ArrayOfScheduleContentInfo | [top] |
Name Type Description ScheduleContentInfo ScheduleContentInfo[]
| Element definition: ArrayOfScheduleIdInfo | [top] |
Name Type Description ScheduleIdInfo ScheduleIdInfo[]
| Element definition: ObjId | [top] |
Identification number (ID) for a DFM object. This typedef is an alias for the builtin ZAPI Type integer. Object IDs are unsigned integers in the range [1..2^31 - 1]. In some contexts, an object ID is also allowed To be 0, which is interpreted as a null Value, e.g., a reference To no object at all. The ID for a DFM object is always assigned by the system; the user is never allowed To assign an ID To an object. Therefore, an input element of Type ObjId is always used To refer To an existing object by its ID. The ZAPI must specify the object's DFM object Type (e.g. Dataset, Host, DP Policy, etc.). Some ZAPIs allow the object To be one of several different types.
If the Value of an ObjId input element does not Match the ID of any existing DFM object of the specified Type or types, then typically the ZAPI fails with Error code EOBJECTNOTFOUND. A ZAPI may deviate From this general rule, for example, it may return a more specific Error code. In either case, the ZAPI specification must document its behavior.
[none]
| Element definition: ObjNameOrId | [top] |
Name or internal ID of a DFM object. This typedef is an alias for the builtin ZAPI Type string. An ObjNameOrId must contain between 1 and 64 characters, and must conform To one of the following formats: Elements of Type ObjNameOrId are used only as inputs To ZAPIs. The Value must Match either the Name or internal ID of an existing DFM object. The ZAPI must specify the object's DFM object Type (e.g. Dataset, Host, DP Policy, etc.). Some ZAPIs allow the object To be one of several different types.
- It must have the format of an ObjName, or
- It must be the decimal numeric string form of a positive integer whose Value is in the range [1..2^31 - 1].
If the format of an ObjNameOrId input element does not conform, or the Value does not Match the Name or ID of an existing object, then generally the ZAPI documents that it fails with Error code EOBJECTNOTFOUND. A ZAPI may return more specific Error codes. In such cases, the ZAPI specification must document its behavior.
If a ZAPI can accept a null Value (e.g. reference To no object at all) for such an element, then the element is declared optional, and the absence of the input element represents a null Value.
[none]
| Element definition: ScheduleContentInfo | [top] |
Detailed schedule contents. A schedule can be a daily, weekly, or monthly schedule. A daily schedule may include both multiple recurring hourly schedules (HourlyList element) and/or individual non-recurring daily schedules (DailyList element). A weekly schedule may include multiple references To daily schedules To be run on specific Days of the week (WeeklySubscheduleList element) and/or individual non-recurring weekly schedules (WeeklyList element). A monthly schedule may include multiple non-recurring monthly schedules (MonthlyList element). In addition, a monthly schedule may include a single reference To either a daily schedule or a montly schedule, not both. User may only specify one MonthlySubscheduleInfo element in the MonthlySubscheduleList.
Name Type Description DailyList ArrayOfDailyInfo
optional
List of daily schedules. May only be used in a daily schedule. HourlyList ArrayOfHourlyInfo
optional
List of hourly schedules. May only be used in a daily schedule. IsModifiable xsd:boolean
optional
If false, this schedule is one of the sample schedules that is created at installation time, therefore it may not be modified, renamed or destroyed. If true, it is not one of the sample schedules, therefore it may be modified, renamed or destroyed. IsModifiable always appears in the output. It is not possible To use it as input. MonthlyList ArrayOfMonthlyInfo
optional
List of monthly schedules. May only be used in a monthly schedule. MonthlySubscheduleList ArrayOfMonthlySubscheduleInfo
optional
List of monthly sub-schedules used by the schedule. May only be used in a monthly schedule. ScheduleCategory xsd:string
optional
Specifies the category of the schedule. Possible Values are: 'dfm_schedule', 'dp_schedule'. The default Value is 'dp_schedule'. ScheduleDescription xsd:string
optional
Description of the schedule. It may contain From 0 To 255 characters. The Description always appears in the output. If the Description is omitted, then the default Value is the empty string "". ScheduleId ObjId
optional
ID of the schedule. Ignored for DfmScheduleCreate. Required for all other calls. Range: [1..(2^31)-1] ScheduleName ObjName
Name of the schedule. May not be numeric. ScheduleType xsd:string
Type of schedule. Possible Values are: 'daily', 'weekly', 'monthly'. Note that the Type cannot be changed once the schedule is created. User has To delete the schedule before creating a new schedule using the same Name with different Type WeeklyList ArrayOfWeeklyInfo
optional
List of weekly schedules. May only be used in a weekly schedule. WeeklySubscheduleList ArrayOfWeeklySubscheduleInfo
optional
List of weekly sub-schedules used by the schedule. May only be used in a weekly schedule.
| Element definition: WrapperOfDailyInfo | [top] |
Name Type Description DailyInfo DailyInfo
| Element definition: WrapperOfHourlyInfo | [top] |
Name Type Description HourlyInfo HourlyInfo
| Element definition: WrapperOfMonthlyInfo | [top] |
Name Type Description MonthlyInfo MonthlyInfo
| Element definition: WrapperOfWeeklyInfo | [top] |
Name Type Description WeeklyInfo WeeklyInfo
| Element definition: ArrayOfDailyInfo | [top] |
Name Type Description DailyInfo DailyInfo[]
| Element definition: ArrayOfHourlyInfo | [top] |
Name Type Description HourlyInfo HourlyInfo[]
| Element definition: ArrayOfMonthlyInfo | [top] |
Name Type Description MonthlyInfo MonthlyInfo[]
| Element definition: ArrayOfMonthlySubscheduleInfo | [top] |
Name Type Description MonthlySubscheduleInfo MonthlySubscheduleInfo[]
| Element definition: ArrayOfWeeklyInfo | [top] |
Name Type Description WeeklyInfo WeeklyInfo[]
| Element definition: ArrayOfWeeklySubscheduleInfo | [top] |
Name Type Description WeeklySubscheduleInfo WeeklySubscheduleInfo[]
| Element definition: DailyInfo | [top] |
The Attributes of a daily schedule. May only be used in a daily schedule.
Name Type Description ItemId xsd:integer
optional
ID of the daily item within the schedule. Ignored for dfm-schedule-create/modify and Required for all other calls. Will be presented in output. Range: [1..(2^31)-1] StartHour xsd:integer
Start hour of the daily schedule. Range: [0..23] StartMinute xsd:integer
Start minute of the daily schedule. Range: [0..59]
| Element definition: HourlyInfo | [top] |
The Attributes of an hourly schedule. May only be used in a daily schedule.
Name Type Description EndHour xsd:integer
End hour of the hourly schedule. Range: [0..23] EndMinute xsd:integer
End minute of the hourly schedule. Range: [0..59] Frequency xsd:integer
Number of minutes between each schedule. Range: [5..1440] ItemId xsd:integer
optional
ID of the hourly item within the schedule. Ignored for dfm-schedule-create/modify and Required for all other calls. Will be presented in output. Range: [1..(2^31)-1] StartHour xsd:integer
Start hour of the hourly schedule. Range: [0..23] StartMinute xsd:integer
Start minute of the hourly schedule. Range: [0..59]
| Element definition: MonthlyInfo | [top] |
The Attributes of a monthly schedule. May only be used in a monthly schedule.
Name Type Description DayOfMonth xsd:integer
optional
If DayOfMonth is 29, 30, or 31, it will be interpretted as the last Day of the Month for Months with fewer than that many Days. if DayOfMonth is set, then both WeekOfMonth and DayOfWeek must not be set. Range: [1..31] DayOfWeek xsd:integer
optional
Day of week for the schedule. If DayOfWeek is set, then WeekOfMonth must also be set and DayOfMonth must not be set. Range: [0..6] (0 = "Sun") ItemId xsd:integer
optional
ID of the monthly item within the schedule. Ignored for dfm-schedule-create/modify and Required for all other calls. Will be presented in output. Range: [1..(2^31)-1] StartHour xsd:integer
Start hour of the monthly schedule. Range: [0..23] StartMinute xsd:integer
Start minute of the monthly schedule. Range: [0..59] WeekOfMonth xsd:integer
optional
A Value of 5 indicates the last week of the Month. If WeekOfMonth is set, then DayOfWeek must also be set and DayOfMonth must not be set. Range: [1..5]
| Element definition: ObjName | [top] |
Name of a DFM object. This typedef is an alias for the built in ZAPI Type string. An object Name must conform To the following format: The behavior of a ZAPI when it encounters an Error involving an ObjName input element depends on how the ZAPI uses the input element. Here are the general rules:
- It must contain between 1 and 64 characters.
- It may start with any character and may contain any combination of characters, except that it may not consist solely of decimal digits ('0' through '9').
- In some contexts, a Name may be the empty string (""), which is interpreted as a null Value, e.g., a reference To no object at all.
A ZAPI may deviate From these general rules, for example, it may return more specific Error codes. In such cases, the ZAPI specification must document its behavior.
- If the input Name element is used To create a new object with the given Name, or rename an existing object To that Name, and the Name does not conform To the above format, then the ZAPI fails with Error code EINVALIDINPUTERROR. Note that because EINVALIDINPUTERROR is such a common Error code, ZAPI specifications are not required To document cases when they may return it.
- If the input Name element is used To refer To an existing object with that Name, and there is no object with that Name, then the ZAPI fails with Error code EOBJECTNOTFOUND. Generally the ZAPI specification documents cases when it may return this Error code.
If an input Name element is used To refer To an existing object, then the ZAPI specification must specify which DFM object Type (e.g. data set, Host, DP Policy, etc.) is allowed. Some ZAPIs allow the object To be one of several different types. See the Description of ObjFullName for examples of valid input formats.
Note that there is no requirement that all object names must be unique. However, the names for some specific types of Objects are constrained such that no two Objects of that Type may have the same Name. For example, this constraint applies To Datasets, DP schedules, and DP policies. This means that no two Datasets may have the same Name, but a Dataset may have the same Name as a DP schedule or DP Policy.
In general, object names are compared in a case-insensitive manner. This means that, for example, "MyObject" and "MYOBJECT" are considered To be the same Name for purposes of: creating new Objects, renaming existing Objects, or looking up an object by Name. On the other hand, ZAPIs that return an ObjName generally do not change the capitalization at all. For example, if an object's Name has been set To "MyObject", then list iteration ZAPIs that return the object's Name return it as "MyObject" rather than "MYOBJECT" or "myobject".
ZAPIs that operate on ObjName Values and do not follow these general rules about case sensitivity must document the rules that they do follow.
One important exception To these general rules is that Volumes, Qtrees, OSSV Directories, SRM Paths, Interfaces, FCP Targets and FC switch ports all have case-sensitive names. When looking up Objects of these types by Name, the case must Match the object Name.
[none]
| Element definition: ScheduleAssignee | [top] |
Description of a DFM object using the schedule.
Name Type Description AssigneeFullName ObjFullName
Full Name of a DFM object. AssigneeId ObjId
Identification number of a DFM object. AssigneeType xsd:string
Type of DFM object. Possible Values are: 'dp_policy', 'dp_schedule', 'dfm_schedule' and 'report_schedule'.
| Element definition: ScheduleIdInfo | [top] |
The Attributes of a Id list
Name Type Description Id ObjId
ID of the schedule. Range: [1..(2^31)-1] Name ObjName
Name of the schedule. May not be numeric. Type xsd:string
Type of schedule. Possible Values are: daily, weekly, monthly
| Element definition: WeeklyInfo | [top] |
The Attributes of a weekly schedule. May only be used in a weekly schedule.
Name Type Description DayOfWeek xsd:integer
Day of week for the schedule. Range: [0..6] (0 = "Sun") ItemId xsd:integer
optional
ID of the weekly item within the schedule Ignored for dfm-schedule-create/modify and Required for all other calls. Will be presented in output. Range: [1..(2^31)-1] StartHour xsd:integer
Start hour of the weekly schedule. Range: [0..23] StartMinute xsd:integer
Start minute of the weekly schedule. Range: [0..59]
| Element definition: MonthlySubscheduleInfo | [top] |
The Attributes of a monthly subschedule. May only be used in a monthly schedule.
Name Type Description SubscheduleId ObjId
ID of the subschedule To be used. Range: [1..(2^31)-1] SubscheduleName ObjName
optional
Name of the subschedule To be used Ignored for dfm-schedule-create/modify. Required for all other calls. Will be presented in output. Range: [1..(2^31)-1]
| Element definition: ObjFullName | [top] |
Full Name of a DFM object. This typedef is an alias for the builtin ZAPI Type string. An object full Name conforms To all the rules of an ObjName, except that the full Name may be up To 255 characters long. DFM creates full names by concatenating an object Name with any parent object names, so as To create a unique Name for an object. The format of full names is as follows:
- Host full names are the either the fully-qualified domain Name or the IP Address of the Host.
- Aggregate full names are the Host Name and the Aggregate Name, separated by a colon, e.g. Hostname:aggr0.
- Volume full names are the Host Name and the Volume Name, separated by ":/", e.g. Hostname:/volume. Note this does not include "/vol". Volume and Aggregate full names are distinguished by the presence of a forward slash after the colon.
- Qtree full names are the containing Volume full Name and the Qtree Name, separated by a slash, e.g. Hostname:/volume/qtree. The data not contained by any Qtree may be represented by "-", e.g. Hostname:/volume/-.
- Lun Path full names are either a Volume or Qtree full Name and the LUN Path, separated by a slash, e.g. Hostname:/volume/LUN or Hostname:/volume/qtree/LUN.
- Network full names are a network Address block in CIDR format, e.g. 1.2.3.0/8.
- OSSV Directory full names are the OSSV Host Name and the OSSV Path, separated by a colon, e.g. host-lnx:/usr/local or host-w2k:c:/temp
- Include any others here...
- Initiator Group full names are Host Name and the initiator Group Name, separated by a colon, e.g. Hostname:igroup.
For any DFM object not listed above, the ObjName and ObjFullName are identical.
[none]
| Element definition: WeeklySubscheduleInfo | [top] |
The Attributes of a weekly subschedule. May only be used in a weekly schedule.
Name Type Description EndDayOfWeek xsd:integer
End Day To be applied To the schedule being used. Range: [0..6] (0 = "Sun") ItemId xsd:integer
optional
ID of the use Type within the schedule. Ignored for dfm-schedule-create/modify and Required for all other calls. Will be presented in output. Range: [1..(2^31)-1] StartDayOfWeek xsd:integer
Start Day To be applied To the schedule being used. Range: [0..6] (0 = "Sun") SubscheduleId ObjId
ID of the subschedule To be used. Range: [1..(2^31)-1] SubscheduleName ObjName
optional
Name of the subschedule To be used Ignored for dfm-schedule-create/modify. Required for all other calls. Will be presented in output. Range: [1..(2^31)-1]