Openpath orgs/dashboards API
The orgs/dashboards API from Openpath — 4 operation(s) for orgs/dashboards.
OpenAPI Specification
swagger: '2.0'
info:
title: Openpath API Documentation auth orgs/dashboards API
version: 1.0.0
description: Authentication and Login
host: api.openpath.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
tags:
- name: orgs/dashboards
paths:
/orgs/{orgId}/dashboards:
get:
summary: List all dashboards
operationId: listDashboards
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashCust:w,o{params.orgId}-dashCust:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listDashboards'
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/dashboards
security:
- jwt: []
responses:
'200':
schema:
type: object
properties:
totalCount:
type: integer
filteredCount:
type: integer
data:
type: array
items:
type: object
properties:
id:
type: number
name:
type: string
widgets:
type: array
items:
type: object
properties:
id:
type: number
config:
type: object
startCol:
type: number
startRow:
type: number
numCols:
type: number
numRows:
type: number
widgetType:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
required:
- id
orgId:
type: number
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}-dash:w
- o{params.orgId}-dash:r
- o{params.orgId}-dashCust:w
- o{params.orgId}-dashCust:r
- o:w
- o:r
- s-o:w
- s-o:r
post:
summary: Create a new dashboard
operationId: createDashboard
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dash:w,o{params.orgId}-dashCust:w,o:w,s-o:w<br/><br/>__Endpoint name__: createDashboard'
parameters:
- type: integer
name: orgId
in: path
required: true
- in: body
name: body
schema:
type: object
properties:
name:
type: string
required:
- name
consumes:
- application/json
produces:
- application/json
tags:
- orgs/dashboards
security:
- jwt: []
responses:
'201':
schema:
type: object
properties:
data:
type: object
properties:
id:
type: number
name:
type: string
widgets:
type: array
items:
type: object
properties:
id:
type: number
config:
type: object
startCol:
type: number
startRow:
type: number
numCols:
type: number
numRows:
type: number
widgetType:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
required:
- id
orgId:
type: number
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: Created
x-op-scopes:
- o{params.orgId}-dash:w
- o{params.orgId}-dashCust:w
- o:w
- s-o:w
/orgs/{orgId}/dashboards/{dashboardId}:
get:
summary: Describe a dashboard
operationId: describeDashboard
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashCust:w,o{params.orgId}-dashCust:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeDashboard'
parameters:
- type: integer
name: orgId
in: path
required: true
- type: integer
name: dashboardId
in: path
required: true
consumes:
- application/json
produces:
- application/json
tags:
- orgs/dashboards
security:
- jwt: []
responses:
'200':
schema:
type: object
properties:
data:
type: object
properties:
id:
type: number
name:
type: string
widgets:
type: array
items:
type: object
properties:
id:
type: number
config:
type: object
startCol:
type: number
startRow:
type: number
numCols:
type: number
numRows:
type: number
widgetType:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
required:
- id
orgId:
type: number
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}-dash:w
- o{params.orgId}-dash:r
- o{params.orgId}-dashCust:w
- o{params.orgId}-dashCust:r
- o:w
- o:r
- s-o:w
- s-o:r
delete:
summary: Delete a dashboard
operationId: deleteDashboard
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dash:w,o{params.orgId}-dashCust:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteDashboard'
parameters:
- type: integer
name: orgId
in: path
required: true
- type: integer
name: dashboardId
in: path
required: true
consumes:
- application/json
produces:
- application/json
tags:
- orgs/dashboards
security:
- jwt: []
responses:
'204':
description: No Content
x-op-scopes:
- o{params.orgId}-dash:w
- o{params.orgId}-dashCust:w
- o:w
- s-o:w
patch:
summary: Update an existing dashboard
operationId: updateDashboard
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dash:w,o{params.orgId}-dashCust:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateDashboard'
parameters:
- type: integer
name: orgId
in: path
required: true
- type: integer
name: dashboardId
in: path
required: true
- in: body
name: body
schema:
type: object
properties:
name:
type: string
consumes:
- application/json
produces:
- application/json
tags:
- orgs/dashboards
security:
- jwt: []
responses:
'200':
schema:
type: object
properties:
data:
type: object
properties:
id:
type: number
name:
type: string
widgets:
type: array
items:
type: object
properties:
id:
type: number
config:
type: object
startCol:
type: number
startRow:
type: number
numCols:
type: number
numRows:
type: number
widgetType:
type: object
properties:
id:
type: number
name:
type: string
required:
- id
required:
- id
orgId:
type: number
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}-dash:w
- o{params.orgId}-dashCust:w
- o:w
- s-o:w
/orgs/{orgId}/dashboards/{dashboardId}/widgets:
get:
summary: List all dashboard widgets
operationId: listWidgets
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashCust:w,o{params.orgId}-dashCust:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: listWidgets'
parameters:
- type: integer
name: orgId
in: path
required: true
- type: integer
name: dashboardId
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: id
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/dashboards
security:
- jwt: []
responses:
'200':
schema:
type: object
properties:
totalCount:
type: integer
filteredCount:
type: integer
data:
type: array
items:
type: object
properties:
id:
type: number
numRows:
type: number
numCols:
type: number
startRow:
type: number
startCol:
type: number
config:
type: object
widgetType:
type: object
properties:
id:
type: integer
name:
type: string
required:
- id
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}-dash:w
- o{params.orgId}-dash:r
- o{params.orgId}-dashCust:w
- o{params.orgId}-dashCust:r
- o:w
- o:r
- s-o:w
- s-o:r
post:
summary: Create a new dashboard widget
operationId: createWidget
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dash:w,o{params.orgId}-dashCust:w,o:w,s-o:w<br/><br/>__Endpoint name__: createWidget'
parameters:
- type: integer
name: orgId
in: path
required: true
- type: integer
name: dashboardId
in: path
required: true
- in: body
name: body
schema:
type: object
properties:
startCol:
type: integer
startRow:
type: integer
numCols:
type: integer
numRows:
type: integer
config:
type: object
widgetTypeId:
type: integer
x-nullable: true
required:
- startCol
- startRow
- numCols
- numRows
- config
- widgetTypeId
consumes:
- application/json
produces:
- application/json
tags:
- orgs/dashboards
security:
- jwt: []
responses:
'201':
schema:
type: object
properties:
data:
type: object
properties:
id:
type: number
numRows:
type: number
numCols:
type: number
startRow:
type: number
startCol:
type: number
config:
type: object
widgetType:
type: object
properties:
id:
type: integer
name:
type: string
required:
- id
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: Created
x-op-scopes:
- o{params.orgId}-dash:w
- o{params.orgId}-dashCust:w
- o:w
- s-o:w
/orgs/{orgId}/dashboards/{dashboardId}/widgets/{widgetId}:
get:
summary: Describe a dashboard widget
operationId: describeWidget
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-dashCust:w,o{params.orgId}-dashCust:r,o:w,o:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeWidget'
parameters:
- type: integer
name: orgId
in: path
required: true
- type: integer
name: dashboardId
in: path
required: true
- type: integer
name: widgetId
in: path
required: true
consumes:
- application/json
produces:
- application/json
tags:
- orgs/dashboards
security:
- jwt: []
responses:
'200':
schema:
type: object
properties:
data:
type: object
properties:
id:
type: number
numRows:
type: number
numCols:
type: number
startRow:
type: number
startCol:
type: number
config:
type: object
widgetType:
type: object
properties:
id:
type: integer
name:
type: string
required:
- id
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}-dash:w
- o{params.orgId}-dash:r
- o{params.orgId}-dashCust:w
- o{params.orgId}-dashCust:r
- o:w
- o:r
- s-o:w
- s-o:r
delete:
summary: Delete a dashboard widget
operationId: deleteWidget
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dash:w,o{params.orgId}-dashCust:w,o:w,s-o:w<br/><br/>__Endpoint name__: deleteWidget'
parameters:
- type: integer
name: orgId
in: path
required: true
- type: integer
name: dashboardId
in: path
required: true
- type: integer
name: widgetId
in: path
required: true
consumes:
- application/json
produces:
- application/json
tags:
- orgs/dashboards
security:
- jwt: []
responses:
'204':
description: No Content
x-op-scopes:
- o{params.orgId}-dash:w
- o{params.orgId}-dashCust:w
- o:w
- s-o:w
patch:
summary: Update a dashboard widget
operationId: updateWidget
description: '__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dash:w,o{params.orgId}-dashCust:w,o:w,s-o:w<br/><br/>__Endpoint name__: updateWidget'
parameters:
- type: integer
name: orgId
in: path
required: true
- type: integer
name: dashboardId
in: path
required: true
- type: integer
name: widgetId
in: path
required: true
- in: body
name: body
schema:
type: object
properties:
startCol:
type: integer
startRow:
type: integer
numCols:
type: integer
numRows:
type: integer
config:
type: object
consumes:
- application/json
produces:
- application/json
tags:
- orgs/dashboards
security:
- jwt: []
responses:
'204':
description: No Content
x-op-scopes:
- o{params.orgId}-dash:w
- o{params.orgId}-dashCust:w
- o:w
- s-o:w
securityDefinitions:
jwt:
type: apiKey
name: Authorization
in: header
x-proxy-enabled: false