API docs by Redocly

Provoly Hypervisor API (1.0.0)

Download OpenAPI specification:

CRUD Operation on repositories data

Event Controller

Retrieve all events with pagination

Default sort on status (NEW,IN_PROGRESS,DONE), criticality (HIGH,MEDIUM,LOW) and lastModificationDate (reversed). It's possible to override it by sorting on other attributes. If order is no provided when sort, the default is asc. It's possible to filter on one or more criticalities, statuses, categories, sources, equipment entities or equipment families. It's possible to search on event id, event name or equipment name.

Authorizations:
oidc
query Parameters
page
integer
Example: page=1

Page number requested, default to 1. Trigger an error if not specified or if 0.

pageSize
integer
Example: pageSize=20

Page size, default to 20. Return an empty list if not specified.

creationDate
string
Example: creationDate=2024-01-20T00:00:00Z

The date must be set to midnight. The filter will return all events created on that day.

closeDate
string
Example: closeDate=2024-01-20T10:09:00Z

Filter on closed events where closeDate is greater or equal than closeDate in query

criticality
Array of strings (Criticality)
Items Enum: "LOW" "MEDIUM" "HIGH"
Example: criticality=LOW
status
Array of strings (Status)
Items Enum: "NEW" "IN_PROGRESS" "DONE"
Example: status=NEW
category
Array of strings
Example: category=LIMIT

Event category code. It must be known to the system

entity
Array of strings
Example: entity=CHALONS-COMMUN

The equipment entity name. It must be known to the system.

family
Array of strings
Example: family=EP_ARMOIRE&family=VP_CAM

The equipment family code. It must be known to the system.

sort
string (EventSort)
Enum: "creationDate" "lastModificationDate" "status" "procedureProgress" "criticality" "name" "category" "id" "source"
order
string (SortOrder)
Default: "ASC"
Enum: "ASC" "DESC"
name
string
Example: name=00001

search on event name

id
string
Example: id=00001

search on event id

equipment
string
Example: equipment=c-A

search on equipment name of event

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Save an event

Events may come from the Hypervisor (internal event), or from an external source (external event). Internal events must have a creator, and it's source is automatically 'Hyperviseur'. External events must have an externalSourceRef. by default, InternalEventWriteDto is deserialized. If creator and externalSourceRef are presents, then the source is ignored, and if none of these properties are present, then an error is raised, saying that the creator is missing. It's possible to set an externalId for external events, in order to update event if already exists instead of save it (used for nodered flows). MANIFESTATION category, startDate and endDate properties are necessary. endDate can't be before startDate. ANOMALY category requires sub categories.

Authorizations:
oidc
Request Body schema: application/json
id
required
integer
name
required
string
address
string
description
required
string
domain
string
criticality
required
string (Criticality)
Enum: "LOW" "MEDIUM" "HIGH"
category
required
string

Value match one of category code

subCategory
string

required only if ANOMALY is set on cateogry property. Value match one of subCategory code.

equipmentId
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
endDate
string <date-time> (DateTime)
startDate
string <date-time> (DateTime)
parent
integer

Parent event

creator
string

Event creator, required if event is created from Hypervisor

externalSourceRef
string

Event source, required if event is external

externalId
string

If event is external, it's possible to provide an external id

Responses

Request samples

