MaintenanceActions

get/api/v1/maintenance-actions/version

Request

  • Base URL: https://api.immy.bot (the document declares no server; this is the origin it was published from)
  • URL: https://api.immy.bot/api/v1/maintenance-actions/version
  • Auth: none declared

Query parameters

softwareType'GlobalSoftware' | 'LocalSoftware' | 'WindowsUpdate' | 'Chocolatey' | 'Ninite'

The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, Chocolatey = 3, Ninite = 4

softwareIdentifierstring
majorinteger
minorinteger
patchinteger
releaseLabelsstring[] nullable
releasestring nullable
isPrereleaseboolean
hasMetadataboolean
metadatastring nullable

Response

OK

idinteger
parentIdinteger nullable
maintenanceSessionIdinteger
tenantIdinteger nullable
computerIdinteger nullable
computerNamestring nullable
isComputerOnlineboolean
startTimestring date-time
endTimestring date-time
actionType'NoAction' | 'Install' | 'Update' | 'Uninstall' | 'Download' | 'Reinstall' | 'Downgrade' | 'Undetermined' | 'TaskEnforce' | 'TaskMonitor' | 'TaskAudit'

The string or integer value may be used. NoAction = 0, Install = 1, Update = 2, Uninstall = 3, Download = 4, Reinstall = 5, Downgrade = 6, Undetermined = 7, TaskEnforce = 8, TaskMonitor = 9, TaskAudit = 10

actionTypeNamestring nullable
status'NotStarted' | 'Downloading' | 'PerformingAction' | 'DeterminingResult' | 'Complete' | 'WaitingForPrerequisite' | 'DeterminingAction' | 'Skipped' | 'PendingExecution'

The string or integer value may be used. NotStarted = 0, Downloading = 1, PerformingAction = 2, DeterminingResult = 3, Complete = 4, WaitingForPrerequisite = 5, DeterminingAction = 6, Skipped = 7, PendingExecution = 8

statusNamestring nullable
assignmentIdinteger nullable
assignmentType'Global' | 'Local'

The string or integer value may be used. Global = 0, Local = 1

tenantNamestring nullable
maintenanceType'GlobalSoftware' | 'LocalSoftware' | 'WindowsUpdate' | 'ChocolateySoftware' | 'NiniteSoftware' | 'LocalMaintenanceTask' | 'GlobalMaintenanceTask' | 'AgentUpdate'

The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, ChocolateySoftware = 3, NiniteSoftware = 4, LocalMaintenanceTask = 5, GlobalMaintenanceTask = 6, AgentUpdate = 7

maintenanceIdentifierstring nullable required
desiredSoftwareState'NewerOrEqualVersion' | 'NotPresent' | 'AnyVersion' | 'ThisVersion' | 'OlderOrEqualVersion' | 'LatestVersion' | 'NoAction' | 'UpdateIfFound'

The string or integer value may be used. NewerOrEqualVersion = 0, NotPresent = 1, AnyVersion = 2, ThisVersion = 3, OlderOrEqualVersion = 4, LatestVersion = 5, NoAction = 6, UpdateIfFound = 7

descriptionstring nullable
postMaintenanceTeststring nullable
postMaintenanceTestTypeinteger nullable
postMaintenanceTestResultboolean nullable
postMaintenanceTestResultMessagestring nullable
maintenanceTypeNamestring nullable
maintenanceDisplayNamestring nullable
detectedVersionStringstring nullable
desiredVersionStringstring nullable
reason'SoftwareMissing' | 'UpdateAvailable' | 'UpToDate' | 'NotAssigned' | 'TestFailed' | 'SoftwareDetected' | 'OlderVersionRequired' | 'NoApplicableSoftwareVersion' | 'NoAction' | 'Undetermined' | 'TaskEnforce' | 'TaskAudit' | 'TaskMonitor' | 'TaskNotCompliant' | 'TaskCompliant' | 'DeviceOffline' | 'RepairTriggered'

The string or integer value may be used. SoftwareMissing = 0, UpdateAvailable = 1, UpToDate = 2, NotAssigned = 3, TestFailed = 4, SoftwareDetected = 5, OlderVersionRequired = 6, NoApplicableSoftwareVersion = 7, NoAction = 8, Undetermined = 9, TaskEnforce = 10, TaskAudit = 11, TaskMonitor = 12, TaskNotCompliant = 13, TaskCompliant = 14, DeviceOffline = 15, RepairTriggered = 16

result'Pending' | 'Success' | 'Failed' | 'Cancelled' | 'Indeterminable' | 'Resolved'

The string or integer value may be used. Pending = 0, Success = 1, Failed = 2, Cancelled = 3, Indeterminable = 4, Resolved = 5

resultNamestring nullable
maintenanceTaskMode'Enforce' | 'Audit' | 'Monitor' | 'NoAction'

The string or integer value may be used. Enforce = 0, Audit = 1, Monitor = 2, NoAction = 3

maintenanceTaskGetResultstring nullable
createdDateUTCstring date-time
updatedDateUTCstring date-time
updatedByinteger nullable
createdByinteger nullable
softwareType'GlobalSoftware' | 'LocalSoftware' | 'WindowsUpdate' | 'Chocolatey' | 'Ninite'

The string or integer value may be used. GlobalSoftware = 0, LocalSoftware = 1, WindowsUpdate = 2, Chocolatey = 3, Ninite = 4

maintenanceTaskType'Global' | 'Local'

The string or integer value may be used. Global = 0, Local = 1

resultReason'NoLicenseAvailable' | 'SoftwareNotFound' | 'DetectionActionFailed' | 'TaskNotFound' | 'TaskNotCompliant' | 'TaskCompliant' | 'TaskSetIsMissing' | 'TaskTestIsMissing' | 'TaskGetIsMissing' | 'SoftwareConfigurationTaskMissing' | 'TaskModeIsMissing' | 'DeviceOffline' | 'RebootsSuppressed'

The string or integer value may be used. NoLicenseAvailable = 0, SoftwareNotFound = 1, DetectionActionFailed = 2, TaskNotFound = 3, TaskNotCompliant = 4, TaskCompliant = 5, TaskSetIsMissing = 6, TaskTestIsMissing = 7, TaskGetIsMissing = 8, SoftwareConfigurationTaskMissing = 9, TaskModeIsMissing = 10, DeviceOffline = 11, RebootsSuppressed = 12

resultReasonMessagestring nullable
dependsOnNamesstring[] nullable
dependentsNamesstring[] nullable
softwareActionIdForConfigurationTaskinteger nullable
softwareProviderType'Ninite' | 'Chocolatey' | 'Inherent'

The string or integer value may be used. Ninite = 1, Chocolatey = 2, Inherent = 3

policyDescriptionstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.