tesma Platform API
Gets a list of all document metadatas.
get
https://api.tesma.com/v1/documents
Query Parameters
loadOptionsobject
The load options object.
* Additional properties are NOT allowed.
Show Child Parameters
Headers
CorporateGroup-Namestring
Corporate group key that assigns the currently selected corporate group to the request.
Response
application/json
Response
application/json
OK
TesmaLoadResult_DocumentMetadataResponse
* Additional properties are NOT allowed.
datanull | array[object]
* Additional properties are NOT allowed.
Show Child Parameters
groupCountinteger(int32)
Default:-1
summarynull | array
totalCountinteger(int32)
Default:-1
get/v1/documents
Authentication
Query Parameters
Headers
application/json
Uploads a new customer document.
post
https://api.tesma.com/v1/documents
Headers
CorporateGroup-Namestring
Corporate group key that assigns the currently selected corporate group to the request.
Body
multipart/form-data
Body
multipart/form-data
AssetIdinteger(int64)
CustomerNumberinteger(int32)required
DocumentCategorystringrequired
Allowed values:masterLeaseAgreementsupplementalAgreementleaseSchedulecarbonZeroCertificatecollectionerasureProtocolinvoicecreditadditionalDocumentreportownDocumentscheduledExportoneTimeExport
DocumentTypestringrequired
>= 0 characters<= 128 characters
LeaseCompanyinteger(int32)required
LeaseScheduleIdinteger(int32)
Response
application/json
Response
application/json
OK
* Additional properties are NOT allowed.
documentIdnull | string
post/v1/documents
Authentication
Headers
Body
Error initializing code snippet
application/json
Downloads multiple documents in a zip file.
get
https://api.tesma.com/v1/documents/downloads
Query Parameters
loadOptionsobject
The load options
* Additional properties are NOT allowed.
Show Child Parameters
Headers
CorporateGroup-Namestring
Corporate group key that assigns the currently selected corporate group to the request.
Response
application/json
Response
application/json
OK
string(binary)
get/v1/documents/downloads
Authentication
Query Parameters
Headers
application/json
Deletes the document with the given document id.
delete
https://api.tesma.com/v1/documents/{documentId}
Path Parameters
documentIdstringrequired
The document id.
Headers
CorporateGroup-Namestring
Corporate group key that assigns the currently selected corporate group to the request.
Response
Response
OK
delete/v1/documents/{documentId}
Authentication
Path Parameters
Headers
Downloads the document by given document id.
get
https://api.tesma.com/v1/documents/{documentId}/download
Path Parameters
documentIdstringrequired
The document id.
Headers
CorporateGroup-Namestring
Corporate group key that assigns the currently selected corporate group to the request.
Response
application/json
Response
application/json
OK
string(binary)
get/v1/documents/{documentId}/download
Authentication
Path Parameters
Headers
application/json