Récupération des assets liés à une alerte

Récupération des assets liés à une alerte

L'ensemble des JSON de ce document ne sont pas exhaustifs. Ils sont présentés à titre d'exemple. Il est possible que les champs soient plus ou moins renseignés sur votre entité sur intentPlatform en fonction de vos paramétrages. Vous pouvez contacter le service client d'Intent technologies ( serviceclient@intent.tech ) pour toutes questions.

Cas d'usage

Je reçois une alerte sur un asset et je souhaite obtenir des informations sur l'asset concerné par l'alerte mais également sur ses éléments parents.
Nous rappelons que dans l'univers Intent, un asset peut aussi bien être un élément bâti qu'un équipement.

Déroulé

Suite à la génération d'une alerte par intentPlatform, vous allez recevoir un webhook avec la référence de l'asset concerné dans le champ assetReference 
[
  {
    "type": "monitors:timeseries",
    "id": "8bdd8355-a832-4bf0-a513-f99dcfbcfbd7",
    "event": {
      "alertTitle": "Pannes ascenseurs",
      "labelAsset": "Ascenseur Bâtiment Hirondelles",
      "assetReference": "01-EUR-5021-406-01-ASC1",
      "alertStatus": "Critique",
      "alertValue": "HIGH"
    }
  }
]

Plus d'informations :  ⁠⁠Récupération des alertes⁠ 

Détail de l'asset concerné par l'alerte

Vous pouvez récupérer le détail de cet asset par un appel API, GET assets by ref ( API Assets v2 ). Le paramètre ownerId correspond à l'id sur intentPlatform du propriétaire de l'asset.

GET /api/assets/v2/assets/01-EUR-5021-406-01-ASC1?ownerId=5b6804e9f7a9f936c84
{
    "fullPath": "/01/EUR/5021/406/01/01-EUR-5021-406-01-ESC/01-EUR-5021-406-01-ASC1",
    "label": "Ascenseur",
    "tags": {
        "intent_address_way": "1 Rue De Londres",
        "intent_address_city": "REIMS",
        "intent_address_zip": "51100",
        "Numéro ascenseur": "12645",
        "mise en service": "1967",
        "Charge": "300",
        "Niveaux": "4",
        "intent_type": "Ascenseur",
        "intent_latitude": 49.25429,
        "intent_longitude": 4.05908
    },
    "type": "equipment",
    "owner": {
        "id": "5b6804e9f7a9f936c84",
        "label": "Gestionnaire immobilier",
        "entityRoles": [
            {
                "name": "client"
            },
            {
                "name": "developer"
            }
        ],
        "logoUrl": "https://hubintent.com/intent/entities/logos/59da495a-4c83-aa23-ba0aaf221344"
    },
    "metadata": {
        "position": {
            "type": "Point",
            "coordinates": [
                4.05908,
                49.25429
            ]
        }
    },
    "installationPath": "/01/EUR/5021/406/01/01-EUR-5021-406-01-ESC",
    "reference": "01-EUR-5021-406-01-ASC1",
    "lastUpdateDate": "2021-08-17T22:57:42+02:00",
    "creationDate": "2018-10-02T12:12:26+02:00",
    "_links": {
        "self": {
            "href": "https://api.hubintent.com/api/assets/v2/assets/01-EUR-5021-406-01-ASC1?ownerId=5b6804e9f7a9f936c84"
        },
        "operations:list": {
            "href": "https://api.hubintent.com/api/operations/v2/operations?ancestorAssetReference=01-EUR-5021-406-01-ASC1&ancestorAssetOwnerId=5b6804e9f7a9f936c84"
        },
        "streams:list": {
            "href": "https://api.hubintent.com/api/data/v1/streams?ancestorAssetReference=01-EUR-5021-406-01-ASC1&ancestorAssetOwnerId=5b6804e9f7a9f936c84"
        },
        "documents:list": {
            "href": "https://api.hubintent.com/api/documents/v1/documents?ancestorAssetReference=01-EUR-5021-406-01-ASC1&ancestorAssetOwnerId=5b6804e9f7a9f936c84"
        },
        "share": {
            "href": "https://api.hubintent.com/api/assets/v1/assets/01-EUR-5021-406-01-ASC1?ownerId=5b6804e9f7a9f936c84"
        },
        "update:installation_path": {
            "href": "https://api.hubintent.com/api/assets/v1/assets/01-EUR-5021-406-01-ASC1?ownerId=5b6804e9f7a9f936c84"
        },
        "migrate": {
            "href": "https://api.hubintent.com/api/assets/v1/assets/01-EUR-5021-406-01-ASC1?ownerId=5b6804e9f7a9f936c84"
        }
    },
    "installationReference": "01-EUR-5021-406-01-ESC",
    "usageLinksReferences": [
        "01-EUR-5021-406-01-ESC"
    ]
}

