API docs by Redocly

Heyliot API (2.28.7)

Download OpenAPI specification:Download

Cyril Pradel: [email protected] URL: https://heyliot.com

Alert

List of alerts for a specified container

List of alerts for a specified container

Authorizations:
Bearer
path Parameters
container_id
required
string

Alert Container's ID

query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

order[createdAt]
string
Enum: "asc" "desc"
order[updatedAt]
string
Enum: "asc" "desc"
with
string

Add some attributes to response [alertDays]

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

List Alerts

List Alerts

Authorizations:
Bearer
path Parameters
organization_id
required
any

Alert Organization's ID

query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

order[createdAt]
string
Enum: "asc" "desc"
order[updatedAt]
string
Enum: "asc" "desc"
order[name]
string
Enum: "asc" "desc"

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Get a Alert

Get a Alert

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string"
}

AlertDay

Get a AlertDay

Get a AlertDay

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "day": 0,
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z"
}

Replaces the AlertDay

Replaces the AlertDay

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Request Body schema: application/ld+json

The updated AlertDay resource

day
required
integer
startTime
required
string <date-time>
endTime
required
string <date-time>

Responses

Request samples

Content type
application/ld+json
{
  • "day": 0,
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "day": 0,
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z"
}

Removes the AlertDay

Removes the AlertDay

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Responses

Updates partially a AlertDay

Updates partially a AlertDay

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Request Body schema: application/merge-patch+json

Any of the following attributes can be updated separately. At least one element is required.

any

Responses

Request samples

Content type
application/merge-patch+json
null

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string"
}

Creates a AlertDay

Creates a AlertDay

Authorizations:
Bearer
Request Body schema: application/ld+json

The new AlertDay resource

day
required
integer
startTime
required
string <date-time>
endTime
required
string <date-time>

Responses

Request samples

Content type
application/ld+json
{
  • "day": 0,
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "day": 0,
  • "startTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z"
}

App

Get a App

Get a App

Authorizations:
Bearer
path Parameters
key
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string"
}

Collects

List Collectss

List Collectss

Authorizations:
Bearer
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 1000 ]
Default: 30

The number of items per page

order[date]
string
date[gt]
string
Example: date[gt]=2020-01-01T00:00:00Z

Filter by date after datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

date[gte]
string
Example: date[gte]=2020-01-01T00:00:00Z

Filter by date after or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

date[lt]
string
Example: date[lt]=2020-01-01T00:00:00Z

Filter by date before datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

date[lte]
string
Example: date[lte]=2020-01-01T00:00:00Z

Filter by date before or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Get a Collects

Get a Collects

Authorizations:
Bearer
path Parameters
_id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "_id": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "levelBefore": 0,
  • "levelAfter": 0
}

List Collectss

List Collectss

Authorizations:
Bearer
path Parameters
container_id
required
string

Container's ID

query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 1000 ]
Default: 30

The number of items per page

order[date]
string
Default: "desc"
Enum: "asc" "desc"

Spectify this filter to change the order of the results

date[gt]
string
Example: date[gt]=2020-01-01T00:00:00Z

Filter by date after datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

date[gte]
string
Example: date[gte]=2020-01-01T00:00:00Z

Filter by date after or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

date[lt]
string
Example: date[lt]=2020-01-01T00:00:00Z

Filter by date before datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

date[lte]
string
Example: date[lte]=2020-01-01T00:00:00Z

Filter by date before or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Comment

Get a Comment

Get a Comment

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "content": "string",
  • "picture": "string",
  • "container": "/entity/1",
  • "sensor": "/entity/1",
  • "author": "/entity/1"
}

Replaces the Comment

Replaces the Comment

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Request Body schema: application/ld+json

The updated Comment resource

content
string
picture
string or null
container
string or null <iri-reference>
sensor
string or null <iri-reference>

Responses

Request samples

Content type
application/ld+json
{
  • "content": "string",
  • "picture": "string",
  • "container": "/entity/1",
  • "sensor": "/entity/1"
}

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "content": "string",
  • "picture": "string",
  • "container": "/entity/1",
  • "sensor": "/entity/1",
  • "author": "/entity/1"
}

Removes the Comment

Removes the Comment

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Responses

Updates partially a Comment

Updates partially a Comment

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Request Body schema: application/merge-patch+json

Any of the following attributes can be updated separately. At least one element is required.

any

Responses

Request samples

Content type
application/merge-patch+json
null

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string"
}

List Comments

List Comments

Authorizations:
Bearer
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a Comment

Creates a Comment

Authorizations:
Bearer
Request Body schema: application/ld+json

The new Comment resource

content
string
picture
string or null
container
string or null <iri-reference>
sensor
string or null <iri-reference>

Responses

Request samples

Content type
application/ld+json
{
  • "content": "string",
  • "picture": "string",
  • "container": "/entity/1",
  • "sensor": "/entity/1"
}

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "content": "string",
  • "picture": "string",
  • "container": "/entity/1",
  • "sensor": "/entity/1",
  • "author": "/entity/1"
}

List Comments

List Comments

Authorizations:
Bearer
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a Comment

Creates a Comment

Authorizations:
Bearer
Request Body schema: application/ld+json

The new Comment resource

content
string
picture
string or null
container
string or null <iri-reference>
sensor
string or null <iri-reference>

Responses

Request samples

Content type
application/ld+json
{
  • "content": "string",
  • "picture": "string",
  • "container": "/entity/1",
  • "sensor": "/entity/1"
}

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "content": "string",
  • "picture": "string",
  • "container": "/entity/1",
  • "sensor": "/entity/1",
  • "author": "/entity/1"
}

Container

Get a Container

Get a Container

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "longitude": 0,
  • "latitude": 0,
  • "geolocationRadius": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "active": true,
  • "note": "string",
  • "addressComment": "string",
  • "address": "string",
  • "zipCode": "string",
  • "city": "string",
  • "picture": "string",
  • "flow": "/entity/1",
  • "depositPoint": {
    },
  • "logisticStatus": "TO_EQUIP",
  • "geolocLongitude": 0,
  • "geolocLatitude": 0
}

Replaces the Container

Replaces the Container

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Request Body schema: application/ld+json

The updated Container resource

longitude
required
number
latitude
required
number
geolocationRadius
integer or null
name
required
string
active
boolean
Default: true
note
string or null
addressComment
string or null
Deprecated
address
string or null
zipCode
string or null
city
string or null
picture
string or null
flow
string or null <iri-reference>
group
required
string <iri-reference>
depositPoint
string or null <iri-reference>
model
string or null <iri-reference>
logisticStatus
required
string
Default: "TO_EQUIP"
geolocLongitude
number
Deprecated
geolocLatitude
number
Deprecated

Responses

Request samples

Content type
application/ld+json
{
  • "longitude": 0,
  • "latitude": 0,
  • "geolocationRadius": 0,
  • "name": "string",
  • "active": true,
  • "note": "string",
  • "addressComment": "string",
  • "address": "string",
  • "zipCode": "string",
  • "city": "string",
  • "picture": "string",
  • "flow": "/entity/1",
  • "group": "/entity/1",
  • "depositPoint": "/entity/1",
  • "model": "/entity/1",
  • "logisticStatus": "TO_EQUIP",
  • "geolocLongitude": 0,
  • "geolocLatitude": 0
}

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "longitude": 0,
  • "latitude": 0,
  • "geolocationRadius": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "active": true,
  • "note": "string",
  • "addressComment": "string",
  • "address": "string",
  • "zipCode": "string",
  • "city": "string",
  • "picture": "string",
  • "flow": "/entity/1",
  • "depositPoint": {
    },
  • "logisticStatus": "TO_EQUIP",
  • "geolocLongitude": 0,
  • "geolocLatitude": 0
}

Updates partially a Container

Updates partially a Container

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Request Body schema: application/merge-patch+json

Any of the following attributes can be updated separately. At least one element is required.

any

Responses

Request samples

Content type
application/merge-patch+json
null

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string"
}

List Containers by organization

List Containers by organization

Authorizations:
Bearer
path Parameters
organization_id
required
string

Container Organization's ID

query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 1000 ]
Default: 30

The number of items per page

withContractsActiveBetween
string

Filter containers which have contract active between two dates.
The contracts returned are only the active one between those dates.
Example: 2012-04-17,null | null,2020-05-09 | 2010-01-01T15:03:01,2020-01-01T15:03:01

orderByProximity
string

Order containers by proximity of the given position.
Example: 49.0154,-1.4568

active
boolean

Returns all active/unactive containers

groups
string

Returns the containers belonging to group(s) | 'id (or list) of groups' Example 'e278f932-d2bc-4996-b1c1-b93a3de8c388,f5eb953a-ed56-4875-a23b-a3e0e4affd26'

logisticStatus
string
tag
string

Name (or list) of container tag(s).
Example: EXT_1,EXT_2

order[name]
string
Enum: "asc" "desc"
order[active]
string
Enum: "asc" "desc"
order[createdAt]
string
Enum: "asc" "desc"
order[updatedAt]
string
Enum: "asc" "desc"
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string
name
string
with
string

Will add some attributes to response
Example: with=properties,contracts,group

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a Container

Creates a Container

Authorizations:
Bearer
Request Body schema: application/ld+json

