Resource

Scheduled Maintenance State Timeline

Change state of your scheduled maintenance event.

The Scheduled Maintenance State Timeline Model

Properties

Name
_id
Type
Object ID
Description
ID of this object
Name
createdAt
Type
Date
Description
Date and Time when the object was created.
Name
updatedAt
Type
Date
Description
Date and Time when the object was updated.
Name
project
Type
Project
Description
Relation to Project Resource in which this object belongs
Name
projectId
Type
Object IDRequired
Description
ID of your Project in which this object belongs
Name
scheduledMaintenance
Type
Scheduled Maintenance Event
Description
Relation to Scheduled Maintenance Event this resource belongs to
Name
scheduledMaintenanceId
Type
Object IDRequired
Description
ID of Scheduled Maintenance this resource belongs to
Name
createdByUser
Type
User
Description
Relation to User who created this object (if this object was created by a User)
Name
createdByUserId
Type
Object ID
Description
User ID who created this object (if this object was created by a User)
Name
scheduledMaintenanceState
Type
Scheduled Maintenance State
Description
Which state does this event belongs to?. Relation to Scheduled Maintenance State
Name
scheduledMaintenanceStateId
Type
Object IDRequired
Description
Scheduled Maintenance State ID. Which state does this event belongs to?
Name
subscriberNotificationStatusMessage
Type
Very Long Text
Description
Status message for subscriber notifications - includes success messages, failure reasons, or skip reasons
Name
shouldStatusPageSubscribersBeNotified
Type
Boolean
Description
Should subscribers be notified about this state change?
Name
endsAt
Type
Date
Description
When did this status change end?
Name
startsAt
Type
Date
Description
When did this status change?

GETorPOST/api/scheduled-maintenance-state-timeline/get-list

List

This endpoint allows you to retrieve a paginated list of all your Scheduled Maintenance State Timeline. By default, a maximum of ten Scheduled Maintenance State Timeline are shown per page.

Optional Query Params

limit
number
Number of objects to fetch. By default 10, you can increase this count up to 100
skip
number
Number of objects to skip. This can be useful in pagination

Optional Request Body

query
If you would like to filter on Scheduled Maintenance State Timeline. You can specify include a query here. For more information, please check out writing queries here.
select
By default you will only retrieve ID of objects, to retrieve more fields you need to select them. For more information, please check how to select here.
sort
Objects will be sorted based on created date by default. You can change the sort order — see Data Types: Sort.

List Request

POST

/api/scheduled-maintenance-state-timeline/get-list?skip=0&limit=10

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Body

{
  "select": {
    "projectId": true,
    "scheduledMaintenanceId": true,
    "scheduledMaintenanceStateId": true,
    "createdByUser": true,
    "createdByUserId": true
  },
  "query": {
    "subscriberNotificationStatusMessage": "Maintenance notification sent to 152 subscribers. Scheduled maintenance window: 2024-01-16 02:00-04:00 UTC"
  },
  "sort": {
    "createdAt": -1
  }
}

Response

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "3779cf10-28fe-11f1-b591-3fdcef396aba",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "scheduledMaintenanceId": "c9d0e1f2-a3b4-5678-90ab-cdef01234567",
      "scheduledMaintenanceStateId": "d0e1f2a3-b4c5-6789-01ab-cdef12345678",
      "createdByUser": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "createdByUserId": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
    },
    {
      "_id": "3779cf11-28fe-11f1-b591-3fdcef396aba",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "scheduledMaintenanceId": "c9d0e1f2-a3b4-5678-90ab-cdef01234567",
      "scheduledMaintenanceStateId": "d0e1f2a3-b4c5-6789-01ab-cdef12345678",
      "createdByUser": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "createdByUserId": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
    },
    {
      "_id": "3779cf12-28fe-11f1-b591-3fdcef396aba",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "scheduledMaintenanceId": "c9d0e1f2-a3b4-5678-90ab-cdef01234567",
      "scheduledMaintenanceStateId": "d0e1f2a3-b4c5-6789-01ab-cdef12345678",
      "createdByUser": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "createdByUserId": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
    }
  ]
}

GETorPOST/api/scheduled-maintenance-state-timeline/:id/get-item

Get item by ID

This endpoint allows you to retrieve Scheduled Maintenance State Timeline by ID.

id
text
ID of the Object

Optional Request Body

select
By default you will only retrieve ID of objects, to retrieve more fields you need to select them. For more information, please check how to select here.

