Mevris API

Mevris API 1.0.0

0
No votes yet
forum Discuss this API in the forum
production
development
https://api.us.apiconnect.ibmcloud.com/blueeastorientgmailcom-dev/sb

Paths

/Accounts/logout

/Devices

post /Devices
Device

Create a new instance of the model and persist it into the data source.

clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
clientSecretHeader
X-IBM-Client-Secret
(apiKey located in header)
access_token
Required in query
string / JSON

Mevris API token

data
Optional in body
object

Model instance data

Device
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

Request was successful

Device
Example Request
Example Response
POST https://api.us.apiconnect.ibmcloud.com/blueeastorientgmailcom-dev/sb/api/Devices
Try this operation
https://api.us.apiconnect.ibmcloud.com/blueeastorientgmailcom-dev/sb/api/Devices
content-type
accept
access_token

/Sites

get /Sites
Site
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
clientSecretHeader
X-IBM-Client-Secret
(apiKey located in header)
access_token
Required in query
string

Mevris API Token

Accept
Optional in header
string
application/json
200

Request was successful

x-any []
Example Request
Example Response
GET https://api.us.apiconnect.ibmcloud.com/blueeastorientgmailcom-dev/sb/api/Sites
Try this operation
https://api.us.apiconnect.ibmcloud.com/blueeastorientgmailcom-dev/sb/api/Sites
accept
access_token

/Sites/{id}

get /Sites/{id}
Site

Find a model instance by {{id}} from the data source.

clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
clientSecretHeader
X-IBM-Client-Secret
(apiKey located in header)
id
Required in path
string / JSON

Model id

filter
Optional in query
string / JSON

Filter defining fields and include - must be a JSON-encoded string ({"something":"value"})

access_token
Required in query
string

Mevris API Token

Accept
Optional in header
string
application/json
200

Request was successful

Site
Example Request
Example Response
GET https://api.us.apiconnect.ibmcloud.com/blueeastorientgmailcom-dev/sb/api/Sites/{id}
Try this operation
https://api.us.apiconnect.ibmcloud.com/blueeastorientgmailcom-dev/sb/api/Sites/{id}
accept
id
filter
access_token
patch /Sites/{id}
Site

Patch attributes for a model instance and persist it into the data source.

clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
clientSecretHeader
X-IBM-Client-Secret
(apiKey located in header)
data
Optional in body
object

An object of model property name/value pairs

Site
id
Required in path
string / JSON

Site id

access_token
Required in query
string

Mevris Access Token

Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

Request was successful

Site
Example Request
Example Response
PATCH https://api.us.apiconnect.ibmcloud.com/blueeastorientgmailcom-dev/sb/api/Sites/{id}
Try this operation
https://api.us.apiconnect.ibmcloud.com/blueeastorientgmailcom-dev/sb/api/Sites/{id}
content-type
accept
id
access_token

/ApiConnects/asset

post /ApiConnects/asset
ApiConnect
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
clientSecretHeader
X-IBM-Client-Secret
(apiKey located in header)
body
Required in body
object
{
    "schema": {
        "type": "object"
    }
}
access_token
Required in query
string
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

Request was successful

{
    "schema": {
        "type": "object",
        "properties": {
            "name": {
                "type": "string"
            },
            "state": {
                "type": "object"
            },
            "id": {
                "type": "string"
            },
            "ownerId": {
                "type": "string"
            },
            "createdAt": {
                "type": "string"
            },
            "updatedAt": {
                "type": "string"
            },
            "assetType": {
                "type": "string"
            },
            "site": {
                "type": "string"
            },
            "siteId": {
                "type": "string"
            }
        }
    }
}
Example Request
Example Response
POST https://api.us.apiconnect.ibmcloud.com/blueeastorientgmailcom-dev/sb/api/ApiConnects/asset
Try this operation
https://api.us.apiconnect.ibmcloud.com/blueeastorientgmailcom-dev/sb/api/ApiConnects/asset
content-type
accept
access_token
get /ApiConnects/asset
ApiConnect
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
clientSecretHeader
X-IBM-Client-Secret
(apiKey located in header)
name
Optional in query
string
limit
Optional in query
string

Default value is 10

offset
Optional in query
string

Default value is 0

access_token
Required in query
string
Accept
Optional in header
string
application/json
200

Request was successful