The new Container resource

longitude
required
number
latitude
required
number
geolocationRadius
integer or null
name
required
string
active
boolean
Default: true
note
string or null
addressComment
string or null
Deprecated
address
string or null
zipCode
string or null
city
string or null
picture
string or null
flow
string or null <iri-reference>
group
required
string <iri-reference>
depositPoint
string or null <iri-reference>
model
string or null <iri-reference>
logisticStatus
required
string
Default: "TO_EQUIP"
geolocLongitude
number
Deprecated
geolocLatitude
number
Deprecated

Responses

Request samples

Content type
application/ld+json
{
  • "longitude": 0,
  • "latitude": 0,
  • "geolocationRadius": 0,
  • "name": "string",
  • "active": true,
  • "note": "string",
  • "addressComment": "string",
  • "address": "string",
  • "zipCode": "string",
  • "city": "string",
  • "picture": "string",
  • "flow": "/entity/1",
  • "group": "/entity/1",
  • "depositPoint": "/entity/1",
  • "model": "/entity/1",
  • "logisticStatus": "TO_EQUIP",
  • "geolocLongitude": 0,
  • "geolocLatitude": 0
}

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "longitude": 0,
  • "latitude": 0,
  • "geolocationRadius": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "active": true,
  • "note": "string",
  • "addressComment": "string",
  • "address": "string",
  • "zipCode": "string",
  • "city": "string",
  • "picture": "string",
  • "flow": "/entity/1",
  • "depositPoint": {
    },
  • "logisticStatus": "TO_EQUIP",
  • "geolocLongitude": 0,
  • "geolocLatitude": 0
}

List Containers by group

List Containers by group

Authorizations:
Bearer
path Parameters
group_id
required
string

Container Group's ID

query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 1000 ]
Default: 30

The number of items per page

withContractsActiveBetween
string

Filter containers which have contract active between two dates.
The contracts returned are only the active one between those dates.
Example: 2012-04-17,null | null,2020-05-09 | 2010-01-01T15:03:01,2020-01-01T15:03:01

orderByProximity
string

Order containers by proximity of the given position.
Example: 49.0154,-1.4568

active
boolean

Returns all active/unactive containers

groups
string
logisticStatus
string
tag
string

Name (or list) of container tag(s).
Example: EXT_1,EXT_2

order[name]
string
Enum: "asc" "desc"
order[active]
string
Enum: "asc" "desc"
order[createdAt]
string
Enum: "asc" "desc"
order[updatedAt]
string
Enum: "asc" "desc"
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string
name
string
with
string

Add some attributes to response [properties,contracts,group]

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Create a container

Create a container

Authorizations:
Bearer
path Parameters
group_id
required
string

Container Group's ID

Request Body schema: application/ld+json

The new Container resource

longitude
required
number
latitude
required
number
geolocationRadius
integer or null
name
required
string
active
boolean
Default: true
note
string or null
addressComment
string or null
Deprecated
address
string or null
zipCode
string or null
city
string or null
picture
string or null
flow
string or null <iri-reference>
group
required
string <iri-reference>
depositPoint
string or null <iri-reference>
model
string or null <iri-reference>
logisticStatus
required
string
Default: "TO_EQUIP"
geolocLongitude
number
Deprecated
geolocLatitude
number
Deprecated

Responses

Request samples

Content type
application/ld+json
{
  • "longitude": 0,
  • "latitude": 0,
  • "geolocationRadius": 0,
  • "name": "string",
  • "active": true,
  • "note": "string",
  • "addressComment": "string",
  • "address": "string",
  • "zipCode": "string",
  • "city": "string",
  • "picture": "string",
  • "flow": "/entity/1",
  • "group": "/entity/1",
  • "depositPoint": "/entity/1",
  • "model": "/entity/1",
  • "logisticStatus": "TO_EQUIP",
  • "geolocLongitude": 0,
  • "geolocLatitude": 0
}

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "longitude": 0,
  • "latitude": 0,
  • "geolocationRadius": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "active": true,
  • "note": "string",
  • "addressComment": "string",
  • "address": "string",
  • "zipCode": "string",
  • "city": "string",
  • "picture": "string",
  • "flow": "/entity/1",
  • "depositPoint": {
    },
  • "logisticStatus": "TO_EQUIP",
  • "geolocLongitude": 0,
  • "geolocLatitude": 0
}

List Containers

List Containers

Authorizations:
Bearer
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a Container

Creates a Container

Authorizations:
Bearer
Request Body schema: application/ld+json

The new Container resource

longitude
required
number
latitude
required
number
geolocationRadius
integer or null
name
required
string
active
boolean
Default: true
note
string or null
addressComment
string or null
Deprecated
address
string or null
zipCode
string or null
city
string or null
picture
string or null
flow
string or null <iri-reference>
group
required
string <iri-reference>
depositPoint
string or null <iri-reference>
model
string or null <iri-reference>
logisticStatus
required
string
Default: "TO_EQUIP"
geolocLongitude
number
Deprecated
geolocLatitude
number
Deprecated

Responses

Request samples

Content type
application/ld+json
{
  • "longitude": 0,
  • "latitude": 0,
  • "geolocationRadius": 0,
  • "name": "string",
  • "active": true,
  • "note": "string",
  • "addressComment": "string",
  • "address": "string",
  • "zipCode": "string",
  • "city": "string",
  • "picture": "string",
  • "flow": "/entity/1",
  • "group": "/entity/1",
  • "depositPoint": "/entity/1",
  • "model": "/entity/1",
  • "logisticStatus": "TO_EQUIP",
  • "geolocLongitude": 0,
  • "geolocLatitude": 0
}

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "longitude": 0,
  • "latitude": 0,
  • "geolocationRadius": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "active": true,
  • "note": "string",
  • "addressComment": "string",
  • "address": "string",
  • "zipCode": "string",
  • "city": "string",
  • "picture": "string",
  • "flow": "/entity/1",
  • "depositPoint": {
    },
  • "logisticStatus": "TO_EQUIP",
  • "geolocLongitude": 0,
  • "geolocLatitude": 0
}

Add Tag to Container

Add Tag to Container

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

tagId
required
string
Example: unclear-boundaries

Tag ID

Responses

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "longitude": 0,
  • "latitude": 0,
  • "geolocationRadius": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "active": true,
  • "note": "string",
  • "addressComment": "string",
  • "address": "string",
  • "zipCode": "string",
  • "city": "string",
  • "picture": "string",
  • "flow": "/entity/1",
  • "depositPoint": {
    },
  • "logisticStatus": "TO_EQUIP",
  • "geolocLongitude": 0,
  • "geolocLatitude": 0
}

Remove Tag from Container

Remove Tag from Container

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

tagId
required
string
Example: container-lost

Tag ID

Responses

List Containers by alert

List Containers by alert

Authorizations:
Bearer
path Parameters
alert_id
required
string

Container Alert's ID

query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

name
string
active
boolean

Returns all active/unactive containers

groups
string

Returns the containers belonging to group(s) | 'id (or list) of groups' Example 'e278f932-d2bc-4996-b1c1-b93a3de8c388,f5eb953a-ed56-4875-a23b-a3e0e4affd26'

order[name]
string
Enum: "asc" "desc"
order[active]
string
Enum: "asc" "desc"
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string
with
string

Will add some attributes to response
Example: with=properties,contracts,group

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

ContainerBrand

List ContainerBrands

List ContainerBrands

Authorizations:
Bearer
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

order[createdAt]
string
Enum: "asc" "desc"
order[updatedAt]
string
Enum: "asc" "desc"
order[name]
string
Enum: "asc" "desc"

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Get a ContainerBrand

Get a ContainerBrand

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string"
}

ContainerModel

List ContainerModels

List ContainerModels

Authorizations:
Bearer
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

order[default]
string
Enum: "asc" "desc"
order[name]
string
Enum: "asc" "desc"
order[brand.name]
string
Enum: "asc" "desc"
order[createdAt]
string
Enum: "asc" "desc"
order[updatedAt]
string
Enum: "asc" "desc"

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

List ContainerModels

List ContainerModels

Authorizations:
Bearer
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

order[default]
string
Enum: "asc" "desc"
order[name]
string
Enum: "asc" "desc"
order[brand.name]
string
Enum: "asc" "desc"
order[createdAt]
string
Enum: "asc" "desc"
order[updatedAt]
string
Enum: "asc" "desc"

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Get a ContainerModel

Get a ContainerModel

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "name": "string",
  • "reference": "string",
  • "type": "string",
  • "default": true,
  • "properties": {
    }
}

Replaces the ContainerModel

Replaces the ContainerModel

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Request Body schema: application/ld+json

The updated ContainerModel resource

Responses

Request samples

Content type
application/ld+json
{ }

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "name": "string",
  • "reference": "string",
  • "type": "string",
  • "default": true,
  • "properties": {
    }
}

Updates partially a ContainerModel

Updates partially a ContainerModel

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Request Body schema: application/merge-patch+json

Any of the following attributes can be updated separately. At least one element is required.

any

Responses

Request samples

Content type
application/merge-patch+json
null

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string"
}

ContainerViews

List ContainerViews by organization

List ContainerViews by organization

