Incident Public Note
Get Incident Public Note
Endpoint to retrieve a single Incident Public Note by ID
post/incident-public-note/{id}/get-item
Request
- Base URLhttps://oneuptime.com/api
- AuthAPI key in header APIKey
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring uuid required
ID of the Incident Public Note to retrieve
Request body
Example request
{
"select": {
"_id": true,
"createdAt": true,
"updatedAt": 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",
"incidentId": "123e4567-e89b-12d3-a456-426614174000",
"createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
"note": "# Heading\n\nThis is **markdown** content",
"attachments": [
{
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
],
"subscriberNotificationStatusOnNoteCreated": "Skipped",
"subscriberNotificationStatusMessage": "Successfully notified 1,234 subscribers via email and SMS",
"subscriberNotificationStatusOnNoteUpdated": "Skipped",
"subscriberNotificationStatusMessageOnNoteUpdated": "This is an example of very long text content that might be stored in this field. It can contain a lot of information, such as detailed descriptions, comments, or any other lengthy text data that needs to be stored in the database.",
"shouldStatusPageSubscribersBeNotifiedOnNoteCreated": true,
"isOwnerNotified": true,
"postedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"postedFromSlackMessageId": "C1234567890:1234567890.123456",
"postedWithIncidentStateId": "123e4567-e89b-12d3-a456-426614174000",
"savedFromChatMessage": {
"key": "value",
"nested": {
"data": 123
}
}
}
}Changes
No recorded changes to this operation across all 1 revision of this API.