Sign in
Data Products

Add Data Product Document

Uploads a document to a data product. Accessible to the owning provider and admins.

post/api/products/v2/{id}/documents

Path parameters

idstring uuid required

Query parameters

actingRole'PROVIDER' | 'ADMIN'

Selects the role in which the authenticated user acts for this request. Optional: if the authenticated user holds exactly one of the allowed roles, the value is auto-resolved. Returns 400 if the value is unknown, not allowed for this endpoint, or omitted while the user holds multiple matching roles. Returns 403 if the user does not hold the role specified in the parameter.

Response

OK

idstring uuid required
fileNamestring required

Filename of the document

sizeBytesinteger required

Filesize of the document

scanStatus'PENDING_SCAN' | 'AVAILABLE' | 'REJECTED' | 'SCAN_FAILED' required

Example response

{
  "fileName": "example.pdf",
  "sizeBytes": 1024
}

Changes

Changed in 6 of the 56 revisions of this API.27