Authorizations:
Bearer
path Parameters
organization_id
required
string

Container Organization's ID

query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 500 ]
Default: 30

The number of items per page

lastFillLevel[gt]
int
Example: lastFillLevel[gt]=50

Filter by lastFillLevel greater than the value.

lastFillLevel[gte]
int
Example: lastFillLevel[gte]=50

Filter by lastFillLevel greater than or equal to the value.

lastFillLevel[lt]
int
Example: lastFillLevel[lt]=50

Filter by lastFillLevel less than the value.

lastFillLevel[lte]
int
Example: lastFillLevel[lte]=50

Filter by lastFillLevel less than or equal to the value.

lastFillLevelDate[gt]
string
Example: lastFillLevelDate[gt]=2020-01-01T00:00:00Z

Filter by lastFillLevelDate after datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

lastFillLevelDate[gte]
string
Example: lastFillLevelDate[gte]=2020-01-01T00:00:00Z

Filter by lastFillLevelDate after or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

lastFillLevelDate[lt]
string
Example: lastFillLevelDate[lt]=2020-01-01T00:00:00Z

Filter by lastFillLevelDate before datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

lastFillLevelDate[lte]
string
Example: lastFillLevelDate[lte]=2020-01-01T00:00:00Z

Filter by lastFillLevelDate before or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

lastCommunication[gt]
string
Example: lastCommunication[gt]=2020-01-01T00:00:00Z

Filter by lastCommunication after datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

lastCommunication[gte]
string
Example: lastCommunication[gte]=2020-01-01T00:00:00Z

Filter by lastCommunication after or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

lastCommunication[lt]
string
Example: lastCommunication[lt]=2020-01-01T00:00:00Z

Filter by lastCommunication before datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

lastCommunication[lte]
string
Example: lastCommunication[lte]=2020-01-01T00:00:00Z

Filter by lastCommunication before or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

active
string
groupId
string
modelId
string
organizationId
string
logisticStatus
string

logisticStatus

flow
string
tags
string
hasActiveContract
string
groupName
string
properties.PROPERTY_NAME
string
Enum: "asc" "desc"

PROPERTY_NAME has to be replace for example by CONTAINER_FLOW or any other property

order[active]
string
Enum: "asc" "desc"
order[flow]
string
order[updatedAt]
string
Enum: "asc" "desc"
order[createdAt]
string
Enum: "asc" "desc"
order[lastCommunication]
string
order[lastFillLevel]
string
Enum: "asc" "desc"
order[lastFillLevelDate]
string
Enum: "asc" "desc"
order[name]
string
Enum: "asc" "desc"
order[groupName]
string
Enum: "asc" "desc"
order[organizationName]
string
order[properties.PROPERTY_NAME]
string

PROPERTY_NAME has to be replace for example by CONTAINER_FLOW or any other property

order[lastCollect.date]
string
search
string

Partial and non-case sensitive search by name, groupName, addressComment or sensorId.

orderByProximity
string

Order containersViews by proximity of the given position.
Example: 49.0154,-1.4568

nullProperty
string

Filter documents where the specified property is null.

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

List ContainerViewss

List ContainerViewss

Authorizations:
Bearer
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 500 ]
Default: 30

The number of items per page

lastFillLevel[gt]
int
Example: lastFillLevel[gt]=50

Filter by lastFillLevel greater than the value.

lastFillLevel[gte]
int
Example: lastFillLevel[gte]=50

Filter by lastFillLevel greater than or equal to the value.

lastFillLevel[lt]
int
Example: lastFillLevel[lt]=50

Filter by lastFillLevel less than the value.

lastFillLevel[lte]
int
Example: lastFillLevel[lte]=50

Filter by lastFillLevel less than or equal to the value.

lastFillLevelDate[gt]
string
Example: lastFillLevelDate[gt]=2020-01-01T00:00:00Z

Filter by lastFillLevelDate after datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

lastFillLevelDate[gte]
string
Example: lastFillLevelDate[gte]=2020-01-01T00:00:00Z

Filter by lastFillLevelDate after or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

lastFillLevelDate[lt]
string
Example: lastFillLevelDate[lt]=2020-01-01T00:00:00Z

Filter by lastFillLevelDate before datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

lastFillLevelDate[lte]
string
Example: lastFillLevelDate[lte]=2020-01-01T00:00:00Z

Filter by lastFillLevelDate before or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

lastCommunication[gt]
string
Example: lastCommunication[gt]=2020-01-01T00:00:00Z

Filter by lastCommunication after datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

lastCommunication[gte]
string
Example: lastCommunication[gte]=2020-01-01T00:00:00Z

Filter by lastCommunication after or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

lastCommunication[lt]
string
Example: lastCommunication[lt]=2020-01-01T00:00:00Z

Filter by lastCommunication before datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

lastCommunication[lte]
string
Example: lastCommunication[lte]=2020-01-01T00:00:00Z

Filter by lastCommunication before or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

active
string
groupId
string
modelId
string
organizationId
string
logisticStatus
string
flow
string
tags
string
hasActiveContract
string
groupName
string
properties.PROPERTY_NAME
string
order[active]
string
order[flow]
string
order[updatedAt]
string
order[createdAt]
string
order[lastCommunication]
string
order[lastFillLevel]
string
order[lastFillLevelDate]
string
order[name]
string
order[groupName]
string
order[organizationName]
string
order[properties.PROPERTY_NAME]
string
order[lastCollect.date]
string
search
string

Partial and non-case sensitive search by name, groupName, addressComment or sensorId.

orderByProximity
string

Order containerViews closest from the given position.
Example: 49.0154,-1.4568

nullProperty
string

Filter documents where the specified property is null.

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Get a ContainerViews

Get a ContainerViews

Authorizations:
Bearer
path Parameters
container_id
required
string

Container's ID

Responses

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "_id": "string",
  • "id": "string",
  • "name": "string",
  • "logisticStatus": "string",
  • "longitude": 0,
  • "latitude": 0,
  • "properties": [
    ],
  • "addressComment": "string",
  • "note": "string",
  • "picture": "string",
  • "flow": "string",
  • "active": true,
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastFillLevel": 0,
  • "lastCollect": [
    ],
  • "lastCommunication": "2019-08-24T14:15:22Z",
  • "lastFillLevelDate": "2019-08-24T14:15:22Z",
  • "isManualFillLevel": true,
  • "hasActiveContract": true
}

Contract

List Contracts

List Contracts

Authorizations:
Bearer
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

order[createdAt]
string
Enum: "asc" "desc"
order[updatedAt]
string
Enum: "asc" "desc"
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string
active
boolean

Filter active contracts

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

List Contracts

List Contracts

Authorizations:
Bearer
path Parameters
container_id
required
string

Contract Container's ID

query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

order[createdAt]
string
Enum: "asc" "desc"
order[updatedAt]
string
Enum: "asc" "desc"
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string
active
boolean

Filter active contracts

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a Contract

Creates a Contract

Authorizations:
Bearer
path Parameters
container_id
required
string

Contract Container's ID

Request Body schema: application/ld+json

The new Contract resource

startedAt
required
string or null <date-time>
endedAt
string or null <date-time>
timezone
string
Default: "Europe/Paris"
sensor
required
string <iri-reference>

Responses

Request samples

Content type
application/ld+json
{
  • "startedAt": "2019-08-24T14:15:22Z",
  • "endedAt": "2019-08-24T14:15:22Z",
  • "timezone": "Europe/Paris",
  • "sensor": "/entity/1"
}

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "endedAt": "2019-08-24T14:15:22Z",
  • "timezone": "Europe/Paris",
  • "container": {
    },
  • "sensor": {
    },
  • "active": true
}

List Contracts

List Contracts

Authorizations:
Bearer
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

order[createdAt]
string
Enum: "asc" "desc"
order[updatedAt]
string
Enum: "asc" "desc"
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string
active
boolean

Filter active contracts

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Get a Contract

Get a Contract

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "endedAt": "2019-08-24T14:15:22Z",
  • "timezone": "Europe/Paris",
  • "container": {
    },
  • "sensor": {
    },
  • "active": true
}

Replaces the Contract

Replaces the Contract

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Request Body schema: application/ld+json

The updated Contract resource

startedAt
required
string or null <date-time>
endedAt
string or null <date-time>
timezone
string
Default: "Europe/Paris"
sensor
required
string <iri-reference>

Responses

Request samples

Content type
application/ld+json
{
  • "startedAt": "2019-08-24T14:15:22Z",
  • "endedAt": "2019-08-24T14:15:22Z",
  • "timezone": "Europe/Paris",
  • "sensor": "/entity/1"
}

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "startedAt": "2019-08-24T14:15:22Z",
  • "endedAt": "2019-08-24T14:15:22Z",
  • "timezone": "Europe/Paris",
  • "container": {
    },
  • "sensor": {
    },
  • "active": true
}

Updates partially a Contract

Updates partially a Contract

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Request Body schema: application/merge-patch+json

Any of the following attributes can be updated separately. At least one element is required.

any

Responses

Request samples

Content type
application/merge-patch+json
null

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string"
}

List Contracts

List Contracts

Authorizations:
Bearer
path Parameters
serial_number
required
string

Contract Sensor's serial number

query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

