Skip to Content
veriom

Preview review

POST
/v1/workspaces/{workspace_id}/reports/{report_id}/review-preview

Authorization

workspaceToken
headerAuthorizationBearer <vat_<opaque-token>>

Expiring, hashed workspace token with explicit scopes.

Path Parameters

workspace_id*Workspace Id
Formatuuid
report_id*Report Id
Formatuuid

Request Body

application/json
  1. body
finding_ids?array<>
Itemsitems <= 200
include_evidence?Include Evidence
Defaultfalse
include_locations?Include Locations
Defaultfalse
include_repository?Include Repository
Defaultfalse
redact_text?array<string>
Itemsitems <= 100
sections*array<>
Items1 <= items <= 5
title*Title
Length1 <= length <= 240

Response Body

Successful Response

application/json
  1. response
content_sha256*Content Sha256
snapshot*
Example Request
curl -X POST 'https://api.veriom.ai/v1/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/reports/497f6eca-6276-4993-bfeb-53cbbbba6f08/review-preview' \  -H 'Content-Type: application/json' \  -d '{  "sections": [    "executive_summary"  ],  "title": "string"}'
Example Response
{  "content_sha256": "string",  "snapshot": {    "approved_at": "2019-08-24T14:15:22Z",    "branch_ref": "string",    "commit_sha": "string",    "generated_at": "2019-08-24T14:15:22Z",    "limitations": [      "string"    ],    "report_revision": 0,    "repository": "string",    "sections": [      {        "items": [          {            "evidence": [              "string"            ],            "id": "string",            "locations": [              "string"            ],            "severity": "string",            "text": "string",            "title": "string"          }        ],        "kind": "executive_summary",        "title": "string"      }    ],    "title": "string"  }}