Skip to main content
PATCH
Partially update a relationship

Body

application/json
id
integer<int64>
name
string
homepage
string
Maximum string length: 255
Pattern: (?i)(?:https?:\/\/)?(?:(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.){1,126}(?:[a-z]{2,63}|xn--[a-z0-9](?:[a-z0-9-]{0,57}[a-z0-9])?)|\d{1,3}(?:\.\d{1,3}){3})\.?(?::\d{1,5})?(?:[\/?#][^\s]*)?|
description
string
contextTypes
object[]
dataTypes
object[]
businessOwnerFirstName
string
businessOwnerLastName
string
businessOwnerEmail
string
assessmentLeadFirstName
string
assessmentLeadLastName
string
assessmentLeadEmail
string
tags
string[]
externalId
string
productName
string
Maximum string length: 255
tier
integer<int32>
Required range: 1 <= x <= 5

Response

200 - application/json

OK

name
string
required
id
integer<int64>
homepage
string
description
string
businessUnit
string
createdDate
string<date-time>
updatedDate
string<date-time>
recertificationDate
string<date-time>
status
enum<string>
Available options:
ARCHIVED,
NOT_ONBOARDED,
ONBOARDED,
PURGED
inherentRisk
enum<string>
Available options:
NO_CONTEXT,
LOW,
MEDIUM,
HIGH,
EXTREME
inherentRiskScore
number<float>
residualRisk
enum<string>
Available options:
NO_CONTEXT,
LOW,
MEDIUM,
HIGH,
EXTREME
residualRiskScore
number<float>
isTransitional
boolean
contextTypes
object[]
dataTypes
object[]
businessOwner
object
assessmentLead
object
recertificationType
enum<string>
Available options:
MANUAL,
AUTOMATIC,
NONE
subscribers
object[]
primaryContact
object
tags
string[]
tier
string
complianceStandards
enum<string>[]
Available options:
C5,
CCPA,
CSA_STAR,
CSA_LEVEL2,
FEDRAMP,
GDPR,
GLBA,
HIPAA,
HITRUST,
ISO27001,
ISO27017,
ISO27018,
ISO27701,
ISO21434,
ISO22301,
ISO42001,
ISOIEC_2700127002,
ISOIEC_2701727002,
ISOIEC_2701827002,
PCIDSS,
PRIVACY_SHIELD,
SOC1,
SOC2,
SOC3,
TISAXREPORTLEVEL3
latestAssessment
object
riskAcceptanceStatus
enum<string>
Available options:
RISK_ACCEPTED,
REVIEW_NEEDED,
REMEDIATION_REQUESTED
externalId
string
productId
string<uuid>
productName
string
dimensionCoverage
object[]