order[createdAt]
string
Enum: "asc" "desc"
order[updatedAt]
string
Enum: "asc" "desc"
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string
active
boolean

Filter active contracts

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

DepositPoint

List Deposit Points by organization

List Deposit Points by organization

Authorizations:
Bearer
path Parameters
organization_id
required
any

Organization's ID

query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

assigned
string
name
string

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a DepositPoint

Creates a DepositPoint

Authorizations:
Bearer
Request Body schema: application/ld+json

The new DepositPoint resource

name
required
string
latitude
required
number
longitude
required
number
address
required
string

Responses

Request samples

Content type
application/ld+json
{
  • "name": "string",
  • "latitude": 0,
  • "longitude": 0,
  • "address": "string"
}

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "latitude": 0,
  • "longitude": 0,
  • "address": "string"
}

Get a DepositPoint

Get a DepositPoint

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "latitude": 0,
  • "longitude": 0,
  • "address": "string",
  • "containers": [
    ]
}

Removes the DepositPoint

Removes the DepositPoint

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Responses

Updates partially a DepositPoint

Updates partially a DepositPoint

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Request Body schema: application/merge-patch+json

Any of the following attributes can be updated separately. At least one element is required.

any

Responses

Request samples

Content type
application/merge-patch+json
null

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string"
}

Events

List Events by container

List Events by container

Authorizations:
Bearer
path Parameters
container_id
required
string

Container's ID

query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

order[date]
string
date[gt]
string
Example: date[gt]=2020-01-01T00:00:00Z

Filter by date after datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

date[gte]
string
Example: date[gte]=2020-01-01T00:00:00Z

Filter by date after or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

date[lt]
string
Example: date[lt]=2020-01-01T00:00:00Z

Filter by date before datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

date[lte]
string
Example: date[lte]=2020-01-01T00:00:00Z

Filter by date before or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

type
string
byUserId
string

Filter by byUserId.

metadata.key
string
metadata.value
string

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

List Events by organization

List Events by organization

Authorizations:
Bearer
path Parameters
organization_id
required
string

Events Organization's ID

query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

order[date]
string
date[gt]
string
Example: date[gt]=2020-01-01T00:00:00Z

Filter by date after datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

date[gte]
string
Example: date[gte]=2020-01-01T00:00:00Z

Filter by date after or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

date[lt]
string
Example: date[lt]=2020-01-01T00:00:00Z

Filter by date before datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

date[lte]
string
Example: date[lte]=2020-01-01T00:00:00Z

Filter by date before or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

type
string
byUserId
string

Filter by byUserId.

metadata.key
string
metadata.value
string

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

List Events by sensor

List Events by sensor

Authorizations:
Bearer
path Parameters
sensor_id
required
string

Events Sensor's ID

query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

order[date]
string
date[gt]
string
Example: date[gt]=2020-01-01T00:00:00Z

Filter by date after datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

date[gte]
string
Example: date[gte]=2020-01-01T00:00:00Z

Filter by date after or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

date[lt]
string
Example: date[lt]=2020-01-01T00:00:00Z

Filter by date before datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

date[lte]
string
Example: date[lte]=2020-01-01T00:00:00Z

Filter by date before or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

type
string
byUserId
string

Filter by byUserId.

metadata.key
string
metadata.value
string

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Export

Export de mesures de contenants en masse dans un fichier excel

Export de mesures de contenants en masse dans un fichier excel avec un mois d'intervale entre la dernère date et la date d'aujourd'hui

Authorizations:
Bearer
Request Body schema: application/json
containers
required
Array of strings

Array of containers ID

startDate
required
DateTime as ISO String, or one of 'Y-m-d' or 'Y-m-dThh:i:s\Z' or 'Y-m-dThh:i:s.SSS\Z', timestamp

Start Time for the export of measures

endDate
required
DateTime as ISO String, or one of 'Y-m-d' or 'Y-m-dThh:i:s\Z' or 'Y-m-dThh:i:s.SSS\Z', timestamp

End Time for the export of measures

email
required
email

The email where to send the exports

Request samples

Content type
application/json
{
  • "containers": [
    ],
  • "startDate": null,
  • "endDate": null,
  • "email": null
}

FillLevelStasisAlert

List FillLevelStasisAlerts

List FillLevelStasisAlerts

Authorizations:
Bearer
path Parameters
organization_id
required
any

Alert Organization's ID

query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

order[createdAt]
string
Enum: "asc" "desc"
order[updatedAt]
string
Enum: "asc" "desc"
order[name]
string
Enum: "asc" "desc"

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

List of alerts for a specified container

List of alerts for a specified container

Authorizations:
Bearer
path Parameters
container_id
required
string

Alert Container's ID

query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

order[createdAt]
string
Enum: "asc" "desc"
order[updatedAt]
string
Enum: "asc" "desc"
with
string

Add some attributes to response [alertDays]

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

List FillLevelStasisAlerts

List FillLevelStasisAlerts

Authorizations:
Bearer
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a FillLevelStasisAlert

Creates a FillLevelStasisAlert

Authorizations:
Bearer
Request Body schema: application/ld+json

The new FillLevelStasisAlert resource

maxGap
required
number

The trigger related with the threshold to ring the alert

triggerPeriod
required
integer

How many time the fillLevel must be stable to trigger the alert (in hours)

name
required
string
Default: "notification"
alertDays
Array of strings <iri-reference>
containers
required
Array of strings <iri-reference>
mutedTime
required
integer
Default: 24
notificationChannels
required
Array of strings
Default: "a:1:{i:0;s:5:\"EMAIL\";}"
externalRecipientPhones
Array of strings
externalRecipientEmails
Array of strings
message
string

Responses

Request samples

Content type
application/ld+json
{
  • "maxGap": 0,
  • "triggerPeriod": 0,
  • "name": "notification",
  • "alertDays": [
    ],
  • "containers": [
    ],
  • "mutedTime": 24,
  • "notificationChannels": "a:1:{i:0;s:5:\"EMAIL\";}",
  • "externalRecipientPhones": [
    ],
  • "externalRecipientEmails": [
    ],
  • "message": "string"
}

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "maxGap": 0,
  • "triggerPeriod": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "notification",
  • "mutedTime": 24,
  • "notificationChannels": "a:1:{i:0;s:5:\"EMAIL\";}",
  • "externalRecipientPhones": [
    ],
  • "externalRecipientEmails": [
    ],
  • "message": "string"
}

Get a FillLevelStasisAlert

Get a FillLevelStasisAlert

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "maxGap": 0,
  • "triggerPeriod": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "notification",
  • "alertDays": [
    ],
  • "containers": [
    ],
  • "mutedTime": 24,
  • "notificationChannels": "a:1:{i:0;s:5:\"EMAIL\";}",
  • "externalRecipientPhones": [
    ],
  • "externalRecipientEmails": [
    ],
  • "message": "string"
}

Replaces the FillLevelStasisAlert

Replaces the FillLevelStasisAlert

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Request Body schema: application/ld+json

The updated FillLevelStasisAlert resource

maxGap
required
number

The trigger related with the threshold to ring the alert

triggerPeriod
required
integer

How many time the fillLevel must be stable to trigger the alert (in hours)

name
required
string
Default: "notification"
alertDays
Array of strings <iri-reference>
containers
required
Array of strings <iri-reference>
mutedTime
required
integer
Default: 24
notificationChannels
required
Array of strings
Default: "a:1:{i:0;s:5:\"EMAIL\";}"
externalRecipientPhones
Array of strings
externalRecipientEmails
Array of strings
message
string

Responses

Request samples

Content type
application/ld+json
{
  • "maxGap": 0,
  • "triggerPeriod": 0,
  • "name": "notification",
  • "alertDays": [
    ],
  • "containers": [
    ],
  • "mutedTime": 24,
  • "notificationChannels": "a:1:{i:0;s:5:\"EMAIL\";}",
  • "externalRecipientPhones": [
    ],
  • "externalRecipientEmails": [
    ],
  • "message": "string"
}

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "maxGap": 0,
  • "triggerPeriod": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "notification",
  • "alertDays": [
    ],
  • "containers": [
    ],
  • "mutedTime": 24,
  • "notificationChannels": "a:1:{i:0;s:5:\"EMAIL\";}",
  • "externalRecipientPhones": [
    ],
  • "externalRecipientEmails": [
    ],
  • "message": "string"
}

Removes the FillLevelStasisAlert

Removes the FillLevelStasisAlert

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Responses

Updates partially a FillLevelStasisAlert

Updates partially a FillLevelStasisAlert

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Request Body schema: application/merge-patch+json

Any of the following attributes can be updated separately. At least one element is required.

any

Responses

Request samples

Content type
application/merge-patch+json
null

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string"
}

FillLevelThresholdAlert

List FillLevelThresholdAlerts

List FillLevelThresholdAlerts

Authorizations:
Bearer
path Parameters
organization_id
required
any

Alert Organization's ID

query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

order[createdAt]
string
Enum: "asc" "desc"
order[updatedAt]
string
Enum: "asc" "desc"
order[name]
string
Enum: "asc" "desc"

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Get a FillLevelThresholdAlert