Content type
application/json
{
  • "id": 2,
  • "name": "Dépôt sauvage",
  • "address": "3 rue de Châlons",
  • "description": "Il y a un dépôt sauvage ici",
  • "domain": "EP",
  • "criticality": "LOW",
  • "category": "ANOMALY",
  • "subCategory": "WILD_STORAGE",
  • "equipmentId": "ebbfbbd1-b8de-467c-8a9b-88443a49f807",
  • "endDate": "2024-02-20T08:30:00.00Z",
  • "startDate": "2024-02-20T08:30:00.00Z",
  • "parent": 3,
  • "creator": "toto",
  • "externalSourceRef": "Citylinx",
  • "externalId": "string"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Défaillance lampe",
  • "address": "Av. du Président Roosevelt, 51000 Châlons-en-Champagne",
  • "description": "Défaillance au niveau de la lampe",
  • "domain": "EP",
  • "criticality": "LOW",
  • "equipment": {
    },
  • "status": "NEW",
  • "category": "OUTOFORDER",
  • "subCategory": "string",
  • "lastModificationDate": "2024-02-20T08:30:00.00Z",
  • "creationDate": "2024-02-20T08:30:00.00Z",
  • "closeDate": "2024-02-20T08:30:00.00Z",
  • "endDate": "2024-02-20T08:30:00.00Z",
  • "startDate": "2024-02-20T08:30:00.00Z",
  • "externalSourceRef": "Citylinx",
  • "procedureId": "ebbfbbd1-b8de-467c-8a9b-88443a49f807",
  • "linkedEvents": 0,
  • "procedureProgress": 0,
  • "lastComment": {
    },
  • "commentsCount": 0,
  • "parent": {
    }
}

Retrieve event by id

Authorizations:
oidc
path Parameters
id
required
integer
Example: 21

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Défaillance lampe",
  • "address": "Av. du Président Roosevelt, 51000 Châlons-en-Champagne",
  • "description": "Défaillance au niveau de la lampe",
  • "domain": "EP",
  • "criticality": "LOW",
  • "equipment": {
    },
  • "status": "NEW",
  • "category": "OUTOFORDER",
  • "subCategory": "string",
  • "lastModificationDate": "2024-02-20T08:30:00.00Z",
  • "creationDate": "2024-02-20T08:30:00.00Z",
  • "closeDate": "2024-02-20T08:30:00.00Z",
  • "endDate": "2024-02-20T08:30:00.00Z",
  • "startDate": "2024-02-20T08:30:00.00Z",
  • "externalSourceRef": "Citylinx",
  • "procedureId": "ebbfbbd1-b8de-467c-8a9b-88443a49f807",
  • "linkedEvents": 0,
  • "procedureProgress": 0,
  • "lastComment": {
    },
  • "commentsCount": 0,
  • "parent": {
    }
}

Update an event

It's possible to update any events, but events with an external source have non-modifiable properties: category, subCategory, name and externalId.

Authorizations:
oidc
path Parameters
id
required
integer
Example: 1
Request Body schema: application/json
id
required
integer
name
required
string
address
string
description
required
string
domain
string
criticality
required
string (Criticality)
Enum: "LOW" "MEDIUM" "HIGH"
category
required
string

Value match one of category code

subCategory
string

required only if ANOMALY is set on cateogry property. Value match one of subCategory code.

equipmentId
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
endDate
string <date-time> (DateTime)
startDate
string <date-time> (DateTime)
parent
integer

Parent event

creator
string

Event creator, required if event is created from Hypervisor

externalSourceRef
string

Event source, required if event is external

externalId
string

If event is external, it's possible to provide an external id

Responses

Request samples

Content type
application/json
{
  • "id": 2,
  • "name": "Dépôt sauvage",
  • "address": "3 rue de Châlons",
  • "description": "Il y a un dépôt sauvage ici",
  • "domain": "EP",
  • "criticality": "LOW",
  • "category": "ANOMALY",
  • "subCategory": "WILD_STORAGE",
  • "equipmentId": "ebbfbbd1-b8de-467c-8a9b-88443a49f807",
  • "endDate": "2024-02-20T08:30:00.00Z",
  • "startDate": "2024-02-20T08:30:00.00Z",
  • "parent": 3,
  • "creator": "toto",
  • "externalSourceRef": "Citylinx",
  • "externalId": "string"
}

Retrieve event by it's source and external id

