Skip to main content
GET
Get the detections for a relationship

Path Parameters

id
integer<int64>
required

Relationship ID

Query Parameters

detectionType
enum<string>[]

Only these detection types; repeatable. Defaults to every type except NORMAL, which only evidences that a control is in place.

Available options:
NORMAL,
SUBSERVICE,
SHARED_RESPONSIBILITY_MODEL,
EXCEPTION,
CUEC,
SUBPROCESSOR
controlDomainType
enum<string>[]

Only detections in these kinds of control domain; repeatable. Defaults to all.

Available options:
SECURITY,
PRIVACY,
RESILIENCE,
ARTIFICIAL_INTELLIGENCE,
PRODUCT_SECURITY,
GOVERNANCE_ETHICS,
FOURTH_PARTY,
SUSTAINABILITY_HUMAN_RIGHTS,
SANCTIONS_TRADE,
FINANCIAL_VIABILITY,
CYBER_INSURANCE,
SERVICE_LOCATIONS,
SUBSERVICERS,
SUPPLEMENTAL_QUESTIONNAIRE,
UNASSIGNED
assessmentId
integer<int64>

A completed assessment of this relationship, to see what it saw, or the relationship's latest assessment while in progress. Any other assessment is a 400. Omit for the current picture.

includeQuestionnaireAnswers
boolean
default:false

Also return the answers behind supplemental questionnaire detections.

afterId
integer<int64>

The previous page's nextAfterId. Omit for the first page.

size
integer<int32>
default:100

Detections per page, 1 to 500.

Required range: 1 <= x <= 500

Response

200 - application/json

OK

relationshipId
integer<int64>
assessmentId
integer<int64>
riskAssessmentId
integer<int64>
riskAssessmentDate
string<date-time>
artifactsInProgress
object[]
size
integer<int32>
afterId
integer<int64>
nextAfterId
integer<int64>
detections
object[]