Jump to

• Request
• Response

Create a Maintenance Activity

post

/serviceapi/entityModel/data/entities/maintenances

DATA_ENTITIES_MAINTENANCES_Create

API View: Standard

Request

Supported Media Types

• application/json

Body ()

the user input provided for creating a maintenance

Root Schema : CreateMaintenanceDetails

Type: object

Defines the details required for creating a maintenance activity

Show Source

• comment(optional): string
  Comment for creating the Maintenance Activity

  API View: Standard

• durationHours(optional): integer(int32)
  Duration of the maintenance activity in hours

  API View: Standard

• durationMinutes(optional): integer(int32)
  Duration of the maintenance activity in minutes

  API View: Standard

• 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

  API View: Standard

• endTimeUtc(optional): string(date-time)
  End time of the maintenance schedule in UTC

  API View: Standard

• immediateStartFlag(optional): boolean
  Default Value: false

  Flag indicating whether to use current time as start time of maintenance activity or not

  API View: Standard

• name: string
  Name of the Maintenance Activity

  API View: Standard

• selectedEntities: array selectedEntities
  List of details of entities to be put under maintenance

  API View: Standard

• 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

  API View: Standard

• startTimeUtc(optional): string(date-time)
  Start time of the maintenance schedule in UTC

  API View: Standard

{
    "type":"object",
    "required":[
        "name",
        "selectedEntities"
    ],
    "properties":{
        "comment":{
            "type":"string",
            "description":"Comment for creating the Maintenance Activity<p>API View: Standard</p>",
            "x-api-view":"default"
        },
        "durationHours":{
            "type":"integer",
            "format":"int32",
            "description":"Duration of the maintenance activity in hours<p>API View: Standard</p>",
            "x-api-view":"default"
        },
        "durationMinutes":{
            "type":"integer",
            "format":"int32",
            "description":"Duration of the maintenance activity in minutes<p>API View: Standard</p>",
            "x-api-view":"default"
        },
        "durationType":{
            "type":"string",
            "description":"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<p>API View: Standard</p>",
            "enum":[
                "DURATION",
                "END_TIME",
                "INDEFINITE"
            ],
            "x-api-view":"default"
        },
        "endTimeUtc":{
            "type":"string",
            "format":"date-time",
            "description":"End time of the maintenance schedule in UTC<p>API View: Standard</p>",
            "x-api-view":"default"
        },
        "immediateStartFlag":{
            "type":"boolean",
            "description":"Flag indicating whether to use current time as start time of maintenance activity or not<p>API View: Standard</p>",
            "default":false,
            "x-api-view":"default"
        },
        "name":{
            "type":"string",
            "description":"Name of the Maintenance Activity<p>API View: Standard</p>",
            "x-api-view":"default"
        },
        "selectedEntities":{
            "type":"array",
            "description":"List of details of entities to be put under maintenance<p>API View: Standard</p>",
            "items":{
                "$ref":"#/definitions/CreateMaintenanceEntityDetails"
            },
            "x-api-view":"default"
        },
        "slaStatus":{
            "type":"string",
            "description":"Enum indicating service level agreement on how the availability computation needs to be done<p>API View: Standard</p>",
            "enum":[
                "EXCLUDE_FROM_COMPUTATION",
                "INCLUDE_IN_COMPUTATION_AS_ACTUAL",
                "INCLUDE_IN_COMPUTATION_AS_UP"
            ],
            "x-api-view":"default"
        },
        "startTimeUtc":{
            "type":"string",
            "format":"date-time",
            "description":"Start time of the maintenance schedule in UTC<p>API View: Standard</p>",
            "x-api-view":"default"
        }
    },
    "description":"<p>Defines the details required for creating a maintenance activity</p>"
}

Nested Schema : selectedEntities

Type: array

List of details of entities to be put under maintenance

API View: Standard

Show Source

• Array of: object CreateMaintenanceEntityDetails
  Details of entities selected by the user for maintenance activity

{
    "type":"array",
    "description":"List of details of entities to be put under maintenance<p>API View: Standard</p>",
    "items":{
        "$ref":"#/definitions/CreateMaintenanceEntityDetails"
    },
    "x-api-view":"default"
}

Nested Schema : CreateMaintenanceEntityDetails

Type: object

Details of entities selected by the user for maintenance activity

Show Source

• entityName(optional): string
  Entity name

  API View: Standard

• entityType(optional): string
  Entity type

  API View: Standard

