Beta
Findings API
A finding is one thing a product noticed about your data. Read the findings a workflow produced, filter them by category or severity, and record your review: mark a finding reviewed, add a note, override its result, or attach a document.
You can call these at any time. Before a result exists a workflow has no findings yet, which is a normal answer rather than an error. A workflow.updated delivery is what tells you there will be data.
Findings covers reading findings, reviewing them, and working with attachments.
Browse every operation, its schemas and code samples in the API Explorer, or download the OpenAPI specification for your own tools.
Every path below is relative to the base URL, and every one is scoped to a workflow:
https://api.pointservices.com/riskinsight-services-ws/resources
Reading findings
| Operation | Method and path | Reference |
|---|---|---|
| Get a Workflow’s Findings Summary | GET /v1/findings/workflows/{workflowId} | Findings Summary |
| List a Workflow’s Findings | GET /v1/findings/workflows/{workflowId}/findings | List Findings |
| Get a Workflow’s Findings by Category | GET /v1/findings/workflows/{workflowId}/bycategories | Findings by Category |
| Get a Workflow’s Category Counts | GET /v1/findings/workflows/{workflowId}/categories | Category Counts |
| Get One Finding | GET /v1/findings/workflows/{workflowId}/findings/{findingId} | Get One Finding |
| Get a Finding’s History | GET /v1/findings/workflows/{workflowId}/findings/{findingId}/history | Finding History |
Reviewing a finding
One call changes a finding’s review note, its reviewed state and its result override. Send only the fields you want to change.
| Operation | Method and path | Reference |
|---|---|---|
| Edit a Finding | POST /v1/findings/workflows/{workflowId}/findings/{findingId} | Edit a Finding |
Attachments
| Operation | Method and path | Reference |
|---|---|---|
| List a Finding’s Attachments | GET /v1/findings/workflows/{workflowId}/findings/{findingId}/attachments | List Attachments |
| Add an Attachment | POST /v1/findings/workflows/{workflowId}/findings/{findingId}/attachments | Add an Attachment |
| Download an Attachment | GET /v1/findings/workflows/{workflowId}/findings/{findingId}/attachments/{attachmentId}/content | Download an Attachment |
| Remove an Attachment | DELETE /v1/findings/workflows/{workflowId}/findings/{findingId}/attachments/{attachmentId} | Remove an Attachment |
Adding an attachment is the one operation here that doesn’t take JSON: it takes multipart/form-data.
Every error response that carries a body is an RFC 9457 problem document, served as application/problem+json. Branch on its type, never on the text of title or detail. Some rejections, such as those made at the edge before the service is reached, carry no JSON body at all, so handle an error response you can’t parse.