Authorizations:
oidc
path Parameters
source
required
string
Example: Citylinx
id
required
string
Example: 21ad9

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "Défaillance lampe",
  • "address": "Av. du Président Roosevelt, 51000 Châlons-en-Champagne",
  • "description": "Défaillance au niveau de la lampe",
  • "domain": "EP",
  • "criticality": "LOW",
  • "equipment": {
    },
  • "status": "NEW",
  • "category": "OUTOFORDER",
  • "subCategory": "string",
  • "lastModificationDate": "2024-02-20T08:30:00.00Z",
  • "creationDate": "2024-02-20T08:30:00.00Z",
  • "closeDate": "2024-02-20T08:30:00.00Z",
  • "endDate": "2024-02-20T08:30:00.00Z",
  • "startDate": "2024-02-20T08:30:00.00Z",
  • "externalSourceRef": "Citylinx",
  • "procedureId": "ebbfbbd1-b8de-467c-8a9b-88443a49f807",
  • "linkedEvents": 0,
  • "procedureProgress": 0,
  • "lastComment": {
    },
  • "commentsCount": 0,
  • "parent": {
    }
}

Update an Event

It's possible to update any events, but events with an external source have non-modifiable properties: category, subCategory, name and externalId.

Authorizations:
oidc
path Parameters
id
required
integer
Example: 1
Request Body schema: application/json
id
required
integer
name
required
string
address
string
description
required
string
domain
string
criticality
required
string (Criticality)
Enum: "LOW" "MEDIUM" "HIGH"
category
required
string

Value match one of category code

subCategory
string

required only if ANOMALY is set on cateogry property. Value match one of subCategory code.

equipmentId
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
endDate
string <date-time> (DateTime)
startDate
string <date-time> (DateTime)
parent
integer

Parent event

creator
string

Event creator, required if event is created from Hypervisor

externalSourceRef
string

Event source, required if event is external

externalId
string

If event is external, it's possible to provide an external id

Responses

Request samples

Content type
application/json
{
  • "id": 2,
  • "name": "Dépôt sauvage",
  • "address": "3 rue de Châlons",
  • "description": "Il y a un dépôt sauvage ici",
  • "domain": "EP",
  • "criticality": "LOW",
  • "category": "ANOMALY",
  • "subCategory": "WILD_STORAGE",
  • "equipmentId": "ebbfbbd1-b8de-467c-8a9b-88443a49f807",
  • "endDate": "2024-02-20T08:30:00.00Z",
  • "startDate": "2024-02-20T08:30:00.00Z",
  • "parent": 3,
  • "creator": "toto",
  • "externalSourceRef": "Citylinx",
  • "externalId": "string"
}

Close event by id

Set status to DONE and update closeDate property. Close date is not updated if event is already closed.

Authorizations:
oidc
path Parameters
id
required
integer
Example: 22
Request Body schema: application/json
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
message
required
string

comment message

Responses

Request samples

Content type
application/json
{
  • "id": "ebbfbbd1-b8de-467c-8a9b-88443a49f807",
  • "message": "Mon commentaire"
}

Save or update comment for an event

Comment can be edited by its creator only. It's not possible to add or update a comment on a DONE event.

Authorizations:
oidc
path Parameters
id
required
integer
Example: 22

event id

Request Body schema: application/json
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
message
required
string

comment message

Responses

Request samples

Content type
application/json
{
  • "id": "ebbfbbd1-b8de-467c-8a9b-88443a49f807",
  • "message": "Mon commentaire"
}

Get all comments for an event

Authorizations:
oidc
path Parameters
id
required
integer
Example: 22

event id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieve summary events grouped by status

Returns the last n summary events, sorted by last modification date and status. It is possible to sort these summary events by criticality

Authorizations:
oidc
query Parameters
limit
required
integer
Example: limit=1

Limit of summary events by status. Default to 5.

criticality
string (Criticality)
Enum: "LOW" "MEDIUM" "HIGH"
Example: criticality=HIGH

Filter on the criticality required

Responses

Response samples

Content type
application/json
{
  • "NEW": {
    },
  • "IN_PROGRESS": {
    },
  • "DONE": {
    }
}

Export all events

Export events in a .xslx file. It's possible to export all events, even archived events if option is set to true. Default to false.

Authorizations:
oidc
query Parameters
archived
boolean

Responses

Procedure Model Controller

Retrieve all procedures model with pagination

Default sort on useCount (reversed) and name. It's possible to override it by sorting on other attributes. If order is no provided when sort, the default is asc. It's possible to filter on one or more domains, or search by name, creator or id by using search filter