Get a FillLevelThresholdAlert

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "trigger": "string",
  • "threshold": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "notification",
  • "alertDays": [
    ],
  • "containers": [
    ],
  • "mutedTime": 24,
  • "notificationChannels": "a:1:{i:0;s:5:\"EMAIL\";}",
  • "externalRecipientPhones": [
    ],
  • "externalRecipientEmails": [
    ],
  • "message": "string"
}

Replaces the FillLevelThresholdAlert

Replaces the FillLevelThresholdAlert

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Request Body schema: application/ld+json

The updated FillLevelThresholdAlert resource

trigger
required
string

The trigger related with the threshold to ring the alert

threshold
required
number

The threshold when the alert will be triggered

name
required
string
Default: "notification"
alertDays
Array of strings <iri-reference>
containers
required
Array of strings <iri-reference>
mutedTime
required
integer
Default: 24
notificationChannels
required
Array of strings
Default: "a:1:{i:0;s:5:\"EMAIL\";}"
externalRecipientPhones
Array of strings
externalRecipientEmails
Array of strings
message
string

Responses

Request samples

Content type
application/ld+json
{
  • "trigger": "string",
  • "threshold": 0,
  • "name": "notification",
  • "alertDays": [
    ],
  • "containers": [
    ],
  • "mutedTime": 24,
  • "notificationChannels": "a:1:{i:0;s:5:\"EMAIL\";}",
  • "externalRecipientPhones": [
    ],
  • "externalRecipientEmails": [
    ],
  • "message": "string"
}

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "trigger": "string",
  • "threshold": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "notification",
  • "alertDays": [
    ],
  • "containers": [
    ],
  • "mutedTime": 24,
  • "notificationChannels": "a:1:{i:0;s:5:\"EMAIL\";}",
  • "externalRecipientPhones": [
    ],
  • "externalRecipientEmails": [
    ],
  • "message": "string"
}

Removes the FillLevelThresholdAlert

Removes the FillLevelThresholdAlert

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Responses

Updates partially a FillLevelThresholdAlert

Updates partially a FillLevelThresholdAlert

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Request Body schema: application/merge-patch+json

Any of the following attributes can be updated separately. At least one element is required.

any

Responses

Request samples

Content type
application/merge-patch+json
null

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string"
}

List of alerts for a specified container

List of alerts for a specified container

Authorizations:
Bearer
path Parameters
container_id
required
string

Alert Container's ID

query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

order[createdAt]
string
Enum: "asc" "desc"
order[updatedAt]
string
Enum: "asc" "desc"
with
string

Add some attributes to response [alertDays]

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

List FillLevelThresholdAlerts

List FillLevelThresholdAlerts

Authorizations:
Bearer
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a FillLevelThresholdAlert

Creates a FillLevelThresholdAlert

Authorizations:
Bearer
Request Body schema: application/ld+json

The new FillLevelThresholdAlert resource

trigger
required
string

The trigger related with the threshold to ring the alert

threshold
required
number

The threshold when the alert will be triggered

name
required
string
Default: "notification"
alertDays
Array of strings <iri-reference>
containers
required
Array of strings <iri-reference>
mutedTime
required
integer
Default: 24
notificationChannels
required
Array of strings
Default: "a:1:{i:0;s:5:\"EMAIL\";}"
externalRecipientPhones
Array of strings
externalRecipientEmails
Array of strings
message
string

Responses

Request samples

Content type
application/ld+json
{
  • "trigger": "string",
  • "threshold": 0,
  • "name": "notification",
  • "alertDays": [
    ],
  • "containers": [
    ],
  • "mutedTime": 24,
  • "notificationChannels": "a:1:{i:0;s:5:\"EMAIL\";}",
  • "externalRecipientPhones": [
    ],
  • "externalRecipientEmails": [
    ],
  • "message": "string"
}

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "trigger": "string",
  • "threshold": 0,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "notification",
  • "mutedTime": 24,
  • "notificationChannels": "a:1:{i:0;s:5:\"EMAIL\";}",
  • "externalRecipientPhones": [
    ],
  • "externalRecipientEmails": [
    ],
  • "message": "string"
}

FillLevels

List FillLevelss

List FillLevelss

Authorizations:
Bearer
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 1000 ]
Default: 30

The number of items per page

date[gt]
string
Example: date[gt]=2020-01-01T00:00:00Z

Filter by date after datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

date[gte]
string
Example: date[gte]=2020-01-01T00:00:00Z

Filter by date after or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

date[lt]
string
Example: date[lt]=2020-01-01T00:00:00Z

Filter by date before datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

date[lte]
string
Example: date[lte]=2020-01-01T00:00:00Z

Filter by date before or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

updatedAt[gt]
string
Example: updatedAt[gt]=2020-01-01T00:00:00Z

Filter by updatedAt after datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

updatedAt[gte]
string
Example: updatedAt[gte]=2020-01-01T00:00:00Z

Filter by updatedAt after or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

updatedAt[lt]
string
Example: updatedAt[lt]=2020-01-01T00:00:00Z

Filter by updatedAt before datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

updatedAt[lte]
string
Example: updatedAt[lte]=2020-01-01T00:00:00Z

Filter by updatedAt before or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

order[date]
string
order[updatedAt]
string

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

List FillLevelss

List FillLevelss

Authorizations:
Bearer
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 10000 ]
Default: 30

The number of items per page

date[gt]
string
Example: date[gt]=2020-01-01T00:00:00Z

Filter by date after datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

date[gte]
string
Example: date[gte]=2020-01-01T00:00:00Z

Filter by date after or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

date[lt]
string
Example: date[lt]=2020-01-01T00:00:00Z

Filter by date before datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

date[lte]
string
Example: date[lte]=2020-01-01T00:00:00Z

Filter by date before or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

updatedAt[gt]
string
Example: updatedAt[gt]=2020-01-01T00:00:00Z

Filter by updatedAt after datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

updatedAt[gte]
string
Example: updatedAt[gte]=2020-01-01T00:00:00Z

Filter by updatedAt after or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

updatedAt[lt]
string
Example: updatedAt[lt]=2020-01-01T00:00:00Z

Filter by updatedAt before datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

updatedAt[lte]
string
Example: updatedAt[lte]=2020-01-01T00:00:00Z

Filter by updatedAt before or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

order[date]
string
order[updatedAt]
string

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

List FillLevelss

List FillLevelss

Authorizations:
Bearer
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 10000 ]
Default: 30

The number of items per page

date[gt]
string
Example: date[gt]=2020-01-01T00:00:00Z

Filter by date after datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

date[gte]
string
Example: date[gte]=2020-01-01T00:00:00Z

Filter by date after or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

date[lt]
string
Example: date[lt]=2020-01-01T00:00:00Z

Filter by date before datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

date[lte]
string
Example: date[lte]=2020-01-01T00:00:00Z

Filter by date before or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

updatedAt[gt]
string
Example: updatedAt[gt]=2020-01-01T00:00:00Z

Filter by updatedAt after datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

updatedAt[gte]
string
Example: updatedAt[gte]=2020-01-01T00:00:00Z

Filter by updatedAt after or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

updatedAt[lt]
string
Example: updatedAt[lt]=2020-01-01T00:00:00Z

Filter by updatedAt before datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

updatedAt[lte]
string
Example: updatedAt[lte]=2020-01-01T00:00:00Z

Filter by updatedAt before or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

order[date]
string
order[updatedAt]
string

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Flow

List Flows

List Flows

Authorizations:
Bearer
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

List Flows

List Flows

Authorizations:
Bearer
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Get a Flow

Get a Flow

Authorizations:
Bearer
path Parameters
key
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "description": "string",
  • "key": "string",
  • "color": "string"
}

Replaces the Flow

Replaces the Flow

Authorizations:
Bearer
path Parameters
key
required
string

Resource identifier

Request Body schema: application/ld+json

The updated Flow resource

color
string

Responses

Request samples

Content type
application/ld+json
{
  • "color": "string"
}

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "description": "string",
  • "key": "string",
  • "color": "string"
}

Removes the Flow

Removes the Flow

Authorizations:
Bearer
path Parameters
key
required
string

Resource identifier

Responses

Updates partially a Flow

Updates partially a Flow

Authorizations:
Bearer
path Parameters
key
required
string

Resource identifier

Request Body schema: application/merge-patch+json

Any of the following attributes can be updated separately. At least one element is required.

any

Responses

Request samples

Content type
application/merge-patch+json
null

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string"
}

Group

List Groups

List Groups

Authorizations:
Bearer
path Parameters
organization_id
required
any

Group's Organization ID

query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

parent
string
parent[]
Array of strings
order[name]
string
Enum: "asc" "desc"
order[createdAt]
string
Enum: "asc" "desc"
order[updatedAt]
string
Enum: "asc" "desc"

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a Group

Creates a Group

Authorizations:
Bearer
path Parameters
organization_id
required
any

Group's Organization ID

Request Body schema: application/ld+json

The new Group resource

default
boolean
name
string
Group-Group.rw_Group.write_Group.write.collection (object)

The parent group

Responses

Request samples

Content type
application/ld+json
{
  • "default": true,
  • "name": "string",
  • "parent": { }
}

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "default": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "parent": { },
  • "organization": "/entity/1"
}

Get a Group

