Skip to content
AveraAveraAvera Documentation

Retire a validation statement

POST
/api/v1/projects/{projectId}/schema/validation/{statementId}/retire
curl --request POST \
  --url https://app.avera.io/api/v1/projects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/schema/validation/example/retire \
  --header 'Content-Type: application/json' \
  --data '{ "reason": "example", "supersededByVersionId": "example" }'

Withdrawn or superseded; a superseding configuration version can be named.

Parameters

Section titled “Parameters”

Path Parameters

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

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
reason
string | null
supersededByVersionId
string | null

Example generated

{
  "reason": "example",
  "supersededByVersionId": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media type*/*
object
id
required
string
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