Par le champ type , vous pouvez savoir s'il s'agit d'un équipement (equipment) ou d'un élément bâti (building). Dans l'exemple ci-dessous, nous sommes sur un équipement.

On retrouve la référence de l'asset dans le champ reference

Si vous êtes dans le cas d'un asset de type building, vous pouvez directement aller, plus bas, au paragraphe "Détail de l'asset parent d'un asset de type building".

Détail de l'asset parent d'installation de l'équipement

Le champ installationReference nous indique la référence de l'asset sur lequel l'équipement est installé. Le champ installationPath nous indique le fullPath de l'asset sur lequel l'équipement est installé ou autrement dit le Path de son élément parent.

Le champ usageLinksReferences nous indique le ou les assets impactés par cet équipement.

Vous pouvez récupérer les informations détaillées de l'asset sur lequel l'équipement est installé. 2 solutions.

Solution 1 : GET asset by fullPath

Vous prenez le fullPath de l'asset qui est indiquée dans le champ installationPath

GET /api/assets/v2/assets?fullPath=/01/EUR/5021/406/01/01-EUR-5021-406-01-ESC
{
    "_links": {
        "self": {
            "href": "https://api.hubintent.com/api/assets/v2/assets?fullPath=/01/EUR/5021/406/01/01-EUR-5021-406-01-ESC"
        }
    },
    "_embedded": {
        "assets": [
            {
                "category": "Parties communes - module",
                "code": "01-EUR-5021-406-01-ESC",
                "fullPath": "/01/EUR/5021/406/01/01-EUR-5021-406-01-ESC",
                "label": "5021-BAT-406-ESC-01-Cage d'escalier",
                "tags": {
                    "Société": "Ma société",
                    "Agence": "Agence Europe",
                    "Type de niveau": "Parties communes",
                    "intent_type": "Cage d'escalier",
                    "intent_address_way": "1 Rue De Londres",
                    "intent_address_zip": "51100",
                    "intent_address_city": "REIMS",
                    "intent_latitude": 49.25429,
                    "intent_longitude": 4.05908
                },
                "type": "building",
                "owner": {
                    "id": "5b6804e9f7a9f936c84",
                    "label": "Gestionnaire immobilier",
                    "entityRoles": [
                        {
                            "name": "client"
                        },
                        {
                            "name": "developer"
                        }
                    ],
                    "logoUrl": "https://hubintent.com/intent/entities/logos/59da495a-4c83-aa23-ba0aaf221344"
                },
                "metadata": {
                    "position": {
                        "type": "Point",
                        "coordinates": [
                            4.05908,
                            49.25429
                        ]
                    }
                },
                "reference": "01-EUR-5021-406-01-ESC",
                "parentPath": "/01/EUR/5021/406/01",
                "lastUpdateDate": "2021-08-17T22:57:42+02:00",
                "creationDate": "2018-10-02T10:33:36+02:00",
                "_links": {
                    "self": {
                        "href": "https://api.hubintent.com/api/assets/v2/assets/01-EUR-5021-406-01-ESC?ownerId=5b6804e9f7a9f936c84"
                    },
                    "operations:list": {
                        "href": "https://api.hubintent.com/api/operations/v2/operations?ancestorAssetReference=01-EUR-5021-406-01-ESC&ancestorAssetOwnerId=5b6804e9f7a9f936c84"
                    },
                    "streams:list": {
                        "href": "https://api.hubintent.com/api/data/v1/streams?ancestorAssetReference=01-EUR-5021-406-01-ESC&ancestorAssetOwnerId=5b6804e9f7a9f936c84"
                    },
                    "documents:list": {
                        "href": "https://api.hubintent.com/api/documents/v1/documents?ancestorAssetReference=01-EUR-5021-406-01-ESC&ancestorAssetOwnerId=5b6804e9f7a9f936c84"
                    },
                    "share": {
                        "href": "https://api.hubintent.com/api/assets/v1/assets/01-EUR-5021-406-01-ESC?ownerId=5b6804e9f7a9f936c84"
                    },
                    "update:installation_path": {
                        "href": "https://api.hubintent.com/api/assets/v1/assets/01-EUR-5021-406-01-ESC?ownerId=5b6804e9f7a9f936c84"
                    },
                    "migrate": {
                        "href": "https://api.hubintent.com/api/assets/v1/assets/01-EUR-5021-406-01-ESC?ownerId=5b6804e9f7a9f936c84"
                    }
                }
            }
        ]
    },
    "total": 1
}

