openapi: 3.0.0 info: version: 1.0.0 title: Intelligent Assets REST API servers: - url: https://assets.clearblade.com tags: - name: Action Types - name: Actions - name: Adapter Config - name: Area Types - name: Areas - name: Asset Comments - name: Asset History - name: Asset Images - name: Asset Tree - name: Asset Type Tree - name: Asset Types - name: Assets - name: Audits - name: Bucket Sets - name: Components - name: Custom Settings - name: Dashboards - name: Device Config - name: Event Types - name: Events - name: Group Tree - name: Groups - name: Heatmaps - name: Logs - name: Measurement Profiles - name: Microfrontends - name: Miscellaneous - name: Nav Pages - name: OIDC Settings - name: Permission Definitions - name: Reports - name: Roles - name: Rule Types - name: Rules - name: System Info - name: Tags - name: Tour - name: Users components: schemas: {} parameters: {} paths: /api/v/1/code/{systemKey}/fetchTableItems?id=dataHistoryForAsset.read: post: tags: - Asset History description: Retrieve data history for an asset parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - dataHistoryForAsset.read body: type: object properties: descendantIds: type: array items: type: string rootId: type: string startDate: type: string endDate: type: string pageSize: type: number pageNum: type: number customDataSortKey: type: object properties: owner: type: string key: type: string required: - owner - key nonNullAttributes: type: array items: type: string sortKeyType: type: string sortKey: type: string sortDir: anyOf: - type: string enum: - asc - type: string enum: - desc recentAmount: type: number required: - rootId - startDate - endDate required: - name - body responses: "200": description: Success content: application/json: schema: type: array items: type: object properties: change_date: type: string history: type: array items: allOf: - type: object additionalProperties: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true owners: anyOf: - type: array items: type: string - type: object nullable: true enum: - null - nullable: true latitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true longitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true image: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_data: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: number - type: boolean - type: object nullable: true enum: - null - type: undefined enum: - null - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: string - type: number - type: boolean - nullable: true - type: object nullable: true enum: - null - nullable: true attributes_last_updated: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true parent: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_x: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_y: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_z: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_unit: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_id_1: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_id_2: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_location_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true group_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true tree_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true is_root: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true floor_levels: anyOf: - type: array items: type: number - type: object nullable: true enum: - null - nullable: true attributes_labels: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: string - type: object nullable: true enum: - null - nullable: true is_reporting: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true attributes_is_reporting: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: boolean - type: object nullable: true enum: - null - nullable: true tags: type: array items: type: string attributes_errors: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: object properties: message: type: string timestamp: type: string required: - message - timestamp - type: object nullable: true enum: - null - nullable: true polygon: anyOf: - type: object properties: geometry_type: type: string enum: - gps polygon: anyOf: - type: array items: type: object properties: long: type: number lat: type: number required: - long - lat - type: object nullable: true enum: - null - nullable: true required: - geometry_type - type: object properties: geometry_type: type: string enum: - indoor_area polygon: anyOf: - type: array items: type: object properties: x: type: number y: type: number z: type: number required: - x - y - z - type: object nullable: true enum: - null - nullable: true required: - geometry_type - type: object properties: geometry_type: type: string enum: - indoor_model required: - geometry_type - type: object properties: geometry_type: type: string enum: - geojson features: type: array items: type: object properties: type: type: string enum: - Feature properties: type: object properties: {} geometry: anyOf: - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number required: - type - coordinates - type: object properties: type: type: string enum: - MultiPolygon coordinates: type: array items: type: array items: type: array items: type: array items: type: number required: - type - coordinates required: - type - properties - geometry required: - geometry_type - features - type: object nullable: true enum: - null - nullable: true is_archived: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true image_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true address: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - id - owners - latitude - longitude - type - label - description - image - last_updated - location_updated - custom_data - attributes_last_updated - parent - location_x - location_y - location_z - location_type - location_unit - custom_id_1 - custom_id_2 - last_location_updated - group_id - tree_id - is_root - floor_levels - attributes_labels - item_id - type: object properties: asset_id: type: string required: - asset_id required: - change_date - history /api/v/1/code/{systemKey}/fetchTableItems?id=groupsForCallerUser.read: post: tags: - Groups description: Retrieve groups for the calling user parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - groupsForCallerUser.read body: nullable: true required: - name responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: type: object properties: map_location_latitude: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true map_location_longitude: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true map_bounds: anyOf: - type: array items: type: object properties: long: type: number lat: type: number required: - long - lat - type: object nullable: true enum: - null - nullable: true id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true map_zoom: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true map_zoom_float: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true tree_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true is_root: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true tree: type: object properties: id: type: string data: type: object properties: rootID: type: string treeID: type: string nodes: type: object additionalProperties: type: object properties: id: type: string parentID: type: string parents: type: array items: type: string children: type: array items: type: string required: - id - parentID - parents - children required: - rootID - treeID - nodes timezone: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true date_time_locale: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - map_location_latitude - map_location_longitude - map_bounds - id - map_zoom - map_zoom_float - name - tree_id - is_root - timezone - item_id COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=actionTypes.read: post: tags: - Action Types description: Retrieve action types parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - actionTypes.read body: type: object properties: page: type: object properties: pageSize: type: number pageNumber: type: number searchText: type: string filters: type: object properties: ids: type: array items: type: string labels: type: array items: type: string sort: type: array items: type: object properties: field: anyOf: - type: string enum: - id - type: string enum: - label direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - direction columns: type: array items: anyOf: - type: string enum: - item_id - type: string enum: - id - type: string enum: - label - type: string enum: - schema required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: allOf: - type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true schema: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - id - label - schema - item_id - type: object properties: groups: type: array items: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - id - name required: - groups COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=assetTypes.read: post: tags: - Asset Types description: Retrieve asset types parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assetTypes.read body: type: object properties: page: type: object properties: pageSize: type: number pageNumber: type: number searchText: type: string filters: type: object properties: ids: type: array items: type: string labels: type: array items: type: string entityTypes: type: array items: type: string sort: type: array items: type: object properties: field: anyOf: - type: string enum: - id - type: string enum: - label - type: string enum: - entity_type - type: string enum: - device_type direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - direction columns: type: array items: type: string required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: allOf: - type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true icon: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true schema: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true controls_schema: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true device_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true parent_child_options: anyOf: - type: object properties: propagate_location_to_root: type: boolean store_updates_on_root: type: boolean show_location_on_map: type: boolean - type: object nullable: true enum: - null - nullable: true icon_svg: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true default_history_view: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true hide_attribute_if_undefined: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true categories: anyOf: - type: array items: type: object properties: id: type: string label: type: string settings: anyOf: - type: object properties: collapsed: type: boolean layout: type: string enum: - list required: - collapsed - type: object properties: collapsed: type: boolean layout: type: string enum: - grid widget_size: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 required: - collapsed - layout - widget_size attributes: type: array items: type: string controls: type: array items: type: string required: - id - label - settings - attributes - controls - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true reporting_interval: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true attributes_reporting_intervals: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: number - type: object nullable: true enum: - null - nullable: true entity_type: anyOf: - type: string enum: - asset - type: string enum: - area - type: object nullable: true enum: - null - nullable: true asset_tabs: anyOf: - type: array items: anyOf: - type: object properties: type: type: string enum: - core id: anyOf: - type: string enum: - data - type: string enum: - history - type: string enum: - controls - type: string enum: - logs - type: string enum: - events - type: string enum: - comments - type: string enum: - images label: type: string hidden: type: boolean required: - type - id - label - type: object properties: type: type: string enum: - mfe id: type: string label: type: string mfe_id: type: string hidden: type: boolean required: - type - id - label - mfe_id - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true summary: anyOf: - type: array items: anyOf: - allOf: - type: object properties: type: type: string enum: - image required: - type - type: object properties: visible: type: boolean required: - visible - allOf: - type: object properties: type: type: string enum: - profile items: type: array items: anyOf: - type: object properties: type: anyOf: - type: string enum: - name - type: string enum: - id - type: string enum: - type - type: string enum: - customId1 - type: string enum: - customId2 - type: string enum: - reportingStatus - type: string enum: - lastUpdated - type: string enum: - groups - type: string enum: - owners - type: string enum: - tags - type: string enum: - entityType - type: string enum: - deviceType - type: string enum: - description visible: type: boolean required: - type - visible - type: object properties: type: type: string enum: - attribute attributeId: type: string visible: type: boolean required: - type - attributeId - visible required: - type - items - type: object properties: visible: type: boolean required: - visible - allOf: - type: object properties: type: type: string enum: - eventsPanel required: - type - type: object properties: visible: type: boolean required: - visible - allOf: - type: object properties: type: type: string enum: - tree required: - type - type: object properties: visible: type: boolean required: - visible - allOf: - type: object properties: type: type: string enum: - location items: type: array items: type: object properties: type: anyOf: - type: string enum: - map - type: string enum: - lastUpdated - type: string enum: - floorLevel visible: type: boolean required: - type - visible required: - type - items - type: object properties: visible: type: boolean required: - visible - type: object nullable: true enum: - null - nullable: true modal_configuration: anyOf: - type: object properties: fields: type: array items: anyOf: - allOf: - type: object properties: type: type: string enum: - default_column column: anyOf: - type: string enum: - id - type: string enum: - owners - type: string enum: - latitude - type: string enum: - longitude - type: string enum: - type - type: string enum: - label - type: string enum: - description - type: string enum: - image - type: string enum: - last_updated - type: string enum: - location_updated - type: string enum: - custom_data - type: string enum: - attributes_last_updated - type: string enum: - parent - type: string enum: - location_x - type: string enum: - location_y - type: string enum: - location_z - type: string enum: - location_type - type: string enum: - location_unit - type: string enum: - custom_id_1 - type: string enum: - custom_id_2 - type: string enum: - last_location_updated - type: string enum: - group_id - type: string enum: - tree_id - type: string enum: - is_root - type: string enum: - floor_levels - type: string enum: - attributes_labels - type: string enum: - is_reporting - type: string enum: - attributes_is_reporting - type: string enum: - tags - type: string enum: - attributes_errors - type: string enum: - polygon - type: string enum: - is_archived - type: string enum: - image_id - type: string enum: - address - type: string enum: - groups - type: string enum: - children required: - type - column - type: object properties: required: type: boolean cols: type: object properties: xs: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto sm: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto md: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto lg: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto xl: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto required: - xs - sm - md - lg - xl - allOf: - type: object properties: type: type: string enum: - attribute attributeId: type: string required: - type - attributeId - type: object properties: required: type: boolean cols: type: object properties: xs: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto sm: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto md: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto lg: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto xl: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto required: - xs - sm - md - lg - xl mapConfig: type: object properties: show: type: boolean required: - show version: type: number required: - fields - mapConfig - version - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - id - label - description - icon - schema - controls_schema - device_type - parent_child_options - icon_svg - default_history_view - hide_attribute_if_undefined - categories - entity_type - asset_tabs - item_id - type: object properties: groups: type: array items: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - id - name required: - groups COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=assetTypeTree.read: post: tags: - Asset Type Tree description: Retrieve asset type tree parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assetTypeTree.read body: nullable: true required: - name responses: "200": description: Success content: application/json: schema: type: string /api/v/1/code/{systemKey}/fetchTableItems?id=assetTypesTopLevel.read: post: tags: - Asset Types description: Retrieve top level asset types from tree parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assetTypesTopLevel.read body: nullable: true required: - name responses: "200": description: Success content: application/json: schema: type: array items: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true icon: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true schema: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true controls_schema: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true device_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true parent_child_options: anyOf: - type: object properties: propagate_location_to_root: type: boolean store_updates_on_root: type: boolean show_location_on_map: type: boolean - type: object nullable: true enum: - null - nullable: true icon_svg: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true default_history_view: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true hide_attribute_if_undefined: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true categories: anyOf: - type: array items: type: object properties: id: type: string label: type: string settings: anyOf: - type: object properties: collapsed: type: boolean layout: type: string enum: - list required: - collapsed - type: object properties: collapsed: type: boolean layout: type: string enum: - grid widget_size: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 required: - collapsed - layout - widget_size attributes: type: array items: type: string controls: type: array items: type: string required: - id - label - settings - attributes - controls - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true reporting_interval: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true attributes_reporting_intervals: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: number - type: object nullable: true enum: - null - nullable: true entity_type: anyOf: - type: string enum: - asset - type: string enum: - area - type: object nullable: true enum: - null - nullable: true asset_tabs: anyOf: - type: array items: anyOf: - type: object properties: type: type: string enum: - core id: anyOf: - type: string enum: - data - type: string enum: - history - type: string enum: - controls - type: string enum: - logs - type: string enum: - events - type: string enum: - comments - type: string enum: - images label: type: string hidden: type: boolean required: - type - id - label - type: object properties: type: type: string enum: - mfe id: type: string label: type: string mfe_id: type: string hidden: type: boolean required: - type - id - label - mfe_id - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true summary: anyOf: - type: array items: anyOf: - allOf: - type: object properties: type: type: string enum: - image required: - type - type: object properties: visible: type: boolean required: - visible - allOf: - type: object properties: type: type: string enum: - profile items: type: array items: anyOf: - type: object properties: type: anyOf: - type: string enum: - name - type: string enum: - id - type: string enum: - type - type: string enum: - customId1 - type: string enum: - customId2 - type: string enum: - reportingStatus - type: string enum: - lastUpdated - type: string enum: - groups - type: string enum: - owners - type: string enum: - tags - type: string enum: - entityType - type: string enum: - deviceType - type: string enum: - description visible: type: boolean required: - type - visible - type: object properties: type: type: string enum: - attribute attributeId: type: string visible: type: boolean required: - type - attributeId - visible required: - type - items - type: object properties: visible: type: boolean required: - visible - allOf: - type: object properties: type: type: string enum: - eventsPanel required: - type - type: object properties: visible: type: boolean required: - visible - allOf: - type: object properties: type: type: string enum: - tree required: - type - type: object properties: visible: type: boolean required: - visible - allOf: - type: object properties: type: type: string enum: - location items: type: array items: type: object properties: type: anyOf: - type: string enum: - map - type: string enum: - lastUpdated - type: string enum: - floorLevel visible: type: boolean required: - type - visible required: - type - items - type: object properties: visible: type: boolean required: - visible - type: object nullable: true enum: - null - nullable: true modal_configuration: anyOf: - type: object properties: fields: type: array items: anyOf: - allOf: - type: object properties: type: type: string enum: - default_column column: anyOf: - type: string enum: - id - type: string enum: - owners - type: string enum: - latitude - type: string enum: - longitude - type: string enum: - type - type: string enum: - label - type: string enum: - description - type: string enum: - image - type: string enum: - last_updated - type: string enum: - location_updated - type: string enum: - custom_data - type: string enum: - attributes_last_updated - type: string enum: - parent - type: string enum: - location_x - type: string enum: - location_y - type: string enum: - location_z - type: string enum: - location_type - type: string enum: - location_unit - type: string enum: - custom_id_1 - type: string enum: - custom_id_2 - type: string enum: - last_location_updated - type: string enum: - group_id - type: string enum: - tree_id - type: string enum: - is_root - type: string enum: - floor_levels - type: string enum: - attributes_labels - type: string enum: - is_reporting - type: string enum: - attributes_is_reporting - type: string enum: - tags - type: string enum: - attributes_errors - type: string enum: - polygon - type: string enum: - is_archived - type: string enum: - image_id - type: string enum: - address - type: string enum: - groups - type: string enum: - children required: - type - column - type: object properties: required: type: boolean cols: type: object properties: xs: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto sm: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto md: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto lg: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto xl: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto required: - xs - sm - md - lg - xl - allOf: - type: object properties: type: type: string enum: - attribute attributeId: type: string required: - type - attributeId - type: object properties: required: type: boolean cols: type: object properties: xs: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto sm: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto md: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto lg: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto xl: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto required: - xs - sm - md - lg - xl mapConfig: type: object properties: show: type: boolean required: - show version: type: number required: - fields - mapConfig - version - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - id - label - description - icon - schema - controls_schema - device_type - parent_child_options - icon_svg - default_history_view - hide_attribute_if_undefined - categories - entity_type - asset_tabs - item_id /api/v/1/code/{systemKey}/fetchTableItems?id=eventTypesv2.read: post: tags: - Event Types description: Retrieve event types with more complex queries parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - eventTypesv2.read body: type: object properties: page: type: object properties: pageSize: type: number pageNumber: type: number searchText: type: string filters: type: object properties: ids: type: array items: type: string labels: type: array items: type: string groupIds: type: array items: type: string hasLifecycle: type: boolean event: type: object properties: severity: type: array items: type: number priority: type: array items: type: number assetIds: type: array items: type: string is_open: type: boolean labels: type: array items: type: string rule_types: type: array items: type: string rules: type: array items: type: string createdAt: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate lastUpdated: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate searchText: type: string ids: type: array items: type: string states: type: object properties: exclude: type: boolean values: type: array items: type: string required: - values sort: type: array items: type: object properties: field: anyOf: - type: string enum: - id - type: string enum: - label - type: string enum: - description - type: string enum: - has_lifecycle - type: string enum: - exclude_asset_trees direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - direction required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: type: object properties: id: type: string label: type: string severity: type: number priority: type: number action_types: type: array items: type: string description: type: string has_lifecycle: type: boolean exclude_asset_trees: type: boolean closed_states: type: array items: type: string open_states: type: array items: type: string groups: type: array items: type: object properties: id: type: string name: type: string required: - id - name attributes: anyOf: - type: array items: type: object properties: attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - boolean - type: string enum: - dateTime required: - attribute_name - attribute_label - attribute_type - type: object nullable: true enum: - null - nullable: true required: - id - label - severity - priority - action_types - description - has_lifecycle - exclude_asset_trees - closed_states - open_states - groups COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=eventTypesv2Count.read: post: tags: - Event Types description: Retrieve just the count of event types returned for a query parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - eventTypesv2Count.read body: type: object properties: page: type: object properties: pageSize: type: number pageNumber: type: number searchText: type: string filters: type: object properties: ids: type: array items: type: string labels: type: array items: type: string groupIds: type: array items: type: string hasLifecycle: type: boolean event: type: object properties: severity: type: array items: type: number priority: type: array items: type: number assetIds: type: array items: type: string is_open: type: boolean labels: type: array items: type: string rule_types: type: array items: type: string rules: type: array items: type: string createdAt: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate lastUpdated: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate searchText: type: string ids: type: array items: type: string states: type: object properties: exclude: type: boolean values: type: array items: type: string required: - values sort: type: array items: type: object properties: field: anyOf: - type: string enum: - id - type: string enum: - label - type: string enum: - description - type: string enum: - has_lifecycle - type: string enum: - exclude_asset_trees direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - direction required: - name - body responses: "200": description: Success content: application/json: schema: type: number /api/v/1/code/{systemKey}/fetchTableItems?id=ruleTypes.read: post: tags: - Rule Types description: Retrieve rule types parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - ruleTypes.read body: type: object properties: page: type: object properties: pageSize: type: number pageNumber: type: number searchText: type: string filters: type: object properties: ids: type: array items: type: string labels: type: array items: type: string sort: type: array items: type: object properties: field: anyOf: - type: string enum: - id - type: string enum: - label - type: string enum: - include_timeframe - type: string enum: - is_external - type: string enum: - is_invalid direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - direction columns: type: array items: anyOf: - type: string enum: - item_id - type: string enum: - id - type: string enum: - label - type: string enum: - include_timeframe - type: string enum: - conditions - type: string enum: - event_type_ids - type: string enum: - is_external - type: string enum: - is_invalid - type: string enum: - groups required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true include_timeframe: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true conditions: anyOf: - type: object properties: and: type: array items: anyOf: - type: object properties: type: type: string enum: - state meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 3 maxItems: 3 required: - type - meta - type: object properties: type: type: string enum: - area meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 4 maxItems: 4 required: - type - meta - type: object properties: type: type: string enum: - expression meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 2 maxItems: 2 required: - type - meta - type: object properties: and: type: array items: anyOf: - type: object properties: type: type: string enum: - state meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 3 maxItems: 3 required: - type - meta - type: object properties: type: type: string enum: - area meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 4 maxItems: 4 required: - type - meta - type: object properties: type: type: string enum: - expression meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 2 maxItems: 2 required: - type - meta - nullable: true - nullable: true or: type: array items: anyOf: - type: object properties: type: type: string enum: - state meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 3 maxItems: 3 required: - type - meta - type: object properties: type: type: string enum: - area meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 4 maxItems: 4 required: - type - meta - type: object properties: type: type: string enum: - expression meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 2 maxItems: 2 required: - type - meta - nullable: true - nullable: true or: type: array items: anyOf: - type: object properties: type: type: string enum: - state meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 3 maxItems: 3 required: - type - meta - type: object properties: type: type: string enum: - area meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 4 maxItems: 4 required: - type - meta - type: object properties: type: type: string enum: - expression meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 2 maxItems: 2 required: - type - meta - type: object properties: and: type: array items: anyOf: - type: object properties: type: type: string enum: - state meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 3 maxItems: 3 required: - type - meta - type: object properties: type: type: string enum: - area meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 4 maxItems: 4 required: - type - meta - type: object properties: type: type: string enum: - expression meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 2 maxItems: 2 required: - type - meta - nullable: true - nullable: true or: type: array items: anyOf: - type: object properties: type: type: string enum: - state meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 3 maxItems: 3 required: - type - meta - type: object properties: type: type: string enum: - area meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 4 maxItems: 4 required: - type - meta - type: object properties: type: type: string enum: - expression meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 2 maxItems: 2 required: - type - meta - nullable: true - nullable: true - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true event_type_ids: anyOf: - type: array items: type: string - type: object nullable: true enum: - null - nullable: true is_external: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true is_invalid: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true item_id: type: string groups: type: array items: type: object properties: id: type: string name: type: string required: - id - name required: - id - include_timeframe - conditions - label - event_type_ids - is_external - is_invalid - item_id - groups COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=ruleTypeByID.read: post: tags: - Rule Types description: Retrieve rule types parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - ruleTypeByID.read body: type: object properties: id: type: string required: - id required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true include_timeframe: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true conditions: anyOf: - type: object properties: and: type: array items: anyOf: - type: object properties: type: type: string enum: - state meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 3 maxItems: 3 required: - type - meta - type: object properties: type: type: string enum: - area meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 4 maxItems: 4 required: - type - meta - type: object properties: type: type: string enum: - expression meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 2 maxItems: 2 required: - type - meta - type: object properties: and: type: array items: anyOf: - type: object properties: type: type: string enum: - state meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 3 maxItems: 3 required: - type - meta - type: object properties: type: type: string enum: - area meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 4 maxItems: 4 required: - type - meta - type: object properties: type: type: string enum: - expression meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 2 maxItems: 2 required: - type - meta - nullable: true - nullable: true or: type: array items: anyOf: - type: object properties: type: type: string enum: - state meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 3 maxItems: 3 required: - type - meta - type: object properties: type: type: string enum: - area meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 4 maxItems: 4 required: - type - meta - type: object properties: type: type: string enum: - expression meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 2 maxItems: 2 required: - type - meta - nullable: true - nullable: true or: type: array items: anyOf: - type: object properties: type: type: string enum: - state meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 3 maxItems: 3 required: - type - meta - type: object properties: type: type: string enum: - area meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 4 maxItems: 4 required: - type - meta - type: object properties: type: type: string enum: - expression meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 2 maxItems: 2 required: - type - meta - type: object properties: and: type: array items: anyOf: - type: object properties: type: type: string enum: - state meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 3 maxItems: 3 required: - type - meta - type: object properties: type: type: string enum: - area meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 4 maxItems: 4 required: - type - meta - type: object properties: type: type: string enum: - expression meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 2 maxItems: 2 required: - type - meta - nullable: true - nullable: true or: type: array items: anyOf: - type: object properties: type: type: string enum: - state meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 3 maxItems: 3 required: - type - meta - type: object properties: type: type: string enum: - area meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 4 maxItems: 4 required: - type - meta - type: object properties: type: type: string enum: - expression meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 2 maxItems: 2 required: - type - meta - nullable: true - nullable: true - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true event_type_ids: anyOf: - type: array items: type: string - type: object nullable: true enum: - null - nullable: true is_external: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true is_invalid: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - id - include_timeframe - conditions - label - event_type_ids - is_external - is_invalid - item_id /api/v/1/code/{systemKey}/fetchTableItems?id=dataHistoryForAssetMap.read: post: tags: - Asset History description: Retrieve an asset's history data for map display parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - dataHistoryForAssetMap.read body: type: object properties: assetId: type: string startDate: type: string endDate: type: string recentAmount: type: number required: - assetId required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: type: object properties: change_date: type: string latitude: type: number longitude: type: number asset_id: type: string custom_data: type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: number - type: boolean - type: object nullable: true enum: - null - type: undefined enum: - null - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: string - type: number - type: boolean - nullable: true event_history: type: array items: type: object properties: eventId: type: string ruleLabel: type: string eventState: type: string eventWasOpen: type: boolean wasNewlyOpened: type: boolean required: - eventId - ruleLabel - eventState - eventWasOpen - wasNewlyOpened required: - change_date - latitude - longitude - asset_id COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=assetTree.read: post: tags: - Asset Tree description: Retrieve an asset's tree by the asset's id parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assetTree.read body: type: object properties: assetID: type: string required: - assetID required: - name - body responses: "200": description: Success content: application/json: schema: type: string /api/v/1/code/{systemKey}/fetchTableItems?id=assetsv2.read: post: tags: - Assets description: Retrieve assets with more complex queries parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assetsv2.read body: type: object properties: page: type: object properties: pageSize: type: number pageNumber: type: number searchText: type: string includeTrees: type: boolean columnType: anyOf: - type: string enum: - string - type: string enum: - int - type: string enum: - bool - type: string enum: - timestamp - type: string enum: - float - type: string enum: - bigint - type: string enum: - double - type: string enum: - blob - type: string enum: - uuid - type: string enum: - array - type: string enum: - object - type: string enum: - currency - type: string enum: - plotline - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary filters: type: object properties: isRoot: type: boolean types: type: array items: type: string ids: type: array items: type: string treeIds: type: array items: type: string treeIdsOfType: type: string groupIds: type: array items: type: string lastUpdated: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate mapBounds: type: object properties: minLong: type: number minLat: type: number maxLong: type: number maxLat: type: number required: - minLong - minLat - maxLong - maxLat events: type: object properties: is_open: type: object properties: value: type: boolean filterType: type: string enum: - boolean required: - filterType rule: type: object properties: value: type: array items: type: string filterType: type: string enum: - text required: - filterType eventState: type: object properties: value: type: array items: type: string filterType: type: string enum: - text required: - filterType created_at: type: object properties: value: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate filterType: type: string enum: - dateTime required: - value - filterType last_updated: type: object properties: value: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate filterType: type: string enum: - dateTime required: - value - filterType eventsCount: type: object properties: operator: anyOf: - type: string enum: - IS - type: string enum: - = - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - ">" - type: string enum: - < - type: string enum: - "!=" - type: string enum: - between - type: string enum: - notBetween value: anyOf: - type: number - type: array items: type: number minItems: 2 maxItems: 2 filterType: type: string enum: - number required: - filterType severity: type: object properties: operator: anyOf: - type: string enum: - IS - type: string enum: - = - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - ">" - type: string enum: - < - type: string enum: - "!=" - type: string enum: - between - type: string enum: - notBetween value: anyOf: - type: number - type: array items: type: number minItems: 2 maxItems: 2 filterType: type: string enum: - number required: - filterType priority: type: object properties: operator: anyOf: - type: string enum: - IS - type: string enum: - = - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - ">" - type: string enum: - < - type: string enum: - "!=" - type: string enum: - between - type: string enum: - notBetween value: anyOf: - type: number - type: array items: type: number minItems: 2 maxItems: 2 filterType: type: string enum: - number required: - filterType customData: type: array items: anyOf: - type: object properties: filterType: type: string enum: - number attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary operator: type: string enum: - between value: type: array items: type: number minItems: 2 maxItems: 2 required: - filterType - attribute_name - attribute_type - operator - value - type: object properties: filterType: type: string enum: - number attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary operator: type: string enum: - notBetween value: type: array items: type: number minItems: 2 maxItems: 2 required: - filterType - attribute_name - attribute_type - operator - value - type: object properties: filterType: type: string enum: - number attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary operator: anyOf: - type: string enum: - IS - type: string enum: - = - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - ">" - type: string enum: - < - type: string enum: - "!=" value: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - attribute_type - operator - value - type: object properties: filterType: type: string enum: - textSelect attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary value: type: array items: type: string required: - filterType - attribute_name - attribute_type - value - type: object properties: filterType: type: string enum: - text attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary operator: anyOf: - type: string enum: - contains - type: string enum: - notContains - type: string enum: - equals - type: string enum: - notEquals value: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - attribute_type - operator - value - type: object properties: filterType: type: string enum: - dateTime attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary value: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - attribute_type - value - type: object properties: filterType: type: string enum: - boolean attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary value: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - attribute_type - value textAttrValues: type: object properties: attribute_name: type: string attribute_label: type: string required: - attribute_name showRootsForMap: type: boolean floorLevels: type: object properties: levels: type: array items: type: number allowEmpty: type: boolean required: - levels - allowEmpty tags: type: array items: type: string returnTreeRootsOnly: type: boolean isReporting: type: array items: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true entityTypes: type: array items: anyOf: - type: string enum: - asset - type: string enum: - area showArchived: type: boolean rowGroupingFilters: type: array items: type: object properties: field: type: string title: type: string isCustom: type: boolean columnType: type: string sortDirection: type: string required: - field - title sort: type: array items: type: object properties: field: type: string direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - direction columns: type: array items: type: string required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true owners: anyOf: - type: array items: type: string - type: object nullable: true enum: - null - nullable: true latitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true longitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true image: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_data: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: number - type: boolean - type: object nullable: true enum: - null - type: undefined enum: - null - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: string - type: number - type: boolean - nullable: true - type: object nullable: true enum: - null - nullable: true attributes_last_updated: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true parent: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_x: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_y: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_z: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_unit: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_id_1: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_id_2: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_location_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true group_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true tree_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true is_root: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true floor_levels: anyOf: - type: array items: type: number - type: object nullable: true enum: - null - nullable: true attributes_labels: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: string - type: object nullable: true enum: - null - nullable: true is_reporting: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true attributes_is_reporting: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: boolean - type: object nullable: true enum: - null - nullable: true tags: type: array items: type: string attributes_errors: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: object properties: message: type: string timestamp: type: string required: - message - timestamp - type: object nullable: true enum: - null - nullable: true polygon: anyOf: - type: object properties: geometry_type: type: string enum: - gps polygon: anyOf: - type: array items: type: object properties: long: type: number lat: type: number required: - long - lat - type: object nullable: true enum: - null - nullable: true required: - geometry_type - type: object properties: geometry_type: type: string enum: - indoor_area polygon: anyOf: - type: array items: type: object properties: x: type: number y: type: number z: type: number required: - x - y - z - type: object nullable: true enum: - null - nullable: true required: - geometry_type - type: object properties: geometry_type: type: string enum: - indoor_model required: - geometry_type - type: object properties: geometry_type: type: string enum: - geojson features: type: array items: type: object properties: type: type: string enum: - Feature properties: type: object properties: {} geometry: anyOf: - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number required: - type - coordinates - type: object properties: type: type: string enum: - MultiPolygon coordinates: type: array items: type: array items: type: array items: type: array items: type: number required: - type - coordinates required: - type - properties - geometry required: - geometry_type - features - type: object nullable: true enum: - null - nullable: true is_archived: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true image_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true address: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true group_ids: anyOf: - type: array items: type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - id - owners - latitude - longitude - type - label - description - image - last_updated - location_updated - custom_data - attributes_last_updated - parent - location_x - location_y - location_z - location_type - location_unit - custom_id_1 - custom_id_2 - last_location_updated - group_id - tree_id - is_root - floor_levels - attributes_labels - group_ids - item_id COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=assetsv3.read: post: tags: - Assets description: Retrieve assets with complex queries and nested return types parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assetsv3.read body: type: object properties: page: type: object properties: pageSize: type: number pageNumber: type: number searchText: type: string searchFields: type: array items: anyOf: - type: string enum: - assets.id - type: string enum: - assets.label - type: string enum: - assets.custom_id_1 - type: string enum: - assets.custom_id_2 - type: string enum: - assets.type - type: string enum: - assets.description - type: string enum: - assets.custom_data - type: string enum: - asset_types.label - type: string enum: - groups.id - type: string enum: - groups.name filters: type: object properties: parentChild: anyOf: - type: string enum: - returnRootsOnly - type: string enum: - returnParentsOnly - type: string enum: - includeTrees - type: string enum: - includeTreesReturnRootsOnly - type: string enum: - showLocationEnabled ancestorIds: type: array items: type: object properties: ids: type: array items: type: string generationsAbove: type: number required: - ids - generationsAbove ancestorTypes: type: array items: type: object properties: types: type: array items: type: string generationsAbove: type: number required: - types - generationsAbove types: type: array items: type: string ids: type: array items: type: string treeIds: type: array items: type: string treeIdsOfType: type: string groupIds: type: array items: type: string tags: type: array items: type: string lastUpdated: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate mapBounds: type: object properties: minLong: type: number minLat: type: number maxLong: type: number maxLat: type: number required: - minLong - minLat - maxLong - maxLat customData: type: array items: anyOf: - type: object properties: filterType: type: string enum: - number attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary operator: type: string enum: - between value: type: array items: type: number minItems: 2 maxItems: 2 required: - filterType - attribute_name - attribute_type - operator - value - type: object properties: filterType: type: string enum: - number attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary operator: type: string enum: - notBetween value: type: array items: type: number minItems: 2 maxItems: 2 required: - filterType - attribute_name - attribute_type - operator - value - type: object properties: filterType: type: string enum: - number attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary operator: anyOf: - type: string enum: - IS - type: string enum: - = - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - ">" - type: string enum: - < - type: string enum: - "!=" value: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - attribute_type - operator - value - type: object properties: filterType: type: string enum: - textSelect attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary value: type: array items: type: string required: - filterType - attribute_name - attribute_type - value - type: object properties: filterType: type: string enum: - text attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary operator: anyOf: - type: string enum: - contains - type: string enum: - notContains - type: string enum: - equals - type: string enum: - notEquals value: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - attribute_type - operator - value - type: object properties: filterType: type: string enum: - dateTime attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary value: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - attribute_type - value - type: object properties: filterType: type: string enum: - boolean attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary value: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - attribute_type - value floorLevels: type: object properties: levels: type: array items: type: number allowEmpty: type: boolean required: - levels - allowEmpty rowGrouping: type: array items: anyOf: - type: object properties: field: anyOf: - type: string enum: - groups - type: string enum: - tree.id title: type: string isCustom: type: boolean enum: - false columnType: anyOf: - type: string enum: - string - type: string enum: - int - type: string enum: - bool - type: string enum: - timestamp - type: string enum: - float - type: string enum: - bigint - type: string enum: - double - type: string enum: - blob - type: string enum: - uuid - type: string enum: - array - type: string enum: - object - type: string enum: - currency - type: string enum: - plotline - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary required: - field - title - isCustom - type: object properties: field: anyOf: - type: string enum: - id - type: string enum: - custom_id_1 - type: string enum: - custom_id_2 - type: string enum: - label - type: string enum: - last_updated - type: string enum: - last_location_updated - type: string enum: - asset_type.id - type: string enum: - asset_type.label title: type: string sortDirection: anyOf: - type: string enum: - asc - type: string enum: - desc isCustom: type: boolean enum: - false columnType: anyOf: - type: string enum: - string - type: string enum: - int - type: string enum: - bool - type: string enum: - timestamp - type: string enum: - float - type: string enum: - bigint - type: string enum: - double - type: string enum: - blob - type: string enum: - uuid - type: string enum: - array - type: string enum: - object - type: string enum: - currency - type: string enum: - plotline - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary required: - field - title - isCustom - type: object properties: field: type: string title: type: string isCustom: type: boolean enum: - true columnType: anyOf: - type: string enum: - string - type: string enum: - int - type: string enum: - bool - type: string enum: - timestamp - type: string enum: - float - type: string enum: - bigint - type: string enum: - double - type: string enum: - blob - type: string enum: - uuid - type: string enum: - array - type: string enum: - object - type: string enum: - currency - type: string enum: - plotline - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary sortDirection: anyOf: - type: string enum: - asc - type: string enum: - desc required: - field - title - isCustom - columnType events: type: object properties: is_open: type: boolean ruleIds: type: array items: type: string ruleLabels: type: array items: type: string states: type: object properties: exclude: type: boolean values: type: array items: type: string required: - values createdAt: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate lastUpdated: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate eventsCount: type: object properties: operator: anyOf: - type: string enum: - IS - type: string enum: - = - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - ">" - type: string enum: - < - type: string enum: - "!=" - type: string enum: - between - type: string enum: - notBetween value: anyOf: - type: number - type: array items: type: number minItems: 2 maxItems: 2 severity: type: array items: type: number priority: type: array items: type: number excludeDescendantEvents: type: boolean entityTypes: type: array items: anyOf: - type: string enum: - asset - type: string enum: - area showArchived: anyOf: - type: string enum: - any - type: string enum: - active - type: string enum: - archived ancestorSort: type: array items: type: object properties: field: anyOf: - type: string enum: - label - type: string enum: - asset_type.label generationsAbove: type: number direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - generationsAbove - direction customDataSort: type: array items: type: object properties: field: type: string direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC columnType: anyOf: - type: string enum: - string - type: string enum: - int - type: string enum: - bool - type: string enum: - timestamp - type: string enum: - float - type: string enum: - bigint - type: string enum: - double - type: string enum: - blob - type: string enum: - uuid - type: string enum: - array - type: string enum: - object - type: string enum: - currency - type: string enum: - plotline - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary required: - field - direction - columnType sort: type: array items: type: object properties: field: anyOf: - type: string enum: - id - type: string enum: - custom_id_1 - type: string enum: - custom_id_2 - type: string enum: - label - type: string enum: - last_updated - type: string enum: - last_location_updated - type: string enum: - is_reporting - type: string enum: - asset_type.id - type: string enum: - asset_type.label - type: string enum: - asset_type.entity_type - type: string enum: - open_events_with_descendants.count direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - direction columns: type: array items: anyOf: - type: string enum: - id - type: string enum: - custom_id_1 - type: string enum: - custom_id_2 - type: string enum: - label - type: string enum: - description - type: string enum: - latitude - type: string enum: - longitude - type: string enum: - last_updated - type: string enum: - location_updated - type: string enum: - last_location_updated - type: string enum: - location_x - type: string enum: - location_y - type: string enum: - location_z - type: string enum: - location_type - type: string enum: - location_unit - type: string enum: - image - type: string enum: - owners - type: string enum: - parent - type: string enum: - is_root - type: string enum: - is_reporting - type: string enum: - asset_type.id - type: string enum: - asset_type.label - type: string enum: - asset_type.entity_type - type: string enum: - floor_levels - type: string enum: - custom_data - type: string enum: - attributes_last_updated - type: string enum: - attributes_labels - type: string enum: - tree.id - type: string enum: - tree.data - type: string enum: - groups - type: string enum: - tags - type: string enum: - openEvents.data - type: string enum: - openEvents.count - type: string enum: - polygon - type: string enum: - is_archived - type: string enum: - image_id - type: string enum: - address - type: string enum: - open_events_with_descendants.count - type: string enum: - open_events_with_descendants.severities - type: string enum: - open_events_with_descendants.event_types required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: allOf: - type: object properties: id: type: string required: - id - type: object properties: custom_id_1: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_id_2: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true latitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true longitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true last_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_location_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_x: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_y: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_z: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_unit: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true floor_levels: anyOf: - type: array items: type: number - type: object nullable: true enum: - null - nullable: true image: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true owners: type: array items: type: string custom_data: type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: number - type: boolean - type: object nullable: true enum: - null - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: string - type: number - type: boolean - nullable: true attributes_is_reporting: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: boolean - type: object nullable: true enum: - null - nullable: true attributes_last_updated: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: object nullable: true enum: - null - nullable: true attributes_labels: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: string - type: object nullable: true enum: - null - nullable: true ever_had_closed_event: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true attributes_errors: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: object properties: message: type: string timestamp: type: string required: - message - timestamp - type: object nullable: true enum: - null - nullable: true parent: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true is_root: type: boolean is_reporting: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true groups: type: array items: type: object properties: id: type: string name: type: string timezone: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - id - name - timezone tags: type: array items: type: string asset_type: type: object properties: id: type: string label: type: string entity_type: type: string tree: type: object properties: id: type: string data: type: object properties: rootID: type: string treeID: type: string nodes: type: object additionalProperties: type: object properties: id: type: string parentID: type: string children: type: array items: type: string required: - id - parentID - children required: - rootID - treeID - nodes openEvents: type: object properties: data: type: array items: type: object properties: id: type: string label: type: string severity: type: number priority: type: number rule: type: object properties: id: type: string label: type: string required: - id - label event_type: type: object properties: id: type: string label: type: string required: - id - label created_at: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_updated: type: string required: - id - label - severity - priority - rule - event_type - created_at - last_updated count: type: number open_events_with_descendants: type: object properties: count: type: number severities: type: array items: type: object properties: value: type: number count: type: number required: - value - count event_types: type: array items: type: object properties: id: type: string count: type: number required: - id - count polygon: anyOf: - type: object nullable: true enum: - null - type: object properties: geometry_type: type: string enum: - gps polygon: anyOf: - type: array items: type: object properties: long: type: number lat: type: number required: - long - lat - type: object nullable: true enum: - null - nullable: true required: - geometry_type - type: object properties: geometry_type: type: string enum: - indoor_area polygon: anyOf: - type: array items: type: object properties: x: type: number y: type: number z: type: number required: - x - y - z - type: object nullable: true enum: - null - nullable: true required: - geometry_type - type: object properties: geometry_type: type: string enum: - indoor_model required: - geometry_type - type: object properties: geometry_type: type: string enum: - geojson features: type: array items: type: object properties: type: type: string enum: - Feature properties: type: object properties: {} geometry: anyOf: - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number required: - type - coordinates - type: object properties: type: type: string enum: - MultiPolygon coordinates: type: array items: type: array items: type: array items: type: array items: type: number required: - type - coordinates required: - type - properties - geometry required: - geometry_type - features - nullable: true is_archived: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true image_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true address: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - custom_id_1 - custom_id_2 - label - description - latitude - longitude - last_updated - location_updated - last_location_updated - location_x - location_y - location_z - location_type - location_unit - floor_levels - image - owners - custom_data - attributes_is_reporting - attributes_last_updated - attributes_labels - ever_had_closed_event - attributes_errors - parent - is_root - is_reporting - groups - tags - asset_type - tree - openEvents - is_archived - image_id COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=assetByID.read: post: tags: - Assets description: Retrieve a single asset by ID parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assetByID.read body: type: object properties: id: type: string required: - id required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true owners: anyOf: - type: array items: type: string - type: object nullable: true enum: - null - nullable: true latitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true longitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true image: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_data: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: number - type: boolean - type: object nullable: true enum: - null - type: undefined enum: - null - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: string - type: number - type: boolean - nullable: true - type: object nullable: true enum: - null - nullable: true attributes_last_updated: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true parent: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_x: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_y: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_z: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_unit: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_id_1: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_id_2: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_location_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true group_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true tree_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true is_root: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true floor_levels: anyOf: - type: array items: type: number - type: object nullable: true enum: - null - nullable: true attributes_labels: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: string - type: object nullable: true enum: - null - nullable: true is_reporting: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true attributes_is_reporting: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: boolean - type: object nullable: true enum: - null - nullable: true tags: type: array items: type: string attributes_errors: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: object properties: message: type: string timestamp: type: string required: - message - timestamp - type: object nullable: true enum: - null - nullable: true polygon: anyOf: - type: object properties: geometry_type: type: string enum: - gps polygon: anyOf: - type: array items: type: object properties: long: type: number lat: type: number required: - long - lat - type: object nullable: true enum: - null - nullable: true required: - geometry_type - type: object properties: geometry_type: type: string enum: - indoor_area polygon: anyOf: - type: array items: type: object properties: x: type: number y: type: number z: type: number required: - x - y - z - type: object nullable: true enum: - null - nullable: true required: - geometry_type - type: object properties: geometry_type: type: string enum: - indoor_model required: - geometry_type - type: object properties: geometry_type: type: string enum: - geojson features: type: array items: type: object properties: type: type: string enum: - Feature properties: type: object properties: {} geometry: anyOf: - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number required: - type - coordinates - type: object properties: type: type: string enum: - MultiPolygon coordinates: type: array items: type: array items: type: array items: type: array items: type: number required: - type - coordinates required: - type - properties - geometry required: - geometry_type - features - type: object nullable: true enum: - null - nullable: true is_archived: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true image_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true address: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true group_ids: anyOf: - type: array items: type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - id - owners - latitude - longitude - type - label - description - image - last_updated - location_updated - custom_data - attributes_last_updated - parent - location_x - location_y - location_z - location_type - location_unit - custom_id_1 - custom_id_2 - last_location_updated - group_id - tree_id - is_root - floor_levels - attributes_labels - group_ids - item_id /api/v/1/code/{systemKey}/fetchTableItems?id=assetsv2Count.read: post: tags: - Assets description: Retrieve just the count of assets returned for a query parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assetsv2Count.read body: type: object properties: page: type: object properties: pageSize: type: number pageNumber: type: number searchText: type: string includeTrees: type: boolean columnType: anyOf: - type: string enum: - string - type: string enum: - int - type: string enum: - bool - type: string enum: - timestamp - type: string enum: - float - type: string enum: - bigint - type: string enum: - double - type: string enum: - blob - type: string enum: - uuid - type: string enum: - array - type: string enum: - object - type: string enum: - currency - type: string enum: - plotline - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary filters: type: object properties: isRoot: type: boolean types: type: array items: type: string ids: type: array items: type: string treeIds: type: array items: type: string treeIdsOfType: type: string groupIds: type: array items: type: string lastUpdated: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate mapBounds: type: object properties: minLong: type: number minLat: type: number maxLong: type: number maxLat: type: number required: - minLong - minLat - maxLong - maxLat events: type: object properties: is_open: type: object properties: value: type: boolean filterType: type: string enum: - boolean required: - filterType rule: type: object properties: value: type: array items: type: string filterType: type: string enum: - text required: - filterType eventState: type: object properties: value: type: array items: type: string filterType: type: string enum: - text required: - filterType created_at: type: object properties: value: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate filterType: type: string enum: - dateTime required: - value - filterType last_updated: type: object properties: value: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate filterType: type: string enum: - dateTime required: - value - filterType eventsCount: type: object properties: operator: anyOf: - type: string enum: - IS - type: string enum: - = - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - ">" - type: string enum: - < - type: string enum: - "!=" - type: string enum: - between - type: string enum: - notBetween value: anyOf: - type: number - type: array items: type: number minItems: 2 maxItems: 2 filterType: type: string enum: - number required: - filterType severity: type: object properties: operator: anyOf: - type: string enum: - IS - type: string enum: - = - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - ">" - type: string enum: - < - type: string enum: - "!=" - type: string enum: - between - type: string enum: - notBetween value: anyOf: - type: number - type: array items: type: number minItems: 2 maxItems: 2 filterType: type: string enum: - number required: - filterType priority: type: object properties: operator: anyOf: - type: string enum: - IS - type: string enum: - = - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - ">" - type: string enum: - < - type: string enum: - "!=" - type: string enum: - between - type: string enum: - notBetween value: anyOf: - type: number - type: array items: type: number minItems: 2 maxItems: 2 filterType: type: string enum: - number required: - filterType customData: type: array items: anyOf: - type: object properties: filterType: type: string enum: - number attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary operator: type: string enum: - between value: type: array items: type: number minItems: 2 maxItems: 2 required: - filterType - attribute_name - attribute_type - operator - value - type: object properties: filterType: type: string enum: - number attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary operator: type: string enum: - notBetween value: type: array items: type: number minItems: 2 maxItems: 2 required: - filterType - attribute_name - attribute_type - operator - value - type: object properties: filterType: type: string enum: - number attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary operator: anyOf: - type: string enum: - IS - type: string enum: - = - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - ">" - type: string enum: - < - type: string enum: - "!=" value: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - attribute_type - operator - value - type: object properties: filterType: type: string enum: - textSelect attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary value: type: array items: type: string required: - filterType - attribute_name - attribute_type - value - type: object properties: filterType: type: string enum: - text attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary operator: anyOf: - type: string enum: - contains - type: string enum: - notContains - type: string enum: - equals - type: string enum: - notEquals value: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - attribute_type - operator - value - type: object properties: filterType: type: string enum: - dateTime attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary value: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - attribute_type - value - type: object properties: filterType: type: string enum: - boolean attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary value: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - attribute_type - value textAttrValues: type: object properties: attribute_name: type: string attribute_label: type: string required: - attribute_name showRootsForMap: type: boolean floorLevels: type: object properties: levels: type: array items: type: number allowEmpty: type: boolean required: - levels - allowEmpty tags: type: array items: type: string returnTreeRootsOnly: type: boolean isReporting: type: array items: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true entityTypes: type: array items: anyOf: - type: string enum: - asset - type: string enum: - area showArchived: type: boolean rowGroupingFilters: type: array items: type: object properties: field: type: string title: type: string isCustom: type: boolean columnType: type: string sortDirection: type: string required: - field - title sort: type: array items: type: object properties: field: type: string direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - direction columns: type: array items: type: string required: - name - body responses: "200": description: Success content: application/json: schema: type: number /api/v/1/code/{systemKey}/fetchTableItems?id=assetsGroupBy.read: post: tags: - Assets description: Retrieve groupings for assets parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assetsGroupBy.read body: type: object properties: page: type: object properties: pageSize: type: number pageNumber: type: number groupBy: type: array items: anyOf: - type: object properties: type: type: string enum: - standard field: anyOf: - type: string enum: - asset_type.id - type: string enum: - groups - type: string enum: - tags required: - type - field - type: object properties: type: type: string enum: - custom field: type: string required: - type - field searchText: type: string filters: type: object properties: types: type: array items: type: string ids: type: array items: type: string treeIds: type: array items: type: string groupIds: type: array items: type: string tags: type: array items: type: string lastUpdated: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate mapBounds: type: object properties: minLong: type: number minLat: type: number maxLong: type: number maxLat: type: number required: - minLong - minLat - maxLong - maxLat customData: type: array items: anyOf: - type: object properties: filterType: type: string enum: - number attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary operator: type: string enum: - between value: type: array items: type: number minItems: 2 maxItems: 2 required: - filterType - attribute_name - attribute_type - operator - value - type: object properties: filterType: type: string enum: - number attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary operator: type: string enum: - notBetween value: type: array items: type: number minItems: 2 maxItems: 2 required: - filterType - attribute_name - attribute_type - operator - value - type: object properties: filterType: type: string enum: - number attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary operator: anyOf: - type: string enum: - IS - type: string enum: - = - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - ">" - type: string enum: - < - type: string enum: - "!=" value: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - attribute_type - operator - value - type: object properties: filterType: type: string enum: - textSelect attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary value: type: array items: type: string required: - filterType - attribute_name - attribute_type - value - type: object properties: filterType: type: string enum: - text attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary operator: anyOf: - type: string enum: - contains - type: string enum: - notContains - type: string enum: - equals - type: string enum: - notEquals value: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - attribute_type - operator - value - type: object properties: filterType: type: string enum: - dateTime attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary value: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - attribute_type - value - type: object properties: filterType: type: string enum: - boolean attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary value: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - attribute_type - value floorLevels: type: object properties: levels: type: array items: type: number allowEmpty: type: boolean required: - levels - allowEmpty events: type: object properties: is_open: type: boolean ruleIds: type: array items: type: string ruleLabels: type: array items: type: string states: type: object properties: exclude: type: boolean values: type: array items: type: string required: - values createdAt: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate lastUpdated: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate eventsCount: type: object properties: operator: anyOf: - type: string enum: - IS - type: string enum: - = - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - ">" - type: string enum: - < - type: string enum: - "!=" - type: string enum: - between - type: string enum: - notBetween value: anyOf: - type: number - type: array items: type: number minItems: 2 maxItems: 2 severity: type: array items: type: number priority: type: array items: type: number isReporting: type: array items: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true entityTypes: type: array items: anyOf: - type: string enum: - asset - type: string enum: - area customDataSort: type: array items: type: object properties: field: type: string direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC columnType: anyOf: - type: string enum: - string - type: string enum: - int - type: string enum: - bool - type: string enum: - timestamp - type: string enum: - float - type: string enum: - bigint - type: string enum: - double - type: string enum: - blob - type: string enum: - uuid - type: string enum: - array - type: string enum: - object - type: string enum: - currency - type: string enum: - plotline - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary required: - field - direction - columnType sort: type: array items: type: object properties: field: anyOf: - type: string enum: - asset_type.id - type: string enum: - groups - type: string enum: - tags direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - direction required: - groupBy required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: type: object properties: field: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true count: type: number fieldLabel: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - field - count COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=assetsv3Count.read: post: tags: - Assets description: Retrieve just the count of assets returned for a complex query parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assetsv3Count.read body: type: object properties: page: type: object properties: pageSize: type: number pageNumber: type: number searchText: type: string searchFields: type: array items: anyOf: - type: string enum: - assets.id - type: string enum: - assets.label - type: string enum: - assets.custom_id_1 - type: string enum: - assets.custom_id_2 - type: string enum: - assets.type - type: string enum: - assets.description - type: string enum: - assets.custom_data - type: string enum: - asset_types.label - type: string enum: - groups.id - type: string enum: - groups.name filters: type: object properties: parentChild: anyOf: - type: string enum: - returnRootsOnly - type: string enum: - returnParentsOnly - type: string enum: - includeTrees - type: string enum: - includeTreesReturnRootsOnly - type: string enum: - showLocationEnabled ancestorIds: type: array items: type: object properties: ids: type: array items: type: string generationsAbove: type: number required: - ids - generationsAbove ancestorTypes: type: array items: type: object properties: types: type: array items: type: string generationsAbove: type: number required: - types - generationsAbove types: type: array items: type: string ids: type: array items: type: string treeIds: type: array items: type: string treeIdsOfType: type: string groupIds: type: array items: type: string tags: type: array items: type: string lastUpdated: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate mapBounds: type: object properties: minLong: type: number minLat: type: number maxLong: type: number maxLat: type: number required: - minLong - minLat - maxLong - maxLat customData: type: array items: anyOf: - type: object properties: filterType: type: string enum: - number attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary operator: type: string enum: - between value: type: array items: type: number minItems: 2 maxItems: 2 required: - filterType - attribute_name - attribute_type - operator - value - type: object properties: filterType: type: string enum: - number attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary operator: type: string enum: - notBetween value: type: array items: type: number minItems: 2 maxItems: 2 required: - filterType - attribute_name - attribute_type - operator - value - type: object properties: filterType: type: string enum: - number attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary operator: anyOf: - type: string enum: - IS - type: string enum: - = - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - ">" - type: string enum: - < - type: string enum: - "!=" value: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - attribute_type - operator - value - type: object properties: filterType: type: string enum: - textSelect attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary value: type: array items: type: string required: - filterType - attribute_name - attribute_type - value - type: object properties: filterType: type: string enum: - text attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary operator: anyOf: - type: string enum: - contains - type: string enum: - notContains - type: string enum: - equals - type: string enum: - notEquals value: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - attribute_type - operator - value - type: object properties: filterType: type: string enum: - dateTime attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary value: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - attribute_type - value - type: object properties: filterType: type: string enum: - boolean attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary value: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - attribute_type - value floorLevels: type: object properties: levels: type: array items: type: number allowEmpty: type: boolean required: - levels - allowEmpty rowGrouping: type: array items: anyOf: - type: object properties: field: anyOf: - type: string enum: - groups - type: string enum: - tree.id title: type: string isCustom: type: boolean enum: - false columnType: anyOf: - type: string enum: - string - type: string enum: - int - type: string enum: - bool - type: string enum: - timestamp - type: string enum: - float - type: string enum: - bigint - type: string enum: - double - type: string enum: - blob - type: string enum: - uuid - type: string enum: - array - type: string enum: - object - type: string enum: - currency - type: string enum: - plotline - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary required: - field - title - isCustom - type: object properties: field: anyOf: - type: string enum: - id - type: string enum: - custom_id_1 - type: string enum: - custom_id_2 - type: string enum: - label - type: string enum: - last_updated - type: string enum: - last_location_updated - type: string enum: - asset_type.id - type: string enum: - asset_type.label title: type: string sortDirection: anyOf: - type: string enum: - asc - type: string enum: - desc isCustom: type: boolean enum: - false columnType: anyOf: - type: string enum: - string - type: string enum: - int - type: string enum: - bool - type: string enum: - timestamp - type: string enum: - float - type: string enum: - bigint - type: string enum: - double - type: string enum: - blob - type: string enum: - uuid - type: string enum: - array - type: string enum: - object - type: string enum: - currency - type: string enum: - plotline - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary required: - field - title - isCustom - type: object properties: field: type: string title: type: string isCustom: type: boolean enum: - true columnType: anyOf: - type: string enum: - string - type: string enum: - int - type: string enum: - bool - type: string enum: - timestamp - type: string enum: - float - type: string enum: - bigint - type: string enum: - double - type: string enum: - blob - type: string enum: - uuid - type: string enum: - array - type: string enum: - object - type: string enum: - currency - type: string enum: - plotline - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary sortDirection: anyOf: - type: string enum: - asc - type: string enum: - desc required: - field - title - isCustom - columnType events: type: object properties: is_open: type: boolean ruleIds: type: array items: type: string ruleLabels: type: array items: type: string states: type: object properties: exclude: type: boolean values: type: array items: type: string required: - values createdAt: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate lastUpdated: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate eventsCount: type: object properties: operator: anyOf: - type: string enum: - IS - type: string enum: - = - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - ">" - type: string enum: - < - type: string enum: - "!=" - type: string enum: - between - type: string enum: - notBetween value: anyOf: - type: number - type: array items: type: number minItems: 2 maxItems: 2 severity: type: array items: type: number priority: type: array items: type: number excludeDescendantEvents: type: boolean entityTypes: type: array items: anyOf: - type: string enum: - asset - type: string enum: - area showArchived: anyOf: - type: string enum: - any - type: string enum: - active - type: string enum: - archived ancestorSort: type: array items: type: object properties: field: anyOf: - type: string enum: - label - type: string enum: - asset_type.label generationsAbove: type: number direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - generationsAbove - direction customDataSort: type: array items: type: object properties: field: type: string direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC columnType: anyOf: - type: string enum: - string - type: string enum: - int - type: string enum: - bool - type: string enum: - timestamp - type: string enum: - float - type: string enum: - bigint - type: string enum: - double - type: string enum: - blob - type: string enum: - uuid - type: string enum: - array - type: string enum: - object - type: string enum: - currency - type: string enum: - plotline - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary required: - field - direction - columnType sort: type: array items: type: object properties: field: anyOf: - type: string enum: - id - type: string enum: - custom_id_1 - type: string enum: - custom_id_2 - type: string enum: - label - type: string enum: - last_updated - type: string enum: - last_location_updated - type: string enum: - is_reporting - type: string enum: - asset_type.id - type: string enum: - asset_type.label - type: string enum: - asset_type.entity_type - type: string enum: - open_events_with_descendants.count direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - direction columns: type: array items: anyOf: - type: string enum: - id - type: string enum: - custom_id_1 - type: string enum: - custom_id_2 - type: string enum: - label - type: string enum: - description - type: string enum: - latitude - type: string enum: - longitude - type: string enum: - last_updated - type: string enum: - location_updated - type: string enum: - last_location_updated - type: string enum: - location_x - type: string enum: - location_y - type: string enum: - location_z - type: string enum: - location_type - type: string enum: - location_unit - type: string enum: - image - type: string enum: - owners - type: string enum: - parent - type: string enum: - is_root - type: string enum: - is_reporting - type: string enum: - asset_type.id - type: string enum: - asset_type.label - type: string enum: - asset_type.entity_type - type: string enum: - floor_levels - type: string enum: - custom_data - type: string enum: - attributes_last_updated - type: string enum: - attributes_labels - type: string enum: - tree.id - type: string enum: - tree.data - type: string enum: - groups - type: string enum: - tags - type: string enum: - openEvents.data - type: string enum: - openEvents.count - type: string enum: - polygon - type: string enum: - is_archived - type: string enum: - image_id - type: string enum: - address - type: string enum: - open_events_with_descendants.count - type: string enum: - open_events_with_descendants.severities - type: string enum: - open_events_with_descendants.event_types required: - name - body responses: "200": description: Success content: application/json: schema: type: number /api/v/1/code/{systemKey}/fetchTableItems?id=attributeValues.read: post: tags: - Assets description: Retrieve every possible value for an attribute parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - attributeValues.read body: type: object properties: searchText: type: string filters: type: object properties: isRoot: type: boolean types: type: array items: type: string ids: type: array items: type: string treeIds: type: array items: type: string treeIdsOfType: type: string groupIds: type: array items: type: string lastUpdated: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate mapBounds: type: object properties: minLong: type: number minLat: type: number maxLong: type: number maxLat: type: number required: - minLong - minLat - maxLong - maxLat events: type: object properties: is_open: type: object properties: value: type: boolean filterType: type: string enum: - boolean required: - filterType rule: type: object properties: value: type: array items: type: string filterType: type: string enum: - text required: - filterType eventState: type: object properties: value: type: array items: type: string filterType: type: string enum: - text required: - filterType created_at: type: object properties: value: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate filterType: type: string enum: - dateTime required: - value - filterType last_updated: type: object properties: value: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate filterType: type: string enum: - dateTime required: - value - filterType eventsCount: type: object properties: operator: anyOf: - type: string enum: - IS - type: string enum: - = - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - ">" - type: string enum: - < - type: string enum: - "!=" - type: string enum: - between - type: string enum: - notBetween value: anyOf: - type: number - type: array items: type: number minItems: 2 maxItems: 2 filterType: type: string enum: - number required: - filterType severity: type: object properties: operator: anyOf: - type: string enum: - IS - type: string enum: - = - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - ">" - type: string enum: - < - type: string enum: - "!=" - type: string enum: - between - type: string enum: - notBetween value: anyOf: - type: number - type: array items: type: number minItems: 2 maxItems: 2 filterType: type: string enum: - number required: - filterType priority: type: object properties: operator: anyOf: - type: string enum: - IS - type: string enum: - = - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - ">" - type: string enum: - < - type: string enum: - "!=" - type: string enum: - between - type: string enum: - notBetween value: anyOf: - type: number - type: array items: type: number minItems: 2 maxItems: 2 filterType: type: string enum: - number required: - filterType customData: type: array items: anyOf: - type: object properties: filterType: type: string enum: - number attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary operator: type: string enum: - between value: type: array items: type: number minItems: 2 maxItems: 2 required: - filterType - attribute_name - attribute_type - operator - value - type: object properties: filterType: type: string enum: - number attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary operator: type: string enum: - notBetween value: type: array items: type: number minItems: 2 maxItems: 2 required: - filterType - attribute_name - attribute_type - operator - value - type: object properties: filterType: type: string enum: - number attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary operator: anyOf: - type: string enum: - IS - type: string enum: - = - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - ">" - type: string enum: - < - type: string enum: - "!=" value: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - attribute_type - operator - value - type: object properties: filterType: type: string enum: - textSelect attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary value: type: array items: type: string required: - filterType - attribute_name - attribute_type - value - type: object properties: filterType: type: string enum: - text attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary operator: anyOf: - type: string enum: - contains - type: string enum: - notContains - type: string enum: - equals - type: string enum: - notEquals value: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - attribute_type - operator - value - type: object properties: filterType: type: string enum: - dateTime attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary value: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - attribute_type - value - type: object properties: filterType: type: string enum: - boolean attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary value: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - attribute_type - value textAttrValues: type: object properties: attribute_name: type: string attribute_label: type: string required: - attribute_name showRootsForMap: type: boolean floorLevels: type: object properties: levels: type: array items: type: number allowEmpty: type: boolean required: - levels - allowEmpty tags: type: array items: type: string returnTreeRootsOnly: type: boolean isReporting: type: array items: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true entityTypes: type: array items: anyOf: - type: string enum: - asset - type: string enum: - area showArchived: type: boolean required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: object properties: values: type: array items: type: object properties: uuid: type: string text: type: string required: - uuid - text textOptions: type: array items: type: object properties: uuid: type: string text: type: string required: - uuid - text required: - values COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=assetComments.read: post: tags: - Asset Comments description: Retrieve asset comments parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assetComments.read body: type: object properties: page: type: object properties: pageSize: type: number pageNumber: type: number filters: type: object properties: asset_id: type: string required: - asset_id sort: type: array items: type: object properties: field: anyOf: - type: string enum: - id - type: string enum: - timestamp direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - direction required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: COUNT: type: number DATA: type: array items: nullable: true required: - COUNT - DATA /api/v/1/code/{systemKey}/fetchTableItems?id=eventsv2.read: post: tags: - Events description: Retrieve events with more complex queries parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - eventsv2.read body: type: object properties: page: type: object properties: pageSize: type: number pageNumber: type: number searchText: type: string filters: type: object properties: ids: type: array items: type: string types: type: array items: type: string groupIds: type: array items: type: string ancestorGroupIds: type: object properties: ids: type: array items: type: string required: - ids assetIds: type: array items: type: string assetTypes: type: array items: type: string is_open: type: boolean labels: type: array items: type: string lastUpdated: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate createdAt: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate rule_types: type: array items: type: string rules: type: array items: type: string severity: type: array items: type: number priority: type: array items: type: number states: type: object properties: exclude: type: boolean values: type: array items: type: string required: - values descendantAssetIds: type: array items: type: object properties: ids: type: array items: type: string generationsBelow: type: number required: - ids - generationsBelow ancestorAssetIds: type: array items: type: object properties: ids: type: array items: type: string generationsAbove: type: number required: - ids - generationsAbove ancestorAssetTypes: type: array items: type: object properties: types: type: array items: type: string generationsAbove: type: number required: - types - generationsAbove eventAttributes: type: array items: anyOf: - type: object properties: filterType: type: string enum: - number attribute_name: type: string operator: type: string enum: - between value: type: array items: type: number minItems: 2 maxItems: 2 required: - filterType - attribute_name - operator - value - type: object properties: filterType: type: string enum: - number attribute_name: type: string operator: type: string enum: - notBetween value: type: array items: type: number minItems: 2 maxItems: 2 required: - filterType - attribute_name - operator - value - type: object properties: filterType: type: string enum: - number attribute_name: type: string operator: anyOf: - type: string enum: - IS - type: string enum: - = - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - ">" - type: string enum: - < - type: string enum: - "!=" value: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - operator - value - type: object properties: filterType: type: string enum: - boolean attribute_name: type: string value: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - value - type: object properties: filterType: type: string enum: - dateTime attribute_name: type: string value: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - value - type: object properties: filterType: type: string enum: - text attribute_name: type: string operator: anyOf: - type: string enum: - contains - type: string enum: - notContains - type: string enum: - equals - type: string enum: - notEquals value: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - operator - value ancestorSort: type: array items: type: object properties: field: anyOf: - type: string enum: - label - type: string enum: - asset_type.label generationsAbove: type: number direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - generationsAbove - direction sort: type: array items: type: object properties: field: anyOf: - type: string enum: - id - type: string enum: - label - type: string enum: - description - type: string enum: - type - type: string enum: - state - type: string enum: - severity - type: string enum: - priority - type: string enum: - created_at - type: string enum: - last_updated - type: string enum: - is_open - type: string enum: - action_ids - type: string enum: - rule.id - type: string enum: - rule.label - type: string enum: - event_type.id - type: string enum: - event_type.label - type: string enum: - assets - type: string enum: - assets.label - type: string enum: - assets.type.label direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - direction eventAttributesSort: type: array items: type: object properties: field: type: string direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC columnType: anyOf: - type: string enum: - string - type: string enum: - int - type: string enum: - bool - type: string enum: - timestamp - type: string enum: - float - type: string enum: - bigint - type: string enum: - double - type: string enum: - blob - type: string enum: - uuid - type: string enum: - array - type: string enum: - object - type: string enum: - currency - type: string enum: - plotline - type: string enum: - text - type: string enum: - number - type: string enum: - boolean - type: string enum: - dateTime required: - field - direction - columnType columns: type: array items: type: string required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: type: object properties: action_ids: type: array items: type: string assets: type: object additionalProperties: allOf: - type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_data: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: number - type: boolean - type: object nullable: true enum: - null - type: undefined enum: - null - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: string - type: number - type: boolean - nullable: true - type: object nullable: true enum: - null - nullable: true longitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true latitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true last_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - id - type - label - custom_data - longitude - latitude - last_updated - type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true owners: anyOf: - type: array items: type: string - type: object nullable: true enum: - null - nullable: true latitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true longitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true image: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_data: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: number - type: boolean - type: object nullable: true enum: - null - type: undefined enum: - null - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: string - type: number - type: boolean - nullable: true - type: object nullable: true enum: - null - nullable: true attributes_last_updated: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true parent: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_x: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_y: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_z: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_unit: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_id_1: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_id_2: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_location_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true group_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true tree_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true is_root: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true floor_levels: anyOf: - type: array items: type: number - type: object nullable: true enum: - null - nullable: true attributes_labels: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: string - type: object nullable: true enum: - null - nullable: true is_reporting: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true attributes_is_reporting: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: boolean - type: object nullable: true enum: - null - nullable: true tags: type: array items: type: string attributes_errors: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: object properties: message: type: string timestamp: type: string required: - message - timestamp - type: object nullable: true enum: - null - nullable: true is_archived: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true image_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true address: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string polygon: anyOf: - type: object nullable: true enum: - null - type: object properties: geometry_type: type: string enum: - gps polygon: anyOf: - type: array items: type: object properties: long: type: number lat: type: number required: - long - lat - type: object nullable: true enum: - null - nullable: true - type: object properties: geometry_type: type: string enum: - indoor_area polygon: anyOf: - type: array items: type: object properties: x: type: number y: type: number z: type: number required: - x - y - z - type: object nullable: true enum: - null - nullable: true - type: object properties: geometry_type: type: string enum: - indoor_model - type: object properties: geometry_type: type: string enum: - geojson features: type: array items: type: object properties: type: type: string enum: - Feature properties: type: object properties: {} geometry: anyOf: - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number required: - type - coordinates - type: object properties: type: type: string enum: - MultiPolygon coordinates: type: array items: type: array items: type: array items: type: array items: type: number required: - type - coordinates required: - type - properties - geometry required: - geometry_type - features - nullable: true group_ids: anyOf: - type: array items: type: string - type: object nullable: true enum: - null - nullable: true entityType: type: string required: - id - owners - latitude - longitude - type - label - description - image - last_updated - location_updated - custom_data - attributes_last_updated - parent - location_x - location_y - location_z - location_type - location_unit - custom_id_1 - custom_id_2 - last_location_updated - group_id - tree_id - is_root - floor_levels - attributes_labels - item_id - type: object properties: treeAssets: type: array items: allOf: - type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_data: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: number - type: boolean - type: object nullable: true enum: - null - type: undefined enum: - null - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: string - type: number - type: boolean - nullable: true - type: object nullable: true enum: - null - nullable: true longitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true latitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true last_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - id - type - label - custom_data - longitude - latitude - last_updated - type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true owners: anyOf: - type: array items: type: string - type: object nullable: true enum: - null - nullable: true latitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true longitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true image: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_data: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: number - type: boolean - type: object nullable: true enum: - null - type: undefined enum: - null - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: string - type: number - type: boolean - nullable: true - type: object nullable: true enum: - null - nullable: true attributes_last_updated: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true parent: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_x: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_y: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_z: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_unit: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_id_1: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_id_2: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_location_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true group_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true tree_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true is_root: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true floor_levels: anyOf: - type: array items: type: number - type: object nullable: true enum: - null - nullable: true attributes_labels: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: string - type: object nullable: true enum: - null - nullable: true is_reporting: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true attributes_is_reporting: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: boolean - type: object nullable: true enum: - null - nullable: true tags: type: array items: type: string attributes_errors: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: object properties: message: type: string timestamp: type: string required: - message - timestamp - type: object nullable: true enum: - null - nullable: true is_archived: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true image_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true address: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string polygon: anyOf: - type: object nullable: true enum: - null - type: object properties: geometry_type: type: string enum: - gps polygon: anyOf: - type: array items: type: object properties: long: type: number lat: type: number required: - long - lat - type: object nullable: true enum: - null - nullable: true - type: object properties: geometry_type: type: string enum: - indoor_area polygon: anyOf: - type: array items: type: object properties: x: type: number y: type: number z: type: number required: - x - y - z - type: object nullable: true enum: - null - nullable: true - type: object properties: geometry_type: type: string enum: - indoor_model - type: object properties: geometry_type: type: string enum: - geojson features: type: array items: type: object properties: type: type: string enum: - Feature properties: type: object properties: {} geometry: anyOf: - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number required: - type - coordinates - type: object properties: type: type: string enum: - MultiPolygon coordinates: type: array items: type: array items: type: array items: type: array items: type: number required: - type - coordinates required: - type - properties - geometry required: - geometry_type - features - nullable: true group_ids: anyOf: - type: array items: type: string - type: object nullable: true enum: - null - nullable: true entityType: type: string required: - id - owners - latitude - longitude - type - label - description - image - last_updated - location_updated - custom_data - attributes_last_updated - parent - location_x - location_y - location_z - location_type - location_unit - custom_id_1 - custom_id_2 - last_location_updated - group_id - tree_id - is_root - floor_levels - attributes_labels - item_id tree: type: object properties: item_id: type: string id: type: string tree: type: object properties: rootID: type: string treeID: type: string nodes: type: object additionalProperties: anyOf: - type: undefined enum: - null - type: object properties: id: type: string parentID: type: string children: type: array items: type: string required: - id - parentID - children required: - rootID - treeID - nodes required: - id - tree created_at: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true description: type: string id: type: string is_open: type: boolean label: type: string last_updated: type: string priority: type: number rule_id: type: string severity: type: number state: type: string type: type: string rule: type: object properties: id: type: string label: type: string event_type: type: object properties: id: type: string label: type: string event_attributes: anyOf: - type: object additionalProperties: anyOf: - type: string - type: number - type: boolean - type: object nullable: true enum: - null - nullable: true required: - action_ids - assets - created_at - description - id - is_open - label - last_updated - priority - rule_id - severity - state - type - rule - event_type required: - DATA /api/v/1/code/{systemKey}/fetchTableItems?id=eventsv2Count.read: post: tags: - Events description: Retrieve just the count of events returned for a query parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - eventsv2Count.read body: type: object properties: page: type: object properties: pageSize: type: number pageNumber: type: number searchText: type: string filters: type: object properties: ids: type: array items: type: string types: type: array items: type: string groupIds: type: array items: type: string ancestorGroupIds: type: object properties: ids: type: array items: type: string required: - ids assetIds: type: array items: type: string assetTypes: type: array items: type: string is_open: type: boolean labels: type: array items: type: string lastUpdated: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate createdAt: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate rule_types: type: array items: type: string rules: type: array items: type: string severity: type: array items: type: number priority: type: array items: type: number states: type: object properties: exclude: type: boolean values: type: array items: type: string required: - values descendantAssetIds: type: array items: type: object properties: ids: type: array items: type: string generationsBelow: type: number required: - ids - generationsBelow ancestorAssetIds: type: array items: type: object properties: ids: type: array items: type: string generationsAbove: type: number required: - ids - generationsAbove ancestorAssetTypes: type: array items: type: object properties: types: type: array items: type: string generationsAbove: type: number required: - types - generationsAbove eventAttributes: type: array items: anyOf: - type: object properties: filterType: type: string enum: - number attribute_name: type: string operator: type: string enum: - between value: type: array items: type: number minItems: 2 maxItems: 2 required: - filterType - attribute_name - operator - value - type: object properties: filterType: type: string enum: - number attribute_name: type: string operator: type: string enum: - notBetween value: type: array items: type: number minItems: 2 maxItems: 2 required: - filterType - attribute_name - operator - value - type: object properties: filterType: type: string enum: - number attribute_name: type: string operator: anyOf: - type: string enum: - IS - type: string enum: - = - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - ">" - type: string enum: - < - type: string enum: - "!=" value: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - operator - value - type: object properties: filterType: type: string enum: - boolean attribute_name: type: string value: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - value - type: object properties: filterType: type: string enum: - dateTime attribute_name: type: string value: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - value - type: object properties: filterType: type: string enum: - text attribute_name: type: string operator: anyOf: - type: string enum: - contains - type: string enum: - notContains - type: string enum: - equals - type: string enum: - notEquals value: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - operator - value ancestorSort: type: array items: type: object properties: field: anyOf: - type: string enum: - label - type: string enum: - asset_type.label generationsAbove: type: number direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - generationsAbove - direction sort: type: array items: type: object properties: field: anyOf: - type: string enum: - id - type: string enum: - label - type: string enum: - description - type: string enum: - type - type: string enum: - state - type: string enum: - severity - type: string enum: - priority - type: string enum: - created_at - type: string enum: - last_updated - type: string enum: - is_open - type: string enum: - action_ids - type: string enum: - rule.id - type: string enum: - rule.label - type: string enum: - event_type.id - type: string enum: - event_type.label - type: string enum: - assets - type: string enum: - assets.label - type: string enum: - assets.type.label direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - direction eventAttributesSort: type: array items: type: object properties: field: type: string direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC columnType: anyOf: - type: string enum: - string - type: string enum: - int - type: string enum: - bool - type: string enum: - timestamp - type: string enum: - float - type: string enum: - bigint - type: string enum: - double - type: string enum: - blob - type: string enum: - uuid - type: string enum: - array - type: string enum: - object - type: string enum: - currency - type: string enum: - plotline - type: string enum: - text - type: string enum: - number - type: string enum: - boolean - type: string enum: - dateTime required: - field - direction - columnType columns: type: array items: type: string required: - name - body responses: "200": description: Success content: application/json: schema: type: number /api/v/1/code/{systemKey}/fetchTableItems?id=reports.read: post: tags: - Reports description: Retrieve reports parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - reports.read body: type: object properties: page: type: object properties: pageSize: type: number pageNumber: type: number searchText: type: string filters: type: object properties: ids: type: array items: type: string labels: type: array items: type: string groupIds: type: array items: type: string types: type: array items: type: string sort: type: array items: type: object properties: field: anyOf: - type: string enum: - id - type: string enum: - label - type: string enum: - created_on - type: string enum: - created_by - type: string enum: - type direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - direction required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true code_service_name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true group_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true schedules: anyOf: - type: array items: type: object properties: id: type: string label: type: string email_subject: type: string email_body: type: string email_recipients: type: array items: type: object properties: type: type: string enum: - email email: type: string required: - type - email report_time_range: type: object properties: type: type: string enum: - AMOUNT_OF_TIME value: type: object properties: amount: type: number units: anyOf: - type: string enum: - SECOND - type: string enum: - MINUTE - type: string enum: - HOUR - type: string enum: - DAY - type: string enum: - WEEK - type: string enum: - MONTH - type: string enum: - YEAR required: - amount - units required: - type - value start_date: type: string end_date: type: string repeat: anyOf: - type: object properties: type: type: string enum: - REPEAT_NONE value: type: object properties: amount: type: number units: anyOf: - type: string enum: - SECOND - type: string enum: - MINUTE - type: string enum: - HOUR - type: string enum: - DAY - type: string enum: - WEEK - type: string enum: - MONTH - type: string enum: - YEAR required: - amount - units required: - type - value - type: object properties: type: type: string enum: - AMOUNT_OF_TIME value: type: object properties: amount: type: number units: anyOf: - type: string enum: - SECOND - type: string enum: - MINUTE - type: string enum: - HOUR - type: string enum: - DAY - type: string enum: - WEEK - type: string enum: - MONTH - type: string enum: - YEAR required: - amount - units required: - type - value required: - id - label - email_subject - email_body - email_recipients - report_time_range - start_date - end_date - repeat - type: object nullable: true enum: - null - nullable: true type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true created_on: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true created_by: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - id - label - code_service_name - group_id - schedules - type - created_on - created_by - item_id COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=rules.read: post: tags: - Rules description: Retrieve rules parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - rules.read body: type: object properties: page: type: object properties: pageSize: type: number pageNumber: type: number searchText: type: string filters: type: object properties: ids: type: array items: type: string labels: type: array items: type: string ruleTypeIds: type: array items: type: string sort: type: array items: type: object properties: field: anyOf: - type: string enum: - id - type: string enum: - label - type: string enum: - priority - type: string enum: - severity - type: string enum: - is_invalid - type: string enum: - is_disabled direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - direction required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true timeframe: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true conditions: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true rule_type_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true priority: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true severity: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true event_type_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true action_ids: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true closes_ids: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true closed_by_rule: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true is_invalid: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true is_disabled: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true custom_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true allow_multiple_open_events: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true event_attributes: anyOf: - type: array items: type: object properties: attributeName: type: string attributeValue: anyOf: - type: object properties: type: type: string enum: - calculated formula: anyOf: - type: object properties: type: type: string enum: - constant value: anyOf: - type: number - type: string - type: boolean - type: array items: nullable: true required: - type - value - type: object properties: type: type: string enum: - variable path: type: array items: type: string params: type: object properties: {} required: - type - path - type: object properties: type: type: string enum: - arithmeticOperation operator: anyOf: - type: string enum: - + - type: string enum: - "-" - type: string enum: - "*" - type: string enum: - / - type: string enum: - "%" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - comparisonOperation operator: anyOf: - type: string enum: - ">" - type: string enum: - < - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - == - type: string enum: - "!=" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - logicalOperation operator: anyOf: - type: string enum: - AND - type: string enum: - OR - type: string enum: - NOT operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - if operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - switch operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - concat operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - split operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - sum operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - average operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - max operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - min operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - map operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - filter operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - reduce operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - length operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - contains operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - indexOf operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - concat operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mean operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - median operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mode operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - standardDeviation operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - variance operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - percentile operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object nullable: true enum: - null - nullable: true required: - type - formula - type: object properties: type: type: string enum: - assetAttribute assetAttributeName: type: string required: - type - assetAttributeName required: - attributeName - attributeValue - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - id - label - timeframe - conditions - rule_type_id - priority - severity - event_type_id - action_ids - closes_ids - closed_by_rule - is_invalid - is_disabled - custom_id - allow_multiple_open_events - item_id COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=actions.read: post: tags: - Actions description: Retrieve actions parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - actions.read body: type: object properties: page: type: object properties: pageSize: type: number pageNumber: type: number filters: type: object properties: ids: type: array items: type: string actionTypeIds: type: array items: type: string sort: type: array items: type: object properties: field: anyOf: - type: string enum: - id - type: string enum: - name - type: string enum: - type - type: string enum: - is_centralized direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - direction columns: type: array items: anyOf: - type: string enum: - item_id - type: string enum: - id - type: string enum: - name - type: string enum: - type - type: string enum: - config - type: string enum: - is_centralized - type: string enum: - notification_settings required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: type: object properties: name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true config: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - nullable: true - nullable: true - type: object nullable: true enum: - null - nullable: true type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true is_centralized: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true notification_settings: anyOf: - type: object properties: enabled_formula: anyOf: - type: object properties: enabled: type: boolean enum: - true value: anyOf: - type: object properties: type: type: string enum: - constant value: anyOf: - type: number - type: string - type: boolean - type: array items: nullable: true required: - type - value - type: object properties: type: type: string enum: - variable path: type: array items: type: string params: type: object properties: {} required: - type - path - type: object properties: type: type: string enum: - arithmeticOperation operator: anyOf: - type: string enum: - + - type: string enum: - "-" - type: string enum: - "*" - type: string enum: - / - type: string enum: - "%" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - comparisonOperation operator: anyOf: - type: string enum: - ">" - type: string enum: - < - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - == - type: string enum: - "!=" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - logicalOperation operator: anyOf: - type: string enum: - AND - type: string enum: - OR - type: string enum: - NOT operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - if operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - switch operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - concat operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - split operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - sum operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - average operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - max operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - min operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - map operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - filter operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - reduce operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - length operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - contains operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - indexOf operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - concat operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mean operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - median operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mode operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - standardDeviation operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - variance operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - percentile operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object nullable: true enum: - null - nullable: true required: - enabled - value - type: object properties: enabled: type: boolean enum: - false value: type: undefined enum: - null required: - enabled grace_period: anyOf: - type: object properties: enabled: type: boolean enum: - true value: type: object properties: amount: type: number units: anyOf: - type: string enum: - SECOND - type: string enum: - MINUTE - type: string enum: - HOUR - type: string enum: - DAY - type: string enum: - WEEK - type: string enum: - MONTH - type: string enum: - YEAR required: - amount - units required: - enabled - value - type: object properties: enabled: type: boolean enum: - false value: type: undefined enum: - null required: - enabled recipient_formula: anyOf: - type: object properties: enabled: type: boolean enum: - true value: anyOf: - type: object properties: type: type: string enum: - constant value: anyOf: - type: number - type: string - type: boolean - type: array items: nullable: true required: - type - value - type: object properties: type: type: string enum: - variable path: type: array items: type: string params: type: object properties: {} required: - type - path - type: object properties: type: type: string enum: - arithmeticOperation operator: anyOf: - type: string enum: - + - type: string enum: - "-" - type: string enum: - "*" - type: string enum: - / - type: string enum: - "%" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - comparisonOperation operator: anyOf: - type: string enum: - ">" - type: string enum: - < - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - == - type: string enum: - "!=" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - logicalOperation operator: anyOf: - type: string enum: - AND - type: string enum: - OR - type: string enum: - NOT operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - if operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - switch operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - concat operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - split operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - sum operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - average operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - max operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - min operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - map operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - filter operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - reduce operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - length operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - contains operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - indexOf operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - concat operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mean operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - median operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mode operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - standardDeviation operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - variance operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - percentile operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object nullable: true enum: - null - nullable: true required: - enabled - value - type: object properties: enabled: type: boolean enum: - false value: type: undefined enum: - null required: - enabled - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - name - config - type - id - is_centralized - notification_settings - item_id COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=eventHistoryForEvent.read: post: tags: - Events description: Retrieve event history for a specific event parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - eventHistoryForEvent.read body: type: object properties: eventId: type: string required: - eventId required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: type: object properties: event_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true timestamp: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true transition_attribute: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true transition_value: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true updated_by: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true assets: anyOf: - type: object additionalProperties: type: object properties: last_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_location_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - last_updated - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - event_id - timestamp - transition_attribute - transition_value - updated_by - assets - item_id COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=assetTrees.read: post: tags: - Asset Tree description: Retrieve asset trees by the tree id parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assetTrees.read body: type: object properties: page: type: object properties: pageSize: type: number pageNumber: type: number filters: type: object properties: ids: type: array items: type: string itemIds: type: array items: type: string sort: type: array items: type: object properties: field: anyOf: - type: string enum: - item_id - type: string enum: - id direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - direction columns: type: array items: anyOf: - type: string enum: - item_id - type: string enum: - id - type: string enum: - tree required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true tree: anyOf: - type: object properties: rootID: type: string treeID: type: string nodes: type: object additionalProperties: type: object properties: id: type: string parentID: type: string children: type: array items: type: string required: - id - parentID - children required: - rootID - treeID - nodes - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - id - tree - item_id COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=heatmapReports.read: post: tags: - Heatmaps description: Retrieve heatmap reports parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - heatmapReports.read body: type: object properties: page: type: object properties: pageSize: type: number pageNumber: type: number searchText: type: string filters: type: object properties: ids: type: array items: type: string labels: type: array items: type: string groupIds: type: array items: type: string assetTypes: type: array items: type: string attributeNames: type: array items: type: string sort: type: array items: type: object properties: field: anyOf: - type: string enum: - id - type: string enum: - label - type: string enum: - created_on - type: string enum: - created_by - type: string enum: - asset_type - type: string enum: - attribute_name direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - direction required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true group_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true asset_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true attribute_name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location: anyOf: - type: object properties: type: type: string enum: - area ids: type: array items: type: string required: - type - ids - type: object properties: type: type: string enum: - bounds bounds: type: array items: type: number minItems: 4 maxItems: 4 required: - type - bounds - type: object nullable: true enum: - null - nullable: true analysis: anyOf: - type: object properties: type: type: string enum: - numerical analysis: type: object properties: statistic: anyOf: - type: string enum: - MIN - type: string enum: - MAX - type: string enum: - AVG range: anyOf: - type: object properties: enabled: type: boolean enum: - true minMax: type: array items: type: number minItems: 2 maxItems: 2 required: - enabled - minMax - type: object properties: enabled: type: boolean enum: - false required: - enabled required: - statistic - range required: - type - analysis - type: object nullable: true enum: - null - nullable: true date_range: anyOf: - type: object properties: startDate: type: string endDate: type: string rangeSelection: anyOf: - type: number enum: - 1 - type: number enum: - 7 - type: number enum: - 30 - type: number enum: - 90 - type: number enum: - 180 - type: number enum: - 0 - type: number enum: - -1 required: - startDate - endDate - rangeSelection - type: object nullable: true enum: - null - nullable: true created_on: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true created_by: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - id - label - group_id - asset_type - attribute_name - location - analysis - date_range - created_on - created_by - item_id COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=heatmapAssetDetails.read: post: tags: - Heatmaps description: Retrieve asset details for heatmap reports parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - heatmapAssetDetails.read body: type: object properties: assetId: type: string date_range: type: object properties: startDate: type: string endDate: type: string rangeSelection: anyOf: - type: number enum: - 1 - type: number enum: - 7 - type: number enum: - 30 - type: number enum: - 90 - type: number enum: - 180 - type: number enum: - 0 - type: number enum: - -1 required: - startDate - endDate - rangeSelection numericalAttributes: type: array items: type: string required: - assetId - date_range - numericalAttributes required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: asset: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true owners: anyOf: - type: array items: type: string - type: object nullable: true enum: - null - nullable: true latitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true longitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true image: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_data: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: number - type: boolean - type: object nullable: true enum: - null - type: undefined enum: - null - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: string - type: number - type: boolean - nullable: true - type: object nullable: true enum: - null - nullable: true attributes_last_updated: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true parent: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_x: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_y: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_z: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_unit: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_id_1: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_id_2: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_location_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true group_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true tree_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true is_root: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true floor_levels: anyOf: - type: array items: type: number - type: object nullable: true enum: - null - nullable: true attributes_labels: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: string - type: object nullable: true enum: - null - nullable: true is_reporting: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true attributes_is_reporting: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: boolean - type: object nullable: true enum: - null - nullable: true tags: type: array items: type: string attributes_errors: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: object properties: message: type: string timestamp: type: string required: - message - timestamp - type: object nullable: true enum: - null - nullable: true polygon: anyOf: - type: object properties: geometry_type: type: string enum: - gps polygon: anyOf: - type: array items: type: object properties: long: type: number lat: type: number required: - long - lat - type: object nullable: true enum: - null - nullable: true required: - geometry_type - type: object properties: geometry_type: type: string enum: - indoor_area polygon: anyOf: - type: array items: type: object properties: x: type: number y: type: number z: type: number required: - x - y - z - type: object nullable: true enum: - null - nullable: true required: - geometry_type - type: object properties: geometry_type: type: string enum: - indoor_model required: - geometry_type - type: object properties: geometry_type: type: string enum: - geojson features: type: array items: type: object properties: type: type: string enum: - Feature properties: type: object properties: {} geometry: anyOf: - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number required: - type - coordinates - type: object properties: type: type: string enum: - MultiPolygon coordinates: type: array items: type: array items: type: array items: type: array items: type: number required: - type - coordinates required: - type - properties - geometry required: - geometry_type - features - type: object nullable: true enum: - null - nullable: true is_archived: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true image_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true address: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true group_ids: anyOf: - type: array items: type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - id - owners - latitude - longitude - type - label - description - image - last_updated - location_updated - custom_data - attributes_last_updated - parent - location_x - location_y - location_z - location_type - location_unit - custom_id_1 - custom_id_2 - last_location_updated - group_id - tree_id - is_root - floor_levels - attributes_labels - group_ids - item_id custom_data_stats: nullable: true required: - asset /api/v/1/code/{systemKey}/fetchTableItems?id=assetImageHistory.read: post: tags: - Asset Images description: Retrieve asset image history parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assetImageHistory.read body: type: object properties: page: type: object properties: pageSize: type: number pageNumber: type: number filters: type: object properties: assetIds: type: array items: type: string imageIds: type: array items: type: string ids: type: array items: type: string sort: type: array items: type: object properties: field: anyOf: - type: string enum: - asset_id - type: string enum: - upload_datetime - type: string enum: - image_id - type: string enum: - last_modified - type: string enum: - name - type: string enum: - item_id direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - direction columns: type: array items: anyOf: - type: string enum: - asset_id - type: string enum: - upload_datetime - type: string enum: - image_id - type: string enum: - last_modified - type: string enum: - name - type: string enum: - item_id required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: type: object properties: asset_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true upload_datetime: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true image_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_modified: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - asset_id - upload_datetime - image_id - last_modified - name - item_id COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=regionalDeviceConfigs.read: post: tags: - Device Config description: Retrieve regional device configurations parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - regionalDeviceConfigs.read body: type: object properties: page: type: object properties: pageSize: type: number pageNumber: type: number columns: type: array items: anyOf: - type: string enum: - id - type: string enum: - device_type - type: string enum: - config - type: string enum: - asset_id - type: string enum: - version - type: string enum: - created_by - type: string enum: - created_at filters: type: object properties: deviceTypes: type: array items: type: string assetIds: type: array items: type: string versions: type: array items: type: number ids: type: array items: type: string required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: allOf: - type: object properties: id: type: string asset_id: type: string required: - id - asset_id - type: object properties: device_type: type: string config: type: object properties: {} required: - device_type - config COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=deviceConfigFile.read: post: tags: - Device Config description: Retrieve the configuration details for a device parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - deviceConfigFile.read body: anyOf: - type: object properties: asset_id: type: string required: - asset_id - type: object properties: file_id: type: string required: - file_id - type: object properties: version: type: number asset_id: type: string required: - version - asset_id required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: allOf: - type: object properties: file_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true asset_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true version: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true bucket_set: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true upload_timestamp: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true upload_user_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true file_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - file_id - asset_id - version - bucket_set - upload_timestamp - upload_user_id - file_type - item_id - type: object properties: data: nullable: true - type: object properties: asset: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true owners: anyOf: - type: array items: type: string - type: object nullable: true enum: - null - nullable: true latitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true longitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true image: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_data: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: number - type: boolean - type: object nullable: true enum: - null - type: undefined enum: - null - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: string - type: number - type: boolean - nullable: true - type: object nullable: true enum: - null - nullable: true attributes_last_updated: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true parent: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_x: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_y: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_z: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_unit: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_id_1: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_id_2: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_location_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true group_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true tree_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true is_root: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true floor_levels: anyOf: - type: array items: type: number - type: object nullable: true enum: - null - nullable: true attributes_labels: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: string - type: object nullable: true enum: - null - nullable: true is_reporting: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true attributes_is_reporting: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: boolean - type: object nullable: true enum: - null - nullable: true tags: type: array items: type: string attributes_errors: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: object properties: message: type: string timestamp: type: string required: - message - timestamp - type: object nullable: true enum: - null - nullable: true polygon: anyOf: - type: object properties: geometry_type: type: string enum: - gps polygon: anyOf: - type: array items: type: object properties: long: type: number lat: type: number required: - long - lat - type: object nullable: true enum: - null - nullable: true required: - geometry_type - type: object properties: geometry_type: type: string enum: - indoor_area polygon: anyOf: - type: array items: type: object properties: x: type: number y: type: number z: type: number required: - x - y - z - type: object nullable: true enum: - null - nullable: true required: - geometry_type - type: object properties: geometry_type: type: string enum: - indoor_model required: - geometry_type - type: object properties: geometry_type: type: string enum: - geojson features: type: array items: type: object properties: type: type: string enum: - Feature properties: type: object properties: {} geometry: anyOf: - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number required: - type - coordinates - type: object properties: type: type: string enum: - MultiPolygon coordinates: type: array items: type: array items: type: array items: type: array items: type: number required: - type - coordinates required: - type - properties - geometry required: - geometry_type - features - type: object nullable: true enum: - null - nullable: true is_archived: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true image_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true address: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true group_ids: anyOf: - type: array items: type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - id - owners - latitude - longitude - type - label - description - image - last_updated - location_updated - custom_data - attributes_last_updated - parent - location_x - location_y - location_z - location_type - location_unit - custom_id_1 - custom_id_2 - last_location_updated - group_id - tree_id - is_root - floor_levels - attributes_labels - group_ids - item_id required: - asset COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=deviceConfigFileMetaList.read: post: tags: - Device Config description: Retrieve a list of configuration versions for a specific device parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - deviceConfigFileMetaList.read body: type: object properties: asset_id: type: string required: - asset_id required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: type: object properties: file_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true asset_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true version: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - file_id - asset_id - version - item_id COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=deviceConfigsList.read: post: tags: - Device Config description: Retrieve a list of devices with their most recent configuration details parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - deviceConfigsList.read body: type: object properties: query: type: object properties: PrimaryKey: type: array items: type: string Order: type: array items: type: object properties: SortOrder: type: boolean OrderKey: type: string required: - SortOrder - OrderKey PageSize: type: number PageNumber: type: number Queries: type: array items: type: array items: type: object properties: Operator: type: string Field: type: string Value: nullable: true required: - Operator - Field Columns: type: array items: type: string Distinct: type: string GroupBy: type: array items: type: string RawQuery: type: string required: - PrimaryKey - Order - PageSize - PageNumber - Queries - Columns - Distinct - GroupBy - RawQuery required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: allOf: - type: object properties: file_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true asset_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true version: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true bucket_set: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true upload_timestamp: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true upload_user_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true file_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - file_id - asset_id - version - bucket_set - upload_timestamp - upload_user_id - file_type - item_id - type: object properties: asset: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true owners: anyOf: - type: array items: type: string - type: object nullable: true enum: - null - nullable: true latitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true longitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true image: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_data: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: number - type: boolean - type: object nullable: true enum: - null - type: undefined enum: - null - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: string - type: number - type: boolean - nullable: true - type: object nullable: true enum: - null - nullable: true attributes_last_updated: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true parent: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_x: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_y: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_z: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_unit: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_id_1: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_id_2: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_location_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true group_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true tree_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true is_root: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true floor_levels: anyOf: - type: array items: type: number - type: object nullable: true enum: - null - nullable: true attributes_labels: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: string - type: object nullable: true enum: - null - nullable: true is_reporting: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true attributes_is_reporting: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: boolean - type: object nullable: true enum: - null - nullable: true tags: type: array items: type: string attributes_errors: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: object properties: message: type: string timestamp: type: string required: - message - timestamp - type: object nullable: true enum: - null - nullable: true polygon: anyOf: - type: object properties: geometry_type: type: string enum: - gps polygon: anyOf: - type: array items: type: object properties: long: type: number lat: type: number required: - long - lat - type: object nullable: true enum: - null - nullable: true required: - geometry_type - type: object properties: geometry_type: type: string enum: - indoor_area polygon: anyOf: - type: array items: type: object properties: x: type: number y: type: number z: type: number required: - x - y - z - type: object nullable: true enum: - null - nullable: true required: - geometry_type - type: object properties: geometry_type: type: string enum: - indoor_model required: - geometry_type - type: object properties: geometry_type: type: string enum: - geojson features: type: array items: type: object properties: type: type: string enum: - Feature properties: type: object properties: {} geometry: anyOf: - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number required: - type - coordinates - type: object properties: type: type: string enum: - MultiPolygon coordinates: type: array items: type: array items: type: array items: type: array items: type: number required: - type - coordinates required: - type - properties - geometry required: - geometry_type - features - type: object nullable: true enum: - null - nullable: true is_archived: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true image_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true address: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true group_ids: anyOf: - type: array items: type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - id - owners - latitude - longitude - type - label - description - image - last_updated - location_updated - custom_data - attributes_last_updated - parent - location_x - location_y - location_z - location_type - location_unit - custom_id_1 - custom_id_2 - last_location_updated - group_id - tree_id - is_root - floor_levels - attributes_labels - group_ids - item_id required: - asset COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=templateConfigFile.read: post: tags: - Device Config description: Retrieve the configuration details for a template parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - templateConfigFile.read body: anyOf: - type: object properties: id: type: string required: - id - type: object properties: file_id: type: string required: - file_id - type: object properties: version: type: number id: type: string required: - version - id required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: allOf: - type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true file_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true template_name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true device_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true version: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true bucket_set: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true upload_timestamp: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true upload_user_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true file_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - id - file_id - template_name - description - device_type - version - bucket_set - upload_timestamp - upload_user_id - file_type - item_id - type: object properties: data: nullable: true COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=templateConfigFileMetaList.read: post: tags: - Device Config description: Retrieve a list of configuration versions for a specific template parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - templateConfigFileMetaList.read body: type: object properties: id: type: string required: - id required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true file_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true template_name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true device_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true version: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - id - file_id - template_name - device_type - version - description - item_id COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=templateConfigsList.read: post: tags: - Device Config description: Retrieve a list of templates with their most recent configuration details parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - templateConfigsList.read body: type: object properties: query: type: object properties: PrimaryKey: type: array items: type: string Order: type: array items: type: object properties: SortOrder: type: boolean OrderKey: type: string required: - SortOrder - OrderKey PageSize: type: number PageNumber: type: number Queries: type: array items: type: array items: type: object properties: Operator: type: string Field: type: string Value: nullable: true required: - Operator - Field Columns: type: array items: type: string Distinct: type: string GroupBy: type: array items: type: string RawQuery: type: string required: - PrimaryKey - Order - PageSize - PageNumber - Queries - Columns - Distinct - GroupBy - RawQuery required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true file_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true template_name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true device_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true version: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true bucket_set: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true upload_timestamp: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true upload_user_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true file_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - id - file_id - template_name - description - device_type - version - bucket_set - upload_timestamp - upload_user_id - file_type - item_id COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=dashboardsv2.read: post: tags: - Dashboards description: Retrieve dashboards with more complex queries parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - dashboardsv2.read body: type: object properties: page: type: object properties: pageSize: type: number pageNumber: type: number searchText: type: string filters: type: object properties: ids: type: array items: type: string groupIds: type: array items: type: string lastUpdated: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate lastUpdatedBy: type: array items: type: string columns: type: array items: anyOf: - type: string enum: - id - type: string enum: - label - type: string enum: - last_updated - type: string enum: - last_updated_by - type: string enum: - pages - type: string enum: - description - type: string enum: - microfrontend_id - type: string enum: - version - type: string enum: - defaults - type: string enum: - groups sort: type: array items: type: object properties: field: anyOf: - type: string enum: - id - type: string enum: - label - type: string enum: - last_updated - type: string enum: - last_updated_by - type: string enum: - groups direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - direction required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: allOf: - type: object properties: id: type: string required: - id - type: object properties: version: type: string enum: - 1.0.0 label: type: string last_updated: type: string last_updated_by: type: string pages: type: array items: type: object properties: version: type: string enum: - 1.0.0 id: type: string header: type: string controlLayouts: nullable: true mainLayouts: nullable: true widgets: type: array items: type: object properties: id: type: string description: type: string header: type: string visualization: type: object properties: type: type: string purpose: anyOf: - type: string enum: - TIME - type: string enum: - ITEM - type: string enum: - TABULAR - type: string enum: - CONTROL - type: string enum: - INDICATOR - type: string enum: - PERCENTAGE - type: string enum: - IMAGE required: - type - purpose version: type: string queries: nullable: true settings: nullable: true required: - id - description - header - visualization - version required: - version - id - header - widgets description: type: string microfrontend_id: type: string defaults: type: object properties: time_range: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate refresh_rate: type: object properties: count: type: number units: anyOf: - type: number enum: - 1 - type: number enum: - 60 - type: number enum: - 3600 - type: number enum: - 86400 - type: number enum: - 604800 - type: number enum: - 2592000 - type: number enum: - 31104000 required: - count - units groups: type: array items: type: object properties: id: type: string name: type: string required: - id - name required: - version - label - last_updated - last_updated_by - pages - groups COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=dashboardsv2Count.read: post: tags: - Dashboards description: Retrieve just the count of dashboards returned for a query parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - dashboardsv2Count.read body: type: object properties: page: type: object properties: pageSize: type: number pageNumber: type: number searchText: type: string filters: type: object properties: ids: type: array items: type: string groupIds: type: array items: type: string lastUpdated: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate lastUpdatedBy: type: array items: type: string columns: type: array items: anyOf: - type: string enum: - id - type: string enum: - label - type: string enum: - last_updated - type: string enum: - last_updated_by - type: string enum: - pages - type: string enum: - description - type: string enum: - microfrontend_id - type: string enum: - version - type: string enum: - defaults - type: string enum: - groups sort: type: array items: type: object properties: field: anyOf: - type: string enum: - id - type: string enum: - label - type: string enum: - last_updated - type: string enum: - last_updated_by - type: string enum: - groups direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - direction required: - name - body responses: "200": description: Success content: application/json: schema: type: number /api/v/1/code/{systemKey}/fetchTableItems?id=plotsDataV3.read: post: tags: - Asset History description: Retrieve plot data parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - plotsDataV3.read body: type: object properties: assetIds: type: array items: type: string attributeIds: type: array items: type: string timeRange: type: object properties: startDate: type: string endDate: type: string required: - startDate - endDate resolution: type: number required: - assetIds - attributeIds - timeRange - resolution required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: history: type: object additionalProperties: type: object additionalProperties: type: array items: type: object properties: change_date: type: string value: anyOf: - type: string - type: number - type: boolean - type: object nullable: true enum: - null - nullable: true required: - change_date - value events: type: array items: type: object properties: id: type: string created_at: type: string is_open: type: boolean state: type: string last_updated: type: string severity: type: number priority: type: number rule: type: object properties: id: type: string label: type: string openRanges: type: array items: type: object properties: startTime: type: string endTime: type: string required: - startTime - endTime required: - id - created_at - is_open - state - last_updated - severity - priority - rule - openRanges downsampling_factor: type: object additionalProperties: type: object additionalProperties: type: number required: - history - events - downsampling_factor /api/v/1/code/{systemKey}/fetchTableItems?id=plotsStatsV3.read: post: tags: - Asset History description: Retrieve plot aggregatedstats parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - plotsStatsV3.read body: type: object properties: assetIds: type: array items: type: string attributeIds: type: array items: type: string timeRange: type: object properties: startDate: type: string endDate: type: string required: - startDate - endDate required: - assetIds - attributeIds - timeRange required: - name - body responses: "200": description: Success content: application/json: schema: type: object additionalProperties: type: object additionalProperties: type: object properties: mean: type: number median: type: number mode: type: number min: type: number max: type: number std_dev: type: number required: - mean - median - mode - min - max - std_dev /api/v/1/code/{systemKey}/fetchTableItems?id=plotsDataV4.read: post: tags: - Asset History description: Retrieve plot data parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - plotsDataV4.read body: type: object properties: assetIds: type: array items: type: string attributeIds: type: array items: type: string timeRange: type: object properties: startDate: type: string endDate: type: string required: - startDate - endDate resolution: type: number required: - assetIds - attributeIds - timeRange - resolution required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: history: type: object additionalProperties: type: object additionalProperties: type: array items: type: object properties: change_date: type: string value: anyOf: - type: string - type: number - type: boolean - type: object nullable: true enum: - null - nullable: true required: - change_date - value events: type: array items: type: object properties: id: type: string created_at: type: string is_open: type: boolean state: type: string last_updated: type: string severity: type: number priority: type: number rule: type: object properties: id: type: string label: type: string openRanges: type: array items: type: object properties: startTime: type: string endTime: type: string required: - startTime - endTime required: - id - created_at - is_open - state - last_updated - severity - priority - rule - openRanges downsampling_factor: type: object additionalProperties: type: object additionalProperties: type: number required: - history - events - downsampling_factor /api/v/1/code/{systemKey}/fetchTableItems?id=plotsStatsV4.read: post: tags: - Asset History description: Retrieve plot aggregated stats parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - plotsStatsV4.read body: type: object properties: assetIds: type: array items: type: string attributeIds: type: array items: type: string timeRange: type: object properties: startDate: type: string endDate: type: string required: - startDate - endDate required: - assetIds - attributeIds - timeRange required: - name - body responses: "200": description: Success content: application/json: schema: type: object additionalProperties: type: object additionalProperties: type: object properties: mean: type: number median: type: number mode: type: number min: type: number max: type: number std_dev: type: number required: - mean - median - mode - min - max - std_dev /api/v/1/code/{systemKey}/fetchTableItems?id=imageInBucket.read: post: tags: - Asset Images description: Retrieve images from a specific bucket parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - imageInBucket.read body: type: object properties: id: type: string required: - id required: - name - body responses: "200": description: Success content: application/json: schema: type: string /api/v/1/code/{systemKey}/fetchTableItems?id=dataHistoryCountForAsset.read: post: tags: - Asset History description: Retrieve just the count of data history groups for an asset query parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - dataHistoryCountForAsset.read body: type: object properties: descendantIds: type: array items: type: string rootId: type: string startDate: type: string endDate: type: string pageSize: type: number pageNum: type: number customDataSortKey: type: object properties: owner: type: string key: type: string required: - owner - key nonNullAttributes: type: array items: type: string sortKeyType: type: string sortKey: type: string sortDir: anyOf: - type: string enum: - asc - type: string enum: - desc recentAmount: type: number required: - rootId - startDate - endDate required: - name - body responses: "200": description: Success content: application/json: schema: type: number /api/v/1/code/{systemKey}/fetchTableItems?id=dataHistoryForAssetHeatmap.read: post: tags: - Asset History description: Retrieve data history for an asset heatmap parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - dataHistoryForAssetHeatmap.read body: type: object properties: attribute_name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true asset_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true date_range: anyOf: - type: object properties: startDate: type: string endDate: type: string rangeSelection: anyOf: - type: number enum: - 1 - type: number enum: - 7 - type: number enum: - 30 - type: number enum: - 90 - type: number enum: - 180 - type: number enum: - 0 - type: number enum: - -1 required: - startDate - endDate - rangeSelection - type: object nullable: true enum: - null - nullable: true aggregateFunction: anyOf: - type: string enum: - MIN - type: string enum: - MAX - type: string enum: - AVG mapBounds: anyOf: - type: array items: type: object properties: long: type: number lat: type: number required: - long - lat - type: array items: type: number minItems: 4 maxItems: 4 - type: object properties: geometry_type: type: string enum: - geojson features: type: array items: type: object properties: type: type: string enum: - Feature properties: type: object properties: {} geometry: anyOf: - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number required: - type - coordinates - type: object properties: type: type: string enum: - MultiPolygon coordinates: type: array items: type: array items: type: array items: type: array items: type: number required: - type - coordinates required: - type - properties - geometry required: - geometry_type - features dataValueRange: type: object properties: min: type: number max: type: number required: - attribute_name - asset_type - date_range - aggregateFunction - mapBounds required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: allOf: - type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true latitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true longitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true custom_id_1: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_id_2: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true tree_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - id - type - last_updated - label - latitude - longitude - custom_id_1 - custom_id_2 - tree_id - type: object properties: value: anyOf: - type: string - type: number - type: boolean required: - value COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=actionHistoryForActions.read: post: tags: - Actions description: Retrieve action history for one or more actions parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - actionHistoryForActions.read body: type: object properties: actionIDs: type: array items: type: string eventID: type: string required: - actionIDs - eventID required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: type: object properties: item_id: type: string id: type: string name: type: string type: type: string action_history: type: array items: type: object properties: item_id: type: string status: type: string timestamp: type: string required: - item_id - status - timestamp required: - item_id - id - name - type - action_history COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=microfrontendsv2.read: post: tags: - Microfrontends description: Retrieve microfrontends with more complex queries parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - microfrontendsv2.read body: type: object properties: page: type: object properties: pageSize: type: number pageNumber: type: number filters: type: object properties: types: type: array items: type: string sort: type: array items: type: object properties: field: anyOf: - type: string enum: - id - type: string enum: - url - type: string enum: - type - type: string enum: - config.label direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - direction required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: anyOf: - allOf: - type: object properties: id: type: string url: type: string url_location: anyOf: - type: object nullable: true enum: - null - type: string enum: - files - nullable: true required: - id - url - type: object properties: type: type: string enum: - page config: anyOf: - type: object nullable: true enum: - null - type: undefined enum: - null - nullable: true required: - type - type: object properties: item_id: type: string required: - item_id - allOf: - type: object properties: id: type: string url: type: string url_location: anyOf: - type: object nullable: true enum: - null - type: string enum: - files - nullable: true required: - id - url - type: object properties: type: type: string enum: - attributeView config: anyOf: - type: object nullable: true enum: - null - type: object properties: label: type: string attributeType: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary required: - label - attributeType - nullable: true required: - type - config - type: object properties: item_id: type: string required: - item_id - allOf: - type: object properties: id: type: string url: type: string url_location: anyOf: - type: object nullable: true enum: - null - type: string enum: - files - nullable: true required: - id - url - type: object properties: type: type: string enum: - attributeEdit config: anyOf: - type: object nullable: true enum: - null - type: object properties: label: type: string attributeType: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary required: - label - attributeType - nullable: true required: - type - config - type: object properties: item_id: type: string required: - item_id - allOf: - type: object properties: id: type: string url: type: string url_location: anyOf: - type: object nullable: true enum: - null - type: string enum: - files - nullable: true required: - id - url - type: object properties: type: type: string enum: - dashboard config: anyOf: - type: object nullable: true enum: - null - type: undefined enum: - null - nullable: true required: - type - type: object properties: item_id: type: string required: - item_id - allOf: - type: object properties: id: type: string url: type: string url_location: anyOf: - type: object nullable: true enum: - null - type: string enum: - files - nullable: true required: - id - url - type: object properties: type: type: string enum: - assetTab config: anyOf: - type: object nullable: true enum: - null - type: undefined enum: - null - nullable: true required: - type - type: object properties: item_id: type: string required: - item_id COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=roles.read: post: tags: - Roles description: Retrieve custom and core roles parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - roles.read body: type: object properties: page: type: object properties: pageSize: type: number pageNumber: type: number filters: type: object properties: groupIds: type: array items: type: string roleId: type: string roleIds: type: array items: type: string roleSearch: type: string userEmail: type: string roleNames: type: array items: type: string permissionIds: type: array items: type: string sort: type: array items: type: object properties: field: type: string enum: - id direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - direction required: - name - body responses: "200": description: Success content: application/json: schema: anyOf: - type: array items: type: object properties: role: nullable: true group_ids: type: array items: type: string type: anyOf: - type: string enum: - core - type: string enum: - custom required: - group_ids - type - type: undefined enum: - null /api/v/1/code/{systemKey}/fetchTableItems?id=rolesCount.read: post: tags: - Roles description: Retrieve just the count of assets returned for a query parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - rolesCount.read body: type: object properties: page: type: object properties: pageSize: type: number pageNumber: type: number filters: type: object properties: groupIds: type: array items: type: string roleId: type: string roleIds: type: array items: type: string roleSearch: type: string userEmail: type: string roleNames: type: array items: type: string permissionIds: type: array items: type: string sort: type: array items: type: object properties: field: type: string enum: - id direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - direction required: - name - body responses: "200": description: Success content: application/json: schema: type: number /api/v/1/code/{systemKey}/fetchTableItems?id=audits.read: post: tags: - Audits description: Retrieve audit logs parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - audits.read body: type: object properties: page: type: object properties: pageSize: type: number pageNumber: type: number required: - pageSize - pageNumber filters: type: object properties: user_emails: type: array items: type: string entity_type: type: array items: type: string action_type: type: array items: type: string created_at: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate sort: type: array items: type: object properties: field: anyOf: - type: string enum: - timestamp - type: string enum: - user_email - type: string enum: - entity_type - type: string enum: - action_type direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - direction required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: type: object properties: user_email: type: string action_type: type: string timestamp: type: string request: nullable: true errors: type: array items: type: object properties: {} entity_type: type: string entry_point: type: string required: - user_email - action_type - timestamp - entity_type COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=auditsCount.read: post: tags: - Audits description: Retrieve just the count of audit logs returned for a query parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - auditsCount.read body: type: object properties: page: type: object properties: pageSize: type: number pageNumber: type: number required: - pageSize - pageNumber filters: type: object properties: user_emails: type: array items: type: string entity_type: type: array items: type: string action_type: type: array items: type: string created_at: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate sort: type: array items: type: object properties: field: anyOf: - type: string enum: - timestamp - type: string enum: - user_email - type: string enum: - entity_type - type: string enum: - action_type direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - direction required: - name - body responses: "200": description: Success content: application/json: schema: type: number /api/v/1/code/{systemKey}/fetchTableItems?id=bucketSets.read: post: tags: - Bucket Sets description: Retrieve bucket sets parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - bucketSets.read body: type: object properties: query: type: object properties: PrimaryKey: type: array items: type: string Order: type: array items: type: object properties: SortOrder: type: boolean OrderKey: type: string required: - SortOrder - OrderKey PageSize: type: number PageNumber: type: number Queries: type: array items: type: array items: type: object properties: Operator: type: string Field: type: string Value: nullable: true required: - Operator - Field Columns: type: array items: type: string Distinct: type: string GroupBy: type: array items: type: string RawQuery: type: string required: - PrimaryKey - Order - PageSize - PageNumber - Queries - Columns - Distinct - GroupBy - RawQuery required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: type: object properties: name: type: string platform_storage: anyOf: - type: string enum: - local - type: string enum: - google - type: string enum: - s3 platform_config: anyOf: - type: object properties: bucket_name: type: string required: - bucket_name - type: object properties: bucket_name: type: string bucket_region: type: string user_id: type: string user_secret: type: string required: - bucket_name - bucket_region - user_id - user_secret - type: object properties: root: type: string required: - root edge_storage: anyOf: - type: string enum: - local - type: string enum: - google - type: string enum: - s3 edge_config: anyOf: - type: object properties: bucket_name: type: string required: - bucket_name - type: object properties: bucket_name: type: string bucket_region: type: string user_id: type: string user_secret: type: string required: - bucket_name - bucket_region - user_id - user_secret - type: object properties: root: type: string required: - root system_key: type: string required: - name - platform_storage - platform_config - edge_storage - edge_config - system_key COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=navPages.read: post: tags: - Nav Pages description: Retrieve nav pages parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - navPages.read body: type: object properties: filters: type: object properties: ids: type: array items: type: string required: - name - body responses: "200": description: Success content: application/json: schema: anyOf: - type: object nullable: true enum: - null - type: object properties: general: type: array items: anyOf: - type: object properties: id: type: string label: type: string icon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey type: anyOf: - type: string enum: - custom - type: string enum: - core visible: type: boolean config: anyOf: - type: object properties: type: type: string enum: - single content: allOf: - type: object properties: label: type: string icon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey required: - label - icon - anyOf: - type: object properties: type: anyOf: - type: string enum: - home - type: string enum: - assets - type: string enum: - rules - type: string enum: - events - type: string enum: - reports - type: string enum: - dashboards - type: string enum: - store - type: string enum: - actionTypes - type: string enum: - assetTypes - type: string enum: - eventTypes - type: string enum: - ruleTypes - type: string enum: - groups - type: string enum: - roles - type: string enum: - users - type: string enum: - billing - type: string enum: - deviceConfig - type: string enum: - audits required: - type - type: object properties: type: type: string enum: - mfe mfeId: type: string mfeUrlWhileEditing: type: string required: - type - mfeId - type: object properties: type: type: string enum: - dashboard dashboardId: type: string required: - type - dashboardId - type: object properties: type: type: string enum: - externalLink url: type: string required: - type - url required: - type - content - type: object properties: type: type: string enum: - multi layout: type: string enum: - dropdown content: type: array items: allOf: - type: object properties: label: type: string icon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey required: - label - icon - anyOf: - type: object properties: type: anyOf: - type: string enum: - home - type: string enum: - assets - type: string enum: - rules - type: string enum: - events - type: string enum: - reports - type: string enum: - dashboards - type: string enum: - store - type: string enum: - actionTypes - type: string enum: - assetTypes - type: string enum: - eventTypes - type: string enum: - ruleTypes - type: string enum: - groups - type: string enum: - roles - type: string enum: - users - type: string enum: - billing - type: string enum: - deviceConfig - type: string enum: - audits required: - type - type: object properties: type: type: string enum: - mfe mfeId: type: string mfeUrlWhileEditing: type: string required: - type - mfeId - type: object properties: type: type: string enum: - dashboard dashboardId: type: string required: - type - dashboardId - type: object properties: type: type: string enum: - externalLink url: type: string required: - type - url required: - type - layout - content permissionOverride: type: string required: - id - label - icon - type - visible - config - type: object properties: id: type: string icon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey type: anyOf: - type: string enum: - custom - type: string enum: - core visible: type: boolean config: anyOf: - type: object properties: type: type: string enum: - single content: allOf: - type: object properties: icon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey required: - icon - anyOf: - type: object properties: type: anyOf: - type: string enum: - home - type: string enum: - assets - type: string enum: - rules - type: string enum: - events - type: string enum: - reports - type: string enum: - dashboards - type: string enum: - store - type: string enum: - actionTypes - type: string enum: - assetTypes - type: string enum: - eventTypes - type: string enum: - ruleTypes - type: string enum: - groups - type: string enum: - roles - type: string enum: - users - type: string enum: - billing - type: string enum: - deviceConfig - type: string enum: - audits required: - type - type: object properties: type: type: string enum: - mfe mfeId: type: string mfeUrlWhileEditing: type: string required: - type - mfeId - type: object properties: type: type: string enum: - dashboard dashboardId: type: string required: - type - dashboardId - type: object properties: type: type: string enum: - externalLink url: type: string required: - type - url required: - type - content - type: object properties: type: type: string enum: - multi layout: type: string enum: - dropdown content: type: array items: allOf: - type: object properties: icon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey required: - icon - anyOf: - type: object properties: type: anyOf: - type: string enum: - home - type: string enum: - assets - type: string enum: - rules - type: string enum: - events - type: string enum: - reports - type: string enum: - dashboards - type: string enum: - store - type: string enum: - actionTypes - type: string enum: - assetTypes - type: string enum: - eventTypes - type: string enum: - ruleTypes - type: string enum: - groups - type: string enum: - roles - type: string enum: - users - type: string enum: - billing - type: string enum: - deviceConfig - type: string enum: - audits required: - type - type: object properties: type: type: string enum: - mfe mfeId: type: string mfeUrlWhileEditing: type: string required: - type - mfeId - type: object properties: type: type: string enum: - dashboard dashboardId: type: string required: - type - dashboardId - type: object properties: type: type: string enum: - externalLink url: type: string required: - type - url required: - type - layout - content permissionOverride: type: string required: - id - icon - type - visible - config admin: type: array items: anyOf: - type: object properties: id: type: string label: type: string icon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey type: anyOf: - type: string enum: - custom - type: string enum: - core visible: type: boolean config: anyOf: - type: object properties: type: type: string enum: - single content: allOf: - type: object properties: label: type: string icon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey required: - label - icon - anyOf: - type: object properties: type: anyOf: - type: string enum: - home - type: string enum: - assets - type: string enum: - rules - type: string enum: - events - type: string enum: - reports - type: string enum: - dashboards - type: string enum: - store - type: string enum: - actionTypes - type: string enum: - assetTypes - type: string enum: - eventTypes - type: string enum: - ruleTypes - type: string enum: - groups - type: string enum: - roles - type: string enum: - users - type: string enum: - billing - type: string enum: - deviceConfig - type: string enum: - audits required: - type - type: object properties: type: type: string enum: - mfe mfeId: type: string mfeUrlWhileEditing: type: string required: - type - mfeId - type: object properties: type: type: string enum: - dashboard dashboardId: type: string required: - type - dashboardId - type: object properties: type: type: string enum: - externalLink url: type: string required: - type - url required: - type - content - type: object properties: type: type: string enum: - multi layout: type: string enum: - dropdown content: type: array items: allOf: - type: object properties: label: type: string icon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey required: - label - icon - anyOf: - type: object properties: type: anyOf: - type: string enum: - home - type: string enum: - assets - type: string enum: - rules - type: string enum: - events - type: string enum: - reports - type: string enum: - dashboards - type: string enum: - store - type: string enum: - actionTypes - type: string enum: - assetTypes - type: string enum: - eventTypes - type: string enum: - ruleTypes - type: string enum: - groups - type: string enum: - roles - type: string enum: - users - type: string enum: - billing - type: string enum: - deviceConfig - type: string enum: - audits required: - type - type: object properties: type: type: string enum: - mfe mfeId: type: string mfeUrlWhileEditing: type: string required: - type - mfeId - type: object properties: type: type: string enum: - dashboard dashboardId: type: string required: - type - dashboardId - type: object properties: type: type: string enum: - externalLink url: type: string required: - type - url required: - type - layout - content permissionOverride: type: string required: - id - label - icon - type - visible - config - type: object properties: id: type: string icon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey type: anyOf: - type: string enum: - custom - type: string enum: - core visible: type: boolean config: anyOf: - type: object properties: type: type: string enum: - single content: allOf: - type: object properties: icon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey required: - icon - anyOf: - type: object properties: type: anyOf: - type: string enum: - home - type: string enum: - assets - type: string enum: - rules - type: string enum: - events - type: string enum: - reports - type: string enum: - dashboards - type: string enum: - store - type: string enum: - actionTypes - type: string enum: - assetTypes - type: string enum: - eventTypes - type: string enum: - ruleTypes - type: string enum: - groups - type: string enum: - roles - type: string enum: - users - type: string enum: - billing - type: string enum: - deviceConfig - type: string enum: - audits required: - type - type: object properties: type: type: string enum: - mfe mfeId: type: string mfeUrlWhileEditing: type: string required: - type - mfeId - type: object properties: type: type: string enum: - dashboard dashboardId: type: string required: - type - dashboardId - type: object properties: type: type: string enum: - externalLink url: type: string required: - type - url required: - type - content - type: object properties: type: type: string enum: - multi layout: type: string enum: - dropdown content: type: array items: allOf: - type: object properties: icon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey required: - icon - anyOf: - type: object properties: type: anyOf: - type: string enum: - home - type: string enum: - assets - type: string enum: - rules - type: string enum: - events - type: string enum: - reports - type: string enum: - dashboards - type: string enum: - store - type: string enum: - actionTypes - type: string enum: - assetTypes - type: string enum: - eventTypes - type: string enum: - ruleTypes - type: string enum: - groups - type: string enum: - roles - type: string enum: - users - type: string enum: - billing - type: string enum: - deviceConfig - type: string enum: - audits required: - type - type: object properties: type: type: string enum: - mfe mfeId: type: string mfeUrlWhileEditing: type: string required: - type - mfeId - type: object properties: type: type: string enum: - dashboard dashboardId: type: string required: - type - dashboardId - type: object properties: type: type: string enum: - externalLink url: type: string required: - type - url required: - type - layout - content permissionOverride: type: string required: - id - icon - type - visible - config required: - general - admin - nullable: true /api/v/1/code/{systemKey}/fetchTableItems?id=isUsingNewQueryParser.read: post: tags: - Miscellaneous description: Determine whether the platform is using the new query parser parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - isUsingNewQueryParser.read body: nullable: true required: - name responses: "200": description: Success content: application/json: schema: type: boolean /api/v/1/code/{systemKey}/fetchTableItems?id=measurementProfiles.read: post: tags: - Measurement Profiles description: Retrieve measurement profiles parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - measurementProfiles.read body: type: object nullable: true enum: - null required: - name - body responses: "200": description: Success content: application/json: schema: type: array items: type: object properties: id: type: string name: type: string units: type: array items: type: object properties: id: type: string name: type: string abbreviation: type: string conversionFormula: anyOf: - type: object properties: type: type: string enum: - constant value: anyOf: - type: number - type: string - type: boolean - type: array items: nullable: true required: - type - value - type: object properties: type: type: string enum: - variable path: type: array items: type: string params: type: object properties: {} required: - type - path - type: object properties: type: type: string enum: - arithmeticOperation operator: anyOf: - type: string enum: - + - type: string enum: - "-" - type: string enum: - "*" - type: string enum: - / - type: string enum: - "%" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - comparisonOperation operator: anyOf: - type: string enum: - ">" - type: string enum: - < - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - == - type: string enum: - "!=" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - logicalOperation operator: anyOf: - type: string enum: - AND - type: string enum: - OR - type: string enum: - NOT operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - if operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - switch operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - concat operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - split operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - sum operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - average operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - max operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - min operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - map operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - filter operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - reduce operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - length operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - contains operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - indexOf operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - concat operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mean operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - median operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mode operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - standardDeviation operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - variance operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - percentile operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object nullable: true enum: - null - nullable: true reverseFormula: anyOf: - type: object properties: type: type: string enum: - constant value: anyOf: - type: number - type: string - type: boolean - type: array items: nullable: true required: - type - value - type: object properties: type: type: string enum: - variable path: type: array items: type: string params: type: object properties: {} required: - type - path - type: object properties: type: type: string enum: - arithmeticOperation operator: anyOf: - type: string enum: - + - type: string enum: - "-" - type: string enum: - "*" - type: string enum: - / - type: string enum: - "%" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - comparisonOperation operator: anyOf: - type: string enum: - ">" - type: string enum: - < - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - == - type: string enum: - "!=" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - logicalOperation operator: anyOf: - type: string enum: - AND - type: string enum: - OR - type: string enum: - NOT operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - if operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - switch operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - concat operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - split operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - sum operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - average operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - max operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - min operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - map operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - filter operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - reduce operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - length operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - contains operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - indexOf operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - concat operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mean operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - median operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mode operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - standardDeviation operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - variance operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - percentile operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object nullable: true enum: - null - nullable: true groupIds: type: array items: type: string isDefault: type: boolean decimals: type: number required: - id - name - abbreviation - conversionFormula - groupIds - isDefault - decimals sourceUnit: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true sourceUnitAbbreviation: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - id - name - units /api/v/1/code/{systemKey}/fetchTableItems?id=userLastActive.update: post: tags: - Users description: Update the last active time for a user. This is a route on fetchTableItems not updateTableItems in order to benefit from the preloaded performance boost. parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - userLastActive.update body: nullable: true required: - name responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/fetchTableItems?id=groupsv2.read: post: tags: - Groups description: Retreive groups with more complex queries parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - groupsv2.read body: type: object properties: page: type: object properties: pageSize: type: number pageNumber: type: number searchText: type: string filters: type: object properties: parentChild: anyOf: - type: string enum: - includeTrees - type: string enum: - includeTreesReturnRootsOnly ids: type: array items: type: string treeIds: type: array items: type: string mapBounds: type: object properties: minLong: type: number minLat: type: number maxLong: type: number maxLat: type: number required: - minLong - minLat - maxLong - maxLat tags: type: array items: type: string sort: type: array items: type: object properties: field: anyOf: - type: string enum: - name - type: string enum: - id - type: string enum: - map_location_latitude - type: string enum: - map_location_longitude - type: string enum: - map_zoom direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - direction columns: type: array items: type: string required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: type: object properties: map_location_latitude: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true map_location_longitude: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true map_bounds: anyOf: - type: array items: type: object properties: long: type: number lat: type: number required: - long - lat - type: object nullable: true enum: - null - nullable: true id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true map_zoom: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true map_zoom_float: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true tree_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true is_root: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true tree: type: object properties: id: type: string data: type: object properties: rootID: type: string treeID: type: string nodes: type: object additionalProperties: type: object properties: id: type: string parentID: type: string parents: type: array items: type: string children: type: array items: type: string required: - id - parentID - parents - children required: - rootID - treeID - nodes timezone: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true date_time_locale: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - map_location_latitude - map_location_longitude - map_bounds - id - map_zoom - map_zoom_float - name - tree_id - is_root - timezone - item_id COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=groupsv2Count.read: post: tags: - Groups description: Retrieve just the count of groups returned for a query parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - groupsv2Count.read body: type: object properties: page: type: object properties: pageSize: type: number pageNumber: type: number searchText: type: string filters: type: object properties: parentChild: anyOf: - type: string enum: - includeTrees - type: string enum: - includeTreesReturnRootsOnly ids: type: array items: type: string treeIds: type: array items: type: string mapBounds: type: object properties: minLong: type: number minLat: type: number maxLong: type: number maxLat: type: number required: - minLong - minLat - maxLong - maxLat tags: type: array items: type: string sort: type: array items: type: object properties: field: anyOf: - type: string enum: - name - type: string enum: - id - type: string enum: - map_location_latitude - type: string enum: - map_location_longitude - type: string enum: - map_zoom direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - direction columns: type: array items: type: string required: - name - body responses: "200": description: Success content: application/json: schema: type: number /api/v/1/code/{systemKey}/fetchTableItems?id=adapterConfig.read: post: tags: - Adapter Config description: Retrieve adapter configurations parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - adapterConfig.read body: type: object properties: page: type: object properties: pageSize: type: number pageNumber: type: number searchText: type: string filters: type: object properties: edgeNames: type: array items: type: string adapterNames: type: array items: type: string adapterTypes: type: array items: type: string topicRoots: type: array items: type: string sort: type: array items: type: object properties: field: anyOf: - type: string enum: - edge_name - type: string enum: - adapter_name - type: string enum: - adapter_type - type: string enum: - topic_root direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - direction required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: type: object properties: topic_root: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true edge_name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true adapter_settings: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true adapter_name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true adapter_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - topic_root - edge_name - adapter_settings - adapter_name - adapter_type - item_id COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=usersv2.read: post: tags: - Users description: Retrieve users with more complex queries parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - usersv2.read body: type: object properties: page: type: object properties: pageSize: type: number pageNumber: type: number required: - pageSize - pageNumber filters: type: object properties: userIds: type: array items: type: string emails: type: array items: type: string phoneNumbers: type: array items: type: string groupIds: type: array items: type: string firstNames: type: array items: type: string lastNames: type: array items: type: string userTypes: type: array items: type: string roles: type: array items: type: string searchText: type: string sort: type: array items: type: object properties: field: anyOf: - type: string enum: - email - type: string enum: - first_name - type: string enum: - last_name - type: string enum: - phone direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - direction columns: type: array items: type: string required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: type: object properties: user_id: type: string email: type: string first_name: type: string last_name: type: string groups: type: array items: type: object properties: id: type: string name: type: string required: - id - name roles: type: array items: type: object properties: id: type: string label: type: string required: - id - label group_ids: type: array items: type: string phone: type: string photo_url: type: string last_active: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true invite_status: type: string invite_expiry: type: string oidc_enabled: type: boolean two_factor_method: type: string terms_agreement: type: object additionalProperties: anyOf: - type: undefined enum: - null - type: object properties: date: type: string required: - date app_tour: type: object additionalProperties: anyOf: - type: undefined enum: - null - type: object properties: date: type: string started: type: boolean required: - date - started - type: object properties: date: type: string tried: type: boolean required: - date - tried user_preferences: type: object properties: language: type: object properties: language: anyOf: - type: string enum: - en-US - type: string enum: - fr theme: type: object properties: darkMode: type: boolean preferredUnitOverrides: type: object additionalProperties: type: string dateTimeLocale: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - user_id - email - first_name - last_name - groups - roles - group_ids - phone - photo_url - last_active - invite_status - invite_expiry - oidc_enabled - two_factor_method - terms_agreement - app_tour - user_preferences COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=permissionDefinitions.read: post: tags: - Permission Definitions description: Retrieve all permission definitions parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - permissionDefinitions.read body: nullable: true required: - name responses: "200": description: Success content: application/json: schema: type: object properties: permissionDefinitionLists: type: array items: type: object properties: id: type: string permissionDefinitions: type: array items: type: object properties: id: type: string category: type: string description: type: string constraints: type: object additionalProperties: anyOf: - type: object properties: type: type: string enum: - list defaultValue: type: undefined enum: - null required: - type - type: object properties: type: type: string enum: - boolean defaultValue: type: boolean morePermissiveValue: type: boolean required: - type - defaultValue - morePermissiveValue required: - id - category - description required: - id - permissionDefinitions required: - permissionDefinitionLists /api/v/1/code/{systemKey}/fetchTableItems?id=customSettings.read: post: tags: - Custom Settings description: Retrieve system-wide custom settings parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - customSettings.read body: type: object properties: id: type: string required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: type: object properties: item_id: type: string id: type: string description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true config: type: string required: - item_id - id - config required: - DATA /api/v/1/code/{systemKey}/fetchTableItems?id=isSidecarAvailable.read: post: tags: - Miscellaneous description: Check if the sidecar is available parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - isSidecarAvailable.read body: nullable: true required: - name responses: "200": description: Success content: application/json: schema: type: object properties: available: type: boolean required: - available /api/v/1/code/{systemKey}/fetchTableItems?id=tags.read: post: tags: - Tags description: Retrieve tags parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - tags.read body: type: object properties: page: type: object properties: pageSize: type: number pageNumber: type: number required: - pageSize - pageNumber sort: type: array items: type: object properties: field: type: string enum: - label direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - direction required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: type: object properties: label: type: string created_at: type: string required: - label - created_at COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/fetchTableItems?id=components.read: post: tags: - Components description: Retrieve components parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - components.read body: type: object properties: query: type: object properties: filters: type: object properties: id: type: string entity_id: type: string url: type: string required: - filters required: - query required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: COUNT: type: number DATA: type: array items: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true type: anyOf: - type: string enum: - ai_internal_v1 - type: string enum: - ai_external - type: string enum: - external - type: string enum: - AI - type: string enum: - THEME - type: string enum: - FUNCTIONAL - type: string enum: - DEVICE - type: object nullable: true enum: - null - nullable: true url: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true prefix: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true entity_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true settings: anyOf: - type: object additionalProperties: nullable: true - type: object nullable: true enum: - null - nullable: true enabled: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - id - name - type - url - prefix - entity_id - settings - enabled - item_id required: - COUNT - DATA /api/v/1/code/{systemKey}/fetchTableItems?id=oidcSettings.read: post: tags: - OIDC Settings description: Retrieve OIDC settings parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - oidcSettings.read body: nullable: true required: - name responses: "200": description: Success content: application/json: schema: type: object properties: provider_configs: type: array items: type: object properties: allow_auto_registration: type: boolean provider_name: type: string default_groups_for_new_users: type: array items: type: string role_claim_name: type: string role_mappings: type: array items: type: object properties: provider_role: type: string ia_role: type: string required: - provider_role - ia_role group_claim_name: type: string group_mappings: type: array items: type: object properties: provider_group: type: string ia_group: type: string required: - provider_group - ia_group required: - allow_auto_registration - provider_name - default_groups_for_new_users - role_claim_name - role_mappings - group_claim_name - group_mappings required: - provider_configs /api/v/1/code/{systemKey}/createTableItems?id=adapterConfig.create: post: tags: - Adapter Config description: Create adapter configs parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - adapterConfig.create body: type: object properties: item: type: object properties: topic_root: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true edge_name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true adapter_settings: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true adapter_name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true adapter_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - topic_root - edge_name - adapter_settings - adapter_name - adapter_type required: - item required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: topic_root: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true edge_name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true adapter_settings: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true adapter_name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true adapter_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - topic_root - edge_name - adapter_settings - adapter_name - adapter_type /api/v/1/code/{systemKey}/createTableItems?id=actions.create: post: tags: - Actions description: Create actions parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - actions.create body: type: object properties: item: allOf: - type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - id - type: object properties: name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true config: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true is_centralized: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true notification_settings: anyOf: - type: object properties: enabled_formula: anyOf: - type: object properties: enabled: type: boolean enum: - true value: anyOf: - type: object properties: type: type: string enum: - constant value: anyOf: - type: number - type: string - type: boolean - type: array items: nullable: true required: - type - value - type: object properties: type: type: string enum: - variable path: type: array items: type: string params: type: object properties: {} required: - type - path - type: object properties: type: type: string enum: - arithmeticOperation operator: anyOf: - type: string enum: - + - type: string enum: - "-" - type: string enum: - "*" - type: string enum: - / - type: string enum: - "%" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - comparisonOperation operator: anyOf: - type: string enum: - ">" - type: string enum: - < - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - == - type: string enum: - "!=" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - logicalOperation operator: anyOf: - type: string enum: - AND - type: string enum: - OR - type: string enum: - NOT operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - if operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - switch operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - concat operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - split operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - sum operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - average operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - max operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - min operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - map operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - filter operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - reduce operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - length operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - contains operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - indexOf operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - concat operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mean operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - median operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mode operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - standardDeviation operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - variance operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - percentile operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object nullable: true enum: - null - nullable: true required: - enabled - value - type: object properties: enabled: type: boolean enum: - false value: type: undefined enum: - null required: - enabled grace_period: anyOf: - type: object properties: enabled: type: boolean enum: - true value: type: object properties: amount: type: number units: anyOf: - type: string enum: - SECOND - type: string enum: - MINUTE - type: string enum: - HOUR - type: string enum: - DAY - type: string enum: - WEEK - type: string enum: - MONTH - type: string enum: - YEAR required: - amount - units required: - enabled - value - type: object properties: enabled: type: boolean enum: - false value: type: undefined enum: - null required: - enabled recipient_formula: anyOf: - type: object properties: enabled: type: boolean enum: - true value: anyOf: - type: object properties: type: type: string enum: - constant value: anyOf: - type: number - type: string - type: boolean - type: array items: nullable: true required: - type - value - type: object properties: type: type: string enum: - variable path: type: array items: type: string params: type: object properties: {} required: - type - path - type: object properties: type: type: string enum: - arithmeticOperation operator: anyOf: - type: string enum: - + - type: string enum: - "-" - type: string enum: - "*" - type: string enum: - / - type: string enum: - "%" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - comparisonOperation operator: anyOf: - type: string enum: - ">" - type: string enum: - < - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - == - type: string enum: - "!=" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - logicalOperation operator: anyOf: - type: string enum: - AND - type: string enum: - OR - type: string enum: - NOT operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - if operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - switch operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - concat operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - split operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - sum operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - average operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - max operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - min operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - map operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - filter operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - reduce operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - length operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - contains operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - indexOf operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - concat operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mean operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - median operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mode operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - standardDeviation operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - variance operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - percentile operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object nullable: true enum: - null - nullable: true required: - enabled - value - type: object properties: enabled: type: boolean enum: - false value: type: undefined enum: - null required: - enabled - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true required: - name - config - type - id - is_centralized - notification_settings required: - item required: - name - body responses: "200": description: Success content: application/json: schema: allOf: - type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - id - type: object properties: name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true config: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true is_centralized: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true notification_settings: anyOf: - type: object properties: enabled_formula: anyOf: - type: object properties: enabled: type: boolean enum: - true value: anyOf: - type: object properties: type: type: string enum: - constant value: anyOf: - type: number - type: string - type: boolean - type: array items: nullable: true required: - type - value - type: object properties: type: type: string enum: - variable path: type: array items: type: string params: type: object properties: {} required: - type - path - type: object properties: type: type: string enum: - arithmeticOperation operator: anyOf: - type: string enum: - + - type: string enum: - "-" - type: string enum: - "*" - type: string enum: - / - type: string enum: - "%" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - comparisonOperation operator: anyOf: - type: string enum: - ">" - type: string enum: - < - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - == - type: string enum: - "!=" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - logicalOperation operator: anyOf: - type: string enum: - AND - type: string enum: - OR - type: string enum: - NOT operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - if operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - switch operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - concat operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - split operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - sum operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - average operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - max operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - min operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - map operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - filter operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - reduce operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - length operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - contains operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - indexOf operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - concat operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mean operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - median operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mode operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - standardDeviation operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - variance operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - percentile operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object nullable: true enum: - null - nullable: true required: - enabled - value - type: object properties: enabled: type: boolean enum: - false value: type: undefined enum: - null required: - enabled grace_period: anyOf: - type: object properties: enabled: type: boolean enum: - true value: type: object properties: amount: type: number units: anyOf: - type: string enum: - SECOND - type: string enum: - MINUTE - type: string enum: - HOUR - type: string enum: - DAY - type: string enum: - WEEK - type: string enum: - MONTH - type: string enum: - YEAR required: - amount - units required: - enabled - value - type: object properties: enabled: type: boolean enum: - false value: type: undefined enum: - null required: - enabled recipient_formula: anyOf: - type: object properties: enabled: type: boolean enum: - true value: anyOf: - type: object properties: type: type: string enum: - constant value: anyOf: - type: number - type: string - type: boolean - type: array items: nullable: true required: - type - value - type: object properties: type: type: string enum: - variable path: type: array items: type: string params: type: object properties: {} required: - type - path - type: object properties: type: type: string enum: - arithmeticOperation operator: anyOf: - type: string enum: - + - type: string enum: - "-" - type: string enum: - "*" - type: string enum: - / - type: string enum: - "%" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - comparisonOperation operator: anyOf: - type: string enum: - ">" - type: string enum: - < - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - == - type: string enum: - "!=" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - logicalOperation operator: anyOf: - type: string enum: - AND - type: string enum: - OR - type: string enum: - NOT operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - if operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - switch operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - concat operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - split operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - sum operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - average operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - max operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - min operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - map operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - filter operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - reduce operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - length operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - contains operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - indexOf operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - concat operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mean operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - median operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mode operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - standardDeviation operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - variance operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - percentile operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object nullable: true enum: - null - nullable: true required: - enabled - value - type: object properties: enabled: type: boolean enum: - false value: type: undefined enum: - null required: - enabled - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true required: - name - config - type - id - is_centralized - notification_settings /api/v/1/code/{systemKey}/createTableItems?id=actionTypes.create: post: tags: - Action Types description: Create action types parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - actionTypes.create body: type: object properties: item: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true schema: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - id - label - schema groupIds: type: array items: type: string required: - item - groupIds required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true schema: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - id - label - schema /api/v/1/code/{systemKey}/createTableItems?id=assetTypes.create: post: tags: - Asset Types description: Create asset types parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assetTypes.create body: type: object properties: item: allOf: - type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - id - label - type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true icon: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true controls_schema: anyOf: - type: array items: allOf: - type: object properties: id: type: string type: type: string enum: - fire_and_forget widget_type: type: string widget_settings: nullable: true required: - id - type - widget_type - type: object properties: uuid: type: string required: - uuid - type: object nullable: true enum: - null - nullable: true device_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true parent_child_options: anyOf: - type: object properties: propagate_location_to_root: type: boolean store_updates_on_root: type: boolean show_location_on_map: type: boolean - type: object nullable: true enum: - null - nullable: true icon_svg: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true default_history_view: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true hide_attribute_if_undefined: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true categories: anyOf: - type: array items: type: object properties: id: type: string label: type: string settings: anyOf: - type: object properties: collapsed: type: boolean layout: type: string enum: - list required: - collapsed - type: object properties: collapsed: type: boolean layout: type: string enum: - grid widget_size: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 required: - collapsed - layout - widget_size attributes: type: array items: type: string controls: type: array items: type: string required: - id - label - settings - attributes - controls - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true reporting_interval: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true attributes_reporting_intervals: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: number - type: object nullable: true enum: - null - nullable: true entity_type: anyOf: - type: string enum: - asset - type: string enum: - area - type: object nullable: true enum: - null - nullable: true asset_tabs: anyOf: - type: array items: anyOf: - type: object properties: type: type: string enum: - core id: anyOf: - type: string enum: - data - type: string enum: - history - type: string enum: - controls - type: string enum: - logs - type: string enum: - events - type: string enum: - comments - type: string enum: - images label: type: string hidden: type: boolean required: - type - id - label - type: object properties: type: type: string enum: - mfe id: type: string label: type: string mfe_id: type: string hidden: type: boolean required: - type - id - label - mfe_id - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true summary: anyOf: - type: array items: anyOf: - allOf: - type: object properties: type: type: string enum: - image required: - type - type: object properties: visible: type: boolean required: - visible - allOf: - type: object properties: type: type: string enum: - profile items: type: array items: anyOf: - type: object properties: type: anyOf: - type: string enum: - name - type: string enum: - id - type: string enum: - type - type: string enum: - customId1 - type: string enum: - customId2 - type: string enum: - reportingStatus - type: string enum: - lastUpdated - type: string enum: - groups - type: string enum: - owners - type: string enum: - tags - type: string enum: - entityType - type: string enum: - deviceType - type: string enum: - description visible: type: boolean required: - type - visible - type: object properties: type: type: string enum: - attribute attributeId: type: string visible: type: boolean required: - type - attributeId - visible required: - type - items - type: object properties: visible: type: boolean required: - visible - allOf: - type: object properties: type: type: string enum: - eventsPanel required: - type - type: object properties: visible: type: boolean required: - visible - allOf: - type: object properties: type: type: string enum: - tree required: - type - type: object properties: visible: type: boolean required: - visible - allOf: - type: object properties: type: type: string enum: - location items: type: array items: type: object properties: type: anyOf: - type: string enum: - map - type: string enum: - lastUpdated - type: string enum: - floorLevel visible: type: boolean required: - type - visible required: - type - items - type: object properties: visible: type: boolean required: - visible - type: object nullable: true enum: - null - nullable: true modal_configuration: anyOf: - type: object properties: fields: type: array items: anyOf: - allOf: - type: object properties: type: type: string enum: - default_column column: anyOf: - type: string enum: - id - type: string enum: - owners - type: string enum: - latitude - type: string enum: - longitude - type: string enum: - type - type: string enum: - label - type: string enum: - description - type: string enum: - image - type: string enum: - last_updated - type: string enum: - location_updated - type: string enum: - custom_data - type: string enum: - attributes_last_updated - type: string enum: - parent - type: string enum: - location_x - type: string enum: - location_y - type: string enum: - location_z - type: string enum: - location_type - type: string enum: - location_unit - type: string enum: - custom_id_1 - type: string enum: - custom_id_2 - type: string enum: - last_location_updated - type: string enum: - group_id - type: string enum: - tree_id - type: string enum: - is_root - type: string enum: - floor_levels - type: string enum: - attributes_labels - type: string enum: - is_reporting - type: string enum: - attributes_is_reporting - type: string enum: - tags - type: string enum: - attributes_errors - type: string enum: - polygon - type: string enum: - is_archived - type: string enum: - image_id - type: string enum: - address - type: string enum: - groups - type: string enum: - children required: - type - column - type: object properties: required: type: boolean cols: type: object properties: xs: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto sm: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto md: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto lg: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto xl: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto required: - xs - sm - md - lg - xl - allOf: - type: object properties: type: type: string enum: - attribute attributeId: type: string required: - type - attributeId - type: object properties: required: type: boolean cols: type: object properties: xs: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto sm: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto md: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto lg: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto xl: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto required: - xs - sm - md - lg - xl mapConfig: type: object properties: show: type: boolean required: - show version: type: number required: - fields - mapConfig - version - type: object nullable: true enum: - null - nullable: true required: - id - label - description - icon - controls_schema - device_type - parent_child_options - icon_svg - default_history_view - hide_attribute_if_undefined - categories - entity_type - asset_tabs - type: object properties: schema: type: array items: allOf: - type: object properties: attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary attribute_edit_widget: anyOf: - type: string enum: - input - type: string enum: - textArea - type: string enum: - password - type: string enum: - number - type: string enum: - color - type: string enum: - slider - type: string enum: - datePicker - type: string enum: - toggle - type: string enum: - checkbox - type: string enum: - text_options - type: string enum: - dictionaryTextInput - type: string attribute_view_widget: anyOf: - type: string enum: - gauge - type: string enum: - bulletGauge - type: string enum: - hyperlink - type: string enum: - image - type: string enum: - label - type: string enum: - color - type: string enum: - toggle - type: string enum: - datePicker - type: string enum: - dataCard - type: string enum: - dictionaryLabel - type: string measurement_profile_id: type: string keep_history: type: boolean hide_attribute: type: boolean readonly_attribute: type: boolean expression: anyOf: - type: object properties: type: type: string enum: - constant value: anyOf: - type: number - type: string - type: boolean - type: array items: nullable: true required: - type - value - type: object properties: type: type: string enum: - variable path: type: array items: type: string params: type: object properties: {} required: - type - path - type: object properties: type: type: string enum: - arithmeticOperation operator: anyOf: - type: string enum: - + - type: string enum: - "-" - type: string enum: - "*" - type: string enum: - / - type: string enum: - "%" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - comparisonOperation operator: anyOf: - type: string enum: - ">" - type: string enum: - < - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - == - type: string enum: - "!=" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - logicalOperation operator: anyOf: - type: string enum: - AND - type: string enum: - OR - type: string enum: - NOT operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - if operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - switch operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - concat operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - split operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - sum operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - average operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - max operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - min operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - map operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - filter operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - reduce operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - length operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - contains operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - indexOf operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - concat operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mean operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - median operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mode operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - standardDeviation operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - variance operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - percentile operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object nullable: true enum: - null - nullable: true required: - attribute_name - attribute_type - attribute_edit_widget - attribute_view_widget - keep_history - hide_attribute - readonly_attribute - type: object properties: custom_edit_settings: anyOf: - type: string - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: number - type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode - type: array items: type: object properties: uuid: type: string breakpointValue: type: number lightModeColor: type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode darkModeColor: type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode required: - uuid - breakpointValue - lightModeColor - darkModeColor - type: array items: type: object properties: uuid: type: string text: type: string required: - uuid - text - type: object properties: displayMode: anyOf: - type: string enum: - TEXT_ONLY - type: string enum: - ICON_ONLY - type: string enum: - TEXT_AND_ICON applyColorToOnlyIcon: type: boolean fontSize: type: number iconSize: type: number trueColorLight: type: object properties: value: type: string colorType: type: string enum: - fixed isDarkMode: type: boolean required: - value - colorType - isDarkMode trueColorDark: type: object properties: value: type: string colorType: type: string enum: - fixed isDarkMode: type: boolean required: - value - colorType - isDarkMode falseColorLight: type: object properties: value: type: string colorType: type: string enum: - fixed isDarkMode: type: boolean required: - value - colorType - isDarkMode falseColorDark: type: object properties: value: type: string colorType: type: string enum: - fixed isDarkMode: type: boolean required: - value - colorType - isDarkMode options: type: array items: type: object properties: id: type: string name: type: string icon_svg: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey label: type: string required: - id - name - label baseColorLight: type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode baseColorDark: type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode baseDisplayName: type: string baseIcon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey thresholds: type: array items: type: object properties: threshold: anyOf: - type: number - type: string lightModeColor: type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode darkModeColor: type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode icon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey displayName: type: string required: - threshold unit: type: string required: - displayMode - applyColorToOnlyIcon - fontSize - iconSize - trueColorLight - trueColorDark - falseColorLight - falseColorDark - options - type: object properties: min: type: object properties: enabled: type: boolean attribute_name: type: string required: - enabled - attribute_name max: type: object properties: enabled: type: boolean attribute_name: type: string required: - enabled - attribute_name stdDev: type: object properties: enabled: type: boolean attribute_name: type: string required: - enabled - attribute_name custom_view_settings: anyOf: - type: string - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: number - type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode - type: array items: type: object properties: uuid: type: string breakpointValue: type: number lightModeColor: type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode darkModeColor: type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode required: - uuid - breakpointValue - lightModeColor - darkModeColor - type: array items: type: object properties: uuid: type: string text: type: string required: - uuid - text - type: object properties: displayMode: anyOf: - type: string enum: - TEXT_ONLY - type: string enum: - ICON_ONLY - type: string enum: - TEXT_AND_ICON applyColorToOnlyIcon: type: boolean fontSize: type: number iconSize: type: number trueColorLight: type: object properties: value: type: string colorType: type: string enum: - fixed isDarkMode: type: boolean required: - value - colorType - isDarkMode trueColorDark: type: object properties: value: type: string colorType: type: string enum: - fixed isDarkMode: type: boolean required: - value - colorType - isDarkMode falseColorLight: type: object properties: value: type: string colorType: type: string enum: - fixed isDarkMode: type: boolean required: - value - colorType - isDarkMode falseColorDark: type: object properties: value: type: string colorType: type: string enum: - fixed isDarkMode: type: boolean required: - value - colorType - isDarkMode options: type: array items: type: object properties: id: type: string name: type: string icon_svg: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey label: type: string required: - id - name - label baseColorLight: type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode baseColorDark: type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode baseDisplayName: type: string baseIcon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey thresholds: type: array items: type: object properties: threshold: anyOf: - type: number - type: string lightModeColor: type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode darkModeColor: type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode icon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey displayName: type: string required: - threshold unit: type: string required: - displayMode - applyColorToOnlyIcon - fontSize - iconSize - trueColorLight - trueColorDark - falseColorLight - falseColorDark - options - type: object properties: min: type: object properties: enabled: type: boolean attribute_name: type: string required: - enabled - attribute_name max: type: object properties: enabled: type: boolean attribute_name: type: string required: - enabled - attribute_name stdDev: type: object properties: enabled: type: boolean attribute_name: type: string required: - enabled - attribute_name - type: object properties: displayMode: anyOf: - type: string enum: - TEXT_ONLY - type: string enum: - ICON_ONLY - type: string enum: - TEXT_AND_ICON applyColorToOnlyIcon: type: boolean fontSize: type: number iconSize: type: number trueColorLight: type: object properties: value: type: string colorType: type: string enum: - fixed isDarkMode: type: boolean required: - value - colorType - isDarkMode trueColorDark: type: object properties: value: type: string colorType: type: string enum: - fixed isDarkMode: type: boolean required: - value - colorType - isDarkMode falseColorLight: type: object properties: value: type: string colorType: type: string enum: - fixed isDarkMode: type: boolean required: - value - colorType - isDarkMode falseColorDark: type: object properties: value: type: string colorType: type: string enum: - fixed isDarkMode: type: boolean required: - value - colorType - isDarkMode options: type: array items: type: object properties: id: type: string name: type: string icon_svg: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey label: type: string required: - id - name - label baseColorLight: type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode baseColorDark: type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode baseDisplayName: type: string baseIcon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey thresholds: type: array items: type: object properties: threshold: anyOf: - type: number - type: string lightModeColor: type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode darkModeColor: type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode icon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey displayName: type: string required: - threshold unit: type: string required: - displayMode - applyColorToOnlyIcon - fontSize - iconSize - trueColorLight - trueColorDark - falseColorLight - falseColorDark - options - type: object properties: uuid: type: string required: - uuid groupIds: type: array items: type: string required: - item - groupIds required: - name - body responses: "200": description: Success content: application/json: schema: allOf: - type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - id - label - type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true icon: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true controls_schema: anyOf: - type: array items: allOf: - type: object properties: id: type: string type: type: string enum: - fire_and_forget widget_type: type: string widget_settings: nullable: true required: - id - type - widget_type - type: object properties: uuid: type: string required: - uuid - type: object nullable: true enum: - null - nullable: true device_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true parent_child_options: anyOf: - type: object properties: propagate_location_to_root: type: boolean store_updates_on_root: type: boolean show_location_on_map: type: boolean - type: object nullable: true enum: - null - nullable: true icon_svg: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true default_history_view: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true hide_attribute_if_undefined: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true categories: anyOf: - type: array items: type: object properties: id: type: string label: type: string settings: anyOf: - type: object properties: collapsed: type: boolean layout: type: string enum: - list required: - collapsed - type: object properties: collapsed: type: boolean layout: type: string enum: - grid widget_size: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 required: - collapsed - layout - widget_size attributes: type: array items: type: string controls: type: array items: type: string required: - id - label - settings - attributes - controls - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true reporting_interval: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true attributes_reporting_intervals: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: number - type: object nullable: true enum: - null - nullable: true entity_type: anyOf: - type: string enum: - asset - type: string enum: - area - type: object nullable: true enum: - null - nullable: true asset_tabs: anyOf: - type: array items: anyOf: - type: object properties: type: type: string enum: - core id: anyOf: - type: string enum: - data - type: string enum: - history - type: string enum: - controls - type: string enum: - logs - type: string enum: - events - type: string enum: - comments - type: string enum: - images label: type: string hidden: type: boolean required: - type - id - label - type: object properties: type: type: string enum: - mfe id: type: string label: type: string mfe_id: type: string hidden: type: boolean required: - type - id - label - mfe_id - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true summary: anyOf: - type: array items: anyOf: - allOf: - type: object properties: type: type: string enum: - image required: - type - type: object properties: visible: type: boolean required: - visible - allOf: - type: object properties: type: type: string enum: - profile items: type: array items: anyOf: - type: object properties: type: anyOf: - type: string enum: - name - type: string enum: - id - type: string enum: - type - type: string enum: - customId1 - type: string enum: - customId2 - type: string enum: - reportingStatus - type: string enum: - lastUpdated - type: string enum: - groups - type: string enum: - owners - type: string enum: - tags - type: string enum: - entityType - type: string enum: - deviceType - type: string enum: - description visible: type: boolean required: - type - visible - type: object properties: type: type: string enum: - attribute attributeId: type: string visible: type: boolean required: - type - attributeId - visible required: - type - items - type: object properties: visible: type: boolean required: - visible - allOf: - type: object properties: type: type: string enum: - eventsPanel required: - type - type: object properties: visible: type: boolean required: - visible - allOf: - type: object properties: type: type: string enum: - tree required: - type - type: object properties: visible: type: boolean required: - visible - allOf: - type: object properties: type: type: string enum: - location items: type: array items: type: object properties: type: anyOf: - type: string enum: - map - type: string enum: - lastUpdated - type: string enum: - floorLevel visible: type: boolean required: - type - visible required: - type - items - type: object properties: visible: type: boolean required: - visible - type: object nullable: true enum: - null - nullable: true modal_configuration: anyOf: - type: object properties: fields: type: array items: anyOf: - allOf: - type: object properties: type: type: string enum: - default_column column: anyOf: - type: string enum: - id - type: string enum: - owners - type: string enum: - latitude - type: string enum: - longitude - type: string enum: - type - type: string enum: - label - type: string enum: - description - type: string enum: - image - type: string enum: - last_updated - type: string enum: - location_updated - type: string enum: - custom_data - type: string enum: - attributes_last_updated - type: string enum: - parent - type: string enum: - location_x - type: string enum: - location_y - type: string enum: - location_z - type: string enum: - location_type - type: string enum: - location_unit - type: string enum: - custom_id_1 - type: string enum: - custom_id_2 - type: string enum: - last_location_updated - type: string enum: - group_id - type: string enum: - tree_id - type: string enum: - is_root - type: string enum: - floor_levels - type: string enum: - attributes_labels - type: string enum: - is_reporting - type: string enum: - attributes_is_reporting - type: string enum: - tags - type: string enum: - attributes_errors - type: string enum: - polygon - type: string enum: - is_archived - type: string enum: - image_id - type: string enum: - address - type: string enum: - groups - type: string enum: - children required: - type - column - type: object properties: required: type: boolean cols: type: object properties: xs: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto sm: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto md: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto lg: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto xl: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto required: - xs - sm - md - lg - xl - allOf: - type: object properties: type: type: string enum: - attribute attributeId: type: string required: - type - attributeId - type: object properties: required: type: boolean cols: type: object properties: xs: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto sm: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto md: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto lg: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto xl: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto required: - xs - sm - md - lg - xl mapConfig: type: object properties: show: type: boolean required: - show version: type: number required: - fields - mapConfig - version - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - id - label - description - icon - controls_schema - device_type - parent_child_options - icon_svg - default_history_view - hide_attribute_if_undefined - categories - entity_type - asset_tabs - item_id - type: object properties: schema: type: array items: allOf: - type: object properties: attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary attribute_edit_widget: anyOf: - type: string enum: - input - type: string enum: - textArea - type: string enum: - password - type: string enum: - number - type: string enum: - color - type: string enum: - slider - type: string enum: - datePicker - type: string enum: - toggle - type: string enum: - checkbox - type: string enum: - text_options - type: string enum: - dictionaryTextInput - type: string attribute_view_widget: anyOf: - type: string enum: - gauge - type: string enum: - bulletGauge - type: string enum: - hyperlink - type: string enum: - image - type: string enum: - label - type: string enum: - color - type: string enum: - toggle - type: string enum: - datePicker - type: string enum: - dataCard - type: string enum: - dictionaryLabel - type: string measurement_profile_id: type: string keep_history: type: boolean hide_attribute: type: boolean readonly_attribute: type: boolean expression: anyOf: - type: object properties: type: type: string enum: - constant value: anyOf: - type: number - type: string - type: boolean - type: array items: nullable: true required: - type - value - type: object properties: type: type: string enum: - variable path: type: array items: type: string params: type: object properties: {} required: - type - path - type: object properties: type: type: string enum: - arithmeticOperation operator: anyOf: - type: string enum: - + - type: string enum: - "-" - type: string enum: - "*" - type: string enum: - / - type: string enum: - "%" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - comparisonOperation operator: anyOf: - type: string enum: - ">" - type: string enum: - < - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - == - type: string enum: - "!=" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - logicalOperation operator: anyOf: - type: string enum: - AND - type: string enum: - OR - type: string enum: - NOT operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - if operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - switch operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - concat operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - split operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - sum operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - average operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - max operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - min operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - map operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - filter operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - reduce operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - length operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - contains operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - indexOf operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - concat operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mean operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - median operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mode operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - standardDeviation operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - variance operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - percentile operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object nullable: true enum: - null - nullable: true required: - attribute_name - attribute_type - attribute_edit_widget - attribute_view_widget - keep_history - hide_attribute - readonly_attribute - type: object properties: custom_edit_settings: anyOf: - type: string - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: number - type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode - type: array items: type: object properties: uuid: type: string breakpointValue: type: number lightModeColor: type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode darkModeColor: type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode required: - uuid - breakpointValue - lightModeColor - darkModeColor - type: array items: type: object properties: uuid: type: string text: type: string required: - uuid - text - type: object properties: displayMode: anyOf: - type: string enum: - TEXT_ONLY - type: string enum: - ICON_ONLY - type: string enum: - TEXT_AND_ICON applyColorToOnlyIcon: type: boolean fontSize: type: number iconSize: type: number trueColorLight: type: object properties: value: type: string colorType: type: string enum: - fixed isDarkMode: type: boolean required: - value - colorType - isDarkMode trueColorDark: type: object properties: value: type: string colorType: type: string enum: - fixed isDarkMode: type: boolean required: - value - colorType - isDarkMode falseColorLight: type: object properties: value: type: string colorType: type: string enum: - fixed isDarkMode: type: boolean required: - value - colorType - isDarkMode falseColorDark: type: object properties: value: type: string colorType: type: string enum: - fixed isDarkMode: type: boolean required: - value - colorType - isDarkMode options: type: array items: type: object properties: id: type: string name: type: string icon_svg: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey label: type: string required: - id - name - label baseColorLight: type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode baseColorDark: type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode baseDisplayName: type: string baseIcon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey thresholds: type: array items: type: object properties: threshold: anyOf: - type: number - type: string lightModeColor: type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode darkModeColor: type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode icon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey displayName: type: string required: - threshold unit: type: string required: - displayMode - applyColorToOnlyIcon - fontSize - iconSize - trueColorLight - trueColorDark - falseColorLight - falseColorDark - options - type: object properties: min: type: object properties: enabled: type: boolean attribute_name: type: string required: - enabled - attribute_name max: type: object properties: enabled: type: boolean attribute_name: type: string required: - enabled - attribute_name stdDev: type: object properties: enabled: type: boolean attribute_name: type: string required: - enabled - attribute_name custom_view_settings: anyOf: - type: string - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: number - type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode - type: array items: type: object properties: uuid: type: string breakpointValue: type: number lightModeColor: type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode darkModeColor: type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode required: - uuid - breakpointValue - lightModeColor - darkModeColor - type: array items: type: object properties: uuid: type: string text: type: string required: - uuid - text - type: object properties: displayMode: anyOf: - type: string enum: - TEXT_ONLY - type: string enum: - ICON_ONLY - type: string enum: - TEXT_AND_ICON applyColorToOnlyIcon: type: boolean fontSize: type: number iconSize: type: number trueColorLight: type: object properties: value: type: string colorType: type: string enum: - fixed isDarkMode: type: boolean required: - value - colorType - isDarkMode trueColorDark: type: object properties: value: type: string colorType: type: string enum: - fixed isDarkMode: type: boolean required: - value - colorType - isDarkMode falseColorLight: type: object properties: value: type: string colorType: type: string enum: - fixed isDarkMode: type: boolean required: - value - colorType - isDarkMode falseColorDark: type: object properties: value: type: string colorType: type: string enum: - fixed isDarkMode: type: boolean required: - value - colorType - isDarkMode options: type: array items: type: object properties: id: type: string name: type: string icon_svg: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey label: type: string required: - id - name - label baseColorLight: type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode baseColorDark: type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode baseDisplayName: type: string baseIcon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey thresholds: type: array items: type: object properties: threshold: anyOf: - type: number - type: string lightModeColor: type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode darkModeColor: type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode icon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey displayName: type: string required: - threshold unit: type: string required: - displayMode - applyColorToOnlyIcon - fontSize - iconSize - trueColorLight - trueColorDark - falseColorLight - falseColorDark - options - type: object properties: min: type: object properties: enabled: type: boolean attribute_name: type: string required: - enabled - attribute_name max: type: object properties: enabled: type: boolean attribute_name: type: string required: - enabled - attribute_name stdDev: type: object properties: enabled: type: boolean attribute_name: type: string required: - enabled - attribute_name - type: object properties: displayMode: anyOf: - type: string enum: - TEXT_ONLY - type: string enum: - ICON_ONLY - type: string enum: - TEXT_AND_ICON applyColorToOnlyIcon: type: boolean fontSize: type: number iconSize: type: number trueColorLight: type: object properties: value: type: string colorType: type: string enum: - fixed isDarkMode: type: boolean required: - value - colorType - isDarkMode trueColorDark: type: object properties: value: type: string colorType: type: string enum: - fixed isDarkMode: type: boolean required: - value - colorType - isDarkMode falseColorLight: type: object properties: value: type: string colorType: type: string enum: - fixed isDarkMode: type: boolean required: - value - colorType - isDarkMode falseColorDark: type: object properties: value: type: string colorType: type: string enum: - fixed isDarkMode: type: boolean required: - value - colorType - isDarkMode options: type: array items: type: object properties: id: type: string name: type: string icon_svg: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey label: type: string required: - id - name - label baseColorLight: type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode baseColorDark: type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode baseDisplayName: type: string baseIcon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey thresholds: type: array items: type: object properties: threshold: anyOf: - type: number - type: string lightModeColor: type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode darkModeColor: type: object properties: colorType: anyOf: - type: string enum: - theme - type: string enum: - custom - type: string enum: - fixed value: type: string isDarkMode: type: boolean required: - colorType - value - isDarkMode icon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey displayName: type: string required: - threshold unit: type: string required: - displayMode - applyColorToOnlyIcon - fontSize - iconSize - trueColorLight - trueColorDark - falseColorLight - falseColorDark - options - type: object properties: uuid: type: string required: - uuid /api/v/1/code/{systemKey}/createTableItems?id=assetTypeInTree.create: post: tags: - Asset Type Tree description: Add asset type to tree parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assetTypeInTree.create body: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true icon: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true schema: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true controls_schema: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true device_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true parent_child_options: anyOf: - type: object properties: propagate_location_to_root: type: boolean store_updates_on_root: type: boolean show_location_on_map: type: boolean - type: object nullable: true enum: - null - nullable: true icon_svg: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true default_history_view: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true hide_attribute_if_undefined: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true categories: anyOf: - type: array items: type: object properties: id: type: string label: type: string settings: anyOf: - type: object properties: collapsed: type: boolean layout: type: string enum: - list required: - collapsed - type: object properties: collapsed: type: boolean layout: type: string enum: - grid widget_size: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 required: - collapsed - layout - widget_size attributes: type: array items: type: string controls: type: array items: type: string required: - id - label - settings - attributes - controls - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true reporting_interval: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true attributes_reporting_intervals: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: number - type: object nullable: true enum: - null - nullable: true entity_type: anyOf: - type: string enum: - asset - type: string enum: - area - type: object nullable: true enum: - null - nullable: true asset_tabs: anyOf: - type: array items: anyOf: - type: object properties: type: type: string enum: - core id: anyOf: - type: string enum: - data - type: string enum: - history - type: string enum: - controls - type: string enum: - logs - type: string enum: - events - type: string enum: - comments - type: string enum: - images label: type: string hidden: type: boolean required: - type - id - label - type: object properties: type: type: string enum: - mfe id: type: string label: type: string mfe_id: type: string hidden: type: boolean required: - type - id - label - mfe_id - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true summary: anyOf: - type: array items: anyOf: - allOf: - type: object properties: type: type: string enum: - image required: - type - type: object properties: visible: type: boolean required: - visible - allOf: - type: object properties: type: type: string enum: - profile items: type: array items: anyOf: - type: object properties: type: anyOf: - type: string enum: - name - type: string enum: - id - type: string enum: - type - type: string enum: - customId1 - type: string enum: - customId2 - type: string enum: - reportingStatus - type: string enum: - lastUpdated - type: string enum: - groups - type: string enum: - owners - type: string enum: - tags - type: string enum: - entityType - type: string enum: - deviceType - type: string enum: - description visible: type: boolean required: - type - visible - type: object properties: type: type: string enum: - attribute attributeId: type: string visible: type: boolean required: - type - attributeId - visible required: - type - items - type: object properties: visible: type: boolean required: - visible - allOf: - type: object properties: type: type: string enum: - eventsPanel required: - type - type: object properties: visible: type: boolean required: - visible - allOf: - type: object properties: type: type: string enum: - tree required: - type - type: object properties: visible: type: boolean required: - visible - allOf: - type: object properties: type: type: string enum: - location items: type: array items: type: object properties: type: anyOf: - type: string enum: - map - type: string enum: - lastUpdated - type: string enum: - floorLevel visible: type: boolean required: - type - visible required: - type - items - type: object properties: visible: type: boolean required: - visible - type: object nullable: true enum: - null - nullable: true modal_configuration: anyOf: - type: object properties: fields: type: array items: anyOf: - allOf: - type: object properties: type: type: string enum: - default_column column: anyOf: - type: string enum: - id - type: string enum: - owners - type: string enum: - latitude - type: string enum: - longitude - type: string enum: - type - type: string enum: - label - type: string enum: - description - type: string enum: - image - type: string enum: - last_updated - type: string enum: - location_updated - type: string enum: - custom_data - type: string enum: - attributes_last_updated - type: string enum: - parent - type: string enum: - location_x - type: string enum: - location_y - type: string enum: - location_z - type: string enum: - location_type - type: string enum: - location_unit - type: string enum: - custom_id_1 - type: string enum: - custom_id_2 - type: string enum: - last_location_updated - type: string enum: - group_id - type: string enum: - tree_id - type: string enum: - is_root - type: string enum: - floor_levels - type: string enum: - attributes_labels - type: string enum: - is_reporting - type: string enum: - attributes_is_reporting - type: string enum: - tags - type: string enum: - attributes_errors - type: string enum: - polygon - type: string enum: - is_archived - type: string enum: - image_id - type: string enum: - address - type: string enum: - groups - type: string enum: - children required: - type - column - type: object properties: required: type: boolean cols: type: object properties: xs: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto sm: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto md: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto lg: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto xl: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto required: - xs - sm - md - lg - xl - allOf: - type: object properties: type: type: string enum: - attribute attributeId: type: string required: - type - attributeId - type: object properties: required: type: boolean cols: type: object properties: xs: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto sm: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto md: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto lg: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto xl: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto required: - xs - sm - md - lg - xl mapConfig: type: object properties: show: type: boolean required: - show version: type: number required: - fields - mapConfig - version - type: object nullable: true enum: - null - nullable: true required: - id - label - description - icon - schema - controls_schema - device_type - parent_child_options - icon_svg - default_history_view - hide_attribute_if_undefined - categories - entity_type - asset_tabs required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true icon: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true schema: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true controls_schema: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true device_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true parent_child_options: anyOf: - type: object properties: propagate_location_to_root: type: boolean store_updates_on_root: type: boolean show_location_on_map: type: boolean - type: object nullable: true enum: - null - nullable: true icon_svg: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true default_history_view: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true hide_attribute_if_undefined: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true categories: anyOf: - type: array items: type: object properties: id: type: string label: type: string settings: anyOf: - type: object properties: collapsed: type: boolean layout: type: string enum: - list required: - collapsed - type: object properties: collapsed: type: boolean layout: type: string enum: - grid widget_size: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 required: - collapsed - layout - widget_size attributes: type: array items: type: string controls: type: array items: type: string required: - id - label - settings - attributes - controls - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true reporting_interval: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true attributes_reporting_intervals: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: number - type: object nullable: true enum: - null - nullable: true entity_type: anyOf: - type: string enum: - asset - type: string enum: - area - type: object nullable: true enum: - null - nullable: true asset_tabs: anyOf: - type: array items: anyOf: - type: object properties: type: type: string enum: - core id: anyOf: - type: string enum: - data - type: string enum: - history - type: string enum: - controls - type: string enum: - logs - type: string enum: - events - type: string enum: - comments - type: string enum: - images label: type: string hidden: type: boolean required: - type - id - label - type: object properties: type: type: string enum: - mfe id: type: string label: type: string mfe_id: type: string hidden: type: boolean required: - type - id - label - mfe_id - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true summary: anyOf: - type: array items: anyOf: - allOf: - type: object properties: type: type: string enum: - image required: - type - type: object properties: visible: type: boolean required: - visible - allOf: - type: object properties: type: type: string enum: - profile items: type: array items: anyOf: - type: object properties: type: anyOf: - type: string enum: - name - type: string enum: - id - type: string enum: - type - type: string enum: - customId1 - type: string enum: - customId2 - type: string enum: - reportingStatus - type: string enum: - lastUpdated - type: string enum: - groups - type: string enum: - owners - type: string enum: - tags - type: string enum: - entityType - type: string enum: - deviceType - type: string enum: - description visible: type: boolean required: - type - visible - type: object properties: type: type: string enum: - attribute attributeId: type: string visible: type: boolean required: - type - attributeId - visible required: - type - items - type: object properties: visible: type: boolean required: - visible - allOf: - type: object properties: type: type: string enum: - eventsPanel required: - type - type: object properties: visible: type: boolean required: - visible - allOf: - type: object properties: type: type: string enum: - tree required: - type - type: object properties: visible: type: boolean required: - visible - allOf: - type: object properties: type: type: string enum: - location items: type: array items: type: object properties: type: anyOf: - type: string enum: - map - type: string enum: - lastUpdated - type: string enum: - floorLevel visible: type: boolean required: - type - visible required: - type - items - type: object properties: visible: type: boolean required: - visible - type: object nullable: true enum: - null - nullable: true modal_configuration: anyOf: - type: object properties: fields: type: array items: anyOf: - allOf: - type: object properties: type: type: string enum: - default_column column: anyOf: - type: string enum: - id - type: string enum: - owners - type: string enum: - latitude - type: string enum: - longitude - type: string enum: - type - type: string enum: - label - type: string enum: - description - type: string enum: - image - type: string enum: - last_updated - type: string enum: - location_updated - type: string enum: - custom_data - type: string enum: - attributes_last_updated - type: string enum: - parent - type: string enum: - location_x - type: string enum: - location_y - type: string enum: - location_z - type: string enum: - location_type - type: string enum: - location_unit - type: string enum: - custom_id_1 - type: string enum: - custom_id_2 - type: string enum: - last_location_updated - type: string enum: - group_id - type: string enum: - tree_id - type: string enum: - is_root - type: string enum: - floor_levels - type: string enum: - attributes_labels - type: string enum: - is_reporting - type: string enum: - attributes_is_reporting - type: string enum: - tags - type: string enum: - attributes_errors - type: string enum: - polygon - type: string enum: - is_archived - type: string enum: - image_id - type: string enum: - address - type: string enum: - groups - type: string enum: - children required: - type - column - type: object properties: required: type: boolean cols: type: object properties: xs: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto sm: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto md: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto lg: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto xl: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto required: - xs - sm - md - lg - xl - allOf: - type: object properties: type: type: string enum: - attribute attributeId: type: string required: - type - attributeId - type: object properties: required: type: boolean cols: type: object properties: xs: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto sm: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto md: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto lg: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto xl: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto required: - xs - sm - md - lg - xl mapConfig: type: object properties: show: type: boolean required: - show version: type: number required: - fields - mapConfig - version - type: object nullable: true enum: - null - nullable: true required: - id - label - description - icon - schema - controls_schema - device_type - parent_child_options - icon_svg - default_history_view - hide_attribute_if_undefined - categories - entity_type - asset_tabs /api/v/1/code/{systemKey}/createTableItems?id=assetTypeChild.create: post: tags: - Asset Type Tree description: Add child to asset type in tree parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assetTypeChild.create body: type: object properties: childId: type: string parentId: type: string required: - childId - parentId required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/createTableItems?id=regionalDeviceConfigs.create: post: tags: - Device Config description: Create regional device configurations. This is also the update route, since a new config is created for every version. parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - regionalDeviceConfigs.create body: type: object properties: item: type: object properties: id: type: string device_type: type: string config: type: object properties: {} required: - id - device_type - config assetId: type: string required: - item - assetId required: - name - body responses: "200": description: Success content: application/json: schema: allOf: - type: object properties: id: type: string asset_id: type: string required: - id - asset_id - type: object properties: device_type: type: string config: type: object properties: {} required: - device_type - config /api/v/1/code/{systemKey}/createTableItems?id=deviceConfigs.create: post: tags: - Device Config description: Create a device configuration file parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - deviceConfigs.create body: allOf: - type: object properties: file_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true asset_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true upload_timestamp: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true upload_user_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true file_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - file_id - asset_id - upload_timestamp - upload_user_id - file_type - type: object properties: data: nullable: true required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: file_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true asset_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true version: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true required: - file_id - asset_id - version /api/v/1/code/{systemKey}/createTableItems?id=templateConfigs.create: post: tags: - Device Config description: Create a template configuration file parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - templateConfigs.create body: allOf: - type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true file_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true template_name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true device_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true upload_timestamp: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true upload_user_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true file_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - id - file_id - template_name - description - device_type - upload_timestamp - upload_user_id - file_type - type: object properties: data: nullable: true required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true file_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true template_name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true device_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true version: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - id - file_id - template_name - device_type - version - description /api/v/1/code/{systemKey}/createTableItems?id=eventTypes.create: post: tags: - Event Types description: Create event types parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - eventTypes.create body: type: object properties: item: type: object properties: id: type: string label: type: string severity: type: number priority: type: number action_types: type: array items: type: string description: type: string has_lifecycle: type: boolean exclude_asset_trees: type: boolean open_states: type: array items: type: string closed_states: type: array items: type: string open_states_arr: type: array items: type: string closed_states_arr: type: array items: type: string attributes: anyOf: - type: array items: type: object properties: attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - boolean - type: string enum: - dateTime required: - attribute_name - attribute_label - attribute_type - type: object nullable: true enum: - null - nullable: true required: - id - label - severity - priority groupIds: type: array items: type: string required: - item - groupIds required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: item: type: object properties: id: type: string label: type: string severity: type: number priority: type: number action_types: type: array items: type: string description: type: string has_lifecycle: type: boolean exclude_asset_trees: type: boolean open_states: type: array items: type: string closed_states: type: array items: type: string open_states_arr: type: array items: type: string closed_states_arr: type: array items: type: string attributes: anyOf: - type: array items: type: object properties: attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - boolean - type: string enum: - dateTime required: - attribute_name - attribute_label - attribute_type - type: object nullable: true enum: - null - nullable: true required: - id - label - severity - priority groupIds: type: array items: type: string required: - item - groupIds /api/v/1/code/{systemKey}/createTableItems?id=rules.create: post: tags: - Rules description: Create rules parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - rules.create body: nullable: true required: - name responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/createTableItems?id=ruleTypes.create: post: tags: - Rule Types description: Create rule types parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - ruleTypes.create body: type: object properties: item: allOf: - type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true event_type_ids: anyOf: - type: array items: type: string - type: object nullable: true enum: - null - nullable: true required: - id - label - event_type_ids - type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true include_timeframe: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true conditions: anyOf: - type: object properties: and: type: array items: anyOf: - type: object properties: type: type: string enum: - state meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 3 maxItems: 3 required: - type - meta - type: object properties: type: type: string enum: - area meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 4 maxItems: 4 required: - type - meta - type: object properties: type: type: string enum: - expression meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 2 maxItems: 2 required: - type - meta - type: object properties: and: type: array items: anyOf: - type: object properties: type: type: string enum: - state meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 3 maxItems: 3 required: - type - meta - type: object properties: type: type: string enum: - area meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 4 maxItems: 4 required: - type - meta - type: object properties: type: type: string enum: - expression meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 2 maxItems: 2 required: - type - meta - nullable: true - nullable: true or: type: array items: anyOf: - type: object properties: type: type: string enum: - state meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 3 maxItems: 3 required: - type - meta - type: object properties: type: type: string enum: - area meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 4 maxItems: 4 required: - type - meta - type: object properties: type: type: string enum: - expression meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 2 maxItems: 2 required: - type - meta - nullable: true - nullable: true or: type: array items: anyOf: - type: object properties: type: type: string enum: - state meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 3 maxItems: 3 required: - type - meta - type: object properties: type: type: string enum: - area meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 4 maxItems: 4 required: - type - meta - type: object properties: type: type: string enum: - expression meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 2 maxItems: 2 required: - type - meta - type: object properties: and: type: array items: anyOf: - type: object properties: type: type: string enum: - state meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 3 maxItems: 3 required: - type - meta - type: object properties: type: type: string enum: - area meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 4 maxItems: 4 required: - type - meta - type: object properties: type: type: string enum: - expression meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 2 maxItems: 2 required: - type - meta - nullable: true - nullable: true or: type: array items: anyOf: - type: object properties: type: type: string enum: - state meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 3 maxItems: 3 required: - type - meta - type: object properties: type: type: string enum: - area meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 4 maxItems: 4 required: - type - meta - type: object properties: type: type: string enum: - expression meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 2 maxItems: 2 required: - type - meta - nullable: true - nullable: true - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true event_type_ids: anyOf: - type: array items: type: string - type: object nullable: true enum: - null - nullable: true is_external: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true is_invalid: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true required: - id - include_timeframe - conditions - label - event_type_ids - is_external - is_invalid groupIds: type: array items: type: string required: - item - groupIds required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true include_timeframe: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true conditions: anyOf: - type: object properties: and: type: array items: anyOf: - type: object properties: type: type: string enum: - state meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 3 maxItems: 3 required: - type - meta - type: object properties: type: type: string enum: - area meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 4 maxItems: 4 required: - type - meta - type: object properties: type: type: string enum: - expression meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 2 maxItems: 2 required: - type - meta - type: object properties: and: type: array items: anyOf: - type: object properties: type: type: string enum: - state meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 3 maxItems: 3 required: - type - meta - type: object properties: type: type: string enum: - area meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 4 maxItems: 4 required: - type - meta - type: object properties: type: type: string enum: - expression meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 2 maxItems: 2 required: - type - meta - nullable: true - nullable: true or: type: array items: anyOf: - type: object properties: type: type: string enum: - state meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 3 maxItems: 3 required: - type - meta - type: object properties: type: type: string enum: - area meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 4 maxItems: 4 required: - type - meta - type: object properties: type: type: string enum: - expression meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 2 maxItems: 2 required: - type - meta - nullable: true - nullable: true or: type: array items: anyOf: - type: object properties: type: type: string enum: - state meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 3 maxItems: 3 required: - type - meta - type: object properties: type: type: string enum: - area meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 4 maxItems: 4 required: - type - meta - type: object properties: type: type: string enum: - expression meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 2 maxItems: 2 required: - type - meta - type: object properties: and: type: array items: anyOf: - type: object properties: type: type: string enum: - state meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 3 maxItems: 3 required: - type - meta - type: object properties: type: type: string enum: - area meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 4 maxItems: 4 required: - type - meta - type: object properties: type: type: string enum: - expression meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 2 maxItems: 2 required: - type - meta - nullable: true - nullable: true or: type: array items: anyOf: - type: object properties: type: type: string enum: - state meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 3 maxItems: 3 required: - type - meta - type: object properties: type: type: string enum: - area meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: relationship: anyOf: - allOf: - anyOf: - type: object properties: equal: type: boolean notEqual: type: boolean "true": type: string "false": type: string - type: object properties: equal: type: string notEqual: type: string value: type: string required: - equal - notEqual - type: object properties: value: type: number greaterThan: type: string lessThan: type: string equal: type: string notEqual: type: string greaterThanInclusive: type: string lessThanInclusive: type: string units: type: string comparePreviousNumberType: anyOf: - type: string enum: - value - type: string enum: - percent - type: string enum: - numeric required: - greaterThan - lessThan - equal - notEqual - greaterThanInclusive - lessThanInclusive - units - type: object properties: attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string suffix: type: string comparePreviousValue: type: boolean required: - attribute - attribute_label - attribute_type - suffix - type: object properties: evaluateIsReporting: type: string enum: - last_updated notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - notReportingLabel - isReportingLabel - type: object properties: evaluateIsReporting: type: string enum: - attribute attribute: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - boolean - type: string enum: - number - type: string enum: - string notReportingLabel: type: string isReportingLabel: type: string required: - evaluateIsReporting - attribute - attribute_label - attribute_type - notReportingLabel - isReportingLabel - type: object properties: inside: type: string outside: type: string required: - inside - outside required: - relationship - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 4 maxItems: 4 required: - type - meta - type: object properties: type: type: string enum: - expression meta: type: array items: anyOf: - type: object properties: entity: type: object properties: prefix: type: string selected_entity: type: object properties: value: anyOf: - type: string enum: - all - type: string ancestorId: type: string required: - value allow_types: type: boolean allow_specific: type: boolean suffix: type: string filter_type: type: array items: anyOf: - type: object properties: id: type: string enum: - assets type: type: string enum: - all label: type: string enum: - Assets required: - id - type - label - type: object properties: id: type: string enum: - asset_types type: type: string enum: - types label: type: string enum: - Asset Types required: - id - type - label - type: object properties: id: type: string enum: - areas type: type: string enum: - all label: type: string enum: - Areas required: - id - type - label - type: object properties: id: type: string enum: - area_types type: type: string enum: - types label: type: string enum: - Area Types required: - id - type - label required: - prefix - selected_entity - allow_types - allow_specific - suffix - filter_type required: - entity - type: object properties: duration: type: object properties: include_duration: type: boolean required: - include_duration required: - duration minItems: 2 maxItems: 2 required: - type - meta - nullable: true - nullable: true - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true event_type_ids: anyOf: - type: array items: type: string - type: object nullable: true enum: - null - nullable: true is_external: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true is_invalid: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - id - include_timeframe - conditions - label - event_type_ids - is_external - is_invalid - item_id /api/v/1/code/{systemKey}/createTableItems?id=dashboardsv2.create: post: tags: - Dashboards description: Create dashboards parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - dashboardsv2.create body: type: object properties: item: type: object properties: version: type: string enum: - 1.0.0 id: type: string label: type: string last_updated: type: string last_updated_by: type: string pages: type: array items: type: object properties: version: type: string enum: - 1.0.0 id: type: string header: type: string controlLayouts: nullable: true mainLayouts: nullable: true widgets: type: array items: type: object properties: id: type: string description: type: string header: type: string visualization: type: object properties: type: type: string purpose: anyOf: - type: string enum: - TIME - type: string enum: - ITEM - type: string enum: - TABULAR - type: string enum: - CONTROL - type: string enum: - INDICATOR - type: string enum: - PERCENTAGE - type: string enum: - IMAGE required: - type - purpose version: type: string queries: nullable: true settings: nullable: true required: - id - description - header - visualization - version required: - version - id - header - widgets description: type: string microfrontend_id: type: string defaults: type: object properties: time_range: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate refresh_rate: type: object properties: count: type: number units: anyOf: - type: number enum: - 1 - type: number enum: - 60 - type: number enum: - 3600 - type: number enum: - 86400 - type: number enum: - 604800 - type: number enum: - 2592000 - type: number enum: - 31104000 required: - count - units required: - version - id - label - last_updated - last_updated_by - pages groupIds: type: array items: type: string required: - item - groupIds required: - name - body responses: "200": description: Success content: application/json: schema: allOf: - type: object properties: id: type: string required: - id - type: object properties: version: type: string enum: - 1.0.0 label: type: string last_updated: type: string last_updated_by: type: string pages: type: array items: type: object properties: version: type: string enum: - 1.0.0 id: type: string header: type: string controlLayouts: nullable: true mainLayouts: nullable: true widgets: type: array items: type: object properties: id: type: string description: type: string header: type: string visualization: type: object properties: type: type: string purpose: anyOf: - type: string enum: - TIME - type: string enum: - ITEM - type: string enum: - TABULAR - type: string enum: - CONTROL - type: string enum: - INDICATOR - type: string enum: - PERCENTAGE - type: string enum: - IMAGE required: - type - purpose version: type: string queries: nullable: true settings: nullable: true required: - id - description - header - visualization - version required: - version - id - header - widgets description: type: string microfrontend_id: type: string defaults: type: object properties: time_range: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate refresh_rate: type: object properties: count: type: number units: anyOf: - type: number enum: - 1 - type: number enum: - 60 - type: number enum: - 3600 - type: number enum: - 86400 - type: number enum: - 604800 - type: number enum: - 2592000 - type: number enum: - 31104000 required: - count - units groups: type: array items: type: object properties: id: type: string name: type: string required: - id - name required: - version - label - last_updated - last_updated_by - pages - groups /api/v/1/code/{systemKey}/createTableItems?id=microfrontends.create: post: tags: - Microfrontends description: Create microfrontends parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - microfrontends.create body: anyOf: - allOf: - type: object properties: id: type: string url: type: string url_location: anyOf: - type: object nullable: true enum: - null - type: string enum: - files - nullable: true required: - id - url - type: object properties: type: type: string enum: - page config: anyOf: - type: object nullable: true enum: - null - type: undefined enum: - null - nullable: true required: - type - allOf: - type: object properties: id: type: string url: type: string url_location: anyOf: - type: object nullable: true enum: - null - type: string enum: - files - nullable: true required: - id - url - type: object properties: type: type: string enum: - attributeView config: anyOf: - type: object nullable: true enum: - null - type: object properties: label: type: string attributeType: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary required: - label - attributeType - nullable: true required: - type - config - allOf: - type: object properties: id: type: string url: type: string url_location: anyOf: - type: object nullable: true enum: - null - type: string enum: - files - nullable: true required: - id - url - type: object properties: type: type: string enum: - attributeEdit config: anyOf: - type: object nullable: true enum: - null - type: object properties: label: type: string attributeType: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary required: - label - attributeType - nullable: true required: - type - config - allOf: - type: object properties: id: type: string url: type: string url_location: anyOf: - type: object nullable: true enum: - null - type: string enum: - files - nullable: true required: - id - url - type: object properties: type: type: string enum: - dashboard config: anyOf: - type: object nullable: true enum: - null - type: undefined enum: - null - nullable: true required: - type - allOf: - type: object properties: id: type: string url: type: string url_location: anyOf: - type: object nullable: true enum: - null - type: string enum: - files - nullable: true required: - id - url - type: object properties: type: type: string enum: - assetTab config: anyOf: - type: object nullable: true enum: - null - type: undefined enum: - null - nullable: true required: - type required: - name - body responses: "200": description: Success content: application/json: schema: anyOf: - allOf: - type: object properties: id: type: string url: type: string url_location: anyOf: - type: object nullable: true enum: - null - type: string enum: - files - nullable: true required: - id - url - type: object properties: type: type: string enum: - page config: anyOf: - type: object nullable: true enum: - null - type: undefined enum: - null - nullable: true required: - type - type: object properties: item_id: type: string required: - item_id - allOf: - type: object properties: id: type: string url: type: string url_location: anyOf: - type: object nullable: true enum: - null - type: string enum: - files - nullable: true required: - id - url - type: object properties: type: type: string enum: - attributeView config: anyOf: - type: object nullable: true enum: - null - type: object properties: label: type: string attributeType: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary required: - label - attributeType - nullable: true required: - type - config - type: object properties: item_id: type: string required: - item_id - allOf: - type: object properties: id: type: string url: type: string url_location: anyOf: - type: object nullable: true enum: - null - type: string enum: - files - nullable: true required: - id - url - type: object properties: type: type: string enum: - attributeEdit config: anyOf: - type: object nullable: true enum: - null - type: object properties: label: type: string attributeType: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary required: - label - attributeType - nullable: true required: - type - config - type: object properties: item_id: type: string required: - item_id - allOf: - type: object properties: id: type: string url: type: string url_location: anyOf: - type: object nullable: true enum: - null - type: string enum: - files - nullable: true required: - id - url - type: object properties: type: type: string enum: - dashboard config: anyOf: - type: object nullable: true enum: - null - type: undefined enum: - null - nullable: true required: - type - type: object properties: item_id: type: string required: - item_id - allOf: - type: object properties: id: type: string url: type: string url_location: anyOf: - type: object nullable: true enum: - null - type: string enum: - files - nullable: true required: - id - url - type: object properties: type: type: string enum: - assetTab config: anyOf: - type: object nullable: true enum: - null - type: undefined enum: - null - nullable: true required: - type - type: object properties: item_id: type: string required: - item_id /api/v/1/code/{systemKey}/createTableItems?id=imageInBucket.create: post: tags: - Asset Images description: Create images in a specific bucket parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - imageInBucket.create body: type: object properties: path: type: string binary: type: string required: - path - binary required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/createTableItems?id=assets.create: post: tags: - Assets description: Create assets parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assets.create body: allOf: - type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - id - type - type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true owners: anyOf: - type: array items: type: string - type: object nullable: true enum: - null - nullable: true latitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true longitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true image: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_data: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: number - type: boolean - type: object nullable: true enum: - null - type: undefined enum: - null - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: string - type: number - type: boolean - nullable: true - type: object nullable: true enum: - null - nullable: true attributes_last_updated: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true parent: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_x: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_y: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_z: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_unit: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_id_1: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_id_2: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_location_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true group_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true tree_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true is_root: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true floor_levels: anyOf: - type: array items: type: number - type: object nullable: true enum: - null - nullable: true attributes_labels: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: string - type: object nullable: true enum: - null - nullable: true is_reporting: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true attributes_is_reporting: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: boolean - type: object nullable: true enum: - null - nullable: true tags: type: array items: type: string attributes_errors: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: object properties: message: type: string timestamp: type: string required: - message - timestamp - type: object nullable: true enum: - null - nullable: true polygon: anyOf: - type: object properties: geometry_type: type: string enum: - gps polygon: anyOf: - type: array items: type: object properties: long: type: number lat: type: number required: - long - lat - type: object nullable: true enum: - null - nullable: true required: - geometry_type - type: object properties: geometry_type: type: string enum: - indoor_area polygon: anyOf: - type: array items: type: object properties: x: type: number y: type: number z: type: number required: - x - y - z - type: object nullable: true enum: - null - nullable: true required: - geometry_type - type: object properties: geometry_type: type: string enum: - indoor_model required: - geometry_type - type: object properties: geometry_type: type: string enum: - geojson features: type: array items: type: object properties: type: type: string enum: - Feature properties: type: object properties: {} geometry: anyOf: - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number required: - type - coordinates - type: object properties: type: type: string enum: - MultiPolygon coordinates: type: array items: type: array items: type: array items: type: array items: type: number required: - type - coordinates required: - type - properties - geometry required: - geometry_type - features - type: object nullable: true enum: - null - nullable: true is_archived: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true image_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true address: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true group_ids: anyOf: - type: array items: type: string - type: object nullable: true enum: - null - nullable: true required: - id - owners - latitude - longitude - type - label - description - image - last_updated - location_updated - custom_data - attributes_last_updated - parent - location_x - location_y - location_z - location_type - location_unit - custom_id_1 - custom_id_2 - last_location_updated - group_id - tree_id - is_root - floor_levels - attributes_labels - group_ids required: - name - body responses: "200": description: Success content: application/json: schema: allOf: - type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - id - type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true owners: anyOf: - type: array items: type: string - type: object nullable: true enum: - null - nullable: true latitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true longitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true image: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_data: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: number - type: boolean - type: object nullable: true enum: - null - type: undefined enum: - null - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: string - type: number - type: boolean - nullable: true - type: object nullable: true enum: - null - nullable: true attributes_last_updated: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true parent: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_x: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_y: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_z: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_unit: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_id_1: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_id_2: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_location_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true group_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true tree_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true is_root: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true floor_levels: anyOf: - type: array items: type: number - type: object nullable: true enum: - null - nullable: true attributes_labels: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: string - type: object nullable: true enum: - null - nullable: true is_reporting: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true attributes_is_reporting: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: boolean - type: object nullable: true enum: - null - nullable: true tags: type: array items: type: string attributes_errors: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: object properties: message: type: string timestamp: type: string required: - message - timestamp - type: object nullable: true enum: - null - nullable: true polygon: anyOf: - type: object properties: geometry_type: type: string enum: - gps polygon: anyOf: - type: array items: type: object properties: long: type: number lat: type: number required: - long - lat - type: object nullable: true enum: - null - nullable: true required: - geometry_type - type: object properties: geometry_type: type: string enum: - indoor_area polygon: anyOf: - type: array items: type: object properties: x: type: number y: type: number z: type: number required: - x - y - z - type: object nullable: true enum: - null - nullable: true required: - geometry_type - type: object properties: geometry_type: type: string enum: - indoor_model required: - geometry_type - type: object properties: geometry_type: type: string enum: - geojson features: type: array items: type: object properties: type: type: string enum: - Feature properties: type: object properties: {} geometry: anyOf: - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number required: - type - coordinates - type: object properties: type: type: string enum: - MultiPolygon coordinates: type: array items: type: array items: type: array items: type: array items: type: number required: - type - coordinates required: - type - properties - geometry required: - geometry_type - features - type: object nullable: true enum: - null - nullable: true is_archived: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true image_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true address: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true group_ids: anyOf: - type: array items: type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - id - owners - latitude - longitude - type - label - description - image - last_updated - location_updated - custom_data - attributes_last_updated - parent - location_x - location_y - location_z - location_type - location_unit - custom_id_1 - custom_id_2 - last_location_updated - group_id - tree_id - is_root - floor_levels - attributes_labels - group_ids - item_id /api/v/1/code/{systemKey}/createTableItems?id=assetsv3.create: post: tags: - Assets description: Create assets with new request and response types parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assetsv3.create body: type: object properties: item: type: object properties: id: type: string type: type: string custom_id_1: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_id_2: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true latitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true longitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true last_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_location_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_x: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_y: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_z: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_unit: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true floor_levels: anyOf: - type: array items: type: number - type: object nullable: true enum: - null - nullable: true image: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true owners: type: array items: type: string custom_data: type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: number - type: boolean - type: object nullable: true enum: - null - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: string - type: number - type: boolean - nullable: true attributes_last_updated: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: object nullable: true enum: - null - nullable: true attributes_labels: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: string - type: object nullable: true enum: - null - nullable: true parent: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true is_root: type: boolean tags: type: array items: type: string tree_id: type: string attributes_errors: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: object properties: message: type: string timestamp: type: string required: - message - timestamp - type: object nullable: true enum: - null - nullable: true ever_had_closed_event: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true image_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true address: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true is_archived: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true required: - id - type groupIds: type: array items: type: string required: - item - groupIds required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: item: type: object properties: id: type: string type: type: string custom_id_1: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_id_2: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true latitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true longitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true last_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_location_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_x: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_y: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_z: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_unit: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true floor_levels: anyOf: - type: array items: type: number - type: object nullable: true enum: - null - nullable: true image: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true owners: type: array items: type: string custom_data: type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: number - type: boolean - type: object nullable: true enum: - null - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: string - type: number - type: boolean - nullable: true attributes_last_updated: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: object nullable: true enum: - null - nullable: true attributes_labels: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: string - type: object nullable: true enum: - null - nullable: true parent: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true is_root: type: boolean tags: type: array items: type: string tree_id: type: string attributes_errors: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: object properties: message: type: string timestamp: type: string required: - message - timestamp - type: object nullable: true enum: - null - nullable: true ever_had_closed_event: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true image_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true address: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true is_archived: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true required: - id - type groupIds: type: array items: type: string required: - item - groupIds /api/v/1/code/{systemKey}/createTableItems?id=groups.create: post: tags: - Groups description: Create groups parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - groups.create body: allOf: - type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - id - type: object properties: map_location_latitude: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true map_location_longitude: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true map_bounds: anyOf: - type: array items: type: object properties: long: type: number lat: type: number required: - long - lat - type: object nullable: true enum: - null - nullable: true id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true map_zoom: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true map_zoom_float: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true tree_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true is_root: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true tree: type: object properties: id: type: string data: type: object properties: rootID: type: string treeID: type: string nodes: type: object additionalProperties: type: object properties: id: type: string parentID: type: string parents: type: array items: type: string children: type: array items: type: string required: - id - parentID - parents - children required: - rootID - treeID - nodes timezone: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true date_time_locale: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - map_location_latitude - map_location_longitude - map_bounds - id - map_zoom - map_zoom_float - name - tree_id - is_root - timezone required: - name - body responses: "200": description: Success content: application/json: schema: allOf: - type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - id - item_id - type: object properties: map_location_latitude: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true map_location_longitude: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true map_bounds: anyOf: - type: array items: type: object properties: long: type: number lat: type: number required: - long - lat - type: object nullable: true enum: - null - nullable: true id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true map_zoom: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true map_zoom_float: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true tree_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true is_root: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true tree: type: object properties: id: type: string data: type: object properties: rootID: type: string treeID: type: string nodes: type: object additionalProperties: type: object properties: id: type: string parentID: type: string parents: type: array items: type: string children: type: array items: type: string required: - id - parentID - parents - children required: - rootID - treeID - nodes timezone: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true date_time_locale: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - map_location_latitude - map_location_longitude - map_bounds - id - map_zoom - map_zoom_float - name - tree_id - is_root - timezone - item_id /api/v/1/code/{systemKey}/createTableItems?id=roles.create: post: tags: - Roles description: Create custom roles parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - roles.create body: type: object properties: role: nullable: true group_ids: type: array items: type: string required: - group_ids required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: role: nullable: true group_ids: type: array items: type: string required: - group_ids /api/v/1/code/{systemKey}/createTableItems?id=tourItems.create: post: tags: - Tour description: Create tutorial items parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - tourItems.create body: type: undefined enum: - null required: - name responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/createTableItems?id=customSettings.create: post: tags: - Custom Settings description: Create system-wide custom settings parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - customSettings.create body: type: object properties: id: type: string description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true config: type: string required: - id - config required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/createTableItems?id=reports.create: post: tags: - Reports description: Create advanced reports parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - reports.create body: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true code_service_name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true group_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true schedules: anyOf: - type: array items: type: object properties: id: type: string label: type: string email_subject: type: string email_body: type: string email_recipients: type: array items: type: object properties: type: type: string enum: - email email: type: string required: - type - email report_time_range: type: object properties: type: type: string enum: - AMOUNT_OF_TIME value: type: object properties: amount: type: number units: anyOf: - type: string enum: - SECOND - type: string enum: - MINUTE - type: string enum: - HOUR - type: string enum: - DAY - type: string enum: - WEEK - type: string enum: - MONTH - type: string enum: - YEAR required: - amount - units required: - type - value start_date: type: string end_date: type: string repeat: anyOf: - type: object properties: type: type: string enum: - REPEAT_NONE value: type: object properties: amount: type: number units: anyOf: - type: string enum: - SECOND - type: string enum: - MINUTE - type: string enum: - HOUR - type: string enum: - DAY - type: string enum: - WEEK - type: string enum: - MONTH - type: string enum: - YEAR required: - amount - units required: - type - value - type: object properties: type: type: string enum: - AMOUNT_OF_TIME value: type: object properties: amount: type: number units: anyOf: - type: string enum: - SECOND - type: string enum: - MINUTE - type: string enum: - HOUR - type: string enum: - DAY - type: string enum: - WEEK - type: string enum: - MONTH - type: string enum: - YEAR required: - amount - units required: - type - value required: - id - label - email_subject - email_body - email_recipients - report_time_range - start_date - end_date - repeat - type: object nullable: true enum: - null - nullable: true type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true created_on: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true created_by: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - id - label - code_service_name - group_id - schedules - type - created_on - created_by required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/createTableItems?id=heatmapReports.create: post: tags: - Heatmaps description: Create heatmap reports parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - heatmapReports.create body: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true group_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true asset_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true attribute_name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location: anyOf: - type: object properties: type: type: string enum: - area ids: type: array items: type: string required: - type - ids - type: object properties: type: type: string enum: - bounds bounds: type: array items: type: number minItems: 4 maxItems: 4 required: - type - bounds - type: object nullable: true enum: - null - nullable: true analysis: anyOf: - type: object properties: type: type: string enum: - numerical analysis: type: object properties: statistic: anyOf: - type: string enum: - MIN - type: string enum: - MAX - type: string enum: - AVG range: anyOf: - type: object properties: enabled: type: boolean enum: - true minMax: type: array items: type: number minItems: 2 maxItems: 2 required: - enabled - minMax - type: object properties: enabled: type: boolean enum: - false required: - enabled required: - statistic - range required: - type - analysis - type: object nullable: true enum: - null - nullable: true date_range: anyOf: - type: object properties: startDate: type: string endDate: type: string rangeSelection: anyOf: - type: number enum: - 1 - type: number enum: - 7 - type: number enum: - 30 - type: number enum: - 90 - type: number enum: - 180 - type: number enum: - 0 - type: number enum: - -1 required: - startDate - endDate - rangeSelection - type: object nullable: true enum: - null - nullable: true created_on: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true created_by: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - id - label - group_id - asset_type - attribute_name - location - analysis - date_range - created_on - created_by required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/createTableItems?id=assetImageHistory.create: post: tags: - Asset Images description: Create an asset image parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assetImageHistory.create body: type: object properties: asset_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true upload_datetime: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true image_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_modified: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - asset_id - upload_datetime - image_id - last_modified - name required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: asset_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true upload_datetime: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true image_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_modified: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - asset_id - upload_datetime - image_id - last_modified - name - item_id /api/v/1/code/{systemKey}/createTableItems?id=assetComments.create: post: tags: - Asset Comments description: Create an asset comment parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assetComments.create body: nullable: true required: - name responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/createTableItems?id=components.create: post: tags: - Components description: Create instance of existing component parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - components.create body: type: object properties: item: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true type: anyOf: - type: string enum: - ai_internal_v1 - type: string enum: - ai_external - type: string enum: - external - type: string enum: - AI - type: string enum: - THEME - type: string enum: - FUNCTIONAL - type: string enum: - DEVICE - type: object nullable: true enum: - null - nullable: true url: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true prefix: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true entity_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true settings: anyOf: - type: object additionalProperties: nullable: true - type: object nullable: true enum: - null - nullable: true enabled: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true required: - id - name - type - url - prefix - entity_id - settings - enabled required: - item required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true type: anyOf: - type: string enum: - ai_internal_v1 - type: string enum: - ai_external - type: string enum: - external - type: string enum: - AI - type: string enum: - THEME - type: string enum: - FUNCTIONAL - type: string enum: - DEVICE - type: object nullable: true enum: - null - nullable: true url: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true prefix: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true entity_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true settings: anyOf: - type: object additionalProperties: nullable: true - type: object nullable: true enum: - null - nullable: true enabled: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true required: - id - name - type - url - prefix - entity_id - settings - enabled /api/v/1/code/{systemKey}/createTableItems?id=bucketSets.create: post: tags: - Bucket Sets description: Create bucket sets parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - bucketSets.create body: type: object properties: item: type: object properties: name: type: string platform_storage: anyOf: - type: string enum: - local - type: string enum: - google - type: string enum: - s3 platform_config: anyOf: - type: object properties: bucket_name: type: string required: - bucket_name - type: object properties: bucket_name: type: string bucket_region: type: string user_id: type: string user_secret: type: string required: - bucket_name - bucket_region - user_id - user_secret - type: object properties: root: type: string required: - root edge_storage: anyOf: - type: string enum: - local - type: string enum: - google - type: string enum: - s3 edge_config: anyOf: - type: object properties: bucket_name: type: string required: - bucket_name - type: object properties: bucket_name: type: string bucket_region: type: string user_id: type: string user_secret: type: string required: - bucket_name - bucket_region - user_id - user_secret - type: object properties: root: type: string required: - root required: - name - platform_storage - platform_config - edge_storage - edge_config required: - item required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: name: type: string platform_storage: anyOf: - type: string enum: - local - type: string enum: - google - type: string enum: - s3 platform_config: anyOf: - type: object properties: bucket_name: type: string required: - bucket_name - type: object properties: bucket_name: type: string bucket_region: type: string user_id: type: string user_secret: type: string required: - bucket_name - bucket_region - user_id - user_secret - type: object properties: root: type: string required: - root edge_storage: anyOf: - type: string enum: - local - type: string enum: - google - type: string enum: - s3 edge_config: anyOf: - type: object properties: bucket_name: type: string required: - bucket_name - type: object properties: bucket_name: type: string bucket_region: type: string user_id: type: string user_secret: type: string required: - bucket_name - bucket_region - user_id - user_secret - type: object properties: root: type: string required: - root required: - name - platform_storage - platform_config - edge_storage - edge_config /api/v/1/code/{systemKey}/createTableItems?id=measurementProfiles.create: post: tags: - Measurement Profiles description: Create measurement profiles parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - measurementProfiles.create body: type: object properties: item: type: object properties: id: type: string name: type: string units: type: array items: type: object properties: id: type: string name: type: string abbreviation: type: string conversionFormula: anyOf: - type: object properties: type: type: string enum: - constant value: anyOf: - type: number - type: string - type: boolean - type: array items: nullable: true required: - type - value - type: object properties: type: type: string enum: - variable path: type: array items: type: string params: type: object properties: {} required: - type - path - type: object properties: type: type: string enum: - arithmeticOperation operator: anyOf: - type: string enum: - + - type: string enum: - "-" - type: string enum: - "*" - type: string enum: - / - type: string enum: - "%" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - comparisonOperation operator: anyOf: - type: string enum: - ">" - type: string enum: - < - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - == - type: string enum: - "!=" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - logicalOperation operator: anyOf: - type: string enum: - AND - type: string enum: - OR - type: string enum: - NOT operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - if operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - switch operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - concat operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - split operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - sum operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - average operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - max operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - min operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - map operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - filter operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - reduce operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - length operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - contains operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - indexOf operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - concat operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mean operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - median operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mode operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - standardDeviation operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - variance operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - percentile operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object nullable: true enum: - null - nullable: true reverseFormula: anyOf: - type: object properties: type: type: string enum: - constant value: anyOf: - type: number - type: string - type: boolean - type: array items: nullable: true required: - type - value - type: object properties: type: type: string enum: - variable path: type: array items: type: string params: type: object properties: {} required: - type - path - type: object properties: type: type: string enum: - arithmeticOperation operator: anyOf: - type: string enum: - + - type: string enum: - "-" - type: string enum: - "*" - type: string enum: - / - type: string enum: - "%" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - comparisonOperation operator: anyOf: - type: string enum: - ">" - type: string enum: - < - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - == - type: string enum: - "!=" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - logicalOperation operator: anyOf: - type: string enum: - AND - type: string enum: - OR - type: string enum: - NOT operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - if operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - switch operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - concat operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - split operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - sum operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - average operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - max operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - min operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - map operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - filter operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - reduce operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - length operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - contains operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - indexOf operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - concat operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mean operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - median operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mode operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - standardDeviation operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - variance operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - percentile operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object nullable: true enum: - null - nullable: true groupIds: type: array items: type: string isDefault: type: boolean decimals: type: number required: - id - name - abbreviation - conversionFormula - groupIds - isDefault - decimals sourceUnit: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true sourceUnitAbbreviation: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - id - name - units required: - item required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: id: type: string name: type: string units: type: array items: type: object properties: id: type: string name: type: string abbreviation: type: string conversionFormula: anyOf: - type: object properties: type: type: string enum: - constant value: anyOf: - type: number - type: string - type: boolean - type: array items: nullable: true required: - type - value - type: object properties: type: type: string enum: - variable path: type: array items: type: string params: type: object properties: {} required: - type - path - type: object properties: type: type: string enum: - arithmeticOperation operator: anyOf: - type: string enum: - + - type: string enum: - "-" - type: string enum: - "*" - type: string enum: - / - type: string enum: - "%" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - comparisonOperation operator: anyOf: - type: string enum: - ">" - type: string enum: - < - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - == - type: string enum: - "!=" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - logicalOperation operator: anyOf: - type: string enum: - AND - type: string enum: - OR - type: string enum: - NOT operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - if operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - switch operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - concat operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - split operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - sum operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - average operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - max operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - min operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - map operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - filter operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - reduce operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - length operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - contains operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - indexOf operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - concat operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mean operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - median operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mode operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - standardDeviation operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - variance operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - percentile operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object nullable: true enum: - null - nullable: true reverseFormula: anyOf: - type: object properties: type: type: string enum: - constant value: anyOf: - type: number - type: string - type: boolean - type: array items: nullable: true required: - type - value - type: object properties: type: type: string enum: - variable path: type: array items: type: string params: type: object properties: {} required: - type - path - type: object properties: type: type: string enum: - arithmeticOperation operator: anyOf: - type: string enum: - + - type: string enum: - "-" - type: string enum: - "*" - type: string enum: - / - type: string enum: - "%" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - comparisonOperation operator: anyOf: - type: string enum: - ">" - type: string enum: - < - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - == - type: string enum: - "!=" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - logicalOperation operator: anyOf: - type: string enum: - AND - type: string enum: - OR - type: string enum: - NOT operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - if operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - switch operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - concat operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - split operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - sum operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - average operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - max operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - min operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - map operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - filter operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - reduce operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - length operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - contains operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - indexOf operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - concat operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mean operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - median operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mode operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - standardDeviation operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - variance operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - percentile operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object nullable: true enum: - null - nullable: true groupIds: type: array items: type: string isDefault: type: boolean decimals: type: number required: - id - name - abbreviation - conversionFormula - groupIds - isDefault - decimals sourceUnit: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true sourceUnitAbbreviation: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - id - name - units /api/v/1/code/{systemKey}/updateTableItems?id=adapterConfig.update: post: tags: - Adapter Config description: Update adapter configs parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - adapterConfig.update body: allOf: - type: object properties: adapter_name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true edge_name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - adapter_name - edge_name - type: object properties: topic_root: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true edge_name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true adapter_settings: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true adapter_name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true adapter_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - topic_root - edge_name - adapter_settings - adapter_name - adapter_type - item_id required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/updateTableItems?id=actionTypes.update: post: tags: - Action Types description: Update action types and their groups parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - actionTypes.update body: type: object properties: item: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true schema: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - id - label - schema - item_id groupIds: type: array items: type: string required: - item - groupIds required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/updateTableItems?id=actions.update: post: tags: - Actions description: Update actions parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - actions.update body: allOf: - type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - id - type: object properties: name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true config: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true is_centralized: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true notification_settings: anyOf: - type: object properties: enabled_formula: anyOf: - type: object properties: enabled: type: boolean enum: - true value: anyOf: - type: object properties: type: type: string enum: - constant value: anyOf: - type: number - type: string - type: boolean - type: array items: nullable: true required: - type - value - type: object properties: type: type: string enum: - variable path: type: array items: type: string params: type: object properties: {} required: - type - path - type: object properties: type: type: string enum: - arithmeticOperation operator: anyOf: - type: string enum: - + - type: string enum: - "-" - type: string enum: - "*" - type: string enum: - / - type: string enum: - "%" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - comparisonOperation operator: anyOf: - type: string enum: - ">" - type: string enum: - < - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - == - type: string enum: - "!=" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - logicalOperation operator: anyOf: - type: string enum: - AND - type: string enum: - OR - type: string enum: - NOT operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - if operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - switch operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - concat operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - split operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - sum operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - average operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - max operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - min operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - map operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - filter operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - reduce operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - length operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - contains operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - indexOf operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - concat operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mean operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - median operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mode operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - standardDeviation operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - variance operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - percentile operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object nullable: true enum: - null - nullable: true required: - enabled - value - type: object properties: enabled: type: boolean enum: - false value: type: undefined enum: - null required: - enabled grace_period: anyOf: - type: object properties: enabled: type: boolean enum: - true value: type: object properties: amount: type: number units: anyOf: - type: string enum: - SECOND - type: string enum: - MINUTE - type: string enum: - HOUR - type: string enum: - DAY - type: string enum: - WEEK - type: string enum: - MONTH - type: string enum: - YEAR required: - amount - units required: - enabled - value - type: object properties: enabled: type: boolean enum: - false value: type: undefined enum: - null required: - enabled recipient_formula: anyOf: - type: object properties: enabled: type: boolean enum: - true value: anyOf: - type: object properties: type: type: string enum: - constant value: anyOf: - type: number - type: string - type: boolean - type: array items: nullable: true required: - type - value - type: object properties: type: type: string enum: - variable path: type: array items: type: string params: type: object properties: {} required: - type - path - type: object properties: type: type: string enum: - arithmeticOperation operator: anyOf: - type: string enum: - + - type: string enum: - "-" - type: string enum: - "*" - type: string enum: - / - type: string enum: - "%" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - comparisonOperation operator: anyOf: - type: string enum: - ">" - type: string enum: - < - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - == - type: string enum: - "!=" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - logicalOperation operator: anyOf: - type: string enum: - AND - type: string enum: - OR - type: string enum: - NOT operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - if operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - switch operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - concat operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - split operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - sum operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - average operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - max operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - min operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - map operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - filter operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - reduce operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - length operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - contains operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - indexOf operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - concat operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mean operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - median operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mode operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - standardDeviation operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - variance operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - percentile operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object nullable: true enum: - null - nullable: true required: - enabled - value - type: object properties: enabled: type: boolean enum: - false value: type: undefined enum: - null required: - enabled - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - name - config - type - id - is_centralized - notification_settings - item_id required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/updateTableItems?id=assetTypes.update: post: tags: - Asset Types description: Update asset types and their groups parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assetTypes.update body: type: object properties: item: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true icon: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true schema: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true controls_schema: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true device_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true parent_child_options: anyOf: - type: object properties: propagate_location_to_root: type: boolean store_updates_on_root: type: boolean show_location_on_map: type: boolean - type: object nullable: true enum: - null - nullable: true icon_svg: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true default_history_view: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true hide_attribute_if_undefined: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true categories: anyOf: - type: array items: type: object properties: id: type: string label: type: string settings: anyOf: - type: object properties: collapsed: type: boolean layout: type: string enum: - list required: - collapsed - type: object properties: collapsed: type: boolean layout: type: string enum: - grid widget_size: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 required: - collapsed - layout - widget_size attributes: type: array items: type: string controls: type: array items: type: string required: - id - label - settings - attributes - controls - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true reporting_interval: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true attributes_reporting_intervals: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: number - type: object nullable: true enum: - null - nullable: true entity_type: anyOf: - type: string enum: - asset - type: string enum: - area - type: object nullable: true enum: - null - nullable: true asset_tabs: anyOf: - type: array items: anyOf: - type: object properties: type: type: string enum: - core id: anyOf: - type: string enum: - data - type: string enum: - history - type: string enum: - controls - type: string enum: - logs - type: string enum: - events - type: string enum: - comments - type: string enum: - images label: type: string hidden: type: boolean required: - type - id - label - type: object properties: type: type: string enum: - mfe id: type: string label: type: string mfe_id: type: string hidden: type: boolean required: - type - id - label - mfe_id - type: object nullable: true enum: - null - type: object nullable: true enum: - null - nullable: true summary: anyOf: - type: array items: anyOf: - allOf: - type: object properties: type: type: string enum: - image required: - type - type: object properties: visible: type: boolean required: - visible - allOf: - type: object properties: type: type: string enum: - profile items: type: array items: anyOf: - type: object properties: type: anyOf: - type: string enum: - name - type: string enum: - id - type: string enum: - type - type: string enum: - customId1 - type: string enum: - customId2 - type: string enum: - reportingStatus - type: string enum: - lastUpdated - type: string enum: - groups - type: string enum: - owners - type: string enum: - tags - type: string enum: - entityType - type: string enum: - deviceType - type: string enum: - description visible: type: boolean required: - type - visible - type: object properties: type: type: string enum: - attribute attributeId: type: string visible: type: boolean required: - type - attributeId - visible required: - type - items - type: object properties: visible: type: boolean required: - visible - allOf: - type: object properties: type: type: string enum: - eventsPanel required: - type - type: object properties: visible: type: boolean required: - visible - allOf: - type: object properties: type: type: string enum: - tree required: - type - type: object properties: visible: type: boolean required: - visible - allOf: - type: object properties: type: type: string enum: - location items: type: array items: type: object properties: type: anyOf: - type: string enum: - map - type: string enum: - lastUpdated - type: string enum: - floorLevel visible: type: boolean required: - type - visible required: - type - items - type: object properties: visible: type: boolean required: - visible - type: object nullable: true enum: - null - nullable: true modal_configuration: anyOf: - type: object properties: fields: type: array items: anyOf: - allOf: - type: object properties: type: type: string enum: - default_column column: anyOf: - type: string enum: - id - type: string enum: - owners - type: string enum: - latitude - type: string enum: - longitude - type: string enum: - type - type: string enum: - label - type: string enum: - description - type: string enum: - image - type: string enum: - last_updated - type: string enum: - location_updated - type: string enum: - custom_data - type: string enum: - attributes_last_updated - type: string enum: - parent - type: string enum: - location_x - type: string enum: - location_y - type: string enum: - location_z - type: string enum: - location_type - type: string enum: - location_unit - type: string enum: - custom_id_1 - type: string enum: - custom_id_2 - type: string enum: - last_location_updated - type: string enum: - group_id - type: string enum: - tree_id - type: string enum: - is_root - type: string enum: - floor_levels - type: string enum: - attributes_labels - type: string enum: - is_reporting - type: string enum: - attributes_is_reporting - type: string enum: - tags - type: string enum: - attributes_errors - type: string enum: - polygon - type: string enum: - is_archived - type: string enum: - image_id - type: string enum: - address - type: string enum: - groups - type: string enum: - children required: - type - column - type: object properties: required: type: boolean cols: type: object properties: xs: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto sm: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto md: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto lg: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto xl: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto required: - xs - sm - md - lg - xl - allOf: - type: object properties: type: type: string enum: - attribute attributeId: type: string required: - type - attributeId - type: object properties: required: type: boolean cols: type: object properties: xs: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto sm: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto md: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto lg: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto xl: anyOf: - type: number enum: - 1 - type: number enum: - 2 - type: number enum: - 3 - type: number enum: - 4 - type: number enum: - 5 - type: number enum: - 6 - type: number enum: - 7 - type: number enum: - 8 - type: number enum: - 9 - type: number enum: - 10 - type: number enum: - 11 - type: number enum: - 12 - type: string enum: - auto required: - xs - sm - md - lg - xl mapConfig: type: object properties: show: type: boolean required: - show version: type: number required: - fields - mapConfig - version - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - id - label - description - icon - schema - controls_schema - device_type - parent_child_options - icon_svg - default_history_view - hide_attribute_if_undefined - categories - entity_type - asset_tabs - item_id groupIds: type: array items: type: string required: - item - groupIds required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/updateTableItems?id=eventTypes.update: post: tags: - Event Types description: Update event types and their groups parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - eventTypes.update body: type: object properties: item: type: object properties: id: type: string label: type: string severity: type: number priority: type: number action_types: type: array items: type: string description: type: string has_lifecycle: type: boolean exclude_asset_trees: type: boolean open_states: type: array items: type: string closed_states: type: array items: type: string open_states_arr: type: array items: type: string closed_states_arr: type: array items: type: string attributes: anyOf: - type: array items: type: object properties: attribute_name: type: string attribute_label: type: string attribute_type: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - boolean - type: string enum: - dateTime required: - attribute_name - attribute_label - attribute_type - type: object nullable: true enum: - null - nullable: true required: - id - label - severity - priority groupIds: type: array items: type: string required: - item - groupIds required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/updateTableItems?id=events.update: post: tags: - Events description: Update events parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - events.update body: type: object properties: event: allOf: - type: object properties: created_at: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true is_open: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true severity: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true state: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true priority: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true action_ids: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true rule_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true assets: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true event_attributes: anyOf: - type: object additionalProperties: anyOf: - type: string - type: number - type: boolean - type: object nullable: true enum: - null - nullable: true attributes_errors: type: object additionalProperties: anyOf: - type: string - type: number - type: boolean item_id: type: string required: - created_at - last_updated - is_open - label - severity - id - description - type - state - priority - action_ids - rule_id - assets - item_id - type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - id eventHistory: type: object properties: event_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true timestamp: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true transition_attribute: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true transition_value: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true updated_by: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true assets: anyOf: - type: object additionalProperties: type: object properties: last_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_location_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - last_updated - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - event_id - timestamp - transition_attribute - transition_value - updated_by - assets - item_id required: - event - eventHistory required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/updateTableItems?id=eventsBulk.update: post: tags: - Events description: Apply a change to multiple events at once parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - eventsBulk.update body: type: object properties: eventsQuery: type: object properties: page: type: object properties: pageSize: type: number pageNumber: type: number searchText: type: string filters: type: object properties: ids: type: array items: type: string types: type: array items: type: string groupIds: type: array items: type: string ancestorGroupIds: type: object properties: ids: type: array items: type: string required: - ids assetIds: type: array items: type: string assetTypes: type: array items: type: string is_open: type: boolean labels: type: array items: type: string lastUpdated: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate createdAt: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate rule_types: type: array items: type: string rules: type: array items: type: string severity: type: array items: type: number priority: type: array items: type: number states: type: object properties: exclude: type: boolean values: type: array items: type: string required: - values descendantAssetIds: type: array items: type: object properties: ids: type: array items: type: string generationsBelow: type: number required: - ids - generationsBelow ancestorAssetIds: type: array items: type: object properties: ids: type: array items: type: string generationsAbove: type: number required: - ids - generationsAbove ancestorAssetTypes: type: array items: type: object properties: types: type: array items: type: string generationsAbove: type: number required: - types - generationsAbove eventAttributes: type: array items: anyOf: - type: object properties: filterType: type: string enum: - number attribute_name: type: string operator: type: string enum: - between value: type: array items: type: number minItems: 2 maxItems: 2 required: - filterType - attribute_name - operator - value - type: object properties: filterType: type: string enum: - number attribute_name: type: string operator: type: string enum: - notBetween value: type: array items: type: number minItems: 2 maxItems: 2 required: - filterType - attribute_name - operator - value - type: object properties: filterType: type: string enum: - number attribute_name: type: string operator: anyOf: - type: string enum: - IS - type: string enum: - = - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - ">" - type: string enum: - < - type: string enum: - "!=" value: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - operator - value - type: object properties: filterType: type: string enum: - boolean attribute_name: type: string value: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - value - type: object properties: filterType: type: string enum: - dateTime attribute_name: type: string value: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - value - type: object properties: filterType: type: string enum: - text attribute_name: type: string operator: anyOf: - type: string enum: - contains - type: string enum: - notContains - type: string enum: - equals - type: string enum: - notEquals value: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - filterType - attribute_name - operator - value ancestorSort: type: array items: type: object properties: field: anyOf: - type: string enum: - label - type: string enum: - asset_type.label generationsAbove: type: number direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - generationsAbove - direction sort: type: array items: type: object properties: field: anyOf: - type: string enum: - id - type: string enum: - label - type: string enum: - description - type: string enum: - type - type: string enum: - state - type: string enum: - severity - type: string enum: - priority - type: string enum: - created_at - type: string enum: - last_updated - type: string enum: - is_open - type: string enum: - action_ids - type: string enum: - rule.id - type: string enum: - rule.label - type: string enum: - event_type.id - type: string enum: - event_type.label - type: string enum: - assets - type: string enum: - assets.label - type: string enum: - assets.type.label direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC required: - field - direction eventAttributesSort: type: array items: type: object properties: field: type: string direction: anyOf: - type: string enum: - ASC - type: string enum: - DESC columnType: anyOf: - type: string enum: - string - type: string enum: - int - type: string enum: - bool - type: string enum: - timestamp - type: string enum: - float - type: string enum: - bigint - type: string enum: - double - type: string enum: - blob - type: string enum: - uuid - type: string enum: - array - type: string enum: - object - type: string enum: - currency - type: string enum: - plotline - type: string enum: - text - type: string enum: - number - type: string enum: - boolean - type: string enum: - dateTime required: - field - direction - columnType columns: type: array items: type: string updates: type: array items: type: object properties: eventType: type: string transitionTo: type: object properties: isOpen: type: boolean state: type: string required: - isOpen - state required: - eventType - transitionTo required: - updates required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/updateTableItems?id=ruleTypes.update: post: tags: - Rule Types description: Update rule types and their groups parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - ruleTypes.update body: type: object properties: item: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true event_type_ids: anyOf: - type: array items: type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - id - label - event_type_ids - item_id groupIds: type: array items: type: string required: - item - groupIds required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/updateTableItems?id=rules.update: post: tags: - Rules description: Update rules parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - rules.update body: nullable: true required: - name responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/updateTableItems?id=dashboardsv2.update: post: tags: - Dashboards description: Update dashboards and their groups parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - dashboardsv2.update body: type: object properties: item: type: object properties: id: type: string version: type: string enum: - 1.0.0 label: type: string last_updated: type: string last_updated_by: type: string pages: type: array items: type: object properties: version: type: string enum: - 1.0.0 id: type: string header: type: string controlLayouts: nullable: true mainLayouts: nullable: true widgets: type: array items: type: object properties: id: type: string description: type: string header: type: string visualization: type: object properties: type: type: string purpose: anyOf: - type: string enum: - TIME - type: string enum: - ITEM - type: string enum: - TABULAR - type: string enum: - CONTROL - type: string enum: - INDICATOR - type: string enum: - PERCENTAGE - type: string enum: - IMAGE required: - type - purpose version: type: string queries: nullable: true settings: nullable: true required: - id - description - header - visualization - version required: - version - id - header - widgets description: type: string microfrontend_id: type: string defaults: type: object properties: time_range: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate refresh_rate: type: object properties: count: type: number units: anyOf: - type: number enum: - 1 - type: number enum: - 60 - type: number enum: - 3600 - type: number enum: - 86400 - type: number enum: - 604800 - type: number enum: - 2592000 - type: number enum: - 31104000 required: - count - units required: - id updatedGroups: type: object properties: add: type: array items: type: string remove: type: array items: type: string required: - add - remove required: - item - updatedGroups required: - name - body responses: "200": description: Success content: application/json: schema: allOf: - type: object properties: id: type: string required: - id - type: object properties: version: type: string enum: - 1.0.0 label: type: string last_updated: type: string last_updated_by: type: string pages: type: array items: type: object properties: version: type: string enum: - 1.0.0 id: type: string header: type: string controlLayouts: nullable: true mainLayouts: nullable: true widgets: type: array items: type: object properties: id: type: string description: type: string header: type: string visualization: type: object properties: type: type: string purpose: anyOf: - type: string enum: - TIME - type: string enum: - ITEM - type: string enum: - TABULAR - type: string enum: - CONTROL - type: string enum: - INDICATOR - type: string enum: - PERCENTAGE - type: string enum: - IMAGE required: - type - purpose version: type: string queries: nullable: true settings: nullable: true required: - id - description - header - visualization - version required: - version - id - header - widgets description: type: string microfrontend_id: type: string defaults: type: object properties: time_range: anyOf: - type: object properties: type: type: string enum: - relative count: type: number units: type: number required: - type - count - units - type: object properties: type: type: string enum: - absolute startDate: type: string endDate: type: string displayTimezone: type: object properties: tz: type: string source: anyOf: - type: string enum: - asset - type: string enum: - systemSetting - type: string enum: - userGroups - type: string enum: - browser - type: string enum: - TZPicker required: - tz - source required: - type - startDate - endDate refresh_rate: type: object properties: count: type: number units: anyOf: - type: number enum: - 1 - type: number enum: - 60 - type: number enum: - 3600 - type: number enum: - 86400 - type: number enum: - 604800 - type: number enum: - 2592000 - type: number enum: - 31104000 required: - count - units groups: type: array items: type: object properties: id: type: string name: type: string required: - id - name required: - version - label - last_updated - last_updated_by - pages - groups /api/v/1/code/{systemKey}/updateTableItems?id=assetsv3.update: post: tags: - Assets description: Update assets and their groups with new request and response types parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assetsv3.update body: type: object properties: item: type: object properties: id: type: string custom_id_1: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_id_2: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true latitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true longitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true last_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_location_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_x: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_y: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_z: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_unit: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true floor_levels: anyOf: - type: array items: type: number - type: object nullable: true enum: - null - nullable: true image: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true owners: type: array items: type: string custom_data: type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: number - type: boolean - type: object nullable: true enum: - null - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: string - type: number - type: boolean - nullable: true attributes_last_updated: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: object nullable: true enum: - null - nullable: true attributes_labels: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: string - type: object nullable: true enum: - null - nullable: true parent: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true is_root: type: boolean type: type: string tags: type: array items: type: string tree_id: type: string attributes_errors: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: object properties: message: type: string timestamp: type: string required: - message - timestamp - type: object nullable: true enum: - null - nullable: true ever_had_closed_event: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true is_archived: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true image_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true address: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true polygon: anyOf: - type: object properties: geometry_type: type: string enum: - gps polygon: anyOf: - type: array items: type: object properties: long: type: number lat: type: number required: - long - lat - type: object nullable: true enum: - null - nullable: true required: - geometry_type - type: object properties: geometry_type: type: string enum: - indoor_area polygon: anyOf: - type: array items: type: object properties: x: type: number y: type: number z: type: number required: - x - y - z - type: object nullable: true enum: - null - nullable: true required: - geometry_type - type: object properties: geometry_type: type: string enum: - indoor_model required: - geometry_type - type: object properties: geometry_type: type: string enum: - geojson features: type: array items: type: object properties: type: type: string enum: - Feature properties: type: object properties: {} geometry: anyOf: - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number required: - type - coordinates - type: object properties: type: type: string enum: - MultiPolygon coordinates: type: array items: type: array items: type: array items: type: array items: type: number required: - type - coordinates required: - type - properties - geometry required: - geometry_type - features - type: object nullable: true enum: - null - nullable: true required: - id updatedGroups: type: object properties: add: type: array items: type: string remove: type: array items: type: string required: - add - remove required: - item - updatedGroups required: - name - body responses: "200": description: Success content: application/json: schema: allOf: - type: object properties: id: type: string required: - id - type: object properties: custom_id_1: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_id_2: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true latitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true longitude: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true last_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_location_updated: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_x: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_y: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_z: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true location_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location_unit: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true floor_levels: anyOf: - type: array items: type: number - type: object nullable: true enum: - null - nullable: true image: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true owners: type: array items: type: string custom_data: type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: number - type: boolean - type: object nullable: true enum: - null - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: string - type: number - type: boolean - nullable: true attributes_is_reporting: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: boolean - type: object nullable: true enum: - null - nullable: true attributes_last_updated: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: object nullable: true enum: - null - nullable: true attributes_labels: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: string - type: string - type: object nullable: true enum: - null - nullable: true ever_had_closed_event: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true attributes_errors: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: object properties: message: type: string timestamp: type: string required: - message - timestamp - type: object nullable: true enum: - null - nullable: true parent: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true is_root: type: boolean is_reporting: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true groups: type: array items: type: object properties: id: type: string name: type: string timezone: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - id - name - timezone tags: type: array items: type: string asset_type: type: object properties: id: type: string label: type: string entity_type: type: string tree: type: object properties: id: type: string data: type: object properties: rootID: type: string treeID: type: string nodes: type: object additionalProperties: type: object properties: id: type: string parentID: type: string children: type: array items: type: string required: - id - parentID - children required: - rootID - treeID - nodes openEvents: type: object properties: data: type: array items: type: object properties: id: type: string label: type: string severity: type: number priority: type: number rule: type: object properties: id: type: string label: type: string required: - id - label event_type: type: object properties: id: type: string label: type: string required: - id - label created_at: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_updated: type: string required: - id - label - severity - priority - rule - event_type - created_at - last_updated count: type: number open_events_with_descendants: type: object properties: count: type: number severities: type: array items: type: object properties: value: type: number count: type: number required: - value - count event_types: type: array items: type: object properties: id: type: string count: type: number required: - id - count polygon: anyOf: - type: object nullable: true enum: - null - type: object properties: geometry_type: type: string enum: - gps polygon: anyOf: - type: array items: type: object properties: long: type: number lat: type: number required: - long - lat - type: object nullable: true enum: - null - nullable: true required: - geometry_type - type: object properties: geometry_type: type: string enum: - indoor_area polygon: anyOf: - type: array items: type: object properties: x: type: number y: type: number z: type: number required: - x - y - z - type: object nullable: true enum: - null - nullable: true required: - geometry_type - type: object properties: geometry_type: type: string enum: - indoor_model required: - geometry_type - type: object properties: geometry_type: type: string enum: - geojson features: type: array items: type: object properties: type: type: string enum: - Feature properties: type: object properties: {} geometry: anyOf: - type: object properties: type: type: string enum: - Polygon coordinates: type: array items: type: array items: type: array items: type: number required: - type - coordinates - type: object properties: type: type: string enum: - MultiPolygon coordinates: type: array items: type: array items: type: array items: type: array items: type: number required: - type - coordinates required: - type - properties - geometry required: - geometry_type - features - nullable: true is_archived: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true image_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true address: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - custom_id_1 - custom_id_2 - label - description - latitude - longitude - last_updated - location_updated - last_location_updated - location_x - location_y - location_z - location_type - location_unit - floor_levels - image - owners - custom_data - attributes_is_reporting - attributes_last_updated - attributes_labels - ever_had_closed_event - attributes_errors - parent - is_root - is_reporting - groups - tags - asset_type - tree - openEvents - is_archived - image_id /api/v/1/code/{systemKey}/updateTableItems?id=assetChildren.update: post: tags: - Asset Tree description: Add and remove children of an asset parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assetChildren.update body: type: object properties: children: type: array items: type: string parentID: type: string required: - children - parentID required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/updateTableItems?id=assetChild.update: post: tags: - Asset Tree description: Move a child of an asset parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assetChild.update body: type: object properties: childID: type: string parentID: type: string rootID: type: string required: - childID - parentID - rootID required: - name - body responses: "200": description: Success content: application/json: schema: type: string /api/v/1/code/{systemKey}/updateTableItems?id=microfrontends.update: post: tags: - Microfrontends description: Update microfrontends and their groups parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - microfrontends.update body: anyOf: - allOf: - type: object properties: id: type: string url: type: string url_location: anyOf: - type: object nullable: true enum: - null - type: string enum: - files - nullable: true required: - id - url - type: object properties: type: type: string enum: - page config: anyOf: - type: object nullable: true enum: - null - type: undefined enum: - null - nullable: true required: - type - type: object properties: item_id: type: string required: - item_id - allOf: - type: object properties: id: type: string url: type: string url_location: anyOf: - type: object nullable: true enum: - null - type: string enum: - files - nullable: true required: - id - url - type: object properties: type: type: string enum: - attributeView config: anyOf: - type: object nullable: true enum: - null - type: object properties: label: type: string attributeType: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary required: - label - attributeType - nullable: true required: - type - config - type: object properties: item_id: type: string required: - item_id - allOf: - type: object properties: id: type: string url: type: string url_location: anyOf: - type: object nullable: true enum: - null - type: string enum: - files - nullable: true required: - id - url - type: object properties: type: type: string enum: - attributeEdit config: anyOf: - type: object nullable: true enum: - null - type: object properties: label: type: string attributeType: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary required: - label - attributeType - nullable: true required: - type - config - type: object properties: item_id: type: string required: - item_id - allOf: - type: object properties: id: type: string url: type: string url_location: anyOf: - type: object nullable: true enum: - null - type: string enum: - files - nullable: true required: - id - url - type: object properties: type: type: string enum: - dashboard config: anyOf: - type: object nullable: true enum: - null - type: undefined enum: - null - nullable: true required: - type - type: object properties: item_id: type: string required: - item_id - allOf: - type: object properties: id: type: string url: type: string url_location: anyOf: - type: object nullable: true enum: - null - type: string enum: - files - nullable: true required: - id - url - type: object properties: type: type: string enum: - assetTab config: anyOf: - type: object nullable: true enum: - null - type: undefined enum: - null - nullable: true required: - type - type: object properties: item_id: type: string required: - item_id required: - name - body responses: "200": description: Success content: application/json: schema: anyOf: - allOf: - type: object properties: id: type: string url: type: string url_location: anyOf: - type: object nullable: true enum: - null - type: string enum: - files - nullable: true required: - id - url - type: object properties: type: type: string enum: - page config: anyOf: - type: object nullable: true enum: - null - type: undefined enum: - null - nullable: true required: - type - type: object properties: item_id: type: string required: - item_id - allOf: - type: object properties: id: type: string url: type: string url_location: anyOf: - type: object nullable: true enum: - null - type: string enum: - files - nullable: true required: - id - url - type: object properties: type: type: string enum: - attributeView config: anyOf: - type: object nullable: true enum: - null - type: object properties: label: type: string attributeType: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary required: - label - attributeType - nullable: true required: - type - config - type: object properties: item_id: type: string required: - item_id - allOf: - type: object properties: id: type: string url: type: string url_location: anyOf: - type: object nullable: true enum: - null - type: string enum: - files - nullable: true required: - id - url - type: object properties: type: type: string enum: - attributeEdit config: anyOf: - type: object nullable: true enum: - null - type: object properties: label: type: string attributeType: anyOf: - type: string enum: - text - type: string enum: - number - type: string enum: - image - type: string enum: - color - type: string enum: - dateTime - type: string enum: - boolean - type: string enum: - url - type: string enum: - dictionary required: - label - attributeType - nullable: true required: - type - config - type: object properties: item_id: type: string required: - item_id - allOf: - type: object properties: id: type: string url: type: string url_location: anyOf: - type: object nullable: true enum: - null - type: string enum: - files - nullable: true required: - id - url - type: object properties: type: type: string enum: - dashboard config: anyOf: - type: object nullable: true enum: - null - type: undefined enum: - null - nullable: true required: - type - type: object properties: item_id: type: string required: - item_id - allOf: - type: object properties: id: type: string url: type: string url_location: anyOf: - type: object nullable: true enum: - null - type: string enum: - files - nullable: true required: - id - url - type: object properties: type: type: string enum: - assetTab config: anyOf: - type: object nullable: true enum: - null - type: undefined enum: - null - nullable: true required: - type - type: object properties: item_id: type: string required: - item_id /api/v/1/code/{systemKey}/updateTableItems?id=groups.update: post: tags: - Groups description: Update groups parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - groups.update body: allOf: - type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - id - type: object properties: map_location_latitude: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true map_location_longitude: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true map_bounds: anyOf: - type: array items: type: object properties: long: type: number lat: type: number required: - long - lat - type: object nullable: true enum: - null - nullable: true id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true map_zoom: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true map_zoom_float: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true tree_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true is_root: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true tree: type: object properties: id: type: string data: type: object properties: rootID: type: string treeID: type: string nodes: type: object additionalProperties: type: object properties: id: type: string parentID: type: string parents: type: array items: type: string children: type: array items: type: string required: - id - parentID - parents - children required: - rootID - treeID - nodes timezone: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true date_time_locale: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - map_location_latitude - map_location_longitude - map_bounds - id - map_zoom - map_zoom_float - name - tree_id - is_root - timezone - item_id required: - name - body responses: "200": description: Success content: application/json: schema: allOf: - type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - id - type: object properties: map_location_latitude: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true map_location_longitude: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true map_bounds: anyOf: - type: array items: type: object properties: long: type: number lat: type: number required: - long - lat - type: object nullable: true enum: - null - nullable: true id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true map_zoom: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true map_zoom_float: anyOf: - type: number - type: object nullable: true enum: - null - nullable: true name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true tree_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true is_root: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true tree: type: object properties: id: type: string data: type: object properties: rootID: type: string treeID: type: string nodes: type: object additionalProperties: type: object properties: id: type: string parentID: type: string parents: type: array items: type: string children: type: array items: type: string required: - id - parentID - parents - children required: - rootID - treeID - nodes timezone: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true date_time_locale: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - map_location_latitude - map_location_longitude - map_bounds - id - map_zoom - map_zoom_float - name - tree_id - is_root - timezone - item_id /api/v/1/code/{systemKey}/updateTableItems?id=groupChildren.update: post: tags: - Group Tree description: Update the children of a group parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - groupChildren.update body: allOf: - type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - id - type: object properties: children: type: array items: type: string required: - children required: - name - body responses: "200": description: Success content: application/json: schema: allOf: - type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - id - type: object properties: children: type: array items: type: string required: - children /api/v/1/code/{systemKey}/updateTableItems?id=roles.update: post: tags: - Roles description: Update custom roles and their groups parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - roles.update body: allOf: - type: object properties: customRole: nullable: true - type: object properties: updatedGroups: type: object properties: add: type: array items: type: string remove: type: array items: type: string required: - add - remove required: - updatedGroups required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: role: nullable: true group_ids: type: array items: type: string required: - group_ids /api/v/1/code/{systemKey}/updateTableItems?id=userRoleAssignments.update: post: tags: - Roles description: Update the roles assigned to a user parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - userRoleAssignments.update body: type: object properties: user_email: type: string add: type: array items: type: string remove: type: array items: type: string required: - user_email - add - remove required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/updateTableItems?id=customSettings.update: post: tags: - Custom Settings description: Update system-wide custom settings parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - customSettings.update body: type: object properties: id: type: string description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true config: type: string required: - id - config required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/updateTableItems?id=reports.update: post: tags: - Reports description: Update advanced reports parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - reports.update body: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true code_service_name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true group_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true schedules: anyOf: - type: array items: type: object properties: id: type: string label: type: string email_subject: type: string email_body: type: string email_recipients: type: array items: type: object properties: type: type: string enum: - email email: type: string required: - type - email report_time_range: type: object properties: type: type: string enum: - AMOUNT_OF_TIME value: type: object properties: amount: type: number units: anyOf: - type: string enum: - SECOND - type: string enum: - MINUTE - type: string enum: - HOUR - type: string enum: - DAY - type: string enum: - WEEK - type: string enum: - MONTH - type: string enum: - YEAR required: - amount - units required: - type - value start_date: type: string end_date: type: string repeat: anyOf: - type: object properties: type: type: string enum: - REPEAT_NONE value: type: object properties: amount: type: number units: anyOf: - type: string enum: - SECOND - type: string enum: - MINUTE - type: string enum: - HOUR - type: string enum: - DAY - type: string enum: - WEEK - type: string enum: - MONTH - type: string enum: - YEAR required: - amount - units required: - type - value - type: object properties: type: type: string enum: - AMOUNT_OF_TIME value: type: object properties: amount: type: number units: anyOf: - type: string enum: - SECOND - type: string enum: - MINUTE - type: string enum: - HOUR - type: string enum: - DAY - type: string enum: - WEEK - type: string enum: - MONTH - type: string enum: - YEAR required: - amount - units required: - type - value required: - id - label - email_subject - email_body - email_recipients - report_time_range - start_date - end_date - repeat - type: object nullable: true enum: - null - nullable: true type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true created_on: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true created_by: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - id - label - code_service_name - group_id - schedules - type - created_on - created_by - item_id required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/updateTableItems?id=heatmapReports.update: post: tags: - Heatmaps description: Update heatmap reports parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - heatmapReports.update body: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true label: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true group_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true asset_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true attribute_name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true location: anyOf: - type: object properties: type: type: string enum: - area ids: type: array items: type: string required: - type - ids - type: object properties: type: type: string enum: - bounds bounds: type: array items: type: number minItems: 4 maxItems: 4 required: - type - bounds - type: object nullable: true enum: - null - nullable: true analysis: anyOf: - type: object properties: type: type: string enum: - numerical analysis: type: object properties: statistic: anyOf: - type: string enum: - MIN - type: string enum: - MAX - type: string enum: - AVG range: anyOf: - type: object properties: enabled: type: boolean enum: - true minMax: type: array items: type: number minItems: 2 maxItems: 2 required: - enabled - minMax - type: object properties: enabled: type: boolean enum: - false required: - enabled required: - statistic - range required: - type - analysis - type: object nullable: true enum: - null - nullable: true date_range: anyOf: - type: object properties: startDate: type: string endDate: type: string rangeSelection: anyOf: - type: number enum: - 1 - type: number enum: - 7 - type: number enum: - 30 - type: number enum: - 90 - type: number enum: - 180 - type: number enum: - 0 - type: number enum: - -1 required: - startDate - endDate - rangeSelection - type: object nullable: true enum: - null - nullable: true created_on: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true created_by: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - id - label - group_id - asset_type - attribute_name - location - analysis - date_range - created_on - created_by - item_id required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/updateTableItems?id=assetImageHistory.update: post: tags: - Asset Images description: Update asset image history parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assetImageHistory.update body: allOf: - type: object properties: image_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - image_id - type: object properties: asset_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true upload_datetime: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true image_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_modified: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - asset_id - upload_datetime - image_id - last_modified - name - item_id required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: asset_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true upload_datetime: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true image_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_modified: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - asset_id - upload_datetime - image_id - last_modified - name - item_id /api/v/1/code/{systemKey}/updateTableItems?id=assetComments.update: post: tags: - Asset Comments description: Update asset comment parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assetComments.update body: nullable: true required: - name responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/updateTableItems?id=components.update: post: tags: - Components description: Update components parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - components.update body: type: object properties: item: type: object properties: id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true entity_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true settings: anyOf: - type: object additionalProperties: nullable: true - type: object nullable: true enum: - null - nullable: true required: - id - entity_id - settings required: - item required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/updateTableItems?id=navPages.update: post: tags: - Nav Pages description: Update nav pages parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - navPages.update body: type: object properties: data: type: object properties: general: type: array items: type: object properties: id: type: string label: type: string icon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey type: anyOf: - type: string enum: - custom - type: string enum: - core visible: type: boolean config: anyOf: - type: object properties: type: type: string enum: - single content: allOf: - type: object properties: label: type: string icon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey required: - label - icon - anyOf: - type: object properties: type: anyOf: - type: string enum: - home - type: string enum: - assets - type: string enum: - rules - type: string enum: - events - type: string enum: - reports - type: string enum: - dashboards - type: string enum: - store - type: string enum: - actionTypes - type: string enum: - assetTypes - type: string enum: - eventTypes - type: string enum: - ruleTypes - type: string enum: - groups - type: string enum: - roles - type: string enum: - users - type: string enum: - billing - type: string enum: - deviceConfig - type: string enum: - audits required: - type - type: object properties: type: type: string enum: - mfe mfeId: type: string mfeUrlWhileEditing: type: string required: - type - mfeId - type: object properties: type: type: string enum: - dashboard dashboardId: type: string required: - type - dashboardId - type: object properties: type: type: string enum: - externalLink url: type: string required: - type - url required: - type - content - type: object properties: type: type: string enum: - multi layout: type: string enum: - dropdown content: type: array items: allOf: - type: object properties: label: type: string icon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey required: - label - icon - anyOf: - type: object properties: type: anyOf: - type: string enum: - home - type: string enum: - assets - type: string enum: - rules - type: string enum: - events - type: string enum: - reports - type: string enum: - dashboards - type: string enum: - store - type: string enum: - actionTypes - type: string enum: - assetTypes - type: string enum: - eventTypes - type: string enum: - ruleTypes - type: string enum: - groups - type: string enum: - roles - type: string enum: - users - type: string enum: - billing - type: string enum: - deviceConfig - type: string enum: - audits required: - type - type: object properties: type: type: string enum: - mfe mfeId: type: string mfeUrlWhileEditing: type: string required: - type - mfeId - type: object properties: type: type: string enum: - dashboard dashboardId: type: string required: - type - dashboardId - type: object properties: type: type: string enum: - externalLink url: type: string required: - type - url required: - type - layout - content permissionOverride: type: string required: - id - label - icon - type - visible - config admin: type: array items: type: object properties: id: type: string label: type: string icon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey type: anyOf: - type: string enum: - custom - type: string enum: - core visible: type: boolean config: anyOf: - type: object properties: type: type: string enum: - single content: allOf: - type: object properties: label: type: string icon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey required: - label - icon - anyOf: - type: object properties: type: anyOf: - type: string enum: - home - type: string enum: - assets - type: string enum: - rules - type: string enum: - events - type: string enum: - reports - type: string enum: - dashboards - type: string enum: - store - type: string enum: - actionTypes - type: string enum: - assetTypes - type: string enum: - eventTypes - type: string enum: - ruleTypes - type: string enum: - groups - type: string enum: - roles - type: string enum: - users - type: string enum: - billing - type: string enum: - deviceConfig - type: string enum: - audits required: - type - type: object properties: type: type: string enum: - mfe mfeId: type: string mfeUrlWhileEditing: type: string required: - type - mfeId - type: object properties: type: type: string enum: - dashboard dashboardId: type: string required: - type - dashboardId - type: object properties: type: type: string enum: - externalLink url: type: string required: - type - url required: - type - content - type: object properties: type: type: string enum: - multi layout: type: string enum: - dropdown content: type: array items: allOf: - type: object properties: label: type: string icon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey required: - label - icon - anyOf: - type: object properties: type: anyOf: - type: string enum: - home - type: string enum: - assets - type: string enum: - rules - type: string enum: - events - type: string enum: - reports - type: string enum: - dashboards - type: string enum: - store - type: string enum: - actionTypes - type: string enum: - assetTypes - type: string enum: - eventTypes - type: string enum: - ruleTypes - type: string enum: - groups - type: string enum: - roles - type: string enum: - users - type: string enum: - billing - type: string enum: - deviceConfig - type: string enum: - audits required: - type - type: object properties: type: type: string enum: - mfe mfeId: type: string mfeUrlWhileEditing: type: string required: - type - mfeId - type: object properties: type: type: string enum: - dashboard dashboardId: type: string required: - type - dashboardId - type: object properties: type: type: string enum: - externalLink url: type: string required: - type - url required: - type - layout - content permissionOverride: type: string required: - id - label - icon - type - visible - config required: - general - admin required: - data required: - name - body responses: "200": description: Success content: application/json: schema: anyOf: - type: object nullable: true enum: - null - type: object properties: general: type: array items: type: object properties: id: type: string label: type: string icon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey type: anyOf: - type: string enum: - custom - type: string enum: - core visible: type: boolean config: anyOf: - type: object properties: type: type: string enum: - single content: allOf: - type: object properties: label: type: string icon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey required: - label - icon - anyOf: - type: object properties: type: anyOf: - type: string enum: - home - type: string enum: - assets - type: string enum: - rules - type: string enum: - events - type: string enum: - reports - type: string enum: - dashboards - type: string enum: - store - type: string enum: - actionTypes - type: string enum: - assetTypes - type: string enum: - eventTypes - type: string enum: - ruleTypes - type: string enum: - groups - type: string enum: - roles - type: string enum: - users - type: string enum: - billing - type: string enum: - deviceConfig - type: string enum: - audits required: - type - type: object properties: type: type: string enum: - mfe mfeId: type: string mfeUrlWhileEditing: type: string required: - type - mfeId - type: object properties: type: type: string enum: - dashboard dashboardId: type: string required: - type - dashboardId - type: object properties: type: type: string enum: - externalLink url: type: string required: - type - url required: - type - content - type: object properties: type: type: string enum: - multi layout: type: string enum: - dropdown content: type: array items: allOf: - type: object properties: label: type: string icon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey required: - label - icon - anyOf: - type: object properties: type: anyOf: - type: string enum: - home - type: string enum: - assets - type: string enum: - rules - type: string enum: - events - type: string enum: - reports - type: string enum: - dashboards - type: string enum: - store - type: string enum: - actionTypes - type: string enum: - assetTypes - type: string enum: - eventTypes - type: string enum: - ruleTypes - type: string enum: - groups - type: string enum: - roles - type: string enum: - users - type: string enum: - billing - type: string enum: - deviceConfig - type: string enum: - audits required: - type - type: object properties: type: type: string enum: - mfe mfeId: type: string mfeUrlWhileEditing: type: string required: - type - mfeId - type: object properties: type: type: string enum: - dashboard dashboardId: type: string required: - type - dashboardId - type: object properties: type: type: string enum: - externalLink url: type: string required: - type - url required: - type - layout - content permissionOverride: type: string required: - id - label - icon - type - visible - config admin: type: array items: type: object properties: id: type: string label: type: string icon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey type: anyOf: - type: string enum: - custom - type: string enum: - core visible: type: boolean config: anyOf: - type: object properties: type: type: string enum: - single content: allOf: - type: object properties: label: type: string icon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey required: - label - icon - anyOf: - type: object properties: type: anyOf: - type: string enum: - home - type: string enum: - assets - type: string enum: - rules - type: string enum: - events - type: string enum: - reports - type: string enum: - dashboards - type: string enum: - store - type: string enum: - actionTypes - type: string enum: - assetTypes - type: string enum: - eventTypes - type: string enum: - ruleTypes - type: string enum: - groups - type: string enum: - roles - type: string enum: - users - type: string enum: - billing - type: string enum: - deviceConfig - type: string enum: - audits required: - type - type: object properties: type: type: string enum: - mfe mfeId: type: string mfeUrlWhileEditing: type: string required: - type - mfeId - type: object properties: type: type: string enum: - dashboard dashboardId: type: string required: - type - dashboardId - type: object properties: type: type: string enum: - externalLink url: type: string required: - type - url required: - type - content - type: object properties: type: type: string enum: - multi layout: type: string enum: - dropdown content: type: array items: allOf: - type: object properties: label: type: string icon: anyOf: - type: object properties: type: type: string enum: - mui iconKey: type: string required: - type - iconKey - type: object properties: type: type: string enum: - svg svg: type: string required: - type - svg - type: object properties: type: type: string enum: - customMui iconKey: type: string required: - type - iconKey required: - label - icon - anyOf: - type: object properties: type: anyOf: - type: string enum: - home - type: string enum: - assets - type: string enum: - rules - type: string enum: - events - type: string enum: - reports - type: string enum: - dashboards - type: string enum: - store - type: string enum: - actionTypes - type: string enum: - assetTypes - type: string enum: - eventTypes - type: string enum: - ruleTypes - type: string enum: - groups - type: string enum: - roles - type: string enum: - users - type: string enum: - billing - type: string enum: - deviceConfig - type: string enum: - audits required: - type - type: object properties: type: type: string enum: - mfe mfeId: type: string mfeUrlWhileEditing: type: string required: - type - mfeId - type: object properties: type: type: string enum: - dashboard dashboardId: type: string required: - type - dashboardId - type: object properties: type: type: string enum: - externalLink url: type: string required: - type - url required: - type - layout - content permissionOverride: type: string required: - id - label - icon - type - visible - config required: - general - admin - nullable: true /api/v/1/code/{systemKey}/updateTableItems?id=oidcSettings.update: post: tags: - OIDC Settings description: Update OIDC settings parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - oidcSettings.update body: type: object properties: provider_configs: type: array items: type: object properties: allow_auto_registration: type: boolean provider_name: type: string default_groups_for_new_users: type: array items: type: string role_claim_name: type: string role_mappings: type: array items: type: object properties: provider_role: type: string ia_role: type: string required: - provider_role - ia_role group_claim_name: type: string group_mappings: type: array items: type: object properties: provider_group: type: string ia_group: type: string required: - provider_group - ia_group required: - allow_auto_registration - provider_name - default_groups_for_new_users - role_claim_name - role_mappings - group_claim_name - group_mappings required: - provider_configs required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/updateTableItems?id=measurementProfiles.update: post: tags: - Measurement Profiles description: Update measurement profiles parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - measurementProfiles.update body: type: object properties: id: type: string name: type: string units: type: array items: type: object properties: id: type: string name: type: string abbreviation: type: string conversionFormula: anyOf: - type: object properties: type: type: string enum: - constant value: anyOf: - type: number - type: string - type: boolean - type: array items: nullable: true required: - type - value - type: object properties: type: type: string enum: - variable path: type: array items: type: string params: type: object properties: {} required: - type - path - type: object properties: type: type: string enum: - arithmeticOperation operator: anyOf: - type: string enum: - + - type: string enum: - "-" - type: string enum: - "*" - type: string enum: - / - type: string enum: - "%" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - comparisonOperation operator: anyOf: - type: string enum: - ">" - type: string enum: - < - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - == - type: string enum: - "!=" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - logicalOperation operator: anyOf: - type: string enum: - AND - type: string enum: - OR - type: string enum: - NOT operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - if operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - switch operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - concat operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - split operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - sum operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - average operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - max operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - min operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - map operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - filter operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - reduce operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - length operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - contains operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - indexOf operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - concat operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mean operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - median operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mode operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - standardDeviation operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - variance operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - percentile operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object nullable: true enum: - null - nullable: true reverseFormula: anyOf: - type: object properties: type: type: string enum: - constant value: anyOf: - type: number - type: string - type: boolean - type: array items: nullable: true required: - type - value - type: object properties: type: type: string enum: - variable path: type: array items: type: string params: type: object properties: {} required: - type - path - type: object properties: type: type: string enum: - arithmeticOperation operator: anyOf: - type: string enum: - + - type: string enum: - "-" - type: string enum: - "*" - type: string enum: - / - type: string enum: - "%" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - comparisonOperation operator: anyOf: - type: string enum: - ">" - type: string enum: - < - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - == - type: string enum: - "!=" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - logicalOperation operator: anyOf: - type: string enum: - AND - type: string enum: - OR - type: string enum: - NOT operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - if operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - switch operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - concat operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - split operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - sum operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - average operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - max operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - min operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - map operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - filter operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - reduce operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - length operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - contains operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - indexOf operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - concat operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mean operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - median operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mode operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - standardDeviation operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - variance operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - percentile operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object nullable: true enum: - null - nullable: true groupIds: type: array items: type: string isDefault: type: boolean decimals: type: number required: - id - name - abbreviation - conversionFormula - groupIds - isDefault - decimals sourceUnit: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true sourceUnitAbbreviation: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - id required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: id: type: string name: type: string units: type: array items: type: object properties: id: type: string name: type: string abbreviation: type: string conversionFormula: anyOf: - type: object properties: type: type: string enum: - constant value: anyOf: - type: number - type: string - type: boolean - type: array items: nullable: true required: - type - value - type: object properties: type: type: string enum: - variable path: type: array items: type: string params: type: object properties: {} required: - type - path - type: object properties: type: type: string enum: - arithmeticOperation operator: anyOf: - type: string enum: - + - type: string enum: - "-" - type: string enum: - "*" - type: string enum: - / - type: string enum: - "%" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - comparisonOperation operator: anyOf: - type: string enum: - ">" - type: string enum: - < - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - == - type: string enum: - "!=" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - logicalOperation operator: anyOf: - type: string enum: - AND - type: string enum: - OR - type: string enum: - NOT operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - if operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - switch operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - concat operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - split operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - sum operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - average operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - max operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - min operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - map operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - filter operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - reduce operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - length operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - contains operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - indexOf operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - concat operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mean operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - median operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mode operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - standardDeviation operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - variance operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - percentile operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object nullable: true enum: - null - nullable: true reverseFormula: anyOf: - type: object properties: type: type: string enum: - constant value: anyOf: - type: number - type: string - type: boolean - type: array items: nullable: true required: - type - value - type: object properties: type: type: string enum: - variable path: type: array items: type: string params: type: object properties: {} required: - type - path - type: object properties: type: type: string enum: - arithmeticOperation operator: anyOf: - type: string enum: - + - type: string enum: - "-" - type: string enum: - "*" - type: string enum: - / - type: string enum: - "%" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - comparisonOperation operator: anyOf: - type: string enum: - ">" - type: string enum: - < - type: string enum: - ">=" - type: string enum: - <= - type: string enum: - == - type: string enum: - "!=" operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - logicalOperation operator: anyOf: - type: string enum: - AND - type: string enum: - OR - type: string enum: - NOT operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - if operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - conditionalFunction operator: type: string enum: - switch operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - concat operands: type: array items: nullable: true required: - type - operator - operands - type: object properties: type: type: string enum: - stringFunction operator: type: string enum: - split operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - sum operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - average operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - max operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - aggregateFunction operator: type: string enum: - min operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - map operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - filter operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - reduce operands: type: array items: nullable: true minItems: 3 maxItems: 3 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - length operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - contains operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - indexOf operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - arrayFunction operator: type: string enum: - concat operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mean operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - median operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - mode operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - standardDeviation operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - variance operands: type: array items: nullable: true minItems: 1 maxItems: 1 required: - type - operator - operands - type: object properties: type: type: string enum: - statisticalFunction operator: type: string enum: - percentile operands: type: array items: nullable: true minItems: 2 maxItems: 2 required: - type - operator - operands - type: object nullable: true enum: - null - nullable: true groupIds: type: array items: type: string isDefault: type: boolean decimals: type: number required: - id - name - abbreviation - conversionFormula - groupIds - isDefault - decimals sourceUnit: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true sourceUnitAbbreviation: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true description: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - id /api/v/1/code/{systemKey}/updateTableItems?id=validateAssetTypeChange: post: tags: - Assets description: Validate that an asset type change is valid parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - validateAssetTypeChange body: type: object properties: assetId: type: string targetAssetTypeId: type: string required: - assetId - targetAssetTypeId required: - name - body responses: "200": description: Success content: application/json: schema: type: boolean /api/v/1/code/{systemKey}/deleteTableItems?id=adapterConfig.delete: post: tags: - Adapter Config description: Delete adapter configs parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - adapterConfig.delete body: type: object properties: adapter_name: type: string edge_name: type: string required: - adapter_name - edge_name required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/deleteTableItems?id=actions.delete: post: tags: - Actions description: Delete actions parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - actions.delete body: type: object properties: ids: type: array items: type: string required: - ids required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/deleteTableItems?id=actionTypes.delete: post: tags: - Action Types description: Delete action types parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - actionTypes.delete body: type: object properties: id: type: string required: - id required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/deleteTableItems?id=assetTypes.delete: post: tags: - Asset Types description: Delete asset types parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assetTypes.delete body: type: object properties: id: type: string required: - id required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/deleteTableItems?id=assetTypeInTree.delete: post: tags: - Asset Type Tree description: Delete asset type from tree parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assetTypeInTree.delete body: type: object properties: id: type: string required: - id required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/deleteTableItems?id=assetTypeChild.delete: post: tags: - Asset Type Tree description: Delete child from asset type tree parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assetTypeChild.delete body: type: object properties: childId: type: string parentId: type: string required: - childId - parentId required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/deleteTableItems?id=assets.delete: post: tags: - Assets description: Delete assets parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assets.delete body: type: object properties: id: type: string required: - id required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/deleteTableItems?id=assetComments.delete: post: tags: - Asset Comments description: Delete asset comments parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assetComments.delete body: type: object properties: item_id: type: string required: - item_id required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/deleteTableItems?id=regionalDeviceConfigs.delete: post: tags: - Device Config description: Delete regional device configurations parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - regionalDeviceConfigs.delete body: anyOf: - type: object properties: assetId: type: string required: - assetId - type: object properties: assetId: type: string maxVersion: type: number required: - assetId - maxVersion required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/deleteTableItems?id=deviceConfigs.delete: post: tags: - Device Config description: Delete a device configuration file parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - deviceConfigs.delete body: type: object properties: asset_id: type: string device_type: type: string maxVersion: type: number required: - asset_id - device_type required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/deleteTableItems?id=templateConfigs.delete: post: tags: - Device Config description: Delete a template configuration file parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - templateConfigs.delete body: type: object properties: id: type: string maxVersion: type: number required: - id required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/deleteTableItems?id=eventTypes.delete: post: tags: - Event Types description: Delete event types parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - eventTypes.delete body: type: object properties: id: type: string required: - id required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/deleteTableItems?id=ruleTypes.delete: post: tags: - Rule Types description: Delete rule types parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - ruleTypes.delete body: type: object properties: id: type: string required: - id required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/deleteTableItems?id=rules.delete: post: tags: - Rules description: Delete rules parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - rules.delete body: type: object properties: id: type: string required: - id required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/deleteTableItems?id=dashboards.delete: post: tags: - Dashboards description: Delete dashboards parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - dashboards.delete body: type: object properties: id: type: string required: - id required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/deleteTableItems?id=microfrontends.delete: post: tags: - Microfrontends description: Delete microfrontends parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - microfrontends.delete body: type: object properties: id: type: string required: - id required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/deleteTableItems?id=groups.delete: post: tags: - Groups description: Delete groups parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - groups.delete body: type: object properties: id: type: string required: - id required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/deleteTableItems?id=events.delete: post: tags: - Events description: Delete events parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - events.delete body: type: object properties: id: type: string required: - id required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/deleteTableItems?id=assetImageHistory.delete: post: tags: - Asset Images description: Delete asset image history parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assetImageHistory.delete body: type: object properties: image_ids: type: array items: type: string required: - image_ids required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/deleteTableItems?id=imagesInBucket.delete: post: tags: - Asset Images description: Delete images from a bucket parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - imagesInBucket.delete body: type: object properties: ids: type: array items: type: string required: - ids required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/deleteTableItems?id=roles.delete: post: tags: - Roles description: Delete custom roles parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - roles.delete body: type: object properties: id: type: string required: - id required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/deleteTableItems?id=tourItems.delete: post: tags: - Tour description: Delete tutorial items parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - tourItems.delete body: type: undefined enum: - null required: - name responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/deleteTableItems?id=customSettings.delete: post: tags: - Custom Settings description: Delete system-wide custom settings parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - customSettings.delete body: type: object properties: id: type: string required: - id required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/deleteTableItems?id=reports.delete: post: tags: - Reports description: Delete advanced reports parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - reports.delete body: type: object properties: id: type: string required: - id required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/deleteTableItems?id=heatmapReports.delete: post: tags: - Heatmaps description: Delete heatmap reports parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - heatmapReports.delete body: type: object properties: id: type: string required: - id required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/deleteTableItems?id=components.delete: post: tags: - Components description: Delete components parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - components.delete body: type: object properties: id: type: string entity_id: type: string required: - id - entity_id required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: id: type: string entity_id: type: string required: - id - entity_id /api/v/1/code/{systemKey}/deleteTableItems?id=bucketSets.delete: post: tags: - Bucket Sets description: Delete bucket sets parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - bucketSets.delete body: type: object properties: name: type: string required: - name required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/deleteTableItems?id=measurementProfiles.delete: post: tags: - Measurement Profiles description: Delete measurement profiles parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - measurementProfiles.delete body: type: object properties: id: type: string required: - id required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/executeUIQuery?id=executeUIQuery: post: tags: - Dashboards description: Retrieve data for dashboard widgets parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - executeUIQuery body: nullable: true required: - name responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: nullable: true COUNT: type: number required: - DATA - COUNT /api/v/1/code/{systemKey}/executeUIQuery?id=executeMetricPerEntityQuery: post: tags: - Dashboards description: Retrieve data for dashboard widgets where each entity corresponds to a distinct metric parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - executeMetricPerEntityQuery body: nullable: true required: - name responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: type: object properties: attribute_label: type: string attribute_name: type: string attribute_value: anyOf: - type: string - type: number - type: object nullable: true enum: - null - nullable: true attribute_type: type: string entity_id: type: string required: - attribute_label - attribute_name - attribute_value - attribute_type - entity_id required: - DATA /api/v/1/code/{systemKey}/fetchLogs?id=assetLogsById.read: post: tags: - Logs description: Retrieve logs for assets by item_id parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assetLogsById.read body: type: object properties: item_id: type: string required: - item_id required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: message: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true asset_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_fetched: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true log_name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true log_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true storage_format: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_id_1: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true group_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - message - asset_id - last_fetched - log_name - log_type - storage_format - custom_id_1 - group_id - item_id /api/v/1/code/{systemKey}/fetchLogs?id=assetLogs.read: post: tags: - Logs description: Retrieve logs for assets parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - assetLogs.read body: type: object properties: assetId: type: string groupIds: type: array items: type: string pageSize: type: number pageNum: type: number sortKey: type: string sortDir: anyOf: - type: string enum: - ASC - type: string enum: - DESC logType: type: string required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: DATA: type: array items: type: object properties: message: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true asset_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true last_fetched: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true log_name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true log_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true storage_format: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true custom_id_1: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true group_id: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true item_id: type: string required: - message - asset_id - last_fetched - log_name - log_type - storage_format - custom_id_1 - group_id - item_id COUNT: type: number LOG_TYPES: type: array items: type: string required: - DATA - COUNT - LOG_TYPES /api/v/1/code/{systemKey}/manageUsers?id=users.create: post: tags: - Users description: Use to insert users parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - users.create body: type: object properties: email: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true creation_date: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true areas: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true assets: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true cb_service_account: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true first_name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true group_ids: anyOf: - type: array items: type: string - type: object nullable: true enum: - null - nullable: true last_name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true phone: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true photo_url: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true pin: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true user_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true terms_agreement: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: object properties: date: type: string required: - date - type: object nullable: true enum: - null - nullable: true app_tour: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: object properties: date: type: string started: type: boolean required: - date - started - type: object properties: date: type: string tried: type: boolean required: - date - tried - type: object nullable: true enum: - null - nullable: true user_preferences: anyOf: - type: object properties: language: type: object properties: language: anyOf: - type: string enum: - en-US - type: string enum: - fr theme: type: object properties: darkMode: type: boolean preferredUnitOverrides: type: object additionalProperties: type: string dateTimeLocale: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true - type: object nullable: true enum: - null - nullable: true invite_status: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true invite_expiry: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true oidc_enabled: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true last_active: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true two_factor_method: type: string required: - email - creation_date - areas - assets - cb_service_account - first_name - group_ids - last_name - phone - photo_url - pin - user_type - terms_agreement - app_tour - user_preferences - invite_status - invite_expiry required: - name responses: "200": description: Success content: application/json: schema: type: object properties: user_id: type: string required: - user_id /api/v/1/code/{systemKey}/manageUsers?id=users.delete: post: tags: - Users description: Use to delete users parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - users.delete body: type: object properties: emails: type: array items: type: string required: - emails required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/manageUsers?id=users.update: post: tags: - Users description: Use to update users parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - users.update body: type: object properties: changes: allOf: - type: object properties: email: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - email - type: object properties: email: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true creation_date: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true areas: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true assets: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true cb_service_account: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true first_name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true group_ids: anyOf: - type: array items: type: string - type: object nullable: true enum: - null - nullable: true last_name: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true phone: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true photo_url: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true pin: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true user_type: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true terms_agreement: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: object properties: date: type: string required: - date - type: object nullable: true enum: - null - nullable: true app_tour: anyOf: - type: object additionalProperties: anyOf: - type: undefined enum: - null - type: object properties: date: type: string started: type: boolean required: - date - started - type: object properties: date: type: string tried: type: boolean required: - date - tried - type: object nullable: true enum: - null - nullable: true user_preferences: anyOf: - type: object properties: language: type: object properties: language: anyOf: - type: string enum: - en-US - type: string enum: - fr theme: type: object properties: darkMode: type: boolean preferredUnitOverrides: type: object additionalProperties: type: string dateTimeLocale: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true - type: object nullable: true enum: - null - nullable: true invite_status: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true invite_expiry: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true oidc_enabled: anyOf: - type: boolean - type: object nullable: true enum: - null - nullable: true last_active: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true two_factor_method: type: string user_id: type: string required: - email - creation_date - areas - assets - cb_service_account - first_name - group_ids - last_name - phone - photo_url - pin - user_type - terms_agreement - app_tour - user_preferences - invite_status - invite_expiry - user_id required: - changes required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/manageUsers?id=currentUser.update: post: tags: - Users description: Use to update the current user (self) parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - currentUser.update body: type: object properties: item: type: object properties: email: type: string first_name: type: string last_name: type: string phone: type: string photo_url: type: string terms_agreement: type: object additionalProperties: anyOf: - type: undefined enum: - null - type: object properties: date: type: string required: - date app_tour: type: object additionalProperties: anyOf: - type: undefined enum: - null - type: object properties: date: type: string started: type: boolean required: - date - started - type: object properties: date: type: string tried: type: boolean required: - date - tried user_preferences: type: object properties: language: type: object properties: language: anyOf: - type: string enum: - en-US - type: string enum: - fr theme: type: object properties: darkMode: type: boolean preferredUnitOverrides: type: object additionalProperties: type: string dateTimeLocale: anyOf: - type: string - type: object nullable: true enum: - null - nullable: true required: - item required: - name - body responses: "200": description: Success content: application/json: schema: nullable: true /api/v/1/code/{systemKey}/manageUsers?id=currentUser.updatePassword: post: tags: - Users description: Use to update the current user password (self) parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: name: type: string enum: - currentUser.updatePassword body: type: object properties: oldPassword: type: string newPassword: type: string required: - oldPassword - newPassword required: - name - body responses: "200": description: Success content: application/json: schema: type: object properties: success: type: boolean enum: - true required: - success /api/v/1/code/{systemKey}/newUserEmail: post: tags: - Users description: Send an email to a new user parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: email: type: string firstname: type: string lastname: type: string administrator: type: string userPreferences: type: object properties: language: type: string theme: type: string required: - language - theme required: - email - firstname - lastname - administrator - userPreferences responses: {} /api/v/1/code/{systemKey}/resetPassword: post: tags: - Users description: Reset a user password parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: pending_reset_id: type: string password: type: string required: - pending_reset_id - password responses: {} /api/v/1/code/{systemKey}/sendPasswordResetLink: post: tags: - Users description: Send a password reset link to a user parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: email: type: string required: - email responses: {} /api/v/1/code/{systemKey}/sendSMS: post: tags: - Miscellaneous description: Send an SMS to a user parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: phone_number: type: string message: type: string required: - phone_number - message responses: {} /api/v/1/code/{systemKey}/verifyNewUserRequests: post: tags: - Users description: Verify new user requests parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: onboarding_request_id: type: string required: - onboarding_request_id responses: {} /api/v/1/code/{systemKey}/updateOnboardingUsers: post: tags: - Users description: Update onboarding users parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: expires_at: type: string first_name: type: string last_name: type: string email: type: string password: type: string required: - expires_at - first_name - last_name - email - password responses: {} /api/v/1/code/{systemKey}/getResetRequest: post: tags: - Users description: Get reset request parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: pending_reset_id: type: string required: - pending_reset_id responses: {} /api/v/1/code/{systemKey}/invalidateRulesAndTypes: post: tags: - Rules description: Invalidate rules and types parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: rules: type: array items: type: string ruleTypes: type: array items: type: string required: - rules - ruleTypes responses: {} /api/v/1/code/{systemKey}/traverseForInvalidRules: post: tags: - Rules description: Traverse for invalid rules parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: modifiedTree: anyOf: - type: string enum: - assetTree - type: string enum: - assetTypeTree parentIds: type: array items: type: string childrenAdded: type: array items: type: string childrenRemoved: type: array items: type: string required: - modifiedTree - childrenAdded - childrenRemoved responses: {} /api/v/1/code/{systemKey}/retrieveNimbelinkDeviceConfig: post: tags: - Miscellaneous description: Retrieve Nimbelink device config parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: id: type: string required: - id responses: {} /api/v/1/code/{systemKey}/updateNimbelinkDeviceConfig: post: tags: - Miscellaneous description: Update Nimbelink device config parameters: - schema: type: string required: true name: systemKey in: path - schema: type: string required: true name: ClearBlade-UserToken in: header requestBody: content: application/json: schema: type: object properties: id: type: string config: nullable: true required: - id responses: {}