API docs by Redocly

SITRANS FM MAG 8000 4G/LTE API (1.0.0)

Download OpenAPI specification:

APIs published by siemens for SITRANS FM MAG 8000 4G/LTE portfolio.

Company

API's related to CURD operation on company

CreateCompany

Let's admin create a new child company.

Authorizations:
bearerAuth
Request Body schema: application/json
required
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.

Responses

Request samples

Content type
application/json
{
  • "name": "new_company_pvt_ltd#1",
  • "parent_company_id": "1234-f44j-44f4-44f"
}

Response samples

Content type
application/json
{
  • "message": "The company created successfully."
}

DeleteCompany

Only the company administrator has the authority to remove its subsidiary companies. Self-deletion is restricted, and deleting companies with subsidiaries is also prohibited.

Authorizations:
bearerAuth
path Parameters
company_id
required
string

The id of attached to the company

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

GetCompanyDetails

Lets admin visualize the metadata of the company and the children companies.

Authorizations:
bearerAuth
path Parameters
company_id
required
string

The id of the company.

query Parameters
subchild
integer
Example: subchild=3

The number of subchildren to limit the output to. Defaults to the maximum value.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

ListCompanies

Lets admin visualize the metadata of the company in context and the children companies.

Authorizations:
bearerAuth
query Parameters
subchild
integer
Example: subchild=3

The number of subchildren to limit the output to. Defaults to the maximum value.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

RegisterCompany

Let's admin register a company(at least one unclaimed device is needed).

Request Body schema: application/json
required
email
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

Responses

Request samples

Content type
application/json
{
  • "email": "user_name@company.com",
  • "password": "XXXXXXXX",
  • "company_name": "new_company_pvt_ltd#1",
  • "devices": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "The company, attached admin acccount and asset have been created and claimed successfully."
}

CreateUser

Let's admin create an user under a company.

path Parameters
company_id
required
string

The id of the company attached to the user

Request Body schema: application/json
required
email
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, COMPANY_USER

Responses

Request samples

Content type
application/json
{
  • "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"
}

Response samples

Content type
application/json
{
  • "message": "The user created successfully."
}

GetUserDetails

This API will return user details under the company

Authorizations:
bearerAuth
path Parameters
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

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

DeleteUser

Deletes a company user

path Parameters
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

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

UpdateUser

Updates a company user

path Parameters
company_id
required
string

The id of the company attached to the user

user_id
required
string

The id of the user to modify

Request Body schema: application/json
required
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

Responses

Request samples

Content type
application/json
{
  • "first_name": "John",
  • "last_name": "Doe",
  • "society": "Address",
  • "mobile": "1234567890",
  • "country_code": "+1",
  • "language": "ENGLISH",
  • "title": "Mr"
}

Response samples

Content type
application/json
{
  • "first_name": "John",
  • "last_name": "Doe",
  • "society": "Address",
  • "mobile": "1234567890",
  • "country_code": "+1",
  • "language": "ENGLISH",
  • "title": "Mr"
}

ListUsers

This API will return list of users under the company

Authorizations:
bearerAuth
path Parameters
company_id
required
string

The id of the company attached to the user

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

CreateAPIKeys

Let's admin create a new api keys for the company. Example different app

Authorizations:
bearerAuth
path Parameters
company_id
required
string
Example: 1234

The company id which is linked to the api key

Request Body schema: application/json
required
name
string
role
string

Create app role e.g. COMPANY_ADMIN, COMPANY_USER

Responses

Request samples

Content type
application/json
{
  • "name": "SecondCompany",
  • "role": "COMPANY_ADMIN/COMPANY_USER"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "string"
}

GetAllAPIKeys

This API will return list of all app api keys created for this company

Authorizations:
bearerAuth
path Parameters
company_id
required
string
Example: 1234

The company id which is linked to the api key

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "string"
}

DeleteAPIKey

This API will delete app keys for this company

Authorizations:
bearerAuth
path Parameters
company_id
required
string
Example: 1234

The company id which is linked to the api key

client_id
required
string
Example: 1234

The client id which is linked to the api key

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

Device

API's related to CURD operation on devices

RegisterDevices

Lets user register their mag8000 com modules under their company.

Authorizations:
bearerAuth
path Parameters
company_id
required
string

This specifies the company id to which device will be registered.

Request Body schema: application/json
required
Array of objects = 1 items

Responses

Request samples

Content type
application/json
{
  • "devices": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "string"
}

ListDevices

This API will return device list.

Authorizations:
bearerAuth
path Parameters
company_id
required
string

The id of the company attached to the user

