Skip to main content
GET
Get what a document's file needs

Autorizaciones

Authorization
string
header
requerido

JWT bearer token issued by the identity provider.

Parámetros de ruta

documentId
string
requerido

Document identifier, as the catalog publishes it.

Respuesta

OK

datasets
object[] | null
requerido

Every set the file carries and every field of it.

knownGaps
object[] | null
requerido

What this contract knowingly does not yet cover.

metadata
object
requerido

Which obligation this is, at which version.

parameters
object[] | null
requerido

What the generation must be told, answered per request.

rules
object[] | null
requerido

Assertions the finished file must satisfy.

apiVersion
string

Format identifier of the contract document.

Ejemplo:

"reporter.lerian.io/v1alpha1"

kind
string

Document kind; always DocumentContract.

Ejemplo:

"DocumentContract"