Get details of a given maintenance activity
get
/serviceapi/entityModel/data/entities/maintenances/{maintenanceId}
DATA_ENTITIES_MAINTENANCES_Details
API View: Standard
Request
Supported Media Types
- application/json
Path Parameters
-
maintenanceId: string
the ID of the maintenance activity to be retrieved
Query Parameters
-
isExpandedList(optional): boolean
whether to return all the impacted members in Maintenance or just the top level entities selected for maintenance
Response
Supported Media Types
- application/json
200 Response
successful operation
Root Schema : MaintenanceDetails
Type:
object
Defines the details of a maintenance activity
-
comment(optional):
string
Comment for creating the Maintenance Activity
-
day(optional):
string
Specific day on which a maintenance scheduled to repeat on specific day needs to run
-
durationHours(optional):
integer(int32)
Duration of the maintenance activity in hours
-
durationMinutes(optional):
integer(int32)
Duration of the maintenance activity in minutes
-
durationType(optional):
string
Allowed Values:
[ "DURATION", "END_TIME", "INDEFINITE" ]
Valid for a one time schedule, indicates whether this maintenance is for indefinite duration or whether it is based on a given duration or end time -
endTimeUtc(optional):
string
End time of the maintenance schedule
-
frequencyCode:
string
Allowed Values:
[ "ONE_TIME_SCHEDULE", "REPEAT_DAILY", "REPEAT_SPECIFIC_DAY_OF_WEEK", "REPEAT_FIRST_DAY_OF_WEEK_EVERY_MONTH" ]
Frequency code indicating how the maintenance schedule should operate -
id:
string
Read Only:
true
Id of the maintenance activity -
immediateStartFlag(optional):
boolean
Default Value:
false
Flag indicating whether to use current time as start time of maintenance activity or not -
name:
string
Name of the Maintenance Activity
-
selectedEntities:
array selectedEntities
List of entities to be put under maintenance
-
slaStatus(optional):
string
Allowed Values:
[ "EXCLUDE_FROM_COMPUTATION", "INCLUDE_IN_COMPUTATION_AS_ACTUAL", "INCLUDE_IN_COMPUTATION_AS_UP" ]
Enum indicating service level agreement on how the availability computation needs to be done -
startTimeUtc(optional):
string
Start time of the maintenance schedule
-
type(optional):
string
Allowed Values:
[ "NOTIFICATION_BLACKOUT", "MONITORING_BLACKOUT" ]
Type of the Maintenance Activity
Nested Schema : selectedEntities
Type:
array
List of entities to be put under maintenance
Show Source
-
Array of:
object MaintenanceEntityWithMembers
Selected entitiy along with all its member target hierarchy
Nested Schema : MaintenanceEntityWithMembers
Type:
object
Selected entitiy along with all its member target hierarchy
Show Source
-
count(optional):
integer(int32)
Total numberof members for this entity
-
entityId(optional):
string
Entity Id
-
entityName(optional):
string
Entity name
-
entityType(optional):
string
Entity type
-
hasMembers(optional):
boolean
Read Only:
true
Default Value:false
indicates if the selected target has members or not -
memberEntities(optional):
array memberEntities
Member entities impacted due to maintenance on selected entity
Nested Schema : memberEntities
Type:
array
Member entities impacted due to maintenance on selected entity
Show Source
-
Array of:
object MaintenanceMemberEntity
Member entity being put under maintenance as part of maintenance on a parent entity
Nested Schema : MaintenanceMemberEntity
Type:
object
Member entity being put under maintenance as part of maintenance on a parent entity
Show Source
-
entityId(optional):
string
Entity Id
API View: Standard
-
entityName(optional):
string
Entity name
API View: Standard
-
entityType(optional):
string
Entity type
API View: Standard