Alpha Asset Instances
Manage individual asset instances
Add an asset instance
AuthorizationBearer <token>
In: header
Query Parameters
idOverride?string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/asset-instances" \ -H "Content-Type: application/json" \ -d '{ "assetLocationId": "string", "currentValue": 0.1, "installationDate": "2019-08-24T14:15:22Z", "metadata": { "property1": "string", "property2": "string" }, "name": "string", "objectNumber": "string", "productId": "string", "serialNumber": "string", "status": "OPERATIONAL", "type": "string" }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"assetLocationId": "string",
"certifications": [
{
"critical": true,
"description": "string",
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"isCritical": true,
"isRepeat": true,
"issueDate": "2019-08-24T14:15:22Z",
"repeat": true,
"status": "VALID",
"type": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currentValue": 0.1,
"failures": [
{
"alerted": "2019-08-24T14:15:22Z",
"arrival": "2019-08-24T14:15:22Z",
"cause": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"repaired": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"id": "string",
"installationDate": "2019-08-24T14:15:22Z",
"maintenance": [
{
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"doneDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"executed": true,
"finished": true,
"id": "string",
"status": "PLANNED",
"type": "MAINTENANCE"
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"objectNumber": "string",
"productId": "string",
"serialNumber": "string",
"serviceIntervals": [
{
"description": "string",
"id": "string",
"intervals": [
{
"cost": 0.1,
"year": 0
}
],
"partCategory": "string",
"partId": "string"
}
],
"status": "OPERATIONAL",
"tenantId": "string",
"type": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Delete by list of ids in current tenant
AuthorizationBearer <token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/asset-instances" \ -H "Content-Type: application/json" \ -d '[ "string" ]'Empty
{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Bulk create asset instances
AuthorizationBearer <token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/asset-instances/bulk" \ -H "Content-Type: application/json" \ -d '[ { "assetLocationId": "string", "currentValue": 0.1, "installationDate": "2019-08-24T14:15:22Z", "metadata": { "property1": "string", "property2": "string" }, "name": "string", "objectNumber": "string", "productId": "string", "serialNumber": "string", "status": "OPERATIONAL", "type": "string" } ]'[
{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"assetLocationId": "string",
"certifications": [
{
"critical": true,
"description": "string",
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"isCritical": true,
"isRepeat": true,
"issueDate": "2019-08-24T14:15:22Z",
"repeat": true,
"status": "VALID",
"type": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currentValue": 0.1,
"failures": [
{
"alerted": "2019-08-24T14:15:22Z",
"arrival": "2019-08-24T14:15:22Z",
"cause": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"repaired": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"id": "string",
"installationDate": "2019-08-24T14:15:22Z",
"maintenance": [
{
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"doneDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"executed": true,
"finished": true,
"id": "string",
"status": "PLANNED",
"type": "MAINTENANCE"
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"objectNumber": "string",
"productId": "string",
"serialNumber": "string",
"serviceIntervals": [
{
"description": "string",
"id": "string",
"intervals": [
{
"cost": 0.1,
"year": 0
}
],
"partCategory": "string",
"partId": "string"
}
],
"status": "OPERATIONAL",
"tenantId": "string",
"type": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
]{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Find by list of ids in current tenant
AuthorizationBearer <token>
In: header
Query Parameters
ids*array<>
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/asset-instances/find?ids=string"[
{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"assetLocationId": "string",
"certifications": [
{
"critical": true,
"description": "string",
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"isCritical": true,
"isRepeat": true,
"issueDate": "2019-08-24T14:15:22Z",
"repeat": true,
"status": "VALID",
"type": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currentValue": 0.1,
"failures": [
{
"alerted": "2019-08-24T14:15:22Z",
"arrival": "2019-08-24T14:15:22Z",
"cause": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"repaired": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"id": "string",
"installationDate": "2019-08-24T14:15:22Z",
"maintenance": [
{
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"doneDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"executed": true,
"finished": true,
"id": "string",
"status": "PLANNED",
"type": "MAINTENANCE"
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"objectNumber": "string",
"productId": "string",
"serialNumber": "string",
"serviceIntervals": [
{
"description": "string",
"id": "string",
"intervals": [
{
"cost": 0.1,
"year": 0
}
],
"partCategory": "string",
"partId": "string"
}
],
"status": "OPERATIONAL",
"tenantId": "string",
"type": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
]{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Find all for current tenant
AuthorizationBearer <token>
In: header
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/asset-instances/find-all"[
{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"assetLocationId": "string",
"certifications": [
{
"critical": true,
"description": "string",
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"isCritical": true,
"isRepeat": true,
"issueDate": "2019-08-24T14:15:22Z",
"repeat": true,
"status": "VALID",
"type": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currentValue": 0.1,
"failures": [
{
"alerted": "2019-08-24T14:15:22Z",
"arrival": "2019-08-24T14:15:22Z",
"cause": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"repaired": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"id": "string",
"installationDate": "2019-08-24T14:15:22Z",
"maintenance": [
{
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"doneDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"executed": true,
"finished": true,
"id": "string",
"status": "PLANNED",
"type": "MAINTENANCE"
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"objectNumber": "string",
"productId": "string",
"serialNumber": "string",
"serviceIntervals": [
{
"description": "string",
"id": "string",
"intervals": [
{
"cost": 0.1,
"year": 0
}
],
"partCategory": "string",
"partId": "string"
}
],
"status": "OPERATIONAL",
"tenantId": "string",
"type": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
]{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Find by id in current tenant
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/asset-instances/find/string"{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"assetLocationId": "string",
"certifications": [
{
"critical": true,
"description": "string",
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"isCritical": true,
"isRepeat": true,
"issueDate": "2019-08-24T14:15:22Z",
"repeat": true,
"status": "VALID",
"type": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currentValue": 0.1,
"failures": [
{
"alerted": "2019-08-24T14:15:22Z",
"arrival": "2019-08-24T14:15:22Z",
"cause": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"repaired": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"id": "string",
"installationDate": "2019-08-24T14:15:22Z",
"maintenance": [
{
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"doneDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"executed": true,
"finished": true,
"id": "string",
"status": "PLANNED",
"type": "MAINTENANCE"
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"objectNumber": "string",
"productId": "string",
"serialNumber": "string",
"serviceIntervals": [
{
"description": "string",
"id": "string",
"intervals": [
{
"cost": 0.1,
"year": 0
}
],
"partCategory": "string",
"partId": "string"
}
],
"status": "OPERATIONAL",
"tenantId": "string",
"type": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Get the subtree of an asset location
AuthorizationBearer <token>
In: header
Path Parameters
locationId*string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/asset-instances/instances/string"[
{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"assetLocation": {
"children": [
"string"
],
"clients": [
"string"
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"id": "string",
"isRoot": true,
"name": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
},
"certifications": [
{
"critical": true,
"description": "string",
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"isCritical": true,
"isRepeat": true,
"issueDate": "2019-08-24T14:15:22Z",
"repeat": true,
"status": "VALID",
"type": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currentValue": 0.1,
"failures": [
{
"alerted": "2019-08-24T14:15:22Z",
"arrival": "2019-08-24T14:15:22Z",
"cause": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"repaired": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"id": "string",
"installationDate": "2019-08-24T14:15:22Z",
"maintenance": [
{
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"doneDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"executed": true,
"finished": true,
"id": "string",
"status": "PLANNED",
"type": "MAINTENANCE"
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"objectNumber": "string",
"product": {
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [
{
"amount": 0.1,
"product": {},
"unit": "string"
}
],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
},
"risk": "LOW",
"serialNumber": "string",
"serviceIntervals": [
{
"description": "string",
"id": "string",
"intervals": [
{
"cost": 0.1,
"year": 0
}
],
"partCategory": "string",
"partId": "string"
}
],
"status": "OPERATIONAL",
"type": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
]{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Get asset location tree for the current user with instances
AuthorizationBearer <token>
In: header
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/asset-instances/me"[
{
"assetInstances": [
{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"assetLocationId": "string",
"certifications": [
{
"critical": true,
"description": "string",
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"isCritical": true,
"isRepeat": true,
"issueDate": "2019-08-24T14:15:22Z",
"repeat": true,
"status": "VALID",
"type": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currentValue": 0.1,
"failures": [
{
"alerted": "2019-08-24T14:15:22Z",
"arrival": "2019-08-24T14:15:22Z",
"cause": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"repaired": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"id": "string",
"installationDate": "2019-08-24T14:15:22Z",
"maintenance": [
{
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"doneDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"executed": true,
"finished": true,
"id": "string",
"status": "PLANNED",
"type": "MAINTENANCE"
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"objectNumber": "string",
"productId": "string",
"serialNumber": "string",
"serviceIntervals": [
{
"description": "string",
"id": "string",
"intervals": [
{
"cost": 0.1,
"year": 0
}
],
"partCategory": "string",
"partId": "string"
}
],
"status": "OPERATIONAL",
"tenantId": "string",
"type": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
],
"children": [
{}
],
"clients": [
"string"
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"enrichedClients": [
{
"email": "string",
"firstName": "string",
"hasFullAccess": true,
"id": "string",
"language": "string",
"lastLogin": "2019-08-24T14:15:22Z",
"lastName": "string",
"profile": {
"avatar": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
},
"displayName": "string",
"logo": {
"blobId": "string",
"height": 0,
"thumbnailBlobId": "string",
"width": 0
}
},
"projectAccess": [
"string"
],
"roles": [
"string"
],
"status": "ACTIVE",
"subsidiaryAccess": [
"string"
],
"tenantId": "string",
"verified": true
}
],
"id": "string",
"isRoot": true,
"name": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
]{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Get page by page number and size with optional sorting based on field to sortBy and direction
AuthorizationBearer <token>
In: header
Query Parameters
pageNumber?integer
Format
int32pageSize?integer
Format
int32sortBy?string
direction?string
Value in
"ASC" | "DESC"search?string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/asset-instances/page"{
"content": [
{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"assetLocationId": "string",
"certifications": [
{
"critical": true,
"description": "string",
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"isCritical": true,
"isRepeat": true,
"issueDate": "2019-08-24T14:15:22Z",
"repeat": true,
"status": "VALID",
"type": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currentValue": 0.1,
"failures": [
{
"alerted": "2019-08-24T14:15:22Z",
"arrival": "2019-08-24T14:15:22Z",
"cause": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"repaired": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"id": "string",
"installationDate": "2019-08-24T14:15:22Z",
"maintenance": [
{
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"doneDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"executed": true,
"finished": true,
"id": "string",
"status": "PLANNED",
"type": "MAINTENANCE"
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"objectNumber": "string",
"productId": "string",
"serialNumber": "string",
"serviceIntervals": [
{
"description": "string",
"id": "string",
"intervals": [
{
"cost": 0.1,
"year": 0
}
],
"partCategory": "string",
"partId": "string"
}
],
"status": "OPERATIONAL",
"tenantId": "string",
"type": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}
],
"empty": true,
"first": true,
"last": true,
"number": 0,
"numberOfElements": 0,
"pageable": {
"offset": 0,
"pageNumber": 0,
"pageSize": 0,
"paged": true,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"unpaged": true
},
"size": 0,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"totalElements": 0,
"totalPages": 0
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Get an asset instance by id
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Response Body
application/json
application/json
application/json
application/json
curl -X GET "http://localhost:18080/api/v1/asset-instances/string"{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"assetLocation": {
"children": [
"string"
],
"clients": [
"string"
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"description": "string",
"id": "string",
"isRoot": true,
"name": "string",
"tenantId": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
},
"certifications": [
{
"critical": true,
"description": "string",
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"isCritical": true,
"isRepeat": true,
"issueDate": "2019-08-24T14:15:22Z",
"repeat": true,
"status": "VALID",
"type": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currentValue": 0.1,
"failures": [
{
"alerted": "2019-08-24T14:15:22Z",
"arrival": "2019-08-24T14:15:22Z",
"cause": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"repaired": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"id": "string",
"installationDate": "2019-08-24T14:15:22Z",
"maintenance": [
{
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"doneDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"executed": true,
"finished": true,
"id": "string",
"status": "PLANNED",
"type": "MAINTENANCE"
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"objectNumber": "string",
"product": {
"assets": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"brand": "string",
"c02": 0.1,
"category": "string",
"cost": 0.1,
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currency": "string",
"description": "string",
"dimensions": {
"height": 0.1,
"length": 0.1,
"width": 0.1
},
"discounts": [
{
"active": true,
"clientTypes": [
"PERSON"
],
"name": "string",
"regions": [
"string"
],
"volumeThresholds": [
{
"discountPercentage": 1,
"minAmount": 1
}
]
}
],
"events": [
{
"authorId": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"type": "CREATE"
}
],
"gtin": {
"gtin": "string",
"type": "GTIN8"
},
"id": "string",
"lifetime": 0.1,
"metaData": [
{
"key": "string",
"value": "string"
}
],
"name": "string",
"partCosts": 0.1,
"parts": [
{
"amount": 0.1,
"product": {},
"unit": "string"
}
],
"price": 0.1,
"reference": "string",
"reorderPoint": 0.1,
"revision": 0,
"revisionCode": "string",
"safetyStock": 0.1,
"subsidiaryId": "string",
"supplierId": "string",
"taxRate": 0.1,
"tenantId": "string",
"totalCosts": 0.1,
"type": "RAW_MATERIAL",
"unitsOfMeasurement": [
{
"baseUnit": true,
"cost": 0.1,
"decimal": true,
"isBaseUnit": true,
"isDecimal": true,
"name": "string",
"quantity": 0.1,
"salesPrice": 0.1,
"unit": "string"
}
],
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string",
"variant": "string",
"visibility": "PUBLIC",
"volume": 0.1,
"weight": 0.1
},
"risk": "LOW",
"serialNumber": "string",
"serviceIntervals": [
{
"description": "string",
"id": "string",
"intervals": [
{
"cost": 0.1,
"year": 0
}
],
"partCategory": "string",
"partId": "string"
}
],
"status": "OPERATIONAL",
"type": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Delete by id in current tenant
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Response Body
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/asset-instances/string"Empty
{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Update an asset instance
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PUT "http://localhost:18080/api/v1/asset-instances/string" \ -H "Content-Type: application/json" \ -d '{ "assetLocationId": "string", "currentValue": 0.1, "installationDate": "2019-08-24T14:15:22Z", "metadata": { "property1": "string", "property2": "string" }, "name": "string", "objectNumber": "string", "productId": "string", "serialNumber": "string", "status": "OPERATIONAL", "type": "string" }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"assetLocationId": "string",
"certifications": [
{
"critical": true,
"description": "string",
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"isCritical": true,
"isRepeat": true,
"issueDate": "2019-08-24T14:15:22Z",
"repeat": true,
"status": "VALID",
"type": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currentValue": 0.1,
"failures": [
{
"alerted": "2019-08-24T14:15:22Z",
"arrival": "2019-08-24T14:15:22Z",
"cause": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"repaired": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"id": "string",
"installationDate": "2019-08-24T14:15:22Z",
"maintenance": [
{
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"doneDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"executed": true,
"finished": true,
"id": "string",
"status": "PLANNED",
"type": "MAINTENANCE"
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"objectNumber": "string",
"productId": "string",
"serialNumber": "string",
"serviceIntervals": [
{
"description": "string",
"id": "string",
"intervals": [
{
"cost": 0.1,
"year": 0
}
],
"partCategory": "string",
"partId": "string"
}
],
"status": "OPERATIONAL",
"tenantId": "string",
"type": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Add or update certification
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/asset-instances/string/certifications" \ -H "Content-Type: application/json" \ -d '{ "issueDate": "2019-08-24T14:15:22Z" }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"assetLocationId": "string",
"certifications": [
{
"critical": true,
"description": "string",
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"isCritical": true,
"isRepeat": true,
"issueDate": "2019-08-24T14:15:22Z",
"repeat": true,
"status": "VALID",
"type": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currentValue": 0.1,
"failures": [
{
"alerted": "2019-08-24T14:15:22Z",
"arrival": "2019-08-24T14:15:22Z",
"cause": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"repaired": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"id": "string",
"installationDate": "2019-08-24T14:15:22Z",
"maintenance": [
{
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"doneDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"executed": true,
"finished": true,
"id": "string",
"status": "PLANNED",
"type": "MAINTENANCE"
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"objectNumber": "string",
"productId": "string",
"serialNumber": "string",
"serviceIntervals": [
{
"description": "string",
"id": "string",
"intervals": [
{
"cost": 0.1,
"year": 0
}
],
"partCategory": "string",
"partId": "string"
}
],
"status": "OPERATIONAL",
"tenantId": "string",
"type": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Bulk import certifications
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/asset-instances/string/certifications/bulk" \ -H "Content-Type: application/json" \ -d '[ { "issueDate": "2019-08-24T14:15:22Z" } ]'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"assetLocationId": "string",
"certifications": [
{
"critical": true,
"description": "string",
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"isCritical": true,
"isRepeat": true,
"issueDate": "2019-08-24T14:15:22Z",
"repeat": true,
"status": "VALID",
"type": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currentValue": 0.1,
"failures": [
{
"alerted": "2019-08-24T14:15:22Z",
"arrival": "2019-08-24T14:15:22Z",
"cause": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"repaired": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"id": "string",
"installationDate": "2019-08-24T14:15:22Z",
"maintenance": [
{
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"doneDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"executed": true,
"finished": true,
"id": "string",
"status": "PLANNED",
"type": "MAINTENANCE"
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"objectNumber": "string",
"productId": "string",
"serialNumber": "string",
"serviceIntervals": [
{
"description": "string",
"id": "string",
"intervals": [
{
"cost": 0.1,
"year": 0
}
],
"partCategory": "string",
"partId": "string"
}
],
"status": "OPERATIONAL",
"tenantId": "string",
"type": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Delete certification from an asset instance
AuthorizationBearer <token>
In: header
Path Parameters
id*string
certificationId*string
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/asset-instances/string/certifications/string"{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"assetLocationId": "string",
"certifications": [
{
"critical": true,
"description": "string",
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"isCritical": true,
"isRepeat": true,
"issueDate": "2019-08-24T14:15:22Z",
"repeat": true,
"status": "VALID",
"type": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currentValue": 0.1,
"failures": [
{
"alerted": "2019-08-24T14:15:22Z",
"arrival": "2019-08-24T14:15:22Z",
"cause": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"repaired": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"id": "string",
"installationDate": "2019-08-24T14:15:22Z",
"maintenance": [
{
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"doneDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"executed": true,
"finished": true,
"id": "string",
"status": "PLANNED",
"type": "MAINTENANCE"
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"objectNumber": "string",
"productId": "string",
"serialNumber": "string",
"serviceIntervals": [
{
"description": "string",
"id": "string",
"intervals": [
{
"cost": 0.1,
"year": 0
}
],
"partCategory": "string",
"partId": "string"
}
],
"status": "OPERATIONAL",
"tenantId": "string",
"type": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Update certification of an asset instance
AuthorizationBearer <token>
In: header
Path Parameters
id*string
certificationId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PUT "http://localhost:18080/api/v1/asset-instances/string/certifications/string" \ -H "Content-Type: application/json" \ -d '{ "issueDate": "2019-08-24T14:15:22Z" }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"assetLocationId": "string",
"certifications": [
{
"critical": true,
"description": "string",
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"isCritical": true,
"isRepeat": true,
"issueDate": "2019-08-24T14:15:22Z",
"repeat": true,
"status": "VALID",
"type": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currentValue": 0.1,
"failures": [
{
"alerted": "2019-08-24T14:15:22Z",
"arrival": "2019-08-24T14:15:22Z",
"cause": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"repaired": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"id": "string",
"installationDate": "2019-08-24T14:15:22Z",
"maintenance": [
{
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"doneDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"executed": true,
"finished": true,
"id": "string",
"status": "PLANNED",
"type": "MAINTENANCE"
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"objectNumber": "string",
"productId": "string",
"serialNumber": "string",
"serviceIntervals": [
{
"description": "string",
"id": "string",
"intervals": [
{
"cost": 0.1,
"year": 0
}
],
"partCategory": "string",
"partId": "string"
}
],
"status": "OPERATIONAL",
"tenantId": "string",
"type": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Add document to certification of an asset instance
AuthorizationBearer <token>
In: header
Path Parameters
id*string
certificationId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/asset-instances/string/certifications/string/document" \ -H "Content-Type: application/json" \ -d '{ "files": [ "string" ] }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"assetLocationId": "string",
"certifications": [
{
"critical": true,
"description": "string",
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"isCritical": true,
"isRepeat": true,
"issueDate": "2019-08-24T14:15:22Z",
"repeat": true,
"status": "VALID",
"type": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currentValue": 0.1,
"failures": [
{
"alerted": "2019-08-24T14:15:22Z",
"arrival": "2019-08-24T14:15:22Z",
"cause": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"repaired": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"id": "string",
"installationDate": "2019-08-24T14:15:22Z",
"maintenance": [
{
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"doneDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"executed": true,
"finished": true,
"id": "string",
"status": "PLANNED",
"type": "MAINTENANCE"
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"objectNumber": "string",
"productId": "string",
"serialNumber": "string",
"serviceIntervals": [
{
"description": "string",
"id": "string",
"intervals": [
{
"cost": 0.1,
"year": 0
}
],
"partCategory": "string",
"partId": "string"
}
],
"status": "OPERATIONAL",
"tenantId": "string",
"type": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Delete document from certification of an asset instance
AuthorizationBearer <token>
In: header
Path Parameters
id*string
certificationId*string
blobId*string
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/asset-instances/string/certifications/string/document/string"{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"assetLocationId": "string",
"certifications": [
{
"critical": true,
"description": "string",
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"isCritical": true,
"isRepeat": true,
"issueDate": "2019-08-24T14:15:22Z",
"repeat": true,
"status": "VALID",
"type": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currentValue": 0.1,
"failures": [
{
"alerted": "2019-08-24T14:15:22Z",
"arrival": "2019-08-24T14:15:22Z",
"cause": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"repaired": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"id": "string",
"installationDate": "2019-08-24T14:15:22Z",
"maintenance": [
{
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"doneDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"executed": true,
"finished": true,
"id": "string",
"status": "PLANNED",
"type": "MAINTENANCE"
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"objectNumber": "string",
"productId": "string",
"serialNumber": "string",
"serviceIntervals": [
{
"description": "string",
"id": "string",
"intervals": [
{
"cost": 0.1,
"year": 0
}
],
"partCategory": "string",
"partId": "string"
}
],
"status": "OPERATIONAL",
"tenantId": "string",
"type": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Add failure to an asset instance
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Query Parameters
idOverride?string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/asset-instances/string/failures" \ -H "Content-Type: application/json" \ -d '{ "cause": "string", "date": "2019-08-24T14:15:22Z", "description": "string", "type": "string" }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"assetLocationId": "string",
"certifications": [
{
"critical": true,
"description": "string",
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"isCritical": true,
"isRepeat": true,
"issueDate": "2019-08-24T14:15:22Z",
"repeat": true,
"status": "VALID",
"type": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currentValue": 0.1,
"failures": [
{
"alerted": "2019-08-24T14:15:22Z",
"arrival": "2019-08-24T14:15:22Z",
"cause": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"repaired": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"id": "string",
"installationDate": "2019-08-24T14:15:22Z",
"maintenance": [
{
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"doneDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"executed": true,
"finished": true,
"id": "string",
"status": "PLANNED",
"type": "MAINTENANCE"
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"objectNumber": "string",
"productId": "string",
"serialNumber": "string",
"serviceIntervals": [
{
"description": "string",
"id": "string",
"intervals": [
{
"cost": 0.1,
"year": 0
}
],
"partCategory": "string",
"partId": "string"
}
],
"status": "OPERATIONAL",
"tenantId": "string",
"type": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Bulk import failures
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/asset-instances/string/failures/bulk" \ -H "Content-Type: application/json" \ -d '[ { "cause": "string", "date": "2019-08-24T14:15:22Z", "description": "string", "type": "string" } ]'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"assetLocationId": "string",
"certifications": [
{
"critical": true,
"description": "string",
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"isCritical": true,
"isRepeat": true,
"issueDate": "2019-08-24T14:15:22Z",
"repeat": true,
"status": "VALID",
"type": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currentValue": 0.1,
"failures": [
{
"alerted": "2019-08-24T14:15:22Z",
"arrival": "2019-08-24T14:15:22Z",
"cause": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"repaired": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"id": "string",
"installationDate": "2019-08-24T14:15:22Z",
"maintenance": [
{
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"doneDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"executed": true,
"finished": true,
"id": "string",
"status": "PLANNED",
"type": "MAINTENANCE"
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"objectNumber": "string",
"productId": "string",
"serialNumber": "string",
"serviceIntervals": [
{
"description": "string",
"id": "string",
"intervals": [
{
"cost": 0.1,
"year": 0
}
],
"partCategory": "string",
"partId": "string"
}
],
"status": "OPERATIONAL",
"tenantId": "string",
"type": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Delete failure from an asset instance
AuthorizationBearer <token>
In: header
Path Parameters
id*string
failureId*string
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/asset-instances/string/failures/string"{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"assetLocationId": "string",
"certifications": [
{
"critical": true,
"description": "string",
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"isCritical": true,
"isRepeat": true,
"issueDate": "2019-08-24T14:15:22Z",
"repeat": true,
"status": "VALID",
"type": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currentValue": 0.1,
"failures": [
{
"alerted": "2019-08-24T14:15:22Z",
"arrival": "2019-08-24T14:15:22Z",
"cause": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"repaired": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"id": "string",
"installationDate": "2019-08-24T14:15:22Z",
"maintenance": [
{
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"doneDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"executed": true,
"finished": true,
"id": "string",
"status": "PLANNED",
"type": "MAINTENANCE"
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"objectNumber": "string",
"productId": "string",
"serialNumber": "string",
"serviceIntervals": [
{
"description": "string",
"id": "string",
"intervals": [
{
"cost": 0.1,
"year": 0
}
],
"partCategory": "string",
"partId": "string"
}
],
"status": "OPERATIONAL",
"tenantId": "string",
"type": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Update failure of an asset instance
AuthorizationBearer <token>
In: header
Path Parameters
id*string
failureId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PUT "http://localhost:18080/api/v1/asset-instances/string/failures/string" \ -H "Content-Type: application/json" \ -d '{ "cause": "string", "date": "2019-08-24T14:15:22Z", "description": "string", "type": "string" }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"assetLocationId": "string",
"certifications": [
{
"critical": true,
"description": "string",
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"isCritical": true,
"isRepeat": true,
"issueDate": "2019-08-24T14:15:22Z",
"repeat": true,
"status": "VALID",
"type": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currentValue": 0.1,
"failures": [
{
"alerted": "2019-08-24T14:15:22Z",
"arrival": "2019-08-24T14:15:22Z",
"cause": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"repaired": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"id": "string",
"installationDate": "2019-08-24T14:15:22Z",
"maintenance": [
{
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"doneDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"executed": true,
"finished": true,
"id": "string",
"status": "PLANNED",
"type": "MAINTENANCE"
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"objectNumber": "string",
"productId": "string",
"serialNumber": "string",
"serviceIntervals": [
{
"description": "string",
"id": "string",
"intervals": [
{
"cost": 0.1,
"year": 0
}
],
"partCategory": "string",
"partId": "string"
}
],
"status": "OPERATIONAL",
"tenantId": "string",
"type": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Add maintenance to an asset instance
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Query Parameters
idOverride?string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/asset-instances/string/maintenance" \ -H "Content-Type: application/json" \ -d '{ "maintenance": { "dueDate": "2019-08-24T14:15:22Z", "executed": true, "markedAsDone": true, "status": "PLANNED", "type": "MAINTENANCE" } }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"assetLocationId": "string",
"certifications": [
{
"critical": true,
"description": "string",
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"isCritical": true,
"isRepeat": true,
"issueDate": "2019-08-24T14:15:22Z",
"repeat": true,
"status": "VALID",
"type": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currentValue": 0.1,
"failures": [
{
"alerted": "2019-08-24T14:15:22Z",
"arrival": "2019-08-24T14:15:22Z",
"cause": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"repaired": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"id": "string",
"installationDate": "2019-08-24T14:15:22Z",
"maintenance": [
{
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"doneDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"executed": true,
"finished": true,
"id": "string",
"status": "PLANNED",
"type": "MAINTENANCE"
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"objectNumber": "string",
"productId": "string",
"serialNumber": "string",
"serviceIntervals": [
{
"description": "string",
"id": "string",
"intervals": [
{
"cost": 0.1,
"year": 0
}
],
"partCategory": "string",
"partId": "string"
}
],
"status": "OPERATIONAL",
"tenantId": "string",
"type": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Bulk import maintenance records
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/asset-instances/string/maintenance/bulk" \ -H "Content-Type: application/json" \ -d '[ { "dueDate": "2019-08-24T14:15:22Z", "executed": true, "markedAsDone": true, "status": "PLANNED", "type": "MAINTENANCE" } ]'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"assetLocationId": "string",
"certifications": [
{
"critical": true,
"description": "string",
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"isCritical": true,
"isRepeat": true,
"issueDate": "2019-08-24T14:15:22Z",
"repeat": true,
"status": "VALID",
"type": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currentValue": 0.1,
"failures": [
{
"alerted": "2019-08-24T14:15:22Z",
"arrival": "2019-08-24T14:15:22Z",
"cause": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"repaired": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"id": "string",
"installationDate": "2019-08-24T14:15:22Z",
"maintenance": [
{
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"doneDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"executed": true,
"finished": true,
"id": "string",
"status": "PLANNED",
"type": "MAINTENANCE"
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"objectNumber": "string",
"productId": "string",
"serialNumber": "string",
"serviceIntervals": [
{
"description": "string",
"id": "string",
"intervals": [
{
"cost": 0.1,
"year": 0
}
],
"partCategory": "string",
"partId": "string"
}
],
"status": "OPERATIONAL",
"tenantId": "string",
"type": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Delete maintenance from an asset instance
AuthorizationBearer <token>
In: header
Path Parameters
id*string
maintenanceId*string
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/asset-instances/string/maintenance/string"{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"assetLocationId": "string",
"certifications": [
{
"critical": true,
"description": "string",
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"isCritical": true,
"isRepeat": true,
"issueDate": "2019-08-24T14:15:22Z",
"repeat": true,
"status": "VALID",
"type": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currentValue": 0.1,
"failures": [
{
"alerted": "2019-08-24T14:15:22Z",
"arrival": "2019-08-24T14:15:22Z",
"cause": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"repaired": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"id": "string",
"installationDate": "2019-08-24T14:15:22Z",
"maintenance": [
{
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"doneDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"executed": true,
"finished": true,
"id": "string",
"status": "PLANNED",
"type": "MAINTENANCE"
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"objectNumber": "string",
"productId": "string",
"serialNumber": "string",
"serviceIntervals": [
{
"description": "string",
"id": "string",
"intervals": [
{
"cost": 0.1,
"year": 0
}
],
"partCategory": "string",
"partId": "string"
}
],
"status": "OPERATIONAL",
"tenantId": "string",
"type": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Update maintenance of an asset instance
AuthorizationBearer <token>
In: header
Path Parameters
id*string
maintenanceId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PUT "http://localhost:18080/api/v1/asset-instances/string/maintenance/string" \ -H "Content-Type: application/json" \ -d '{ "dueDate": "2019-08-24T14:15:22Z", "executed": true, "markedAsDone": true, "status": "PLANNED", "type": "MAINTENANCE" }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"assetLocationId": "string",
"certifications": [
{
"critical": true,
"description": "string",
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"isCritical": true,
"isRepeat": true,
"issueDate": "2019-08-24T14:15:22Z",
"repeat": true,
"status": "VALID",
"type": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currentValue": 0.1,
"failures": [
{
"alerted": "2019-08-24T14:15:22Z",
"arrival": "2019-08-24T14:15:22Z",
"cause": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"repaired": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"id": "string",
"installationDate": "2019-08-24T14:15:22Z",
"maintenance": [
{
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"doneDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"executed": true,
"finished": true,
"id": "string",
"status": "PLANNED",
"type": "MAINTENANCE"
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"objectNumber": "string",
"productId": "string",
"serialNumber": "string",
"serviceIntervals": [
{
"description": "string",
"id": "string",
"intervals": [
{
"cost": 0.1,
"year": 0
}
],
"partCategory": "string",
"partId": "string"
}
],
"status": "OPERATIONAL",
"tenantId": "string",
"type": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Add document to maintenance of an asset instance
AuthorizationBearer <token>
In: header
Path Parameters
id*string
maintenanceId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/asset-instances/string/maintenance/string/document" \ -H "Content-Type: application/json" \ -d '{ "files": [ "string" ] }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"assetLocationId": "string",
"certifications": [
{
"critical": true,
"description": "string",
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"isCritical": true,
"isRepeat": true,
"issueDate": "2019-08-24T14:15:22Z",
"repeat": true,
"status": "VALID",
"type": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currentValue": 0.1,
"failures": [
{
"alerted": "2019-08-24T14:15:22Z",
"arrival": "2019-08-24T14:15:22Z",
"cause": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"repaired": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"id": "string",
"installationDate": "2019-08-24T14:15:22Z",
"maintenance": [
{
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"doneDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"executed": true,
"finished": true,
"id": "string",
"status": "PLANNED",
"type": "MAINTENANCE"
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"objectNumber": "string",
"productId": "string",
"serialNumber": "string",
"serviceIntervals": [
{
"description": "string",
"id": "string",
"intervals": [
{
"cost": 0.1,
"year": 0
}
],
"partCategory": "string",
"partId": "string"
}
],
"status": "OPERATIONAL",
"tenantId": "string",
"type": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Delete document from maintenance of an asset instance
AuthorizationBearer <token>
In: header
Path Parameters
id*string
maintenanceId*string
blobId*string
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/asset-instances/string/maintenance/string/document/string"{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"assetLocationId": "string",
"certifications": [
{
"critical": true,
"description": "string",
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"isCritical": true,
"isRepeat": true,
"issueDate": "2019-08-24T14:15:22Z",
"repeat": true,
"status": "VALID",
"type": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currentValue": 0.1,
"failures": [
{
"alerted": "2019-08-24T14:15:22Z",
"arrival": "2019-08-24T14:15:22Z",
"cause": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"repaired": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"id": "string",
"installationDate": "2019-08-24T14:15:22Z",
"maintenance": [
{
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"doneDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"executed": true,
"finished": true,
"id": "string",
"status": "PLANNED",
"type": "MAINTENANCE"
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"objectNumber": "string",
"productId": "string",
"serialNumber": "string",
"serviceIntervals": [
{
"description": "string",
"id": "string",
"intervals": [
{
"cost": 0.1,
"year": 0
}
],
"partCategory": "string",
"partId": "string"
}
],
"status": "OPERATIONAL",
"tenantId": "string",
"type": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Add service interval to an asset instance
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Query Parameters
idOverride?string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/asset-instances/string/service-intervals" \ -H "Content-Type: application/json" \ -d '{ "description": "string", "intervals": [ { "cost": 0.1, "year": 0 } ], "partCategory": "string", "partId": "string" }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"assetLocationId": "string",
"certifications": [
{
"critical": true,
"description": "string",
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"isCritical": true,
"isRepeat": true,
"issueDate": "2019-08-24T14:15:22Z",
"repeat": true,
"status": "VALID",
"type": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currentValue": 0.1,
"failures": [
{
"alerted": "2019-08-24T14:15:22Z",
"arrival": "2019-08-24T14:15:22Z",
"cause": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"repaired": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"id": "string",
"installationDate": "2019-08-24T14:15:22Z",
"maintenance": [
{
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"doneDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"executed": true,
"finished": true,
"id": "string",
"status": "PLANNED",
"type": "MAINTENANCE"
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"objectNumber": "string",
"productId": "string",
"serialNumber": "string",
"serviceIntervals": [
{
"description": "string",
"id": "string",
"intervals": [
{
"cost": 0.1,
"year": 0
}
],
"partCategory": "string",
"partId": "string"
}
],
"status": "OPERATIONAL",
"tenantId": "string",
"type": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Bulk import service intervals (MJOB)
AuthorizationBearer <token>
In: header
Path Parameters
id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://localhost:18080/api/v1/asset-instances/string/service-intervals/bulk" \ -H "Content-Type: application/json" \ -d '[ { "description": "string", "intervals": [ { "cost": 0.1, "year": 0 } ], "partCategory": "string", "partId": "string" } ]'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"assetLocationId": "string",
"certifications": [
{
"critical": true,
"description": "string",
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"isCritical": true,
"isRepeat": true,
"issueDate": "2019-08-24T14:15:22Z",
"repeat": true,
"status": "VALID",
"type": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currentValue": 0.1,
"failures": [
{
"alerted": "2019-08-24T14:15:22Z",
"arrival": "2019-08-24T14:15:22Z",
"cause": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"repaired": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"id": "string",
"installationDate": "2019-08-24T14:15:22Z",
"maintenance": [
{
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"doneDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"executed": true,
"finished": true,
"id": "string",
"status": "PLANNED",
"type": "MAINTENANCE"
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"objectNumber": "string",
"productId": "string",
"serialNumber": "string",
"serviceIntervals": [
{
"description": "string",
"id": "string",
"intervals": [
{
"cost": 0.1,
"year": 0
}
],
"partCategory": "string",
"partId": "string"
}
],
"status": "OPERATIONAL",
"tenantId": "string",
"type": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Delete service interval from an asset instance
AuthorizationBearer <token>
In: header
Path Parameters
id*string
serviceIntervalId*string
Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "http://localhost:18080/api/v1/asset-instances/string/service-intervals/string"{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"assetLocationId": "string",
"certifications": [
{
"critical": true,
"description": "string",
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"isCritical": true,
"isRepeat": true,
"issueDate": "2019-08-24T14:15:22Z",
"repeat": true,
"status": "VALID",
"type": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currentValue": 0.1,
"failures": [
{
"alerted": "2019-08-24T14:15:22Z",
"arrival": "2019-08-24T14:15:22Z",
"cause": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"repaired": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"id": "string",
"installationDate": "2019-08-24T14:15:22Z",
"maintenance": [
{
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"doneDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"executed": true,
"finished": true,
"id": "string",
"status": "PLANNED",
"type": "MAINTENANCE"
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"objectNumber": "string",
"productId": "string",
"serialNumber": "string",
"serviceIntervals": [
{
"description": "string",
"id": "string",
"intervals": [
{
"cost": 0.1,
"year": 0
}
],
"partCategory": "string",
"partId": "string"
}
],
"status": "OPERATIONAL",
"tenantId": "string",
"type": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}Update service interval of an asset instance
AuthorizationBearer <token>
In: header
Path Parameters
id*string
serviceIntervalId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PUT "http://localhost:18080/api/v1/asset-instances/string/service-intervals/string" \ -H "Content-Type: application/json" \ -d '{ "description": "string", "intervals": [ { "cost": 0.1, "year": 0 } ], "partCategory": "string", "partId": "string" }'{
"address": {
"city": "string",
"country": "string",
"houseNumber": "string",
"id": "string",
"latitude": 0.1,
"longitude": 0.1,
"postalCode": "string",
"street": "string"
},
"assetLocationId": "string",
"certifications": [
{
"critical": true,
"description": "string",
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"expirationDate": "2019-08-24T14:15:22Z",
"id": "string",
"isCritical": true,
"isRepeat": true,
"issueDate": "2019-08-24T14:15:22Z",
"repeat": true,
"status": "VALID",
"type": "string"
}
],
"created": "2019-08-24T14:15:22Z",
"createdBy": "string",
"currentValue": 0.1,
"failures": [
{
"alerted": "2019-08-24T14:15:22Z",
"arrival": "2019-08-24T14:15:22Z",
"cause": "string",
"date": "2019-08-24T14:15:22Z",
"description": "string",
"id": "string",
"repaired": "2019-08-24T14:15:22Z",
"type": "string"
}
],
"id": "string",
"installationDate": "2019-08-24T14:15:22Z",
"maintenance": [
{
"documents": [
{
"blobId": "string",
"created": "2019-08-24T14:15:22Z",
"extension": "string",
"fileSize": 0,
"name": "string",
"type": "IMAGE"
}
],
"doneDate": "2019-08-24T14:15:22Z",
"dueDate": "2019-08-24T14:15:22Z",
"executed": true,
"finished": true,
"id": "string",
"status": "PLANNED",
"type": "MAINTENANCE"
}
],
"metadata": {
"property1": "string",
"property2": "string"
},
"name": "string",
"objectNumber": "string",
"productId": "string",
"serialNumber": "string",
"serviceIntervals": [
{
"description": "string",
"id": "string",
"intervals": [
{
"cost": 0.1,
"year": 0
}
],
"partCategory": "string",
"partId": "string"
}
],
"status": "OPERATIONAL",
"tenantId": "string",
"type": "string",
"updated": "2019-08-24T14:15:22Z",
"updatedBy": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}{
"detail": "string",
"time": "2019-08-24T14:15:22Z",
"title": "string"
}