Incident Public Note
Create Incident Public Note
Endpoint to create a new Incident Public Note
post/incident-public-note
Request
- Base URLhttps://oneuptime.com/api
- AuthAPI key in header APIKey
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Example request
{
"data": {
"projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"incidentId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
}
}Response
Created successfully
Example response
{
"data": {
"_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"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"
},
"project": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"projectId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"incident": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"incidentId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"createdByUser": {
"_id": "bbbbbbbb-bbbb-bbbb-bbbb-bbbbbbbbbbbb"
},
"createdByUserId": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"note": null,
"attachments": [
{
"_id": "cccccccc-cccc-cccc-cccc-cccccccccccc"
},
{
"_id": "dddddddd-dddd-dddd-dddd-dddddddddddd"
}
],
"subscriberNotificationStatusMessage": "This is an example of longer text content that provides detailed information.",
"shouldStatusPageSubscribersBeNotifiedOnNoteCreated": true,
"postedAt": {
"_type": "DateTime",
"value": "2023-10-01T12:00:00Z"
},
"postedFromSlackMessageId": "This is an example of longer text content that provides detailed information.",
"savedFromChatMessage": {
"key": "value",
"nested": {
"data": 123
}
}
}
}Changes
No recorded changes to this operation across all 1 revision of this API.