Get a Group

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "default": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "children": [
    ],
  • "parent": { },
  • "organization": "/entity/1",
  • "containers": [
    ]
}

Replaces the Group

Replaces the Group

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Request Body schema: application/ld+json

The updated Group resource

default
boolean
name
string
Group-Group.rw_Group.write_Group.write.item (object)

The parent group

Responses

Request samples

Content type
application/ld+json
{
  • "default": true,
  • "name": "string",
  • "parent": { }
}

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "default": true,
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "children": [
    ],
  • "parent": { },
  • "organization": "/entity/1",
  • "containers": [
    ]
}

Removes the Group

Removes the Group

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Responses

Updates partially a Group

Updates partially a Group

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Request Body schema: application/merge-patch+json

Any of the following attributes can be updated separately. At least one element is required.

any

Responses

Request samples

Content type
application/merge-patch+json
null

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string"
}

GroupAreaAlert

List GroupAreaAlerts

List GroupAreaAlerts

Authorizations:
Bearer
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

order[createdAt]
string
Enum: "asc" "desc"
order[updatedAt]
string
Enum: "asc" "desc"

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Get a GroupAreaAlert

Get a GroupAreaAlert

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "notification",
  • "alertDays": [
    ],
  • "mutedTime": 24,
  • "notificationChannels": "a:1:{i:0;s:5:\"EMAIL\";}",
  • "externalRecipientPhones": [
    ],
  • "externalRecipientEmails": [
    ],
  • "message": "string"
}

Replaces the GroupAreaAlert

Replaces the GroupAreaAlert

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Request Body schema: application/ld+json

The updated GroupAreaAlert resource

name
required
string
Default: "notification"
alertDays
Array of strings <iri-reference>
mutedTime
required
integer
Default: 24
notificationChannels
required
Array of strings
Default: "a:1:{i:0;s:5:\"EMAIL\";}"
externalRecipientPhones
Array of strings
externalRecipientEmails
Array of strings
message
string

Responses

Request samples

Content type
application/ld+json
{
  • "name": "notification",
  • "alertDays": [
    ],
  • "mutedTime": 24,
  • "notificationChannels": "a:1:{i:0;s:5:\"EMAIL\";}",
  • "externalRecipientPhones": [
    ],
  • "externalRecipientEmails": [
    ],
  • "message": "string"
}

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "notification",
  • "alertDays": [
    ],
  • "mutedTime": 24,
  • "notificationChannels": "a:1:{i:0;s:5:\"EMAIL\";}",
  • "externalRecipientPhones": [
    ],
  • "externalRecipientEmails": [
    ],
  • "message": "string"
}

Removes the GroupAreaAlert

Removes the GroupAreaAlert

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Responses

Updates partially a GroupAreaAlert

Updates partially a GroupAreaAlert

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Request Body schema: application/merge-patch+json

Any of the following attributes can be updated separately. At least one element is required.

any

Responses

Request samples

Content type
application/merge-patch+json
null

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "notification",
  • "alertDays": [
    ],
  • "mutedTime": 24,
  • "notificationChannels": "a:1:{i:0;s:5:\"EMAIL\";}",
  • "externalRecipientPhones": [
    ],
  • "externalRecipientEmails": [
    ],
  • "message": "string"
}

List GroupAreaAlerts

List GroupAreaAlerts

Authorizations:
Bearer
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a GroupAreaAlert

Creates a GroupAreaAlert

Authorizations:
Bearer
Request Body schema: application/ld+json

The new GroupAreaAlert resource

name
required
string
Default: "notification"
alertDays
Array of strings <iri-reference>
mutedTime
required
integer
Default: 24
notificationChannels
required
Array of strings
Default: "a:1:{i:0;s:5:\"EMAIL\";}"
externalRecipientPhones
Array of strings
externalRecipientEmails
Array of strings
message
string

Responses

Request samples

Content type
application/ld+json
{
  • "name": "notification",
  • "alertDays": [
    ],
  • "mutedTime": 24,
  • "notificationChannels": "a:1:{i:0;s:5:\"EMAIL\";}",
  • "externalRecipientPhones": [
    ],
  • "externalRecipientEmails": [
    ],
  • "message": "string"
}

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "notification",
  • "mutedTime": 24,
  • "notificationChannels": "a:1:{i:0;s:5:\"EMAIL\";}",
  • "externalRecipientPhones": [
    ],
  • "externalRecipientEmails": [
    ],
  • "message": "string"
}

List GroupAreaAlerts

List GroupAreaAlerts

Authorizations:
Bearer
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

order[createdAt]
string
Enum: "asc" "desc"
order[updatedAt]
string
Enum: "asc" "desc"
order[name]
string
Enum: "asc" "desc"

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Indicator

List Indicators

List Indicators

Authorizations:
Bearer
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Get a Indicator

Get a Indicator

Authorizations:
Bearer
path Parameters
organization_id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "type": null,
  • "unit": "string",
  • "value": null
}

Get a Indicator

Get a Indicator

Authorizations:
Bearer
path Parameters
container_id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "type": null,
  • "unit": "string",
  • "value": null
}

Get a Indicator

Get a Indicator

Authorizations:
Bearer
path Parameters
group_id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "type": null,
  • "unit": "string",
  • "value": null
}

KpiWidget

List KpiWidgets

List KpiWidgets

Authorizations:
Bearer
path Parameters
organization_id
required
any

Widget's Organization ID

query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

order[createdAt]
string
Enum: "asc" "desc"
order[updatedAt]
string
Enum: "asc" "desc"

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a KpiWidget

Creates a KpiWidget

Authorizations:
Bearer
Request Body schema: application/ld+json

The new KpiWidget resource

context
required
string
type
required
string
label
string
dateRangeType
required
string
organization
string or null <iri-reference>
group
string or null <iri-reference>
flow
string or null <iri-reference>
containers
Array of strings <iri-reference>
threshold
integer or null

Responses

Request samples

Content type
application/ld+json
{
  • "context": "string",
  • "type": "string",
  • "label": "string",
  • "dateRangeType": "string",
  • "organization": "/entity/1",
  • "group": "/entity/1",
  • "flow": "/entity/1",
  • "containers": [
    ],
  • "threshold": 0
}

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "context": "string",
  • "type": "string",
  • "label": "string",
  • "dateRangeType": "string",
  • "flow": "/entity/1",
  • "threshold": 0
}

List KpiWidgets

List KpiWidgets

Authorizations:
Bearer
path Parameters
group_id
required
any

Widget's Group ID

query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

order[createdAt]
string
Enum: "asc" "desc"
order[updatedAt]
string
Enum: "asc" "desc"

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Get a KpiWidget

Get a KpiWidget

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "context": "string",
  • "type": "string",
  • "label": "string",
  • "dateRangeType": "string",
  • "organization": "/entity/1",
  • "group": "/entity/1",
  • "flow": "/entity/1",
  • "containers": [
    ],
  • "threshold": 0
}

Removes the KpiWidget

Removes the KpiWidget

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Responses

Updates partially a KpiWidget

Updates partially a KpiWidget

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Request Body schema: application/merge-patch+json

Any of the following attributes can be updated separately. At least one element is required.

any

Responses

Request samples

Content type
application/merge-patch+json
null

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string"
}

List KpiWidgets

List KpiWidgets

Authorizations:
Bearer
path Parameters
container_id
required
any

Widget's Container ID

query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Language

Get a Language

Get a Language

Authorizations:
Bearer
path Parameters
isoCode
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "isoCode": "string",
  • "name": "string",
  • "enName": "string"
}

List Languages

List Languages

Authorizations:
Bearer
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

order[name]
string
Enum: "asc" "desc"
name
string

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Measures

List Measuress

List Measuress

Authorizations:
Bearer
path Parameters
container_id
required
string

Container's ID

query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 1000 ]
Default: 30

The number of items per page

order[measureDate]
string
Default: "desc"
Enum: "asc" "desc"

Spectify this filter to change the order of the results

calculationPeriod
string
Default: "two_hours"
Enum: "two_hours" "day" "week" "month"
Example: calculationPeriod=day

Spectify this filter to change the order of the results.

calculationPeriod[]
string
Default: "two_hours"
Enum: "two_hours" "day" "week" "month"
Example: calculationPeriod[]=two_hours&calculationPeriod[]=day

Use this filter if you want to get different calculation period in the same result set.

measureDate[gt]
string
Example: measureDate[gt]=2020-01-01T00:00:00Z

Filter by measureDate after datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

measureDate[gte]
string
Example: measureDate[gte]=2020-01-01T00:00:00Z

Filter by measureDate after or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

measureDate[lt]
string
Example: measureDate[lt]=2020-01-01T00:00:00Z

Filter by measureDate before datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

measureDate[lte]
string
Example: measureDate[lte]=2020-01-01T00:00:00Z

Filter by measureDate before or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

List Measuress

List Measuress

Authorizations:
Bearer
path Parameters
container_id
required
string

Container's ID

query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 10000 ]
Default: 30

The number of items per page

order[measureDate]
string
Default: "desc"
Enum: "asc" "desc"

Spectify this filter to change the order of the results

calculationPeriod
string
Default: "two_hours"
Enum: "two_hours" "day" "week" "month"
Example: calculationPeriod=day

