Resource

Scheduled Maintenance Note Template

Manage scheduled maintenance note templates for your project

The Scheduled Maintenance Note Template 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
note
Type
Markdown
Description
Note template for public or private notes. This is in markdown.
Name
templateName
Type
TextRequired
Description
Name of the Incident Template
Name
templateDescription
Type
Long TextRequired
Description
Description of the Incident Template
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)

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

List

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

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Body

{
  "select": {
    "projectId": true,
    "templateDescription": true,
    "templateName": true,
    "createdByUser": true,
    "createdByUserId": true
  },
  "query": {
    "templateDescription": "This template is used to document the completion of scheduled maintenance activities. It provides a structured format for summarizing the work performed, verifying system health, and communicating the maintenance outcome to stakeholders."
  },
  "sort": {
    "createdAt": -1
  }
}

Response

{
  "count": 10,
  "limit": 10,
  "skip": 0,
  "data": [
    {
      "_id": "377980f0-28fe-11f1-b591-3fdcef396aba",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "templateDescription": "This template is used to document the completion of scheduled maintenance activities. It provides a structured format for summarizing the work performed, verifying system health, and communicating the maintenance outcome to stakeholders.",
      "templateName": "Maintenance Completion Summary",
      "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    {
      "_id": "377980f1-28fe-11f1-b591-3fdcef396aba",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "templateDescription": "This template is used to document the completion of scheduled maintenance activities. It provides a structured format for summarizing the work performed, verifying system health, and communicating the maintenance outcome to stakeholders.",
      "templateName": "Maintenance Completion Summary",
      "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    {
      "_id": "377980f2-28fe-11f1-b591-3fdcef396aba",
      "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
      "templateDescription": "This template is used to document the completion of scheduled maintenance activities. It provides a structured format for summarizing the work performed, verifying system health, and communicating the maintenance outcome to stakeholders.",
      "templateName": "Maintenance Completion Summary",
      "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    }
  ]
}

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

Get item by ID

This endpoint allows you to retrieve Scheduled Maintenance Note Template 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-note-template/:id/get-item

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Body

{
  "select": {
    "projectId": true,
    "templateDescription": true,
    "templateName": true,
    "createdByUser": true,
    "createdByUserId": true
  }
}

Response

{
  "_id": "377980f0-28fe-11f1-b591-3fdcef396aba",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "templateDescription": "This template is used to document the completion of scheduled maintenance activities. It provides a structured format for summarizing the work performed, verifying system health, and communicating the maintenance outcome to stakeholders.",
  "templateName": "Maintenance Completion Summary",
  "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

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

Count

This endpoint allows you to retrieve the count of all your Scheduled Maintenance Note Template.

Optional Request Body

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

Count Request

POST

/api/scheduled-maintenance-note-template/count

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Body

{
  "query": {
    "templateDescription": "This template is used to document the completion of scheduled maintenance activities. It provides a structured format for summarizing the work performed, verifying system health, and communicating the maintenance outcome to stakeholders."
  }
}

Response

{
  "count": 107
}

POST/api/scheduled-maintenance-note-template

Create Scheduled Maintenance Note Template

This endpoint allows you to create a new object.

Create Request

POST

/api/scheduled-maintenance-note-template

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Body

{
  "data": {
    "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
    "templateDescription": "This template is used to document the completion of scheduled maintenance activities. It provides a structured format for summarizing the work performed, verifying system health, and communicating the maintenance outcome to stakeholders.",
    "templateName": "Maintenance Completion Summary",
    "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
}

Response

{
  "_id": "377980f0-28fe-11f1-b591-3fdcef396aba",
  "projectId": "5f8b9c0d-e1a2-4b3c-8d5e-6f7a8b9c0d1e",
  "templateDescription": "This template is used to document the completion of scheduled maintenance activities. It provides a structured format for summarizing the work performed, verifying system health, and communicating the maintenance outcome to stakeholders.",
  "templateName": "Maintenance Completion Summary",
  "createdByUser": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "createdByUserId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

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

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

Update Request

PUT

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

Headers

Content-Type: application/json
ApiKey: YOUR_API_KEY

Body

{
  "data": {
    "templateDescription": "This template is used to document the completion of scheduled maintenance activities. It provides a structured format for summarizing the work performed, verifying system health, and communicating the maintenance outcome to stakeholders.",
    "templateName": "Maintenance Completion Summary",
    "note": "## Scheduled Maintenance Update\n\n**Maintenance Window**: {{maintenance.scheduledAt}} - {{maintenance.endTime}}\n\n**Affected Services**: {{maintenance.services}}\n\n**Status**: The scheduled maintenance has been completed successfully. All systems are now operational.\n\n**Summary of Work Performed**:\n- Database schema upgrades applied\n- Security patches installed\n- Performance optimizations implemented\n\n**Verification**: All post-maintenance tests have passed. Services are running normally.\n\n**Next Scheduled Maintenance**: TBD"
  }
}

Response

{}

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

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

Delete Request

DELETE

/api/scheduled-maintenance-note-template/: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 Note Template

Project Owner
Project Admin
Project Member
Read Scheduled Maintenance Note Template
Read All Project Resources

Create Permissions

Required to create Scheduled Maintenance Note Template

Project Owner
Project Admin
Project Member
Create Scheduled Maintenance Note Template

Update Permissions

Required to update Scheduled Maintenance Note Template

Project Owner
Project Admin
Project Member
Edit Scheduled Maintenance Note Template

Delete Permissions

Required to delete Scheduled Maintenance Note Template

Project Owner
Project Admin
Project Member
Delete Scheduled Maintenance Note Template