RoofKit
Developer docsPartner API
API keys

Import report

Imports one standalone PDF or a legacy XML/CSV/XLSX/DXF report package. The API key supplies the workspace; tenant selector fields are rejected.

Bearer API key · Scope: reports.write

Endpoint

POST/api/v1/reports/import
Request bodyrequired
multipart/form-data
ReportImportForm
Headers2 parameters
  • Idempotency-Keyrequired
    string

  • Content-Lengthrequired
    integer

    Required for multipart report imports before request parsing. Most HTTP clients compute this automatically for multipart form uploads.

Responses

201Report imported.

Headers

  • X-RateLimit-LimitMaximum requests allowed in the current window.
  • X-RateLimit-RemainingRequests remaining in the current window.
  • X-RateLimit-ResetISO timestamp when the current rate-limit window resets.
  • Idempotency-ReplayedPresent and true when a stored successful write response was replayed.
application/json
ReportImportResponse
400Request payload, query, or required header is invalid.
application/json
ErrorResponse
401Missing, malformed, revoked, deleted, or unknown API key.

Headers

  • WWW-AuthenticateDocumented response header
application/json
ErrorResponse
403API key lacks the required scope or the workspace is not active.
application/json
ErrorResponse
409Request conflicts with idempotency or external event identity.
application/json
ErrorResponse
411Request payload, query, or required header is invalid.
application/json
ErrorResponse
413Request payload, query, or required header is invalid.
application/json
ErrorResponse
429Rate limit exceeded for this key and endpoint or invalid-auth bucket.

Headers

  • X-RateLimit-LimitMaximum requests allowed in the current window.
  • X-RateLimit-RemainingRequests remaining in the current window.
  • X-RateLimit-ResetISO timestamp when the current rate-limit window resets.
  • Retry-AfterSeconds until the caller should retry.
application/json
ErrorResponse
500Internal authentication or server error.
application/json
ErrorResponse
503Internal authentication or server error.
application/json
ErrorResponse
Try it out
Headers
Multipart form