Spectify this filter to change the order of the results.

calculationPeriod[]
string
Default: "two_hours"
Enum: "two_hours" "day" "week" "month"
Example: calculationPeriod[]=two_hours&calculationPeriod[]=day

Use this filter if you want to get different calculation period in the same result set.

measureDate[gt]
string
Example: measureDate[gt]=2020-01-01T00:00:00Z

Filter by measureDate after datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

measureDate[gte]
string
Example: measureDate[gte]=2020-01-01T00:00:00Z

Filter by measureDate after or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

measureDate[lt]
string
Example: measureDate[lt]=2020-01-01T00:00:00Z

Filter by measureDate before datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

measureDate[lte]
string
Example: measureDate[lte]=2020-01-01T00:00:00Z

Filter by measureDate before or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

List Measuress

List Measuress

Authorizations:
Bearer
path Parameters
container_id
required
string

Container's ID

query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 10000 ]
Default: 30

The number of items per page

order[measureDate]
string
Default: "desc"
Enum: "asc" "desc"

Spectify this filter to change the order of the results

calculationPeriod
string
Default: "two_hours"
Enum: "two_hours" "day" "week" "month"
Example: calculationPeriod=day

Spectify this filter to change the order of the results.

calculationPeriod[]
string
Default: "two_hours"
Enum: "two_hours" "day" "week" "month"
Example: calculationPeriod[]=two_hours&calculationPeriod[]=day

Use this filter if you want to get different calculation period in the same result set.

measureDate[gt]
string
Example: measureDate[gt]=2020-01-01T00:00:00Z

Filter by measureDate after datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

measureDate[gte]
string
Example: measureDate[gte]=2020-01-01T00:00:00Z

Filter by measureDate after or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

measureDate[lt]
string
Example: measureDate[lt]=2020-01-01T00:00:00Z

Filter by measureDate before datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

measureDate[lte]
string
Example: measureDate[lte]=2020-01-01T00:00:00Z

Filter by measureDate before or at datetime.
The Date can be a timestamp one of following formats: yyyy-mm-dd yyyy-mm-ddThh:ii:ssZ

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Organization

Get a Organization

Get a Organization

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "groups": [
    ],
  • "users": [
    ],
  • "children": [
    ],
  • "parent": { },
  • "defaultTimezone": "Europe/Paris",
  • "models": [
    ],
  • "flows": [
    ]
}

Replaces the Organization

Replaces the Organization

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Request Body schema: application/ld+json

The updated Organization resource

name
string
crmCustomerId
string or null
Organization-Organization.rw_Organization.write_Organization.write.item (object)

The "mother" organization of an organization

models
Array of strings <iri-reference>
flows
Array of strings <iri-reference>

Responses

Request samples

Content type
application/ld+json
{
  • "name": "string",
  • "crmCustomerId": "string",
  • "parent": { },
  • "models": [
    ],
  • "flows": [
    ]
}

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "groups": [
    ],
  • "users": [
    ],
  • "children": [
    ],
  • "parent": { },
  • "defaultTimezone": "Europe/Paris",
  • "models": [
    ],
  • "flows": [
    ]
}

Removes the Organization

Removes the Organization

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Responses

Updates partially a Organization

Updates partially a Organization

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Request Body schema: application/merge-patch+json

Any of the following attributes can be updated separately. At least one element is required.

any

Responses

Request samples

Content type
application/merge-patch+json
null

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string"
}

List Organizations

List Organizations

Authorizations:
Bearer
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

crmCustomerId
string
crmCustomerId[]
Array of strings
maintenanceLevel
integer
maintenanceLevel[]
Array of integers
order[name]
string
Enum: "asc" "desc"
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string
order[createdAt]
string
Enum: "asc" "desc"
order[updatedAt]
string
Enum: "asc" "desc"
tag
string

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Profile

Get a Profile

Get a Profile

Authorizations:
Bearer
path Parameters
name
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "createUser": 0,
  • "readUser": 0,
  • "updateUser": 0,
  • "deleteUser": 0,
  • "createOrganization": 0,
  • "readOrganization": 0,
  • "updateOrganization": 0,
  • "deleteOrganization": 0,
  • "createSensor": 0,
  • "readSensor": 0,
  • "updateSensor": 0,
  • "deleteSensor": 0,
  • "createContainer": 0,
  • "readContainer": 0,
  • "updateContainer": 0,
  • "deleteContainer": 0,
  • "name": "string",
  • "deleteAlert": null,
  • "createAlertDays": null,
  • "createAlert": null,
  • "readAlertDays": null,
  • "readAlert": null,
  • "updateAlertDays": null,
  • "updateAlert": null,
  • "deleteAlertDays": null,
  • "createContract": null,
  • "readContract": null,
  • "updateContract": null,
  • "deleteContract": null,
  • "createKpiWidget": null,
  • "readKpiWidget": null,
  • "updateKpiWidget": null,
  • "deleteKpiWidget": null,
  • "createGroup": null,
  • "readGroup": null,
  • "updateGroup": null,
  • "deleteGroup": null
}

List Profiles

List Profiles

Authorizations:
Bearer
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Sensor

List Sensors

List Sensors

Authorizations:
Bearer
path Parameters
organization_id
required
string

Sensor's Organization ID

query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

type
string
Example: type=HEYLIOT

Filter by sensor type

liveObjectId
string
sigfoxId
string
serialNumber
string
tag
string

Name (or list) of sensor tag(s).
Example: EXT_1,EXT_2'

order[createdAt]
string
Enum: "asc" "desc"
order[updatedAt]
string
Enum: "asc" "desc"
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string
with
string

Will add some attributes to response
Example: with=monitor,contracts,activeContract

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a Sensor

Creates a Sensor

Authorizations:
Bearer
path Parameters
organization_id
required
string

Sensor's Organization ID

Request Body schema: application/ld+json

The new Sensor resource

longitude
number or null
latitude
number or null
geolocationRadius
integer or null
serialNumber
required
string
type
required
string
Default: "HEYLIOT"
status
required
string
liveObjectId
string or null
sigfoxId
string or null
imei
string or null
version
required
string
softwareVersion
string or null
sensorConfiguration
string or null <iri-reference>
tags
Array of strings <iri-reference>

Responses

Request samples

Content type
application/ld+json
{
  • "longitude": 0,
  • "latitude": 0,
  • "geolocationRadius": 0,
  • "serialNumber": "string",
  • "type": "HEYLIOT",
  • "status": "string",
  • "liveObjectId": "string",
  • "sigfoxId": "string",
  • "imei": "string",
  • "version": "string",
  • "softwareVersion": "string",
  • "sensorConfiguration": "/entity/1",
  • "tags": [
    ]
}

Response samples

Content type
application/ld+json
{
  • "@id": "string",
  • "@type": "string",
  • "@context": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "serialNumber": "string",
  • "type": "HEYLIOT",
  • "status": "string",
  • "liveObjectId": "string",
  • "sigfoxId": "string",
  • "imei": "string",
  • "version": "string",
  • "softwareVersion": "string",
  • "sensorConfiguration": "/entity/1",
  • "lastSyncSuccess": true,
  • "organization": "/entity/1",
  • "loraId": "string"
}

Get a Sensor

Get a Sensor

Authorizations:
Bearer
path Parameters
serialNumber
required
string

Resource identifier

query Parameters
with
string

Will add some attributes to response
Example: with=monitor,contracts,activeContract,goelocation

Responses

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "serialNumber": "string",
  • "type": "HEYLIOT",
  • "status": "string",
  • "liveObjectId": "string",
  • "sigfoxId": "string",
  • "imei": "string",
  • "version": "string",
  • "softwareVersion": "string",
  • "sensorConfiguration": {
    },
  • "lastSyncSuccess": true,
  • "organization": "/entity/1",
  • "contracts": [
    ],
  • "loraId": "string",
  • "activeContract": "/entity/1",
  • "latestContract": "/entity/1"
}

Replaces the Sensor

Replaces the Sensor

Authorizations:
Bearer
path Parameters
serialNumber
required
string

Resource identifier

Request Body schema: application/ld+json

The updated Sensor resource

longitude
number or null
latitude
number or null
geolocationRadius
integer or null
serialNumber
required
string
type
required
string
Default: "HEYLIOT"
status
required
string
liveObjectId
string or null
sigfoxId
string or null
imei
string or null
version
required
string
softwareVersion
string or null
sensorConfiguration
string or null <iri-reference>
tags
Array of strings <iri-reference>

Responses

Request samples

Content type
application/ld+json
{
  • "longitude": 0,
  • "latitude": 0,
  • "geolocationRadius": 0,
  • "serialNumber": "string",
  • "type": "HEYLIOT",
  • "status": "string",
  • "liveObjectId": "string",
  • "sigfoxId": "string",
  • "imei": "string",
  • "version": "string",
  • "softwareVersion": "string",
  • "sensorConfiguration": "/entity/1",
  • "tags": [
    ]
}

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "serialNumber": "string",
  • "type": "HEYLIOT",
  • "status": "string",
  • "liveObjectId": "string",
  • "sigfoxId": "string",
  • "imei": "string",
  • "version": "string",
  • "softwareVersion": "string",
  • "sensorConfiguration": {
    },
  • "lastSyncSuccess": true,
  • "organization": "/entity/1",
  • "contracts": [
    ],
  • "loraId": "string",
  • "activeContract": "/entity/1",
  • "latestContract": "/entity/1"
}

