Document Generator API

ReadResourceAsync

post
/v1/documentTemplates/packaging/readResource

Body

ReadResourceRequest

* Additional properties are NOT allowed.
ridstringrequired

Response

application/json

Success

ReadResourceResponse

* Additional properties are NOT allowed.
RIDstringrequired
staterequired
application/json

UpdateResourceAsync

post
/v1/documentTemplates/packaging/updateResource

Body

UpdateResourceRequest

* Additional properties are NOT allowed.
ridstringrequired
stateobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

Success

CreateResourceResponse

* Additional properties are NOT allowed.
RIDstringrequired
staterequired
application/json

GetAvailableDataSources

get
/v1/dataSources

Response

application/json

Success

* Additional properties are NOT allowed.
connectionNamestring | null
connectionRIDstring | null
versionstring | null
providerstring | null
application/json

GetEntitiesByDataSource

get
/v1/dataSources/{dataSource}/entities

Path Parameters

dataSourcestringrequired

Response

401

Unauthorized

401

GetSchemaByEntity

get
/v1/dataSources/{dataSource}/entities/{entityId}/schema

Path Parameters

dataSourcestringrequired
entityIdstringrequired

Response

401

Unauthorized

401