Get Item Request

POST

/api/scheduled-maintenance-state-timeline/:id/get-item

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Body

{
  "select": {
    "projectId": true,
    "scheduledMaintenanceId": true,
    "scheduledMaintenanceStateId": true,
    "createdByUser": true,
    "createdByUserId": true
  }
}

Response

{
  "_id": "3779cf10-28fe-11f1-b591-3fdcef396aba",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "scheduledMaintenanceId": "c9d0e1f2-a3b4-5678-90ab-cdef01234567",
  "scheduledMaintenanceStateId": "d0e1f2a3-b4c5-6789-01ab-cdef12345678",
  "createdByUser": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "createdByUserId": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
}

POST/api/scheduled-maintenance-state-timeline/count

Count

This endpoint allows you to retrieve the count of all your Scheduled Maintenance State Timeline.

Optional Request Body

query
If you would like to filter on Scheduled Maintenance State Timeline. You can specify include a query here. For more information, please check out writing queries here.

Count Request

POST

/api/scheduled-maintenance-state-timeline/count

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Body

{
  "query": {
    "subscriberNotificationStatusMessage": "Maintenance notification sent to 152 subscribers. Scheduled maintenance window: 2024-01-16 02:00-04:00 UTC"
  }
}

Response

{
  "count": 107
}

POST/api/scheduled-maintenance-state-timeline

Create Scheduled Maintenance State Timeline

This endpoint allows you to create a new object.

Create Request

POST

/api/scheduled-maintenance-state-timeline

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Body

{
  "data": {
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "scheduledMaintenanceId": "c9d0e1f2-a3b4-5678-90ab-cdef01234567",
    "scheduledMaintenanceStateId": "d0e1f2a3-b4c5-6789-01ab-cdef12345678",
    "createdByUser": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "createdByUserId": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
  }
}

Response

{
  "_id": "3779cf10-28fe-11f1-b591-3fdcef396aba",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "scheduledMaintenanceId": "c9d0e1f2-a3b4-5678-90ab-cdef01234567",
  "scheduledMaintenanceStateId": "d0e1f2a3-b4c5-6789-01ab-cdef12345678",
  "createdByUser": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "createdByUserId": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
}

PUT/api/scheduled-maintenance-state-timeline/:id

Update by ID

This endpoint allows you to update object by its ID.

Alternative Methods

For clients that do not support PUT requests, you can use POST or GET with the same request headers and body:

POST/api/scheduled-maintenance-state-timeline/:id/update-item

GET/api/scheduled-maintenance-state-timeline/:id/update-item

Update Request

PUT

/api/scheduled-maintenance-state-timeline/:id

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Body

{
  "data": {
    "scheduledMaintenanceStateId": "d0e1f2a3-b4c5-6789-01ab-cdef12345678",
    "scheduledMaintenanceState": "d0e1f2a3-b4c5-6789-01ab-cdef12345678",
    "subscriberNotificationStatusMessage": "Maintenance notification sent to 152 subscribers. Scheduled maintenance window: 2024-01-16 02:00-04:00 UTC"
  }
}

Response

{}

DELETE/api/scheduled-maintenance-state-timeline/:id

Delete by ID

This endpoint allows you to delete object by its ID.

Alternative Methods

For clients that do not support DELETE requests, you can use POST or GET with the same request headers and body:

POST/api/scheduled-maintenance-state-timeline/:id/delete-item

GET/api/scheduled-maintenance-state-timeline/:id/delete-item

Delete Request

DELETE

/api/scheduled-maintenance-state-timeline/:id

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Response

{}

Permissions

Your API Token needs permissions to create, update, read or delete this resource. If you do not have permissions to make a request a 4xx status will be sent as response.

Read Permissions

Required to read Scheduled Maintenance State Timeline

Project Owner
Project Admin
Project Member
Read Scheduled Maintenance State Timeline
Read All Project Resources

Create Permissions

Required to create Scheduled Maintenance State Timeline

Project Owner
Project Admin
Project Member
Create Scheduled Maintenance State Timeline

Update Permissions

Required to update Scheduled Maintenance State Timeline

Project Owner
Project Admin
Project Member
Edit Scheduled Maintenance State Timeline

Delete Permissions

Required to delete Scheduled Maintenance State Timeline

Project Owner
Project Admin
Project Member
Delete Scheduled Maintenance State Timeline