Authorizations:
oidc
query Parameters
page
integer
Example: page=1

Page number requested, default to 1. Trigger an error if not specified or if 0.

pageSize
integer
Example: pageSize=20

Page size, default to 20. Return an empty list if not specified.

search
string
Example: search=proc

Returns all procedures whose value is contained in the name, creator or id property

domain
Array of strings
Example: domain=EP

The domain code. It must be known to the system.

sort
string (ProcedureModelSort)
Enum: "id" "useCount" "name" "creator" "creationDate" "lastModificationDate" "domain"
order
string (SortOrder)
Default: "ASC"
Enum: "ASC" "DESC"

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Save a procedure model

Save a procedure model and it's actions. Default actions types are EMAIL, PHONE, SMS, ASKED_SERVICE and OTHER. It's possible to insert custom action types that will not have specific properties.

Authorizations:
oidc
Request Body schema: application/json
id
required
integer
name
required
string
description
required
string
domain
string
creator
required
string
Array of EmailActionWriteDto (object) or PhoneActionWriteDto (object) or OtherActionWriteDto (object) or AskedServiceWriteDto (object)

Responses

Request samples

Content type
application/json
{
  • "id": 2,
  • "name": "Ma procédure",
  • "description": "Description de ma procédure",
  • "domain": "EP",
  • "creator": "string",
  • "actions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 2,
  • "name": "Ma procédure",
  • "description": "Description de ma procédure",
  • "domain": "EP",
  • "creator": "string",
  • "actions": [
    ]
}

Retrieve procedure model by id

Authorizations:
oidc
path Parameters
id
required
integer
Example: 29

Responses

Response samples

Content type
application/json
{
  • "id": 3,
  • "useCount": 4,
  • "name": "Ma procédure",
  • "description": "Ma description",
  • "domain": "EP",
  • "creator": "Jess Mariano",
  • "lastModificationDate": "2024-02-20T08:30:00.00Z",
  • "creationDate": "2024-02-20T08:30:00.00Z",
  • "actions": [
    ]
}

Update procedure model

It's possible to update every properties, even actions order. But creator must be the same.

Authorizations:
oidc
path Parameters
id
required
integer
Example: 3
Request Body schema: application/json
id
required
integer
name
required
string
description
required
string
domain
string
creator
required
string
Array of EmailActionWriteDto (object) or PhoneActionWriteDto (object) or OtherActionWriteDto (object) or AskedServiceWriteDto (object)

Responses

Request samples

Content type
application/json
{
  • "id": 2,
  • "name": "Ma procédure",
  • "description": "Description de ma procédure",
  • "domain": "EP",
  • "creator": "string",
  • "actions": [
    ]
}

Associate procedure model to one or more events

The procedure model association will generate a new Procedure instance. This procedure is linked to events whose ids are in request body. These events will automatically be set to IN_PROGRESS status.

Authorizations:
oidc
path Parameters
id
required
integer
Example: 3
Request Body schema: application/json
Array
integer

events id

Responses

Request samples

Content type
application/json
[
  • 1,
  • 2,
  • 3
]

Response samples

Content type
application/json
{
  • "id": 5,
  • "name": "string",
  • "lastModificationDate": "2024-02-20T08:30:00.00Z",
  • "creationDate": "2024-02-20T08:30:00.00Z",
  • "progress": 0,
  • "events": [
    ],
  • "actions": [
    ]
}

Procedure Controller

Retrieve procedure by id

Return procedure detail and its linked events.

Authorizations:
oidc
path Parameters
id
required
integer
Example: 45

Responses

Response samples

Content type
application/json
{
  • "id": 5,
  • "name": "string",
  • "lastModificationDate": "2024-02-20T08:30:00.00Z",
  • "creationDate": "2024-02-20T08:30:00.00Z",
  • "progress": 0,
  • "events": [
    ],
  • "actions": [
    ]
}

Update events and actions procedure

Authorizations:
oidc
path Parameters
id
required
integer
Example: 3
Request Body schema: application/json
id
required
integer
name
required
string
required
Array of objects (EventWriteDto)
Array of EmailActionWriteDto (object) or PhoneActionWriteDto (object) or OtherActionWriteDto (object) or AskedServiceWriteDto (object)