query Parameters
subchild
integer
Example: subchild=3

The number of subchildren to limit the output to. Defaults to the maximum value.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

DeleteDevice

This API will return device detail created under this company

Authorizations:
bearerAuth
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

GetDeviceDetails

This API will return device detail created under this company

Authorizations:
bearerAuth
path Parameters
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

query Parameters
subchild
integer
Example: subchild=3

The number of subchildren to limit the output to. Defaults to the maximum value.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

GetDevicePosition

This API will return the device position data.

Authorizations:
bearerAuth
path Parameters
company_id
required
string

The company id which is linked to the device

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

UpdateDevicePosition

This API will trigger a location request for the device.

Authorizations:
bearerAuth
path Parameters
company_id
required
string

The company id which is linked to the device

device_id
required
string

The device id to update position for

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

AddFTPConfiguration

This endpoint will opt-in for forwarding the process data of a device to a SFTP/FTPS server.

Authorizations:
bearerAuth
path Parameters
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 get the process data from

Request Body schema: application/json
required
host
string

The host name of the FTP server

port
number

The port number of the FTP server

username
string

The username to authenticate with the FTP server

password
string

The password to authenticate with the FTP server

ftp_type
string

the type of the FTP server

destination_path
string

The path to save the files on the FTP server

Responses

Request samples

