connectwise-rest
    Preparing search index...

    Class BatchAPI

    Batch module

    Hierarchy

    • AutomateBaseAPI
      • BatchAPI
    Index

    Methods

    batchSendToSearches executeScript request runDeviceDetection scheduleScript

    Methods

    • Parameters

      • SendToSearchesBatchRequest: { FolderId?: number; SearchIds?: number[] }
        • OptionalFolderId?: number

          Format: int32

        • OptionalSearchIds?: number[]

      Returns Promise<
          {
              ContainsUnsuccessfulResults?: boolean;
              SearchResults?: {
                  ResultDetails?: {
                      Message?: string;
                      ReasonCode?: number;
                      ResultStatus?: number;
                  };
                  SearchId?: number;
              }[];
          },
      >

    • Parameters

      • ScheduleScriptBatchRequest: {
            content: {
                "application/json": {
                    DistributionWindow?: {
                        Amount?: number;
                        DistributionWindowType?: {
                            DistributionWindowTypeId?: number;
                            Name?: string;
                        };
                    };
                    EntityIds?: number[];
                    EntityType?: | "System"
                    | "Computer"
                    | "Site"
                    | "Company"
                    | "Probe"
                    | "NetworkDevice"
                    | "Ticket"
                    | "Group"
                    | "MobileDevice"
                    | "Vendor"
                    | "VendorProduct"
                    | "Possibility"
                    | "Opportunity"
                    | "Contact"
                    | "User"
                    | "Script"
                    | "Plugin"
                    | "Service"
                    | "ServiceBundle"
                    | "Search"
                    | "SearchFolder"
                    | "Dataview"
                    | "DataviewFolder"
                    | "UserFolder"
                    | "UserClass"
                    | "ScriptFolder"
                    | "RemoteMonitorTemplate"
                    | "ExtraField";
                    ExpireDate?: string;
                    IncludeSubGroups?: boolean;
                    OfflineActionFlags?: {
                        OnlyRunsOnOfflineAgents?: boolean;
                        SkipsOfflineAgents?: boolean;
                        WakesOfflineAgents?: boolean;
                    };
                    Parameters?: { Key?: string; Value?: string }[];
                    Priority?: number;
                    Schedule?: {
                        DailySettings?: {
                            DailyInterval?: number;
                            DailyRepeatSettings?: {
                                DailyRepeatInterval?: number;
                                DailyScriptRepeatFrequency?: {
                                    DailyScriptRepeatFrequencyId?: ...;
                                    Name?: ...;
                                };
                                MaximumRepetitions?: number;
                            };
                            DaysOfWeekSettings?: {
                                Friday?: boolean;
                                Monday?: boolean;
                                Saturday?: boolean;
                                Sunday?: boolean;
                                Thursday?: boolean;
                                Tuesday?: boolean;
                                Wednesday?: boolean;
                            };
                            RunsAt?: string;
                        };
                        HourlySettings?: {
                            ExclusionEndTime?: string;
                            ExclusionStartTime?: string;
                            HourlyInterval?: number;
                        };
                        MinutelySettings?: {
                            ExclusionEndTime?: string;
                            ExclusionStartTime?: string;
                            MinutelyInterval?: number;
                        };
                        MonthlySettings?: {
                            Day?: number;
                            MonthlyInterval?: number;
                            RunsAt?: string;
                        };
                        ScriptScheduleFrequency?: {
                            Name?: string;
                            ScriptScheduleFrequencyId?: number;
                        };
                        WeeklySettings?: {
                            DaysOfWeekSettings?: {
                                Friday?: boolean;
                                Monday?: boolean;
                                Saturday?: boolean;
                                Sunday?: boolean;
                                Thursday?: boolean;
                                Tuesday?: boolean;
                                Wednesday?: boolean;
                            };
                            RunsAt?: string;
                            WeeksOfMonthSettings?: {
                                First?: boolean;
                                Fourth?: boolean;
                                Last?: boolean;
                                Second?: boolean;
                                Third?: boolean;
                            };
                        };
                    };
                    ScriptGuid?: string;
                    ScriptId?: number;
                    StartDate?: string;
                    UseAgentTime?: boolean;
                };
                "application/x-www-form-urlencoded": {
                    DistributionWindow?: {
                        Amount?: number;
                        DistributionWindowType?: {
                            DistributionWindowTypeId?: number;
                            Name?: string;
                        };
                    };
                    EntityIds?: number[];
                    EntityType?: | "System"
                    | "Computer"
                    | "Site"
                    | "Company"
                    | "Probe"
                    | "NetworkDevice"
                    | "Ticket"
                    | "Group"
                    | "MobileDevice"
                    | "Vendor"
                    | "VendorProduct"
                    | "Possibility"
                    | "Opportunity"
                    | "Contact"
                    | "User"
                    | "Script"
                    | "Plugin"
                    | "Service"
                    | "ServiceBundle"
                    | "Search"
                    | "SearchFolder"
                    | "Dataview"
                    | "DataviewFolder"
                    | "UserFolder"
                    | "UserClass"
                    | "ScriptFolder"
                    | "RemoteMonitorTemplate"
                    | "ExtraField";
                    ExpireDate?: string;
                    IncludeSubGroups?: boolean;
                    OfflineActionFlags?: {
                        OnlyRunsOnOfflineAgents?: boolean;
                        SkipsOfflineAgents?: boolean;
                        WakesOfflineAgents?: boolean;
                    };
                    Parameters?: { Key?: string; Value?: string }[];
                    Priority?: number;
                    Schedule?: {
                        DailySettings?: {
                            DailyInterval?: number;
                            DailyRepeatSettings?: {
                                DailyRepeatInterval?: number;
                                DailyScriptRepeatFrequency?: {
                                    DailyScriptRepeatFrequencyId?: ...;
                                    Name?: ...;
                                };
                                MaximumRepetitions?: number;
                            };
                            DaysOfWeekSettings?: {
                                Friday?: boolean;
                                Monday?: boolean;
                                Saturday?: boolean;
                                Sunday?: boolean;
                                Thursday?: boolean;
                                Tuesday?: boolean;
                                Wednesday?: boolean;
                            };
                            RunsAt?: string;
                        };
                        HourlySettings?: {
                            ExclusionEndTime?: string;
                            ExclusionStartTime?: string;
                            HourlyInterval?: number;
                        };
                        MinutelySettings?: {
                            ExclusionEndTime?: string;
                            ExclusionStartTime?: string;
                            MinutelyInterval?: number;
                        };
                        MonthlySettings?: {
                            Day?: number;
                            MonthlyInterval?: number;
                            RunsAt?: string;
                        };
                        ScriptScheduleFrequency?: {
                            Name?: string;
                            ScriptScheduleFrequencyId?: number;
                        };
                        WeeklySettings?: {
                            DaysOfWeekSettings?: {
                                Friday?: boolean;
                                Monday?: boolean;
                                Saturday?: boolean;
                                Sunday?: boolean;
                                Thursday?: boolean;
                                Tuesday?: boolean;
                                Wednesday?: boolean;
                            };
                            RunsAt?: string;
                            WeeksOfMonthSettings?: {
                                First?: boolean;
                                Fourth?: boolean;
                                Last?: boolean;
                                Second?: boolean;
                                Third?: boolean;
                            };
                        };
                    };
                    ScriptGuid?: string;
                    ScriptId?: number;
                    StartDate?: string;
                    UseAgentTime?: boolean;
                };
                "application/xml": {
                    DistributionWindow?: {
                        Amount?: number;
                        DistributionWindowType?: {
                            DistributionWindowTypeId?: number;
                            Name?: string;
                        };
                    };
                    EntityIds?: number[];
                    EntityType?: | "System"
                    | "Computer"
                    | "Site"
                    | "Company"
                    | "Probe"
                    | "NetworkDevice"
                    | "Ticket"
                    | "Group"
                    | "MobileDevice"
                    | "Vendor"
                    | "VendorProduct"
                    | "Possibility"
                    | "Opportunity"
                    | "Contact"
                    | "User"
                    | "Script"
                    | "Plugin"
                    | "Service"
                    | "ServiceBundle"
                    | "Search"
                    | "SearchFolder"
                    | "Dataview"
                    | "DataviewFolder"
                    | "UserFolder"
                    | "UserClass"
                    | "ScriptFolder"
                    | "RemoteMonitorTemplate"
                    | "ExtraField";
                    ExpireDate?: string;
                    IncludeSubGroups?: boolean;
                    OfflineActionFlags?: {
                        OnlyRunsOnOfflineAgents?: boolean;
                        SkipsOfflineAgents?: boolean;
                        WakesOfflineAgents?: boolean;
                    };
                    Parameters?: { Key?: string; Value?: string }[];
                    Priority?: number;
                    Schedule?: {
                        DailySettings?: {
                            DailyInterval?: number;
                            DailyRepeatSettings?: {
                                DailyRepeatInterval?: number;
                                DailyScriptRepeatFrequency?: {
                                    DailyScriptRepeatFrequencyId?: ...;
                                    Name?: ...;
                                };
                                MaximumRepetitions?: number;
                            };
                            DaysOfWeekSettings?: {
                                Friday?: boolean;
                                Monday?: boolean;
                                Saturday?: boolean;
                                Sunday?: boolean;
                                Thursday?: boolean;
                                Tuesday?: boolean;
                                Wednesday?: boolean;
                            };
                            RunsAt?: string;
                        };
                        HourlySettings?: {
                            ExclusionEndTime?: string;
                            ExclusionStartTime?: string;
                            HourlyInterval?: number;
                        };
                        MinutelySettings?: {
                            ExclusionEndTime?: string;
                            ExclusionStartTime?: string;
                            MinutelyInterval?: number;
                        };
                        MonthlySettings?: {
                            Day?: number;
                            MonthlyInterval?: number;
                            RunsAt?: string;
                        };
                        ScriptScheduleFrequency?: {
                            Name?: string;
                            ScriptScheduleFrequencyId?: number;
                        };
                        WeeklySettings?: {
                            DaysOfWeekSettings?: {
                                Friday?: boolean;
                                Monday?: boolean;
                                Saturday?: boolean;
                                Sunday?: boolean;
                                Thursday?: boolean;
                                Tuesday?: boolean;
                                Wednesday?: boolean;
                            };
                            RunsAt?: string;
                            WeeksOfMonthSettings?: {
                                First?: boolean;
                                Fourth?: boolean;
                                Last?: boolean;
                                Second?: boolean;
                                Third?: boolean;
                            };
                        };
                    };
                    ScriptGuid?: string;
                    ScriptId?: number;
                    StartDate?: string;
                    UseAgentTime?: boolean;
                };
                "text/json": {
                    DistributionWindow?: {
                        Amount?: number;
                        DistributionWindowType?: {
                            DistributionWindowTypeId?: number;
                            Name?: string;
                        };
                    };
                    EntityIds?: number[];
                    EntityType?: | "System"
                    | "Computer"
                    | "Site"
                    | "Company"
                    | "Probe"
                    | "NetworkDevice"
                    | "Ticket"
                    | "Group"
                    | "MobileDevice"
                    | "Vendor"
                    | "VendorProduct"
                    | "Possibility"
                    | "Opportunity"
                    | "Contact"
                    | "User"
                    | "Script"
                    | "Plugin"
                    | "Service"
                    | "ServiceBundle"
                    | "Search"
                    | "SearchFolder"
                    | "Dataview"
                    | "DataviewFolder"
                    | "UserFolder"
                    | "UserClass"
                    | "ScriptFolder"
                    | "RemoteMonitorTemplate"
                    | "ExtraField";
                    ExpireDate?: string;
                    IncludeSubGroups?: boolean;
                    OfflineActionFlags?: {
                        OnlyRunsOnOfflineAgents?: boolean;
                        SkipsOfflineAgents?: boolean;
                        WakesOfflineAgents?: boolean;
                    };
                    Parameters?: { Key?: string; Value?: string }[];
                    Priority?: number;
                    Schedule?: {
                        DailySettings?: {
                            DailyInterval?: number;
                            DailyRepeatSettings?: {
                                DailyRepeatInterval?: number;
                                DailyScriptRepeatFrequency?: {
                                    DailyScriptRepeatFrequencyId?: ...;
                                    Name?: ...;
                                };
                                MaximumRepetitions?: number;
                            };
                            DaysOfWeekSettings?: {
                                Friday?: boolean;
                                Monday?: boolean;
                                Saturday?: boolean;
                                Sunday?: boolean;
                                Thursday?: boolean;
                                Tuesday?: boolean;
                                Wednesday?: boolean;
                            };
                            RunsAt?: string;
                        };
                        HourlySettings?: {
                            ExclusionEndTime?: string;
                            ExclusionStartTime?: string;
                            HourlyInterval?: number;
                        };
                        MinutelySettings?: {
                            ExclusionEndTime?: string;
                            ExclusionStartTime?: string;
                            MinutelyInterval?: number;
                        };
                        MonthlySettings?: {
                            Day?: number;
                            MonthlyInterval?: number;
                            RunsAt?: string;
                        };
                        ScriptScheduleFrequency?: {
                            Name?: string;
                            ScriptScheduleFrequencyId?: number;
                        };
                        WeeklySettings?: {
                            DaysOfWeekSettings?: {
                                Friday?: boolean;
                                Monday?: boolean;
                                Saturday?: boolean;
                                Sunday?: boolean;
                                Thursday?: boolean;
                                Tuesday?: boolean;
                                Wednesday?: boolean;
                            };
                            RunsAt?: string;
                            WeeksOfMonthSettings?: {
                                First?: boolean;
                                Fourth?: boolean;
                                Last?: boolean;
                                Second?: boolean;
                                Third?: boolean;
                            };
                        };
                    };
                    ScriptGuid?: string;
                    ScriptId?: number;
                    StartDate?: string;
                    UseAgentTime?: boolean;
                };
                "text/xml": {
                    DistributionWindow?: {
                        Amount?: number;
                        DistributionWindowType?: {
                            DistributionWindowTypeId?: number;
                            Name?: string;
                        };
                    };
                    EntityIds?: number[];
                    EntityType?: | "System"
                    | "Computer"
                    | "Site"
                    | "Company"
                    | "Probe"
                    | "NetworkDevice"
                    | "Ticket"
                    | "Group"
                    | "MobileDevice"
                    | "Vendor"
                    | "VendorProduct"
                    | "Possibility"
                    | "Opportunity"
                    | "Contact"
                    | "User"
                    | "Script"
                    | "Plugin"
                    | "Service"
                    | "ServiceBundle"
                    | "Search"
                    | "SearchFolder"
                    | "Dataview"
                    | "DataviewFolder"
                    | "UserFolder"
                    | "UserClass"
                    | "ScriptFolder"
                    | "RemoteMonitorTemplate"
                    | "ExtraField";
                    ExpireDate?: string;
                    IncludeSubGroups?: boolean;
                    OfflineActionFlags?: {
                        OnlyRunsOnOfflineAgents?: boolean;
                        SkipsOfflineAgents?: boolean;
                        WakesOfflineAgents?: boolean;
                    };
                    Parameters?: { Key?: string; Value?: string }[];
                    Priority?: number;
                    Schedule?: {
                        DailySettings?: {
                            DailyInterval?: number;
                            DailyRepeatSettings?: {
                                DailyRepeatInterval?: number;
                                DailyScriptRepeatFrequency?: {
                                    DailyScriptRepeatFrequencyId?: ...;
                                    Name?: ...;
                                };
                                MaximumRepetitions?: number;
                            };
                            DaysOfWeekSettings?: {
                                Friday?: boolean;
                                Monday?: boolean;
                                Saturday?: boolean;
                                Sunday?: boolean;
                                Thursday?: boolean;
                                Tuesday?: boolean;
                                Wednesday?: boolean;
                            };
                            RunsAt?: string;
                        };
                        HourlySettings?: {
                            ExclusionEndTime?: string;
                            ExclusionStartTime?: string;
                            HourlyInterval?: number;
                        };
                        MinutelySettings?: {
                            ExclusionEndTime?: string;
                            ExclusionStartTime?: string;
                            MinutelyInterval?: number;
                        };
                        MonthlySettings?: {
                            Day?: number;
                            MonthlyInterval?: number;
                            RunsAt?: string;
                        };
                        ScriptScheduleFrequency?: {
                            Name?: string;
                            ScriptScheduleFrequencyId?: number;
                        };
                        WeeklySettings?: {
                            DaysOfWeekSettings?: {
                                Friday?: boolean;
                                Monday?: boolean;
                                Saturday?: boolean;
                                Sunday?: boolean;
                                Thursday?: boolean;
                                Tuesday?: boolean;
                                Wednesday?: boolean;
                            };
                            RunsAt?: string;
                            WeeksOfMonthSettings?: {
                                First?: boolean;
                                Fourth?: boolean;
                                Last?: boolean;
                                Second?: boolean;
                                Third?: boolean;
                            };
                        };
                    };
                    ScriptGuid?: string;
                    ScriptId?: number;
                    StartDate?: string;
                    UseAgentTime?: boolean;
                };
            };
        }

      Returns Promise<
          {
              ContainsUnsuccessfulResults?: boolean;
              ScriptResults?: {
                  EntityId?: number;
                  ResultDetails?: {
                      Message?: string;
                      ReasonCode?: number;
                      ResultStatus?: number;
                  };
              }[];
          },
      >

    • Parameters

      • ExecuteProbeBatchRequest: { ProbeIds?: number[] }

      Returns Promise<
          {
              ContainsUnsuccessfulResults?: boolean;
              ProbeCommandResults?: {
                  ProbeId?: number;
                  ResultDetails?: {
                      Message?: string;
                      ReasonCode?: number;
                      ResultStatus?: number;
                  };
              }[];
          },
      >

    • Parameters

      • ScheduleScriptBatchRequest: {
            content: {
                "application/json": {
                    DistributionWindow?: {
                        Amount?: number;
                        DistributionWindowType?: {
                            DistributionWindowTypeId?: number;
                            Name?: string;
                        };
                    };
                    EntityIds?: number[];
                    EntityType?: | "System"
                    | "Computer"
                    | "Site"
                    | "Company"
                    | "Probe"
                    | "NetworkDevice"
                    | "Ticket"
                    | "Group"
                    | "MobileDevice"
                    | "Vendor"
                    | "VendorProduct"
                    | "Possibility"
                    | "Opportunity"
                    | "Contact"
                    | "User"
                    | "Script"
                    | "Plugin"
                    | "Service"
                    | "ServiceBundle"
                    | "Search"
                    | "SearchFolder"
                    | "Dataview"
                    | "DataviewFolder"
                    | "UserFolder"
                    | "UserClass"
                    | "ScriptFolder"
                    | "RemoteMonitorTemplate"
                    | "ExtraField";
                    ExpireDate?: string;
                    IncludeSubGroups?: boolean;
                    OfflineActionFlags?: {
                        OnlyRunsOnOfflineAgents?: boolean;
                        SkipsOfflineAgents?: boolean;
                        WakesOfflineAgents?: boolean;
                    };
                    Parameters?: { Key?: string; Value?: string }[];
                    Priority?: number;
                    Schedule?: {
                        DailySettings?: {
                            DailyInterval?: number;
                            DailyRepeatSettings?: {
                                DailyRepeatInterval?: number;
                                DailyScriptRepeatFrequency?: {
                                    DailyScriptRepeatFrequencyId?: ...;
                                    Name?: ...;
                                };
                                MaximumRepetitions?: number;
                            };
                            DaysOfWeekSettings?: {
                                Friday?: boolean;
                                Monday?: boolean;
                                Saturday?: boolean;
                                Sunday?: boolean;
                                Thursday?: boolean;
                                Tuesday?: boolean;
                                Wednesday?: boolean;
                            };
                            RunsAt?: string;
                        };
                        HourlySettings?: {
                            ExclusionEndTime?: string;
                            ExclusionStartTime?: string;
                            HourlyInterval?: number;
                        };
                        MinutelySettings?: {
                            ExclusionEndTime?: string;
                            ExclusionStartTime?: string;
                            MinutelyInterval?: number;
                        };
                        MonthlySettings?: {
                            Day?: number;
                            MonthlyInterval?: number;
                            RunsAt?: string;
                        };
                        ScriptScheduleFrequency?: {
                            Name?: string;
                            ScriptScheduleFrequencyId?: number;
                        };
                        WeeklySettings?: {
                            DaysOfWeekSettings?: {
                                Friday?: boolean;
                                Monday?: boolean;
                                Saturday?: boolean;
                                Sunday?: boolean;
                                Thursday?: boolean;
                                Tuesday?: boolean;
                                Wednesday?: boolean;
                            };
                            RunsAt?: string;
                            WeeksOfMonthSettings?: {
                                First?: boolean;
                                Fourth?: boolean;
                                Last?: boolean;
                                Second?: boolean;
                                Third?: boolean;
                            };
                        };
                    };
                    ScriptGuid?: string;
                    ScriptId?: number;
                    StartDate?: string;
                    UseAgentTime?: boolean;
                };
                "application/x-www-form-urlencoded": {
                    DistributionWindow?: {
                        Amount?: number;
                        DistributionWindowType?: {
                            DistributionWindowTypeId?: number;
                            Name?: string;
                        };
                    };
                    EntityIds?: number[];
                    EntityType?: | "System"
                    | "Computer"
                    | "Site"
                    | "Company"
                    | "Probe"
                    | "NetworkDevice"
                    | "Ticket"
                    | "Group"
                    | "MobileDevice"
                    | "Vendor"
                    | "VendorProduct"
                    | "Possibility"
                    | "Opportunity"
                    | "Contact"
                    | "User"
                    | "Script"
                    | "Plugin"
                    | "Service"
                    | "ServiceBundle"
                    | "Search"
                    | "SearchFolder"
                    | "Dataview"
                    | "DataviewFolder"
                    | "UserFolder"
                    | "UserClass"
                    | "ScriptFolder"
                    | "RemoteMonitorTemplate"
                    | "ExtraField";
                    ExpireDate?: string;
                    IncludeSubGroups?: boolean;
                    OfflineActionFlags?: {
                        OnlyRunsOnOfflineAgents?: boolean;
                        SkipsOfflineAgents?: boolean;
                        WakesOfflineAgents?: boolean;
                    };
                    Parameters?: { Key?: string; Value?: string }[];
                    Priority?: number;
                    Schedule?: {
                        DailySettings?: {
                            DailyInterval?: number;
                            DailyRepeatSettings?: {
                                DailyRepeatInterval?: number;
                                DailyScriptRepeatFrequency?: {
                                    DailyScriptRepeatFrequencyId?: ...;
                                    Name?: ...;
                                };
                                MaximumRepetitions?: number;
                            };
                            DaysOfWeekSettings?: {
                                Friday?: boolean;
                                Monday?: boolean;
                                Saturday?: boolean;
                                Sunday?: boolean;
                                Thursday?: boolean;
                                Tuesday?: boolean;
                                Wednesday?: boolean;
                            };
                            RunsAt?: string;
                        };
                        HourlySettings?: {
                            ExclusionEndTime?: string;
                            ExclusionStartTime?: string;
                            HourlyInterval?: number;
                        };
                        MinutelySettings?: {
                            ExclusionEndTime?: string;
                            ExclusionStartTime?: string;
                            MinutelyInterval?: number;
                        };
                        MonthlySettings?: {
                            Day?: number;
                            MonthlyInterval?: number;
                            RunsAt?: string;
                        };
                        ScriptScheduleFrequency?: {
                            Name?: string;
                            ScriptScheduleFrequencyId?: number;
                        };
                        WeeklySettings?: {
                            DaysOfWeekSettings?: {
                                Friday?: boolean;
                                Monday?: boolean;
                                Saturday?: boolean;
                                Sunday?: boolean;
                                Thursday?: boolean;
                                Tuesday?: boolean;
                                Wednesday?: boolean;
                            };
                            RunsAt?: string;
                            WeeksOfMonthSettings?: {
                                First?: boolean;
                                Fourth?: boolean;
                                Last?: boolean;
                                Second?: boolean;
                                Third?: boolean;
                            };
                        };
                    };
                    ScriptGuid?: string;
                    ScriptId?: number;
                    StartDate?: string;
                    UseAgentTime?: boolean;
                };
                "application/xml": {
                    DistributionWindow?: {
                        Amount?: number;
                        DistributionWindowType?: {
                            DistributionWindowTypeId?: number;
                            Name?: string;
                        };
                    };
                    EntityIds?: number[];
                    EntityType?: | "System"
                    | "Computer"
                    | "Site"
                    | "Company"
                    | "Probe"
                    | "NetworkDevice"
                    | "Ticket"
                    | "Group"
                    | "MobileDevice"
                    | "Vendor"
                    | "VendorProduct"
                    | "Possibility"
                    | "Opportunity"
                    | "Contact"
                    | "User"
                    | "Script"
                    | "Plugin"
                    | "Service"
                    | "ServiceBundle"
                    | "Search"
                    | "SearchFolder"
                    | "Dataview"
                    | "DataviewFolder"
                    | "UserFolder"
                    | "UserClass"
                    | "ScriptFolder"
                    | "RemoteMonitorTemplate"
                    | "ExtraField";
                    ExpireDate?: string;
                    IncludeSubGroups?: boolean;
                    OfflineActionFlags?: {
                        OnlyRunsOnOfflineAgents?: boolean;
                        SkipsOfflineAgents?: boolean;
                        WakesOfflineAgents?: boolean;
                    };
                    Parameters?: { Key?: string; Value?: string }[];
                    Priority?: number;
                    Schedule?: {
                        DailySettings?: {
                            DailyInterval?: number;
                            DailyRepeatSettings?: {
                                DailyRepeatInterval?: number;
                                DailyScriptRepeatFrequency?: {
                                    DailyScriptRepeatFrequencyId?: ...;
                                    Name?: ...;
                                };
                                MaximumRepetitions?: number;
                            };
                            DaysOfWeekSettings?: {
                                Friday?: boolean;
                                Monday?: boolean;
                                Saturday?: boolean;
                                Sunday?: boolean;
                                Thursday?: boolean;
                                Tuesday?: boolean;
                                Wednesday?: boolean;
                            };
                            RunsAt?: string;
                        };
                        HourlySettings?: {
                            ExclusionEndTime?: string;
                            ExclusionStartTime?: string;
                            HourlyInterval?: number;
                        };
                        MinutelySettings?: {
                            ExclusionEndTime?: string;
                            ExclusionStartTime?: string;
                            MinutelyInterval?: number;
                        };
                        MonthlySettings?: {
                            Day?: number;
                            MonthlyInterval?: number;
                            RunsAt?: string;
                        };
                        ScriptScheduleFrequency?: {
                            Name?: string;
                            ScriptScheduleFrequencyId?: number;
                        };
                        WeeklySettings?: {
                            DaysOfWeekSettings?: {
                                Friday?: boolean;
                                Monday?: boolean;
                                Saturday?: boolean;
                                Sunday?: boolean;
                                Thursday?: boolean;
                                Tuesday?: boolean;
                                Wednesday?: boolean;
                            };
                            RunsAt?: string;
                            WeeksOfMonthSettings?: {
                                First?: boolean;
                                Fourth?: boolean;
                                Last?: boolean;
                                Second?: boolean;
                                Third?: boolean;
                            };
                        };
                    };
                    ScriptGuid?: string;
                    ScriptId?: number;
                    StartDate?: string;
                    UseAgentTime?: boolean;
                };
                "text/json": {
                    DistributionWindow?: {
                        Amount?: number;
                        DistributionWindowType?: {
                            DistributionWindowTypeId?: number;
                            Name?: string;
                        };
                    };
                    EntityIds?: number[];
                    EntityType?: | "System"
                    | "Computer"
                    | "Site"
                    | "Company"
                    | "Probe"
                    | "NetworkDevice"
                    | "Ticket"
                    | "Group"
                    | "MobileDevice"
                    | "Vendor"
                    | "VendorProduct"
                    | "Possibility"
                    | "Opportunity"
                    | "Contact"
                    | "User"
                    | "Script"
                    | "Plugin"
                    | "Service"
                    | "ServiceBundle"
                    | "Search"
                    | "SearchFolder"
                    | "Dataview"
                    | "DataviewFolder"
                    | "UserFolder"
                    | "UserClass"
                    | "ScriptFolder"
                    | "RemoteMonitorTemplate"
                    | "ExtraField";
                    ExpireDate?: string;
                    IncludeSubGroups?: boolean;
                    OfflineActionFlags?: {
                        OnlyRunsOnOfflineAgents?: boolean;
                        SkipsOfflineAgents?: boolean;
                        WakesOfflineAgents?: boolean;
                    };
                    Parameters?: { Key?: string; Value?: string }[];
                    Priority?: number;
                    Schedule?: {
                        DailySettings?: {
                            DailyInterval?: number;
                            DailyRepeatSettings?: {
                                DailyRepeatInterval?: number;
                                DailyScriptRepeatFrequency?: {
                                    DailyScriptRepeatFrequencyId?: ...;
                                    Name?: ...;
                                };
                                MaximumRepetitions?: number;
                            };
                            DaysOfWeekSettings?: {
                                Friday?: boolean;
                                Monday?: boolean;
                                Saturday?: boolean;
                                Sunday?: boolean;
                                Thursday?: boolean;
                                Tuesday?: boolean;
                                Wednesday?: boolean;
                            };
                            RunsAt?: string;
                        };
                        HourlySettings?: {
                            ExclusionEndTime?: string;
                            ExclusionStartTime?: string;
                            HourlyInterval?: number;
                        };
                        MinutelySettings?: {
                            ExclusionEndTime?: string;
                            ExclusionStartTime?: string;
                            MinutelyInterval?: number;
                        };
                        MonthlySettings?: {
                            Day?: number;
                            MonthlyInterval?: number;
                            RunsAt?: string;
                        };
                        ScriptScheduleFrequency?: {
                            Name?: string;
                            ScriptScheduleFrequencyId?: number;
                        };
                        WeeklySettings?: {
                            DaysOfWeekSettings?: {
                                Friday?: boolean;
                                Monday?: boolean;
                                Saturday?: boolean;
                                Sunday?: boolean;
                                Thursday?: boolean;
                                Tuesday?: boolean;
                                Wednesday?: boolean;
                            };
                            RunsAt?: string;
                            WeeksOfMonthSettings?: {
                                First?: boolean;
                                Fourth?: boolean;
                                Last?: boolean;
                                Second?: boolean;
                                Third?: boolean;
                            };
                        };
                    };
                    ScriptGuid?: string;
                    ScriptId?: number;
                    StartDate?: string;
                    UseAgentTime?: boolean;
                };
                "text/xml": {
                    DistributionWindow?: {
                        Amount?: number;
                        DistributionWindowType?: {
                            DistributionWindowTypeId?: number;
                            Name?: string;
                        };
                    };
                    EntityIds?: number[];
                    EntityType?: | "System"
                    | "Computer"
                    | "Site"
                    | "Company"
                    | "Probe"
                    | "NetworkDevice"
                    | "Ticket"
                    | "Group"
                    | "MobileDevice"
                    | "Vendor"
                    | "VendorProduct"
                    | "Possibility"
                    | "Opportunity"
                    | "Contact"
                    | "User"
                    | "Script"
                    | "Plugin"
                    | "Service"
                    | "ServiceBundle"
                    | "Search"
                    | "SearchFolder"
                    | "Dataview"
                    | "DataviewFolder"
                    | "UserFolder"
                    | "UserClass"
                    | "ScriptFolder"
                    | "RemoteMonitorTemplate"
                    | "ExtraField";
                    ExpireDate?: string;
                    IncludeSubGroups?: boolean;
                    OfflineActionFlags?: {
                        OnlyRunsOnOfflineAgents?: boolean;
                        SkipsOfflineAgents?: boolean;
                        WakesOfflineAgents?: boolean;
                    };
                    Parameters?: { Key?: string; Value?: string }[];
                    Priority?: number;
                    Schedule?: {
                        DailySettings?: {
                            DailyInterval?: number;
                            DailyRepeatSettings?: {
                                DailyRepeatInterval?: number;
                                DailyScriptRepeatFrequency?: {
                                    DailyScriptRepeatFrequencyId?: ...;
                                    Name?: ...;
                                };
                                MaximumRepetitions?: number;
                            };
                            DaysOfWeekSettings?: {
                                Friday?: boolean;
                                Monday?: boolean;
                                Saturday?: boolean;
                                Sunday?: boolean;
                                Thursday?: boolean;
                                Tuesday?: boolean;
                                Wednesday?: boolean;
                            };
                            RunsAt?: string;
                        };
                        HourlySettings?: {
                            ExclusionEndTime?: string;
                            ExclusionStartTime?: string;
                            HourlyInterval?: number;
                        };
                        MinutelySettings?: {
                            ExclusionEndTime?: string;
                            ExclusionStartTime?: string;
                            MinutelyInterval?: number;
                        };
                        MonthlySettings?: {
                            Day?: number;
                            MonthlyInterval?: number;
                            RunsAt?: string;
                        };
                        ScriptScheduleFrequency?: {
                            Name?: string;
                            ScriptScheduleFrequencyId?: number;
                        };
                        WeeklySettings?: {
                            DaysOfWeekSettings?: {
                                Friday?: boolean;
                                Monday?: boolean;
                                Saturday?: boolean;
                                Sunday?: boolean;
                                Thursday?: boolean;
                                Tuesday?: boolean;
                                Wednesday?: boolean;
                            };
                            RunsAt?: string;
                            WeeksOfMonthSettings?: {
                                First?: boolean;
                                Fourth?: boolean;
                                Last?: boolean;
                                Second?: boolean;
                                Third?: boolean;
                            };
                        };
                    };
                    ScriptGuid?: string;
                    ScriptId?: number;
                    StartDate?: string;
                    UseAgentTime?: boolean;
                };
            };
        }

      Returns Promise<
          {
              ContainsUnsuccessfulResults?: boolean;
              ScriptResults?: {
                  EntityId?: number;
                  ResultDetails?: {
                      Message?: string;
                      ReasonCode?: number;
                      ResultStatus?: number;
                  };
              }[];
          },
      >

    Settings

    Member Visibility

    On This Page

    Methods