VIvisotrust
client-api-relationship-rest-resource

Search for relationships by filter criteria

post/api/v1/relationships/search

Request

Query parameters

pageinteger
sizeinteger
sortstring[]
pageinteger

Results page you want to retrieve (0..N)

sizeinteger

Number of records per page (max 500)

sortstring

Sorting criteria in the format: property(,asc|desc). Supported properties: name, externalId, score, createdDate, onboardedDate, recertificationDate.

Request body

domainsstring[]
namestring
externalIdstring
statusesstring[]
assessmentStatusesstring[]
riskAcceptanceStatusesstring[]
residualRiskLevelsstring[]
inherentRiskLevelsstring[]
minScorenumber float
maxScorenumber float
businessUnitIdsinteger[]
vendorTierIdsinteger[]
businessOwnerIdsinteger[]
creatorIdsinteger[]
primaryContactIdsinteger[]
tagsstring[]
createdAfterstring date-time
createdBeforestring date-time
recertificationAfterstring date-time
recertificationBeforestring date-time
onboardedAfterstring date-time
onboardedBeforestring date-time
assessmentCompletedAfterstring date-time
assessmentCompletedBeforestring date-time

Response

OK

idinteger
namestring required
homepagestring
descriptionstring
businessUnitstring
createdDatestring date-time
updatedDatestring date-time
recertificationDatestring date-time
status'ARCHIVED' | 'NOT_ONBOARDED' | 'ONBOARDED' | 'PURGED'
inherentRisk'NO_CONTEXT' | 'LOW' | 'MEDIUM' | 'HIGH' | 'EXTREME'
inherentRiskScorenumber float
residualRisk'NO_CONTEXT' | 'LOW' | 'MEDIUM' | 'HIGH' | 'EXTREME'
residualRiskScorenumber float
isTransitionalboolean
recertificationType'MANUAL' | 'AUTOMATIC' | 'NONE'
tagsstring[]
tierstring
complianceStandardsstring[]
riskAcceptanceStatus'RISK_ACCEPTED' | 'REVIEW_NEEDED' | 'REMEDIATION_REQUESTED'
externalIdstring
productIdstring uuid
productNamestring

Changes

No recorded changes to this operation across all 1 revision of this API.