Skillnader
Här visas skillnader mellan den valda versionen och den nuvarande versionen av sidan.
| Börjar med Föregående version. Nästa version. | Föregående version. | ||
| api:rest:alarm [2023/04/28 13:16] – raderad - extern redigering (Unknown date) 127.0.0.1 | api:rest:alarm [2023/06/08 16:47] (aktuell) – dokuadmin | ||
|---|---|---|---|
| Rad 1: | Rad 1: | ||
| + | {{tag> | ||
| + | ====== Orbiqs API för registrering av larm ====== | ||
| + | Orbiq har ett REST-API för registrering av larm. API:et nås via endpointen | ||
| + | /api/alarm | ||
| + | Autentisering sker via [[https:// | ||
| + | * Token URL: / | ||
| + | * flow: application | ||
| + | * Type: Request body | ||
| + | * Scope: iqalarm | ||
| + | ====== Datamodell för payloaden ====== | ||
| + | < | ||
| + | Alarm { | ||
| + | event (string): The type of event that occurred. Valid values: 'New event', | ||
| + | type (string): The type of alarm. , | ||
| + | time (Alarm Times): Object containing times for the alarm , | ||
| + | subject (string), | ||
| + | message (string), | ||
| + | severity (string), | ||
| + | state (string, optional): Required when " | ||
| + | ackState (string, optional): Acknowledgement status , | ||
| + | ackTime (string, optional): string , | ||
| + | ackUser (string, optional), | ||
| + | ackSystem (string, optional), | ||
| + | clearTime (string, optional), | ||
| + | clearUser (string, optional), | ||
| + | clearSystem (string, optional), | ||
| + | metadata (Metadata, optional), | ||
| + | comment (object, optional), | ||
| + | eventId (string): Local alarm event id from the alarm event source. , | ||
| + | source (Alarm Source): Information regarding the source of the alarm | ||
| + | } | ||
| + | Alarm Times { | ||
| + | eventTime (string), | ||
| + | receivedTime (string, optional) | ||
| + | } | ||
| + | Metadata { | ||
| + | objectShortName (string, optional), | ||
| + | objectLongName (string, optional), | ||
| + | sourceName (string, optional), | ||
| + | sourceDescription (string, optional), | ||
| + | anyOtherProperty (string, optional) | ||
| + | } | ||
| + | Alarm Source { | ||
| + | id (integer, optional), | ||
| + | hrid (string, optional) | ||
| + | } | ||
| + | </ | ||
| + | ====== Exempel på anrop ====== | ||
| + | Nedan ges exempel på några anrop som ni kan testa med hjälp av en API-klient, exempelvis Postman. Ni behöver få uppgifter om client-id och client_secret för den aktuella installationen från iquest. | ||
| + | Följande anrop autentiserar mot API:et med hjälp av Oauth2 och tar emot en __Bearer token__ som används för anropen: | ||
| + | < | ||
| + | curl --location ' | ||
| + | --form ' | ||
| + | --form ' | ||
| + | --form ' | ||
| + | --form ' | ||
| + | </ | ||
| + | |||
| + | Följande anrop registrerar en larmhändelser. | ||
| + | < | ||
| + | curl --location ' | ||
| + | --header ' | ||
| + | --header ' | ||
| + | --header ' | ||
| + | --data-raw '{ | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | }' | ||
| + | </ | ||
| + | |||
| + | Detta anrop kvitterar larmhändelsen. | ||
| + | < | ||
| + | curl --location ' | ||
| + | --header ' | ||
| + | --header ' | ||
| + | --header ' | ||
| + | --data-raw '{ | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | }' | ||
| + | </ | ||
| + | |||
| + | Och detta anrop återställer larmhändelsen. | ||
| + | < | ||
| + | curl --location ' | ||
| + | --header ' | ||
| + | --header ' | ||
| + | --header ' | ||
| + | --data-raw '{ | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | }' | ||
| + | </ | ||
| + | ====== Byggnads binding ====== | ||
| + | |||
| + | för att bind ett larm till en byggnad så skickar man med under metadata ett eller flera identifierande fält | ||
| + | < | ||
| + | objectShortName | ||
| + | objectLongName</ | ||
| + | Dessa motsvarar det som står i orbiq under objekts formuläret (Främmande nyckel, Kortbeteckning och Beteckning) | ||
| + | |||
| + | t.ex. skulle ett anrop för att skapa ett pågånede larm till orbiq för byggnade med kortbetecking 12345 se ut enligt följande | ||
| + | |||
| + | < | ||
| + | curl --location ' | ||
| + | --header ' | ||
| + | --header ' | ||
| + | --header ' | ||
| + | --data-raw '{ | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | }, | ||
| + | " | ||
| + | " | ||
| + | " | ||
| + | } | ||
| + | }' | ||
| + | </ | ||