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

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

documentId
string
obrigatório

Document identifier, as the catalog publishes it.

Resposta

OK

datasets
object[] | null
obrigatório

Every set the file carries and every field of it.

knownGaps
object[] | null
obrigatório

What this contract knowingly does not yet cover.

metadata
object
obrigatório

Which obligation this is, at which version.

parameters
object[] | null
obrigatório

What the generation must be told, answered per request.

rules
object[] | null
obrigatório

Assertions the finished file must satisfy.

apiVersion
string

Format identifier of the contract document.

Exemplo:

"reporter.lerian.io/v1alpha1"

kind
string

Document kind; always DocumentContract.

Exemplo:

"DocumentContract"