Responses

Request samples

Content type
application/json
{
  • "id": 2,
  • "name": "Ma procédure",
  • "events": [
    ],
  • "actions": [
    ]
}

Delete procedure by id

Events can again be associated with a procedure model. Status events are reset to NEW.

Authorizations:
oidc
path Parameters
id
required
integer
Example: 45

Responses

Close all procedure events by id

Set status to DONE. Close date is not updated if event is already closed

Authorizations:
oidc
path Parameters
id
required
integer
Example: 50
Request Body schema: application/json
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
message
required
string

comment message

Responses

Request samples

Content type
application/json
{
  • "id": "ebbfbbd1-b8de-467c-8a9b-88443a49f807",
  • "message": "Mon commentaire"
}

Add new event to procedure

Add new event to an already instantiated procedure. Event must have NEW status, and procedure can't be done;

Authorizations:
oidc
path Parameters
id
required
integer
Example: 50
eventId
required
integer
Example: 50

Responses

Action Controller

Save or update comment for an action

Comment can be edited by its creator only. It's not possible to add or update a comment on a DONE procedure.

Authorizations:
oidc
path Parameters
id
required
string
Example: 30956c82-073f-4b51-8f79-b447ebe54c76

action id

Request Body schema: application/json
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
message
required
string

comment message

Responses

Request samples

Content type
application/json
{
  • "id": "ebbfbbd1-b8de-467c-8a9b-88443a49f807",
  • "message": "Mon commentaire"
}

Get all comments for an action

Authorizations:
oidc
path Parameters
id
required
string
Example: 30956c82-073f-4b51-8f79-b447ebe54c76

action id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Equipment Controller

Save or update equipments

If one of external id entry exists, update equipment, else create it

Authorizations:
oidc
Request Body schema: application/json
Array
id
required
object

Map of external ids

code
required
string
name
required
string
family
required
string

Value must match one of Family name

domain
required
string

Value must match one of Domain code

entity
required
string

Value must match one of Equipment Entity code

city
required
string

Value must match one of City code

district
string

Value must match one of District code

address
required
string
deleted
boolean
Default: false

if true then the equipment will not be counted in the metrics and will not be returned

level
required
integer

Corresponds to the level to determine whether it will have a parent or not. If the value is 1, then it can be referenced in children equipments and will not itself have a parent equipment.

parent
string

The value must be the parent code property

property name*
additional property
any

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Retrieve all equipments with pagination

Returns all equipments without deleted property. It's possible to filter on entity, or search by equipment name or family name.

Authorizations:
oidc
query Parameters
page
integer
Example: page=1

Page number requested, default to 1. Trigger an error if not specified or if 0.

pageSize
integer
Example: pageSize=20

Page size, default to 20. Return an empty list if not specified.

entity
Array of strings
Example: entity=FAGNIERES-COMMUN

must match one of EquipmentEntity name

search
string
Example: search=armo

search on equipment code and family name

Responses

Response samples

Content type
application/json
{
  • "id": "ebbfbbd1-b8de-467c-8a9b-88443a49f807",
  • "externalId": {
    },
  • "code": "A-001",
  • "name": "A-001",
  • "family": "EP_ARMOIRE",
  • "domain": "EP",
  • "entity": "CHALONS-COMMUN",
  • "city": "CHALONS",
  • "district": "CENTRE",
  • "address": "24 rue de Châlons",
  • "deleted": false,
  • "parent": { },
  • "events": [
    ]
}

Retrieve an equipment by id

Authorizations:
oidc
path Parameters
id
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 01ffde9d-30d2-4273-b61f-c6addd8747c8

Responses

Response samples

Content type
application/json
{
  • "id": "ebbfbbd1-b8de-467c-8a9b-88443a49f807",
  • "externalId": {
    },
  • "code": "A-001",
  • "name": "A-001",
  • "family": "EP_ARMOIRE",
  • "domain": "EP",
  • "entity": "CHALONS-COMMUN",
  • "city": "CHALONS",
  • "district": "CENTRE",
  • "address": "24 rue de Châlons",
  • "deleted": false,
  • "parent": { },
  • "events": [
    ]
}

