Openpath orgs/alarmStatuses API
The orgs/alarmStatuses API from Openpath — 2 operation(s) for orgs/alarmstatuses.
OpenAPI Specification
swagger: '2.0'
info:
title: Openpath API Documentation auth orgs/alarmStatuses API
version: 1.0.0
description: Authentication and Login
host: api.openpath.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
tags:
- name: orgs/alarmStatuses
paths:
/orgs/{orgId}/alarmStatuses:
get:
summary: List all alarm statuses
operationId: listAlarmStatuses
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-alarmConfigurations:w,o{params.orgId}-alarmConfigurations:r,o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashAlarm:w,o{params.orgId}-dashAlarm:r,o:w,o:r<br/><br/>__Endpoint name__: listAlarmStatuses'
parameters:
- type: integer
name: orgId
in: path
required: true
- type: integer
minimum: 1
maximum: 1000
name: limit
in: query
- type: integer
default: 0
minimum: 0
name: offset
in: query
- type: string
default: name
pattern: ^[a-zA-Z0-9.]+(,\s*[a-zA-Z0-9.]+)*$
name: sort
in: query
- type: string
default: asc
pattern: ^(asc|desc)+(,\s*(asc|desc)+)*$
name: order
in: query
- type: string
name: q
in: query
- type: string
name: filter
in: query
- type: string
name: preFilter
in: query
consumes:
- application/json
produces:
- application/json
tags:
- orgs/alarmStatuses
security:
- jwt: []
responses:
'200':
schema:
type: object
properties:
totalCount:
type: integer
filteredCount:
type: integer
data:
type: array
items:
type: object
properties:
id:
type: number
code:
type: string
name:
type: string
required:
- id
meta:
type: object
properties:
accessToken:
x-nullable: true
type: object
properties:
scopeUpdatedAt:
type: string
format: date
siteSpecificAccess:
x-nullable: true
type: object
properties:
isSiteSpecific:
type: boolean
siteIds:
x-nullable: true
type: array
items:
type: integer
siteIdsByScope:
type: object
properties:
string:
x-nullable: true
type: array
items:
type: integer
x-nullable: true
description: Successful
x-op-scopes:
- o{params.orgId}-configurations:w
- o{params.orgId}-configurations:r
- o{params.orgId}-alarmConfigurations:w
- o{params.orgId}-alarmConfigurations:r
- o{params.orgId}-dash:w
- o{params.orgId}-dash:r
- o{params.orgId}-dashAlarm:w
- o{params.orgId}-dashAlarm:r
- o:w
- o:r
/orgs/{orgId}/alarmStatuses/{alarmStatusId}:
get:
summary: Describe an alarm status
operationId: describeAlarmStatus
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-configurations:w,o{params.orgId}-configurations:r,o{params.orgId}-alarmConfigurations:w,o{params.orgId}-alarmConfigurations:r,o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashAlarm:w,o{params.orgId}-dashAlarm:r,o:w,o:r<br/><br/>__Endpoint name__: describeAlarmStatus'
parameters:
- type: integer
name: orgId
in: path
required: true
- type: integer
name: alarmStatusId
in: path
required: true
consumes:
- application/json
produces:
- application/json
tags:
- orgs/alarmStatuses
security:
- jwt: []
responses:
'200':
schema:
type: object
properties:
data:
type: object
properties:
id:
type: number
code:
type: string
name:
type: string
required:
- id
meta:
type: object
properties:
accessToken:
x-nullable: true
type: object
properties:
scopeUpdatedAt:
type: string
format: date
siteSpecificAccess:
x-nullable: true
type: object
properties:
isSiteSpecific:
type: boolean
siteIds:
x-nullable: true
type: array
items:
type: integer
siteIdsByScope:
type: object
properties:
string:
x-nullable: true
type: array
items:
type: integer
x-nullable: true
description: Successful
x-op-scopes:
- o{params.orgId}-configurations:w
- o{params.orgId}-configurations:r
- o{params.orgId}-alarmConfigurations:w
- o{params.orgId}-alarmConfigurations:r
- o{params.orgId}-dash:w
- o{params.orgId}-dash:r
- o{params.orgId}-dashAlarm:w
- o{params.orgId}-dashAlarm:r
- o:w
- o:r
securityDefinitions:
jwt:
type: apiKey
name: Authorization
in: header
x-proxy-enabled: false