Reporting

Partner-facing endpoints for retrieving appointments that are pending reporting and submitting tele reporting content/artifacts. Appointments appear after QUBS moves them to PENDING REPORTING, typically when the scan/study is ended. Typical workflow: list pending reporting appointments, optionally create upload URLs for report artifacts, upload with PUT, then submit report text. Report text alone is sufficient; attachments are optional.

Operations

List pending reporting appointments

Request

Returns the tele reporting appointment view for appointments in the PENDING REPORTING status. Appointments enter this status after QUBS moves them to PENDING REPORTING, typically when the scan/study is ended; subscribe to appointment.status_changed webhooks for notification and use this endpoint for reconciliation. Supports cursor-based pagination via pageSize and nextToken.

Security

Bearer

Path

domainstringrequired

Partner domain identifier for the organisation/tenant. Your bearer token is scoped to one or more domains and requests outside that scope are rejected.

Example:acme

Query

pageSizeinteger, (int32), [ 1 .. 500 ]

Maximum number of items to return in a page. Defaults to 100 when omitted. Must be between 1 and 500.

Default:100

Example:pageSize=100

nextTokenstring

Opaque, URL-safe continuation token returned as nextToken in a previous paged response. Omit for the first page.

Example:nextToken=DDB_NEXT_TOKEN

X-Correlation-Idstring

Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.

Example:4b7f0a91b4f54f2a

curl -i -X GET \
  'https://partnerdocs.qubs.io/_mock/openapi/integrations/v1/acme/reporting/appointments/pending?pageSize=100&nextToken=DDB_NEXT_TOKEN' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-Correlation-Id: 4b7f0a91b4f54f2a'

Responses

Page of appointments that are pending reporting for the requested domain. Appointments enter this view after QUBS moves them to PENDING REPORTING, typically when the scan/study is ended. Subscribe to appointment.status_changed webhooks for transition notifications and use this endpoint for reconciliation.

Headers

X-Correlation-Idstring

Request correlation identifier. Echoes the incoming X-Correlation-Id header when provided.

Example:"4b7f0a91b4f54f2a"

Bodyapplication/json

itemsArray of objects(PendingReportingAppointmentResponse)required

Tele reporting appointments in the current page.

nextTokennull or string

Opaque continuation token to fetch the next page, when more results are available.

Example:"Example nextToken"

Response

{
  "items": [
    { … }
  ],
  "nextToken": "DDB_NEXT_TOKEN"
}