On récupère maintenant un asset de type building. La référence de l'asset est toujours indiquée dans le champ reference. Le path de l'élément parent est indiqué dans le champ parentPath

Solution 2 : GET asset by ref

Vous prenez la référence de l'asset d'installation qui est indiquée dans le champ installationReference

GET /api/assets/v2/assets/01-EUR-5021-406-01-ESC?ownerId=5b6804e9f7a9f936c84 
{
    "category": "Parties communes - module",
    "code": "01-EUR-5021-406-01-ESC",
    "fullPath": "/01/EUR/5021/406/01/01-EUR-5021-406-01-ESC",
    "label": "5021-BAT-406-ESC-01-Cage d'escalier",
    "tags": {
        "Société": "Ma société",
        "Agence": "Agence Europe",
        "Type de niveau": "Parties communes",
        "intent_type": "Cage d'escalier",
        "intent_address_way": "1 Rue De Londres",
        "intent_address_zip": "51100",
        "intent_address_city": "REIMS",
        "intent_latitude": 49.25429,
        "intent_longitude": 4.05908
    },
    "type": "building",
    "owner": {
        "id": "5b6804e9f7a9f936c84",
        "label": "Gestionnaire immobilier",
        "entityRoles": [
            {
                "name": "client"
            },
            {
                "name": "developer"
            }
        ],
        "logoUrl": "https://hubintent.com/intent/entities/logos/59da495a-4c83-aa23-ba0aaf221344"
    },
    "metadata": {
        "position": {
            "type": "Point",
            "coordinates": [
                4.05908,
                49.25429
            ]
        }
    },
    "reference": "01-EUR-5021-406-01-ESC",
    "parentPath": "/01/EUR/5021/406/01",
    "lastUpdateDate": "2021-08-17T22:57:42+02:00",
    "creationDate": "2018-10-02T10:33:36+02:00",
    "_links": {
        "self": {
            "href": "https://api.hubintent.com/api/assets/v2/assets/01-EUR-5021-406-01-ESC?ownerId=5b6804e9f7a9f936c84"
        },
        "operations:list": {
            "href": "https://api.hubintent.com/api/operations/v2/operations?ancestorAssetReference=01-EUR-5021-406-01-ESC&ancestorAssetOwnerId=5b6804e9f7a9f936c84"
        },
        "streams:list": {
            "href": "https://api.hubintent.com/api/data/v1/streams?ancestorAssetReference=01-EUR-5021-406-01-ESC&ancestorAssetOwnerId=5b6804e9f7a9f936c84"
        },
        "documents:list": {
            "href": "https://api.hubintent.com/api/documents/v1/documents?ancestorAssetReference=01-EUR-5021-406-01-ESC&ancestorAssetOwnerId=5b6804e9f7a9f936c84"
        },
        "share": {
            "href": "https://api.hubintent.com/api/assets/v1/assets/01-EUR-5021-406-01-ESC?ownerId=5b6804e9f7a9f936c84"
        },
        "update:installation_path": {
            "href": "https://api.hubintent.com/api/assets/v1/assets/01-EUR-5021-406-01-ESC?ownerId=5b6804e9f7a9f936c84"
        },
        "migrate": {
            "href": "https://api.hubintent.com/api/assets/v1/assets/01-EUR-5021-406-01-ESC?ownerId=5b6804e9f7a9f936c84"
        }
    }
}