Retrieve an equipment by name

Authorizations:
oidc
path Parameters
name
required
string
Example: P-1000

Responses

Response samples

Content type
application/json
{
  • "id": "ebbfbbd1-b8de-467c-8a9b-88443a49f807",
  • "externalId": {
    },
  • "code": "A-001",
  • "name": "A-001",
  • "family": "EP_ARMOIRE",
  • "domain": "EP",
  • "entity": "CHALONS-COMMUN",
  • "city": "CHALONS",
  • "district": "CENTRE",
  • "address": "24 rue de Châlons",
  • "deleted": false,
  • "parent": { },
  • "events": [
    ]
}

Retrieve an equipment by source and externalId

Authorizations:
oidc
path Parameters
source
required
string
Example: GMAO
id
required
string
Example: technical_unique_id

Responses

Response samples

Content type
application/json
{
  • "id": "ebbfbbd1-b8de-467c-8a9b-88443a49f807",
  • "externalId": {
    },
  • "code": "A-001",
  • "name": "A-001",
  • "family": "EP_ARMOIRE",
  • "domain": "EP",
  • "entity": "CHALONS-COMMUN",
  • "city": "CHALONS",
  • "district": "CENTRE",
  • "address": "24 rue de Châlons",
  • "deleted": false,
  • "parent": { },
  • "events": [
    ]
}

Retrieve all equipment entities

Authorizations:
oidc

Responses

Response samples

Content type
application/json
[
  • "FAGNIERES-COMMUN",
  • "CHALONS_AGGLOS"
]

Service Controller

Save or update services

startDate and endDate are required is status at least ASKED and closeDate is required if status is DONE

Authorizations:
oidc
Request Body schema: application/json
Array
id
required
string
additionalInfo
string
description
required
string
equipment
string
creationDate
required
string <date-time> (DateTime)
lastModificationDate
required
string <date-time> (DateTime)
startDate
string <date-time> (DateTime)
endDate
string <date-time> (DateTime)
closeDate
string <date-time> (DateTime)
domain
string
status
required
string (ServiceStatus)
Enum: "ASKED" "IN_PROGRESS" "DONE" "CANCELLED"
category
required
string

Value match one of ServiceCategory code

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Retrieve all services

Authorizations:
oidc

Responses

Response samples

Content type
application/json
{
  • "id": "ebbfbbd1-b8de-467c-8a9b-88443a49f807",
  • "externalId": "string",
  • "additionalInfo": "string",
  • "description": "string",
  • "equipment": {
    },
  • "creationDate": "2024-02-20T08:30:00.00Z",
  • "lastModificationDate": "2024-02-20T08:30:00.00Z",
  • "startDate": "2024-02-20T08:30:00.00Z",
  • "endDate": "2024-02-20T08:30:00.00Z",
  • "closeDate": "2024-02-20T08:30:00.00Z",
  • "domain": "EP",
  • "status": "ASKED",
  • "category": "CURA"
}

Create external service for an Asked Service Action

Generate External service and send it to external service application : Coswin. It returns a service code which will be set in serviceExternalId property in action.

