Resource

Scheduled Event Public Note

Manage public notes for your scheduled event

The Scheduled Event Public Note 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
note
Type
Markdown
Description
Notes in markdown
Name
attachments
Type
File
Description
Files attached to this note
Name
subscriberNotificationStatusMessage
Type
Very Long Text
Description
Status message for subscriber notifications - includes success messages, failure reasons, or skip reasons
Name
shouldStatusPageSubscribersBeNotifiedOnNoteCreated
Type
Boolean
Description
Should subscribers be notified about this note?
Name
postedAt
Type
Date
Description
Date and time when the note was posted
Name
postedFromSlackMessageId
Type
Long Text
Description
Unique identifier for the Slack message this note was created from (channel_id:message_ts). Used to prevent duplicate notes when multiple users react to the same message.

GETorPOST/api/scheduled-maintenance-public-note/get-list

List

This endpoint allows you to retrieve a paginated list of all your Scheduled Event Public Note. By default, a maximum of ten Scheduled Event Public Note 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 Event Public Note. 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-public-note/get-list?skip=0&limit=10

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Body

{
  "select": {
    "projectId": true,
    "scheduledMaintenanceId": true,
    "createdByUserId": true,
    "note": true,
    "postedAt": true
  },
  "query": {
    "postedFromSlackMessageId": "C1234567890:1234567890.123456"
  },
  "sort": {
    "createdAt": -1
  }
}

Response

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "3778e4b0-28fe-11f1-b591-3fdcef396aba",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "scheduledMaintenanceId": "f6a7b8c9-d0e1-2345-f6a7-b8c9d0e12345",
      "createdByUserId": "b2c3d4e5-f6a7-8901-b2c3-d4e5f6a78901",
      "note": "## Maintenance Update\n\nThe scheduled maintenance is proceeding as planned. We expect to complete the database migration within the next hour.\n\n- Database migration: **In Progress**\n- Estimated completion: 2:00 PM UTC",
      "postedAt": "2024-01-15T14:30:00.000Z"
    },
    {
      "_id": "3778e4b1-28fe-11f1-b591-3fdcef396aba",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "scheduledMaintenanceId": "f6a7b8c9-d0e1-2345-f6a7-b8c9d0e12345",
      "createdByUserId": "b2c3d4e5-f6a7-8901-b2c3-d4e5f6a78901",
      "note": "## Maintenance Update\n\nThe scheduled maintenance is proceeding as planned. We expect to complete the database migration within the next hour.\n\n- Database migration: **In Progress**\n- Estimated completion: 2:00 PM UTC",
      "postedAt": "2024-01-15T14:30:00.000Z"
    },
    {
      "_id": "3778e4b2-28fe-11f1-b591-3fdcef396aba",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "scheduledMaintenanceId": "f6a7b8c9-d0e1-2345-f6a7-b8c9d0e12345",
      "createdByUserId": "b2c3d4e5-f6a7-8901-b2c3-d4e5f6a78901",
      "note": "## Maintenance Update\n\nThe scheduled maintenance is proceeding as planned. We expect to complete the database migration within the next hour.\n\n- Database migration: **In Progress**\n- Estimated completion: 2:00 PM UTC",
      "postedAt": "2024-01-15T14:30:00.000Z"
    }
  ]
}

GETorPOST/api/scheduled-maintenance-public-note/:id/get-item

Get item by ID

This endpoint allows you to retrieve Scheduled Event Public Note 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-public-note/:id/get-item

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Body

{
  "select": {
    "projectId": true,
    "scheduledMaintenanceId": true,
    "createdByUserId": true,
    "note": true,
    "postedAt": true
  }
}

Response

{
  "_id": "3778e4b0-28fe-11f1-b591-3fdcef396aba",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "scheduledMaintenanceId": "f6a7b8c9-d0e1-2345-f6a7-b8c9d0e12345",
  "createdByUserId": "b2c3d4e5-f6a7-8901-b2c3-d4e5f6a78901",
  "note": "## Maintenance Update\n\nThe scheduled maintenance is proceeding as planned. We expect to complete the database migration within the next hour.\n\n- Database migration: **In Progress**\n- Estimated completion: 2:00 PM UTC",
  "postedAt": "2024-01-15T14:30:00.000Z"
}

POST/api/scheduled-maintenance-public-note/count

Count

This endpoint allows you to retrieve the count of all your Scheduled Event Public Note.

Optional Request Body

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

Count Request

POST

/api/scheduled-maintenance-public-note/count

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Body

{
  "query": {
    "postedFromSlackMessageId": "C1234567890:1234567890.123456"
  }
}

Response

{
  "count": 107
}

POST/api/scheduled-maintenance-public-note

Create Scheduled Event Public Note

This endpoint allows you to create a new object.

Create Request

POST

/api/scheduled-maintenance-public-note

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Body

{
  "data": {
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "scheduledMaintenanceId": "f6a7b8c9-d0e1-2345-f6a7-b8c9d0e12345",
    "createdByUserId": "b2c3d4e5-f6a7-8901-b2c3-d4e5f6a78901",
    "note": "## Maintenance Update\n\nThe scheduled maintenance is proceeding as planned. We expect to complete the database migration within the next hour.\n\n- Database migration: **In Progress**\n- Estimated completion: 2:00 PM UTC",
    "postedAt": "2024-01-15T14:30:00.000Z"
  }
}

Response

{
  "_id": "3778e4b0-28fe-11f1-b591-3fdcef396aba",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "scheduledMaintenanceId": "f6a7b8c9-d0e1-2345-f6a7-b8c9d0e12345",
  "createdByUserId": "b2c3d4e5-f6a7-8901-b2c3-d4e5f6a78901",
  "note": "## Maintenance Update\n\nThe scheduled maintenance is proceeding as planned. We expect to complete the database migration within the next hour.\n\n- Database migration: **In Progress**\n- Estimated completion: 2:00 PM UTC",
  "postedAt": "2024-01-15T14:30:00.000Z"
}

PUT/api/scheduled-maintenance-public-note/: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-public-note/:id/update-item

GET/api/scheduled-maintenance-public-note/:id/update-item

Update Request

PUT

/api/scheduled-maintenance-public-note/:id

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Body

{
  "data": {
    "note": "## Maintenance Update\n\nThe scheduled maintenance is proceeding as planned. We expect to complete the database migration within the next hour.\n\n- Database migration: **In Progress**\n- Estimated completion: 2:00 PM UTC",
    "postedAt": "2024-01-15T14:30:00.000Z",
    "subscriberNotificationStatusMessage": "Successfully sent notification to 150 subscribers"
  }
}

Response

{}

DELETE/api/scheduled-maintenance-public-note/: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-public-note/:id/delete-item

GET/api/scheduled-maintenance-public-note/:id/delete-item

Delete Request

DELETE

/api/scheduled-maintenance-public-note/: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 Event Public Note

Project Owner
Project Admin
Project Member
Read Scheduled Maintenance Status Page Note
Read All Project Resources

Create Permissions

Required to create Scheduled Event Public Note

Project Owner
Project Admin
Project Member
Create Scheduled Maintenance Status Page Note

Update Permissions

Required to update Scheduled Event Public Note

Project Owner
Project Admin
Project Member
Edit Scheduled Maintenance Status Page Note

Delete Permissions

Required to delete Scheduled Event Public Note

Project Owner
Project Admin
Project Member
Delete Scheduled Maintenance Status Page Note