Skip to content
AveraAveraAvera Documentation

Generate a point-in-time validation summary report

GET
/api/v1/projects/{projectId}/schema/validation-report
curl --request GET \
  --url https://app.avera.io/api/v1/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/schema/validation-report

The CSV/CSA validation summary as of a moment or a baseline. Resolve the baseline by an explicit baseline version id, by asOf as an ISO-8601 instant for the latest baseline at that time, or the current one when neither is given.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectId
required
string format: uuid

Query Parameters

Section titled “Query Parameters”
asOf
string
baseline
string

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media type*/*
object
projectId
required
string format: uuid
generatedAt
required
string format: date-time
asOf
string | null format: date-time
effectiveBaseline
required
object
versionId
required
string
versionNumber
required
integer format: int32
versionName
required
string
createdAt
required
string format: date-time
schemaHash
string | null
platformValidation
required
object
platformVersion
required
string
note
required
string
configuration
required
object
snapshot
required
object
schemaHash
string | null
itemTypeCount
required
integer format: int32
attributeCount
required
integer format: int32
relationshipTypeCount
required
integer format: int32
workflowCount
required
integer format: int32
roleCount
required
integer format: int32
snapshotJson
string | null
verification
required
object
versionNumber
required
integer format: int32
asOfThen
One of:
object
ruleSetVersion
required
string
results
required
Array<object>
object
checkId
required
string
status
required
string
Allowed values: PASS WARN FAIL
dimension
string | null
Allowed values: META_MODEL WORKFLOW RBAC FORM SIGNATURE_POLICY
detail
string | null
targetId
string | null
title
string | null
targetType
string | null
targetName
string | null
acknowledgment
One of:
object
id
required
string format: uuid
decision
required
string
Allowed values: ACCEPTED MITIGATED WITHDRAWN
rationale
required
string
decidedBy
required
string format: uuid
decidedByName
required
string
decidedAt
required
string format: date-time
stale
required
boolean
findingDetailAtDecision
required
string
passCount
required
integer format: int32
warnCount
required
integer format: int32
failCount
required
integer format: int32
acknowledgedCount
required
integer format: int32
currentRules
required
object
ruleSetVersion
required
string
results
required
Array<object>
object
checkId
required
string
status
required
string
Allowed values: PASS WARN FAIL
dimension
string | null
Allowed values: META_MODEL WORKFLOW RBAC FORM SIGNATURE_POLICY
detail
string | null
targetId
string | null
title
string | null
targetType
string | null
targetName
string | null
acknowledgment
One of:
object
id
required
string format: uuid
decision
required
string
Allowed values: ACCEPTED MITIGATED WITHDRAWN
rationale
required
string
decidedBy
required
string format: uuid
decidedByName
required
string
decidedAt
required
string format: date-time
stale
required
boolean
findingDetailAtDecision
required
string
passCount
required
integer format: int32
warnCount
required
integer format: int32
failCount
required
integer format: int32
acknowledgedCount
required
integer format: int32
ruleSetChanged
required
boolean
validationStatement
One of:
object
id
required
string
tenantId
required
string format: uuid
projectId
required
string format: uuid
configurationVersionId
required
string
status
required
string
Allowed values: PROVISIONAL VALIDATED RETIRED
intendedUseScope
required
string
validationProtocol
string | null
validationRequirementItemIds
required
Array<string>
validatorUserId
string | null format: uuid
validatedAt
string | null format: date-time
signatureId
string | null format: uuid
supersededByVersionId
string | null
rationale
string | null
createdAt
required
string format: date-time
createdBy
required
string format: uuid
modifiedAt
required
string format: date-time
modifiedBy
required
string format: uuid
validationDecisions
required
Array<object>
object
id
required
string
tenantId
required
string format: uuid
projectId
required
string format: uuid
configurationVersionId
required
string
verificationLogId
required
string
question
required
string
riskLevel
required
string
Allowed values: NONE LOW MEDIUM HIGH CRITICAL
decision
required
string
Allowed values: ACCEPTED REJECTED MITIGATED
rationale
required
string
decidedBy
required
string format: uuid
decidedAt
required
string format: date-time
projectValidationState
required
object
validatedBaselineVersionId
string | null
validatedVersionNumber
integer | null format: int32
currentVersionNumber
integer | null format: int32
isValidatedNow
required
boolean
driftChangeCount
required
integer format: int32
traceability
required
Array<object>
object
requirementItemId
required
string format: uuid
requirementNumber
string | null
requirementItemTypeId
string | null
exists
required
boolean
isCovered
required
boolean
coveredBy
required
Array<object>
object
itemId
required
string format: uuid
number
required
string
itemTypeId
required
string
via
required
string
operationalRecords
required
object
note
required
string