Removes the Sensor

Removes the Sensor

Authorizations:
Bearer
path Parameters
serialNumber
required
string

Resource identifier

Responses

Updates partially a Sensor

Updates partially a Sensor

Authorizations:
Bearer
path Parameters
serialNumber
required
string

Resource identifier

Request Body schema: application/merge-patch+json

Any of the following attributes can be updated separately. At least one element is required.

any

Responses

Request samples

Content type
application/merge-patch+json
null

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string"
}

Add Tag to Sensor

Add Tag to Sensor

Authorizations:
Bearer
path Parameters
serialNumber
required
string

Resource identifier

tagId
required
string
Example: sensor-lost

Tag ID

Responses

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "serialNumber": "string",
  • "type": "HEYLIOT",
  • "status": "string",
  • "liveObjectId": "string",
  • "sigfoxId": "string",
  • "imei": "string",
  • "version": "string",
  • "softwareVersion": "string",
  • "sensorConfiguration": {
    },
  • "lastSyncSuccess": true,
  • "organization": "/entity/1",
  • "contracts": [
    ],
  • "loraId": "string",
  • "activeContract": "/entity/1",
  • "latestContract": "/entity/1"
}

Remove Tag from Sensor

Remove Tag from Sensor

Authorizations:
Bearer
path Parameters
serialNumber
required
string

Resource identifier

tagId
required
string
Example: sensor-lost

Tag ID

Responses

SensorConfiguration

Get a SensorConfiguration

Get a SensorConfiguration

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "default": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "activePhaseStartAt": "2019-08-24T14:15:22Z",
  • "activePhasePeriod": 0,
  • "inactivePhaseStartAt": "2019-08-24T14:15:22Z",
  • "inactivePhasePeriod": 0,
  • "measurePerSending": 0,
  • "dailyConfigTime": "2019-08-24T14:15:22Z",
  • "distanceMode": "string",
  • "anglePosition": 0,
  • "timingBudget": 0,
  • "roiX": 0,
  • "roiY": 0,
  • "organization": "/entity/1"
}

List SensorConfigurations

List SensorConfigurations

Authorizations:
Bearer
path Parameters
organization_id
required
string

SensorConfiguration Organization's ID

query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

order[createdAt]
string
Enum: "asc" "desc"
order[updatedAt]
string
Enum: "asc" "desc"
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a SensorConfiguration

Creates a SensorConfiguration

Authorizations:
Bearer
Request Body schema: application/ld+json

The new SensorConfiguration resource

default
boolean
name
required
string
activePhaseStartAt
required
string <date-time>
activePhasePeriod
required
integer
inactivePhaseStartAt
required
string <date-time>
inactivePhasePeriod
required
integer
measurePerSending
required
integer
dailyConfigTime
required
string <date-time>
distanceMode
required
string
anglePosition
required
integer
timingBudget
required
integer
roiX
required
integer
roiY
required
integer

Responses

Request samples

Content type
application/ld+json
{
  • "default": true,
  • "name": "string",
  • "activePhaseStartAt": "2019-08-24T14:15:22Z",
  • "activePhasePeriod": 0,
  • "inactivePhaseStartAt": "2019-08-24T14:15:22Z",
  • "inactivePhasePeriod": 0,
  • "measurePerSending": 0,
  • "dailyConfigTime": "2019-08-24T14:15:22Z",
  • "distanceMode": "string",
  • "anglePosition": 0,
  • "timingBudget": 0,
  • "roiX": 0,
  • "roiY": 0
}

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "default": true,
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "activePhaseStartAt": "2019-08-24T14:15:22Z",
  • "activePhasePeriod": 0,
  • "inactivePhaseStartAt": "2019-08-24T14:15:22Z",
  • "inactivePhasePeriod": 0,
  • "measurePerSending": 0,
  • "dailyConfigTime": "2019-08-24T14:15:22Z",
  • "distanceMode": "string",
  • "anglePosition": 0,
  • "timingBudget": 0,
  • "roiX": 0,
  • "roiY": 0,
  • "organization": "/entity/1"
}

SensorMonitors

Get a SensorMonitors

Get a SensorMonitors

Authorizations:
Bearer
path Parameters
serial_number
required
string

Sensor's ID

Responses

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "_id": "string",
  • "hasActiveContract": true,
  • "sensorId": "string",
  • "lastPeriodicalMeasure": [
    ],
  • "lastManualMeasure": [
    ],
  • "lastCalibrationMeasure": [
    ],
  • "lastFirstUplink": [
    ]
}

ServiceApiKey

Get a ServiceApiKey

Get a ServiceApiKey

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
null

List ServiceApiKeys

List ServiceApiKeys

Authorizations:
Bearer
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

Responses

Response samples

Content type
application/ld+json
null

Tag

Get a Tag

Get a Tag

Authorizations:
Bearer
path Parameters
name
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "description": "string",
  • "name": "string",
  • "isFeatureFlag": true,
  • "organizations": [
    ],
  • "containers": [
    ],
  • "sensors": [
    ]
}

Updates partially a Tag

Updates partially a Tag

Authorizations:
Bearer
path Parameters
name
required
string

The tag name

Request Body schema: application/merge-patch+json

Any of the following attributes can be updated separately. At least one element is required.

any

Responses

Request samples

Content type
application/merge-patch+json
null

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string"
}

List Tags

List Tags

Authorizations:
Bearer
path Parameters
organization_id
required
string

Organization's tags

query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

List Tags

List Tags

Authorizations:
Bearer
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

User

Ask for password reset

Ask for password reset

Authorizations:
Bearer
Request Body schema: application/json
email
required
string

The email address of the concerned user

Responses

Request samples

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

Response samples

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

List Users

List Users

Authorizations:
Bearer
path Parameters
organization_id
required
any

User Organization's ID

query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 100 ]
Default: 30

The number of items per page

order[firstName]
string
Enum: "asc" "desc"
order[lastName]
string
Enum: "asc" "desc"
order[email]
string
Enum: "asc" "desc"
email
string
email[]
Array of strings
profile
string

Responses

Response samples

Content type
application/ld+json
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a User

Creates a User

Authorizations:
Bearer
path Parameters
organization_id
required
any

User's Organization ID

Request Body schema: application/ld+json

The new User resource

firstName
required
string
lastName
required
string
email
required
phone
string or null
password
string
organization
string <iri-reference>
language
string <iri-reference>
profile
string <iri-reference>
apps
Array of strings <iri-reference>
allowedGroups
Array of strings <iri-reference>
forceChangePassword
boolean
resetToken
string or null

Responses

Request samples

Content type
application/ld+json
{
  • "firstName": "string",
  • "lastName": "string",
  • "email": "[email protected]",
  • "phone": "string",
  • "password": "string",
  • "organization": "/entity/1",
  • "language": "/entity/1",
  • "profile": "/entity/1",
  • "apps": [
    ],
  • "allowedGroups": [
    ],
  • "forceChangePassword": true,
  • "resetToken": "string"
}

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "[email protected]",
  • "phone": "string",
  • "language": {
    },
  • "profile": "/entity/1",
  • "allowedGroups": [
    ],
  • "username": "string"
}

Get a User

Get a User

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "[email protected]",
  • "phone": "string",
  • "organization": {
    },
  • "language": {
    },
  • "profile": {
    },
  • "apps": [
    ],
  • "allowedGroups": [
    ],
  • "forceChangePassword": true,
  • "resetToken": "string",
  • "username": "string"
}

Replaces the User

Replaces the User

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Request Body schema: application/ld+json

The updated User resource

firstName
required
string
lastName
required
string
email
required
phone
string or null
password
string
organization
string <iri-reference>
language
string <iri-reference>
profile
string <iri-reference>
apps
Array of strings <iri-reference>
allowedGroups
Array of strings <iri-reference>
forceChangePassword
boolean
resetToken
string or null

Responses

Request samples

Content type
application/ld+json
{
  • "firstName": "string",
  • "lastName": "string",
  • "email": "[email protected]",
  • "phone": "string",
  • "password": "string",
  • "organization": "/entity/1",
  • "language": "/entity/1",
  • "profile": "/entity/1",
  • "apps": [
    ],
  • "allowedGroups": [
    ],
  • "forceChangePassword": true,
  • "resetToken": "string"
}

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "firstName": "string",
  • "lastName": "string",
  • "email": "[email protected]",
  • "phone": "string",
  • "organization": {
    },
  • "language": {
    },
  • "profile": {
    },
  • "apps": [
    ],
  • "allowedGroups": [
    ],
  • "forceChangePassword": true,
  • "resetToken": "string",
  • "username": "string"
}

Removes the User

Removes the User

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Responses

Updates partially a User

Updates partially a User

Authorizations:
Bearer
path Parameters
id
required
string

Resource identifier

Request Body schema: application/merge-patch+json

Any of the following attributes can be updated separately. At least one element is required.

any

Responses

Request samples

Content type
application/merge-patch+json
null

Response samples

Content type
application/ld+json
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string"
}