Skip to main content

Machine Reporting

As a manufacturer, you can query information about your manufactured machines, to see how the machine is used and which applications are assigned to it. This will enable you to retrieve information about the customer usage of your machines.

Reporting

GET https://api.tapio.one/management/manufacturer/machineinfo

The following properties can be set via query parameter.

PropertyDescriptionDefaultDatatype
includeLimitedMachinesIf false, will only return machines with an existing manufacturer machine, if true the response will return limited machines that exist only in a customer subscription.falsebool
pageNumber of the page Obsolete use the offset parameter instead0int
offsetOffset for paging0int
sizeNumber of items per page Obsolete use the limit parameter instead200int
limitNumber of items per request200int

Response model

An example JSON response will then look like this:

{
"ManufacturerMachineInformations" : [
{
"tmid": "testmachine12",
"isCcInformationAvailable": true,
"deviceType": "Machine",
"deviceSubtype": null,
"subscriptions": [
{
"subscriptionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"customerMachineName": "Test super saw 5000",
"state": "Active",
"assignedApps": [
{
"applicationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"applicationName": "MachineBoard"
}
]
}
]
}
],
"invalidMachineInformation" : []
}

Reporting defined list of Tapio machine Ids

POST https://api.tapio.one/management/manufacturer/machineinfo

The following properties can be set via query parameter.

PropertyDescriptionDefaultDatatype
includeLimitedMachinesIf false, will only return machines with an existing manufacturer machine, if true the response will return limited machines that exist only in a customer subscription.falsebool
pageNumber of the page Obsolete use the offset parameter instead0int
offsetOffset for paging0int
sizeNumber of items per page Obsolete use the limit parameter instead200int
limitNumber of items per request200int

Request body

An example JSON response will then look like this:

{
"tmids" : ["testmachine12", "testmachine13"]
}

Response model

An example JSON response will then look like this:

{
"validMachineInformation" : [
{
"tmid": "testmachine12",
"isCcInformationAvailable": true,
"deviceType": "Machine",
"deviceSubtype": null,
"subscriptions": [
{
"subscriptionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"customerMachineName": "Test super saw 5000",
"state": "Active",
"assignedApps": [
{
"applicationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"applicationName": "MachineBoard"
}
]
}
]
}
],
"invalidMachineInformation" : [
"message" : "Machine is not found testmachine13",
"details" : [""]
]
}

Response Model Description

As a response to this query, you will retrieve an array of manufacturerMachineInformations.

PropertyDescriptionDatatype
validMachineInformationslist of valid manufacturer machine informationManufacturerMachineInformation
invalidMachineInformationslist of invalid requested tapio machine id and there reasonErrorInformation

ManufacturerMachineInformation

PropertyDescriptionDatatype
tapioMachineIdtapio machine idstring
isCcInformationAvailablethis machines has an CloudConnectorbool
deviceTypeKind of the device (Machine, SmartDevice)enum
deviceSubtypeDevice subtype of the devicestring
subscriptionslist of customer subscriptionsSubscriptionInformation[]

SubscriptionInformation

PropertyDescriptionDatatype
subscriptionIdId of the subscription in which the machine is onboardedguid
customerMachineNameName of the machine in the customer subscriptionstring
stateState of the machine (Pending, Active, Declined, Limited, Error)string
assignedAppsList of apps assigned to the machineApplicationInformation[]
customerMachineNameName of the customer subscriptionstring

ApplicationInformation

PropertyDescriptionDatatype
applicationIdId of the applicationguid
applicationNameName of the applicationstring

ErrorInformation

PropertyDescriptionDatatype
messagereason why this is an errorstring
detailsoptional set details why this is an errorlist of string