MaintenanceSessions

get/api/v1/maintenance-sessions/{sessionId}

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-sessions/{sessionId}
  • Auth: none declared

Path parameters

sessionIdinteger required

Query parameters

includeActionsboolean
includeStagesboolean
includeActionActivitiesboolean

Response

OK

idinteger
jobIdstring nullable
computerIdinteger nullable
tenantIdinteger nullable
personIdinteger nullable
scheduledIdinteger nullable
sessionStatus'Passed' | 'Running' | 'Failed' | 'Created' | 'Cancelled' | 'Postponed' | 'Pending' | 'PartialPassed' | 'PendingConnectivity' | 'Missed' | 'MaxTrackedDevicesPerMonthExceeded' | 'PendingPreflight' | 'PendingEphemeralAgentConnection' | 'MaintenanceForTrackableDevicesNotAllowed'

The string or integer value may be used. Passed = 0, Running = 1, Failed = 2, Created = 3, Cancelled = 4, Postponed = 5, Pending = 6, PartialPassed = 7, PendingConnectivity = 8, Missed = 9, MaxTrackedDevicesPerMonthExceeded = 10, PendingPreflight = 11, PendingEphemeralAgentConnection = 12, MaintenanceForTrackableDevicesNotAllowed = 13

onboardingboolean
createdDateUTCstring date-time
updatedDateUTCstring date-time
updatedByIdinteger nullable
createdByIdinteger nullable
createdBystring nullable
fullMaintenanceboolean
computerNamestring nullable
tenantNamestring nullable
durationstring date-span nullable
onboardingStageStatus'Passed' | 'Running' | 'Failed' | 'Created' | 'Cancelled' | 'Postponed' | 'Pending' | 'PartialPassed' | 'PendingConnectivity' | 'Missed' | 'MaxTrackedDevicesPerMonthExceeded' | 'PendingPreflight' | 'PendingEphemeralAgentConnection' | 'MaintenanceForTrackableDevicesNotAllowed'

The string or integer value may be used. Passed = 0, Running = 1, Failed = 2, Created = 3, Cancelled = 4, Postponed = 5, Pending = 6, PartialPassed = 7, PendingConnectivity = 8, Missed = 9, MaxTrackedDevicesPerMonthExceeded = 10, PendingPreflight = 11, PendingEphemeralAgentConnection = 12, MaintenanceForTrackableDevicesNotAllowed = 13

detectionStageStatus'Passed' | 'Running' | 'Failed' | 'Created' | 'Cancelled' | 'Postponed' | 'Pending' | 'PartialPassed' | 'PendingConnectivity' | 'Missed' | 'MaxTrackedDevicesPerMonthExceeded' | 'PendingPreflight' | 'PendingEphemeralAgentConnection' | 'MaintenanceForTrackableDevicesNotAllowed'

The string or integer value may be used. Passed = 0, Running = 1, Failed = 2, Created = 3, Cancelled = 4, Postponed = 5, Pending = 6, PartialPassed = 7, PendingConnectivity = 8, Missed = 9, MaxTrackedDevicesPerMonthExceeded = 10, PendingPreflight = 11, PendingEphemeralAgentConnection = 12, MaintenanceForTrackableDevicesNotAllowed = 13

executionStageStatus'Passed' | 'Running' | 'Failed' | 'Created' | 'Cancelled' | 'Postponed' | 'Pending' | 'PartialPassed' | 'PendingConnectivity' | 'Missed' | 'MaxTrackedDevicesPerMonthExceeded' | 'PendingPreflight' | 'PendingEphemeralAgentConnection' | 'MaintenanceForTrackableDevicesNotAllowed'

The string or integer value may be used. Passed = 0, Running = 1, Failed = 2, Created = 3, Cancelled = 4, Postponed = 5, Pending = 6, PartialPassed = 7, PendingConnectivity = 8, Missed = 9, MaxTrackedDevicesPerMonthExceeded = 10, PendingPreflight = 11, PendingEphemeralAgentConnection = 12, MaintenanceForTrackableDevicesNotAllowed = 13

agentUpdatesStageStatus'Passed' | 'Running' | 'Failed' | 'Created' | 'Cancelled' | 'Postponed' | 'Pending' | 'PartialPassed' | 'PendingConnectivity' | 'Missed' | 'MaxTrackedDevicesPerMonthExceeded' | 'PendingPreflight' | 'PendingEphemeralAgentConnection' | 'MaintenanceForTrackableDevicesNotAllowed'

The string or integer value may be used. Passed = 0, Running = 1, Failed = 2, Created = 3, Cancelled = 4, Postponed = 5, Pending = 6, PartialPassed = 7, PendingConnectivity = 8, Missed = 9, MaxTrackedDevicesPerMonthExceeded = 10, PendingPreflight = 11, PendingEphemeralAgentConnection = 12, MaintenanceForTrackableDevicesNotAllowed = 13

resolutionStageStatus'Passed' | 'Running' | 'Failed' | 'Created' | 'Cancelled' | 'Postponed' | 'Pending' | 'PartialPassed' | 'PendingConnectivity' | 'Missed' | 'MaxTrackedDevicesPerMonthExceeded' | 'PendingPreflight' | 'PendingEphemeralAgentConnection' | 'MaintenanceForTrackableDevicesNotAllowed'

The string or integer value may be used. Passed = 0, Running = 1, Failed = 2, Created = 3, Cancelled = 4, Postponed = 5, Pending = 6, PartialPassed = 7, PendingConnectivity = 8, Missed = 9, MaxTrackedDevicesPerMonthExceeded = 10, PendingPreflight = 11, PendingEphemeralAgentConnection = 12, MaintenanceForTrackableDevicesNotAllowed = 13

inventoryStageStatus'Passed' | 'Running' | 'Failed' | 'Created' | 'Cancelled' | 'Postponed' | 'Pending' | 'PartialPassed' | 'PendingConnectivity' | 'Missed' | 'MaxTrackedDevicesPerMonthExceeded' | 'PendingPreflight' | 'PendingEphemeralAgentConnection' | 'MaintenanceForTrackableDevicesNotAllowed'

The string or integer value may be used. Passed = 0, Running = 1, Failed = 2, Created = 3, Cancelled = 4, Postponed = 5, Pending = 6, PartialPassed = 7, PendingConnectivity = 8, Missed = 9, MaxTrackedDevicesPerMonthExceeded = 10, PendingPreflight = 11, PendingEphemeralAgentConnection = 12, MaintenanceForTrackableDevicesNotAllowed = 13

scheduledExecutionDatestring date-time nullable

Changes

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