API REFERENCE
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, 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.
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
| Operation | Method and path | Reference |
|---|---|---|
| Mark a Finding Reviewed | POST /v1/findings/workflows/{workflowId}/findings/{findingId}/resolve | Mark Reviewed |
| Set a Finding’s Review Note | POST /v1/findings/workflows/{workflowId}/findings/{findingId}/note | Set Review Note |
| Clear a Finding’s Review State | POST /v1/findings/workflows/{workflowId}/findings/{findingId}/reset | Clear Review State |
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 is not JSON — it takes multipart/form-data.
Table of contents
- Get a Workflow's Findings Summary
- Get a Workflow's Category Counts
- List a Workflow's Findings
- Get One Finding
- Get a Workflow's Findings by Category
- Set a Finding's Review Note
- Mark a Finding Reviewed
- Clear a Finding's Review State
- Get a Finding's History
- List a Finding's Attachments
- Add an Attachment
- Download an Attachment
- Remove an Attachment