{ "openapi": "3.1.0", "info": { "title": "AEMP ISO API", "description": "Provides access to fleet AEMP data based on the ISO 15143-3 standard", "version": "2.0" }, "externalDocs": { "description": "Trackunit Developer Hub", "url": "https://dev.trackunit.com/" }, "servers": [ { "url": "https://iris.trackunit.com/public/api/aemp/v2", "description": "API Endpoint" } ], "security": [ { "authorizationBearer": [] } ], "paths": { "/15143/-3/Fleet/{pageNumber}": { "get": { "tags": ["snapshot"], "summary": "Fleet snapshot", "description": "Gets the fleet snapshot of the latest available telematics data. Response is limited to a maximum of 100 records per page.", "operationId": "getFleetSnapshot", "parameters": [ { "name": "pageNumber", "in": "path", "description": "Requested page number. First request must use \"1\" as page number. Next available page number can be derived from the \"Links\"-section of the response.", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 }, { "name": "addMetadata", "in": "query", "description": "To extend the standard and add additional metadata information in the output set this parameter to true. The output will then contain a metadata section containing equipment related IDs used to system integration and reverse system lookup", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "addExtendedData", "in": "query", "description": "To extend the standard and add additional insight values in the output set this parameter to true.", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "includeOffRentAssets", "in": "query", "description": "Include off-rent assets in the response. If set to true, the response will include assets that are currently off-rent. If set to false, only on-rent assets will be included. Default is false for Customer Portal users and true for all other accounts.", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "addRentalData", "in": "query", "description": "To extend the standard and add additional rental data information in the output set this parameter to true.", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/Fleet" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Fleet" } } } }, "403": { "description": "Unauthorized request" }, "404": { "description": "Page not found" }, "429": { "description": "Request rate exceeded" }, "500": { "description": "Internal server error" } } } }, "/15143/-3/Fleet/Equipment/ID/{oemISOIdentifier}": { "get": { "tags": ["snapshot"], "summary": "Single-element snapshot", "description": "Gets the single-element snapshot of the latest available telematics data.", "operationId": "getSingleElement", "parameters": [ { "name": "oemISOIdentifier", "in": "path", "description": "OEM ISO identifier (PIN, VIN or telematics device serial number). PIN & VIN take priority in searching, and if not found, serial number is considered. The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.", "required": true, "schema": { "type": "string" } }, { "name": "addMetadata", "in": "query", "description": "To extend the standard and add additional metadata information in the output set this parameter to true. The output will then contain a metadata section containing equipment related IDs used to system integration and reverse system lookup", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "addExtendedData", "in": "query", "description": "To extend the standard and add additional insight values in the output set this parameter to true.", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/Fleet" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Fleet" } } } }, "403": { "description": "Unauthorized request" }, "404": { "description": "Page not found" }, "429": { "description": "Request rate exceeded" }, "500": { "description": "Internal server error" } } } }, "/15143/-3/Fleet/Equipment/ID/{oemISOIdentifier}/{timeSeriesType}/{startDate}/{endDate}/{pageNumber}": { "get": { "tags": ["time-series"], "summary": "Machine insights", "description": "Gets the time-series of custom MachineInsight type, not covered by AEMP ISO standard.", "operationId": "getMachineInsight", "parameters": [ { "name": "oemISOIdentifier", "in": "path", "description": "OEM ISO identifier (PIN, VIN or telematics device serial number). PIN & VIN take priority in searching, and if not found, serial number is considered. The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.", "required": true, "schema": { "type": "string" } }, { "name": "timeSeriesType", "in": "path", "description": "Custom time-series type matching a Machine Insight", "required": true, "schema": { "type": "string", "enum": [ "EngineFuelRate", "EngineSpeed", "EngineOilPressure", "EngineOilTemperature", "EngineCoolantTemperature", "EngineCoolantLevel", "EngineExhaustTemperature", "WaterInFuelIndicator", "HydraulicTemperature", "HydraulicOilLevel", "BatteryPotential", "SeatBeltSwitch", "EnginePercentLoadAtCurrentSpeed", "ActualEnginePercentTorque", "PitchAngle", "RollAngle", "AfterTreatmentDieselParticulateFilterSootLoadPercent", "AfterTreatmentDieselParticulateFilterAshLoadPercent", "AfterTreatmentDieselParticulateFilterTimeSinceLastActiveRegeneration", "AfterTreatmentDieselParticulateFilterPassiveRegenerationStatus", "AfterTreatmentDieselParticulateFilterStatus", "AfterTreatmentDieselParticulateFilterActiveRegenerationStatus", "AfterTreatmentDieselExhaustFluidTankTemperature", "AfterTreatmentScrOperatorInducementSeverity", "AfterTreatmentDieselExhaustFluidConcentration", "DieselParticulateFilterActiveRegenerationInhibitedDueToInhibitSwitch", "PayloadPercentage", "GeneratorTotalKwHoursExport", "HydraulicOilFilterRestrictionSwitch", "ServiceComponentIdentification", "EngineFuelDeliveryPressure", "EngineCoolantPressure", "WheelBasedVehicleSpeed", "BarometricPressure", "AmbientAirTemperature", "EngineIntakeAirTemperature", "RoadSurfaceTemperature", "EngineIntakeManifoldTemperature", "EngineAirFilterDifferentialPressure", "BatteryChargerState", "BatteryChargerPowerLineState", "BatteryChargerOutputVoltage", "BatteryChargerOutputCurrent", "EngineTripFuel", "AfterTreatmentDieselParticulateFilterDifferentialPressure", "AfterTreatmentDieselParticulateFilterIntakeTemperature", "AfterTreatmentExhaustTemperature", "AmberWarningLamp", "DieselParticulateFilterLampCommand", "EngineFuelTemperature", "EngineIntakeAirPressure", "EngineIntakeManifoldPressure", "EngineIntercoolerTemperature", "EngineOilLevel", "EngineTotalIdleFuelUsed", "ExhaustSystemHighTemperatureLampCommand", "HydraulicPressure", "MalfunctionIndicatorLamp", "ProtectLamp", "RedStopLamp", "TransmissionOilTemperature", "CumulativeProductiveHours", "CumulativeMovingHours", "Speed", "OperationStatus", "CumulativeEngineHours", "PlatformHeightPercent", "PlatformHeight", "PlatformElevated", "Payload", "BatteryStateOfChargePercent", "BatteryCurrent", "BatteryTemperature", "AcPhaseL1NeutralRMSVoltage", "AcPhaseL2NeutralRMSVoltage", "AcPhaseL3NeutralRMSVoltage", "AcPhaseL1Frequency", "AcPhaseL2Frequency", "AcPhaseL3Frequency", "AcPhaseL1RMSCurrent", "AcPhaseL2RMSCurrent", "AcPhaseL3RMSCurrent", "AcPhaseL1L2RMSVoltage", "AcPhaseL2L3RMSVoltage", "AcPhaseL3L1RMSVoltage", "AcTotalActivePower", "AcPhaseL1ActivePower", "AcPhaseL2ActivePower", "AcPhaseL3ActivePower", "AcTotalApparentPower", "AcTotalPowerFactor", "AcTotalReactivePower", "PayloadTemperature", "AcTotalRelativeActivePowerLoadPercentage", "AcTotalRelativeApparentPowerLoadPercentage", "AcTotalRelativeLoadPercentage", "AcAveragePhaseToNeutralRmsVoltage", "AcAveragePhaseToPhaseRmsVoltage", "AcAverageRmsCurrent", "Accelerometer_X_Axis", "Accelerometer_Y_Axis", "Accelerometer_Z_Axis", "Impact", "AftertreatmentDieselParticulateFilterTimeToNextActiveRegeneration", "AftertreatmentSCRTimeSinceLastCleaningEvent", "EngineFuelFilterDifferentialPressure", "EngineOilFilterDifferentialPressure", "AcAverageFrequency", "StabilizersDeployed", "PlatformStowed", "RescueModeActive", "BatteryStateOfHealthPercent", "BatteryRemainingRunTime", "BatteryChargeCyclesCount", "BatteryCumulativeDischargedEnergy", "BatteryRemainingChargeTime", "BatteryChargerInputVoltage", "BatteryChargerInputCurrent", "BatteryChargerOutputCurrentLimit", "BatteryChargerInputCurrentLimit", "CumulativeCO2Emissions", "AfterTreatmentDieselParticulateFilterActiveRegenerationState", "AfterTreatmentDieselParticulateFilterState", "CumulativeUtilizationHours", "WindSpeed", "WindDirection", "ParticleVelocity", "ParticulateMatter25", "ParticulateMatter10", "BatteryChargerCumulativeInputEnergy" ] }, "example": "EngineOilPressure" }, { "name": "startDate", "in": "path", "description": "Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-19T16:22:20Z" }, { "name": "endDate", "in": "path", "description": "End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-20T00:22:20Z" }, { "name": "pageNumber", "in": "path", "description": "Requested page number. The only supported value is \"1\"", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 } ], "responses": { "200": { "description": "Success", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/MachineInsightTimeseries" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MachineInsightTimeseries" } } } }, "403": { "description": "Unauthorized request, content = @Content(schema = @Schema(hidden = true))", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/MachineInsightTimeseries" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MachineInsightTimeseries" } } } }, "404": { "description": "Page not found" }, "429": { "description": "Request rate exceeded" }, "500": { "description": "Internal server error" } } } }, "/15143/-3/Fleet/Equipment/ID/{oemISOIdentifier}/PeakDailySpeed/{startDate}/{endDate}/{pageNumber}": { "get": { "tags": ["time-series"], "summary": "Peak daily speed", "description": "Gets the time-series of daily peak speed. Time-series is for a single construction machine over the specified time. Peak daily speed is the highest achieved travel speed for this machine during the previous 24 h period. Time-series is for a single construction machine over the specified time. The range of a time series is specified by its start date and time and end date and time. Time range can not be longer than 14 days.", "operationId": "getPeakDailySpeedTimeSeries", "parameters": [ { "name": "oemISOIdentifier", "in": "path", "description": "OEM ISO identifier (PIN, VIN or telematics device serial number). PIN & VIN take priority in searching, and if not found, serial number is considered. The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "path", "description": "Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-19T16:22:20Z" }, { "name": "endDate", "in": "path", "description": "End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-20T00:22:20Z" }, { "name": "pageNumber", "in": "path", "description": "Requested page number. The only supported value is \"1\"", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 } ], "responses": { "200": { "description": "Success", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/PeakDailySpeedMessages" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PeakDailySpeedMessages" } } } }, "403": { "description": "Unauthorized request" }, "404": { "description": "Page not found" }, "429": { "description": "Request rate exceeded" }, "500": { "description": "Internal server error" } } } }, "/15143/-3/Fleet/Equipment/ID/{oemISOIdentifier}/Locations/{startDate}/{endDate}/{pageNumber}": { "get": { "tags": ["time-series"], "summary": "Location", "description": "Gets the time-series of location data. Time-series is for a single construction machine over the specified time. The range of a time series is specified by its start date and time and end date and time. Time range can not be longer than 14 days.", "operationId": "getLocationTimeSeries", "parameters": [ { "name": "oemISOIdentifier", "in": "path", "description": "OEM ISO identifier (PIN, VIN or telematics device serial number). PIN & VIN take priority in searching, and if not found, serial number is considered. The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "path", "description": "Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-19T16:22:20Z" }, { "name": "endDate", "in": "path", "description": "End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-20T00:22:20Z" }, { "name": "pageNumber", "in": "path", "description": "Requested page number. The only supported value is \"1\"", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 } ], "responses": { "200": { "description": "Success", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/LocationMessages" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LocationMessages" } } } }, "403": { "description": "Unauthorized request" }, "404": { "description": "Page not found" }, "429": { "description": "Request rate exceeded" }, "500": { "description": "Internal server error" } } } }, "/15143/-3/Fleet/Equipment/ID/{oemISOIdentifier}/FuelUsedInThePreceding24Hours/{startDate}/{endDate}/{pageNumber}": { "get": { "tags": ["time-series"], "summary": "Fuel used within the past 24 hours.", "description": "Gets the time-series of fuel used within the past 24 hours. Time-series is for a single construction machine over the specified time. The range of a time series is specified by its start date and time and end date and time. Time range can not be longer than 14 days.", "operationId": "getCumulativeFuelUsedLast24HoursTimeSeries", "parameters": [ { "name": "oemISOIdentifier", "in": "path", "description": "OEM ISO identifier (PIN, VIN or telematics device serial number). PIN & VIN take priority in searching, and if not found, serial number is considered. The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "path", "description": "Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-19T16:22:20Z" }, { "name": "endDate", "in": "path", "description": "End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-20T00:22:20Z" }, { "name": "pageNumber", "in": "path", "description": "Requested page number. The only supported value is \"1\"", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 } ], "responses": { "200": { "description": "Success", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/FuelUsedMessages" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FuelUsedMessages" } } } }, "403": { "description": "Unauthorized request" }, "404": { "description": "Page not found" }, "429": { "description": "Request rate exceeded" }, "500": { "description": "Internal server error" } } } }, "/15143/-3/Fleet/Equipment/ID/{oemISOIdentifier}/FuelRemainingRatio/{startDate}/{endDate}/{pageNumber}": { "get": { "tags": ["time-series"], "summary": "Fuel Remaining Ratio", "description": "Gets the time-series of the percentage of fuel remaining in the fuel tank of the machine. Time-series is for a single construction machine over the specified time. The range of a time series is specified by its start date and time and end date and time. Time range can not be longer than 14 days.", "operationId": "getFuelRemainingRatioTimeSeries", "parameters": [ { "name": "oemISOIdentifier", "in": "path", "description": "OEM ISO identifier (PIN, VIN or telematics device serial number). PIN & VIN take priority in searching, and if not found, serial number is considered. The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "path", "description": "Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-19T16:22:20Z" }, { "name": "endDate", "in": "path", "description": "End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-20T00:22:20Z" }, { "name": "pageNumber", "in": "path", "description": "Requested page number. The only supported value is \"1\"", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 } ], "responses": { "200": { "description": "Success", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/FuelRemainingMessages" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FuelRemainingMessages" } } } }, "400": { "description": "Missing request body" }, "403": { "description": "Unauthorized request" }, "404": { "description": "Page not found" }, "429": { "description": "Request rate exceeded" }, "500": { "description": "Internal server error" } } } }, "/15143/-3/Fleet/Equipment/ID/{oemISOIdentifier}/Faults/{startDate}/{endDate}/{pageNumber}": { "get": { "tags": ["time-series"], "summary": "Diagnostic codes", "description": "Gets the time-series of diagnostic codes. The diagnostic codes, from the OEM, can alert the owner to the need for non-scheduled machine supports. Time-series is for a single construction machine over the specified time. The range of a time series is specified by its start date and time and end date and time. Time range can not be longer than 14 days.", "operationId": "getDiagnosticTroubleCodesTimeSeries", "parameters": [ { "name": "oemISOIdentifier", "in": "path", "description": "OEM ISO identifier (PIN, VIN or telematics device serial number). PIN & VIN take priority in searching, and if not found, serial number is considered. The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "path", "description": "Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-19T16:22:20Z" }, { "name": "endDate", "in": "path", "description": "End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-20T00:22:20Z" }, { "name": "pageNumber", "in": "path", "description": "Requested page number. The only supported value is \"1\"", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 } ], "responses": { "200": { "description": "Success", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/DiagnosticTroubleCode" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticTroubleCode" } } } }, "403": { "description": "Unauthorized request" }, "404": { "description": "Page not found" }, "429": { "description": "Request rate exceeded" }, "500": { "description": "Internal server error" } } } }, "/15143/-3/Fleet/Equipment/ID/{oemISOIdentifier}/EngineCondition/{startDate}/{endDate}/{pageNumber}": { "get": { "tags": ["time-series"], "summary": "Engine condition", "description": "Gets the time-series of engine condition. Time-series is for a single construction machine over the specified time. Engine condition is the running state of the engine as of the specified date and time. The range of a time series is specified by its start date and time and end date and time. Time range can not be longer than 14 days.", "operationId": "getEngineConditionTimeSeries", "parameters": [ { "name": "oemISOIdentifier", "in": "path", "description": "OEM ISO identifier (PIN, VIN or telematics device serial number). PIN & VIN take priority in searching, and if not found, serial number is considered. The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "path", "description": "Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-19T16:22:20Z" }, { "name": "endDate", "in": "path", "description": "End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-20T00:22:20Z" }, { "name": "pageNumber", "in": "path", "description": "Requested page number. The only supported value is \"1\"", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 } ], "responses": { "200": { "description": "Success", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/EngineStatusMessages" } }, "application/json": { "schema": { "$ref": "#/components/schemas/EngineStatusMessages" } } } }, "403": { "description": "Unauthorized request" }, "404": { "description": "Page not found" }, "429": { "description": "Request rate exceeded" }, "500": { "description": "Internal server error" } } } }, "/15143/-3/Fleet/Equipment/ID/{oemISOIdentifier}/Distance/{startDate}/{endDate}/{pageNumber}": { "get": { "tags": ["time-series"], "summary": "Cumulative distance travelled.", "description": "Gets the time-series of cumulative distance travelled. Time-series is for a single construction machine over the specified time. The range of a time series is specified by its start date and time and end date and time. Time range can not be longer than 14 days.", "operationId": "getDistanceTimeSeries", "parameters": [ { "name": "oemISOIdentifier", "in": "path", "description": "OEM ISO identifier (PIN, VIN or telematics device serial number). PIN & VIN take priority in searching, and if not found, serial number is considered. The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "path", "description": "Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-19T16:22:20Z" }, { "name": "endDate", "in": "path", "description": "End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-20T00:22:20Z" }, { "name": "pageNumber", "in": "path", "description": "Requested page number. The only supported value is \"1\"", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 } ], "responses": { "200": { "description": "Success", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/DistanceMessages" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DistanceMessages" } } } }, "403": { "description": "Unauthorized request" }, "404": { "description": "Page not found" }, "429": { "description": "Request rate exceeded" }, "500": { "description": "Internal server error" } } } }, "/15143/-3/Fleet/Equipment/ID/{oemISOIdentifier}/DEFRemaining/{startDate}/{endDate}/{pageNumber}": { "get": { "tags": ["time-series"], "summary": "Percent of DEF remaining", "description": "Gets the time-series of the percentage of diesel exhaust fluid (DEF) remaining in the DEF tank. Time-series is for a single construction machine over the specified time. The range of a time series is specified by its start date and time and end date and time. Time range can not be longer than 14 days.", "operationId": "getDEFRemainingTimeSeries", "parameters": [ { "name": "oemISOIdentifier", "in": "path", "description": "OEM ISO identifier (PIN, VIN or telematics device serial number). PIN & VIN take priority in searching, and if not found, serial number is considered. The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "path", "description": "Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-19T16:22:20Z" }, { "name": "endDate", "in": "path", "description": "End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-20T00:22:20Z" }, { "name": "pageNumber", "in": "path", "description": "Requested page number. The only supported value is \"1\"", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 } ], "responses": { "200": { "description": "Success", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/DEFRemainingMessages" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DEFRemainingMessages" } } } }, "403": { "description": "Unauthorized request" }, "404": { "description": "Page not found" }, "429": { "description": "Request rate exceeded" }, "500": { "description": "Internal server error" } } } }, "/15143/-3/Fleet/Equipment/ID/{oemISOIdentifier}/CumulativePowerTakeOffHours/{startDate}/{endDate}/{pageNumber}": { "get": { "tags": ["time-series"], "summary": "Cumulative power take-off hours", "description": "Gets the time-series of cumulative power take-off hours of the machine. Time-series is for a single construction machine over the specified time. The range of a time series is specified by its start date and time and end date and time. Time range can not be longer than 14 days.", "operationId": "getCumulativePowerTakeOffHoursTimeSeries", "parameters": [ { "name": "oemISOIdentifier", "in": "path", "description": "OEM ISO identifier (PIN, VIN or telematics device serial number). PIN & VIN take priority in searching, and if not found, serial number is considered. The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "path", "description": "Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-19T16:22:20Z" }, { "name": "endDate", "in": "path", "description": "End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-20T00:22:20Z" }, { "name": "pageNumber", "in": "path", "description": "Requested page number. The only supported value is \"1\"", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 } ], "responses": { "200": { "description": "Success", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/CumulativePowerTakeOffHoursMessages" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CumulativePowerTakeOffHoursMessages" } } } }, "403": { "description": "Unauthorized request" }, "404": { "description": "Page not found" }, "429": { "description": "Request rate exceeded" }, "500": { "description": "Internal server error" } } } }, "/15143/-3/Fleet/Equipment/ID/{oemISOIdentifier}/CumulativePayloadTotals/{startDate}/{endDate}/{pageNumber}": { "get": { "tags": ["time-series"], "summary": "Cumulative payload total", "description": "Gets the time-series of cumulative total payload moved by the machine. Time-series is for a single construction machine over the specified time. The range of a time series is specified by its start date and time and end date and time. Time range can not be longer than 14 days.", "operationId": "getCumulativePayloadTotalTimeSeries", "parameters": [ { "name": "oemISOIdentifier", "in": "path", "description": "OEM ISO identifier (PIN, VIN or telematics device serial number). PIN & VIN take priority in searching, and if not found, serial number is considered. The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "path", "description": "Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-19T16:22:20Z" }, { "name": "endDate", "in": "path", "description": "End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-20T00:22:20Z" }, { "name": "pageNumber", "in": "path", "description": "Requested page number. The only supported value is \"1\"", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 } ], "responses": { "200": { "description": "Success", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/CumulativePayloadTotalMessages" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CumulativePayloadTotalMessages" } } } }, "403": { "description": "Unauthorized request" }, "404": { "description": "Page not found" }, "429": { "description": "Request rate exceeded" }, "500": { "description": "Internal server error" } } } }, "/15143/-3/Fleet/Equipment/ID/{oemISOIdentifier}/CumulativeOperatingHours/{startDate}/{endDate}/{pageNumber}": { "get": { "tags": ["time-series"], "summary": "Cumulative operating hours", "description": "Gets the time-series of cumulative operating hours. Time-series is for a single construction machine over the specified time. The range of a time series is specified by its start date and time and end date and time. Time range can not be longer than 14 days.", "operationId": "getCumulativeOperatingHoursTimeSeries", "parameters": [ { "name": "oemISOIdentifier", "in": "path", "description": "OEM ISO identifier (PIN, VIN or telematics device serial number). PIN & VIN take priority in searching, and if not found, serial number is considered. The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "path", "description": "Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-19T16:22:20Z" }, { "name": "endDate", "in": "path", "description": "End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-20T00:22:20Z" }, { "name": "pageNumber", "in": "path", "description": "Requested page number. The only supported value is \"1\"", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 } ], "responses": { "200": { "description": "Success", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/CumulativeOperatingHoursMessages" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CumulativeOperatingHoursMessages" } } } }, "403": { "description": "Unauthorized request" }, "404": { "description": "Page not found" }, "429": { "description": "Request rate exceeded" }, "500": { "description": "Internal server error" } } } }, "/15143/-3/Fleet/Equipment/ID/{oemISOIdentifier}/CumulativeNonProductiveIdleHours/{startDate}/{endDate}/{pageNumber}": { "get": { "tags": ["time-series"], "summary": "Cumulative idle non-operating hours", "description": "Gets the time-series of cumulative idle non-operating hours. Cumulative idle non-operating hours are the total hours when the engine is running, but the machine is not moving and the machine controls are not operated (e.g. lever or pedal not operated). Time-series is for a single construction machine over the specified time. The range of a time series is specified by its start date and time and end date and time. Time range can not be longer than 14 days.", "operationId": "getCumulativeIdleNonOperatingHoursTimeSeries", "parameters": [ { "name": "oemISOIdentifier", "in": "path", "description": "OEM ISO identifier (PIN, VIN or telematics device serial number). PIN & VIN take priority in searching, and if not found, serial number is considered. The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "path", "description": "Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-19T16:22:20Z" }, { "name": "endDate", "in": "path", "description": "End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-20T00:22:20Z" }, { "name": "pageNumber", "in": "path", "description": "Requested page number. The only supported value is \"1\"", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 } ], "responses": { "200": { "description": "Success", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/CumulativeNonproductiveIdleHoursMessages" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CumulativeNonproductiveIdleHoursMessages" } } } }, "403": { "description": "Unauthorized request" }, "404": { "description": "Page not found" }, "429": { "description": "Request rate exceeded" }, "500": { "description": "Internal server error" } } } }, "/15143/-3/Fleet/Equipment/ID/{oemISOIdentifier}/CumulativeLoadCount/{startDate}/{endDate}/{pageNumber}": { "get": { "tags": ["time-series"], "summary": "Cumulative load count", "description": "Gets the time-series of cumulative load count. Time-series is for a single construction machine over the specified time. Cumulative load count is the lifetime total cumulative number of loads the machine has achieved. The definitions of load and load count are at the discretion of the manufacturer. The range of a time series is specified by its start date and time and end date and time. Time range can not be longer than 14 days.", "operationId": "getCumulativeLoadCountTimeSeries", "parameters": [ { "name": "oemISOIdentifier", "in": "path", "description": "OEM ISO identifier (PIN, VIN or telematics device serial number). PIN & VIN take priority in searching, and if not found, serial number is considered. The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "path", "description": "Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-19T16:22:20Z" }, { "name": "endDate", "in": "path", "description": "End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-20T00:22:20Z" }, { "name": "pageNumber", "in": "path", "description": "Requested page number. The only supported value is \"1\"", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 } ], "responses": { "200": { "description": "Success", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/CumulativeLoadCountMessages" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CumulativeLoadCountMessages" } } } }, "403": { "description": "Unauthorized request" }, "404": { "description": "Page not found" }, "429": { "description": "Request rate exceeded" }, "500": { "description": "Internal server error" } } } }, "/15143/-3/Fleet/Equipment/ID/{oemISOIdentifier}/CumulativeIdleHours/{startDate}/{endDate}/{pageNumber}": { "get": { "tags": ["time-series"], "summary": "Cumulative idle hours", "description": "Gets the time-series of cumulative idle hours. Time-series is for a single construction machine over the specified time. Cumulative idle hours are the total hours when the engine is running. The range of a time series is specified by its start date and time and end date and time. Time range can not be longer than 14 days.", "operationId": "getCumulativeIdleHoursTimeSeries", "parameters": [ { "name": "oemISOIdentifier", "in": "path", "description": "OEM ISO identifier (PIN, VIN or telematics device serial number). PIN & VIN take priority in searching, and if not found, serial number is considered. The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "path", "description": "Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-19T16:22:20Z" }, { "name": "endDate", "in": "path", "description": "End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-20T00:22:20Z" }, { "name": "pageNumber", "in": "path", "description": "Requested page number. The only supported value is \"1\"", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 } ], "responses": { "200": { "description": "Success", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/CumulativeIdleHoursMessages" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CumulativeIdleHoursMessages" } } } }, "403": { "description": "Unauthorized request" }, "404": { "description": "Page not found" }, "429": { "description": "Request rate exceeded" }, "500": { "description": "Internal server error" } } } }, "/15143/-3/Fleet/Equipment/ID/{oemISOIdentifier}/CumulativeFuelUsed/{startDate}/{endDate}/{pageNumber}": { "get": { "tags": ["time-series"], "summary": "Cumulative fuel used.", "description": "Gets the time-series of cumulative fuel used. Time-series is for a single construction machine over the specified time. The range of a time series is specified by its start date and time and end date and time. Time range can not be longer than 14 days.", "operationId": "getCumulativeFuelUsedTimeSeries", "parameters": [ { "name": "oemISOIdentifier", "in": "path", "description": "OEM ISO identifier (PIN, VIN or telematics device serial number). PIN & VIN take priority in searching, and if not found, serial number is considered. The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "path", "description": "Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-19T16:22:20Z" }, { "name": "endDate", "in": "path", "description": "End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-20T00:22:20Z" }, { "name": "pageNumber", "in": "path", "description": "Requested page number. The only supported value is \"1\"", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 } ], "responses": { "200": { "description": "Success", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/FuelUsedMessages" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FuelUsedMessages" } } } }, "403": { "description": "Unauthorized request" }, "404": { "description": "Page not found" }, "429": { "description": "Request rate exceeded" }, "500": { "description": "Internal server error" } } } }, "/15143/-3/Fleet/Equipment/ID/{oemISOIdentifier}/CumulativeActiveRegenerationHours/{startDate}/{endDate}/{pageNumber}": { "get": { "tags": ["time-series"], "summary": "Cumulative non-productive regeneration hours", "description": "Gets the time-series of cumulative non-productive regeneration hours. Time-series is for a single construction machine over the specified time. The range of a time series is specified by its start date and time and end date and time. Time range can not be longer than 14 days.", "operationId": "getCumulativeNonProductiveRegenerationHoursTimeSeries", "parameters": [ { "name": "oemISOIdentifier", "in": "path", "description": "OEM ISO identifier (PIN, VIN or telematics device serial number). PIN & VIN take priority in searching, and if not found, serial number is considered. The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "path", "description": "Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-19T16:22:20Z" }, { "name": "endDate", "in": "path", "description": "End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-20T00:22:20Z" }, { "name": "pageNumber", "in": "path", "description": "Requested page number. The only supported value is \"1\"", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 } ], "responses": { "200": { "description": "Success", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/CumulativeActiveRegenerationHourMessages" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CumulativeActiveRegenerationHourMessages" } } } }, "403": { "description": "Unauthorized request" }, "404": { "description": "Page not found" }, "429": { "description": "Request rate exceeded" }, "500": { "description": "Internal server error" } } } }, "/15143/-3/Fleet/Equipment/ID/{oemISOIdentifier}/AverageDailyEngineLoadFactors/{startDate}/{endDate}/{pageNumber}": { "get": { "tags": ["time-series"], "summary": "Average daily engine load factor", "description": "Gets the time-series of average daily engine load factor. Time-series is for a single construction machine over the specified time. The preferred definition of average daily load factor is a percentage calculated as the actual fuel consumed over the previous 24 h period divided by the fuel that would have been consumed during that period if the machine had been continually operated at the engine’s rated output. The range of a time series is specified by its start date and time and end date and time. Time range can not be longer than 14 days.", "operationId": "getAverageLoadFactorLast24HoursTimeSeries", "parameters": [ { "name": "oemISOIdentifier", "in": "path", "description": "OEM ISO identifier (PIN, VIN or telematics device serial number). PIN & VIN take priority in searching, and if not found, serial number is considered. The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.", "required": true, "schema": { "type": "string" } }, { "name": "startDate", "in": "path", "description": "Start date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-19T16:22:20Z" }, { "name": "endDate", "in": "path", "description": "End date and time of the requested time-series (inclusive). Date-time format must align to the ISO-8601 standard.", "required": true, "schema": { "type": "string" }, "example": "2020-01-20T00:22:20Z" }, { "name": "pageNumber", "in": "path", "description": "Requested page number. The only supported value is \"1\"", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 } ], "responses": { "200": { "description": "Success", "content": { "application/xml": { "schema": { "$ref": "#/components/schemas/AverageLoadFactorLast24" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AverageLoadFactorLast24" } } } }, "403": { "description": "Unauthorized request" }, "404": { "description": "Page not found" }, "429": { "description": "Request rate exceeded" }, "500": { "description": "Internal server error" } } } } }, "components": { "schemas": { "ActiveContractItem": { "type": "object", "description": "Information about when an asset is rented out to a customer.", "properties": { "OnRentDate": { "type": "string", "format": "date-time", "description": "Start of the rental period of the asset.", "title": "OnRentDate" }, "OffRentDate": { "type": "string", "format": "date-time", "description": "End of the rental period of the asset.", "title": "OffRentDate" } }, "title": "ActiveContractItem" }, "AfterTreatmentDieselExhaustFluidConcentrationExtended": { "type": "object", "properties": { "AfterTreatmentDieselExhaustFluidConcentration": { "type": "number", "title": "AfterTreatmentDieselExhaustFluidConcentration" }, "Value": { "type": "number", "description": "This value is deprecated and may be removed in future versions. Please use AfterTreatmentDieselExhaustFluidConcentration value instead.", "title": "Value" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "AfterTreatmentDieselParticulateFilterTimeSinceLastActiveRegenerationExtended": { "type": "object", "properties": { "AfterTreatmentDieselParticulateFilterTimeSinceLastActiveRegeneration": { "type": "number", "title": "AfterTreatmentDieselParticulateFilterTimeSinceLastActiveRegeneration" }, "Value": { "type": "number", "description": "This value is deprecated and may be removed in future versions. Please use AfterTreatmentDieselParticulateFilterTimeSinceLastActiveRegeneration value instead.", "title": "Value" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "AfterTreatmentScrOperatorInducementSeverityExtended": { "type": "object", "properties": { "AfterTreatmentScrOperatorInducementSeverity": { "type": "string", "title": "AfterTreatmentScrOperatorInducementSeverity" }, "Value": { "type": "string", "description": "This value is deprecated and may be removed in future versions. Please use AfterTreatmentScrOperatorInducementSeverity value instead.", "title": "Value" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "AngleExtended": { "type": "object", "properties": { "Angle": { "type": "number", "title": "Angle" }, "Value": { "type": "number", "description": "This value is deprecated and may be removed in future versions. Please use Angle value instead.", "title": "Value" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "BatteryChargerOutputCurrentExtended": { "type": "object", "properties": { "BatteryChargerOutputCurrent": { "type": "number", "title": "BatteryChargerOutputCurrent" }, "Value": { "type": "number", "description": "This value is deprecated and may be removed in future versions. Please use BatteryChargerOutputCurrent value instead.", "title": "Value" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "BatteryChargerOutputVoltageExtended": { "type": "object", "properties": { "BatteryChargerOutputVoltage": { "type": "number", "title": "BatteryChargerOutputVoltage" }, "Value": { "type": "number", "description": "This value is deprecated and may be removed in future versions. Please use BatteryChargerOutputVoltage value instead.", "title": "Value" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "BatteryPotentialExtended": { "type": "object", "properties": { "BatteryPotential": { "type": "number", "title": "BatteryPotential" }, "Value": { "type": "number", "description": "This value is deprecated and may be removed in future versions. Please use BatteryPotential value instead.", "title": "Value" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "CO2EmissionsExtended": { "type": "object", "properties": { "Emissions": { "type": "number", "title": "Emissions" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "ConcentrationExtended": { "type": "object", "properties": { "Concentration": { "type": "number", "title": "Concentration" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "CountExtended": { "type": "object", "properties": { "Count": { "type": "number", "title": "Count" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "CumulativeActiveRegenerationHours": { "type": "object", "description": "The current lifetime total non-productive regeneration hours of the machine are expressed by two fields: Date and time (DateTime) and Cumulative regeneration hours (Hour). Non-productive regeneration is the time when the machine is placed in a non-productive state to complete the regeneration process. This field is specific to machines with emissions related after- treatment devices mounted on the machine’s engine. Regeneration is the oxidation of exhaust soot collected inside an after-treatment device.", "properties": { "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } }, "Hour": { "type": "number", "description": "The value is expressed as a decimal eight digits in length with two digits to the right of the decimal point.", "title": "Hour" } }, "required": ["Hour"] }, "CumulativeHoursExtended": { "type": "object", "properties": { "Hour": { "type": "number", "title": "Hour" }, "Value": { "type": "number", "description": "This value is deprecated and may be removed in future versions. Please use Hour value instead.", "title": "Value" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "CumulativeIdleHours": { "type": "object", "description": "Cumulative idle non-operating hours are the total hours when the engine is running, but the machine is not moving and the machine controls are not operated (e.g. lever or pedal not operated). Cumulative idle non-operating hours are expressed by two fields: Date and time (DateTime) and Cumulative non-productive idle hours (Hour).", "properties": { "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } }, "Hour": { "type": "number", "description": "The value is expressed as a decimal eight digits in length with two digits to the right of the decimal point.", "title": "Hour" } }, "required": ["Hour"] }, "CumulativeOperatingHours": { "type": "object", "description": "The current lifetime total cumulative operating hours of the machine is expressed by two separate.", "properties": { "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } }, "Hour": { "type": "number", "description": "The current total lifetime operating hours of the machine is expressed as the cumulative quantity of time during which the machine’s engine has been running. This is generally the value of the hourmeter on the machine.", "title": "Hour" } }, "required": ["Hour"] }, "CumulativePowerTakeOffHours": { "type": "object", "description": "Current lifetime total power take-off hours of the machine is expressed by two fields: Date and time (DateTime) and Cumulative power take-off hours (Hour)", "properties": { "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } }, "Hour": { "type": "number", "description": "The value is expressed as a decimal eight digits in length with two digits to the right of the decimal point.", "title": "Hour" } }, "required": ["Hour"] }, "CurrentExtended": { "type": "object", "properties": { "Current": { "type": "number", "title": "Current" }, "Value": { "type": "number", "description": "This value is deprecated and may be removed in future versions. Please use Current value instead.", "title": "Value" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "DEFRemaining": { "type": "object", "description": "The percentage of DEF remaining in the DEF tank of the machine is expressed by four fields: Date and time (DateTime), DEF remaining ratio (Percent), Unit of measure of DEF tank (DEFTankCapacityUnits) and DEF Tank capacity (DEFTankCapacity)", "properties": { "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } }, "Percent": { "type": "number", "description": "This field indicates the estimated percentage of DEF remaining in the machine’s DEF tank as of the specified date and time. Its data type is decimal with a maximum of 3 digits to the left of the decimal and with 2 digits to the right of the decimal. It includes all values from 0.00 to 100.00.", "maximum": 100.0, "minimum": 0.0, "title": "Percent" }, "DEFTankCapacityUnits": { "type": "string", "description": "DEF tank capacity shall be expressed in litres. If DEF tank capacity is included in the response, this field shall have the value “litre”.", "enum": ["litre"], "title": "DEFTankCapacityUnits" }, "DEFTankCapacity": { "type": "number", "description": "This field indicates the capacity of the DEF tank. The value is expressed as a decimal with up to 2 digits to the right of the decimal.", "title": "DEFTankCapacity" } }, "required": ["Percent"] }, "DetailedStateExtended": { "type": "object", "properties": { "Value": { "type": "number", "title": "Value" }, "Name": { "type": "string", "title": "Name" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "DieselParticulateFilterActiveRegenerationInhibitedDuetoInhibitSwitchExtended": { "type": "object", "properties": { "DieselParticulateFilterActiveRegenerationInhibitedDuetoInhibitSwitch": { "type": "string", "title": "DieselParticulateFilterActiveRegenerationInhibitedDuetoInhibitSwitch" }, "Value": { "type": "string", "description": "This value is deprecated and may be removed in future versions. Please use DieselParticulateFilterActiveRegenerationInhibitedDuetoInhibitSwitch value instead.", "title": "Value" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "Distance": { "type": "object", "description": "The distance the machine has travelled (regardless of direction) while operating is expressed by three fields: Date and time (DateTime), Unit of measure of distance (OdometerUnits) and Cumulative distance travelled (Odometer). Cumulative distance travelled is the total distance travelled by the machine, under its own power, since its manufacture.", "properties": { "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } }, "OdometerUnits": { "type": "string", "description": "The distance travelled by the machine shall be expressed in kilometres. If cumulative distance travelled is included in the response, this field will have the value “kilometre”.", "enum": ["kilometre"], "title": "OdometerUnits" }, "Odometer": { "type": "number", "description": "The cumulative distance the machine has travelled as of the specified date and time. The value shall contain one significant digit to the right of the decimal with the smallest unit of resolution equal to 0.1 km.", "title": "Odometer" } }, "required": ["Odometer", "OdometerUnits"] }, "DurationExtended": { "type": "object", "properties": { "Second": { "type": "number", "title": "Second" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "ElectricEnergyExtended": { "type": "object", "properties": { "ElectricEnergy": { "type": "number", "title": "ElectricEnergy" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "EngineFuelRateExtended": { "type": "object", "properties": { "EngineFuelRate": { "type": "number", "title": "EngineFuelRate" }, "Value": { "type": "number", "description": "This value is deprecated and may be removed in future versions. Please use EngineFuelRate value instead.", "title": "Value" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "EngineStatus": { "type": "object", "description": "This value is an indicator of the current status of the machine’s engine running state, which is expressed by three fields: Date and time (DateTime), Engine number (EngineNumber), and Engine running (Running).", "properties": { "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } }, "EngineNumber": { "type": "string", "description": "The engine number is an unbounded alphanumeric string assigned by the OEM representing the unique engine in the construction machine.", "title": "EngineNumber" }, "Running": { "type": "boolean", "description": "Engine condition is the running state of the engine as of the specified date and time. This data type is Boolean with false (i.e. 0) indicating not running and true (i.e. 1) indicating running. The intent of this data element is to supply a record of changes from engine running on to engine not running and from engine not running to engine running.", "title": "Running" } }, "required": ["EngineNumber", "Running"] }, "EngineTripFuelExtended": { "type": "object", "properties": { "EngineTripFuel": { "type": "number", "title": "EngineTripFuel" }, "Value": { "type": "number", "description": "This value is deprecated and may be removed in future versions. Please use BatteryChargerOutputCurrent value instead.", "title": "Value" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "Equipment": { "type": "object", "description": "Collection of single machine AEMP data points", "properties": { "RentalData": { "$ref": "#/components/schemas/RentalData", "description": "Rental data information for this asset including rental status and active contract details.", "title": "RentalData" }, "EngineFuelRate": { "$ref": "#/components/schemas/EngineFuelRateExtended", "title": "EngineFuelRate" }, "EngineSpeed": { "$ref": "#/components/schemas/SpeedExtended", "title": "EngineSpeed" }, "EngineOilPressure": { "$ref": "#/components/schemas/PressureExtended", "title": "EngineOilPressure" }, "EngineOilTemperature": { "$ref": "#/components/schemas/TemperatureExtended", "title": "EngineOilTemperature" }, "EngineCoolantTemperature": { "$ref": "#/components/schemas/TemperatureExtended", "title": "EngineCoolantTemperature" }, "EngineCoolantLevel": { "$ref": "#/components/schemas/LevelExtended", "title": "EngineCoolantLevel" }, "EngineExhaustTemperature": { "$ref": "#/components/schemas/TemperatureExtended", "title": "EngineExhaustTemperature" }, "WaterInFuelIndicator": { "$ref": "#/components/schemas/WaterInFuelIndicatorExtended", "title": "WaterInFuelIndicator" }, "HydraulicTemperature": { "$ref": "#/components/schemas/TemperatureExtended", "title": "HydraulicTemperature" }, "HydraulicOilLevel": { "$ref": "#/components/schemas/LevelExtended", "title": "HydraulicOilLevel" }, "BatteryPotential": { "$ref": "#/components/schemas/BatteryPotentialExtended", "title": "BatteryPotential" }, "SeatBeltSwitch": { "$ref": "#/components/schemas/SeatBeltSwitchExtended", "title": "SeatBeltSwitch" }, "EnginePercentLoadAtCurrentSpeed": { "$ref": "#/components/schemas/PercentageExtended", "title": "EnginePercentLoadAtCurrentSpeed" }, "ActualEnginePercentTorque": { "$ref": "#/components/schemas/PercentageExtended", "title": "ActualEnginePercentTorque" }, "PitchAngle": { "$ref": "#/components/schemas/AngleExtended", "title": "PitchAngle" }, "RollAngle": { "$ref": "#/components/schemas/AngleExtended", "title": "RollAngle" }, "AfterTreatmentDieselParticulateFilterSootLoadPercent": { "$ref": "#/components/schemas/PercentageExtended", "title": "AfterTreatmentDieselParticulateFilterSootLoadPercent" }, "AfterTreatmentDieselParticulateFilterAshLoadPercent": { "$ref": "#/components/schemas/PercentageExtended", "title": "AfterTreatmentDieselParticulateFilterAshLoadPercent" }, "AfterTreatmentDieselParticulateFilterTimeSinceLastActiveRegeneration": { "$ref": "#/components/schemas/AfterTreatmentDieselParticulateFilterTimeSinceLastActiveRegenerationExtended", "title": "AfterTreatmentDieselParticulateFilterTimeSinceLastActiveRegeneration" }, "AfterTreatmentDieselParticulateFilterPassiveRegenerationStatus": { "$ref": "#/components/schemas/StatusExtended", "title": "AfterTreatmentDieselParticulateFilterPassiveRegenerationStatus" }, "AfterTreatmentDieselParticulateFilterStatus": { "$ref": "#/components/schemas/StatusExtended", "title": "AfterTreatmentDieselParticulateFilterStatus" }, "AfterTreatmentDieselParticulateFilterActiveRegenerationStatus": { "$ref": "#/components/schemas/StatusExtended", "title": "AfterTreatmentDieselParticulateFilterActiveRegenerationStatus" }, "AfterTreatmentDieselExhaustFluidTankTemperature": { "$ref": "#/components/schemas/TemperatureExtended", "title": "AfterTreatmentDieselExhaustFluidTankTemperature" }, "AfterTreatmentScrOperatorInducementSeverity": { "$ref": "#/components/schemas/AfterTreatmentScrOperatorInducementSeverityExtended", "title": "AfterTreatmentScrOperatorInducementSeverity" }, "AfterTreatmentDieselExhaustFluidConcentration": { "$ref": "#/components/schemas/AfterTreatmentDieselExhaustFluidConcentrationExtended", "title": "AfterTreatmentDieselExhaustFluidConcentration" }, "DieselParticulateFilterActiveRegenerationInhibitedDueToInhibitSwitch": { "$ref": "#/components/schemas/DieselParticulateFilterActiveRegenerationInhibitedDuetoInhibitSwitchExtended", "title": "DieselParticulateFilterActiveRegenerationInhibitedDueToInhibitSwitch" }, "PayloadPercentage": { "$ref": "#/components/schemas/PercentageExtended", "title": "PayloadPercentage" }, "GeneratorTotalKwHoursExport": { "$ref": "#/components/schemas/GeneratorTotalkWHoursExportExtended", "title": "GeneratorTotalKwHoursExport" }, "HydraulicOilFilterRestrictionSwitch": { "$ref": "#/components/schemas/HydraulicOilFilterRestrictionSwitchExtended", "title": "HydraulicOilFilterRestrictionSwitch" }, "ServiceComponentIdentification": { "$ref": "#/components/schemas/ServiceComponentIdentificationExtended", "title": "ServiceComponentIdentification" }, "EngineFuelDeliveryPressure": { "$ref": "#/components/schemas/PressureExtended", "title": "EngineFuelDeliveryPressure" }, "EngineCoolantPressure": { "$ref": "#/components/schemas/PressureExtended", "title": "EngineCoolantPressure" }, "WheelBasedVehicleSpeed": { "$ref": "#/components/schemas/SpeedExtended", "title": "WheelBasedVehicleSpeed" }, "BarometricPressure": { "$ref": "#/components/schemas/PressureExtended", "title": "BarometricPressure" }, "AmbientAirTemperature": { "$ref": "#/components/schemas/TemperatureExtended", "title": "AmbientAirTemperature" }, "EngineIntakeAirTemperature": { "$ref": "#/components/schemas/TemperatureExtended", "title": "EngineIntakeAirTemperature" }, "RoadSurfaceTemperature": { "$ref": "#/components/schemas/TemperatureExtended", "title": "RoadSurfaceTemperature" }, "EngineIntakeManifoldTemperature": { "$ref": "#/components/schemas/TemperatureExtended", "title": "EngineIntakeManifoldTemperature" }, "EngineAirFilterDifferentialPressure": { "$ref": "#/components/schemas/PressureExtended", "title": "EngineAirFilterDifferentialPressure" }, "BatteryChargerState": { "$ref": "#/components/schemas/StateExtended", "title": "BatteryChargerState" }, "BatteryChargerPowerLineState": { "$ref": "#/components/schemas/StateExtended", "title": "BatteryChargerPowerLineState" }, "BatteryChargerOutputVoltage": { "$ref": "#/components/schemas/BatteryChargerOutputVoltageExtended", "title": "BatteryChargerOutputVoltage" }, "BatteryChargerOutputCurrent": { "$ref": "#/components/schemas/BatteryChargerOutputCurrentExtended", "title": "BatteryChargerOutputCurrent" }, "EngineTripFuel": { "$ref": "#/components/schemas/EngineTripFuelExtended", "title": "EngineTripFuel" }, "AfterTreatmentDieselParticulateFilterDifferentialPressure": { "$ref": "#/components/schemas/PressureExtended", "title": "AfterTreatmentDieselParticulateFilterDifferentialPressure" }, "AfterTreatmentDieselParticulateFilterIntakeTemperature": { "$ref": "#/components/schemas/TemperatureExtended", "title": "AfterTreatmentDieselParticulateFilterIntakeTemperature" }, "AfterTreatmentExhaustTemperature": { "$ref": "#/components/schemas/TemperatureExtended", "title": "AfterTreatmentExhaustTemperature" }, "AmberWarningLamp": { "$ref": "#/components/schemas/StateExtended", "title": "AmberWarningLamp" }, "DieselParticulateFilterLampCommand": { "$ref": "#/components/schemas/StateExtended", "title": "DieselParticulateFilterLampCommand" }, "EngineFuelTemperature": { "$ref": "#/components/schemas/TemperatureExtended", "title": "EngineFuelTemperature" }, "EngineIntakeAirPressure": { "$ref": "#/components/schemas/PressureExtended", "title": "EngineIntakeAirPressure" }, "EngineIntakeManifoldPressure": { "$ref": "#/components/schemas/PressureExtended", "title": "EngineIntakeManifoldPressure" }, "EngineIntercoolerTemperature": { "$ref": "#/components/schemas/TemperatureExtended", "title": "EngineIntercoolerTemperature" }, "EngineOilLevel": { "$ref": "#/components/schemas/PercentageExtended", "title": "EngineOilLevel" }, "EngineTotalIdleFuelUsed": { "$ref": "#/components/schemas/FuelUsedExtended", "title": "EngineTotalIdleFuelUsed" }, "ExhaustSystemHighTemperatureLampCommand": { "$ref": "#/components/schemas/StateExtended", "title": "ExhaustSystemHighTemperatureLampCommand" }, "HydraulicPressure": { "$ref": "#/components/schemas/PressureExtended", "title": "HydraulicPressure" }, "MalfunctionIndicatorLamp": { "$ref": "#/components/schemas/StateExtended", "title": "MalfunctionIndicatorLamp" }, "ProtectLamp": { "$ref": "#/components/schemas/StateExtended", "title": "ProtectLamp" }, "RedStopLamp": { "$ref": "#/components/schemas/StateExtended", "title": "RedStopLamp" }, "TransmissionOilTemperature": { "$ref": "#/components/schemas/TemperatureExtended", "title": "TransmissionOilTemperature" }, "CumulativeProductiveHours": { "$ref": "#/components/schemas/CumulativeHoursExtended", "title": "CumulativeProductiveHours" }, "CumulativeMovingHours": { "$ref": "#/components/schemas/CumulativeHoursExtended", "title": "CumulativeMovingHours" }, "Speed": { "$ref": "#/components/schemas/SpeedExtended", "title": "Speed" }, "OperationStatus": { "$ref": "#/components/schemas/StatusExtended", "title": "OperationStatus" }, "CumulativeEngineHours": { "$ref": "#/components/schemas/CumulativeHoursExtended", "title": "CumulativeEngineHours" }, "PlatformHeightPercent": { "$ref": "#/components/schemas/PercentageExtended", "title": "PlatformHeightPercent" }, "PlatformHeight": { "$ref": "#/components/schemas/LengthExtended", "title": "PlatformHeight" }, "PlatformElevated": { "$ref": "#/components/schemas/StatusExtended", "title": "PlatformElevated" }, "Payload": { "$ref": "#/components/schemas/PayloadTotalsExtended", "title": "Payload" }, "BatteryStateOfChargePercent": { "$ref": "#/components/schemas/PercentageExtended", "title": "BatteryStateOfChargePercent" }, "BatteryCurrent": { "$ref": "#/components/schemas/CurrentExtended", "title": "BatteryCurrent" }, "BatteryTemperature": { "$ref": "#/components/schemas/TemperatureExtended", "title": "BatteryTemperature" }, "AcPhaseL1NeutralRMSVoltage": { "$ref": "#/components/schemas/VoltageExtended", "title": "AcPhaseL1NeutralRMSVoltage" }, "AcPhaseL2NeutralRMSVoltage": { "$ref": "#/components/schemas/VoltageExtended", "title": "AcPhaseL2NeutralRMSVoltage" }, "AcPhaseL3NeutralRMSVoltage": { "$ref": "#/components/schemas/VoltageExtended", "title": "AcPhaseL3NeutralRMSVoltage" }, "AcPhaseL1Frequency": { "$ref": "#/components/schemas/FrequencyExtended", "title": "AcPhaseL1Frequency" }, "AcPhaseL2Frequency": { "$ref": "#/components/schemas/FrequencyExtended", "title": "AcPhaseL2Frequency" }, "AcPhaseL3Frequency": { "$ref": "#/components/schemas/FrequencyExtended", "title": "AcPhaseL3Frequency" }, "AcPhaseL1RMSCurrent": { "$ref": "#/components/schemas/CurrentExtended", "title": "AcPhaseL1RMSCurrent" }, "AcPhaseL2RMSCurrent": { "$ref": "#/components/schemas/CurrentExtended", "title": "AcPhaseL2RMSCurrent" }, "AcPhaseL3RMSCurrent": { "$ref": "#/components/schemas/CurrentExtended", "title": "AcPhaseL3RMSCurrent" }, "AcPhaseL1L2RMSVoltage": { "$ref": "#/components/schemas/VoltageExtended", "title": "AcPhaseL1L2RMSVoltage" }, "AcPhaseL2L3RMSVoltage": { "$ref": "#/components/schemas/VoltageExtended", "title": "AcPhaseL2L3RMSVoltage" }, "AcPhaseL3L1RMSVoltage": { "$ref": "#/components/schemas/VoltageExtended", "title": "AcPhaseL3L1RMSVoltage" }, "AcTotalActivePower": { "$ref": "#/components/schemas/PowerExtended", "title": "AcTotalActivePower" }, "AcPhaseL1ActivePower": { "$ref": "#/components/schemas/PowerExtended", "title": "AcPhaseL1ActivePower" }, "AcPhaseL2ActivePower": { "$ref": "#/components/schemas/PowerExtended", "title": "AcPhaseL2ActivePower" }, "AcPhaseL3ActivePower": { "$ref": "#/components/schemas/PowerExtended", "title": "AcPhaseL3ActivePower" }, "AcTotalApparentPower": { "$ref": "#/components/schemas/PowerExtended", "title": "AcTotalApparentPower" }, "AcTotalPowerFactor": { "$ref": "#/components/schemas/FactorExtended", "title": "AcTotalPowerFactor" }, "AcTotalReactivePower": { "$ref": "#/components/schemas/PowerExtended", "title": "AcTotalReactivePower" }, "PayloadTemperature": { "$ref": "#/components/schemas/TemperatureExtended", "title": "PayloadTemperature" }, "AcTotalRelativeActivePowerLoadPercentage": { "$ref": "#/components/schemas/PercentageExtended", "title": "AcTotalRelativeActivePowerLoadPercentage" }, "AcTotalRelativeApparentPowerLoadPercentage": { "$ref": "#/components/schemas/PercentageExtended", "title": "AcTotalRelativeApparentPowerLoadPercentage" }, "AcTotalRelativeLoadPercentage": { "$ref": "#/components/schemas/PercentageExtended", "title": "AcTotalRelativeLoadPercentage" }, "AcAveragePhaseToNeutralRmsVoltage": { "$ref": "#/components/schemas/VoltageExtended", "title": "AcAveragePhaseToNeutralRmsVoltage" }, "AcAveragePhaseToPhaseRmsVoltage": { "$ref": "#/components/schemas/VoltageExtended", "title": "AcAveragePhaseToPhaseRmsVoltage" }, "AcAverageRmsCurrent": { "$ref": "#/components/schemas/CurrentExtended", "title": "AcAverageRmsCurrent" }, "Accelerometer_X_Axis": { "$ref": "#/components/schemas/GForceExtended", "title": "Accelerometer_X_Axis" }, "Accelerometer_Y_Axis": { "$ref": "#/components/schemas/GForceExtended", "title": "Accelerometer_Y_Axis" }, "Accelerometer_Z_Axis": { "$ref": "#/components/schemas/GForceExtended", "title": "Accelerometer_Z_Axis" }, "Impact": { "$ref": "#/components/schemas/GForceExtended", "title": "Impact" }, "AftertreatmentDieselParticulateFilterTimeToNextActiveRegeneration": { "$ref": "#/components/schemas/DurationExtended", "title": "AftertreatmentDieselParticulateFilterTimeToNextActiveRegeneration" }, "AftertreatmentSCRTimeSinceLastCleaningEvent": { "$ref": "#/components/schemas/DurationExtended", "title": "AftertreatmentSCRTimeSinceLastCleaningEvent" }, "EngineFuelFilterDifferentialPressure": { "$ref": "#/components/schemas/PressureExtended", "title": "EngineFuelFilterDifferentialPressure" }, "EngineOilFilterDifferentialPressure": { "$ref": "#/components/schemas/PressureExtended", "title": "EngineOilFilterDifferentialPressure" }, "AcAverageFrequency": { "$ref": "#/components/schemas/FrequencyExtended", "title": "AcAverageFrequency" }, "StabilizersDeployed": { "$ref": "#/components/schemas/StatusExtended", "title": "StabilizersDeployed" }, "PlatformStowed": { "$ref": "#/components/schemas/StatusExtended", "title": "PlatformStowed" }, "RescueModeActive": { "$ref": "#/components/schemas/StatusExtended", "title": "RescueModeActive" }, "BatteryStateOfHealthPercent": { "$ref": "#/components/schemas/PercentageExtended", "title": "BatteryStateOfHealthPercent" }, "BatteryRemainingRunTime": { "$ref": "#/components/schemas/DurationExtended", "title": "BatteryRemainingRunTime" }, "BatteryChargeCyclesCount": { "$ref": "#/components/schemas/CountExtended", "title": "BatteryChargeCyclesCount" }, "BatteryCumulativeDischargedEnergy": { "$ref": "#/components/schemas/ElectricEnergyExtended", "title": "BatteryCumulativeDischargedEnergy" }, "BatteryRemainingChargeTime": { "$ref": "#/components/schemas/DurationExtended", "title": "BatteryRemainingChargeTime" }, "BatteryChargerInputVoltage": { "$ref": "#/components/schemas/VoltageExtended", "title": "BatteryChargerInputVoltage" }, "BatteryChargerInputCurrent": { "$ref": "#/components/schemas/CurrentExtended", "title": "BatteryChargerInputCurrent" }, "BatteryChargerOutputCurrentLimit": { "$ref": "#/components/schemas/CurrentExtended", "title": "BatteryChargerOutputCurrentLimit" }, "BatteryChargerInputCurrentLimit": { "$ref": "#/components/schemas/CurrentExtended", "title": "BatteryChargerInputCurrentLimit" }, "CumulativeCO2Emissions": { "$ref": "#/components/schemas/CO2EmissionsExtended", "title": "CumulativeCO2Emissions" }, "AfterTreatmentDieselParticulateFilterActiveRegenerationState": { "$ref": "#/components/schemas/DetailedStateExtended", "title": "AfterTreatmentDieselParticulateFilterActiveRegenerationState" }, "AfterTreatmentDieselParticulateFilterState": { "$ref": "#/components/schemas/DetailedStateExtended", "title": "AfterTreatmentDieselParticulateFilterState" }, "CumulativeUtilizationHours": { "$ref": "#/components/schemas/CumulativeHoursExtended", "description": "The cumulative utilization hours of the asset. The utilization hours represent the total time a machine has been actively utilized based on a more precise definition of machine usage. CumulativeUtilizationHours is tailored to specific machine types and is defined in collaboration with manufacturers to reflect the work performed. Please note: The utilization graph on Manager's asset home page does not display CumulativeUtilizationHours.", "title": "CumulativeUtilizationHours" }, "WindSpeed": { "$ref": "#/components/schemas/SpeedExtended", "title": "WindSpeed" }, "WindDirection": { "$ref": "#/components/schemas/AngleExtended", "title": "WindDirection" }, "ParticleVelocity": { "$ref": "#/components/schemas/SpeedExtended", "title": "ParticleVelocity" }, "ParticulateMatter25": { "$ref": "#/components/schemas/ConcentrationExtended", "title": "ParticulateMatter25" }, "ParticulateMatter10": { "$ref": "#/components/schemas/ConcentrationExtended", "title": "ParticulateMatter10" }, "BatteryChargerCumulativeInputEnergy": { "$ref": "#/components/schemas/ElectricEnergyExtended", "title": "BatteryChargerCumulativeInputEnergy" }, "Metadata": { "$ref": "#/components/schemas/Metadata", "description": "Equipment metadata containing equipment related IDs used to system integration and reverse system lookup.", "title": "Metadata" }, "EquipmentHeader": { "$ref": "#/components/schemas/EquipmentHeader", "description": "Header information (EquipmentHeader) consists of Telematics Unit Installation Date (UnitInstallDateTime), Equipment Make (OEMName), Equipment Model (Model), Equipment ID (EquipmentID), Serial Number (SerialNumber) and OEM ISO Number (PIN). NOTE PIN and VIN are both 17-character fields. Either one is acceptable depending upon the classification of the specific machine. PIN is the name used in to represent both.", "title": "EquipmentHeader" }, "AverageLoadFactorLast24": { "$ref": "#/components/schemas/LoadFactor", "description": "The preferred definition of average daily load factor is a percentage calculated as the actual fuel consumed over the previous 24 h period divided by the fuel that would have been consumed during that period if the machine had been continually operated at the engine’s rated output. Average daily load factor of the machine is expressed by two fields as shown: Date and time (DateTime) and Average daily load factor (Percent)", "title": "AverageLoadFactorLast24" }, "Location": { "$ref": "#/components/schemas/Location", "description": "The last known equipment location is expressed by the following fields: Date and time (DateTime), Latitude of location (Latitude), Longitude of location (Longitude), Altitude of location (Altitude) and Units of Altitude (AltitudeUnits). If only Altitude is known, Latitude and Longitude will both be 0.", "title": "Location" }, "CumulativeActiveRegenerationHours": { "$ref": "#/components/schemas/CumulativeActiveRegenerationHours", "description": "The current lifetime total non-productive regeneration hours of the machine are expressed by two fields: Date and time (DateTime) and Cumulative regeneration hours (Hour). Non-productive regeneration is the time when the machine is placed in a non-productive state to complete the regeneration process. This field is specific to machines with emissions related after- treatment devices mounted on the machine’s engine. Regeneration is the oxidation of exhaust soot collected inside an after-treatment device.", "title": "CumulativeActiveRegenerationHours" }, "CumulativeIdleHours": { "$ref": "#/components/schemas/CumulativeIdleHours", "description": "Cumulative idle non-operating hours are the total hours when the engine is running, but the machine is not moving and the machine controls are not operated (e.g. lever or pedal not operated). Cumulative idle non-operating hours are expressed by two fields: Date and time (DateTime) and Cumulative non-productive idle hours (Hour).", "title": "CumulativeIdleHours" }, "CumulativeIdleNonOperatingHours": { "$ref": "#/components/schemas/CumulativeIdleHours", "description": "Cumulative idle non-operating hours are the total hours when the engine is running, but the machine is not moving and the machine controls are not operated (e.g. lever or pedal not operated). Cumulative idle non-operating hours are expressed by two fields: Date and time (DateTime) and Cumulative non-productive idle hours (Hour).", "title": "CumulativeIdleNonOperatingHours" }, "CumulativeLoadCount": { "$ref": "#/components/schemas/LoadCount", "description": "Lifetime total cumulative number of loads the machine has achieved is expressed by two fields: Date and time (DateTime) and Cumulative load count (Count). The definitions of load and load count are at the discretion of the manufacturer.", "title": "CumulativeLoadCount" }, "CumulativeOperatingHours": { "$ref": "#/components/schemas/CumulativeOperatingHours", "description": "The current lifetime total cumulative operating hours of the machine is expressed by two separate.", "title": "CumulativeOperatingHours" }, "CumulativePowerTakeOffHours": { "$ref": "#/components/schemas/CumulativePowerTakeOffHours", "description": "Current lifetime total power take-off hours of the machine is expressed by two fields: Date and time (DateTime) and Cumulative power take-off hours (Hour)", "title": "CumulativePowerTakeOffHours" }, "CumulativePayloadTotals": { "$ref": "#/components/schemas/PayloadTotals", "description": "Cumulative total payload moved by the machine is expressed by two fields: Date and time (DateTime), Unit of measure for payload (PayloadUnits) and Cumulative payload (Payload)", "title": "CumulativePayloadTotals" }, "DEFRemaining": { "$ref": "#/components/schemas/DEFRemaining", "description": "The percentage of DEF remaining in the DEF tank of the machine is expressed by four fields: Date and time (DateTime), DEF remaining ratio (Percent), Unit of measure of DEF tank (DEFTankCapacityUnits) and DEF Tank capacity (DEFTankCapacity)", "title": "DEFRemaining" }, "Distance": { "$ref": "#/components/schemas/Distance", "description": "The distance the machine has travelled (regardless of direction) while operating is expressed by three fields: Date and time (DateTime), Unit of measure of distance (OdometerUnits) and Cumulative distance travelled (Odometer). Cumulative distance travelled is the total distance travelled by the machine, under its own power, since its manufacture.", "title": "Distance" }, "EngineStatus": { "$ref": "#/components/schemas/EngineStatus", "description": "This value is an indicator of the current status of the machine’s engine running state, which is expressed by three fields: Date and time (DateTime), Engine number (EngineNumber), and Engine running (Running).", "title": "EngineStatus" }, "FuelUsed": { "$ref": "#/components/schemas/FuelUsed", "description": "The total amount of fuel consumed by the machine is expressed by three separate fields: Date and time (DateTime), Unit of measure of fuel (FuelUnits) and Cumulative fuel used (FuelConsumed). This data element represents the cumulative amount of fuel used by the machine since its manufacture.", "title": "FuelUsed" }, "FuelUsedLast24": { "$ref": "#/components/schemas/FuelUsed", "description": "The quantity of fuel the machine used during the previous 24 h period is expressed by three fields: Date and time (DateTime), Unit of measure of fuel (FuelUnits) and Fuel used in preceding 24 hours (FuelConsumed).", "title": "FuelUsedLast24" }, "FuelRemaining": { "$ref": "#/components/schemas/FuelRemaining", "description": "The percentage of fuel remaining in the fuel tank of the machine is expressed by four fields: Date and time (DateTime), Fuel remaining ratio (Percent), Unit of measure of fuel tank (FuelTankCapacityUnits) and Fuel tank capacity (FuelTankCapacity).", "title": "FuelRemaining" }, "MaximumSpeedLast24": { "$ref": "#/components/schemas/Speed", "description": "Peak daily speed is the highest achieved travel speed for this machine during the previous 24 h period. Peak daily speed is expressed by three fields: Date and time (DateTime), Unit used for speed (SpeedUnit) and Peak speed (Speed).", "title": "MaximumSpeedLast24" } }, "required": ["EquipmentHeader"], "title": "Equipment" }, "EquipmentHeader": { "type": "object", "description": "Header information (EquipmentHeader) consists of Telematics Unit Installation Date (UnitInstallDateTime), Equipment Make (OEMName), Equipment Model (Model), Equipment ID (EquipmentID), Serial Number (SerialNumber) and OEM ISO Number (PIN). NOTE PIN and VIN are both 17-character fields. Either one is acceptable depending upon the classification of the specific machine. PIN is the name used in to represent both.", "properties": { "UnitInstallDateTime": { "type": "string", "format": "date-time", "description": "Telematics unit installation date. This date and time describes when the telematics unit was installed on the machine. This field is optional, and if blank, it is assumed that the telematics unit was installed when the machine was built.", "title": "UnitInstallDateTime" }, "OEMName": { "type": "string", "description": "Equipment make. If this data element is unavailable, then it is populated with blanks. If the data element is available, then the equipment make is returned. This field is optional.", "title": "OEMName" }, "Model": { "type": "string", "description": "Equipment Model is the model or series of the machine. The data type of the equipment model is string. Its length is unbounded. If this data element is unavailable, then it is populated with blanks. If the data element is available, then the equipment model is returned. This field is optional.", "title": "Model" }, "EquipmentID": { "type": "string", "description": "Customers machine name mapped to this field. The end user shall provide this information to the telematics provider during fleet registration. Because this field is defined by the end user, it is not a unique identifier. Its data type is string, and its length is unbounded. This field is optional.", "title": "EquipmentID" }, "SerialNumber": { "type": "string", "description": "The serial number identifies the specific instance of the machine for those machines that are not identified by a PIN or a VIN. If the equipement serial number dosen't exists we map telematic seriial number to provide backward compatibility. The data type is character string and the length is unbounded. This field is optional. If a PIN or VIN is assigned to the machine, the PIN or VIN shall be used in place of the serial number.", "maxLength": 17, "minLength": 1, "title": "SerialNumber" }, "PIN": { "type": "string", "description": "OEM ISO identifier (PIN or VIN). The PIN shall be as defined by ISO 10261. PIN is used for earth-moving machinery and may be used for other types of off-road machines. The VIN shall be as defined by ISO 3779. VIN is used for on-road vehicles.", "maxLength": 17, "minLength": 1, "title": "PIN" } } }, "FactorExtended": { "type": "object", "properties": { "Factor": { "type": "number", "title": "Factor" }, "Value": { "type": "number", "description": "This value is deprecated and may be removed in future versions. Please use Factor value instead.", "title": "Value" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "Fleet": { "type": "object", "description": "Fleet represents a equipment snapshot for a single point in time. Time-series data, such as fault codes and switch status, are not included in the snapshot view.", "properties": { "Links": { "type": "array", "description": "Collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last). Each link contains a relationship (rel) and a hyperlink (href).", "items": { "$ref": "#/components/schemas/FleetLinks" }, "title": "Links" }, "Equipment": { "type": "array", "description": "Collection of single machine AEMP data points", "items": { "$ref": "#/components/schemas/Equipment" }, "title": "Equipment" }, "version": { "type": "integer", "format": "int64", "title": "version", "xml": { "attribute": true } }, "snapshotTime": { "type": "string", "format": "date-time", "title": "snapshotTime", "xml": { "attribute": true } } }, "required": ["Equipment", "Links", "version"], "xml": { "name": "Fleet", "namespace": "http://standards.iso.org/iso/15143/-3" } }, "FleetLinks": { "type": "object", "description": "Each endpoint that returns more than one piece of equipment or message shall include a set of links. These links are used to describe the metadata about the web service call. Each link shall contain a relationship (rel) and a hyperlink (href).", "properties": { "rel": { "type": "string", "description": "The reference attribute describes the link. Paginated services shall include a collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last).", "title": "rel" }, "href": { "type": "string", "description": "The hypermedia reference URL (href) is a reference to another endpoint. These references are provided so that available data is discoverable by automated systems. The reference is an absolute URL.", "title": "href" } }, "required": ["href", "rel"], "title": "Links" }, "FrequencyExtended": { "type": "object", "properties": { "Frequency": { "type": "number", "title": "Frequency" }, "Value": { "type": "number", "description": "This value is deprecated and may be removed in future versions. Please use Frequency value instead.", "title": "Value" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "FuelRemaining": { "type": "object", "description": "The percentage of fuel remaining in the fuel tank of the machine is expressed by four fields: Date and time (DateTime), Fuel remaining ratio (Percent), Unit of measure of fuel tank (FuelTankCapacityUnits) and Fuel tank capacity (FuelTankCapacity).", "properties": { "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } }, "Percent": { "type": "number", "description": "This field indicates the estimated percentage of fuel remaining in the machine’s fuel tank as of the specified date and time. Its data type is decimal with a maximum of 3 digits to the left of the decimal and with 2 digits to the right of the decimal. It includes all values from 0.00 to 100.00.", "maximum": 100.0, "minimum": 0.0, "title": "Percent" }, "FuelTankCapacityUnits": { "type": "string", "description": "Fuel tank capacity shall be expressed in litres. If fuel tank capacity is included in the response, this field shall have the value “litre”.", "enum": ["litre"], "title": "FuelTankCapacityUnits" }, "FuelTankCapacity": { "type": "integer", "format": "int64", "description": "This field indicates the capacity of the fuel tank. The value is expressed as an unsigned integer, which includes all values from 0 to 4 294 967 295.", "maximum": 4294967295, "minimum": 0, "title": "FuelTankCapacity" } }, "required": ["Percent"] }, "FuelUsed": { "type": "object", "description": "Fuel consumed by the machine is expressed by three separate fields: Date and time (DateTime), Unit of measure of fuel (FuelUnits) and Cumulative fuel used (FuelConsumed).", "properties": { "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } }, "FuelUnits": { "type": "string", "description": "The quantity of fuel is expressed in litres. If cumulative fuel used is included in the response, this field shall have the value “litre”.", "enum": ["litre"], "title": "FuelUnits" }, "FuelConsumed": { "type": "integer", "format": "int64", "description": "The value is expressed as an unsigned integer, which includes all values from 0 through 4 294 967 295.", "maximum": 4294967295, "minimum": 0, "title": "FuelConsumed" } }, "required": ["FuelConsumed", "FuelUnits"] }, "FuelUsedExtended": { "type": "object", "properties": { "FuelUnits": { "type": "string", "title": "FuelUnits" }, "FuelConsumed": { "type": "number", "title": "FuelConsumed" }, "Value": { "type": "number", "description": "This value is deprecated and may be removed in future versions. Please use FuelConsumed value instead.", "title": "Value" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "GForceExtended": { "type": "object", "properties": { "Value": { "type": "number", "description": "This value is deprecated and may be removed in future versions. Please use gAcceleration value instead.", "title": "Value" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } }, "gacceleration": { "type": "number" } } }, "GeneratorTotalkWHoursExportExtended": { "type": "object", "properties": { "GeneratorTotalkWHoursExport": { "type": "number", "title": "GeneratorTotalkWHoursExport" }, "Value": { "type": "number", "description": "This value is deprecated and may be removed in future versions. Please use GeneratorTotalkWHoursExport value instead.", "title": "Value" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "HydraulicOilFilterRestrictionSwitchExtended": { "type": "object", "properties": { "HydraulicOilFilterRestrictionSwitch": { "type": "string", "title": "HydraulicOilFilterRestrictionSwitch" }, "Value": { "type": "string", "description": "This value is deprecated and may be removed in future versions. Please use HydraulicOilFilterRestrictionSwitch value instead.", "title": "Value" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "LengthExtended": { "type": "object", "properties": { "Length": { "type": "number", "title": "Length" }, "Value": { "type": "number", "description": "This value is deprecated and may be removed in future versions. Please use Length value instead.", "title": "Value" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "LevelExtended": { "type": "object", "properties": { "Level": { "type": "number", "title": "Level" }, "Value": { "type": "number", "description": "This value is deprecated and may be removed in future versions. Please use Level value instead.", "title": "Value" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "LoadCount": { "type": "object", "description": "Lifetime total cumulative number of loads the machine has achieved is expressed by two fields: Date and time (DateTime) and Cumulative load count (Count). The definitions of load and load count are at the discretion of the manufacturer.", "properties": { "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } }, "Count": { "type": "integer", "format": "int64", "description": "The date and time indicate when the machine last registered a completed load.", "maximum": 4294967295, "minimum": 0, "title": "Count" } }, "required": ["Count"] }, "LoadFactor": { "type": "object", "description": "The preferred definition of average daily load factor is a percentage calculated as the actual fuel consumed over the previous 24 h period divided by the fuel that would have been consumed during that period if the machine had been continually operated at the engine’s rated output. Average daily load factor of the machine is expressed by two fields as shown: Date and time (DateTime) and Average daily load factor (Percent)", "properties": { "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } }, "Percent": { "type": "number", "description": "This field indicates the average load factor during a 24 h period of machine life (whether or not operating) as of the specified data and time. Its data type is decimal and includes all values from 000.00 to 100.00.", "maximum": 100.0, "minimum": 0.0, "title": "Percent" } }, "required": ["Percent"] }, "Location": { "type": "object", "description": "The last known equipment location is expressed by the following fields: Date and time (DateTime), Latitude of location (Latitude), Longitude of location (Longitude), Altitude of location (Altitude) and Units of Altitude (AltitudeUnits)", "properties": { "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } }, "Latitude": { "type": "number", "description": "The latitude is expressed as a signed decimal number with six digits of precision in the range from −90.000000° to +90.000000°. The latitude at the equator is represented by 0°. Latitudes north of the equator are represented as positive numbers; those south, by negative numbers.", "maximum": 90.0, "minimum": -90.0, "title": "Latitude" }, "Longitude": { "type": "number", "description": "The longitude is expressed as a signed decimal number with six digits of precision in the range from −180.000000° to +180.000000°. The prime meridian at Greenwich is represented by 0°. Longitudes to the west of the prime meridian are represented as negative numbers; those to the east, by positive numbers.", "maximum": 180.0, "minimum": -180.0, "title": "Longitude" }, "Altitude": { "type": "number", "description": "The altitude is expressed as distance above mean sea level of the machine’s location. Altitude is reported in metres. This field is optional. This description does not consider the geodesic model used in any GPS system. There can be a small difference between reported altitude when the value is derived from different GPS systems. This data element is the unique altitude value expressed in SI units.", "title": "Altitude" }, "AltitudeUnits": { "type": "string", "description": "The altitude of the location shall be expressed in metres. If altitude is included in the response, this field is mandatory. It shall have the value “metre”.", "enum": ["metre"], "title": "AltitudeUnits" } }, "required": ["Latitude", "Longitude"] }, "Metadata": { "type": "object", "description": "Equipment metadata containing equipment related IDs used to system integration and reverse system lookup.", "properties": { "TelematicSerialNumber": { "type": "string", "description": "IoT hardware serialnumber.", "title": "TelematicSerialNumber" }, "AssetId": { "type": "string", "description": "Unique identifier (UUID) for an asset.", "title": "AssetId" }, "MachineId": { "type": "string", "description": "Deprecated: Use AssetId instead. Unique identifier (UUID) for a machine.", "title": "MachineId" }, "UnitId": { "type": "integer", "format": "int32", "description": "Deprecated identifier, which has been replaced by MachineId. Still used to access Classic APIs.", "maximum": 2147483647, "minimum": -2147483648, "title": "UnitId" }, "ExternalReferenceNumber": { "type": "string", "description": "Reference to external systems - Reference Field in Classic.", "title": "ExternalReferenceNumber" }, "Type": { "type": "string", "description": "Type (e.g., Scissorlift, Forklift, Wheel loader, Excavator, Light tower, Generator, etc.).", "title": "Type" } }, "required": ["AssetId", "MachineId", "TelematicSerialNumber"] }, "PayloadTotals": { "type": "object", "description": "Cumulative total payload moved by the machine is expressed by two fields: Date and time (DateTime), Unit of measure for payload (PayloadUnits) and Cumulative payload (Payload)", "properties": { "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } }, "PayloadUnits": { "type": "string", "description": "The quantity of payload shall be expressed as load mass in kilograms. If cumulative payload is included in the response, this field shall have the value “kilogram”.", "enum": ["kilogram"], "title": "PayloadUnits" }, "Payload": { "type": "number", "description": "This field indicates the quantity of payload that has been moved cumulatively by the machine as of the specified date and time. Its data type is decimal.", "title": "Payload" } }, "required": ["Payload", "PayloadUnits"] }, "PayloadTotalsExtended": { "type": "object", "properties": { "PayloadUnits": { "type": "string", "title": "PayloadUnits" }, "Payload": { "type": "number", "title": "Payload" }, "Value": { "type": "number", "description": "This value is deprecated and may be removed in future versions. Please use Payload value instead.", "title": "Value" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "PercentageExtended": { "type": "object", "properties": { "Percentage": { "type": "number", "title": "Percentage" }, "Value": { "type": "number", "description": "This value is deprecated and may be removed in future versions. Please use Percentage value instead.", "title": "Value" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "PowerExtended": { "type": "object", "properties": { "Unit": { "type": "string", "title": "Unit" }, "Power": { "type": "number", "title": "Power" }, "Value": { "type": "number", "description": "This value is deprecated and may be removed in future versions. Please use Power value instead.", "title": "Value" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "PressureExtended": { "type": "object", "properties": { "Pressure": { "type": "number", "title": "Pressure" }, "Value": { "type": "number", "description": "This value is deprecated and may be removed in future versions. Please use Pressure value instead.", "title": "Value" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "RentalData": { "type": "object", "description": "Rental data information for an asset.", "properties": { "RentalStatus": { "type": "string", "description": "The current rental status of the asset (e.g., ON_RENT, OFF_RENT, AVAILABLE).", "enum": [ "ON_RENT", "PICK_UP_READY", "AVAILABLE", "RETURNED", "IN_REPAIR", "TRANSFER", "OTHER", "OFF_RENT", "NOT_ON_CONTRACT", "RESERVED" ], "title": "RentalStatus" }, "ActiveContractItem": { "type": "array", "description": "Information about when an asset is rented out to a customer.", "items": { "$ref": "#/components/schemas/ActiveContractItem" }, "title": "ActiveContractItem" } }, "required": ["RentalStatus"] }, "SeatBeltSwitchExtended": { "type": "object", "properties": { "SeatBeltSwitch": { "type": "string", "title": "SeatBeltSwitch" }, "Value": { "type": "string", "description": "This value is deprecated and may be removed in future versions. Please use SeatBeltSwitch value instead.", "title": "Value" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "ServiceComponentIdentificationExtended": { "type": "object", "properties": { "ServiceComponentIdentification": { "type": "string", "title": "ServiceComponentIdentification" }, "Value": { "type": "string", "description": "This value is deprecated and may be removed in future versions. Please use ServiceComponentIdentification value instead.", "title": "Value" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "Speed": { "type": "object", "description": "Peak daily speed is the highest achieved travel speed for this machine during the previous 24 h period. Peak daily speed is expressed by three fields: Date and time (DateTime), Unit used for speed (SpeedUnit) and Peak speed (Speed).", "properties": { "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } }, "SpeedUnits": { "type": "string", "description": "Speed is to be expressed as kilometres per hour or metres per minute. If peak daily speed is included in the response, this field shall have the value kilometres per hour, or metres per minute.", "enum": ["kilometres per hour", "metres per minute"], "title": "SpeedUnits" }, "Speed": { "type": "number", "description": "This field indicates the highest achieved travel speed by the machine during a 24 h period as of the specified date and time.", "title": "Speed" } }, "required": ["Speed", "SpeedUnits"] }, "SpeedExtended": { "type": "object", "properties": { "SpeedUnits": { "type": "string", "title": "SpeedUnits" }, "Speed": { "type": "number", "title": "Speed" }, "Value": { "type": "number", "description": "This value is deprecated and may be removed in future versions. Please use Speed value instead.", "title": "Value" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "StateExtended": { "type": "object", "properties": { "State": { "type": "string", "title": "State" }, "Value": { "type": "string", "description": "This value is deprecated and may be removed in future versions. Please use State value instead.", "title": "Value" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "StatusExtended": { "type": "object", "properties": { "Status": { "type": "string", "title": "Status" }, "Value": { "type": "string", "description": "This value is deprecated and may be removed in future versions. Please use Status value instead.", "title": "Value" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "TemperatureExtended": { "type": "object", "properties": { "Temperature": { "type": "number", "title": "Temperature" }, "Value": { "type": "number", "description": "This value is deprecated and may be removed in future versions. Please use Temperature value instead.", "title": "Value" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "VoltageExtended": { "type": "object", "properties": { "Voltage": { "type": "number", "title": "Voltage" }, "Value": { "type": "number", "description": "This value is deprecated and may be removed in future versions. Please use Voltage value instead.", "title": "Value" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "WaterInFuelIndicatorExtended": { "type": "object", "properties": { "WaterInFuelIndicator": { "type": "string", "title": "WaterInFuelIndicator" }, "Value": { "type": "string", "description": "This value is deprecated and may be removed in future versions. Please use WaterInFuelIndicator value instead.", "title": "Value" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } } }, "MachineInsightTimeseries": { "type": "object", "description": "Machine Insights", "properties": { "Links": { "type": "array", "description": "Collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last). Each link contains a relationship (rel) and a hyperlink (href).", "items": { "$ref": "#/components/schemas/FleetLinks" }, "title": "Links" }, "EngineFuelRate": { "type": "array", "items": { "$ref": "#/components/schemas/EngineFuelRateExtended" }, "title": "EngineFuelRate" }, "EngineSpeed": { "type": "array", "items": { "$ref": "#/components/schemas/SpeedExtended" }, "title": "EngineSpeed" }, "EngineOilPressure": { "type": "array", "items": { "$ref": "#/components/schemas/PressureExtended" }, "title": "EngineOilPressure" }, "EngineOilTemperature": { "type": "array", "items": { "$ref": "#/components/schemas/TemperatureExtended" }, "title": "EngineOilTemperature" }, "EngineCoolantTemperature": { "type": "array", "items": { "$ref": "#/components/schemas/TemperatureExtended" }, "title": "EngineCoolantTemperature" }, "EngineCoolantLevel": { "type": "array", "items": { "$ref": "#/components/schemas/LevelExtended" }, "title": "EngineCoolantLevel" }, "EngineExhaustTemperature": { "type": "array", "items": { "$ref": "#/components/schemas/TemperatureExtended" }, "title": "EngineExhaustTemperature" }, "WaterInFuelIndicator": { "type": "array", "items": { "$ref": "#/components/schemas/WaterInFuelIndicatorExtended" }, "title": "WaterInFuelIndicator" }, "HydraulicTemperature": { "type": "array", "items": { "$ref": "#/components/schemas/TemperatureExtended" }, "title": "HydraulicTemperature" }, "HydraulicOilLevel": { "type": "array", "items": { "$ref": "#/components/schemas/LevelExtended" }, "title": "HydraulicOilLevel" }, "BatteryPotential": { "type": "array", "items": { "$ref": "#/components/schemas/BatteryPotentialExtended" }, "title": "BatteryPotential" }, "SeatBeltSwitch": { "type": "array", "items": { "$ref": "#/components/schemas/SeatBeltSwitchExtended" }, "title": "SeatBeltSwitch" }, "EnginePercentLoadAtCurrentSpeed": { "type": "array", "items": { "$ref": "#/components/schemas/PercentageExtended" }, "title": "EnginePercentLoadAtCurrentSpeed" }, "ActualEnginePercentTorque": { "type": "array", "items": { "$ref": "#/components/schemas/PercentageExtended" }, "title": "ActualEnginePercentTorque" }, "PitchAngle": { "type": "array", "items": { "$ref": "#/components/schemas/AngleExtended" }, "title": "PitchAngle" }, "RollAngle": { "type": "array", "items": { "$ref": "#/components/schemas/AngleExtended" }, "title": "RollAngle" }, "AfterTreatmentDieselParticulateFilterSootLoadPercent": { "type": "array", "items": { "$ref": "#/components/schemas/PercentageExtended" }, "title": "AfterTreatmentDieselParticulateFilterSootLoadPercent" }, "AfterTreatmentDieselParticulateFilterAshLoadPercent": { "type": "array", "items": { "$ref": "#/components/schemas/PercentageExtended" }, "title": "AfterTreatmentDieselParticulateFilterAshLoadPercent" }, "AfterTreatmentDieselParticulateFilterTimeSinceLastActiveRegeneration": { "type": "array", "items": { "$ref": "#/components/schemas/AfterTreatmentDieselParticulateFilterTimeSinceLastActiveRegenerationExtended" }, "title": "AfterTreatmentDieselParticulateFilterTimeSinceLastActiveRegeneration" }, "AfterTreatmentDieselParticulateFilterPassiveRegenerationStatus": { "type": "array", "items": { "$ref": "#/components/schemas/StatusExtended" }, "title": "AfterTreatmentDieselParticulateFilterPassiveRegenerationStatus" }, "AfterTreatmentDieselParticulateFilterStatus": { "type": "array", "items": { "$ref": "#/components/schemas/StatusExtended" }, "title": "AfterTreatmentDieselParticulateFilterStatus" }, "AfterTreatmentDieselParticulateFilterActiveRegenerationStatus": { "type": "array", "items": { "$ref": "#/components/schemas/StatusExtended" }, "title": "AfterTreatmentDieselParticulateFilterActiveRegenerationStatus" }, "AfterTreatmentDieselExhaustFluidTankTemperature": { "type": "array", "items": { "$ref": "#/components/schemas/TemperatureExtended" }, "title": "AfterTreatmentDieselExhaustFluidTankTemperature" }, "AfterTreatmentScrOperatorInducementSeverity": { "type": "array", "items": { "$ref": "#/components/schemas/AfterTreatmentScrOperatorInducementSeverityExtended" }, "title": "AfterTreatmentScrOperatorInducementSeverity" }, "AfterTreatmentDieselExhaustFluidConcentration": { "type": "array", "items": { "$ref": "#/components/schemas/AfterTreatmentDieselExhaustFluidConcentrationExtended" }, "title": "AfterTreatmentDieselExhaustFluidConcentration" }, "DieselParticulateFilterActiveRegenerationInhibitedDueToInhibitSwitch": { "type": "array", "items": { "$ref": "#/components/schemas/DieselParticulateFilterActiveRegenerationInhibitedDuetoInhibitSwitchExtended" }, "title": "DieselParticulateFilterActiveRegenerationInhibitedDueToInhibitSwitch" }, "PayloadPercentage": { "type": "array", "items": { "$ref": "#/components/schemas/PercentageExtended" }, "title": "PayloadPercentage" }, "GeneratorTotalKwHoursExport": { "type": "array", "items": { "$ref": "#/components/schemas/GeneratorTotalkWHoursExportExtended" }, "title": "GeneratorTotalKwHoursExport" }, "HydraulicOilFilterRestrictionSwitch": { "type": "array", "items": { "$ref": "#/components/schemas/HydraulicOilFilterRestrictionSwitchExtended" }, "title": "HydraulicOilFilterRestrictionSwitch" }, "ServiceComponentIdentification": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceComponentIdentificationExtended" }, "title": "ServiceComponentIdentification" }, "EngineFuelDeliveryPressure": { "type": "array", "items": { "$ref": "#/components/schemas/PressureExtended" }, "title": "EngineFuelDeliveryPressure" }, "EngineCoolantPressure": { "type": "array", "items": { "$ref": "#/components/schemas/PressureExtended" }, "title": "EngineCoolantPressure" }, "WheelBasedVehicleSpeed": { "type": "array", "items": { "$ref": "#/components/schemas/SpeedExtended" }, "title": "WheelBasedVehicleSpeed" }, "BarometricPressure": { "type": "array", "items": { "$ref": "#/components/schemas/PressureExtended" }, "title": "BarometricPressure" }, "AmbientAirTemperature": { "type": "array", "items": { "$ref": "#/components/schemas/TemperatureExtended" }, "title": "AmbientAirTemperature" }, "EngineIntakeAirTemperature": { "type": "array", "items": { "$ref": "#/components/schemas/TemperatureExtended" }, "title": "EngineIntakeAirTemperature" }, "RoadSurfaceTemperature": { "type": "array", "items": { "$ref": "#/components/schemas/TemperatureExtended" }, "title": "RoadSurfaceTemperature" }, "EngineIntakeManifoldTemperature": { "type": "array", "items": { "$ref": "#/components/schemas/TemperatureExtended" }, "title": "EngineIntakeManifoldTemperature" }, "EngineAirFilterDifferentialPressure": { "type": "array", "items": { "$ref": "#/components/schemas/PressureExtended" }, "title": "EngineAirFilterDifferentialPressure" }, "BatteryChargerState": { "type": "array", "items": { "$ref": "#/components/schemas/StateExtended" }, "title": "BatteryChargerState" }, "BatteryChargerPowerLineState": { "type": "array", "items": { "$ref": "#/components/schemas/StateExtended" }, "title": "BatteryChargerPowerLineState" }, "BatteryChargerOutputVoltage": { "type": "array", "items": { "$ref": "#/components/schemas/BatteryChargerOutputVoltageExtended" }, "title": "BatteryChargerOutputVoltage" }, "BatteryChargerOutputCurrent": { "type": "array", "items": { "$ref": "#/components/schemas/BatteryChargerOutputCurrentExtended" }, "title": "BatteryChargerOutputCurrent" }, "EngineTripFuel": { "type": "array", "items": { "$ref": "#/components/schemas/EngineTripFuelExtended" }, "title": "EngineTripFuel" }, "AfterTreatmentDieselParticulateFilterDifferentialPressure": { "type": "array", "items": { "$ref": "#/components/schemas/PressureExtended" }, "title": "AfterTreatmentDieselParticulateFilterDifferentialPressure" }, "AfterTreatmentDieselParticulateFilterIntakeTemperature": { "type": "array", "items": { "$ref": "#/components/schemas/TemperatureExtended" }, "title": "AfterTreatmentDieselParticulateFilterIntakeTemperature" }, "AfterTreatmentExhaustTemperature": { "type": "array", "items": { "$ref": "#/components/schemas/TemperatureExtended" }, "title": "AfterTreatmentExhaustTemperature" }, "AmberWarningLamp": { "type": "array", "items": { "$ref": "#/components/schemas/StateExtended" }, "title": "AmberWarningLamp" }, "DieselParticulateFilterLampCommand": { "type": "array", "items": { "$ref": "#/components/schemas/StateExtended" }, "title": "DieselParticulateFilterLampCommand" }, "EngineFuelTemperature": { "type": "array", "items": { "$ref": "#/components/schemas/TemperatureExtended" }, "title": "EngineFuelTemperature" }, "EngineIntakeAirPressure": { "type": "array", "items": { "$ref": "#/components/schemas/PressureExtended" }, "title": "EngineIntakeAirPressure" }, "EngineIntakeManifoldPressure": { "type": "array", "items": { "$ref": "#/components/schemas/PressureExtended" }, "title": "EngineIntakeManifoldPressure" }, "EngineIntercoolerTemperature": { "type": "array", "items": { "$ref": "#/components/schemas/TemperatureExtended" }, "title": "EngineIntercoolerTemperature" }, "EngineOilLevel": { "type": "array", "items": { "$ref": "#/components/schemas/PercentageExtended" }, "title": "EngineOilLevel" }, "EngineTotalIdleFuelUsed": { "type": "array", "items": { "$ref": "#/components/schemas/FuelUsedExtended" }, "title": "EngineTotalIdleFuelUsed" }, "ExhaustSystemHighTemperatureLampCommand": { "type": "array", "items": { "$ref": "#/components/schemas/StateExtended" }, "title": "ExhaustSystemHighTemperatureLampCommand" }, "HydraulicPressure": { "type": "array", "items": { "$ref": "#/components/schemas/PressureExtended" }, "title": "HydraulicPressure" }, "MalfunctionIndicatorLamp": { "type": "array", "items": { "$ref": "#/components/schemas/StateExtended" }, "title": "MalfunctionIndicatorLamp" }, "ProtectLamp": { "type": "array", "items": { "$ref": "#/components/schemas/StateExtended" }, "title": "ProtectLamp" }, "RedStopLamp": { "type": "array", "items": { "$ref": "#/components/schemas/StateExtended" }, "title": "RedStopLamp" }, "TransmissionOilTemperature": { "type": "array", "items": { "$ref": "#/components/schemas/TemperatureExtended" }, "title": "TransmissionOilTemperature" }, "CumulativeProductiveHours": { "type": "array", "items": { "$ref": "#/components/schemas/CumulativeHoursExtended" }, "title": "CumulativeProductiveHours" }, "CumulativeMovingHours": { "type": "array", "items": { "$ref": "#/components/schemas/CumulativeHoursExtended" }, "title": "CumulativeMovingHours" }, "Speed": { "type": "array", "items": { "$ref": "#/components/schemas/SpeedExtended" }, "title": "Speed" }, "OperationStatus": { "type": "array", "items": { "$ref": "#/components/schemas/StatusExtended" }, "title": "OperationStatus" }, "CumulativeEngineHours": { "type": "array", "items": { "$ref": "#/components/schemas/CumulativeHoursExtended" }, "title": "CumulativeEngineHours" }, "PlatformHeightPercent": { "type": "array", "items": { "$ref": "#/components/schemas/PercentageExtended" }, "title": "PlatformHeightPercent" }, "PlatformHeight": { "type": "array", "items": { "$ref": "#/components/schemas/LengthExtended" }, "title": "PlatformHeight" }, "PlatformElevated": { "type": "array", "items": { "$ref": "#/components/schemas/StatusExtended" }, "title": "PlatformElevated" }, "Payload": { "type": "array", "items": { "$ref": "#/components/schemas/PayloadTotalsExtended" }, "title": "Payload" }, "BatteryStateOfChargePercent": { "type": "array", "items": { "$ref": "#/components/schemas/PercentageExtended" }, "title": "BatteryStateOfChargePercent" }, "BatteryCurrent": { "type": "array", "items": { "$ref": "#/components/schemas/CurrentExtended" }, "title": "BatteryCurrent" }, "BatteryTemperature": { "type": "array", "items": { "$ref": "#/components/schemas/TemperatureExtended" }, "title": "BatteryTemperature" }, "AcPhaseL1NeutralRMSVoltage": { "type": "array", "items": { "$ref": "#/components/schemas/VoltageExtended" }, "title": "AcPhaseL1NeutralRMSVoltage" }, "AcPhaseL2NeutralRMSVoltage": { "type": "array", "items": { "$ref": "#/components/schemas/VoltageExtended" }, "title": "AcPhaseL2NeutralRMSVoltage" }, "AcPhaseL3NeutralRMSVoltage": { "type": "array", "items": { "$ref": "#/components/schemas/VoltageExtended" }, "title": "AcPhaseL3NeutralRMSVoltage" }, "AcPhaseL1Frequency": { "type": "array", "items": { "$ref": "#/components/schemas/FrequencyExtended" }, "title": "AcPhaseL1Frequency" }, "AcPhaseL2Frequency": { "type": "array", "items": { "$ref": "#/components/schemas/FrequencyExtended" }, "title": "AcPhaseL2Frequency" }, "AcPhaseL3Frequency": { "type": "array", "items": { "$ref": "#/components/schemas/FrequencyExtended" }, "title": "AcPhaseL3Frequency" }, "AcPhaseL1RMSCurrent": { "type": "array", "items": { "$ref": "#/components/schemas/CurrentExtended" }, "title": "AcPhaseL1RMSCurrent" }, "AcPhaseL2RMSCurrent": { "type": "array", "items": { "$ref": "#/components/schemas/CurrentExtended" }, "title": "AcPhaseL2RMSCurrent" }, "AcPhaseL3RMSCurrent": { "type": "array", "items": { "$ref": "#/components/schemas/CurrentExtended" }, "title": "AcPhaseL3RMSCurrent" }, "AcPhaseL1L2RMSVoltage": { "type": "array", "items": { "$ref": "#/components/schemas/VoltageExtended" }, "title": "AcPhaseL1L2RMSVoltage" }, "AcPhaseL2L3RMSVoltage": { "type": "array", "items": { "$ref": "#/components/schemas/VoltageExtended" }, "title": "AcPhaseL2L3RMSVoltage" }, "AcPhaseL3L1RMSVoltage": { "type": "array", "items": { "$ref": "#/components/schemas/VoltageExtended" }, "title": "AcPhaseL3L1RMSVoltage" }, "AcTotalActivePower": { "type": "array", "items": { "$ref": "#/components/schemas/PowerExtended" }, "title": "AcTotalActivePower" }, "AcPhaseL1ActivePower": { "type": "array", "items": { "$ref": "#/components/schemas/PowerExtended" }, "title": "AcPhaseL1ActivePower" }, "AcPhaseL2ActivePower": { "type": "array", "items": { "$ref": "#/components/schemas/PowerExtended" }, "title": "AcPhaseL2ActivePower" }, "AcPhaseL3ActivePower": { "type": "array", "items": { "$ref": "#/components/schemas/PowerExtended" }, "title": "AcPhaseL3ActivePower" }, "AcTotalApparentPower": { "type": "array", "items": { "$ref": "#/components/schemas/PowerExtended" }, "title": "AcTotalApparentPower" }, "AcTotalPowerFactor": { "type": "array", "items": { "$ref": "#/components/schemas/FactorExtended" }, "title": "AcTotalPowerFactor" }, "AcTotalReactivePower": { "type": "array", "items": { "$ref": "#/components/schemas/PowerExtended" }, "title": "AcTotalReactivePower" }, "PayloadTemperature": { "type": "array", "items": { "$ref": "#/components/schemas/TemperatureExtended" }, "title": "PayloadTemperature" }, "AcTotalRelativeActivePowerLoadPercentage": { "type": "array", "items": { "$ref": "#/components/schemas/PercentageExtended" }, "title": "AcTotalRelativeActivePowerLoadPercentage" }, "AcTotalRelativeApparentPowerLoadPercentage": { "type": "array", "items": { "$ref": "#/components/schemas/PercentageExtended" }, "title": "AcTotalRelativeApparentPowerLoadPercentage" }, "AcTotalRelativeLoadPercentage": { "type": "array", "items": { "$ref": "#/components/schemas/PercentageExtended" }, "title": "AcTotalRelativeLoadPercentage" }, "AcAveragePhaseToNeutralRmsVoltage": { "type": "array", "items": { "$ref": "#/components/schemas/VoltageExtended" }, "title": "AcAveragePhaseToNeutralRmsVoltage" }, "AcAveragePhaseToPhaseRmsVoltage": { "type": "array", "items": { "$ref": "#/components/schemas/VoltageExtended" }, "title": "AcAveragePhaseToPhaseRmsVoltage" }, "AcAverageRmsCurrent": { "type": "array", "items": { "$ref": "#/components/schemas/CurrentExtended" }, "title": "AcAverageRmsCurrent" }, "Accelerometer_X_Axis": { "type": "array", "items": { "$ref": "#/components/schemas/GForceExtended" }, "title": "Accelerometer_X_Axis" }, "Accelerometer_Y_Axis": { "type": "array", "items": { "$ref": "#/components/schemas/GForceExtended" }, "title": "Accelerometer_Y_Axis" }, "Accelerometer_Z_Axis": { "type": "array", "items": { "$ref": "#/components/schemas/GForceExtended" }, "title": "Accelerometer_Z_Axis" }, "Impact": { "type": "array", "items": { "$ref": "#/components/schemas/GForceExtended" }, "title": "Impact" }, "AftertreatmentDieselParticulateFilterTimeToNextActiveRegeneration": { "type": "array", "items": { "$ref": "#/components/schemas/DurationExtended" }, "title": "AftertreatmentDieselParticulateFilterTimeToNextActiveRegeneration" }, "AftertreatmentSCRTimeSinceLastCleaningEvent": { "type": "array", "items": { "$ref": "#/components/schemas/DurationExtended" }, "title": "AftertreatmentSCRTimeSinceLastCleaningEvent" }, "EngineFuelFilterDifferentialPressure": { "type": "array", "items": { "$ref": "#/components/schemas/PressureExtended" }, "title": "EngineFuelFilterDifferentialPressure" }, "EngineOilFilterDifferentialPressure": { "type": "array", "items": { "$ref": "#/components/schemas/PressureExtended" }, "title": "EngineOilFilterDifferentialPressure" }, "AcAverageFrequency": { "type": "array", "items": { "$ref": "#/components/schemas/FrequencyExtended" }, "title": "AcAverageFrequency" }, "StabilizersDeployed": { "type": "array", "items": { "$ref": "#/components/schemas/StatusExtended" }, "title": "StabilizersDeployed" }, "PlatformStowed": { "type": "array", "items": { "$ref": "#/components/schemas/StatusExtended" }, "title": "PlatformStowed" }, "RescueModeActive": { "type": "array", "items": { "$ref": "#/components/schemas/StatusExtended" }, "title": "RescueModeActive" }, "BatteryStateOfHealthPercent": { "type": "array", "items": { "$ref": "#/components/schemas/PercentageExtended" }, "title": "BatteryStateOfHealthPercent" }, "BatteryRemainingRunTime": { "type": "array", "items": { "$ref": "#/components/schemas/DurationExtended" }, "title": "BatteryRemainingRunTime" }, "BatteryChargeCyclesCount": { "type": "array", "items": { "$ref": "#/components/schemas/CountExtended" }, "title": "BatteryChargeCyclesCount" }, "BatteryCumulativeDischargedEnergy": { "type": "array", "items": { "$ref": "#/components/schemas/ElectricEnergyExtended" }, "title": "BatteryCumulativeDischargedEnergy" }, "BatteryRemainingChargeTime": { "type": "array", "items": { "$ref": "#/components/schemas/DurationExtended" }, "title": "BatteryRemainingChargeTime" }, "BatteryChargerInputVoltage": { "type": "array", "items": { "$ref": "#/components/schemas/VoltageExtended" }, "title": "BatteryChargerInputVoltage" }, "BatteryChargerInputCurrent": { "type": "array", "items": { "$ref": "#/components/schemas/CurrentExtended" }, "title": "BatteryChargerInputCurrent" }, "BatteryChargerOutputCurrentLimit": { "type": "array", "items": { "$ref": "#/components/schemas/CurrentExtended" }, "title": "BatteryChargerOutputCurrentLimit" }, "BatteryChargerInputCurrentLimit": { "type": "array", "items": { "$ref": "#/components/schemas/CurrentExtended" }, "title": "BatteryChargerInputCurrentLimit" }, "CumulativeCO2Emissions": { "type": "array", "items": { "$ref": "#/components/schemas/CO2EmissionsExtended" }, "title": "CumulativeCO2Emissions" }, "AfterTreatmentDieselParticulateFilterActiveRegenerationState": { "type": "array", "items": { "$ref": "#/components/schemas/DetailedStateExtended" }, "title": "AfterTreatmentDieselParticulateFilterActiveRegenerationState" }, "AfterTreatmentDieselParticulateFilterState": { "type": "array", "items": { "$ref": "#/components/schemas/DetailedStateExtended" }, "title": "AfterTreatmentDieselParticulateFilterState" }, "CumulativeUtilizationHours": { "type": "array", "description": "The cumulative utilization hours of the asset. The utilization hours represent the total time a machine has been actively utilized based on a more precise definition of machine usage. CumulativeUtilizationHours is tailored to specific machine types and is defined in collaboration with manufacturers to reflect the work performed. Please note: The utilization graph on Manager's asset home page does not display CumulativeUtilizationHours.", "items": { "$ref": "#/components/schemas/CumulativeHoursExtended" }, "title": "CumulativeUtilizationHours" }, "WindSpeed": { "type": "array", "items": { "$ref": "#/components/schemas/SpeedExtended" }, "title": "WindSpeed" }, "WindDirection": { "type": "array", "items": { "$ref": "#/components/schemas/AngleExtended" }, "title": "WindDirection" }, "ParticleVelocity": { "type": "array", "items": { "$ref": "#/components/schemas/SpeedExtended" }, "title": "ParticleVelocity" }, "ParticulateMatter25": { "type": "array", "items": { "$ref": "#/components/schemas/ConcentrationExtended" }, "title": "ParticulateMatter25" }, "ParticulateMatter10": { "type": "array", "items": { "$ref": "#/components/schemas/ConcentrationExtended" }, "title": "ParticulateMatter10" }, "BatteryChargerCumulativeInputEnergy": { "type": "array", "items": { "$ref": "#/components/schemas/ElectricEnergyExtended" }, "title": "BatteryChargerCumulativeInputEnergy" } }, "required": ["Links"], "xml": { "name": "MachineInsightTimeseries", "namespace": "http://standards.iso.org/iso/15143/-3" } }, "PeakDailySpeedMessages": { "type": "object", "description": "Time-series of daily peak speed. Peak daily speed is the highest achieved travel speed for this machine during the previous 24 h period.", "properties": { "Links": { "type": "array", "description": "Collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last). Each link contains a relationship (rel) and a hyperlink (href).", "items": { "$ref": "#/components/schemas/FleetLinks" }, "title": "Links" }, "Speed": { "type": "array", "description": "Collection of daily peak speed. Peak daily speed is the highest achieved travel speed for this machine during the previous 24 h period.", "items": { "$ref": "#/components/schemas/Speed" }, "title": "Speed" } }, "required": ["Links"], "xml": { "name": "PeakDailySpeedMessages", "namespace": "http://standards.iso.org/iso/15143/-3" } }, "LocationMessages": { "type": "object", "description": "Time-series of location data", "properties": { "Links": { "type": "array", "description": "Collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last). Each link contains a relationship (rel) and a hyperlink (href).", "items": { "$ref": "#/components/schemas/FleetLinks" }, "title": "Links" }, "Location": { "type": "array", "description": "Collection of location data", "items": { "$ref": "#/components/schemas/Location" }, "title": "Location" } }, "required": ["Links"], "xml": { "name": "LocationMessages", "namespace": "http://standards.iso.org/iso/15143/-3" } }, "FuelUsedMessages": { "type": "object", "description": "Time-series of cumulative fuel used", "properties": { "Links": { "type": "array", "description": "Collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last). Each link contains a relationship (rel) and a hyperlink (href).", "items": { "$ref": "#/components/schemas/FleetLinks" }, "title": "Links" }, "FuelUsed": { "type": "array", "description": "Collection of cumulative fuel used", "items": { "$ref": "#/components/schemas/FuelUsed" }, "title": "FuelUsed" } }, "required": ["Links"], "xml": { "name": "FuelUsedMessages", "namespace": "http://standards.iso.org/iso/15143/-3" } }, "FuelRemainingMessages": { "type": "object", "description": "Time-series of the percentage of fuel remaining in the fuel tank of the machine", "properties": { "Links": { "type": "array", "description": "Collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last). Each link contains a relationship (rel) and a hyperlink (href).", "items": { "$ref": "#/components/schemas/FleetLinks" }, "title": "Links" }, "FuelRemaining": { "type": "array", "description": "Collection of the percentage of fuel remaining in the fuel tank of the machine", "items": { "$ref": "#/components/schemas/FuelRemaining" }, "title": "FuelRemaining" } }, "required": ["Links"], "xml": { "name": "FuelRemainingMessages", "namespace": "http://standards.iso.org/iso/15143/-3" } }, "DiagnosticTroubleCode": { "type": "object", "description": "Time-series of diagnostic codes. The diagnostic codes, from the OEM, can alert the owner to the need for non-scheduled machine supports.", "properties": { "Links": { "type": "array", "description": "Collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last). Each link contains a relationship (rel) and a hyperlink (href).", "items": { "$ref": "#/components/schemas/FleetLinks" }, "title": "Links" }, "FaultCode": { "type": "array", "description": "Collection of diagnostic codes. The diagnostic codes, from the OEM, can alert the owner to the need for non-scheduled machine supports.", "items": { "$ref": "#/components/schemas/FaultCode" }, "title": "FaultCode" } }, "required": ["Links"], "xml": { "name": "DiagnosticTroubleCode", "namespace": "http://standards.iso.org/iso/15143/-3" } }, "FaultCode": { "type": "object", "description": "FaultCode is the definition of OEM specified diagnostic codes that alert the owner to the need for non-scheduled machine supports. Each code is expressed by seven fields: Date and time (DateTime), Diagnostic trouble code identifier (CodeIdentifier), Code severity (CodeSeverity), Code description (CodeDescription), Temperature unit (TemperatureUnit), Ambient air temperature (AirTemperature) and Description of code source (CodeSource).", "properties": { "CodeIdentifier": { "type": "string", "description": "The diagnostic trouble code identifier specifies the identification for the code that occurred at a specific data and time. The diagnostic trouble code concept is defined in SAE J1939-73. The structure and values of the diagnostic trouble code identifier can differ among OEM.", "title": "CodeIdentifier" }, "CodeDescription": { "type": "string", "description": "The code description is a string of text that describes the meaning of the code, e.g. “air filter blocked”. The structure of the code description for any particular code identifier can differ among OEM. This data element varies among OEM.", "title": "CodeDescription" }, "CodeSeverity": { "type": "string", "description": "The code severity is the severity descriptor of the specific code identifier that occurred. The structure of the code severity can differ among OEM. This data element varies among OEM.", "title": "CodeSeverity" }, "AirTemperature": { "type": "integer", "description": "This field indicates the temperature at the time the code occurred on the machine as of the specified date and time. Its data type is integer, which includes all values from −100 to +100.", "title": "AirTemperature" }, "TemperatureUnit": { "type": "string", "description": "Temperature is expressed as degrees Celsius. If the unit of measure of ambient air temperature is included in the response, this field will have the value “Celsius.”", "title": "TemperatureUnit" }, "CodeSource": { "type": "string", "description": "The description of code source indicates the machine controller (e.g. ECU) that generated the code on the machine. The structure of the source description for any particular code identifier can differ among OEM.", "title": "CodeSource" }, "datetime": { "type": "string", "format": "date-time", "title": "datetime", "xml": { "attribute": true } } }, "title": "FaultCode" }, "EngineStatusMessages": { "type": "object", "description": "Time-series of engine condition. Engine condition is the running state of the engine as of the specified date and time.", "properties": { "Links": { "type": "array", "description": "Collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last). Each link contains a relationship (rel) and a hyperlink (href).", "items": { "$ref": "#/components/schemas/FleetLinks" }, "title": "Links" }, "EngineStatus": { "type": "array", "description": "Collection of engine condition. Engine condition is the running state of the engine as of the specified date and time.", "items": { "$ref": "#/components/schemas/EngineStatus" }, "title": "EngineStatus" } }, "required": ["Links"], "xml": { "name": "EngineStatusMessages", "namespace": "http://standards.iso.org/iso/15143/-3" } }, "DistanceMessages": { "type": "object", "description": "Time-series of cumulative distance travelled. Cumulative distance is the total distance travelled by the machine, under its own power, since its manufacture", "properties": { "Links": { "type": "array", "description": "Collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last). Each link contains a relationship (rel) and a hyperlink (href).", "items": { "$ref": "#/components/schemas/FleetLinks" }, "title": "Links" }, "Distance": { "type": "array", "description": "Collection of cumulative distance travelled. Cumulative distance is the total distance travelled by the machine, under its own power, since its manufacture", "items": { "$ref": "#/components/schemas/Distance" }, "title": "Distance" } }, "required": ["Links"], "xml": { "name": "DistanceMessages", "namespace": "http://standards.iso.org/iso/15143/-3" } }, "DEFRemainingMessages": { "type": "object", "description": "Time-series of the percentage of diesel exhaust fluid (DEF) remaining in the DEF tank", "properties": { "Links": { "type": "array", "description": "Collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last). Each link contains a relationship (rel) and a hyperlink (href).", "items": { "$ref": "#/components/schemas/FleetLinks" }, "title": "Links" }, "defremaining": { "type": "array", "items": { "$ref": "#/components/schemas/DEFRemaining" } } }, "required": ["Links"], "xml": { "name": "DEFRemainingMessages", "namespace": "http://standards.iso.org/iso/15143/-3" } }, "CumulativePowerTakeOffHoursMessages": { "type": "object", "description": "Time-series of cumulative power take-off hours of the machine", "properties": { "Links": { "type": "array", "description": "Collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last). Each link contains a relationship (rel) and a hyperlink (href).", "items": { "$ref": "#/components/schemas/FleetLinks" }, "title": "Links" }, "CumulativePowerTakeOffHours": { "type": "array", "description": "Collection of cumulative power take-off hours of the machine", "items": { "$ref": "#/components/schemas/CumulativePowerTakeOffHours" }, "title": "CumulativePowerTakeOffHours" } }, "required": ["Links"], "xml": { "name": "CumulativePowerTakeOffHoursMessages", "namespace": "http://standards.iso.org/iso/15143/-3" } }, "CumulativePayloadTotalMessages": { "type": "object", "description": "Time-series of cumulative total payload moved by the machine", "properties": { "Links": { "type": "array", "description": "Collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last). Each link contains a relationship (rel) and a hyperlink (href).", "items": { "$ref": "#/components/schemas/FleetLinks" }, "title": "Links" }, "CumulativePayloadTotals": { "type": "array", "description": "Collection of cumulative total payload moved by the machine", "items": { "$ref": "#/components/schemas/PayloadTotals" }, "title": "CumulativePayloadTotals" } }, "required": ["Links"], "xml": { "name": "CumulativePayloadTotalMessages", "namespace": "http://standards.iso.org/iso/15143/-3" } }, "CumulativeOperatingHoursMessages": { "type": "object", "description": "Time-series of cumulative operating hours.", "properties": { "Links": { "type": "array", "description": "Collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last). Each link contains a relationship (rel) and a hyperlink (href).", "items": { "$ref": "#/components/schemas/FleetLinks" }, "title": "Links" }, "CumulativeOperatingHours": { "type": "array", "description": "Collection of cumulative operating hours.", "items": { "$ref": "#/components/schemas/CumulativeOperatingHours" }, "title": "CumulativeOperatingHours" } }, "required": ["Links"], "xml": { "name": "CumulativeOperatingHoursMessages", "namespace": "http://standards.iso.org/iso/15143/-3" } }, "CumulativeNonproductiveIdleHoursMessages": { "type": "object", "description": "Time-series of cumulative idle non-operating hours. Cumulative idle non-operating hours are the total hours when the engine is running, but the machine is not moving and the machine controls are not operated (e.g. lever or pedal not operated).", "properties": { "Links": { "type": "array", "description": "Collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last). Each link contains a relationship (rel) and a hyperlink (href).", "items": { "$ref": "#/components/schemas/FleetLinks" }, "title": "Links" }, "CumulativeNonproductiveIdleHours": { "type": "array", "description": "Collection of cumulative idle non-operating hours", "items": { "$ref": "#/components/schemas/CumulativeIdleHours" }, "title": "CumulativeNonproductiveIdleHours" } }, "required": ["Links"], "xml": { "name": "CumulativeNonproductiveIdleHoursMessages", "namespace": "http://standards.iso.org/iso/15143/-3" } }, "CumulativeLoadCountMessages": { "type": "object", "description": "Time-series of cumulative load count. Cumulative load count is the lifetime total cumulative number of loads the machine has achieved. The definitions of load and load count are at the discretion of the manufacturer.", "properties": { "Links": { "type": "array", "description": "Collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last). Each link contains a relationship (rel) and a hyperlink (href).", "items": { "$ref": "#/components/schemas/FleetLinks" }, "title": "Links" }, "CumulativeLoadCount": { "type": "array", "description": "Collection of cumulative load count", "items": { "$ref": "#/components/schemas/LoadCount" }, "title": "CumulativeLoadCount" } }, "required": ["Links"], "xml": { "name": "CumulativeLoadCountMessages", "namespace": "http://standards.iso.org/iso/15143/-3" } }, "CumulativeIdleHoursMessages": { "type": "object", "description": "Time-series of cumulative idle non-operating hours. Cumulative idle non-operating hours are the total hours when the engine is running, but the machine is not moving and the machine controls are not operated (e.g. lever or pedal not operated).", "properties": { "Links": { "type": "array", "description": "Collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last). Each link contains a relationship (rel) and a hyperlink (href).", "items": { "$ref": "#/components/schemas/FleetLinks" }, "title": "Links" }, "CumulativeIdleHours": { "type": "array", "description": "Collection of cumulative idle non-operating hours", "items": { "$ref": "#/components/schemas/CumulativeIdleHours" }, "title": "CumulativeIdleHours" } }, "required": ["Links"], "xml": { "name": "CumulativeIdleHoursMessages", "namespace": "http://standards.iso.org/iso/15143/-3" } }, "CumulativeActiveRegenerationHourMessages": { "type": "object", "description": "Time-series of cumulative non-productive regeneration hours", "properties": { "Links": { "type": "array", "description": "Collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last). Each link contains a relationship (rel) and a hyperlink (href).", "items": { "$ref": "#/components/schemas/FleetLinks" }, "title": "Links" }, "CumulativeActiveRegenerationHours": { "type": "array", "description": "Collection of cumulative non-productive regeneration hours", "items": { "$ref": "#/components/schemas/CumulativeActiveRegenerationHours" }, "title": "CumulativeActiveRegenerationHours" } }, "required": ["Links"], "xml": { "name": "CumulativeActiveRegenerationHourMessages", "namespace": "http://standards.iso.org/iso/15143/-3" } }, "AverageLoadFactorLast24": { "type": "object", "description": "Time-series of average daily engine load factor.", "properties": { "Links": { "type": "array", "description": "Collection of links that describe the current page (self), next page (next), previous page (prev), and last page (last). Each link contains a relationship (rel) and a hyperlink (href).", "items": { "$ref": "#/components/schemas/FleetLinks" }, "title": "Links" }, "LoadFactor": { "type": "array", "description": "Collection of average daily engine load factor. The preferred definition of average daily load factor is a percentage calculated as the actual fuel consumed over the previous 24 h period divided by the fuel that would have been consumed during that period if the machine had been continually operated at the engine’s rated output.", "items": { "$ref": "#/components/schemas/LoadFactor" }, "title": "LoadFactor" } }, "required": ["Links"], "xml": { "name": "AverageLoadFactorLast24", "namespace": "http://standards.iso.org/iso/15143/-3" } } }, "securitySchemes": { "authorizationBearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } } }