RetailHardHat Developer docs

REST API documentation

Project Documents

Documents attached to a project (accessed via /api/v1/projects/:id/documents)

Supported operations

MethodPathDescription
GET/api/v1/projects/:id/documentsList documents on a project
DELETE/api/v1/projects/:id/documents/:docIdRemove a project document

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.

FieldTypeModel requirementDescription
idstringOptionalUnique identifier (auto-generated)
projectIduuidRequiredproject Id

Related resource: projects

namestringRequiredname
descriptionstringOptionaldescription
filePathstringRequiredfile Path
fileSizenumberOptionalfile Size
fileTypestringOptionalfile Type
uploadedBystringOptionaluploaded By
createdAtdatetimeOptionalCreation timestamp (auto)
updatedAtdatetimeOptionalLast update timestamp (auto)