API docs by Redocly

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

Download OpenAPI specification:Download

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, USER_ADMIN

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": {
    }
}

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": {
    }
}

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": {
    }
}

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": {
    }
}

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_number
string
Example: register_number=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 queue status

This API will return the device queue status from thingstream

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": {
    }
}