RoadOps Developer Docs

List day files

GET/v1/teams/{teamId}/days/{dayId}/files

Lists files attached to a day.

Required scopes: day_file:read

Parameters

`path.teamId`required	`string:uuid` Team identifier.
`path.dayId`required	`string:uuid` Day identifier.
`query.limit`	`integer` Maximum number of records to return. Defaults to 50 and is capped at 200.
`query.cursor`	`string` Cursor returned by page.nextCursor from the previous list response.

Response 200

`data`	`object[]`
`data[].dayId`	`string:uuid`
`data[].fileName`	`string`
`data[].contentType`	`string`
`data[].sizeBytes`	`integer`
`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`	`integer` Current day file aggregate version.
`data[].createdAt`	`string:date-time` ISO 8601 timestamp when the day file was created.
`data[].createdBy`	`string` User identifier that created the day file.
`data[].updatedAt`	`string:date-time` ISO 8601 timestamp when the day file was last updated.
`data[].updatedBy`	`string` User identifier that last updated the day file.
`data[].deletedAt`	`string:date-time` ISO 8601 timestamp when the day file was deleted.
`data[].cursor`	`integer` Latest event-ledger cursor projected into this day file record.
`page`	`object`
`page.limit`	`integer` Maximum number of records returned in this page.
`page.nextCursor`	`string \| null` Cursor to pass as the next request's cursor query parameter, or null when there are no more results.
`meta`	`object`
`meta.cursor`	`number \| null` Highest record cursor represented by this response.

Upload a day file

POST/v1/teams/{teamId}/days/{dayId}/files

Uploads one file attachment for a day and accepts a command to create the day file record. Send the request as multipart/form-data with the binary file in the file field. Optional text fields are id, fileName, and visibility. Direct uploads are capped at 10 MB.

Required scopes: day_file:write

Parameters

`path.teamId`required	`string:uuid` Team identifier.
`path.dayId`required	`string:uuid` Day identifier.
`header.Idempotency-Key`	`string:uuid` Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.

Request body (multipart/form-data)

`file`required	`string` Required multipart/form-data file part. Send the binary upload in a form field named file.
`id`	`string:uuid` Optional caller-supplied day file ID. RoadOps generates one when omitted.
`fileName`	`string` Optional multipart/form-data text field named fileName. Defaults to the uploaded file name.
`visibility`	`string` Optional multipart/form-data text field named visibility. The value must be a JSON string matching the RoadOps visibility object.

Response 202

`commandId`	`string:uuid` Command identifier accepted into the RoadOps command ledger.
`resourceId`	`string:uuid` Identifier of the resource targeted by the command.
`resourceType`	`string` Resource type targeted by the command.
`status`	`"applied"` Command dispatch status.
`aggregateVersion`	`integer` Aggregate version produced by the accepted command.
`cursor`	`integer` Event-ledger cursor for the accepted update. Refetch until returned records reach this cursor.
`links`	`object`
`links.refetch`	`string` Relative URL to refetch the affected resource.

Retrieve a day file

GET/v1/teams/{teamId}/days/{dayId}/files/{fileId}

Returns one day file by ID.

Required scopes: day_file:read

Parameters

`path.teamId`required	`string:uuid` Team identifier.
`path.dayId`required	`string:uuid` Day identifier.
`path.fileId`required	`string:uuid` Day file identifier.

Response 200

`data`	`object`
`data.dayId`	`string:uuid`
`data.fileName`	`string`
`data.contentType`	`string`
`data.sizeBytes`	`integer`
`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`	`integer` Current day file aggregate version.
`data.createdAt`	`string:date-time` ISO 8601 timestamp when the day file was created.
`data.createdBy`	`string` User identifier that created the day file.
`data.updatedAt`	`string:date-time` ISO 8601 timestamp when the day file was last updated.
`data.updatedBy`	`string` User identifier that last updated the day file.
`data.deletedAt`	`string:date-time` ISO 8601 timestamp when the day file was deleted.
`data.cursor`	`integer` Latest event-ledger cursor projected into this day file record.
`meta`	`object`
`meta.cursor`	`integer` Highest record cursor represented by this response.

Update a day file

PATCH/v1/teams/{teamId}/days/{dayId}/files/{fileId}

Accepts a command to update day file metadata. File replacement is not supported; delete and upload a new file instead.

Required scopes: day_file:write

Parameters

`path.teamId`required	`string:uuid` Team identifier.
`path.dayId`required	`string:uuid` Day identifier.
`path.fileId`required	`string:uuid` Day file identifier.
`header.Idempotency-Key`	`string:uuid` Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.

Request body (application/json)

`expectedVersion`	`integer` Optional aggregate version guard.
`updates`required	`object` Day file fields to update.
`updates.visibility`	`object \| null` Updated visibility, or null to clear custom visibility.
`updates.visibility.groupIds`	`string:uuid[]`
`updates.visibility.userIds`	`string:uuid[]`

Response 202

`commandId`	`string:uuid` Command identifier accepted into the RoadOps command ledger.
`resourceId`	`string:uuid` Identifier of the resource targeted by the command.
`resourceType`	`string` Resource type targeted by the command.
`status`	`"applied"` Command dispatch status.
`aggregateVersion`	`integer` Aggregate version produced by the accepted command.
`cursor`	`integer` Event-ledger cursor for the accepted update. Refetch until returned records reach this cursor.
`links`	`object`
`links.refetch`	`string` Relative URL to refetch the affected resource.

Delete a day file

DELETE/v1/teams/{teamId}/days/{dayId}/files/{fileId}

Accepts a command to delete a day file and remove the stored object.

Required scopes: day_file:write

Parameters

`path.teamId`required	`string:uuid` Team identifier.
`path.dayId`required	`string:uuid` Day identifier.
`path.fileId`required	`string:uuid` Day file identifier.
`header.Idempotency-Key`	`string:uuid` Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.

Response 202

`commandId`	`string:uuid` Command identifier accepted into the RoadOps command ledger.
`resourceId`	`string:uuid` Identifier of the resource targeted by the command.
`resourceType`	`string` Resource type targeted by the command.
`status`	`"applied"` Command dispatch status.
`aggregateVersion`	`integer` Aggregate version produced by the accepted command.
`cursor`	`integer` Event-ledger cursor for the accepted update. Refetch until returned records reach this cursor.
`links`	`object`
`links.refetch`	`string` Relative URL to refetch the affected resource.

Download a day file

GET/v1/teams/{teamId}/days/{dayId}/files/{fileId}/download

Redirects to a short-lived signed URL that downloads the file directly. Follow the redirect or read the Location response header.

Required scopes: day_file:read

Parameters

`path.teamId`required	`string:uuid` Team identifier.
`path.dayId`required	`string:uuid` Day identifier.
`path.fileId`required	`string:uuid` Day file identifier.

Day Files

List day files

Parameters

Response 200

Upload a day file

Parameters

Request body (multipart/form-data)

Response 202

Retrieve a day file

Parameters

Response 200

Update a day file

Parameters

Request body (application/json)

Response 202

Delete a day file

Parameters

Response 202

Download a day file

Parameters