Détail de l'asset parent d'un asset de type building

Pour récupérer le détail de l'élément parent, vous pouvez faire un appel GET by fullPath en prenant le path indiqué dans le champ parentPath

GET /api/assets/v2/assets?fullPath=/01/EUR/5021/406/01
{
    "_links": {
        "self": {
            "href": "https://api.hubintent.com/api/assets/v2/assets?fullPath=/01/EUR/5021/406/01"
        }
    },
    "_embedded": {
        "assets": [
            {
                "category": "Escalier",
                "code": "01",
                "fullPath": "/01/EUR/5021/406/01",
                "label": "5021-BAT-406-ESC-01",
                "tags": {
                    "Société": "Ma société",
                    "Agence": "Agence Europe",
                    "Type de niveau": "Escalier",
                    "intent_address_way": "1 Rue De Londres",
                    "intent_address_zip": "51100",
                    "intent_address_city": "REIMS",
                    "intent_latitude": 49.25429,
                    "intent_longitude": 4.05908
                },
                "type": "building",
                "owner": {
                    "id": "5b6804e9f7a9f936c84",
                    "label": "Gestionnaire immobilier",
                    "entityRoles": [
                        {
                            "name": "client"
                        },
                        {
                            "name": "developer"
                        }
                    ],
                    "logoUrl": "https://hubintent.com/intent/entities/logos/59da495a-4c83-aa23-ba0aaf221344"
                },
                "contracts": [
                    "LFR2019CMS"
                ],
                "metadata": {
                    "position": {
                        "type": "Point",
                        "coordinates": [
                            4.05908,
                            49.25429
                        ]
                    }
                },
                "reference": "01-EUR-5021-406-01",
                "parentPath": "/01/EUR/5021/406",
                "lastUpdateDate": "2021-08-17T22:57:42+02:00",
                "creationDate": "2018-10-02T10:33:39+02:00",
                "_links": {
                    "self": {
                        "href": "https://api.hubintent.com/api/assets/v2/assets/01-EUR-5021-406-01?ownerId=5b6804e9f7a9f936c84"
                    },
                    "operations:list": {
                        "href": "https://api.hubintent.com/api/operations/v2/operations?ancestorAssetReference=01-EUR-5021-406-01&ancestorAssetOwnerId=5b6804e9f7a9f936c84"
                    },
                    "streams:list": {
                        "href": "https://api.hubintent.com/api/data/v1/streams?ancestorAssetReference=01-EUR-5021-406-01&ancestorAssetOwnerId=5b6804e9f7a9f936c84"
                    },
                    "documents:list": {
                        "href": "https://api.hubintent.com/api/documents/v1/documents?ancestorAssetReference=01-EUR-5021-406-01&ancestorAssetOwnerId=5b6804e9f7a9f936c84"
                    },
                    "share": {
                        "href": "https://api.hubintent.com/api/assets/v1/assets/01-EUR-5021-406-01?ownerId=5b6804e9f7a9f936c84"
                    },
                    "update:installation_path": {
                        "href": "https://api.hubintent.com/api/assets/v1/assets/01-EUR-5021-406-01?ownerId=5b6804e9f7a9f936c84"
                    },
                    "migrate": {
                        "href": "https://api.hubintent.com/api/assets/v1/assets/01-EUR-5021-406-01?ownerId=5b6804e9f7a9f936c84"
                    }
                }
            }
        ]
    },
    "total": 1
}