x-any []
Example Request
Example Response
GET https://api.us.apiconnect.ibmcloud.com/blueeastorientgmailcom-dev/sb/api/ApiConnects/asset
Try this operation
https://api.us.apiconnect.ibmcloud.com/blueeastorientgmailcom-dev/sb/api/ApiConnects/asset
accept
name
limit
offset
access_token

/ApiConnects/site

post /ApiConnects/site
ApiConnect
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
clientSecretHeader
X-IBM-Client-Secret
(apiKey located in header)
data
Required in body
object
Site
access_token
Required in query
string
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

Request was successful

Site
Example Request
Example Response
POST https://api.us.apiconnect.ibmcloud.com/blueeastorientgmailcom-dev/sb/api/ApiConnects/site
Try this operation
https://api.us.apiconnect.ibmcloud.com/blueeastorientgmailcom-dev/sb/api/ApiConnects/site
content-type
accept
access_token

/ApiConnects/asset/{id}

get /ApiConnects/asset/{id}
ApiConnect
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
clientSecretHeader
X-IBM-Client-Secret
(apiKey located in header)
id
Required in path
string
access_token
Required in query
string
Accept
Optional in header
string
application/json
200

Request was successful

{
    "schema": {
        "type": "object",
        "properties": {
            "name": {
                "type": "string"
            },
            "state": {
                "type": "object"
            },
            "id": {
                "type": "string"
            },
            "ownerId": {
                "type": "string"
            },
            "createdAt": {
                "type": "string"
            },
            "updatedAt": {
                "type": "string"
            },
            "assetType": {
                "type": "string"
            },
            "site": {
                "type": "string"
            },
            "siteId": {
                "type": "string"
            }
        }
    }
}
Example Request
Example Response
GET https://api.us.apiconnect.ibmcloud.com/blueeastorientgmailcom-dev/sb/api/ApiConnects/asset/{id}
Try this operation
https://api.us.apiconnect.ibmcloud.com/blueeastorientgmailcom-dev/sb/api/ApiConnects/asset/{id}
accept
id
access_token
put /ApiConnects/asset/{id}
ApiConnect
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
clientSecretHeader
X-IBM-Client-Secret
(apiKey located in header)
id
Required in path
string
body
Required in body
object
{
    "schema": {
        "type": "object"
    }
}
access_token
Required in query
string
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

Request was successful

{
    "schema": {
        "type": "object",
        "properties": {
            "name": {
                "type": "string"
            },
            "state": {
                "type": "object"
            },
            "id": {
                "type": "string"
            },
            "ownerId": {
                "type": "string"
            },
            "createdAt": {
                "type": "string"
            },
            "updatedAt": {
                "type": "string"
            },
            "assetType": {
                "type": "string"
            },
            "site": {
                "type": "string"
            },
            "siteId": {
                "type": "string"
            }
        }
    }
}
Example Request
Example Response
PUT https://api.us.apiconnect.ibmcloud.com/blueeastorientgmailcom-dev/sb/api/ApiConnects/asset/{id}
Try this operation
https://api.us.apiconnect.ibmcloud.com/blueeastorientgmailcom-dev/sb/api/ApiConnects/asset/{id}
content-type
accept
id
access_token

/ApiConnects/auth

post /ApiConnects/auth
ApiConnect

This end point is for Api Connect developers usage.

clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
clientSecretHeader
X-IBM-Client-Secret
(apiKey located in header)
credentials
Optional in body
object

Provide username OR email and password.

{
    "schema": {
        "description": "Provide username OR email and password.",
        "type": "object"
    }
}
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

Request was successful

{
    "schema": {
        "type": "string"
    }
}
Example Request
Example Response
POST https://api.us.apiconnect.ibmcloud.com/blueeastorientgmailcom-dev/sb/api/ApiConnects/auth
Try this operation
https://api.us.apiconnect.ibmcloud.com/blueeastorientgmailcom-dev/sb/api/ApiConnects/auth
content-type
accept

/ApiConnects/device/{macId}

get /ApiConnects/device/{macId}
ApiConnect
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
clientSecretHeader
X-IBM-Client-Secret
(apiKey located in header)
macId
Required in path
string
access_token
Required in query
string
Accept
Optional in header
string
application/json
200

Request was successful