Authorizations:
oidc
path Parameters
actionId
required
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
Example: 01ffde9d-30d2-4273-b61f-c6addd8747c8
Request Body schema: application/json
Array
name
required
string
equipment
string <uuid> (UUID) [a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-...
priority
required
string (Priority)
Enum: "1-MINEUR" "2-MAJEUR" "3-BLOQUANT"
description
required
string
domain
required
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

ServiceType Controller

Retrieve all service type. It's possible to filter on domain

Authorizations:
oidc
query Parameters
domain
string
Example: domain=EP

Responses

Response samples

Content type
application/json
{
  • "type": "Armoire - Ouverte",
  • "domain": "EP",
  • "gti": null,
  • "gtr": 30,
  • "gtrp": 24
}

Metrics Controller

Retrieve equipments from EP domain with event metrics

Returns the number of Armoires, Foyers lumineux and unmanaged equipments linked with at least one event that has not been closed, the number of services ASKED for this equipment, and the number of services IN_PROGRESS. Filter on equipments without deleted property.

Authorizations:
oidc
query Parameters
entity
Array of strings
criticality
Array of strings (Criticality)
Items Enum: "LOW" "MEDIUM" "HIGH"
Example: criticality=LOW
category
Array of strings
place
Array of strings

Must match city or district value from equipment

Responses

Response samples

Content type
No sample

Retrieve equipments from EP domain with event metrics

Similar to the endpoint /metrics/equipments-with-events/EP but the number of events is grouped by category and includes the "MANIFESTATION" category. Filter on equipments without deleted property.

Authorizations:
oidc

Responses

Response samples

Content type
application/json
{
  • "nbEquipWithEvent_CF": 0,
  • "totalEquipWithEvent_CF": 0,
  • "nbServiceTodoWithEquip_CF": 0,
  • "nbServiceInProgressWithEquip_CF": 0,
  • "nbEquipWithEvent_unmanaged": 0,
  • "totalEquipWithEvent_unmanaged": 0,
  • "nbServiceTodoWithEquip_unmanaged": 0,
  • "nbServiceInProgressWithEquip_unmanaged": 0,
  • "manifestation": {
    },
  • "outoforder": {
    },
  • "anomaly": {
    },
  • "limit": {
    }
}

Retrieve equipments from SLT domain with event metrics

Returns the number of Carrefours and unmanaged equipments linked with at least one event that has not been closed, the number of services ASKED for this equipment, and the number of services IN_PROGRESS. Filter on equipments without deleted property.

Authorizations:
oidc
query Parameters
entity
Array of strings
criticality
Array of strings (Criticality)
Items Enum: "LOW" "MEDIUM" "HIGH"
Example: criticality=LOW
category
Array of strings
place
Array of strings

Must match city or district value from equipment

Responses

Response samples

Content type
No sample

Retrieve equipments from EP domain with event metrics

Similar to the endpoint /metrics/equipments-with-events/Slt but the number of events is grouped by category and includes the "MANIFESTATION" category. Filter on equipments without deleted property.

Authorizations:
oidc

Responses

Response samples

Content type
application/json
{
  • "nbEquipWithEvent_CF": 0,
  • "totalEquipWithEvent_CF": 0,
  • "nbServiceTodoWithEquip_CF": 0,
  • "nbServiceInProgressWithEquip_CF": 0,
  • "nbEquipWithEvent_unmanaged": 0,
  • "totalEquipWithEvent_unmanaged": 0,
  • "nbServiceTodoWithEquip_unmanaged": 0,
  • "nbServiceInProgressWithEquip_unmanaged": 0,
  • "manifestation": {
    },
  • "outoforder": {
    },
  • "anomaly": {
    },
  • "limit": {
    }
}

Retrieve equipments from VP domain with event metrics

Returns the number of Cameras linked with at least one event that has not been closed, the number of services ASKED for this equipment, and the number of services IN_PROGRESS. Filter on equipments without deleted property.

Authorizations:
oidc
query Parameters
entity
Array of strings
criticality
Array of strings (Criticality)
Items Enum: "LOW" "MEDIUM" "HIGH"
Example: criticality=LOW
category
Array of strings
place
Array of strings

Must match city or district value from equipment

Responses

Response samples

Content type
No sample

Retrieve equipments from VP domain with event metrics

Similar to the endpoint /metrics/equipments-with-events/VP but the number of events is grouped by category and includes the "MANIFESTATION" category. Filter on equipments without deleted property.

Authorizations:
oidc

Responses

Response samples

Content type
application/json
{
  • "nbEquipWithEvent_C": 0,
  • "totalEquipWithEvent_C": 0,
  • "nbServiceTodoWithEquip_C": 0,
  • "nbServiceInProgressWithEquip_C": 0,
  • "manifestation": {
    },
  • "outoforder": {
    },
  • "anomaly": {
    },
  • "limit": {
    }
}

Retrieve equipments by entity for `EP` domain

Returns the number of equipments for EP domain in a given family grouped by entity. The number of managed equipments is separated from the number of unmanaged equipments. Filter on equipments without deleted property.

Authorizations:
oidc
path Parameters
family
required
string
Example: EP_FL

Responses

Response samples

Content type
application/json
{
  • "CHA_managed": 0,
  • "CHA_unmanaged": 0,
  • "CH_managed": 0,
  • "CH_unmanaged": 0,
  • "FAGN_managed": 0,
  • "FAGN_unmanaged": 0,
  • "SMP_managed": 0,
  • "SMP_unmanaged": 0
}

Retrieve first n events by equipments

It's possible to filter on category, domain, and count events that was created after a specific date. Limit is set to 10 by default but can be changed. Filter on equipments without deleted property.

Authorizations:
oidc
query Parameters
domain
string
Example: domain=VP
category
string
Example: category=ANOMALY
date
string <date-time> (DateTime)
Example: date=2024-05-28T08:10:00Z
limit
integer
Default: 10
Example: limit=10
entity
Array of strings
criticality
Array of strings (Criticality)
Items Enum: "LOW" "MEDIUM" "HIGH"
Example: criticality=LOW
place
Array of strings

Must match city or district value from equipment

family
Array of strings

Must match family from equipment

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns an aggregation of services

Aggregates the number of DONE services over a given interval and over a number of buckets from a given date.

Authorizations:
oidc
path Parameters
interval
required
string
Example: month

must be one of hour,day,week,month,quarter,year

query Parameters
date
string <date-time> (DateTime)
Example: date=2024-05-28T08:10:00Z

The timezoned reference date for building the aggregation over the last n intervals

buckets
integer
Example: buckets=12

Number of buckets. Default to 24. Must be a positive number.

domain
string
entity
Array of strings
family
Array of strings
place
Array of strings

Must match city or district value from equipment

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Count opened events grouped by anomaly's subcategories

It's possible to filter on event creation date, event status. If creation date is set, then ignore Done events. If a domain filter is set, count all events linked to a equipment with this domain. Filter on equipments without deleted property.

Authorizations:
oidc
query Parameters
date
string <date-time> (DateTime)
Example: date=2024-01-20T00:00:00Z

event creation date

domain
string

domain from equipment linked to event

status
string (Status)
Enum: "NEW" "IN_PROGRESS" "DONE"
Example: status=NEW

event status

entity
Array of strings
criticality
Array of strings (Criticality)
Items Enum: "LOW" "MEDIUM" "HIGH"
Example: criticality=LOW
place
Array of strings

Must match city or district value from equipment

family
Array of strings

Must match family from equipment

equipment
string

Must match equipment name to get anomalies count for this equipment

Responses

Response samples

Content type
application/json
{
  • "UNUSUAL_FLOW": 0,
  • "WILD_STORAGE": 0,
  • "TRAFFIC_CONGESTION": 0
}

Count events linked by equipment and grouped by anomaly's subcategories and equipment entities

It's possible to filter on equipment domain and set start date to filter on events created from this date. Filter on equipments without deleted property.

Authorizations:
oidc
query Parameters
startDate
string
Example: startDate=2024-01-20T00:00:00Z

filter on events created from this date

domain
string

domain from equipment linked to event

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Returns an aggregation of anomaly events

Aggregates the number of ANOMALY events over a given interval and over a number of buckets from a given start date. Results are grouped by subcategories

Authorizations:
oidc
path Parameters
interval
required
string
Example: month

must be one of hour,day,week,month,quarter,year

query Parameters
startDate
integer
Example: startDate=2024-05-28T08:10:00Z

The timezoned reference date for building the aggregation over the last n intervals

buckets
integer
Example: buckets=12

Number of buckets. Default to 12. Must be a positive number.

domain
string
entity
Array of strings
criticality
Array of strings (Criticality)
Items Enum: "LOW" "MEDIUM" "HIGH"
Example: criticality=LOW
place
Array of strings

Must match city or district value from equipment

family
Array of strings

Must match family from equipment

Responses

Response samples

Content type
application/json
[
  • {
    }
]