Download OpenAPI specification:Download
APIs published by siemens for SITRANS FM MAG 8000 4G/LTE portfolio.
Let's admin create a new child company.
name | string user_name@company.comCompany name can consist of [a-z] [0-9] [#,_,&], and the first letter must be an alphabet. The length must be at least 2 |
parent_company_id | string Must be requested using suitable company API. This parameter specifies the parent company of the new company. If this parameter is not specified, the new company will be listed under current company. |
{- "name": "new_company_pvt_ltd#1",
- "parent_company_id": "1234-f44j-44f4-44f"
}
{- "message": "The company created successfully."
}
Only the company administrator has the authority to remove its subsidiary companies. Self-deletion is restricted, and deleting companies with subsidiaries is also prohibited.
company_id required | string The id of attached to the company |
{- "message": "string"
}
Lets admin visualize the metadata of the company and the children companies.
company_id required | string The id of the company. |
subchild | integer Example: subchild=3 The number of subchildren to limit the output to. Defaults to the maximum value. |
{- "message": "string",
- "data": {
- "CompanyId": "string",
- "CompanyPath": "string",
- "CompanyName": "string",
- "Children": [
- {
- "CompanyId": "string",
- "CompanyPath": "string",
- "CompanyName": "string"
}
]
}
}
Lets admin visualize the metadata of the company in context and the children companies.
subchild | integer Example: subchild=3 The number of subchildren to limit the output to. Defaults to the maximum value. |
{- "message": "string",
- "data": {
- "CompanyId": "string",
- "CompanyPath": "string",
- "CompanyName": "string",
- "Children": [
- {
- "CompanyId": "string",
- "CompanyPath": "string",
- "CompanyName": "string"
}
]
}
}
Let's admin register a company(at least one unclaimed device is needed).
string | |
password | string |
company_name | string Company name can consist of [a-z] [0-9] [#,_,&], and the first letter must be an alphabet. The length must be at least 2 |
Array of objects = 1 items |
{- "email": "user_name@company.com",
- "password": "XXXXXXXX",
- "company_name": "new_company_pvt_ltd#1",
- "devices": [
- {
- "id": "123456789",
- "type": "4G"
}
]
}
{- "data": {
- "company_id": "string",
- "client_id": "string",
- "client_secret": "string"
}, - "message": "The company, attached admin acccount and asset have been created and claimed successfully."
}
Let's admin create an user under a company.
company_id required | string The id of the company attached to the user |
string | |
password | string |
first_name | string A name using which we can identify an user. |
last_name | string A surname using which we can identify an user. |
society | string Address to know the user well |
mobile | string Mobile number to identify contact |
country_code | string Country code to contact the user |
language | string Good to know users preferred language |
title | string Title to understand user better |
role | string Create user role e.g. SIEMENS_ADMIN, COMPANY_ADMIN, USER_ADMIN |
{- "email": "user_name@company.com",
- "password": "XXXXXXXX",
- "first_name": "John",
- "last_name": "Doe",
- "society": "Address",
- "mobile": "1234567890",
- "country_code": "+1",
- "language": "ENGLISH",
- "title": "Mr",
- "role": "SIEMENS_ADMIN/COMPANY_ADMIN/COMPANY_USER"
}
{- "message": "The user created successfully."
}
This API will return user details under the company
company_id required | string The id of the company attached to the user |
user_id required | string The id of the user to be deleted |
{- "message": "string",
- "data": {
- "devices": [
- "string"
]
}
}
Updates a company user
company_id required | string The id of the company attached to the user |
user_id required | string The id of the user to modify |
first_name | string A name using which we can identify an user. |
last_name | string A surname using which we can identify an user. |
society | string Address to know the user well |
mobile | string Mobile number to identify contact |
country_code | string Country code to contact the user |
language | string Good to know users preferred language |
title | string Title to understand user better |
{- "first_name": "John",
- "last_name": "Doe",
- "society": "Address",
- "mobile": "1234567890",
- "country_code": "+1",
- "language": "ENGLISH",
- "title": "Mr"
}
{- "first_name": "John",
- "last_name": "Doe",
- "society": "Address",
- "mobile": "1234567890",
- "country_code": "+1",
- "language": "ENGLISH",
- "title": "Mr"
}
Lets user register their mag8000 com modules under their company.
company_id required | string This specifies the company id to which device will be registered. |
Array of objects = 1 items |
{- "devices": [
- {
- "id": "123456789",
- "type": "4G"
}
]
}
{- "data": {
- "invalid_devices": [
- "string"
]
}, - "message": "string"
}
This API will return device list.
company_id required | string The id of the company attached to the user |
subchild | integer Example: subchild=3 The number of subchildren to limit the output to. Defaults to the maximum value. |
{- "message": "string",
- "data": {
- "CompanyId": "string",
- "Devices": [
- {
- "DeviceId": "string",
- "IMEI": "string",
- "CompanyID": "string",
- "AssetType": "string",
- "ClaimedStatus": "string",
- "SerialNumber": "string",
- "ConnectivityStatus": "string"
}
]
}
}
This API will return device detail created under this company
company_id required | string The id of the company attached to the user |
device_id required | string The device_id of the to be fetched. |
{- "message": "string"
}
This API will return device detail created under this company
company_id required | string The id of the company attached to the user |
device_id required | string The device_id of the to be fetched |
subchild | integer Example: subchild=3 The number of subchildren to limit the output to. Defaults to the maximum value. |
{- "message": "string",
- "data": {
- "CompanyId": "string",
- "Devices": [
- {
- "DeviceId": "string",
- "IMEI": "string",
- "CompanyID": "string",
- "AssetType": "string",
- "ClaimedStatus": "string",
- "SerialNumber": "string",
- "ConnectivityStatus": "string"
}
]
}
}
Lets user get a token to acess API's.
client_id | string |
client_secret | string |
grant_type | string This parameter specifies the type of request, now only 'credentials' is supported. |
{- "client_id": "string",
- "client_secret": "string",
- "grant_type": "credentials"
}
{- "data": {
- "jwt": "string"
}, - "message": "string"
}
This API will return flow measurement data of a specific device.
company_id required | string Example: This is company id linked to the device |
device_id required | string Example: 1234568 This is Device ID of the device. |
from_date | string Default: "None" Example: from_date=YYYY-MM-DD The date in the format YYYY, YYYY-MM or YYYY-MM-DD |
to_date | string Default: "None" Example: to_date=YYYY-MM-DD The date in the format YYYY, YYYY-MM or YYYY-MM-DD |
max_items | integer Default: 100 Example: max_items=123 Optional. The maximum of values to fetch. Will add a 'NextToken' key to fetch the next page. Defaults to 100 and cannot be less than 1 if specified. |
next_token | string Default: "None" Example: next_token=eyabcdefgegOIjlwPIJmqmlqjzIOPJkLQjfd A base64 encoded string to fetch the next page of the paginated result. |
{- "message": "string",
- "data": {
- "DeviceId": "string",
- "NextValueTimestamp": "string",
- "NextValueDatetime": "string",
- "NextToken": "string",
- "Values": [
- {
- "BatteryCapacity": "string",
- "Totalizer1": "string",
- "Totalizer2": "string",
- "Totalizer3": "string",
- "TotalizerUnit": "string",
- "FlowUnit": "string",
- "FlowValue": "string",
- "Header": "string",
- "AnalogMeasurement1": "string",
- "AnalogMeasurement2": "string",
- "MessageNumber": 0,
- "TransmittedDatetime": "2019-08-24T14:15:22Z",
- "TransmittedTimestamp": "string",
- "CollectedDatetime": "2019-08-24T14:15:22Z",
- "CollectedTimestamp": "string",
- "Alarms": {
- "ModuleAlarms": [
- {
- "RequirementID": "string",
- "Description": "string"
}
], - "HostDeviceAlarms": [
- {
- "RequirementID": "string",
- "Description": "string"
}
]
}
}
]
}
}
This API will return only the latest flow measurement data of a specific device.
company_id required | string Example: This is company id linked to the device |
device_id required | string Example: 1234568 This is Device ID of the device. |
{- "message": "string",
- "data": {
- "DeviceId": "string",
- "NextValueTimestamp": "string",
- "NextValueDatetime": "string",
- "NextToken": "string",
- "Values": [
- {
- "BatteryCapacity": "string",
- "Totalizer1": "string",
- "Totalizer2": "string",
- "Totalizer3": "string",
- "TotalizerUnit": "string",
- "FlowUnit": "string",
- "FlowValue": "string",
- "Header": "string",
- "AnalogMeasurement1": "string",
- "AnalogMeasurement2": "string",
- "MessageNumber": 0,
- "TransmittedDatetime": "2019-08-24T14:15:22Z",
- "TransmittedTimestamp": "string",
- "CollectedDatetime": "2019-08-24T14:15:22Z",
- "CollectedTimestamp": "string",
- "Alarms": {
- "ModuleAlarms": [
- {
- "RequirementID": "string",
- "Description": "string"
}
], - "HostDeviceAlarms": [
- {
- "RequirementID": "string",
- "Description": "string"
}
]
}
}
]
}
}
This API returns the list of alarms raised for a device.
company_id required | string Example: 1234 The company id which is linked to the device |
device_id required | string Example: 1234 The device id to fetch the alarms from |
from_date | string Default: "None" Example: from_date=YYYY-MM-DD The date in the format YYYY, YYYY-MM or YYYY-MM-DD |
to_date | string Default: "None" Example: to_date=YYYY-MM-DD The date in the format YYYY, YYYY-MM or YYYY-MM-DD |
max_items | integer Default: 100 Example: max_items=3 The maximum of values to fetch. Will add a 'NextToken' key to fetch the next page. Defaults to 100 and cannot be less than 1 if specified. |
next_token | string Default: "None" Example: next_token=eyabcdefgegOIjlwPIJmqmlqjzIOPJkLQjfd A base64 encoded string to fetch the next page of the paginated result. |
{- "message": "string",
- "data": {
- "DeviceId": "string",
- "NextToken": "string",
- "Values": [
- {
- "Date": "string",
- "ModuleAlarms": [
- {
- "RequirementID": "string",
- "Description": "string"
}
], - "HostDeviceAlarms": [
- {
- "RequirementID": "string",
- "Description": "string"
}
]
}
]
}
}
This API returns the message when the particular parameter is requested to read.
company_id required | string Example: 1234 The company id which is linked to the device |
device_id required | string Example: 1234 The device id to fetch the parameters for |
register_number required | string Example: register_number=5014 The register_number of the parameter |
{- "message": "string",
- "data": {
- "sent_message": "string",
- "sent_message_hex": "string",
- "topic": "string",
- "message_id": "string"
}
}
This API returns the message when the particular parameter value is requested to update.
company_id required | string Example: 1234 The company id which is linked to the device |
device_id required | string Example: 1234 The device id to fetch the parameters for |
register_number required | string Example: register_number=5014 The register_number of the parameter |
register_value required | string Example: register_value=200 The value of the parameter |
{- "message": "string",
- "data": {
- "sent_message": "string",
- "sent_message_hex": "string",
- "topic": "string",
- "message_id": "string"
}
}
This API will return device register value and status.
company_id required | string Example: 1234 The company id which is linked to the device |
device_id required | string Example: 1234 The device id to fetch the register data from |
status | string Example: status=True (Optional). Fetch the status for parameter request. Allowed values True or False |
register_number | string Example: register_number=5011 (Optional). Limit the response data to specific register number of the device |
{- "message": "<string>",
- "data": {
- "DeviceId": "<string>",
- "register_number": {
- "Value": "<string>"
}
}
}
This API will return the device queue status from thingstream
company_id required | string Example: 1234 The company id which is linked to the device |
device_id required | string Example: 1234 The device id to fetch the register data from |
{- "message": "string",
- "data": {
- "queueCount": 0,
- "inflightCount": 0,
- "retryCount": 0,
- "status": "string"
}
}