Get Data Product Documents Metadata

Retrieves metadata for all documents of a data product. Accessible to the owning provider and admins.

get/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

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

Jul 16, 2026e2684b7af4bb4See the full diff
- ○
  the response property items/fileName became required for the status 200
  response-property-became-required
- ○
  the response property items/id became required for the status 200
  response-property-became-required
- ○
  the response property items/scanStatus became required for the status 200
  response-property-became-required
- ○
  the response property items/sizeBytes became required for the status 200
  response-property-became-required
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 13, 2026bf09fcfe746c1See the full diff
- ○
  endpoint added
  endpoint-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 9, 202673b93bab6c7b1See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 8, 20264f907e1764811See the full diff
- ○
  endpoint added
  endpoint-added
Jul 2, 2026aec259103b951See the full diff
- ▲
  api path removed without deprecation
  api-path-removed-without-deprecation
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 2, 202616bdeed9be541See the full diff
- ○
  endpoint added
  endpoint-added

Full history