{
    "type":"object",
    "properties":{
        "entityName":{
            "type":"string",
            "description":"Entity name<p>API View: Standard</p>",
            "x-api-view":"default"
        },
        "entityType":{
            "type":"string",
            "description":"Entity type<p>API View: Standard</p>",
            "x-api-view":"default"
        }
    },
    "description":"Details of entities selected by the user for maintenance activity"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

successful operation

Body ()

Root Schema : MaintenanceDetails

Type: object

Defines the details of a maintenance activity

Show Source

• 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

{
    "type":"object",
    "required":[
        "frequencyCode",
        "id",
        "name",
        "selectedEntities"
    ],
    "properties":{
        "comment":{
            "type":"string",
            "description":"Comment for creating the Maintenance Activity"
        },
        "day":{
            "type":"string",
            "description":"Specific day on which a maintenance scheduled to repeat on specific day needs to run"
        },
        "durationHours":{
            "type":"integer",
            "format":"int32",
            "description":"Duration of the maintenance activity in hours"
        },
        "durationMinutes":{
            "type":"integer",
            "format":"int32",
            "description":"Duration of the maintenance activity in minutes"
        },
        "durationType":{
            "type":"string",
            "description":"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",
            "enum":[
                "DURATION",
                "END_TIME",
                "INDEFINITE"
            ]
        },
        "endTimeUtc":{
            "type":"string",
            "description":"End time of the maintenance schedule"
        },
        "frequencyCode":{
            "type":"string",
            "description":"Frequency code indicating how the maintenance schedule should operate",
            "enum":[
                "ONE_TIME_SCHEDULE",
                "REPEAT_DAILY",
                "REPEAT_SPECIFIC_DAY_OF_WEEK",
                "REPEAT_FIRST_DAY_OF_WEEK_EVERY_MONTH"
            ]
        },
        "id":{
            "type":"string",
            "description":"Id of the maintenance activity",
            "readOnly":true
        },
        "immediateStartFlag":{
            "type":"boolean",
            "description":"Flag indicating whether to use current time as start time of maintenance activity or not",
            "default":false
        },
        "name":{
            "type":"string",
            "description":"Name of the Maintenance Activity"
        },
        "selectedEntities":{
            "type":"array",
            "description":"List of entities to be put under maintenance",
            "items":{
                "$ref":"#/definitions/MaintenanceEntityWithMembers"
            }
        },
        "slaStatus":{
            "type":"string",
            "description":"Enum indicating service level agreement on how the availability computation needs to be done",
            "enum":[
                "EXCLUDE_FROM_COMPUTATION",
                "INCLUDE_IN_COMPUTATION_AS_ACTUAL",
                "INCLUDE_IN_COMPUTATION_AS_UP"
            ]
        },
        "startTimeUtc":{
            "type":"string",
            "description":"Start time of the maintenance schedule"
        },
        "type":{
            "type":"string",
            "description":"Type of the Maintenance Activity",
            "enum":[
                "NOTIFICATION_BLACKOUT",
                "MONITORING_BLACKOUT"
            ]
        }
    },
    "description":"<p>Defines the details of a maintenance activity</p>"
}

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

{
    "type":"array",
    "description":"List of entities to be put under maintenance",
    "items":{
        "$ref":"#/definitions/MaintenanceEntityWithMembers"
    }
}

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

{
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"Total numberof members for this entity"
        },
        "entityId":{
            "type":"string",
            "description":"Entity Id"
        },
        "entityName":{
            "type":"string",
            "description":"Entity name"
        },
        "entityType":{
            "type":"string",
            "description":"Entity type"
        },
        "hasMembers":{
            "type":"boolean",
            "description":"indicates if the selected target has members or not",
            "readOnly":true,
            "default":false
        },
        "memberEntities":{
            "type":"array",
            "description":"Member entities impacted due to maintenance on selected entity",
            "items":{
                "$ref":"#/definitions/MaintenanceMemberEntity"
            }
        }
    },
    "description":"Selected entitiy along with all its member target hierarchy"
}

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

{
    "type":"array",
    "description":"Member entities impacted due to maintenance on selected entity",
    "items":{
        "$ref":"#/definitions/MaintenanceMemberEntity"
    }
}

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

{
    "type":"object",
    "properties":{
        "entityId":{
            "type":"string",
            "description":"Entity Id<p>API View: Standard</p>",
            "x-api-view":"default"
        },
        "entityName":{
            "type":"string",
            "description":"Entity name<p>API View: Standard</p>",
            "x-api-view":"default"
        },
        "entityType":{
            "type":"string",
            "description":"Entity type<p>API View: Standard</p>",
            "x-api-view":"default"
        }
    },
    "description":"Member entity being put under maintenance as part of maintenance on a parent entity"
}

Back to Top