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

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Path Parameters

documentId
string
required

Document identifier, as the catalog publishes it.

Response

OK

datasets
object[] | null
required

Every set the file carries and every field of it.

knownGaps
object[] | null
required

What this contract knowingly does not yet cover.

metadata
object
required

Which obligation this is, at which version.

parameters
object[] | null
required

What the generation must be told, answered per request.

rules
object[] | null
required

Assertions the finished file must satisfy.

apiVersion
string

Format identifier of the contract document.

Example:

"reporter.lerian.io/v1alpha1"

kind
string

Document kind; always DocumentContract.

Example:

"DocumentContract"