Day Notes
Ask
List day notes
GET/v1/teams/{teamId}/days/{dayId}/notesLists notes for a day.
Required scopes: day_note:read
Parameters
path.teamIdrequired | string:uuidTeam identifier. |
|---|---|
path.dayIdrequired | string:uuidDay identifier. |
query.limit | integerMaximum number of records to return. Defaults to 50 and is capped at 200. |
query.cursor | stringCursor returned by page.nextCursor from the previous list response. |
Response 200
data | object[] |
|---|---|
data[].dayId | string:uuid |
data[].title | string |
data[].body | stringDay note body. New lines are represented with \n characters, and basic Markdown formatting is supported. |
data[].visibility | object |
data[].visibility.groupIds | string:uuid[] |
data[].visibility.userIds | string:uuid[] |
data[].id | string:uuid |
data[].orgId | string:uuid |
data[].isDeleted | boolean |
data[].version | integerCurrent day note aggregate version. |
data[].createdAt | string:date-timeISO 8601 timestamp when the day note was created. |
data[].createdBy | stringUser identifier that created the day note. |
data[].updatedAt | string:date-timeISO 8601 timestamp when the day note was last updated. |
data[].updatedBy | stringUser identifier that last updated the day note. |
data[].deletedAt | string:date-timeISO 8601 timestamp when the day note was deleted. |
data[].cursor | integerLatest event-ledger cursor projected into this day note record. |
page | object |
page.limit | integerMaximum number of records returned in this page. |
page.nextCursor | string | nullCursor to pass as the next request's cursor query parameter, or null when there are no more results. |
meta | object |
meta.cursor | number | nullHighest record cursor represented by this response. |
Create a day note
POST/v1/teams/{teamId}/days/{dayId}/notesAccepts a command to create a day note.
Required scopes: day_note:write
Parameters
path.teamIdrequired | string:uuidTeam identifier. |
|---|---|
path.dayIdrequired | string:uuidDay identifier. |
header.Idempotency-Key | string:uuidOptional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request. |
Request body (application/json)
title | string |
|---|---|
bodyrequired | stringDay note body. New lines are represented with \n characters, and basic Markdown formatting is supported. |
visibility | object |
visibility.groupIds | string:uuid[] |
visibility.userIds | string:uuid[] |
id | string:uuidOptional caller-supplied day note ID. RoadOps generates one when omitted. |
Response 202
commandId | string:uuidCommand identifier accepted into the RoadOps command ledger. |
|---|---|
resourceId | string:uuidIdentifier of the resource targeted by the command. |
resourceType | stringResource type targeted by the command. |
status | "applied"Command dispatch status. |
aggregateVersion | integerAggregate version produced by the accepted command. |
cursor | integerEvent-ledger cursor for the accepted update. Refetch until returned records reach this cursor. |
links | object |
links.refetch | stringRelative URL to refetch the affected resource. |
Retrieve a day note
GET/v1/teams/{teamId}/days/{dayId}/notes/{noteId}Returns one day note by ID.
Required scopes: day_note:read
Parameters
path.teamIdrequired | string:uuidTeam identifier. |
|---|---|
path.dayIdrequired | string:uuidDay identifier. |
path.noteIdrequired | string:uuidDay note identifier. |
Response 200
data | object |
|---|---|
data.dayId | string:uuid |
data.title | string |
data.body | stringDay note body. New lines are represented with \n characters, and basic Markdown formatting is supported. |
data.visibility | object |
data.visibility.groupIds | string:uuid[] |
data.visibility.userIds | string:uuid[] |
data.id | string:uuid |
data.orgId | string:uuid |
data.isDeleted | boolean |
data.version | integerCurrent day note aggregate version. |
data.createdAt | string:date-timeISO 8601 timestamp when the day note was created. |
data.createdBy | stringUser identifier that created the day note. |
data.updatedAt | string:date-timeISO 8601 timestamp when the day note was last updated. |
data.updatedBy | stringUser identifier that last updated the day note. |
data.deletedAt | string:date-timeISO 8601 timestamp when the day note was deleted. |
data.cursor | integerLatest event-ledger cursor projected into this day note record. |
meta | object |
meta.cursor | integerHighest record cursor represented by this response. |
Update a day note
PATCH/v1/teams/{teamId}/days/{dayId}/notes/{noteId}Accepts a command to update day note fields.
Required scopes: day_note:write
Parameters
path.teamIdrequired | string:uuidTeam identifier. |
|---|---|
path.dayIdrequired | string:uuidDay identifier. |
path.noteIdrequired | string:uuidDay note identifier. |
header.Idempotency-Key | string:uuidOptional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request. |
Request body (application/json)
expectedVersion | integerOptional aggregate version guard. |
|---|---|
updatesrequired | objectDay note fields to update. |
updates.title | string | nullUpdated note title, or null to clear it. |
updates.body | stringUpdated note body. New lines are represented with \n characters, and basic Markdown formatting is supported. |
updates.visibility | object | nullUpdated visibility, or null to clear custom visibility. |
updates.visibility.groupIds | string:uuid[] |
updates.visibility.userIds | string:uuid[] |
Response 202
commandId | string:uuidCommand identifier accepted into the RoadOps command ledger. |
|---|---|
resourceId | string:uuidIdentifier of the resource targeted by the command. |
resourceType | stringResource type targeted by the command. |
status | "applied"Command dispatch status. |
aggregateVersion | integerAggregate version produced by the accepted command. |
cursor | integerEvent-ledger cursor for the accepted update. Refetch until returned records reach this cursor. |
links | object |
links.refetch | stringRelative URL to refetch the affected resource. |
Delete a day note
DELETE/v1/teams/{teamId}/days/{dayId}/notes/{noteId}Accepts a command to delete a day note.
Required scopes: day_note:write
Parameters
path.teamIdrequired | string:uuidTeam identifier. |
|---|---|
path.dayIdrequired | string:uuidDay identifier. |
path.noteIdrequired | string:uuidDay note identifier. |
header.Idempotency-Key | string:uuidOptional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request. |
Response 202
commandId | string:uuidCommand identifier accepted into the RoadOps command ledger. |
|---|---|
resourceId | string:uuidIdentifier of the resource targeted by the command. |
resourceType | stringResource type targeted by the command. |
status | "applied"Command dispatch status. |
aggregateVersion | integerAggregate version produced by the accepted command. |
cursor | integerEvent-ledger cursor for the accepted update. Refetch until returned records reach this cursor. |
links | object |
links.refetch | stringRelative URL to refetch the affected resource. |