Device
Example Request
Example Response
GET https://api.us.apiconnect.ibmcloud.com/blueeastorientgmailcom-dev/sb/api/ApiConnects/device/{macId}
Try this operation
https://api.us.apiconnect.ibmcloud.com/blueeastorientgmailcom-dev/sb/api/ApiConnects/device/{macId}
accept
macId
access_token

/Devices/{id}

put /Devices/{id}
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
clientSecretHeader
X-IBM-Client-Secret
(apiKey located in header)
id
Required in path
string

Id of device

access_token
Optional in query
string

Mevris Access Token

body
Optional in body
object

Updated Device

{
    "schema": {
        "type": "object"
    }
}
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

200 OK

Example Request
Example Response
PUT https://api.us.apiconnect.ibmcloud.com/blueeastorientgmailcom-dev/sb/api/Devices/{id}
Try this operation
https://api.us.apiconnect.ibmcloud.com/blueeastorientgmailcom-dev/sb/api/Devices/{id}
content-type
accept
id
access_token

/Events

post /Events
Event

Create a new instance of the model and persist it into the data source.

clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
clientSecretHeader
X-IBM-Client-Secret
(apiKey located in header)
data
Optional in body
object

Model instance data

Event
access_token
Required in query
string

Mevris Access Token

Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200

Request was successful

Event
Example Request
Example Response
POST https://api.us.apiconnect.ibmcloud.com/blueeastorientgmailcom-dev/sb/api/Events
Try this operation
https://api.us.apiconnect.ibmcloud.com/blueeastorientgmailcom-dev/sb/api/Events
content-type
accept
access_token

Definitions 

{
    "properties": []
}
              
{
    "properties": {
        "type": {
            "type": "string"
        },
        "data": {
            "type": "object"
        },
        "time": {
            "type": "string",
            "format": "date-time"
        },
        "meta": {
            "type": "object"
        },
        "response": {
            "type": "object"
        },
        "id": {
            "$ref": "#/definitions/ObjectID"
        },
        "sourceAccountId": {
            "$ref": "#/definitions/ObjectID"
        },
        "assetId": {
            "$ref": "#/definitions/ObjectID"
        },
        "deviceId": {
            "$ref": "#/definitions/ObjectID"
        },
        "createdAt": {
            "type": "string",
            "format": "date-time"
        },
        "updatedAt": {
            "type": "string",
            "format": "date-time"
        },
        "deletedAt": {
            "default": null,
            "type": "string",
            "format": "date-time"
        },
        "deleted": {
            "default": false,
            "type": "boolean"
        },
        "createdBy": {
            "type": "number",
            "format": "double"
        },
        "updatedBy": {
            "type": "number",
            "format": "double"
        },
        "deletedBy": {
            "type": "number",
            "format": "double"
        }
    },
    "required": [
        "type",
        "deleted"
    ],
    "additionalProperties": false
}
              
{
    "properties": {
        "id": {
            "$ref": "#/definitions/ObjectID"
        },
        "name": {
            "type": "string"
        },
        "active": {
            "default": true,
            "type": "boolean"
        },
        "isDeleted": {
            "default": false,
            "type": "boolean"
        },
        "location": {
            "$ref": "#/definitions/GeoPoint"
        },
        "image": {
            "type": "string"
        },
        "ownerId": {
            "$ref": "#/definitions/ObjectID"
        },
        "createdAt": {
            "type": "string",
            "format": "date-time"
        },
        "updatedAt": {
            "type": "string",
            "format": "date-time"
        },
        "deletedAt": {
            "default": null,
            "type": "string",
            "format": "date-time"
        },
        "deleted": {
            "default": false,
            "type": "boolean"
        },
        "createdBy": {
            "type": "number",
            "format": "double"
        },
        "updatedBy": {
            "type": "number",
            "format": "double"
        },
        "deletedBy": {
            "type": "number",
            "format": "double"
        },
        "siteType": {
            "$ref": "#/definitions/ObjectID",
            "type": "string",
            "description": "Could be \"Work\" or \"Home\""
        }
    },
    "required": [
        "name",
        "deleted",
        "siteType"
    ],
    "additionalProperties": false
}
              
{
    "type": "string",
    "pattern": "^[a-fA-F\\d]{24}$"
}
              
{
    "properties": {
        "lat": {
            "type": "number"
        },
        "lng": {
            "type": "number"
        }
    }
}