{"swagger":"2.0","info":{"version":"v1","title":"Utelogy.Rest.Gateway.Portal"},"host":"portal.utelogy.com","schemes":["https"],"paths":{"/api/alert/list/active":{"get":{"tags":["Alert"],"operationId":"Alert_ListActiveAlerts","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"access token","required":false,"type":"string"}],"responses":{"200":{"description":"List active alerts","schema":{"$ref":"#/definitions/AlertProtocolDocument"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/NotFoundResult"}}}}},"/api/alert/list":{"get":{"tags":["Alert"],"operationId":"Alert_ListAllAlerts","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"occurredFrom","in":"query","required":false,"type":"string","format":"date-time"},{"name":"occurredTo","in":"query","required":false,"type":"string","format":"date-time"},{"name":"Authorization","in":"header","description":"access token","required":false,"type":"string"}],"responses":{"200":{"description":"List all alerts","schema":{"$ref":"#/definitions/AlertProtocolDocument"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/NotFoundResult"}}}}},"/api/alert/{id}/acknowledge":{"get":{"tags":["Alert"],"operationId":"Alert_AcknowledgeAlert","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"access token","required":false,"type":"string"}],"responses":{"200":{"description":"Acknowledge an alert","schema":{"$ref":"#/definitions/Packet"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/NotFoundResult"}}}}},"/api/asset/list":{"get":{"tags":["Asset"],"operationId":"Asset_ListAssets","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"access token","required":false,"type":"string"}],"responses":{"200":{"description":"List assets","schema":{"$ref":"#/definitions/AssetDocument"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/NotFoundResult"}}}}},"/api/asset/{id}":{"get":{"tags":["Asset"],"operationId":"Asset_GetAsset","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"access token","required":false,"type":"string"}],"responses":{"200":{"description":"Find asset","schema":{"$ref":"#/definitions/Packet"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/NotFoundResult"}}}}},"/api/gdl/manufacturer/list":{"get":{"tags":["Gdl"],"operationId":"Gdl_GetManufacturerList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"Authorization","in":"header","description":"access token","required":false,"type":"string"}],"responses":{"200":{"description":"Get list of manufacturers","schema":{"type":"array","items":{"$ref":"#/definitions/Manufacturer"}}}}}},"/api/gdl/devicekind/list":{"get":{"tags":["Gdl"],"operationId":"Gdl_GetDeviceKindList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"Authorization","in":"header","description":"access token","required":false,"type":"string"}],"responses":{"200":{"description":"Get list of device kinds","schema":{"type":"array","items":{"$ref":"#/definitions/DeviceKind"}}}}}},"/api/gdl/featurekind/list":{"get":{"tags":["Gdl"],"operationId":"Gdl_GetFeatureKindList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"Authorization","in":"header","description":"access token","required":false,"type":"string"}],"responses":{"200":{"description":"Get list of feature kinds","schema":{"type":"array","items":{"$ref":"#/definitions/FeatureKind"}}}}}},"/api/gdl/driver/list":{"get":{"tags":["Gdl"],"operationId":"Gdl_GetDriverList","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"Authorization","in":"header","description":"access token","required":false,"type":"string"}],"responses":{"200":{"description":"Get List of All Device Drivers","schema":{"$ref":"#/definitions/Packet"}}}}},"/api/gdl/driver/search/{keywords}":{"get":{"tags":["Gdl"],"operationId":"Gdl_DriverSearch","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"keywords","in":"path","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"access token","required":false,"type":"string"}],"responses":{"200":{"description":"Get Device Driver by name","schema":{"$ref":"#/definitions/Packet"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/NotFoundResult"}}}}},"/api/gdl/driver/{filename}":{"get":{"tags":["Gdl"],"operationId":"Gdl_DriverFileGet","consumes":[],"produces":["application/json","text/json","application/xml","text/xml"],"parameters":[{"name":"filename","in":"path","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"access token","required":false,"type":"string"}],"responses":{"200":{"description":"Get a Driver file","schema":{"format":"byte","type":"string"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/NotFoundResult"}}}}},"/api/room/list":{"get":{"tags":["Room"],"operationId":"Room_ListRooms","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"Authorization","in":"header","description":"access token","required":false,"type":"string"}],"responses":{"200":{"description":"List the rooms","schema":{"$ref":"#/definitions/Packet"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/NotFoundResult"}}}}},"/api/room/{id}/alerts":{"get":{"tags":["Room"],"operationId":"Room_RoomActiveAlerts","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"access token","required":false,"type":"string"}],"responses":{"200":{"description":"List the alerts for the room","schema":{"$ref":"#/definitions/Packet"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/NotFoundResult"}}}}},"/api/room/{id}":{"get":{"tags":["Room"],"operationId":"Room_RoomGet","consumes":[],"produces":["application/json","text/json"],"parameters":[{"name":"id","in":"path","required":true,"type":"string"},{"name":"Authorization","in":"header","description":"access token","required":false,"type":"string"}],"responses":{"200":{"description":"Find room","schema":{"$ref":"#/definitions/Packet"}},"404":{"description":"NotFound","schema":{"$ref":"#/definitions/NotFoundResult"}}}}}},"definitions":{"AlertProtocolDocument":{"type":"object","properties":{"AccountKey":{"type":"string"},"TargetInfo":{"$ref":"#/definitions/TargetInfo"},"LocationID":{"type":"string"},"LocationName":{"type":"string"},"State":{"enum":["None","Active","History"],"type":"string"},"Feature":{"type":"string"},"Subject":{"type":"string"},"Severity":{"enum":["Ok","Error","Warning","Critical"],"type":"string"},"Occurred":{"format":"date-time","type":"string"},"Cleared":{"format":"date-time","type":"string"},"Message":{"type":"string"},"Acknowledged":{"type":"boolean"},"AcknowledgeUserID":{"type":"string"},"AcknowledgeUser":{"type":"string"},"AcknowledgeDate":{"format":"date-time","type":"string"},"_id":{"type":"string"}}},"TargetInfo":{"type":"object","properties":{"Target":{"enum":["None","AccessDirectoryService","AccessConfiguration","AccessGroup","AccessLevel","AccessRole","AccessRule","Account","AccountRole","Alert","AlertNotification","Asset","AssetFeature","Dashboard","DeviceDriver","DeviceDriverAsync","DeviceKind","Document","DocumentLabel","Event","FeatureKind","HelpCall","HelpTicket","Location","Manufacturer","Metadata","ModelArchive","NotificationRule","Room","RoomGroup","Rule","AccountSchedule","Server","Tether","Instance","PowerUsage","User","Group","ScheduleData","View","Metric","ApiLog","BackgroundTaskLog","NotificationLog","DocEvent","MetricHistory","Test","Template","Product","Notification","Driver","DriverAsync","Resource","Call","DataCenter","MonitorLog","StructuredLog","JobTaskQueue","JobTaskLog","Report","SJMTest","Securable","AutomationScript","AutomationSchedule","AutomationSession","AutomationSessionTarget","Block","Timezone","TimezoneLink","Theme","Cluster","DataChangeLog","Announcement"],"type":"string"},"TargetID":{"type":"string"},"Description":{"type":"string"},"ClmID":{"type":"string"},"DeviceKindCode":{"type":"string"},"ManufacturerCode":{"type":"string"},"RoomName":{"type":"string"},"RoomKind":{"type":"string"},"RoomID":{"type":"string"},"DeviceKindName":{"type":"string"},"ManufacturerName":{"type":"string"},"AssetID":{"type":"string"},"SerialNumber":{"type":"string"},"Reference":{"type":"string"},"ModelName":{"type":"string"},"Room":{"$ref":"#/definitions/RoomDocument"}}},"RoomDocument":{"type":"object","properties":{"AccountKey":{"type":"string"},"ClmService":{"$ref":"#/definitions/ClmService"},"ScheduleService":{"$ref":"#/definitions/ScheduleService"},"Name":{"type":"string"},"ClmName":{"type":"string","readOnly":true},"IsPool":{"type":"boolean"},"IsManual":{"type":"boolean"},"LocationID":{"type":"string"},"LocationName":{"type":"string"},"Metrics":{"type":"array","items":{"$ref":"#/definitions/MetricValue"}},"Alerts":{"type":"array","items":{"$ref":"#/definitions/AlertDocument"}},"_id":{"type":"string"}}},"ClmService":{"type":"object","properties":{"ClmID":{"type":"string"},"StatusTimestamp":{"format":"date-time","type":"string"},"IsReporting":{"type":"boolean","readOnly":true},"CreateTimestamp":{"format":"date-time","type":"string"},"HostName":{"type":"string"},"ExecState":{"enum":["Stop","Standby","Running"],"type":"string"},"ClusterID":{"type":"string"},"ClusterName":{"type":"string"}}},"ScheduleService":{"type":"object","properties":{"TargetID":{"type":"string"},"CalendarID":{"type":"string"},"IsEnabled":{"type":"boolean"}}},"MetricValue":{"type":"object","properties":{"MetricKey":{"type":"string"},"Value":{"type":"object"},"Timestamp":{"format":"date-time","type":"string"},"LastReportedTimestamp":{"format":"date-time","type":"string"},"IsOverridden":{"type":"boolean"}}},"AlertDocument":{"type":"object","properties":{"AccountKey":{"type":"string"},"TargetInfo":{"$ref":"#/definitions/TargetInfo"},"LocationID":{"type":"string"},"LocationName":{"type":"string"},"State":{"enum":["None","Active","History"],"type":"string"},"Feature":{"type":"string"},"Subject":{"type":"string"},"Severity":{"enum":["Ok","Error","Warning","Critical"],"type":"string"},"Occurred":{"format":"date-time","type":"string"},"Cleared":{"format":"date-time","type":"string"},"Message":{"type":"string"},"Acknowledged":{"type":"boolean"},"AcknowledgeUserID":{"type":"string"},"AcknowledgeUser":{"type":"string"},"AcknowledgeDate":{"format":"date-time","type":"string"},"AlertKind":{"enum":["Condition","Event"],"type":"string"},"_id":{"type":"string"}}},"NotFoundResult":{"type":"object","properties":{"Request":{"type":"object","readOnly":true}}},"Packet":{"type":"object","properties":{"MessageType":{"type":"string"},"Sequence":{"format":"int32","type":"integer"},"SessionID":{"type":"string"},"UserAuthKey":{"type":"string"},"Target":{"type":"string"},"TimeStamp":{"format":"date-time","type":"string"},"Originated":{"format":"date-time","type":"string"},"ResponseTo":{"format":"int32","type":"integer"},"ResponseCode":{"enum":["None","InvalidRequest","BadPacket","Ok","Error","TransportError","AuthenticationError","ServerError","UnknownMessage","NotImplemented","Queued","NotFound","NotAvailable","RateLimitExceeded"],"type":"string"},"Content":{"type":"object"},"MAC":{"type":"string"},"Errors":{"$ref":"#/definitions/ErrorSet"},"HasErrors":{"type":"boolean","readOnly":true}}},"ErrorSet":{"type":"object","properties":{"Errors":{"type":"array","items":{"$ref":"#/definitions/ErrorItem"}}}},"ErrorItem":{"type":"object","properties":{"<Context>k__BackingField":{"type":"string"},"<Title>k__BackingField":{"type":"string"},"<Detail>k__BackingField":{"type":"string"},"<ErrorLevel>k__BackingField":{"enum":["Information","Error","Warning"],"type":"string"}}},"AssetDocument":{"type":"object","properties":{"AccountKey":{"type":"string"},"RoomID":{"type":"string"},"RoomName":{"type":"string"},"RoomKind":{"type":"string"},"DeviceID":{"type":"string"},"LocationID":{"type":"string"},"LocationName":{"type":"string"},"Reference":{"type":"string"},"DeviceKindCode":{"type":"string"},"DeviceKindName":{"type":"string"},"ManufacturerCode":{"type":"string"},"ManufacturerName":{"type":"string"},"Notes":{"type":"string"},"ModelName":{"type":"string"},"CreateTimestamp":{"format":"date-time","type":"string"},"ClmID":{"type":"string"},"Metrics":{"type":"array","items":{"$ref":"#/definitions/MetricValue"}},"Alerts":{"type":"array","items":{"$ref":"#/definitions/AlertDocument"}},"_id":{"type":"string"}}},"Manufacturer":{"type":"object","properties":{"ManufacturerCode":{"type":"string"},"Name":{"type":"string"},"Website":{"type":"string"}}},"DeviceKind":{"type":"object","properties":{"Code":{"type":"string"},"Label":{"type":"string"},"ImageUri":{"type":"string"},"FullImageUri":{"type":"string","readOnly":true}}},"FeatureKind":{"type":"object","properties":{"FeatureKindCode":{"type":"string"},"Label":{"type":"string"},"Signal":{"enum":["A","V","AV","C"],"type":"string"},"Direction":{"enum":["S","D","SD","N"],"type":"string"}}}},"securityDefinitions":{"apiKey":{"type":"apiKey","description":"API Key Authentication","name":"apiKey","in":"header"}}}