Site Documents | RetailHardHat REST API docs

Supported operations

This resource provides field metadata only. No dedicated CRUD endpoint is advertised.

Field reference

Required means required by the underlying data model, not necessarily caller-supplied. The server derives protected identity and ownership fields; endpoint validation controls which fields are accepted. Sensitive credential fields are omitted here.

Field	Type	Model requirement	Description
`id`	`string`	Optional	Unique identifier (auto-generated)
`siteId`	`uuid`	Required	site Id Related resource: `sites`
`folderId`	`uuid`	Optional	folder Id Related resource: `documentFolders`
`name`	`string`	Required	name
`description`	`string`	Optional	description
`filePath`	`string`	Required	file Path
`fileSize`	`number`	Optional	file Size
`fileType`	`string`	Optional	file Type
`uploadedBy`	`string`	Optional	uploaded By Related resource: `users`
`showInPortal`	`boolean`	Optional	show In Portal
`portalVisibility`	`enum`	Optional	portal Visibility Values: `all_vendors`, `specific_vendors`
`classification`	`enum`	Optional	classification Values: `public`, `internal`, `confidential`, `restricted`
`createdAt`	`datetime`	Optional	Creation timestamp (auto)
`updatedAt`	`datetime`	Optional	Last update timestamp (auto)