tesma Platform API
Gets the current status of a bulk lease asset patch request
get
https://api.tesma.com/v1/leases/assets/bulkpatches/{bulkJobId}
Path Parameters
bulkJobIdinteger(int32)required
The id of the bulk job
>= 1
Headers
CorporateGroup-Namestring
Corporate group key that assigns the currently selected corporate group to the request.
Response
application/json
Response
application/json
OK
AssetBulkJobResponse
* Additional properties are NOT allowed.
assetsSuccessfullyUpdatednull | integer(int32)
assetsTotalinteger(int32)
createDatestring(date-time)
endDatenull | string(date-time)
errorsnull | array[object]
* Additional properties are NOT allowed.
Show Child Parameters
idinteger(int32)
startDatenull | string(date-time)
statusstring
Allowed values:notStartedvalidatinginProgresssuccessfulpartiallySuccessfulfailedfailedPotentiallyInconsistent
get/v1/leases/assets/bulkpatches/{bulkJobId}
Authentication
Path Parameters
Headers
application/json
LeaseScheduleAssets
Gets all lease assets.
get
https://api.tesma.com/v1/leases/assets
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
TesmaLoadResult_LeaseScheduleAssetResponse
* 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/leases/assets
Authentication
Query Parameters
Headers
application/json
Gets all lease assets of the specified lease schedule.
get
https://api.tesma.com/v1/leases/{leaseCompanyNumber}/{leaseScheduleId}/assets
Query Parameters
loadOptionsobject
The load options object.
* Additional properties are NOT allowed.
Show Child Parameters
Path Parameters
leaseCompanyNumberinteger(int32)required
The lease company number.
>= 1
leaseScheduleIdinteger(int32)required
The lease schedule identifier.
>= 1
Headers
CorporateGroup-Namestring
Corporate group key that assigns the currently selected corporate group to the request.
Response
application/json
Response
application/json
OK
TesmaLoadResult_LeaseScheduleAssetResponse
* 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/leases/{leaseCompanyNumber}/{leaseScheduleId}/assets
Authentication
Path Parameters
Query Parameters
Headers
application/json
Gets a single lease asset of the specified lease schedule.
get
https://api.tesma.com/v1/leases/{leaseCompanyNumber}/{leaseScheduleId}/assets/{assetId}
Path Parameters
leaseCompanyNumberinteger(int32)required
The lease company number.
>= 1
leaseScheduleIdinteger(int32)required
The lease schedule identifier.
>= 1
assetIdinteger(int64)required
The asset id.
>= 1
Headers
CorporateGroup-Namestring
Corporate group key that assigns the currently selected corporate group to the request.
Response
application/json
Response
application/json
OK
LeaseScheduleAssetResponse
* Additional properties are NOT allowed.
acceptanceCertificateIdnull | integer(int32)
actualLeaseEndDatenull | string(date)
assetIdinteger(int64)
assetStatusIdnull | integer(int32)
categorystring
Allowed values:hardwaresoftwareservice
citynull | string
classnull | string
collectionNumbernull | integer(int32)
confirmationDatenull | string(date-time)
contractStatusstring
Allowed values:confirmationPendingconfirmedinLeaseterminatedunknown
costCenternull | string
currencynull | string
customerContextobject
* Additional properties are NOT allowed.
Show Child Parameters
customerSpecificFieldsnull
deinstallationDatenull | string(date)
descriptionnull | string
eolFlagDatenull | string(date-time)
eolFlagTypestring
Allowed values:extensionbuyOutcollectionmarkForCollection
eolFlagUserIdnull | integer(int32)
federalStatenull | string
invoiceGroupNumbernull | integer(int32)
isCarbonZeroboolean
leaseDepartmentnull | string
leaseOrderNumbernull | string
leaseScheduleIdinteger(int32)
leaseStartDatenull | string(date)
locationnull | string
locationOfInstallationnull | string
mKeyinteger(int32)
manufacturernull | string
minimumLeaseTermEndDatenull | string(date)
offleaseTypestring
Allowed values:stockfollowUpLeasederecognitionbuyout
orderNumbernull | string
periodicalPricenull | number(double)
plannedLeaseEndDatenull | string(date)
postcodenull | string
purchaseOrdernull | string
serialNumbernull | string
streetnull | string
street2null | string
technicalSpecificationsnull | string
usagePeriodstring
Allowed values:monthlyquarterlysemiyearlyyearly
get/v1/leases/{leaseCompanyNumber}/{leaseScheduleId}/assets/{assetId}
Authentication
Path Parameters
Headers
application/json