Scheduled Maintenance Measurement

Get Scheduled Maintenance Measurement

Endpoint to retrieve a single Scheduled Maintenance Measurement by ID

post/scheduled-maintenance-measurement/{id}/get-item

Request

Path parameters

idstring uuid required

ID of the Scheduled Maintenance Measurement to retrieve

Request body

Example request

{
  "select": {
    "_id": true,
    "createdAt": true,
    "updatedAt": true,
    "name": true,
    "key": true,
    "metricName": true,
    "startAnchorType": true,
    "endAnchorType": true
  }
}

Response

Successful response

Example response

{
  "data": {
    "_id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "updatedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "deletedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "version": 42,
    "projectId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Time to Start",
    "key": "time-to-start",
    "description": "This is an example of longer text content that might be stored in this field.",
    "metricName": "oneuptime.scheduled-maintenance.measurement.time-to-start",
    "startAnchorType": "Created At",
    "endAnchorType": "State Role Entered",
    "startScheduledMaintenanceStateId": "123e4567-e89b-12d3-a456-426614174000",
    "endScheduledMaintenanceStateId": "123e4567-e89b-12d3-a456-426614174000",
    "startScheduledMaintenanceStateRole": "Scheduled",
    "endScheduledMaintenanceStateRole": "Ended",
    "startStateOccurrence": "First",
    "endStateOccurrence": "First",
    "unit": "Example short text",
    "aggregationType": "Avg",
    "isEnabled": true,
    "showOnScheduledMaintenanceView": true,
    "order": 42,
    "isSystemDefined": true,
    "backfillRequestedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "backfillCursorCreatedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "backfillCompletedAt": {
      "_type": "DateTime",
      "value": "2023-10-01T12:00:00Z"
    },
    "createdByUserId": "123e4567-e89b-12d3-a456-426614174000"
  }
}

Changes

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