Content type
application/json
{
  • "host": "ftp.example.com",
  • "port": 21,
  • "username": "username",
  • "password": "password",
  • "ftp_type": "SFTP|EXPLICIT_FTPS|IMPLICIT_FTPS",
  • "destination_path": "/path/to/save"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

GetFTPConfiguration

This endpoint will fetch the process data forwarding SFTP/FTPS configuration.

Authorizations:
bearerAuth
path Parameters
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 get the process data from

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

DeleteFTPConfiguration

This endpoint will delete the process data forwarding SFTP/FTPS configuration.

Authorizations:
bearerAuth
path Parameters
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 get the ftp details

ftp_type
required
string
Example: SFTP|EXPLICIT_FTPS|IMPLICIT_FTPS

The ftp type will be SFTP, EXPLICIT_FTPS or IMPLICIT_FTPS

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

UpdateFTPConfiguration

This endpoint will update the process data forwarding SFTP/FTPS configuration.

Authorizations:
bearerAuth
path Parameters
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 get the ftp details

ftp_type
required
string
Example: SFTP|EXPLICIT_FTPS|IMPLICIT_FTPS

The ftp type will be SFTP, EXPLICIT_FTPS or IMPLICIT_FTPS

Request Body schema: application/json
required
host
string

The host name of the FTP server

port
number

The port number of the FTP server

username
string

The username to authenticate with the FTP server

password
string

The password to authenticate with the FTP server

destination_path
string

The path to save the files on the FTP server

Responses

Request samples

Content type
application/json
{
  • "host": "ftp.example.com",
  • "port": 21,
  • "username": "username",
  • "password": "password",
  • "destination_path": "/path/to/save"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

AddEmailAddresses

This endpoint will opt-in for forwarding the process data of a device to a list of email addresses. Maximum 5 emails per device can be added.

Authorizations:
bearerAuth
path Parameters
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 get the process data from

Request Body schema: application/json
required
email_addresses
Array of strings non-empty

The list of email addresses to opt in for process data forwarding CSV files

Responses

Request samples

Content type
application/json
{
  • "email_addresses": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "string"
}

GetEmailAddresses

This endpoint will fetch list of email configured for forwarding the process data of a device

Authorizations:
bearerAuth
path Parameters
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 get the process data from

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

DeleteEmailAddress

This endpoint will delete the email configured for forwarding the process data of a device

Authorizations:
bearerAuth
path Parameters
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 get list of emails

email_address
required
string
Example: name@example.com

email to delete from the list

Responses

Response samples

Content type
application/json
{
  • "message": "string"
}

UpdateEmailAddress

This endpoint will update the email configured for forwarding the process data of a device.

Authorizations:
bearerAuth
path Parameters
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 get list of emails

email_address
required
string
Example: name@example.com

email to delete from the list

Request Body schema: application/json
required
email_address
string

The new email address for process data forwarding CSV files

Responses

Request samples

Content type
application/json
{
  • "email_address": "string"
}

Response samples

Content type
application/json
{
  • "message": "string"
}

Token

API's related to token generation

GetJWTToken

Lets user get a token to acess API's.

Request Body schema: application/json
required
client_id
string
client_secret
string
grant_type
string

This parameter specifies the type of request, now only 'credentials' is supported.

Responses

Request samples

Content type
application/json
{
  • "client_id": "string",
  • "client_secret": "string",
  • "grant_type": "credentials"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "string"
}

ProcessValues

API's related to flow mesurement data

GetFlowMeasurementData

This API will return flow measurement data of a specific device.

Authorizations:
bearerAuth
path Parameters
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.

query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

GetLatestFlowMeasurementData

This API will return only the latest flow measurement data of a specific device.

Authorizations:
bearerAuth
path Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

Alarms

API's related to alarm monitoring data

GetDeviceAlarmsData

This API returns the list of alarms raised for a device.

Authorizations:
bearerAuth
path Parameters
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

query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

GetCompanyAlarmsData

This API returns the list of alarms raised for all the devices under a company.

Authorizations:
bearerAuth
path Parameters
company_id
required
string
Example: 1234

The company id which is linked to the device

query Parameters
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.

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

Parameters

API's related to device parameter data

RequestDeviceParameterDataRead

This API returns the message when the particular parameter is requested to read.

Authorizations:
bearerAuth
path Parameters
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

query Parameters
register_number
required
string
Example: register_number=5014

The register_number of the parameter

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

RequestDeviceParameterDataWrite

This API returns the message when the particular parameter value is requested to update.

Authorizations:
bearerAuth
path Parameters
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

query Parameters
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

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

RequestHostDeviceParameterDataWrite

This API returns the message when the particular host register/coil value is requested to update.

Authorizations:
bearerAuth
path Parameters
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

query Parameters
parameter_type
required
string
Example: parameter_type=coil

The register belongs to which parameter type- coil/register

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

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

RequestHostParameterDataRead

This API returns the message when the particular host register/coil value is requested to read.

Authorizations:
bearerAuth
path Parameters
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

query Parameters
parameter_type
required
string
Example: parameter_type=coil

The register belongs to which parameter type- coil/register

register_number
required
string
Example: register_number=5014

The register_number of the parameter

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

Get Device register data

This API will return device register value and status.

Authorizations:
bearerAuth
path Parameters
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

query Parameters
status
string
Example: status=True

(Optional). Fetch the status for parameter request. Allowed values True or False

register_num
string
Example: register_num=5011

(Optional). Limit the response data to specific register number of the device

Responses

Response samples

Content type
application/json
{
  • "message": "<string>",
  • "data": {
    }
}

Get Device host register data

This API will return device host register value and status.

Authorizations:
bearerAuth
path Parameters
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

query Parameters
status
string
Example: status=True

(Optional). Fetch the status for parameter request. Allowed values True or False

register_num
string
Example: register_num=5011

(Optional). Limit the response data to specific register number of the device

parameter_type
required
string
Example: parameter_type=coil

The register belongs to which parameter type- coil/register

Responses

Response samples

Content type
application/json
{
  • "message": "<string>",
  • "data": {
    }
}

Get Device queue status

This API will return the device queue status for 4G devices.

Authorizations:
bearerAuth
path Parameters
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

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

FUOTA

APIs related to FUOTA process

TriggerFUOTA

This endpoint will trigger FUOTA to device.

Authorizations:
bearerAuth
path Parameters
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

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

GetFUOTAStatus

This endpoint will get fuota status.

Authorizations:
bearerAuth
path Parameters
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

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "data": {
    }
}

GetFirmwareVersions

This endpoint will fetch the list of firmware versions available for FUOTA.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "string"
}

GetLatestFirmwareVersions

This endpoint will fetch the latest firmware version for FUOTA.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
null

Password

ForgotPassword

This endpoint will send an email to the user with a verification code to reset the password.

Request Body schema: application/json
required
email
string

Responses

Request samples

Content type
application/json
{
  • "email": "zyx@gmail.com"
}

Response samples

Content type
application/json
{
  • "message": "Success"
}

ChangePassword

This endpoint will allow user to change current password.

Authorizations:
bearerAuth
Request Body schema: application/json
required
username
string
old_password
string
new_password
string

Responses

Request samples

Content type
application/json
{
  • "username": "zyx@gmail.com",
  • "old_password": "G20JX+o^2{4_",
  • "new_password": "Muwgy1H(6?3%"
}

Response samples

Content type
application/json
{
  • "message": "Success"
}

ConfirmPassword

This endpoint will allow user to confirm the password.

Request Body schema: application/json
required
username
string
verification_code
string
new_password
string

Responses

Request samples

Content type
application/json
{
  • "username": "zyx@gmail.com",
  • "verification_code": "962534",
  • "new_password": "Muwgy1H(6?3%"
}

Response samples

Content type
application/json
{
  • "message": "Success"
}