Reports

Changed on
get/reports/{id}

Request

  • Base URL: https://api.greentally.ai/v1
  • URL: https://api.greentally.ai/v1/reports/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Query parameters

versionstring

"draft" answers the current draft version even when a published version exists (after "Update report" or an edit after publishing); it needs report.view_draft and is 404 otherwise. Without it the published version is preferred, as before. Ignored while REPORTS_V2_ENABLED is off.

evidencestring

"omit" leaves evidencePack out, for the viewer's first render (spec §7.5); "include" is the default. Ignored while REPORTS_V2_ENABLED is off.

Response

Report detail

Changes

  • 5c524454c847Revision changes
    • info

      added the optional property // to the response with the status

  • 77d466d0e73dRevision changes
    • breaking

      the response property ///// became optional for the status

    • breaking

      the response property ///// became optional for the status

    • warning

      added the new vsme enum value to the ///// response property for the response status

    • info

      added the new optional query request parameter evidence

    • info

      added the new optional query request parameter version

    • info

      added the non-success response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status