{ "x-generator": "On Key REST API Docs Generator", "openapi": "3.0.0", "info": { "title": "On Key AHM API Specification", "description": "Better and smarter enterprise asset management with one of the world's leading Enterprise Asset Management (EAM) systems.", "termsOfService": "https://www.onkey.com/", "contact": { "name": "On Key Support", "url": "https://www.onkey.com/", "email": "onkey.support@pragmaworld.net" }, "license": { "name": "On Key Licence", "url": "https://www.onkey.com/" }, "version": "1.0.0" }, "servers": [ { "url": "{scheme}://{server}:{port}/api/tenants/{client}/{connection}", "description": "On Key API Server", "variables": { "scheme": { "default": "https", "description": "HTTP scheme" }, "server": { "default": "", "description": "Server host" }, "port": { "default": "443", "description": "Port" }, "client": { "default": "", "description": "Client" }, "connection": { "default": "", "description": "Connection/Environment (i.e. prod, qa)" } } } ], "paths": { "/Modules/AHM/Alarms/{id}": { "get": { "tags": [ "Alarm" ], "summary": "Get a Alarm resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | Alarm->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Alarm->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Alarm->CreatedByUser_FullName | string | |\r\n| createdOn | Alarm->CreatedOn | string | date-time |\r\n| modifiedByUserId | Alarm->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Alarm->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Alarm->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Alarm->ModifiedOn | string | date-time |\r\n| version | Alarm->Version | integer | int32 |\r\n| permissionTreeId | Alarm->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Alarm->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Alarm->PermissionTree_Description | string | |\r\n| id | Alarm->Id | integer | int64 |\r\n| alarmTypeId | Alarm->AlarmType_Id | integer | int64 |\r\n| alarmTypeCode | Alarm->AlarmType_Code | string | |\r\n| alarmTypeDescription | Alarm->AlarmType_Description | string | |\r\n| assetId | Alarm->Asset_Id | integer | int64 |\r\n| assetCode | Alarm->Asset_Code | string | |\r\n| assetDescription | Alarm->Asset_Description | string | |\r\n| assetRecordType | Alarm->Asset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| classification | Alarm->Classification | string (Allowed values: [Information, Warning, Error]) | enum |\r\n| description | Alarm->Description | string | |\r\n| exceededBound | Alarm->ExceededBound | string (Allowed values: [UpperCritical, UpperWarning, LowerWarning, LowerCritical]) | enum |\r\n| monitoringPointId | Alarm->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | Alarm->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | Alarm->MonitoringPoint_Description | string | |\r\n| monitoringPointIsCalculated | Alarm->MonitoringPoint_IsCalculated | boolean | |\r\n| monitoringPointMonitoringPointTypeId | Alarm->MonitoringPoint_MonitoringPointType_Id | integer | int64 |\r\n| monitoringPointMonitoringPointTypeCode | Alarm->MonitoringPoint_MonitoringPointType_Code | string | |\r\n| monitoringPointMonitoringPointTypeDescription | Alarm->MonitoringPoint_MonitoringPointType_Description | string | |\r\n| notes | Alarm->Notes | string | |\r\n| sequenceNumber | Alarm->SequenceNumber | integer | int32 |\r\n| source | Alarm->Source | string (Allowed values: [Manual, StandaloneTriggerExpression, AssetRegisterTriggerExpression]) | enum |\r\n| status | Alarm->Status | string (Allowed values: [Active, Acknowledged, Closed, Cancelled, ClosedBySystem]) | enum |\r\n| workOrderGenerated | Alarm->WorkOrderGenerated | boolean | |\r\n", "operationId": "GetAlarm", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Alarm Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Alarm", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetMonitorPointTypeResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Alarm" ], "summary": "Update an existing Alarm resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | Alarm->Version | integer | int32 |\r\n| assetId | Alarm->Asset_Id | integer | int64 |\r\n| alarmTypeId | Alarm->AlarmType_Id | integer | int64 |\r\n| classification | Alarm->Classification | string (Allowed values: [Information, Warning, Error]) | enum |\r\n| description | Alarm->Description | string | |\r\n| notes | Alarm->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| alarmTypeId | Nullable | False | |\r\n| classification | Nullable | False | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 500 chars| |\r\n| notes | Read-only | True | Alarm->Status EQ 'Cancelled' OR Alarm->Status EQ 'ClosedBySystem' OR Alarm->Status EQ 'Closed' |\r\n\r\n", "operationId": "UpdateAlarm", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Alarm Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateAlarmResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Alarm was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms": { "get": { "tags": [ "Alarm" ], "summary": "Get a collection of Alarm resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | Alarm->Version | integer | int32 |\r\n| id | Alarm->Id | integer | int64 |\r\n| description | Alarm->Description | string | |\r\n| assetId | Alarm->Asset_Id | integer | int64 |\r\n| assetCode | Alarm->Asset_Code | string | |\r\n| assetDescription | Alarm->Asset_Description | string | |\r\n| alarmTypeId | Alarm->AlarmType_Id | integer | int64 |\r\n| alarmTypeCode | Alarm->AlarmType_Code | string | |\r\n| alarmTypeDescription | Alarm->AlarmType_Description | string | |\r\n| workOrderGenerated | Alarm->WorkOrderGenerated | boolean | |\r\n| status | Alarm->Status | string (Allowed values: [Active, Acknowledged, Closed, Cancelled, ClosedBySystem]) | enum |\r\n| notes | Alarm->Notes | string | |\r\n| createdOn | Alarm->CreatedOn | string | date-time |\r\n| modifiedOn | Alarm->ModifiedOn | string | date-time |\r\n| sequenceNumber | Alarm->SequenceNumber | integer | int32 |\r\n", "operationId": "GetAlarmCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Alarm collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetAlarmCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Alarm" ], "summary": "Create a new Alarm resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| alarmTypeId | Alarm->AlarmType_Id | integer | int64 |\r\n| assetId | Alarm->Asset_Id | integer | int64 |\r\n| classification | Alarm->Classification | string (Allowed values: [Information, Warning, Error]) | enum |\r\n| description | Alarm->Description | string | |\r\n| permissionTreeId | Alarm->PermissionTree_Id | integer | int64 |\r\n| notes | Alarm->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| alarmTypeId | Required | True | |\r\n| alarmTypeId | Nullable | False | |\r\n| classification | Nullable | False | |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 500 chars| |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateAlarm", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateAlarmResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Lookups/LookupAlarmAlarmType": { "get": { "tags": [ "Alarm" ], "summary": "Lookup the Alarm Type for the Alarm.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AlarmType->Id | integer | int64 |\r\n| code | AlarmType->Code | string | |\r\n| description | AlarmType->Description | string | |\r\n", "operationId": "LookupAlarmAlarmType", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Alarm Type collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/AlarmAlarmTypeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Lookups/LookupAlarmAsset": { "get": { "tags": [ "Alarm" ], "summary": "Lookup the Asset for the Alarm.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Asset->Id | integer | int64 |\r\n| code | Asset->Code | string | |\r\n| description | Asset->Description | string | |\r\n| recordType | Asset->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "LookupAlarmAsset", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Asset collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/AlarmAssetLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Lookups/LookupAlarmChangePermissionTree": { "get": { "tags": [ "Alarm" ], "summary": "Lookup the permission set for changing the Alarm.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupAlarmChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/AlarmChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Lookups/LookupAlarmInsertPermissionTree": { "get": { "tags": [ "Alarm" ], "summary": "Lookup the permission set for creating the Alarm.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupAlarmInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/AlarmInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Batch/{ids}": { "get": { "tags": [ "Alarm" ], "summary": "Get a collection of Alarm resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | Alarm->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Alarm->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Alarm->CreatedByUser_FullName | string | |\r\n| createdOn | Alarm->CreatedOn | string | date-time |\r\n| modifiedByUserId | Alarm->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Alarm->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Alarm->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Alarm->ModifiedOn | string | date-time |\r\n| version | Alarm->Version | integer | int32 |\r\n| permissionTreeId | Alarm->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Alarm->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Alarm->PermissionTree_Description | string | |\r\n| id | Alarm->Id | integer | int64 |\r\n| alarmTypeId | Alarm->AlarmType_Id | integer | int64 |\r\n| alarmTypeCode | Alarm->AlarmType_Code | string | |\r\n| alarmTypeDescription | Alarm->AlarmType_Description | string | |\r\n| assetId | Alarm->Asset_Id | integer | int64 |\r\n| assetCode | Alarm->Asset_Code | string | |\r\n| assetDescription | Alarm->Asset_Description | string | |\r\n| assetRecordType | Alarm->Asset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| classification | Alarm->Classification | string (Allowed values: [Information, Warning, Error]) | enum |\r\n| description | Alarm->Description | string | |\r\n| exceededBound | Alarm->ExceededBound | string (Allowed values: [UpperCritical, UpperWarning, LowerWarning, LowerCritical]) | enum |\r\n| monitoringPointId | Alarm->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | Alarm->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | Alarm->MonitoringPoint_Description | string | |\r\n| monitoringPointIsCalculated | Alarm->MonitoringPoint_IsCalculated | boolean | |\r\n| monitoringPointMonitoringPointTypeId | Alarm->MonitoringPoint_MonitoringPointType_Id | integer | int64 |\r\n| monitoringPointMonitoringPointTypeCode | Alarm->MonitoringPoint_MonitoringPointType_Code | string | |\r\n| monitoringPointMonitoringPointTypeDescription | Alarm->MonitoringPoint_MonitoringPointType_Description | string | |\r\n| notes | Alarm->Notes | string | |\r\n| sequenceNumber | Alarm->SequenceNumber | integer | int32 |\r\n| source | Alarm->Source | string (Allowed values: [Manual, StandaloneTriggerExpression, AssetRegisterTriggerExpression]) | enum |\r\n| status | Alarm->Status | string (Allowed values: [Active, Acknowledged, Closed, Cancelled, ClosedBySystem]) | enum |\r\n| workOrderGenerated | Alarm->WorkOrderGenerated | boolean | |\r\n", "operationId": "BatchGetAlarm", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Alarm id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Alarm collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetAlarmsResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Batch": { "post": { "tags": [ "Alarm" ], "summary": "Create a new collection of Alarm resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| description | Alarm->Description | string | |\r\n| alarmTypeId | Alarm->AlarmType_Id | integer | int64 |\r\n| assetId | Alarm->Asset_Id | integer | int64 |\r\n| classification | Alarm->Classification | string (Allowed values: [Information, Warning, Error]) | enum |\r\n| permissionTreeId | Alarm->PermissionTree_Id | integer | int64 |\r\n| notes | Alarm->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 500 chars| |\r\n| alarmTypeId | Required | True | |\r\n| alarmTypeId | Nullable | False | |\r\n| classification | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateAlarm", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateAlarmRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Alarm batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Alarm" ], "summary": "Update a collection of existing Alarm resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Alarm->Id | integer | int64 |\r\n| version | Alarm->Version | integer | int32 |\r\n| alarmTypeId | Alarm->AlarmType_Id | integer | int64 |\r\n| description | Alarm->Description | string | |\r\n| classification | Alarm->Classification | string (Allowed values: [Information, Warning, Error]) | enum |\r\n| assetId | Alarm->Asset_Id | integer | int64 |\r\n| notes | Alarm->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| alarmTypeId | Nullable | False | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 500 chars| |\r\n| classification | Nullable | False | |\r\n| notes | Read-only | True | Alarm->Status EQ 'Cancelled' OR Alarm->Status EQ 'ClosedBySystem' OR Alarm->Status EQ 'Closed' |\r\n\r\n", "operationId": "BatchUpdateAlarm", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateAlarmResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Alarm batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Batch/{alarmIds}/CreateWorkOrder": { "post": { "tags": [ "Alarm" ], "summary": "Batch Create Work Order for Alarms", "description": "", "operationId": "BatchCreateWorkOrderForAlarm", "parameters": [ { "name": "alarmIds", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Alarm id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/{id}/PermissionTree": { "patch": { "tags": [ "Alarm" ], "summary": "Change the PermissionTree for an existing Alarm resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | Alarm->Version | integer | int32 |\r\n| permissionTreeId | Alarm->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeAlarmPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Alarm Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeAlarmPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/{id}/Status": { "patch": { "tags": [ "Alarm" ], "summary": "Change Alarm Status", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | ChangeAlarmStatus->Version | integer | int32 |\r\n| status | ChangeAlarmStatus->Status | string (Allowed values: [Active, Acknowledged, Closed, Cancelled, ClosedBySystem]) | enum |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| status | Required | True | |\r\n| status | Nullable | False | |\r\n\r\n", "operationId": "ChangeAlarmStatus", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Alarm Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeAlarmStatusResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/{id}/CreateWorkOrder": { "post": { "tags": [ "Alarm" ], "summary": "Create Work Order For Alarm.", "description": "", "operationId": "CreateWorkOrderForAlarm", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Alarm Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Batch/PermissionTree": { "patch": { "tags": [ "Alarm" ], "summary": "Change the PermissionTree status for a collection of existing Alarm resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Alarm->Id | integer | int64 |\r\n| version | Alarm->Version | integer | int32 |\r\n| permissionTreeId | Alarm->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeAlarmPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeAlarmPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Status/Batch": { "post": { "tags": [ "Alarm" ], "summary": "Change the status for a collection of Alarm resources", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | ChangeAlarmStatus->Id | integer | int64 |\r\n| version | ChangeAlarmStatus->Version | integer | int32 |\r\n| status | ChangeAlarmStatus->Status | string (Allowed values: [Active, Acknowledged, Closed, Cancelled, ClosedBySystem]) | enum |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| status | Required | True | |\r\n| status | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeAlarmStatus", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeAlarmStatusResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Attributes/{id}": { "get": { "tags": [ "Alarm Attribute" ], "summary": "Get a Alarm Attribute resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| alarmId | AlarmAttribute->Alarm_Id | integer | int64 |\r\n| alarmDescription | AlarmAttribute->Alarm_Description | string | |\r\n| createdByUserId | AlarmAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AlarmAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AlarmAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | AlarmAttribute->CreatedOn | string | date-time |\r\n| isActive | AlarmAttribute->IsActive | boolean | |\r\n| modifiedByUserId | AlarmAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AlarmAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AlarmAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AlarmAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | AlarmAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AlarmAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AlarmAttribute->PermissionTree_Description | string | |\r\n| version | AlarmAttribute->Version | integer | int32 |\r\n| id | AlarmAttribute->Id | integer | int64 |\r\n| attributeId | AlarmAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | AlarmAttribute->Attribute_Code | string | |\r\n| attributeDescription | AlarmAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | AlarmAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | AlarmAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | AlarmAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | AlarmAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | AlarmAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | AlarmAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | AlarmAttribute->Notes | string | |\r\n| predefinedValueId | AlarmAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | AlarmAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | AlarmAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | AlarmAttribute->SequenceNumber | integer | int32 |\r\n| value | AlarmAttribute->Value | object | composite |\r\n", "operationId": "GetAlarmAttribute", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Alarm Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Alarm Attribute", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetAlarmAttributeResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Alarm Attribute" ], "summary": "Update an existing Alarm Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | AlarmAttribute->Version | integer | int32 |\r\n| value | AlarmAttribute->Value | object | composite |\r\n| predefinedValueId | AlarmAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | AlarmAttribute->SequenceNumber | integer | int32 |\r\n| notes | AlarmAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n\r\n", "operationId": "UpdateAlarmAttribute", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Alarm Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateAlarmAttributeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Alarm Attribute was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Alarm Attribute" ], "summary": "Delete an existing Alarm Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | AlarmAttribute->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteAlarmAttribute", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Alarm Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteAlarmAttributeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Alarm Attribute was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/{alarmId}/Attributes": { "get": { "tags": [ "Alarm Attribute" ], "summary": "Get a collection of Alarm Attribute resources for the Alarm.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AlarmAttribute->Id | integer | int64 |\r\n| version | AlarmAttribute->Version | integer | int32 |\r\n| sequenceNumber | AlarmAttribute->SequenceNumber | integer | int32 |\r\n| attributeId | AlarmAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | AlarmAttribute->Attribute_Code | string | |\r\n| attributeDescription | AlarmAttribute->Attribute_Description | string | |\r\n| attributeDataType | AlarmAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | AlarmAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | AlarmAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | AlarmAttribute->PredefinedValue_Value | object | composite |\r\n| value | AlarmAttribute->Value | object | composite |\r\n| notes | AlarmAttribute->Notes | string | |\r\n| createdOn | AlarmAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | AlarmAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetAlarmAttributeCollectionForAlarm", "parameters": [ { "name": "alarmId", "in": "path", "required": true, "description": "Alarm Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Alarm Attribute collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetAlarmAttributeCollectionForAlarmResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Attributes": { "get": { "tags": [ "Alarm Attribute" ], "summary": "Get a collection of Alarm Attribute resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AlarmAttribute->Id | integer | int64 |\r\n| version | AlarmAttribute->Version | integer | int32 |\r\n| alarmId | AlarmAttribute->Alarm_Id | integer | int64 |\r\n| alarmDescription | AlarmAttribute->Alarm_Description | string | |\r\n| sequenceNumber | AlarmAttribute->SequenceNumber | integer | int32 |\r\n| attributeId | AlarmAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | AlarmAttribute->Attribute_Code | string | |\r\n| attributeDescription | AlarmAttribute->Attribute_Description | string | |\r\n| attributeDataType | AlarmAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | AlarmAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | AlarmAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | AlarmAttribute->PredefinedValue_Value | object | composite |\r\n| value | AlarmAttribute->Value | object | composite |\r\n| notes | AlarmAttribute->Notes | string | |\r\n| createdOn | AlarmAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | AlarmAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetAlarmAttributeCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Alarm Attribute collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetAlarmAttributeCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Alarm Attribute" ], "summary": "Create a new Alarm Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| alarmId | AlarmAttribute->Alarm_Id | integer | int64 |\r\n| attributeId | AlarmAttribute->Attribute_Id | integer | int64 |\r\n| value | AlarmAttribute->Value | object | composite |\r\n| predefinedValueId | AlarmAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | AlarmAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | AlarmAttribute->SequenceNumber | integer | int32 |\r\n| notes | AlarmAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| alarmId | Required | True | |\r\n| alarmId | Nullable | False | |\r\n| attributeId | Required | True | |\r\n| attributeId | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateAlarmAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateAlarmAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Attributes/Lookups/LookupAlarmAttributeAllowedValue": { "get": { "tags": [ "Alarm Attribute" ], "summary": "Lookup the Attribute Allowed Value for the Alarm Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AttributeAllowedValue->Id | integer | int64 |\r\n| description | AttributeAllowedValue->Description | string | |\r\n| value | AttributeAllowedValue->Value | object | composite |\r\n", "operationId": "LookupAlarmAttributeAllowedValue", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Attribute Allowed Value collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/AlarmAttributeAttributeAllowedValueLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Attributes/Lookups/LookupAlarmAttribute": { "get": { "tags": [ "Alarm Attribute" ], "summary": "Alarm Attribute", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Attribute->Id | integer | int64 |\r\n| code | Attribute->Code | string | |\r\n| description | Attribute->Description | string | |\r\n| allowAnyValue | Attribute->AllowAnyValue | boolean | |\r\n| dataType | Attribute->DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| defaultValue | Attribute->DefaultValue | object | composite |\r\n| defaultAllowedValueId | Attribute->DefaultAllowedValue_Id | integer | int64 |\r\n| defaultAllowedValueValue | Attribute->DefaultAllowedValue_Value | object | composite |\r\n| defaultAllowedValueDescription | Attribute->DefaultAllowedValue_Description | string | |\r\n| explanation | Attribute->Explanation | string | |\r\n", "operationId": "LookupAlarmAttribute", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Attribute collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/AlarmAttributeAttributeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Attributes/Lookups/LookupAlarmAttributeChangePermissionTree": { "get": { "tags": [ "Alarm Attribute" ], "summary": "Lookup the permission set for changing the Alarm Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupAlarmAttributeChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/AlarmAttributeChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Attributes/Lookups/LookupAlarmAttributeInsertPermissionTree": { "get": { "tags": [ "Alarm Attribute" ], "summary": "Lookup the permission set for creating the Alarm Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupAlarmAttributeInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/AlarmAttributeInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Attributes/Lookups/LookupAlarmAttributeAlarm": { "get": { "tags": [ "Alarm Attribute" ], "summary": "Lookup the Alarm Attribute for the Alarm Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Alarm->Id | integer | int64 |\r\n| description | Alarm->Description | string | |\r\n", "operationId": "LookupAlarmAttributeAlarm", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Alarm collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/AlarmAttributeAlarmLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Attributes/Batch/{ids}": { "get": { "tags": [ "Alarm Attribute" ], "summary": "Get a collection of Alarm Attribute resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| alarmId | AlarmAttribute->Alarm_Id | integer | int64 |\r\n| alarmDescription | AlarmAttribute->Alarm_Description | string | |\r\n| createdByUserId | AlarmAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AlarmAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AlarmAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | AlarmAttribute->CreatedOn | string | date-time |\r\n| isActive | AlarmAttribute->IsActive | boolean | |\r\n| modifiedByUserId | AlarmAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AlarmAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AlarmAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AlarmAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | AlarmAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AlarmAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AlarmAttribute->PermissionTree_Description | string | |\r\n| version | AlarmAttribute->Version | integer | int32 |\r\n| id | AlarmAttribute->Id | integer | int64 |\r\n| attributeId | AlarmAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | AlarmAttribute->Attribute_Code | string | |\r\n| attributeDescription | AlarmAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | AlarmAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | AlarmAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | AlarmAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | AlarmAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | AlarmAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | AlarmAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | AlarmAttribute->Notes | string | |\r\n| predefinedValueId | AlarmAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | AlarmAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | AlarmAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | AlarmAttribute->SequenceNumber | integer | int32 |\r\n| value | AlarmAttribute->Value | object | composite |\r\n", "operationId": "BatchGetAlarmAttribute", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Alarm Attribute id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Alarm Attribute collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetAlarmAttributeResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Attributes/Batch": { "post": { "tags": [ "Alarm Attribute" ], "summary": "Create a new collection of Alarm Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| alarmId | AlarmAttribute->Alarm_Id | integer | int64 |\r\n| attributeId | AlarmAttribute->Attribute_Id | integer | int64 |\r\n| value | AlarmAttribute->Value | object | composite |\r\n| predefinedValueId | AlarmAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | AlarmAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | AlarmAttribute->SequenceNumber | integer | int32 |\r\n| notes | AlarmAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| alarmId | Required | True | |\r\n| alarmId | Nullable | False | |\r\n| attributeId | Required | True | |\r\n| attributeId | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateAlarmAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateAlarmAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Alarm Attribute batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Alarm Attribute" ], "summary": "Update a collection of existing Alarm Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AlarmAttribute->Id | integer | int64 |\r\n| version | AlarmAttribute->Version | integer | int32 |\r\n| value | AlarmAttribute->Value | object | composite |\r\n| predefinedValueId | AlarmAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | AlarmAttribute->SequenceNumber | integer | int32 |\r\n| notes | AlarmAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n\r\n", "operationId": "BatchUpdateAlarmAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateAlarmAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Alarm Attribute batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Alarm Attribute" ], "summary": "Delete a collection of existing Alarm Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AlarmAttribute->Id | integer | int64 |\r\n| version | AlarmAttribute->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteAlarmAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteAlarmAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Alarm Attribute batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Attributes/{id}/Active": { "patch": { "tags": [ "Alarm Attribute" ], "summary": "Change the IsActive status for an existing Alarm Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | AlarmAttribute->Version | integer | int32 |\r\n| isActive | AlarmAttribute->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeAlarmAttributeIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Alarm Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeAlarmAttributeIsActiveResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Attributes/{id}/PermissionTree": { "patch": { "tags": [ "Alarm Attribute" ], "summary": "Change the PermissionTree for an existing Alarm Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | AlarmAttribute->Version | integer | int32 |\r\n| permissionTreeId | AlarmAttribute->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeAlarmAttributePermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Alarm Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeAlarmAttributePermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Attributes/Batch/PermissionTree": { "patch": { "tags": [ "Alarm Attribute" ], "summary": "Change the PermissionTree status for a collection of existing Alarm Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AlarmAttribute->Id | integer | int64 |\r\n| version | AlarmAttribute->Version | integer | int32 |\r\n| permissionTreeId | AlarmAttribute->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeAlarmAttributePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeAlarmAttributePermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Attributes/Batch/Active": { "patch": { "tags": [ "Alarm Attribute" ], "summary": "Change the IsActive status for a collection of existing Alarm Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AlarmAttribute->Id | integer | int64 |\r\n| version | AlarmAttribute->Version | integer | int32 |\r\n| isActive | AlarmAttribute->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeAlarmAttributeIsActive", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeAlarmAttributeIsActiveResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Documents/{id}": { "get": { "tags": [ "Alarm Document" ], "summary": "Get a Alarm Document resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| alarmId | AlarmDocument->Alarm_Id | integer | int64 |\r\n| alarmDescription | AlarmDocument->Alarm_Description | string | |\r\n| isActive | AlarmDocument->IsActive | boolean | |\r\n| createdByUserId | AlarmDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AlarmDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AlarmDocument->CreatedByUser_FullName | string | |\r\n| createdOn | AlarmDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | AlarmDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AlarmDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AlarmDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AlarmDocument->ModifiedOn | string | date-time |\r\n| version | AlarmDocument->Version | integer | int32 |\r\n| permissionTreeId | AlarmDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AlarmDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AlarmDocument->PermissionTree_Description | string | |\r\n| id | AlarmDocument->Id | integer | int64 |\r\n| documentRecordId | AlarmDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | AlarmDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | AlarmDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | AlarmDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | AlarmDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | AlarmDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | AlarmDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | AlarmDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | AlarmDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | AlarmDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | AlarmDocument->Notes | string | |\r\n| sequenceNumber | AlarmDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "GetAlarmDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Alarm Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Alarm Document", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetAlarmDocumentResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Alarm Document" ], "summary": "Update an existing Alarm Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | AlarmDocument->Version | integer | int32 |\r\n| sequenceNumber | AlarmDocument->SequenceNumber | integer | int32 |\r\n| notes | AlarmDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "UpdateAlarmDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Alarm Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateAlarmDocumentResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Alarm Document was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Alarm Document" ], "summary": "Delete an existing Alarm Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | AlarmDocument->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteAlarmDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Alarm Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteAlarmDocumentResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Alarm Document was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/{id}/Documents": { "get": { "tags": [ "Alarm Document" ], "summary": "Get a collection of Alarm Document resources for the Alarm.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AlarmDocument->Id | integer | int64 |\r\n| version | AlarmDocument->Version | integer | int32 |\r\n| sequenceNumber | AlarmDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | AlarmDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | AlarmDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | AlarmDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | AlarmDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | AlarmDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | AlarmDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | AlarmDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetAlarmDocumentCollectionForAlarm", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Alarm Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Alarm Document collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetAlarmDocumentCollectionForAlarmResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Documents": { "get": { "tags": [ "Alarm Document" ], "summary": "Get a collection of Alarm Document resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AlarmDocument->Id | integer | int64 |\r\n| version | AlarmDocument->Version | integer | int32 |\r\n| alarmId | AlarmDocument->Alarm_Id | integer | int64 |\r\n| alarmDescription | AlarmDocument->Alarm_Description | string | |\r\n| sequenceNumber | AlarmDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | AlarmDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | AlarmDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | AlarmDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | AlarmDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | AlarmDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | AlarmDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | AlarmDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetAlarmDocumentCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Alarm Document collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetAlarmDocumentCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Alarm Document" ], "summary": "Create a new Alarm Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| alarmId | AlarmDocument->Alarm_Id | integer | int64 |\r\n| documentRecordId | AlarmDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | AlarmDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | AlarmDocument->SequenceNumber | integer | int32 |\r\n| notes | AlarmDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| alarmId | Required | True | |\r\n| alarmId | Nullable | False | |\r\n| documentRecordId | Required | True | |\r\n| documentRecordId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateAlarmDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateAlarmDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Documents/Lookups/LookupAlarmDocumentAlarm": { "get": { "tags": [ "Alarm Document" ], "summary": "Lookup the Alarm Document for the Alarm Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Alarm->Id | integer | int64 |\r\n| description | Alarm->Description | string | |\r\n", "operationId": "LookupAlarmDocumentAlarm", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Alarm collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/AlarmDocumentAlarmLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Documents/Lookups/LookupAlarmDocumentChangePermissionTree": { "get": { "tags": [ "Alarm Document" ], "summary": "Lookup the permission set for changing the Alarm Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupAlarmDocumentChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/AlarmDocumentChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Documents/Lookups/LookupAlarmDocument": { "get": { "tags": [ "Alarm Document" ], "summary": "Alarm Document", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | DocumentRecord->Id | integer | int64 |\r\n| code | DocumentRecord->Code | string | |\r\n| description | DocumentRecord->Description | string | |\r\n| fileLocation | DocumentRecord->FileLocation | string | |\r\n| fileFullName | DocumentRecord->FileFullName | string | |\r\n", "operationId": "LookupAlarmDocument", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Document Record collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/AlarmDocumentDocumentLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Documents/Lookups/LookupAlarmDocumentInsertPermissionTree": { "get": { "tags": [ "Alarm Document" ], "summary": "Lookup the permission set for creating the Alarm Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupAlarmDocumentInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/AlarmDocumentInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Documents/Batch/{ids}": { "get": { "tags": [ "Alarm Document" ], "summary": "Get a collection of Alarm Document resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| alarmId | AlarmDocument->Alarm_Id | integer | int64 |\r\n| alarmDescription | AlarmDocument->Alarm_Description | string | |\r\n| isActive | AlarmDocument->IsActive | boolean | |\r\n| createdByUserId | AlarmDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AlarmDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AlarmDocument->CreatedByUser_FullName | string | |\r\n| createdOn | AlarmDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | AlarmDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AlarmDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AlarmDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AlarmDocument->ModifiedOn | string | date-time |\r\n| version | AlarmDocument->Version | integer | int32 |\r\n| permissionTreeId | AlarmDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AlarmDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AlarmDocument->PermissionTree_Description | string | |\r\n| id | AlarmDocument->Id | integer | int64 |\r\n| documentRecordId | AlarmDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | AlarmDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | AlarmDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | AlarmDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | AlarmDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | AlarmDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | AlarmDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | AlarmDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | AlarmDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | AlarmDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | AlarmDocument->Notes | string | |\r\n| sequenceNumber | AlarmDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetAlarmDocument", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Alarm Document id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Alarm Document collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetAlarmDocumentResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Documents/Batch": { "post": { "tags": [ "Alarm Document" ], "summary": "Create a new collection of Alarm Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| alarmId | AlarmDocument->Alarm_Id | integer | int64 |\r\n| documentRecordId | AlarmDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | AlarmDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | AlarmDocument->SequenceNumber | integer | int32 |\r\n| notes | AlarmDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| alarmId | Required | True | |\r\n| alarmId | Nullable | False | |\r\n| documentRecordId | Required | True | |\r\n| documentRecordId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateAlarmDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateAlarmDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Alarm Document batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Alarm Document" ], "summary": "Update a collection of existing Alarm Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AlarmDocument->Id | integer | int64 |\r\n| version | AlarmDocument->Version | integer | int32 |\r\n| sequenceNumber | AlarmDocument->SequenceNumber | integer | int32 |\r\n| notes | AlarmDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateAlarmDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateAlarmDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Alarm Document batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Alarm Document" ], "summary": "Delete a collection of existing Alarm Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AlarmDocument->Id | integer | int64 |\r\n| version | AlarmDocument->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteAlarmDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteAlarmDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Alarm Document batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Documents/{id}/Active": { "patch": { "tags": [ "Alarm Document" ], "summary": "Change the IsActive status for an existing Alarm Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | AlarmDocument->Version | integer | int32 |\r\n| isActive | AlarmDocument->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeAlarmDocumentIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Alarm Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeAlarmDocumentIsActiveResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Documents/{id}/PermissionTree": { "patch": { "tags": [ "Alarm Document" ], "summary": "Change the PermissionTree for an existing Alarm Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | AlarmDocument->Version | integer | int32 |\r\n| permissionTreeId | AlarmDocument->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeAlarmDocumentPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Alarm Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeAlarmDocumentPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Documents/Batch/PermissionTree": { "patch": { "tags": [ "Alarm Document" ], "summary": "Change the PermissionTree status for a collection of existing Alarm Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AlarmDocument->Id | integer | int64 |\r\n| version | AlarmDocument->Version | integer | int32 |\r\n| permissionTreeId | AlarmDocument->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeAlarmDocumentPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeAlarmDocumentPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Documents/Batch/Active": { "patch": { "tags": [ "Alarm Document" ], "summary": "Change the IsActive status for a collection of existing Alarm Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AlarmDocument->Id | integer | int64 |\r\n| version | AlarmDocument->Version | integer | int32 |\r\n| isActive | AlarmDocument->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeAlarmDocumentIsActive", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeAlarmDocumentIsActiveResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Expressions/{id}": { "get": { "tags": [ "Alarm Expression" ], "summary": "Get a Alarm Expression resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | AlarmExpression->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AlarmExpression->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AlarmExpression->CreatedByUser_FullName | string | |\r\n| createdOn | AlarmExpression->CreatedOn | string | date-time |\r\n| modifiedByUserId | AlarmExpression->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AlarmExpression->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AlarmExpression->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AlarmExpression->ModifiedOn | string | date-time |\r\n| version | AlarmExpression->Version | integer | int32 |\r\n| id | AlarmExpression->Id | integer | int64 |\r\n| alarmId | AlarmExpression->Alarm_Id | integer | int64 |\r\n| alarmDescription | AlarmExpression->Alarm_Description | string | |\r\n| monitoringPointTriggerExpressionId | AlarmExpression->MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionDescription | AlarmExpression->MonitoringPointTriggerExpression_Description | string | |\r\n| monitoringPointTriggerExpressionExpression | AlarmExpression->MonitoringPointTriggerExpression_Expression | string | |\r\n| status | AlarmExpression->Status | string (Allowed values: [Active, Handled, Cancelled]) | enum |\r\n", "operationId": "GetAlarmExpression", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Alarm Expression Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Alarm Expression", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetMonitorPointTypeResourceActionResponse2" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Expressions": { "get": { "tags": [ "Alarm Expression" ], "summary": "Get a collection of Alarm Expression resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AlarmExpression->Id | integer | int64 |\r\n| version | AlarmExpression->Version | integer | int32 |\r\n| alarmDescription | AlarmExpression->Alarm_Description | string | |\r\n| status | AlarmExpression->Status | string (Allowed values: [Active, Handled, Cancelled]) | enum |\r\n| monitoringPointTriggerExpressionDescription | AlarmExpression->MonitoringPointTriggerExpression_Description | string | |\r\n| monitoringPointTriggerExpressionExpression | AlarmExpression->MonitoringPointTriggerExpression_Expression | string | |\r\n", "operationId": "GetAlarmExpressionCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Alarm Expression collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetAlarmExpressionCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/{alarmId}/Expression": { "get": { "tags": [ "Alarm Expression" ], "summary": "Get a collection of Alarm Expression resources for the Alarm.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AlarmExpression->Id | integer | int64 |\r\n| version | AlarmExpression->Version | integer | int32 |\r\n| monitoringPointTriggerExpressionDescription | AlarmExpression->MonitoringPointTriggerExpression_Description | string | |\r\n| monitoringPointTriggerExpressionExpression | AlarmExpression->MonitoringPointTriggerExpression_Expression | string | |\r\n", "operationId": "GetAlarmExpressionForAlarmCollection", "parameters": [ { "name": "alarmId", "in": "path", "required": true, "description": "Alarm Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Alarm Expression collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetAlarmExpressionForAlarmCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Expressions/Batch/{ids}": { "get": { "tags": [ "Alarm Expression" ], "summary": "Get a collection of Alarm Expression resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | AlarmExpression->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AlarmExpression->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AlarmExpression->CreatedByUser_FullName | string | |\r\n| createdOn | AlarmExpression->CreatedOn | string | date-time |\r\n| modifiedByUserId | AlarmExpression->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AlarmExpression->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AlarmExpression->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AlarmExpression->ModifiedOn | string | date-time |\r\n| version | AlarmExpression->Version | integer | int32 |\r\n| id | AlarmExpression->Id | integer | int64 |\r\n| alarmId | AlarmExpression->Alarm_Id | integer | int64 |\r\n| alarmDescription | AlarmExpression->Alarm_Description | string | |\r\n| monitoringPointTriggerExpressionId | AlarmExpression->MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionDescription | AlarmExpression->MonitoringPointTriggerExpression_Description | string | |\r\n| monitoringPointTriggerExpressionExpression | AlarmExpression->MonitoringPointTriggerExpression_Expression | string | |\r\n| status | AlarmExpression->Status | string (Allowed values: [Active, Handled, Cancelled]) | enum |\r\n", "operationId": "BatchGetAlarmExpression", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Alarm Expression id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Alarm Expression collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetAlarmExpressionResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Expressions/Tasks/{id}": { "get": { "tags": [ "Alarm Expression Task" ], "summary": "Get a Alarm Expression Task resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | AlarmExpressionTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AlarmExpressionTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AlarmExpressionTask->CreatedByUser_FullName | string | |\r\n| createdOn | AlarmExpressionTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | AlarmExpressionTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AlarmExpressionTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AlarmExpressionTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AlarmExpressionTask->ModifiedOn | string | date-time |\r\n| version | AlarmExpressionTask->Version | integer | int32 |\r\n| id | AlarmExpressionTask->Id | integer | int64 |\r\n| alarmExpressionId | AlarmExpressionTask->AlarmExpression_Id | integer | int64 |\r\n| alarmExpressionAlarmId | AlarmExpressionTask->AlarmExpression_Alarm_Id | integer | int64 |\r\n| alarmExpressionAlarmDescription | AlarmExpressionTask->AlarmExpression_Alarm_Description | string | |\r\n| alarmExpressionMonitoringPointTriggerExpressionId | AlarmExpressionTask->AlarmExpression_MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| alarmExpressionMonitoringPointTriggerExpressionDescription | AlarmExpressionTask->AlarmExpression_MonitoringPointTriggerExpression_Description | string | |\r\n| alarmExpressionMonitoringPointTriggerExpressionExpression | AlarmExpressionTask->AlarmExpression_MonitoringPointTriggerExpression_Expression | string | |\r\n| regularAssetTaskId | AlarmExpressionTask->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | AlarmExpressionTask->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | AlarmExpressionTask->RegularAssetTask_Description | string | |\r\n| regularAssetTaskRecordType | AlarmExpressionTask->RegularAssetTask_RecordType | string (Allowed values: [Regular, Auxiliary]) | enum |\r\n| regularAssetTaskAssetId | AlarmExpressionTask->RegularAssetTask_Asset_Id | integer | int64 |\r\n| regularAssetTaskAssetCode | AlarmExpressionTask->RegularAssetTask_Asset_Code | string | |\r\n| regularAssetTaskAssetDescription | AlarmExpressionTask->RegularAssetTask_Asset_Description | string | |\r\n| regularAssetTaskAssetRecordType | AlarmExpressionTask->RegularAssetTask_Asset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| regularAssetTaskComponentId | AlarmExpressionTask->RegularAssetTask_Component_Id | integer | int64 |\r\n| regularAssetTaskComponentCode | AlarmExpressionTask->RegularAssetTask_Component_Code | string | |\r\n| regularAssetTaskComponentDescription | AlarmExpressionTask->RegularAssetTask_Component_Description | string | |\r\n| regularAssetTaskComponentRecordType | AlarmExpressionTask->RegularAssetTask_Component_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| regularAssetTaskSiteId | AlarmExpressionTask->RegularAssetTask_Site_Id | integer | int64 |\r\n| regularAssetTaskSiteCode | AlarmExpressionTask->RegularAssetTask_Site_Code | string | |\r\n| regularAssetTaskSiteDescription | AlarmExpressionTask->RegularAssetTask_Site_Description | string | |\r\n| status | AlarmExpressionTask->Status | string (Allowed values: [Active, Handled, Cancelled]) | enum |\r\n", "operationId": "GetAlarmExpressionTask", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Alarm Expression Task Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Alarm Expression Task", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetMonitorPointTypeResourceActionResponse3" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Expressions/{alarmExpressionId}/Task": { "get": { "tags": [ "Alarm Expression Task" ], "summary": "Get a collection of Alarm Expression Task resources for the Alarm.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AlarmExpressionTask->Id | integer | int64 |\r\n| version | AlarmExpressionTask->Version | integer | int32 |\r\n| alarmExpressionAlarmId | AlarmExpressionTask->AlarmExpression_Alarm_Id | integer | int64 |\r\n| alarmExpressionAlarmDescription | AlarmExpressionTask->AlarmExpression_Alarm_Description | string | |\r\n| alarmExpressionMonitoringPointTriggerExpressionDescription | AlarmExpressionTask->AlarmExpression_MonitoringPointTriggerExpression_Description | string | |\r\n| alarmExpressionMonitoringPointTriggerExpressionExpression | AlarmExpressionTask->AlarmExpression_MonitoringPointTriggerExpression_Expression | string | |\r\n| regularAssetTaskCode | AlarmExpressionTask->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | AlarmExpressionTask->RegularAssetTask_Description | string | |\r\n| regularAssetTaskAssetCode | AlarmExpressionTask->RegularAssetTask_Asset_Code | string | |\r\n| regularAssetTaskComponentCode | AlarmExpressionTask->RegularAssetTask_Component_Code | string | |\r\n", "operationId": "GetAlarmExpressionTaskForAlarmExpressionCollection", "parameters": [ { "name": "alarmExpressionId", "in": "path", "required": true, "description": "Alarm Expression Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Alarm Expression Task collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetAlarmExpressionTaskForAlarmExpressionCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Expressions/Tasks": { "get": { "tags": [ "Alarm Expression Task" ], "summary": "Get a collection of Alarm Expression Task resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AlarmExpressionTask->Id | integer | int64 |\r\n| version | AlarmExpressionTask->Version | integer | int32 |\r\n| alarmExpressionAlarmDescription | AlarmExpressionTask->AlarmExpression_Alarm_Description | string | |\r\n| alarmExpressionMonitoringPointTriggerExpressionDescription | AlarmExpressionTask->AlarmExpression_MonitoringPointTriggerExpression_Description | string | |\r\n| alarmExpressionMonitoringPointTriggerExpressionExpression | AlarmExpressionTask->AlarmExpression_MonitoringPointTriggerExpression_Expression | string | |\r\n| status | AlarmExpressionTask->Status | string (Allowed values: [Active, Handled, Cancelled]) | enum |\r\n| regularAssetTaskCode | AlarmExpressionTask->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | AlarmExpressionTask->RegularAssetTask_Description | string | |\r\n| regularAssetTaskAssetCode | AlarmExpressionTask->RegularAssetTask_Asset_Code | string | |\r\n| regularAssetTaskComponentCode | AlarmExpressionTask->RegularAssetTask_Component_Code | string | |\r\n", "operationId": "GetAlarmExpressionTaskCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Alarm Expression Task collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetAlarmExpressionTaskCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/Alarms/Expressions/Tasks/Batch/{ids}": { "get": { "tags": [ "Alarm Expression Task" ], "summary": "Get a collection of Alarm Expression Task resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | AlarmExpressionTask->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AlarmExpressionTask->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AlarmExpressionTask->CreatedByUser_FullName | string | |\r\n| createdOn | AlarmExpressionTask->CreatedOn | string | date-time |\r\n| modifiedByUserId | AlarmExpressionTask->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AlarmExpressionTask->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AlarmExpressionTask->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AlarmExpressionTask->ModifiedOn | string | date-time |\r\n| version | AlarmExpressionTask->Version | integer | int32 |\r\n| id | AlarmExpressionTask->Id | integer | int64 |\r\n| alarmExpressionId | AlarmExpressionTask->AlarmExpression_Id | integer | int64 |\r\n| alarmExpressionAlarmId | AlarmExpressionTask->AlarmExpression_Alarm_Id | integer | int64 |\r\n| alarmExpressionAlarmDescription | AlarmExpressionTask->AlarmExpression_Alarm_Description | string | |\r\n| alarmExpressionMonitoringPointTriggerExpressionId | AlarmExpressionTask->AlarmExpression_MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| alarmExpressionMonitoringPointTriggerExpressionDescription | AlarmExpressionTask->AlarmExpression_MonitoringPointTriggerExpression_Description | string | |\r\n| alarmExpressionMonitoringPointTriggerExpressionExpression | AlarmExpressionTask->AlarmExpression_MonitoringPointTriggerExpression_Expression | string | |\r\n| regularAssetTaskId | AlarmExpressionTask->RegularAssetTask_Id | integer | int64 |\r\n| regularAssetTaskCode | AlarmExpressionTask->RegularAssetTask_Code | string | |\r\n| regularAssetTaskDescription | AlarmExpressionTask->RegularAssetTask_Description | string | |\r\n| regularAssetTaskRecordType | AlarmExpressionTask->RegularAssetTask_RecordType | string (Allowed values: [Regular, Auxiliary]) | enum |\r\n| regularAssetTaskAssetId | AlarmExpressionTask->RegularAssetTask_Asset_Id | integer | int64 |\r\n| regularAssetTaskAssetCode | AlarmExpressionTask->RegularAssetTask_Asset_Code | string | |\r\n| regularAssetTaskAssetDescription | AlarmExpressionTask->RegularAssetTask_Asset_Description | string | |\r\n| regularAssetTaskAssetRecordType | AlarmExpressionTask->RegularAssetTask_Asset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| regularAssetTaskComponentId | AlarmExpressionTask->RegularAssetTask_Component_Id | integer | int64 |\r\n| regularAssetTaskComponentCode | AlarmExpressionTask->RegularAssetTask_Component_Code | string | |\r\n| regularAssetTaskComponentDescription | AlarmExpressionTask->RegularAssetTask_Component_Description | string | |\r\n| regularAssetTaskComponentRecordType | AlarmExpressionTask->RegularAssetTask_Component_RecordType | string (Allowed values: [Regular, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| regularAssetTaskSiteId | AlarmExpressionTask->RegularAssetTask_Site_Id | integer | int64 |\r\n| regularAssetTaskSiteCode | AlarmExpressionTask->RegularAssetTask_Site_Code | string | |\r\n| regularAssetTaskSiteDescription | AlarmExpressionTask->RegularAssetTask_Site_Description | string | |\r\n| status | AlarmExpressionTask->Status | string (Allowed values: [Active, Handled, Cancelled]) | enum |\r\n", "operationId": "BatchGetAlarmExpressionTask", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Alarm Expression Task id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Alarm Expression Task collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetAlarmExpressionTaskResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/AlarmTypes/{id}": { "get": { "tags": [ "Alarm Type" ], "summary": "Get a Alarm Type resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | AlarmType->Code | string | |\r\n| isActive | AlarmType->IsActive | boolean | |\r\n| createdByUserId | AlarmType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AlarmType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AlarmType->CreatedByUser_FullName | string | |\r\n| createdOn | AlarmType->CreatedOn | string | date-time |\r\n| modifiedByUserId | AlarmType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AlarmType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AlarmType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AlarmType->ModifiedOn | string | date-time |\r\n| version | AlarmType->Version | integer | int32 |\r\n| permissionTreeId | AlarmType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AlarmType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AlarmType->PermissionTree_Description | string | |\r\n| id | AlarmType->Id | integer | int64 |\r\n| autoCreateWorkOrder | AlarmType->AutoCreateWorkOrder | boolean | |\r\n| defaultWorkOrderSectionId | AlarmType->DefaultWorkOrderSection_Id | integer | int64 |\r\n| defaultWorkOrderSectionCode | AlarmType->DefaultWorkOrderSection_Code | string | |\r\n| defaultWorkOrderSectionDescription | AlarmType->DefaultWorkOrderSection_Description | string | |\r\n| defaultWorkOrderStaffMemberId | AlarmType->DefaultWorkOrderStaffMember_Id | integer | int64 |\r\n| defaultWorkOrderStaffMemberCode | AlarmType->DefaultWorkOrderStaffMember_Code | string | |\r\n| defaultWorkOrderStaffMemberDescription | AlarmType->DefaultWorkOrderStaffMember_Description | string | |\r\n| defaultWorkOrderStaffMemberContactDetailId | AlarmType->DefaultWorkOrderStaffMember_ContactDetailId | integer | int64 |\r\n| defaultWorkOrderStaffMemberContactDetailFullName | AlarmType->DefaultWorkOrderStaffMember_ContactDetailFullName | string | |\r\n| defaultWorkOrderStatusId | AlarmType->DefaultWorkOrderStatus_Id | integer | int64 |\r\n| defaultWorkOrderStatusCode | AlarmType->DefaultWorkOrderStatus_Code | string | |\r\n| defaultWorkOrderStatusDescription | AlarmType->DefaultWorkOrderStatus_Description | string | |\r\n| defaultWorkOrderTradeId | AlarmType->DefaultWorkOrderTrade_Id | integer | int64 |\r\n| defaultWorkOrderTradeCode | AlarmType->DefaultWorkOrderTrade_Code | string | |\r\n| defaultWorkOrderTradeDescription | AlarmType->DefaultWorkOrderTrade_Description | string | |\r\n| defaultWorkOrderTypeOfWorkId | AlarmType->DefaultWorkOrderTypeOfWork_Id | integer | int64 |\r\n| defaultWorkOrderTypeOfWorkCode | AlarmType->DefaultWorkOrderTypeOfWork_Code | string | |\r\n| defaultWorkOrderTypeOfWorkDescription | AlarmType->DefaultWorkOrderTypeOfWork_Description | string | |\r\n| description | AlarmType->Description | string | |\r\n| notes | AlarmType->Notes | string | |\r\n| sequenceNumber | AlarmType->SequenceNumber | integer | int32 |\r\n", "operationId": "GetAlarmType", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Alarm Type Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Alarm Type", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetAlarmTypeResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Alarm Type" ], "summary": "Update an existing Alarm Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | AlarmType->Version | integer | int32 |\r\n| code | AlarmType->Code | string | |\r\n| description | AlarmType->Description | string | |\r\n| autoCreateWorkOrder | AlarmType->AutoCreateWorkOrder | boolean | |\r\n| defaultWorkOrderStatusId | AlarmType->DefaultWorkOrderStatus_Id | integer | int64 |\r\n| defaultWorkOrderSectionId | AlarmType->DefaultWorkOrderSection_Id | integer | int64 |\r\n| defaultWorkOrderStaffMemberId | AlarmType->DefaultWorkOrderStaffMember_Id | integer | int64 |\r\n| defaultWorkOrderTradeId | AlarmType->DefaultWorkOrderTrade_Id | integer | int64 |\r\n| defaultWorkOrderTypeOfWorkId | AlarmType->DefaultWorkOrderTypeOfWork_Id | integer | int64 |\r\n| notes | AlarmType->Notes | string | |\r\n| sequenceNumber | AlarmType->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 500 chars| |\r\n\r\n", "operationId": "UpdateAlarmType", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Alarm Type Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateAlarmTypeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Alarm Type was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Alarm Type" ], "summary": "Delete an existing Alarm Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | AlarmType->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteAlarmType", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Alarm Type Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "input", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteAlarmTypeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Alarm Type was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/AlarmTypes": { "get": { "tags": [ "Alarm Type" ], "summary": "Get a collection of Alarm Type resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | AlarmType->Version | integer | int32 |\r\n| id | AlarmType->Id | integer | int64 |\r\n| code | AlarmType->Code | string | |\r\n| description | AlarmType->Description | string | |\r\n| notes | AlarmType->Notes | string | |\r\n| sequenceNumber | AlarmType->SequenceNumber | integer | int32 |\r\n| defaultWorkOrderTypeOfWorkId | AlarmType->DefaultWorkOrderTypeOfWork_Id | integer | int64 |\r\n| defaultWorkOrderTypeOfWorkCode | AlarmType->DefaultWorkOrderTypeOfWork_Code | string | |\r\n| defaultWorkOrderTypeOfWorkDescription | AlarmType->DefaultWorkOrderTypeOfWork_Description | string | |\r\n| defaultWorkOrderStatusId | AlarmType->DefaultWorkOrderStatus_Id | integer | int64 |\r\n| defaultWorkOrderStatusCode | AlarmType->DefaultWorkOrderStatus_Code | string | |\r\n| defaultWorkOrderStatusDescription | AlarmType->DefaultWorkOrderStatus_Description | string | |\r\n| defaultWorkOrderSectionId | AlarmType->DefaultWorkOrderSection_Id | integer | int64 |\r\n| defaultWorkOrderSectionCode | AlarmType->DefaultWorkOrderSection_Code | string | |\r\n| defaultWorkOrderSectionDescription | AlarmType->DefaultWorkOrderSection_Description | string | |\r\n| defaultWorkOrderTradeId | AlarmType->DefaultWorkOrderTrade_Id | integer | int64 |\r\n| defaultWorkOrderTradeCode | AlarmType->DefaultWorkOrderTrade_Code | string | |\r\n| defaultWorkOrderTradeDescription | AlarmType->DefaultWorkOrderTrade_Description | string | |\r\n| defaultWorkOrderStaffMemberId | AlarmType->DefaultWorkOrderStaffMember_Id | integer | int64 |\r\n| defaultWorkOrderStaffMemberCode | AlarmType->DefaultWorkOrderStaffMember_Code | string | |\r\n| defaultWorkOrderStaffMemberDescription | AlarmType->DefaultWorkOrderStaffMember_Description | string | |\r\n| isActive | AlarmType->IsActive | boolean | |\r\n| createdOn | AlarmType->CreatedOn | string | date-time |\r\n| modifiedOn | AlarmType->ModifiedOn | string | date-time |\r\n", "operationId": "GetAlarmTypeCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Alarm Type collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetAlarmTypeCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Alarm Type" ], "summary": "Create a new Alarm Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | AlarmType->Code | string | |\r\n| description | AlarmType->Description | string | |\r\n| permissionTreeId | AlarmType->PermissionTree_Id | integer | int64 |\r\n| autoCreateWorkOrder | AlarmType->AutoCreateWorkOrder | boolean | |\r\n| defaultWorkOrderStatusId | AlarmType->DefaultWorkOrderStatus_Id | integer | int64 |\r\n| defaultWorkOrderSectionId | AlarmType->DefaultWorkOrderSection_Id | integer | int64 |\r\n| defaultWorkOrderStaffMemberId | AlarmType->DefaultWorkOrderStaffMember_Id | integer | int64 |\r\n| defaultWorkOrderTradeId | AlarmType->DefaultWorkOrderTrade_Id | integer | int64 |\r\n| defaultWorkOrderTypeOfWorkId | AlarmType->DefaultWorkOrderTypeOfWork_Id | integer | int64 |\r\n| notes | AlarmType->Notes | string | |\r\n| sequenceNumber | AlarmType->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 500 chars| |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateAlarmType", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateAlarmTypeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/AlarmTypes/Lookups/LookupAlarmTypeChangePermissionTree": { "get": { "tags": [ "Alarm Type" ], "summary": "Lookup the permission set for changing the Alarm Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupAlarmTypeChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/AlarmTypeChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/AlarmTypes/Lookups/LookupAlarmTypeDefaultWorkOrderStaffMember": { "get": { "tags": [ "Alarm Type" ], "summary": "Lookup up the Staff Member for the Alarm Type", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Resource->Id | integer | int64 |\r\n| code | Resource->Code | string | |\r\n| contactDetailFirstName | Resource->ContactDetailFirstName | string | |\r\n| contactDetailLastName | Resource->ContactDetailLastName | string | |\r\n| contactDetailFullName | Resource->ContactDetailFullName | string | |\r\n", "operationId": "LookupAlarmTypeDefaultWorkOrderStaffMember", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Resource collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/AlarmTypeDefaultWorkOrderStaffMemberLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/AlarmTypes/Lookups/LookupAlarmTypeDefaultWorkOrderTrade": { "get": { "tags": [ "Alarm Type" ], "summary": "Lookup the Trade for the Alarm Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Trade->Id | integer | int64 |\r\n| code | Trade->Code | string | |\r\n| description | Trade->Description | string | |\r\n", "operationId": "LookupAlarmTypeDefaultWorkOrderTrade", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Trade collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/AlarmTypeDefaultWorkOrderTradeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/AlarmTypes/Lookups/LookupAlarmTypeInsertPermissionTree": { "get": { "tags": [ "Alarm Type" ], "summary": "Lookup the permission set for creating the Alarm Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupAlarmTypeInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/AlarmTypeInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/AlarmTypes/Lookups/LookupAlarmTypeDefaultWorkOrderSection": { "get": { "tags": [ "Alarm Type" ], "summary": "Lookup the Section for the Alarm Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Section->Id | integer | int64 |\r\n| code | Section->Code | string | |\r\n| description | Section->Description | string | |\r\n", "operationId": "LookupAlarmTypeDefaultWorkOrderSection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Section collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/AlarmTypeSectionLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/AlarmTypes/Lookups/LookupAlarmTypeDefaultWorkOrderTypeOfWork": { "get": { "tags": [ "Alarm Type" ], "summary": "Lookup the Type of Work for the Alarm Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | TypeOfWork->Id | integer | int64 |\r\n| code | TypeOfWork->Code | string | |\r\n| description | TypeOfWork->Description | string | |\r\n", "operationId": "LookupAlarmTypeDefaultWorkOrderTypeOfWork", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Type of Work collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/AlarmTypeTypeOfWorkLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/AlarmTypes/Lookups/LookupAlarmTypeDefaultWorkOrderStatus": { "get": { "tags": [ "Alarm Type" ], "summary": "Lookup the Work Order Status for the Alarm Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | WorkOrderStatus->Id | integer | int64 |\r\n| code | WorkOrderStatus->Code | string | |\r\n| description | WorkOrderStatus->Description | string | |\r\n| baseStatus | WorkOrderStatus->BaseStatus | string (Allowed values: [AwaitingApproval, Approved, Completed, Closed, Cancelled]) | enum |\r\n", "operationId": "LookupAlarmTypeDefaultWorkOrderStatus", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Work Order Status collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/AlarmTypeWorkOrderStatusLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/AlarmTypes/Batch/{ids}": { "get": { "tags": [ "Alarm Type" ], "summary": "Get a collection of Alarm Type resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | AlarmType->Code | string | |\r\n| isActive | AlarmType->IsActive | boolean | |\r\n| createdByUserId | AlarmType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | AlarmType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | AlarmType->CreatedByUser_FullName | string | |\r\n| createdOn | AlarmType->CreatedOn | string | date-time |\r\n| modifiedByUserId | AlarmType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | AlarmType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | AlarmType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | AlarmType->ModifiedOn | string | date-time |\r\n| version | AlarmType->Version | integer | int32 |\r\n| permissionTreeId | AlarmType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | AlarmType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | AlarmType->PermissionTree_Description | string | |\r\n| id | AlarmType->Id | integer | int64 |\r\n| autoCreateWorkOrder | AlarmType->AutoCreateWorkOrder | boolean | |\r\n| defaultWorkOrderSectionId | AlarmType->DefaultWorkOrderSection_Id | integer | int64 |\r\n| defaultWorkOrderSectionCode | AlarmType->DefaultWorkOrderSection_Code | string | |\r\n| defaultWorkOrderSectionDescription | AlarmType->DefaultWorkOrderSection_Description | string | |\r\n| defaultWorkOrderStaffMemberId | AlarmType->DefaultWorkOrderStaffMember_Id | integer | int64 |\r\n| defaultWorkOrderStaffMemberCode | AlarmType->DefaultWorkOrderStaffMember_Code | string | |\r\n| defaultWorkOrderStaffMemberDescription | AlarmType->DefaultWorkOrderStaffMember_Description | string | |\r\n| defaultWorkOrderStaffMemberContactDetailId | AlarmType->DefaultWorkOrderStaffMember_ContactDetailId | integer | int64 |\r\n| defaultWorkOrderStaffMemberContactDetailFullName | AlarmType->DefaultWorkOrderStaffMember_ContactDetailFullName | string | |\r\n| defaultWorkOrderStatusId | AlarmType->DefaultWorkOrderStatus_Id | integer | int64 |\r\n| defaultWorkOrderStatusCode | AlarmType->DefaultWorkOrderStatus_Code | string | |\r\n| defaultWorkOrderStatusDescription | AlarmType->DefaultWorkOrderStatus_Description | string | |\r\n| defaultWorkOrderTradeId | AlarmType->DefaultWorkOrderTrade_Id | integer | int64 |\r\n| defaultWorkOrderTradeCode | AlarmType->DefaultWorkOrderTrade_Code | string | |\r\n| defaultWorkOrderTradeDescription | AlarmType->DefaultWorkOrderTrade_Description | string | |\r\n| defaultWorkOrderTypeOfWorkId | AlarmType->DefaultWorkOrderTypeOfWork_Id | integer | int64 |\r\n| defaultWorkOrderTypeOfWorkCode | AlarmType->DefaultWorkOrderTypeOfWork_Code | string | |\r\n| defaultWorkOrderTypeOfWorkDescription | AlarmType->DefaultWorkOrderTypeOfWork_Description | string | |\r\n| description | AlarmType->Description | string | |\r\n| notes | AlarmType->Notes | string | |\r\n| sequenceNumber | AlarmType->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetAlarmType", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Alarm Type id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Alarm Type collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetAlarmTypesResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/AlarmTypes/Batch": { "post": { "tags": [ "Alarm Type" ], "summary": "Create a new collection of Alarm Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | AlarmType->Code | string | |\r\n| description | AlarmType->Description | string | |\r\n| permissionTreeId | AlarmType->PermissionTree_Id | integer | int64 |\r\n| autoCreateWorkOrder | AlarmType->AutoCreateWorkOrder | boolean | |\r\n| defaultWorkOrderStatusId | AlarmType->DefaultWorkOrderStatus_Id | integer | int64 |\r\n| defaultWorkOrderSectionId | AlarmType->DefaultWorkOrderSection_Id | integer | int64 |\r\n| defaultWorkOrderStaffMemberId | AlarmType->DefaultWorkOrderStaffMember_Id | integer | int64 |\r\n| defaultWorkOrderTradeId | AlarmType->DefaultWorkOrderTrade_Id | integer | int64 |\r\n| defaultWorkOrderTypeOfWorkId | AlarmType->DefaultWorkOrderTypeOfWork_Id | integer | int64 |\r\n| notes | AlarmType->Notes | string | |\r\n| sequenceNumber | AlarmType->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 500 chars| |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateAlarmType", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateAlarmTypeRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Alarm Type batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Alarm Type" ], "summary": "Update a collection of existing Alarm Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AlarmType->Id | integer | int64 |\r\n| version | AlarmType->Version | integer | int32 |\r\n| code | AlarmType->Code | string | |\r\n| description | AlarmType->Description | string | |\r\n| autoCreateWorkOrder | AlarmType->AutoCreateWorkOrder | boolean | |\r\n| defaultWorkOrderStatusId | AlarmType->DefaultWorkOrderStatus_Id | integer | int64 |\r\n| defaultWorkOrderSectionId | AlarmType->DefaultWorkOrderSection_Id | integer | int64 |\r\n| defaultWorkOrderTypeOfWorkId | AlarmType->DefaultWorkOrderTypeOfWork_Id | integer | int64 |\r\n| defaultWorkOrderTradeId | AlarmType->DefaultWorkOrderTrade_Id | integer | int64 |\r\n| defaultWorkOrderStaffMemberId | AlarmType->DefaultWorkOrderStaffMember_Id | integer | int64 |\r\n| notes | AlarmType->Notes | string | |\r\n| sequenceNumber | AlarmType->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 500 chars| |\r\n\r\n", "operationId": "BatchUpdateAlarmType", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateAlarmTypeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Alarm Type batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Alarm Type" ], "summary": "Delete a collection of existing Alarm Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AlarmType->Id | integer | int64 |\r\n| version | AlarmType->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteAlarmType", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteAlarmTypeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Alarm Type batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/AlarmTypes/{id}/Active": { "patch": { "tags": [ "Alarm Type" ], "summary": "Change the IsActive status for an existing Alarm Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | AlarmType->Version | integer | int32 |\r\n| isActive | AlarmType->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeAlarmTypeIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Alarm Type Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeAlarmTypeIsActiveResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/AlarmTypes/{id}/PermissionTree": { "patch": { "tags": [ "Alarm Type" ], "summary": "Change the PermissionTree for an existing Alarm Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | AlarmType->Version | integer | int32 |\r\n| permissionTreeId | AlarmType->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeAlarmTypePermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Alarm Type Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeAlarmTypePermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/AlarmTypes/Batch/Active": { "patch": { "tags": [ "Alarm Type" ], "summary": "Change the IsActive status for a collection of existing Alarm Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AlarmType->Id | integer | int64 |\r\n| version | AlarmType->Version | integer | int32 |\r\n| isActive | AlarmType->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeAlarmTypeIsActive", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeAlarmTypeIsActiveResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/AlarmTypes/Batch/PermissionTree": { "patch": { "tags": [ "Alarm Type" ], "summary": "Change the PermissionTree status for a collection of existing Alarm Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AlarmType->Id | integer | int64 |\r\n| version | AlarmType->Version | integer | int32 |\r\n| permissionTreeId | AlarmType->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeAlarmTypePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeAlarmTypePermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/{id}": { "get": { "tags": [ "Monitoring Point" ], "summary": "Get a Monitoring Point resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | MonitoringPoint->Code | string | |\r\n| isActive | MonitoringPoint->IsActive | boolean | |\r\n| createdByUserId | MonitoringPoint->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MonitoringPoint->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MonitoringPoint->CreatedByUser_FullName | string | |\r\n| createdOn | MonitoringPoint->CreatedOn | string | date-time |\r\n| modifiedByUserId | MonitoringPoint->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MonitoringPoint->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MonitoringPoint->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MonitoringPoint->ModifiedOn | string | date-time |\r\n| version | MonitoringPoint->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPoint->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MonitoringPoint->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MonitoringPoint->PermissionTree_Description | string | |\r\n| id | MonitoringPoint->Id | integer | int64 |\r\n| alarmCancellation | MonitoringPoint->AlarmCancellation | string (Allowed values: [None, Bounds, WorkOrder]) | enum |\r\n| assetId | MonitoringPoint->Asset_Id | integer | int64 |\r\n| assetCode | MonitoringPoint->Asset_Code | string | |\r\n| assetDescription | MonitoringPoint->Asset_Description | string | |\r\n| description | MonitoringPoint->Description | string | |\r\n| isCalculated | MonitoringPoint->IsCalculated | boolean | |\r\n| lowerCriticalAlarmTypeId | MonitoringPoint->LowerCriticalAlarmType_Id | integer | int64 |\r\n| lowerCriticalAlarmTypeDescription | MonitoringPoint->LowerCriticalAlarmType_Description | string | |\r\n| lowerCriticalAlarmTypeCode | MonitoringPoint->LowerCriticalAlarmType_Code | string | |\r\n| lowerCriticalBound | MonitoringPoint->LowerCriticalBound | number | decimal |\r\n| lowerCriticalSuppressesLowerWarning | MonitoringPoint->LowerCriticalSuppressesLowerWarning | boolean | |\r\n| lowerWarningAlarmTypeId | MonitoringPoint->LowerWarningAlarmType_Id | integer | int64 |\r\n| lowerWarningAlarmTypeDescription | MonitoringPoint->LowerWarningAlarmType_Description | string | |\r\n| lowerWarningAlarmTypeCode | MonitoringPoint->LowerWarningAlarmType_Code | string | |\r\n| lowerWarningBound | MonitoringPoint->LowerWarningBound | number | decimal |\r\n| monitoringPointTypeId | MonitoringPoint->MonitoringPointType_Id | integer | int64 |\r\n| monitoringPointTypeCode | MonitoringPoint->MonitoringPointType_Code | string | |\r\n| monitoringPointTypeDescription | MonitoringPoint->MonitoringPointType_Description | string | |\r\n| monitoringPointTypeHasLowerCriticalBound | MonitoringPoint->MonitoringPointType_HasLowerCriticalBound | boolean | |\r\n| monitoringPointTypeHasLowerWarningBound | MonitoringPoint->MonitoringPointType_HasLowerWarningBound | boolean | |\r\n| monitoringPointTypeHasUpperCriticalBound | MonitoringPoint->MonitoringPointType_HasUpperCriticalBound | boolean | |\r\n| monitoringPointTypeHasUpperWarningBound | MonitoringPoint->MonitoringPointType_HasUpperWarningBound | boolean | |\r\n| notes | MonitoringPoint->Notes | string | |\r\n| readingFormula | MonitoringPoint->ReadingFormula | string | |\r\n| sequenceNumber | MonitoringPoint->SequenceNumber | integer | int32 |\r\n| serialNumber | MonitoringPoint->SerialNumber | string | |\r\n| unitOfMeasurementId | MonitoringPoint->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | MonitoringPoint->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | MonitoringPoint->UnitOfMeasurement_Description | string | |\r\n| upperCriticalAlarmTypeId | MonitoringPoint->UpperCriticalAlarmType_Id | integer | int64 |\r\n| upperCriticalAlarmTypeDescription | MonitoringPoint->UpperCriticalAlarmType_Description | string | |\r\n| upperCriticalAlarmTypeCode | MonitoringPoint->UpperCriticalAlarmType_Code | string | |\r\n| upperCriticalBound | MonitoringPoint->UpperCriticalBound | number | decimal |\r\n| upperCriticalSuppressesUpperWarning | MonitoringPoint->UpperCriticalSuppressesUpperWarning | boolean | |\r\n| upperWarningAlarmTypeId | MonitoringPoint->UpperWarningAlarmType_Id | integer | int64 |\r\n| upperWarningAlarmTypeDescription | MonitoringPoint->UpperWarningAlarmType_Description | string | |\r\n| upperWarningAlarmTypeCode | MonitoringPoint->UpperWarningAlarmType_Code | string | |\r\n| upperWarningBound | MonitoringPoint->UpperWarningBound | number | decimal |\r\n", "operationId": "GetMonitoringPoint", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Monitoring Point", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Monitoring Point" ], "summary": "Update an existing Monitoring Point resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPoint->Version | integer | int32 |\r\n| code | MonitoringPoint->Code | string | |\r\n| description | MonitoringPoint->Description | string | |\r\n| serialNumber | MonitoringPoint->SerialNumber | string | |\r\n| notes | MonitoringPoint->Notes | string | |\r\n| isCalculated | MonitoringPoint->IsCalculated | boolean | |\r\n| readingFormula | MonitoringPoint->ReadingFormula | string | |\r\n| serialNumber | MonitoringPoint->SerialNumber | string | |\r\n| alarmCancellation | MonitoringPoint->AlarmCancellation | string (Allowed values: [None, Bounds, WorkOrder]) | enum |\r\n| upperCriticalSuppressesUpperWarning | MonitoringPoint->UpperCriticalSuppressesUpperWarning | boolean | |\r\n| lowerCriticalSuppressesLowerWarning | MonitoringPoint->LowerCriticalSuppressesLowerWarning | boolean | |\r\n| upperCriticalBound | MonitoringPoint->UpperCriticalBound | number | decimal |\r\n| upperWarningBound | MonitoringPoint->UpperWarningBound | number | decimal |\r\n| lowerCriticalBound | MonitoringPoint->LowerCriticalBound | number | decimal |\r\n| lowerWarningBound | MonitoringPoint->LowerWarningBound | number | decimal |\r\n| assetId | MonitoringPoint->Asset_Id | integer | int64 |\r\n| sequenceNumber | MonitoringPoint->SequenceNumber | integer | int32 |\r\n| monitoringPointTypeId | MonitoringPoint->MonitoringPointType_Id | integer | int64 |\r\n| upperCriticalAlarmTypeId | MonitoringPoint->UpperCriticalAlarmType_Id | integer | int64 |\r\n| upperWarningAlarmTypeId | MonitoringPoint->UpperWarningAlarmType_Id | integer | int64 |\r\n| lowerWarningAlarmTypeId | MonitoringPoint->LowerWarningAlarmType_Id | integer | int64 |\r\n| lowerCriticalAlarmTypeId | MonitoringPoint->LowerCriticalAlarmType_Id | integer | int64 |\r\n| unitOfMeasurementId | MonitoringPoint->UnitOfMeasurement_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| isCalculated | Nullable | False | |\r\n| readingFormula | Nullable | True | MonitoringPoint->IsCalculated eq FALSE |\r\n| readingFormula | Nullable | False | MonitoringPoint->IsCalculated eq TRUE |\r\n| alarmCancellation | Nullable | False | |\r\n| upperCriticalSuppressesUpperWarning | Nullable | False | |\r\n| lowerCriticalSuppressesLowerWarning | Nullable | False | |\r\n| monitoringPointTypeId | Nullable | False | |\r\n| unitOfMeasurementId | Nullable | False | |\r\n\r\n", "operationId": "UpdateMonitoringPoint", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateMonitoringPointResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Monitoring Point was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Monitoring Point" ], "summary": "Delete an existing Monitoring Point resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPoint->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteMonitoringPoint", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteMonitoringPointResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Monitoring Point was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints": { "get": { "tags": [ "Monitoring Point" ], "summary": "Get a collection of Monitoring Point resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPoint->Id | integer | int64 |\r\n| version | MonitoringPoint->Version | integer | int32 |\r\n| code | MonitoringPoint->Code | string | |\r\n| description | MonitoringPoint->Description | string | |\r\n| unitOfMeasurementId | MonitoringPoint->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | MonitoringPoint->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | MonitoringPoint->UnitOfMeasurement_Description | string | |\r\n| assetId | MonitoringPoint->Asset_Id | integer | int64 |\r\n| assetCode | MonitoringPoint->Asset_Code | string | |\r\n| assetDescription | MonitoringPoint->Asset_Description | string | |\r\n| monitoringPointTypeId | MonitoringPoint->MonitoringPointType_Id | integer | int64 |\r\n| monitoringPointTypeCode | MonitoringPoint->MonitoringPointType_Code | string | |\r\n| monitoringPointTypeDescription | MonitoringPoint->MonitoringPointType_Description | string | |\r\n| notes | MonitoringPoint->Notes | string | |\r\n| isCalculated | MonitoringPoint->IsCalculated | boolean | |\r\n| sequenceNumber | MonitoringPoint->SequenceNumber | integer | int32 |\r\n| createdOn | MonitoringPoint->CreatedOn | string | date-time |\r\n| modifiedOn | MonitoringPoint->ModifiedOn | string | date-time |\r\n| upperCriticalBound | MonitoringPoint->UpperCriticalBound | number | decimal |\r\n| upperWarningBound | MonitoringPoint->UpperWarningBound | number | decimal |\r\n| lowerWarningBound | MonitoringPoint->LowerWarningBound | number | decimal |\r\n| lowerCriticalBound | MonitoringPoint->LowerCriticalBound | number | decimal |\r\n", "operationId": "GetMonitoringPointCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Monitoring Point" ], "summary": "Create a new Monitoring Point resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | MonitoringPoint->Code | string | |\r\n| description | MonitoringPoint->Description | string | |\r\n| permissionTreeId | MonitoringPoint->PermissionTree_Id | integer | int64 |\r\n| serialNumber | MonitoringPoint->SerialNumber | string | |\r\n| notes | MonitoringPoint->Notes | string | |\r\n| sequenceNumber | MonitoringPoint->SequenceNumber | integer | int32 |\r\n| serialNumber | MonitoringPoint->SerialNumber | string | |\r\n| alarmCancellation | MonitoringPoint->AlarmCancellation | string (Allowed values: [None, Bounds, WorkOrder]) | enum |\r\n| upperCriticalSuppressesUpperWarning | MonitoringPoint->UpperCriticalSuppressesUpperWarning | boolean | |\r\n| lowerCriticalSuppressesLowerWarning | MonitoringPoint->LowerCriticalSuppressesLowerWarning | boolean | |\r\n| upperCriticalBound | MonitoringPoint->UpperCriticalBound | number | decimal |\r\n| upperWarningBound | MonitoringPoint->UpperWarningBound | number | decimal |\r\n| lowerCriticalBound | MonitoringPoint->LowerCriticalBound | number | decimal |\r\n| lowerWarningBound | MonitoringPoint->LowerWarningBound | number | decimal |\r\n| isCalculated | MonitoringPoint->IsCalculated | boolean | |\r\n| readingFormula | MonitoringPoint->ReadingFormula | string | |\r\n| assetId | MonitoringPoint->Asset_Id | integer | int64 |\r\n| monitoringPointTypeId | MonitoringPoint->MonitoringPointType_Id | integer | int64 |\r\n| upperCriticalAlarmTypeId | MonitoringPoint->UpperCriticalAlarmType_Id | integer | int64 |\r\n| upperWarningAlarmTypeId | MonitoringPoint->UpperWarningAlarmType_Id | integer | int64 |\r\n| lowerWarningAlarmTypeId | MonitoringPoint->LowerWarningAlarmType_Id | integer | int64 |\r\n| lowerCriticalAlarmTypeId | MonitoringPoint->LowerCriticalAlarmType_Id | integer | int64 |\r\n| unitOfMeasurementId | MonitoringPoint->UnitOfMeasurement_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| code | System Generated | true | If no value specified |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | System Generated | true | If no value specified |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| alarmCancellation | Nullable | False | |\r\n| upperCriticalSuppressesUpperWarning | Nullable | False | |\r\n| lowerCriticalSuppressesLowerWarning | Nullable | False | |\r\n| isCalculated | Nullable | False | |\r\n| readingFormula | Nullable | True | MonitoringPoint->IsCalculated eq FALSE |\r\n| readingFormula | Nullable | False | MonitoringPoint->IsCalculated eq TRUE |\r\n| monitoringPointTypeId | Required | True | |\r\n| monitoringPointTypeId | Nullable | False | |\r\n| unitOfMeasurementId | System Generated | true | If no value specified |\r\n| unitOfMeasurementId | Nullable | False | |\r\n\r\n", "operationId": "CreateMonitoringPoint", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateMonitoringPointResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Lookups/LookupMonitoringPointAsset": { "get": { "tags": [ "Monitoring Point" ], "summary": "Lookup the Regular Asset for the Monitoring Point.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | RegularAsset->Id | integer | int64 |\r\n| code | RegularAsset->Code | string | |\r\n| description | RegularAsset->Description | string | |\r\n", "operationId": "LookupMonitoringPointAsset", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Regular Asset collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointAssetLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Lookups/LookupMonitoringPointChangePermissionTree": { "get": { "tags": [ "Monitoring Point" ], "summary": "Lookup the permission set for changing the Monitoring Point.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupMonitoringPointChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Lookups/LookupMonitoringPointInsertPermissionTree": { "get": { "tags": [ "Monitoring Point" ], "summary": "Lookup the permission set for creating the Monitoring Point.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupMonitoringPointInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Lookups/LookupMonitoringPointLowerCriticalAlarmType": { "get": { "tags": [ "Monitoring Point" ], "summary": "Lookup the Alarm Type for the Monitoring Point.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AlarmType->Id | integer | int64 |\r\n| code | AlarmType->Code | string | |\r\n| description | AlarmType->Description | string | |\r\n", "operationId": "LookupMonitoringPointLowerCriticalAlarmType", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Alarm Type collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointLowerCriticalAlarmTypeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Lookups/LookupMonitoringPointLowerWarningAlarmType": { "get": { "tags": [ "Monitoring Point" ], "summary": "Lookup the Alarm Type for the Monitoring Point.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AlarmType->Id | integer | int64 |\r\n| code | AlarmType->Code | string | |\r\n| description | AlarmType->Description | string | |\r\n", "operationId": "LookupMonitoringPointLowerWarningAlarmType", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Alarm Type collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointLowerWarningAlarmTypeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Lookups/LookupMonitoringPointMonitoringPointType": { "get": { "tags": [ "Monitoring Point" ], "summary": "Lookup the Monitoring Point Type for the Monitoring Point.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointType->Id | integer | int64 |\r\n| code | MonitoringPointType->Code | string | |\r\n| description | MonitoringPointType->Description | string | |\r\n| lowerCriticalBound | MonitoringPointType->LowerCriticalBound | number | decimal |\r\n| lowerWarningBound | MonitoringPointType->LowerWarningBound | number | decimal |\r\n| upperCriticalBound | MonitoringPointType->UpperCriticalBound | number | decimal |\r\n| upperWarningBound | MonitoringPointType->UpperWarningBound | number | decimal |\r\n| hasLowerCriticalBound | MonitoringPointType->HasLowerCriticalBound | boolean | |\r\n| hasLowerWarningBound | MonitoringPointType->HasLowerWarningBound | boolean | |\r\n| hasUpperCriticalBound | MonitoringPointType->HasUpperCriticalBound | boolean | |\r\n| hasUpperWarningBound | MonitoringPointType->HasUpperWarningBound | boolean | |\r\n| alarmCancellation | MonitoringPointType->AlarmCancellation | string (Allowed values: [None, Bounds, WorkOrder]) | enum |\r\n| upperCriticalSuppressesUpperWarning | MonitoringPointType->UpperCriticalSuppressesUpperWarning | boolean | |\r\n| lowerCriticalSuppressesLowerWarning | MonitoringPointType->LowerCriticalSuppressesLowerWarning | boolean | |\r\n| upperCriticalAlarmTypeId | MonitoringPointType->UpperCriticalAlarmType_Id | integer | int64 |\r\n| upperCriticalAlarmTypeCode | MonitoringPointType->UpperCriticalAlarmType_Code | string | |\r\n| upperCriticalAlarmTypeDescription | MonitoringPointType->UpperCriticalAlarmType_Description | string | |\r\n| upperWarningAlarmTypeId | MonitoringPointType->UpperWarningAlarmType_Id | integer | int64 |\r\n| upperWarningAlarmTypeCode | MonitoringPointType->UpperWarningAlarmType_Code | string | |\r\n| upperWarningAlarmTypeDescription | MonitoringPointType->UpperWarningAlarmType_Description | string | |\r\n| lowerWarningAlarmTypeId | MonitoringPointType->LowerWarningAlarmType_Id | integer | int64 |\r\n| lowerWarningAlarmTypeCode | MonitoringPointType->LowerWarningAlarmType_Code | string | |\r\n| lowerWarningAlarmTypeDescription | MonitoringPointType->LowerWarningAlarmType_Description | string | |\r\n| lowerCriticalAlarmTypeId | MonitoringPointType->LowerCriticalAlarmType_Id | integer | int64 |\r\n| lowerCriticalAlarmTypeCode | MonitoringPointType->LowerCriticalAlarmType_Code | string | |\r\n| lowerCriticalAlarmTypeDescription | MonitoringPointType->LowerCriticalAlarmType_Description | string | |\r\n", "operationId": "LookupMonitoringPointMonitoringPointType", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point Type collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointMonitoringPointTypeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Lookups/LookupMonitoringPointUnitOfMeasurement": { "get": { "tags": [ "Monitoring Point" ], "summary": "Lookup the Unit Of Measurement for the Monitoring Point.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | UnitOfMeasurement->Id | integer | int64 |\r\n| code | UnitOfMeasurement->Code | string | |\r\n| description | UnitOfMeasurement->Description | string | |\r\n", "operationId": "LookupMonitoringPointUnitOfMeasurement", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Unit Of Measurement collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointUnitOfMeasurementLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Lookups/LookupMonitoringPointUpperCriticalAlarmType": { "get": { "tags": [ "Monitoring Point" ], "summary": "Lookup the Alarm Type for the Monitoring Point.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AlarmType->Id | integer | int64 |\r\n| code | AlarmType->Code | string | |\r\n| description | AlarmType->Description | string | |\r\n", "operationId": "LookupMonitoringPointUpperCriticalAlarmType", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Alarm Type collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointUpperCriticalAlarmTypeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Lookups/LookupMonitoringPointUpperWarningAlarmType": { "get": { "tags": [ "Monitoring Point" ], "summary": "Lookup the Alarm Type for the Monitoring Point.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AlarmType->Id | integer | int64 |\r\n| code | AlarmType->Code | string | |\r\n| description | AlarmType->Description | string | |\r\n", "operationId": "LookupMonitoringPointUpperWarningAlarmType", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Alarm Type collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointUpperWarningAlarmTypeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Batch/{ids}": { "get": { "tags": [ "Monitoring Point" ], "summary": "Get a collection of Monitoring Point resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | MonitoringPoint->Code | string | |\r\n| isActive | MonitoringPoint->IsActive | boolean | |\r\n| createdByUserId | MonitoringPoint->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MonitoringPoint->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MonitoringPoint->CreatedByUser_FullName | string | |\r\n| createdOn | MonitoringPoint->CreatedOn | string | date-time |\r\n| modifiedByUserId | MonitoringPoint->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MonitoringPoint->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MonitoringPoint->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MonitoringPoint->ModifiedOn | string | date-time |\r\n| version | MonitoringPoint->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPoint->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MonitoringPoint->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MonitoringPoint->PermissionTree_Description | string | |\r\n| id | MonitoringPoint->Id | integer | int64 |\r\n| alarmCancellation | MonitoringPoint->AlarmCancellation | string (Allowed values: [None, Bounds, WorkOrder]) | enum |\r\n| assetId | MonitoringPoint->Asset_Id | integer | int64 |\r\n| assetCode | MonitoringPoint->Asset_Code | string | |\r\n| assetDescription | MonitoringPoint->Asset_Description | string | |\r\n| description | MonitoringPoint->Description | string | |\r\n| isCalculated | MonitoringPoint->IsCalculated | boolean | |\r\n| lowerCriticalAlarmTypeId | MonitoringPoint->LowerCriticalAlarmType_Id | integer | int64 |\r\n| lowerCriticalAlarmTypeDescription | MonitoringPoint->LowerCriticalAlarmType_Description | string | |\r\n| lowerCriticalAlarmTypeCode | MonitoringPoint->LowerCriticalAlarmType_Code | string | |\r\n| lowerCriticalBound | MonitoringPoint->LowerCriticalBound | number | decimal |\r\n| lowerCriticalSuppressesLowerWarning | MonitoringPoint->LowerCriticalSuppressesLowerWarning | boolean | |\r\n| lowerWarningAlarmTypeId | MonitoringPoint->LowerWarningAlarmType_Id | integer | int64 |\r\n| lowerWarningAlarmTypeDescription | MonitoringPoint->LowerWarningAlarmType_Description | string | |\r\n| lowerWarningAlarmTypeCode | MonitoringPoint->LowerWarningAlarmType_Code | string | |\r\n| lowerWarningBound | MonitoringPoint->LowerWarningBound | number | decimal |\r\n| monitoringPointTypeId | MonitoringPoint->MonitoringPointType_Id | integer | int64 |\r\n| monitoringPointTypeCode | MonitoringPoint->MonitoringPointType_Code | string | |\r\n| monitoringPointTypeDescription | MonitoringPoint->MonitoringPointType_Description | string | |\r\n| monitoringPointTypeHasLowerCriticalBound | MonitoringPoint->MonitoringPointType_HasLowerCriticalBound | boolean | |\r\n| monitoringPointTypeHasLowerWarningBound | MonitoringPoint->MonitoringPointType_HasLowerWarningBound | boolean | |\r\n| monitoringPointTypeHasUpperCriticalBound | MonitoringPoint->MonitoringPointType_HasUpperCriticalBound | boolean | |\r\n| monitoringPointTypeHasUpperWarningBound | MonitoringPoint->MonitoringPointType_HasUpperWarningBound | boolean | |\r\n| notes | MonitoringPoint->Notes | string | |\r\n| readingFormula | MonitoringPoint->ReadingFormula | string | |\r\n| sequenceNumber | MonitoringPoint->SequenceNumber | integer | int32 |\r\n| serialNumber | MonitoringPoint->SerialNumber | string | |\r\n| unitOfMeasurementId | MonitoringPoint->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | MonitoringPoint->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | MonitoringPoint->UnitOfMeasurement_Description | string | |\r\n| upperCriticalAlarmTypeId | MonitoringPoint->UpperCriticalAlarmType_Id | integer | int64 |\r\n| upperCriticalAlarmTypeDescription | MonitoringPoint->UpperCriticalAlarmType_Description | string | |\r\n| upperCriticalAlarmTypeCode | MonitoringPoint->UpperCriticalAlarmType_Code | string | |\r\n| upperCriticalBound | MonitoringPoint->UpperCriticalBound | number | decimal |\r\n| upperCriticalSuppressesUpperWarning | MonitoringPoint->UpperCriticalSuppressesUpperWarning | boolean | |\r\n| upperWarningAlarmTypeId | MonitoringPoint->UpperWarningAlarmType_Id | integer | int64 |\r\n| upperWarningAlarmTypeDescription | MonitoringPoint->UpperWarningAlarmType_Description | string | |\r\n| upperWarningAlarmTypeCode | MonitoringPoint->UpperWarningAlarmType_Code | string | |\r\n| upperWarningBound | MonitoringPoint->UpperWarningBound | number | decimal |\r\n", "operationId": "BatchGetMonitoringPoint", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Monitoring Point id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Monitoring Point collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetMonitoringPointResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Batch": { "post": { "tags": [ "Monitoring Point" ], "summary": "Create a new collection of Monitoring Point resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | MonitoringPoint->Code | string | |\r\n| description | MonitoringPoint->Description | string | |\r\n| permissionTreeId | MonitoringPoint->PermissionTree_Id | integer | int64 |\r\n| serialNumber | MonitoringPoint->SerialNumber | string | |\r\n| notes | MonitoringPoint->Notes | string | |\r\n| sequenceNumber | MonitoringPoint->SequenceNumber | integer | int32 |\r\n| serialNumber | MonitoringPoint->SerialNumber | string | |\r\n| alarmCancellation | MonitoringPoint->AlarmCancellation | string (Allowed values: [None, Bounds, WorkOrder]) | enum |\r\n| upperCriticalSuppressesUpperWarning | MonitoringPoint->UpperCriticalSuppressesUpperWarning | boolean | |\r\n| lowerCriticalSuppressesLowerWarning | MonitoringPoint->LowerCriticalSuppressesLowerWarning | boolean | |\r\n| upperCriticalBound | MonitoringPoint->UpperCriticalBound | number | decimal |\r\n| upperWarningBound | MonitoringPoint->UpperWarningBound | number | decimal |\r\n| lowerCriticalBound | MonitoringPoint->LowerCriticalBound | number | decimal |\r\n| lowerWarningBound | MonitoringPoint->LowerWarningBound | number | decimal |\r\n| isCalculated | MonitoringPoint->IsCalculated | boolean | |\r\n| readingFormula | MonitoringPoint->ReadingFormula | string | |\r\n| assetId | MonitoringPoint->Asset_Id | integer | int64 |\r\n| monitoringPointTypeId | MonitoringPoint->MonitoringPointType_Id | integer | int64 |\r\n| upperCriticalAlarmTypeId | MonitoringPoint->UpperCriticalAlarmType_Id | integer | int64 |\r\n| upperWarningAlarmTypeId | MonitoringPoint->UpperWarningAlarmType_Id | integer | int64 |\r\n| lowerWarningAlarmTypeId | MonitoringPoint->LowerWarningAlarmType_Id | integer | int64 |\r\n| lowerCriticalAlarmTypeId | MonitoringPoint->LowerCriticalAlarmType_Id | integer | int64 |\r\n| unitOfMeasurementId | MonitoringPoint->UnitOfMeasurement_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| code | System Generated | true | If no value specified |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | System Generated | true | If no value specified |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| alarmCancellation | Nullable | False | |\r\n| upperCriticalSuppressesUpperWarning | Nullable | False | |\r\n| lowerCriticalSuppressesLowerWarning | Nullable | False | |\r\n| isCalculated | Nullable | False | |\r\n| readingFormula | Nullable | True | MonitoringPoint->IsCalculated eq FALSE |\r\n| readingFormula | Nullable | False | MonitoringPoint->IsCalculated eq TRUE |\r\n| monitoringPointTypeId | Required | True | |\r\n| monitoringPointTypeId | Nullable | False | |\r\n| unitOfMeasurementId | System Generated | true | If no value specified |\r\n| unitOfMeasurementId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateMonitoringPoint", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateMonitoringPointResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Monitoring Point batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Monitoring Point" ], "summary": "Update a collection of existing Monitoring Point resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPoint->Id | integer | int64 |\r\n| version | MonitoringPoint->Version | integer | int32 |\r\n| code | MonitoringPoint->Code | string | |\r\n| description | MonitoringPoint->Description | string | |\r\n| serialNumber | MonitoringPoint->SerialNumber | string | |\r\n| notes | MonitoringPoint->Notes | string | |\r\n| sequenceNumber | MonitoringPoint->SequenceNumber | integer | int32 |\r\n| isCalculated | MonitoringPoint->IsCalculated | boolean | |\r\n| readingFormula | MonitoringPoint->ReadingFormula | string | |\r\n| serialNumber | MonitoringPoint->SerialNumber | string | |\r\n| alarmCancellation | MonitoringPoint->AlarmCancellation | string (Allowed values: [None, Bounds, WorkOrder]) | enum |\r\n| upperCriticalSuppressesUpperWarning | MonitoringPoint->UpperCriticalSuppressesUpperWarning | boolean | |\r\n| lowerCriticalSuppressesLowerWarning | MonitoringPoint->LowerCriticalSuppressesLowerWarning | boolean | |\r\n| upperCriticalBound | MonitoringPoint->UpperCriticalBound | number | decimal |\r\n| upperWarningBound | MonitoringPoint->UpperWarningBound | number | decimal |\r\n| lowerCriticalBound | MonitoringPoint->LowerCriticalBound | number | decimal |\r\n| lowerWarningBound | MonitoringPoint->LowerWarningBound | number | decimal |\r\n| assetId | MonitoringPoint->Asset_Id | integer | int64 |\r\n| monitoringPointTypeId | MonitoringPoint->MonitoringPointType_Id | integer | int64 |\r\n| upperCriticalAlarmTypeId | MonitoringPoint->UpperCriticalAlarmType_Id | integer | int64 |\r\n| upperWarningAlarmTypeId | MonitoringPoint->UpperWarningAlarmType_Id | integer | int64 |\r\n| lowerWarningAlarmTypeId | MonitoringPoint->LowerWarningAlarmType_Id | integer | int64 |\r\n| lowerCriticalAlarmTypeId | MonitoringPoint->LowerCriticalAlarmType_Id | integer | int64 |\r\n| unitOfMeasurementId | MonitoringPoint->UnitOfMeasurement_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| isCalculated | Nullable | False | |\r\n| readingFormula | Nullable | True | MonitoringPoint->IsCalculated eq FALSE |\r\n| readingFormula | Nullable | False | MonitoringPoint->IsCalculated eq TRUE |\r\n| alarmCancellation | Nullable | False | |\r\n| upperCriticalSuppressesUpperWarning | Nullable | False | |\r\n| lowerCriticalSuppressesLowerWarning | Nullable | False | |\r\n| monitoringPointTypeId | Nullable | False | |\r\n| unitOfMeasurementId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateMonitoringPoint", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateMonitoringPointResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Monitoring Point batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Monitoring Point" ], "summary": "Delete a collection of existing Monitoring Point resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPoint->Id | integer | int64 |\r\n| version | MonitoringPoint->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteMonitoringPoint", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteMonitoringPointResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Monitoring Point batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/{id}/Active": { "patch": { "tags": [ "Monitoring Point" ], "summary": "Change the IsActive status for an existing Monitoring Point resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPoint->Version | integer | int32 |\r\n| isActive | MonitoringPoint->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeMonitoringPointIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeMonitoringPointIsActiveResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/{id}/PermissionTree": { "patch": { "tags": [ "Monitoring Point" ], "summary": "Change the PermissionTree for an existing Monitoring Point resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPoint->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPoint->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeMonitoringPointPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeMonitoringPointPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Batch/Active": { "patch": { "tags": [ "Monitoring Point" ], "summary": "Change the IsActive status for a collection of existing Monitoring Point resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPoint->Id | integer | int64 |\r\n| version | MonitoringPoint->Version | integer | int32 |\r\n| isActive | MonitoringPoint->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeMonitoringPointIsActive", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeMonitoringPointIsActiveResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Batch/PermissionTree": { "patch": { "tags": [ "Monitoring Point" ], "summary": "Change the PermissionTree status for a collection of existing Monitoring Point resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPoint->Id | integer | int64 |\r\n| version | MonitoringPoint->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPoint->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeMonitoringPointPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeMonitoringPointPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Attributes/{id}": { "get": { "tags": [ "Monitoring Point Attribute" ], "summary": "Get a Monitoring Point Attribute resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| monitoringPointId | MonitoringPointAttribute->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | MonitoringPointAttribute->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | MonitoringPointAttribute->MonitoringPoint_Description | string | |\r\n| createdByUserId | MonitoringPointAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MonitoringPointAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MonitoringPointAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | MonitoringPointAttribute->CreatedOn | string | date-time |\r\n| isActive | MonitoringPointAttribute->IsActive | boolean | |\r\n| modifiedByUserId | MonitoringPointAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MonitoringPointAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MonitoringPointAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MonitoringPointAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | MonitoringPointAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MonitoringPointAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MonitoringPointAttribute->PermissionTree_Description | string | |\r\n| version | MonitoringPointAttribute->Version | integer | int32 |\r\n| id | MonitoringPointAttribute->Id | integer | int64 |\r\n| attributeId | MonitoringPointAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | MonitoringPointAttribute->Attribute_Code | string | |\r\n| attributeDescription | MonitoringPointAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | MonitoringPointAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | MonitoringPointAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | MonitoringPointAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | MonitoringPointAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | MonitoringPointAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | MonitoringPointAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | MonitoringPointAttribute->Notes | string | |\r\n| predefinedValueId | MonitoringPointAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | MonitoringPointAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | MonitoringPointAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | MonitoringPointAttribute->SequenceNumber | integer | int32 |\r\n| value | MonitoringPointAttribute->Value | object | composite |\r\n", "operationId": "GetMonitoringPointAttribute", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Monitoring Point Attribute", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointAttributeResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Monitoring Point Attribute" ], "summary": "Update an existing Monitoring Point Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointAttribute->Version | integer | int32 |\r\n| value | MonitoringPointAttribute->Value | object | composite |\r\n| predefinedValueId | MonitoringPointAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | MonitoringPointAttribute->SequenceNumber | integer | int32 |\r\n| notes | MonitoringPointAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n\r\n", "operationId": "UpdateMonitoringPointAttribute", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateMonitoringPointAttributeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Monitoring Point Attribute was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Monitoring Point Attribute" ], "summary": "Delete an existing Monitoring Point Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointAttribute->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteMonitoringPointAttribute", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteMonitoringPointAttributeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Monitoring Point Attribute was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/{monitoringPointId}/Attributes": { "get": { "tags": [ "Monitoring Point Attribute" ], "summary": "Get a collection of Monitoring Point Attribute resources for the Monitoring Point.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointAttribute->Id | integer | int64 |\r\n| version | MonitoringPointAttribute->Version | integer | int32 |\r\n| sequenceNumber | MonitoringPointAttribute->SequenceNumber | integer | int32 |\r\n| attributeId | MonitoringPointAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | MonitoringPointAttribute->Attribute_Code | string | |\r\n| attributeDescription | MonitoringPointAttribute->Attribute_Description | string | |\r\n| attributeDataType | MonitoringPointAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | MonitoringPointAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | MonitoringPointAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | MonitoringPointAttribute->PredefinedValue_Value | object | composite |\r\n| value | MonitoringPointAttribute->Value | object | composite |\r\n| notes | MonitoringPointAttribute->Notes | string | |\r\n| createdOn | MonitoringPointAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | MonitoringPointAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetMonitoringPointAttributeCollectionForMonitoringPoint", "parameters": [ { "name": "monitoringPointId", "in": "path", "required": true, "description": "Monitoring Point Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point Attribute collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointAttributeCollectionForMonitoringPointResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Attributes": { "get": { "tags": [ "Monitoring Point Attribute" ], "summary": "Get a collection of Monitoring Point Attribute resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointAttribute->Id | integer | int64 |\r\n| version | MonitoringPointAttribute->Version | integer | int32 |\r\n| monitoringPointId | MonitoringPointAttribute->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | MonitoringPointAttribute->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | MonitoringPointAttribute->MonitoringPoint_Description | string | |\r\n| sequenceNumber | MonitoringPointAttribute->SequenceNumber | integer | int32 |\r\n| attributeId | MonitoringPointAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | MonitoringPointAttribute->Attribute_Code | string | |\r\n| attributeDescription | MonitoringPointAttribute->Attribute_Description | string | |\r\n| attributeDataType | MonitoringPointAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | MonitoringPointAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | MonitoringPointAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | MonitoringPointAttribute->PredefinedValue_Value | object | composite |\r\n| value | MonitoringPointAttribute->Value | object | composite |\r\n| notes | MonitoringPointAttribute->Notes | string | |\r\n| createdOn | MonitoringPointAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | MonitoringPointAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetMonitoringPointAttributeCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point Attribute collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointAttributeCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Monitoring Point Attribute" ], "summary": "Create a new Monitoring Point Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| monitoringPointId | MonitoringPointAttribute->MonitoringPoint_Id | integer | int64 |\r\n| attributeId | MonitoringPointAttribute->Attribute_Id | integer | int64 |\r\n| value | MonitoringPointAttribute->Value | object | composite |\r\n| predefinedValueId | MonitoringPointAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | MonitoringPointAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | MonitoringPointAttribute->SequenceNumber | integer | int32 |\r\n| notes | MonitoringPointAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| monitoringPointId | Required | True | |\r\n| monitoringPointId | Nullable | False | |\r\n| attributeId | Required | True | |\r\n| attributeId | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateMonitoringPointAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateMonitoringPointAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Attributes/Lookups/LookupMonitoringPointAttributeAllowedValue": { "get": { "tags": [ "Monitoring Point Attribute" ], "summary": "Lookup the Attribute Allowed Value for the Monitoring Point Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AttributeAllowedValue->Id | integer | int64 |\r\n| description | AttributeAllowedValue->Description | string | |\r\n| value | AttributeAllowedValue->Value | object | composite |\r\n", "operationId": "LookupMonitoringPointAttributeAllowedValue", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Attribute Allowed Value collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointAttributeAttributeAllowedValueLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Attributes/Lookups/LookupMonitoringPointAttribute": { "get": { "tags": [ "Monitoring Point Attribute" ], "summary": "Monitoring Point Attribute", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Attribute->Id | integer | int64 |\r\n| code | Attribute->Code | string | |\r\n| description | Attribute->Description | string | |\r\n| allowAnyValue | Attribute->AllowAnyValue | boolean | |\r\n| dataType | Attribute->DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| defaultValue | Attribute->DefaultValue | object | composite |\r\n| defaultAllowedValueId | Attribute->DefaultAllowedValue_Id | integer | int64 |\r\n| defaultAllowedValueValue | Attribute->DefaultAllowedValue_Value | object | composite |\r\n| defaultAllowedValueDescription | Attribute->DefaultAllowedValue_Description | string | |\r\n| explanation | Attribute->Explanation | string | |\r\n", "operationId": "LookupMonitoringPointAttribute", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Attribute collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointAttributeAttributeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Attributes/Lookups/LookupMonitoringPointAttributeChangePermissionTree": { "get": { "tags": [ "Monitoring Point Attribute" ], "summary": "Lookup the permission set for changing the Monitoring Point Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupMonitoringPointAttributeChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointAttributeChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Attributes/Lookups/LookupMonitoringPointAttributeInsertPermissionTree": { "get": { "tags": [ "Monitoring Point Attribute" ], "summary": "Lookup the permission set for creating the Monitoring Point Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupMonitoringPointAttributeInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointAttributeInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Attributes/Lookups/LookupMonitoringPointAttributeMonitoringPoint": { "get": { "tags": [ "Monitoring Point Attribute" ], "summary": "Lookup the Monitoring Point Attribute for the Monitoring Point Attribute.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPoint->Id | integer | int64 |\r\n| code | MonitoringPoint->Code | string | |\r\n| description | MonitoringPoint->Description | string | |\r\n", "operationId": "LookupMonitoringPointAttributeMonitoringPoint", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointAttributeMonitoringPointLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Attributes/Batch/{ids}": { "get": { "tags": [ "Monitoring Point Attribute" ], "summary": "Get a collection of Monitoring Point Attribute resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| monitoringPointId | MonitoringPointAttribute->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | MonitoringPointAttribute->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | MonitoringPointAttribute->MonitoringPoint_Description | string | |\r\n| createdByUserId | MonitoringPointAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MonitoringPointAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MonitoringPointAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | MonitoringPointAttribute->CreatedOn | string | date-time |\r\n| isActive | MonitoringPointAttribute->IsActive | boolean | |\r\n| modifiedByUserId | MonitoringPointAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MonitoringPointAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MonitoringPointAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MonitoringPointAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | MonitoringPointAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MonitoringPointAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MonitoringPointAttribute->PermissionTree_Description | string | |\r\n| version | MonitoringPointAttribute->Version | integer | int32 |\r\n| id | MonitoringPointAttribute->Id | integer | int64 |\r\n| attributeId | MonitoringPointAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | MonitoringPointAttribute->Attribute_Code | string | |\r\n| attributeDescription | MonitoringPointAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | MonitoringPointAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | MonitoringPointAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | MonitoringPointAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | MonitoringPointAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | MonitoringPointAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | MonitoringPointAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | MonitoringPointAttribute->Notes | string | |\r\n| predefinedValueId | MonitoringPointAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | MonitoringPointAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | MonitoringPointAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | MonitoringPointAttribute->SequenceNumber | integer | int32 |\r\n| value | MonitoringPointAttribute->Value | object | composite |\r\n", "operationId": "BatchGetMonitoringPointAttribute", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Monitoring Point Attribute id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Monitoring Point Attribute collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetMonitoringPointAttributeResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Attributes/Batch": { "post": { "tags": [ "Monitoring Point Attribute" ], "summary": "Create a new collection of Monitoring Point Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| monitoringPointId | MonitoringPointAttribute->MonitoringPoint_Id | integer | int64 |\r\n| attributeId | MonitoringPointAttribute->Attribute_Id | integer | int64 |\r\n| value | MonitoringPointAttribute->Value | object | composite |\r\n| predefinedValueId | MonitoringPointAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | MonitoringPointAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | MonitoringPointAttribute->SequenceNumber | integer | int32 |\r\n| notes | MonitoringPointAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| monitoringPointId | Required | True | |\r\n| monitoringPointId | Nullable | False | |\r\n| attributeId | Required | True | |\r\n| attributeId | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateMonitoringPointAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateMonitoringPointAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Monitoring Point Attribute batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Monitoring Point Attribute" ], "summary": "Update a collection of existing Monitoring Point Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointAttribute->Id | integer | int64 |\r\n| version | MonitoringPointAttribute->Version | integer | int32 |\r\n| value | MonitoringPointAttribute->Value | object | composite |\r\n| predefinedValueId | MonitoringPointAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | MonitoringPointAttribute->SequenceNumber | integer | int32 |\r\n| notes | MonitoringPointAttribute->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| value | Nullable | True | |\r\n| predefinedValueId | Nullable | True | |\r\n\r\n", "operationId": "BatchUpdateMonitoringPointAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateMonitoringPointAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Monitoring Point Attribute batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Monitoring Point Attribute" ], "summary": "Delete a collection of existing Monitoring Point Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointAttribute->Id | integer | int64 |\r\n| version | MonitoringPointAttribute->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteMonitoringPointAttribute", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteMonitoringPointAttributeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Monitoring Point Attribute batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Attributes/{id}/Active": { "patch": { "tags": [ "Monitoring Point Attribute" ], "summary": "Change the IsActive status for an existing Monitoring Point Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointAttribute->Version | integer | int32 |\r\n| isActive | MonitoringPointAttribute->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeMonitoringPointAttributeIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeMonitoringPointAttributeIsActiveResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Attributes/{id}/PermissionTree": { "patch": { "tags": [ "Monitoring Point Attribute" ], "summary": "Change the PermissionTree for an existing Monitoring Point Attribute resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointAttribute->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointAttribute->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeMonitoringPointAttributePermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Attribute Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeMonitoringPointAttributePermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Attributes/Batch/PermissionTree": { "patch": { "tags": [ "Monitoring Point Attribute" ], "summary": "Change the PermissionTree status for a collection of existing Monitoring Point Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointAttribute->Id | integer | int64 |\r\n| version | MonitoringPointAttribute->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointAttribute->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeMonitoringPointAttributePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeMonitoringPointAttributePermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Attributes/Batch/Active": { "patch": { "tags": [ "Monitoring Point Attribute" ], "summary": "Change the IsActive status for a collection of existing Monitoring Point Attribute resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointAttribute->Id | integer | int64 |\r\n| version | MonitoringPointAttribute->Version | integer | int32 |\r\n| isActive | MonitoringPointAttribute->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeMonitoringPointAttributeIsActive", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeMonitoringPointAttributeIsActiveResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Logs": { "get": { "tags": [ "Monitoring Point Bound Evaluation Log" ], "summary": "Get a collection of Monitoring Point Bound Evaluation Log resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointBoundEvaluationLog->Id | integer | int64 |\r\n| monitoringPointId | MonitoringPointBoundEvaluationLog->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | MonitoringPointBoundEvaluationLog->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | MonitoringPointBoundEvaluationLog->MonitoringPoint_Description | string | |\r\n| executedOn | MonitoringPointBoundEvaluationLog->ExecutedOn | string | date-time |\r\n| processStatus | MonitoringPointBoundEvaluationLog->ProcessStatus | string (Allowed values: [AllBoundsEliminated, NoAlarmType, ProcessBounds]) | enum |\r\n| executionStatus | MonitoringPointBoundEvaluationLog->ExecutionStatus | string (Allowed values: [SkipExecution, Executed, UnhandledException, ConfigurationException, Resubmitted]) | enum |\r\n| executionType | MonitoringPointBoundEvaluationLog->ExecutionType | string (Allowed values: [Lower, Upper]) | enum |\r\n| warningTriggered | MonitoringPointBoundEvaluationLog->WarningTriggered | boolean | |\r\n| criticalTriggered | MonitoringPointBoundEvaluationLog->CriticalTriggered | boolean | |\r\n| alarmsGenerated | MonitoringPointBoundEvaluationLog->AlarmsGenerated | array | array |\r\n| notification | MonitoringPointBoundEvaluationLog->Notification | object | |\r\n", "operationId": "GetMonitoringPointBoundEvaluationCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point Bound Evaluation Log collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointTriggerExpressionEvaluationCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Logs/Failures": { "get": { "tags": [ "Monitoring Point Bound Evaluation Log" ], "summary": "Get a collection of Monitoring Point Bound Evaluation Log resource failures.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointBoundEvaluationLog->Id | integer | int64 |\r\n| monitoringPointId | MonitoringPointBoundEvaluationLog->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | MonitoringPointBoundEvaluationLog->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | MonitoringPointBoundEvaluationLog->MonitoringPoint_Description | string | |\r\n| executedOn | MonitoringPointBoundEvaluationLog->ExecutedOn | string | date-time |\r\n| processStatus | MonitoringPointBoundEvaluationLog->ProcessStatus | string (Allowed values: [AllBoundsEliminated, NoAlarmType, ProcessBounds]) | enum |\r\n| executionStatus | MonitoringPointBoundEvaluationLog->ExecutionStatus | string (Allowed values: [SkipExecution, Executed, UnhandledException, ConfigurationException, Resubmitted]) | enum |\r\n| notification | MonitoringPointBoundEvaluationLog->Notification | object | |\r\n", "operationId": "GetMonitoringPointBoundEvaluationFailuresCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point Bound Evaluation Log collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointTriggerExpressionEvaluationFailuresCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Logs/Resubmit": { "post": { "tags": [ "Monitoring Point Bound Evaluation Log" ], "summary": "Resubmit a failed Monitoring Point Bound Evaluation Log resource", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| evaluationIds | ResubmitEvaluation->EvaluationIds | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| evaluationIds | Required | True | |\r\n| evaluationIds | Nullable | False | |\r\n\r\n", "operationId": "ResubmitMonitoringPointBoundEvaluation", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/ResubmitMonitoringPointTriggerExpressionEvaluationResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Documents/{id}": { "get": { "tags": [ "Monitoring Point Document" ], "summary": "Get a Monitoring Point Document resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| monitoringPointId | MonitoringPointDocument->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | MonitoringPointDocument->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | MonitoringPointDocument->MonitoringPoint_Description | string | |\r\n| isActive | MonitoringPointDocument->IsActive | boolean | |\r\n| createdByUserId | MonitoringPointDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MonitoringPointDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MonitoringPointDocument->CreatedByUser_FullName | string | |\r\n| createdOn | MonitoringPointDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | MonitoringPointDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MonitoringPointDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MonitoringPointDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MonitoringPointDocument->ModifiedOn | string | date-time |\r\n| version | MonitoringPointDocument->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MonitoringPointDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MonitoringPointDocument->PermissionTree_Description | string | |\r\n| id | MonitoringPointDocument->Id | integer | int64 |\r\n| documentRecordId | MonitoringPointDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | MonitoringPointDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | MonitoringPointDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | MonitoringPointDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | MonitoringPointDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | MonitoringPointDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | MonitoringPointDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | MonitoringPointDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | MonitoringPointDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | MonitoringPointDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | MonitoringPointDocument->Notes | string | |\r\n| sequenceNumber | MonitoringPointDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "GetMonitoringPointDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Monitoring Point Document", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointDocumentResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Monitoring Point Document" ], "summary": "Update an existing Monitoring Point Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointDocument->Version | integer | int32 |\r\n| sequenceNumber | MonitoringPointDocument->SequenceNumber | integer | int32 |\r\n| notes | MonitoringPointDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "UpdateMonitoringPointDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateMonitoringPointDocumentResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Monitoring Point Document was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Monitoring Point Document" ], "summary": "Delete an existing Monitoring Point Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointDocument->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteMonitoringPointDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteMonitoringPointDocumentResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Monitoring Point Document was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/{id}/Documents": { "get": { "tags": [ "Monitoring Point Document" ], "summary": "Get a collection of Monitoring Point Document resources for the Monitoring Point.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointDocument->Id | integer | int64 |\r\n| version | MonitoringPointDocument->Version | integer | int32 |\r\n| sequenceNumber | MonitoringPointDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | MonitoringPointDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | MonitoringPointDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | MonitoringPointDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | MonitoringPointDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | MonitoringPointDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | MonitoringPointDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | MonitoringPointDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetMonitoringPointDocumentCollectionForMonitoringPoint", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point Document collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointDocumentCollectionForMonitoringPointResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Documents": { "get": { "tags": [ "Monitoring Point Document" ], "summary": "Get a collection of Monitoring Point Document resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointDocument->Id | integer | int64 |\r\n| version | MonitoringPointDocument->Version | integer | int32 |\r\n| monitoringPointId | MonitoringPointDocument->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | MonitoringPointDocument->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | MonitoringPointDocument->MonitoringPoint_Description | string | |\r\n| sequenceNumber | MonitoringPointDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | MonitoringPointDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | MonitoringPointDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | MonitoringPointDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | MonitoringPointDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | MonitoringPointDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | MonitoringPointDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | MonitoringPointDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetMonitoringPointDocumentCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point Document collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointDocumentCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Monitoring Point Document" ], "summary": "Create a new Monitoring Point Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| monitoringPointId | MonitoringPointDocument->MonitoringPoint_Id | integer | int64 |\r\n| documentRecordId | MonitoringPointDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | MonitoringPointDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | MonitoringPointDocument->SequenceNumber | integer | int32 |\r\n| notes | MonitoringPointDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| monitoringPointId | Required | True | |\r\n| monitoringPointId | Nullable | False | |\r\n| documentRecordId | Required | True | |\r\n| documentRecordId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateMonitoringPointDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateMonitoringPointDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Documents/Lookups/LookupMonitoringPointDocumentChangePermissionTree": { "get": { "tags": [ "Monitoring Point Document" ], "summary": "Lookup the permission set for changing the Monitoring Point Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupMonitoringPointDocumentChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointDocumentChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Documents/Lookups/LookupMonitoringPointDocument": { "get": { "tags": [ "Monitoring Point Document" ], "summary": "Monitoring Point Document", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | DocumentRecord->Id | integer | int64 |\r\n| code | DocumentRecord->Code | string | |\r\n| description | DocumentRecord->Description | string | |\r\n| fileLocation | DocumentRecord->FileLocation | string | |\r\n| fileFullName | DocumentRecord->FileFullName | string | |\r\n", "operationId": "LookupMonitoringPointDocument", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Document Record collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointDocumentDocumentLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Documents/Lookups/LookupMonitoringPointDocumentInsertPermissionTree": { "get": { "tags": [ "Monitoring Point Document" ], "summary": "Lookup the permission set for creating the Monitoring Point Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupMonitoringPointDocumentInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointDocumentInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Documents/Lookups/LookupMonitoringPointDocumentMonitoringPoint": { "get": { "tags": [ "Monitoring Point Document" ], "summary": "Lookup the Monitoring Point Document for the Monitoring Point Document.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPoint->Id | integer | int64 |\r\n| code | MonitoringPoint->Code | string | |\r\n| description | MonitoringPoint->Description | string | |\r\n", "operationId": "LookupMonitoringPointDocumentMonitoringPoint", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointDocumentMonitoringPointLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Documents/Batch/{ids}": { "get": { "tags": [ "Monitoring Point Document" ], "summary": "Get a collection of Monitoring Point Document resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| monitoringPointId | MonitoringPointDocument->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | MonitoringPointDocument->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | MonitoringPointDocument->MonitoringPoint_Description | string | |\r\n| isActive | MonitoringPointDocument->IsActive | boolean | |\r\n| createdByUserId | MonitoringPointDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MonitoringPointDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MonitoringPointDocument->CreatedByUser_FullName | string | |\r\n| createdOn | MonitoringPointDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | MonitoringPointDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MonitoringPointDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MonitoringPointDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MonitoringPointDocument->ModifiedOn | string | date-time |\r\n| version | MonitoringPointDocument->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MonitoringPointDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MonitoringPointDocument->PermissionTree_Description | string | |\r\n| id | MonitoringPointDocument->Id | integer | int64 |\r\n| documentRecordId | MonitoringPointDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | MonitoringPointDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | MonitoringPointDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | MonitoringPointDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | MonitoringPointDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | MonitoringPointDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | MonitoringPointDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | MonitoringPointDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | MonitoringPointDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | MonitoringPointDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | MonitoringPointDocument->Notes | string | |\r\n| sequenceNumber | MonitoringPointDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetMonitoringPointDocument", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Monitoring Point Document id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Monitoring Point Document collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetMonitoringPointDocumentResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Documents/Batch": { "post": { "tags": [ "Monitoring Point Document" ], "summary": "Create a new collection of Monitoring Point Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| monitoringPointId | MonitoringPointDocument->MonitoringPoint_Id | integer | int64 |\r\n| documentRecordId | MonitoringPointDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | MonitoringPointDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | MonitoringPointDocument->SequenceNumber | integer | int32 |\r\n| notes | MonitoringPointDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| monitoringPointId | Required | True | |\r\n| monitoringPointId | Nullable | False | |\r\n| documentRecordId | Required | True | |\r\n| documentRecordId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateMonitoringPointDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateMonitoringPointDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Monitoring Point Document batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Monitoring Point Document" ], "summary": "Update a collection of existing Monitoring Point Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointDocument->Id | integer | int64 |\r\n| version | MonitoringPointDocument->Version | integer | int32 |\r\n| sequenceNumber | MonitoringPointDocument->SequenceNumber | integer | int32 |\r\n| notes | MonitoringPointDocument->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateMonitoringPointDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateMonitoringPointDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Monitoring Point Document batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Monitoring Point Document" ], "summary": "Delete a collection of existing Monitoring Point Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointDocument->Id | integer | int64 |\r\n| version | MonitoringPointDocument->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteMonitoringPointDocument", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteMonitoringPointDocumentResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Monitoring Point Document batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Documents/{id}/Active": { "patch": { "tags": [ "Monitoring Point Document" ], "summary": "Change the IsActive status for an existing Monitoring Point Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointDocument->Version | integer | int32 |\r\n| isActive | MonitoringPointDocument->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeMonitoringPointDocumentIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeMonitoringPointDocumentIsActiveResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Documents/{id}/PermissionTree": { "patch": { "tags": [ "Monitoring Point Document" ], "summary": "Change the PermissionTree for an existing Monitoring Point Document resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointDocument->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointDocument->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeMonitoringPointDocumentPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Document Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeMonitoringPointDocumentPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Documents/Batch/PermissionTree": { "patch": { "tags": [ "Monitoring Point Document" ], "summary": "Change the PermissionTree status for a collection of existing Monitoring Point Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointDocument->Id | integer | int64 |\r\n| version | MonitoringPointDocument->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointDocument->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeMonitoringPointDocumentPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeMonitoringPointDocumentPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Documents/Batch/Active": { "patch": { "tags": [ "Monitoring Point Document" ], "summary": "Change the IsActive status for a collection of existing Monitoring Point Document resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointDocument->Id | integer | int64 |\r\n| version | MonitoringPointDocument->Version | integer | int32 |\r\n| isActive | MonitoringPointDocument->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeMonitoringPointDocumentIsActive", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeMonitoringPointDocumentIsActiveResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Parameters/{id}": { "get": { "tags": [ "Monitoring Point Parameter" ], "summary": "Get a Monitoring Point Parameter resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| isActive | MonitoringPointParameter->IsActive | boolean | |\r\n| createdByUserId | MonitoringPointParameter->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MonitoringPointParameter->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MonitoringPointParameter->CreatedByUser_FullName | string | |\r\n| createdOn | MonitoringPointParameter->CreatedOn | string | date-time |\r\n| modifiedByUserId | MonitoringPointParameter->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MonitoringPointParameter->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MonitoringPointParameter->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MonitoringPointParameter->ModifiedOn | string | date-time |\r\n| version | MonitoringPointParameter->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointParameter->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MonitoringPointParameter->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MonitoringPointParameter->PermissionTree_Description | string | |\r\n| id | MonitoringPointParameter->Id | integer | int64 |\r\n| monitoringPointId | MonitoringPointParameter->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | MonitoringPointParameter->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | MonitoringPointParameter->MonitoringPoint_Description | string | |\r\n| parameterName | MonitoringPointParameter->ParameterName | string | |\r\n| parameterValue | MonitoringPointParameter->ParameterValue | string | |\r\n", "operationId": "GetMonitoringPointParameter", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Parameter Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Monitoring Point Parameter", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointParameterResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Monitoring Point Parameter" ], "summary": "Update an existing Monitoring Point Parameter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointParameter->Version | integer | int32 |\r\n| parameterName | MonitoringPointParameter->ParameterName | string | |\r\n| parameterValue | MonitoringPointParameter->ParameterValue | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| parameterName | Nullable | False | |\r\n| parameterName | Min Length | >= 1 chars| |\r\n| parameterName | Max Length | <= 50 chars| |\r\n| parameterValue | Nullable | False | |\r\n| parameterValue | Min Length | >= 1 chars| |\r\n| parameterValue | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "UpdateMonitoringPointParameter", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Parameter Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateMonitoringPointParameterResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Monitoring Point Parameter was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Monitoring Point Parameter" ], "summary": "Delete an existing Monitoring Point Parameter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointParameter->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteMonitoringPointParameter", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Parameter Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteMonitoringPointParameterResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Monitoring Point Parameter was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Parameters": { "get": { "tags": [ "Monitoring Point Parameter" ], "summary": "Get a collection of Monitoring Point Parameter resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointParameter->Id | integer | int64 |\r\n| version | MonitoringPointParameter->Version | integer | int32 |\r\n| parameterName | MonitoringPointParameter->ParameterName | string | |\r\n| parameterValue | MonitoringPointParameter->ParameterValue | string | |\r\n| monitoringPointId | MonitoringPointParameter->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | MonitoringPointParameter->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | MonitoringPointParameter->MonitoringPoint_Description | string | |\r\n| createdOn | MonitoringPointParameter->CreatedOn | string | date-time |\r\n| modifiedOn | MonitoringPointParameter->ModifiedOn | string | date-time |\r\n", "operationId": "GetMonitoringPointParameterCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point Parameter collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointParameterCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Monitoring Point Parameter" ], "summary": "Create a new Monitoring Point Parameter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| parameterName | MonitoringPointParameter->ParameterName | string | |\r\n| parameterValue | MonitoringPointParameter->ParameterValue | string | |\r\n| permissionTreeId | MonitoringPointParameter->PermissionTree_Id | integer | int64 |\r\n| monitoringPointId | MonitoringPointParameter->MonitoringPoint_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| parameterName | Required | True | |\r\n| parameterName | Nullable | False | |\r\n| parameterName | Min Length | >= 1 chars| |\r\n| parameterName | Max Length | <= 50 chars| |\r\n| parameterValue | Required | True | |\r\n| parameterValue | Nullable | False | |\r\n| parameterValue | Min Length | >= 1 chars| |\r\n| parameterValue | Max Length | <= 100 chars| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| monitoringPointId | Required | True | |\r\n| monitoringPointId | Nullable | False | |\r\n\r\n", "operationId": "CreateMonitoringPointParameter", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateMonitoringPointParameterResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/{monitoringPointId}/Parameters": { "get": { "tags": [ "Monitoring Point Parameter" ], "summary": "Get a collection of Monitoring Point Parameter resources for the Monitoring Point.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointParameter->Id | integer | int64 |\r\n| version | MonitoringPointParameter->Version | integer | int32 |\r\n| parameterName | MonitoringPointParameter->ParameterName | string | |\r\n| parameterValue | MonitoringPointParameter->ParameterValue | string | |\r\n| createdOn | MonitoringPointParameter->CreatedOn | string | date-time |\r\n| modifiedOn | MonitoringPointParameter->ModifiedOn | string | date-time |\r\n", "operationId": "GetMonitoringPointParameterForMonitoringPointCollection", "parameters": [ { "name": "monitoringPointId", "in": "path", "required": true, "description": "Monitoring Point Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point Parameter collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointParameterForMonitoringPointCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Parameters/Lookups/LookupMonitoringPointParameterChangePermissionTree": { "get": { "tags": [ "Monitoring Point Parameter" ], "summary": "Lookup the permission set for changing the Monitoring Point Parameter.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupMonitoringPointParameterChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointParameterChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Parameters/Lookups/LookupMonitoringPointParameterInsertPermissionTree": { "get": { "tags": [ "Monitoring Point Parameter" ], "summary": "Lookup the permission set for creating the Monitoring Point Parameter.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupMonitoringPointParameterInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointParameterInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Parameters/Lookups/LookupMonitoringPointParameterMonitoringPoint": { "get": { "tags": [ "Monitoring Point Parameter" ], "summary": "Lookup the Monitoring Point for the Monitoring Point Parameter.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPoint->Id | integer | int64 |\r\n| code | MonitoringPoint->Code | string | |\r\n| description | MonitoringPoint->Description | string | |\r\n", "operationId": "LookupMonitoringPointParameterMonitoringPoint", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointParameterMonitoringPointLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Parameters/Batch/{ids}": { "get": { "tags": [ "Monitoring Point Parameter" ], "summary": "Get a collection of Monitoring Point Parameter resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| isActive | MonitoringPointParameter->IsActive | boolean | |\r\n| createdByUserId | MonitoringPointParameter->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MonitoringPointParameter->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MonitoringPointParameter->CreatedByUser_FullName | string | |\r\n| createdOn | MonitoringPointParameter->CreatedOn | string | date-time |\r\n| modifiedByUserId | MonitoringPointParameter->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MonitoringPointParameter->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MonitoringPointParameter->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MonitoringPointParameter->ModifiedOn | string | date-time |\r\n| version | MonitoringPointParameter->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointParameter->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MonitoringPointParameter->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MonitoringPointParameter->PermissionTree_Description | string | |\r\n| id | MonitoringPointParameter->Id | integer | int64 |\r\n| monitoringPointId | MonitoringPointParameter->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | MonitoringPointParameter->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | MonitoringPointParameter->MonitoringPoint_Description | string | |\r\n| parameterName | MonitoringPointParameter->ParameterName | string | |\r\n| parameterValue | MonitoringPointParameter->ParameterValue | string | |\r\n", "operationId": "BatchGetMonitoringPointParameter", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Monitoring Point Parameter id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Monitoring Point Parameter collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetMonitoringPointParameterResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Parameters/Batch": { "post": { "tags": [ "Monitoring Point Parameter" ], "summary": "Create a new collection of Monitoring Point Parameter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| parameterName | MonitoringPointParameter->ParameterName | string | |\r\n| parameterValue | MonitoringPointParameter->ParameterValue | string | |\r\n| permissionTreeId | MonitoringPointParameter->PermissionTree_Id | integer | int64 |\r\n| monitoringPointId | MonitoringPointParameter->MonitoringPoint_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| parameterName | Required | True | |\r\n| parameterName | Nullable | False | |\r\n| parameterName | Min Length | >= 1 chars| |\r\n| parameterName | Max Length | <= 50 chars| |\r\n| parameterValue | Required | True | |\r\n| parameterValue | Nullable | False | |\r\n| parameterValue | Min Length | >= 1 chars| |\r\n| parameterValue | Max Length | <= 100 chars| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| monitoringPointId | Required | True | |\r\n| monitoringPointId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateMonitoringPointParameter", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateMonitoringPointParameterResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Monitoring Point Parameter batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Monitoring Point Parameter" ], "summary": "Update a collection of existing Monitoring Point Parameter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointParameter->Id | integer | int64 |\r\n| version | MonitoringPointParameter->Version | integer | int32 |\r\n| parameterName | MonitoringPointParameter->ParameterName | string | |\r\n| parameterValue | MonitoringPointParameter->ParameterValue | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| parameterName | Nullable | False | |\r\n| parameterName | Min Length | >= 1 chars| |\r\n| parameterName | Max Length | <= 50 chars| |\r\n| parameterValue | Nullable | False | |\r\n| parameterValue | Min Length | >= 1 chars| |\r\n| parameterValue | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchUpdateMonitoringPointParameter", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateMonitoringPointParameterResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Monitoring Point Parameter batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Monitoring Point Parameter" ], "summary": "Delete a collection of existing Monitoring Point Parameter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointParameter->Id | integer | int64 |\r\n| version | MonitoringPointParameter->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteMonitoringPointParameter", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteMonitoringPointParameterResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Monitoring Point Parameter batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Parameters/{id}/Active": { "patch": { "tags": [ "Monitoring Point Parameter" ], "summary": "Change the IsActive status for an existing Monitoring Point Parameter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointParameter->Version | integer | int32 |\r\n| isActive | MonitoringPointParameter->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeMonitoringPointParameterIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Parameter Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeMonitoringPointParameterIsActiveResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Parameters/{id}/PermissionTree": { "patch": { "tags": [ "Monitoring Point Parameter" ], "summary": "Change the PermissionTree for an existing Monitoring Point Parameter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointParameter->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointParameter->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeMonitoringPointParameterPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Parameter Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeMonitoringPointParameterPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Parameters/Batch/Active": { "patch": { "tags": [ "Monitoring Point Parameter" ], "summary": "Change the IsActive status for a collection of existing Monitoring Point Parameter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointParameter->Id | integer | int64 |\r\n| version | MonitoringPointParameter->Version | integer | int32 |\r\n| isActive | MonitoringPointParameter->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeMonitoringPointParameterIsActive", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeMonitoringPointParameterIsActiveResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Parameters/Batch/PermissionTree": { "patch": { "tags": [ "Monitoring Point Parameter" ], "summary": "Change the PermissionTree status for a collection of existing Monitoring Point Parameter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointParameter->Id | integer | int64 |\r\n| version | MonitoringPointParameter->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointParameter->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeMonitoringPointParameterPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeMonitoringPointParameterPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Readings/{id}": { "get": { "tags": [ "Monitoring Point Reading" ], "summary": "Get a Monitoring Point Reading resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | MonitoringPointReading->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MonitoringPointReading->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MonitoringPointReading->CreatedByUser_FullName | string | |\r\n| createdOn | MonitoringPointReading->CreatedOn | string | date-time |\r\n| modifiedByUserId | MonitoringPointReading->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MonitoringPointReading->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MonitoringPointReading->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MonitoringPointReading->ModifiedOn | string | date-time |\r\n| version | MonitoringPointReading->Version | integer | int32 |\r\n| geographicId | MonitoringPointReading->GeographicId | integer | int64 |\r\n| geographicEndPosition | MonitoringPointReading->GeographicEndPosition | number | decimal |\r\n| geographicEntityType | MonitoringPointReading->GeographicEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicLength | MonitoringPointReading->GeographicLength | number | decimal |\r\n| geographicLocation | MonitoringPointReading->GeographicLocation | object | |\r\n| geographicNotes | MonitoringPointReading->GeographicNotes | string | |\r\n| geographicReferenceEntityId | MonitoringPointReading->GeographicReferenceEntityId | integer | int64 |\r\n| geographicReferenceEntityType | MonitoringPointReading->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicStartPosition | MonitoringPointReading->GeographicStartPosition | number | decimal |\r\n| geographicUnitOfMeasurementId | MonitoringPointReading->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicUnitOfMeasurementDescription | MonitoringPointReading->GeographicUnitOfMeasurement_Description | string | |\r\n| geographicUnitOfMeasurementCode | MonitoringPointReading->GeographicUnitOfMeasurement_Code | string | |\r\n| id | MonitoringPointReading->Id | integer | int64 |\r\n| monitoringPointId | MonitoringPointReading->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | MonitoringPointReading->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | MonitoringPointReading->MonitoringPoint_Description | string | |\r\n| notes | MonitoringPointReading->Notes | string | |\r\n| reading | MonitoringPointReading->Reading | number | decimal |\r\n| readingOn | MonitoringPointReading->ReadingOn | string | date-time |\r\n", "operationId": "GetMonitoringPointReading", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Reading Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Monitoring Point Reading", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointReadingResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Monitoring Point Reading" ], "summary": "Update an existing Monitoring Point Reading resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointReading->Version | integer | int32 |\r\n| notes | MonitoringPointReading->Notes | string | |\r\n| reading | MonitoringPointReading->Reading | number | decimal |\r\n| readingOn | MonitoringPointReading->ReadingOn | string | date-time |\r\n| geographicLocation | MonitoringPointReading->GeographicLocation | object | |\r\n| geographicStartPosition | MonitoringPointReading->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | MonitoringPointReading->GeographicEndPosition | number | decimal |\r\n| geographicLength | MonitoringPointReading->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | MonitoringPointReading->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | MonitoringPointReading->GeographicNotes | string | |\r\n| geographicReferenceEntityType | MonitoringPointReading->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | MonitoringPointReading->GeographicReferenceEntityId | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| reading | Nullable | False | |\r\n| readingOn | Nullable | False | |\r\n| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "UpdateMonitoringPointReading", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Reading Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateMonitoringPointReadingResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Monitoring Point Reading was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Monitoring Point Reading" ], "summary": "Delete an existing Monitoring Point Reading resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointReading->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteMonitoringPointReading", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Reading Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteMonitoringPointReadingResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Monitoring Point Reading was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Readings": { "get": { "tags": [ "Monitoring Point Reading" ], "summary": "Get a collection of Monitoring Point Reading resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointReading->Id | integer | int64 |\r\n| version | MonitoringPointReading->Version | integer | int32 |\r\n| notes | MonitoringPointReading->Notes | string | |\r\n| monitoringPointId | MonitoringPointReading->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | MonitoringPointReading->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | MonitoringPointReading->MonitoringPoint_Description | string | |\r\n| monitoringPointUnitOfMeasurementId | MonitoringPointReading->MonitoringPoint_UnitOfMeasurement_Id | integer | int64 |\r\n| monitoringPointUnitOfMeasurementCode | MonitoringPointReading->MonitoringPoint_UnitOfMeasurement_Code | string | |\r\n| monitoringPointUnitOfMeasurementDescription | MonitoringPointReading->MonitoringPoint_UnitOfMeasurement_Description | string | |\r\n| reading | MonitoringPointReading->Reading | number | decimal |\r\n| readingOn | MonitoringPointReading->ReadingOn | string | date-time |\r\n| createdOn | MonitoringPointReading->CreatedOn | string | date-time |\r\n| modifiedOn | MonitoringPointReading->ModifiedOn | string | date-time |\r\n", "operationId": "GetMonitoringPointReadingCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point Reading collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointReadingCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Monitoring Point Reading" ], "summary": "Create a new Monitoring Point Reading resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| notes | MonitoringPointReading->Notes | string | |\r\n| monitoringPointId | MonitoringPointReading->MonitoringPoint_Id | integer | int64 |\r\n| reading | MonitoringPointReading->Reading | number | decimal |\r\n| readingOn | MonitoringPointReading->ReadingOn | string | date-time |\r\n| geographicLocation | MonitoringPointReading->GeographicLocation | object | |\r\n| geographicStartPosition | MonitoringPointReading->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | MonitoringPointReading->GeographicEndPosition | number | decimal |\r\n| geographicLength | MonitoringPointReading->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | MonitoringPointReading->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | MonitoringPointReading->GeographicNotes | string | |\r\n| geographicReferenceEntityType | MonitoringPointReading->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | MonitoringPointReading->GeographicReferenceEntityId | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| monitoringPointId | Required | True | |\r\n| monitoringPointId | Nullable | False | |\r\n| reading | Nullable | False | |\r\n| readingOn | Nullable | False | |\r\n| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "CreateMonitoringPointReading", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateMonitoringPointReadingResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/{monitoringPointId}/Readings": { "get": { "tags": [ "Monitoring Point Reading" ], "summary": "Get a collection of Monitoring Point Reading resources for the Monitoring Point.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointReading->Id | integer | int64 |\r\n| version | MonitoringPointReading->Version | integer | int32 |\r\n| notes | MonitoringPointReading->Notes | string | |\r\n| reading | MonitoringPointReading->Reading | number | decimal |\r\n| readingOn | MonitoringPointReading->ReadingOn | string | date-time |\r\n| createdOn | MonitoringPointReading->CreatedOn | string | date-time |\r\n| modifiedOn | MonitoringPointReading->ModifiedOn | string | date-time |\r\n", "operationId": "GetMonitoringPointReadingForMonitoringPointCollection", "parameters": [ { "name": "monitoringPointId", "in": "path", "required": true, "description": "Monitoring Point Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point Reading collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointReadingForMonitoringPointCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Readings/Lookups/LookupMonitoringPointReadingMonitoringPoint": { "get": { "tags": [ "Monitoring Point Reading" ], "summary": "Lookup the Monitoring Point for the Monitoring Point Reading.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPoint->Id | integer | int64 |\r\n| code | MonitoringPoint->Code | string | |\r\n| description | MonitoringPoint->Description | string | |\r\n", "operationId": "LookupMonitoringPointReadingMonitoringPoint", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointReadingMonitoringPointLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Readings/Batch/{ids}": { "get": { "tags": [ "Monitoring Point Reading" ], "summary": "Get a collection of Monitoring Point Reading resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | MonitoringPointReading->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MonitoringPointReading->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MonitoringPointReading->CreatedByUser_FullName | string | |\r\n| createdOn | MonitoringPointReading->CreatedOn | string | date-time |\r\n| modifiedByUserId | MonitoringPointReading->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MonitoringPointReading->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MonitoringPointReading->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MonitoringPointReading->ModifiedOn | string | date-time |\r\n| version | MonitoringPointReading->Version | integer | int32 |\r\n| geographicId | MonitoringPointReading->GeographicId | integer | int64 |\r\n| geographicEndPosition | MonitoringPointReading->GeographicEndPosition | number | decimal |\r\n| geographicEntityType | MonitoringPointReading->GeographicEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicLength | MonitoringPointReading->GeographicLength | number | decimal |\r\n| geographicLocation | MonitoringPointReading->GeographicLocation | object | |\r\n| geographicNotes | MonitoringPointReading->GeographicNotes | string | |\r\n| geographicReferenceEntityId | MonitoringPointReading->GeographicReferenceEntityId | integer | int64 |\r\n| geographicReferenceEntityType | MonitoringPointReading->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicStartPosition | MonitoringPointReading->GeographicStartPosition | number | decimal |\r\n| geographicUnitOfMeasurementId | MonitoringPointReading->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicUnitOfMeasurementDescription | MonitoringPointReading->GeographicUnitOfMeasurement_Description | string | |\r\n| geographicUnitOfMeasurementCode | MonitoringPointReading->GeographicUnitOfMeasurement_Code | string | |\r\n| id | MonitoringPointReading->Id | integer | int64 |\r\n| monitoringPointId | MonitoringPointReading->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | MonitoringPointReading->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | MonitoringPointReading->MonitoringPoint_Description | string | |\r\n| notes | MonitoringPointReading->Notes | string | |\r\n| reading | MonitoringPointReading->Reading | number | decimal |\r\n| readingOn | MonitoringPointReading->ReadingOn | string | date-time |\r\n", "operationId": "BatchGetMonitoringPointReading", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Monitoring Point Reading id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Monitoring Point Reading collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetMonitoringPointReadingResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPoints/Readings/Batch": { "post": { "tags": [ "Monitoring Point Reading" ], "summary": "Create a new collection of Monitoring Point Reading resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| notes | MonitoringPointReading->Notes | string | |\r\n| monitoringPointId | MonitoringPointReading->MonitoringPoint_Id | integer | int64 |\r\n| reading | MonitoringPointReading->Reading | number | decimal |\r\n| readingOn | MonitoringPointReading->ReadingOn | string | date-time |\r\n| geographicLocation | MonitoringPointReading->GeographicLocation | object | |\r\n| geographicStartPosition | MonitoringPointReading->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | MonitoringPointReading->GeographicEndPosition | number | decimal |\r\n| geographicLength | MonitoringPointReading->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | MonitoringPointReading->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | MonitoringPointReading->GeographicNotes | string | |\r\n| geographicReferenceEntityType | MonitoringPointReading->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | MonitoringPointReading->GeographicReferenceEntityId | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| monitoringPointId | Required | True | |\r\n| monitoringPointId | Nullable | False | |\r\n| reading | Nullable | False | |\r\n| readingOn | Nullable | False | |\r\n| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateMonitoringPointReading", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateMonitoringPointReadingResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Monitoring Point Reading batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Monitoring Point Reading" ], "summary": "Update a collection of existing Monitoring Point Reading resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointReading->Id | integer | int64 |\r\n| version | MonitoringPointReading->Version | integer | int32 |\r\n| notes | MonitoringPointReading->Notes | string | |\r\n| reading | MonitoringPointReading->Reading | number | decimal |\r\n| readingOn | MonitoringPointReading->ReadingOn | string | date-time |\r\n| geographicLocation | MonitoringPointReading->GeographicLocation | object | |\r\n| geographicStartPosition | MonitoringPointReading->GeographicStartPosition | number | decimal |\r\n| geographicEndPosition | MonitoringPointReading->GeographicEndPosition | number | decimal |\r\n| geographicLength | MonitoringPointReading->GeographicLength | number | decimal |\r\n| geographicUnitOfMeasurementId | MonitoringPointReading->GeographicUnitOfMeasurement_Id | integer | int64 |\r\n| geographicNotes | MonitoringPointReading->GeographicNotes | string | |\r\n| geographicReferenceEntityType | MonitoringPointReading->GeographicReferenceEntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| geographicReferenceEntityId | MonitoringPointReading->GeographicReferenceEntityId | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| reading | Nullable | False | |\r\n| readingOn | Nullable | False | |\r\n| geographicReferenceEntityType | Nullable | False | |\r\n| geographicReferenceEntityId | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateMonitoringPointReading", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateMonitoringPointReadingResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Monitoring Point Reading batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Monitoring Point Reading" ], "summary": "Delete a collection of existing Monitoring Point Reading resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointReading->Id | integer | int64 |\r\n| version | MonitoringPointReading->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteMonitoringPointReading", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteMonitoringPointReadingResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Monitoring Point Reading batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/{id}": { "get": { "tags": [ "Monitoring Point Trigger" ], "summary": "Get a Monitoring Point Trigger resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | MonitoringPointTrigger->Code | string | |\r\n| isActive | MonitoringPointTrigger->IsActive | boolean | |\r\n| createdByUserId | MonitoringPointTrigger->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MonitoringPointTrigger->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MonitoringPointTrigger->CreatedByUser_FullName | string | |\r\n| createdOn | MonitoringPointTrigger->CreatedOn | string | date-time |\r\n| modifiedByUserId | MonitoringPointTrigger->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MonitoringPointTrigger->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MonitoringPointTrigger->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MonitoringPointTrigger->ModifiedOn | string | date-time |\r\n| version | MonitoringPointTrigger->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointTrigger->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MonitoringPointTrigger->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MonitoringPointTrigger->PermissionTree_Description | string | |\r\n| id | MonitoringPointTrigger->Id | integer | int64 |\r\n| description | MonitoringPointTrigger->Description | string | |\r\n| expressionsValid | MonitoringPointTrigger->ExpressionsValid | boolean | |\r\n| notes | MonitoringPointTrigger->Notes | string | |\r\n| sequenceNumber | MonitoringPointTrigger->SequenceNumber | integer | int32 |\r\n", "operationId": "GetMonitoringPointTrigger", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Trigger Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Monitoring Point Trigger", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointTriggerResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Monitoring Point Trigger" ], "summary": "Update an existing Monitoring Point Trigger resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointTrigger->Version | integer | int32 |\r\n| code | MonitoringPointTrigger->Code | string | |\r\n| description | MonitoringPointTrigger->Description | string | |\r\n| sequenceNumber | MonitoringPointTrigger->SequenceNumber | integer | int32 |\r\n| notes | MonitoringPointTrigger->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "UpdateMonitoringPointTrigger", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Trigger Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateMonitoringPointTriggerResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Monitoring Point Trigger was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Monitoring Point Trigger" ], "summary": "Delete an existing Monitoring Point Trigger resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointTrigger->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteMonitoringPointTrigger", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Trigger Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteTriggerResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Monitoring Point Trigger was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers": { "get": { "tags": [ "Monitoring Point Trigger" ], "summary": "Get a collection of Monitoring Point Trigger resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointTrigger->Version | integer | int32 |\r\n| id | MonitoringPointTrigger->Id | integer | int64 |\r\n| code | MonitoringPointTrigger->Code | string | |\r\n| description | MonitoringPointTrigger->Description | string | |\r\n| sequenceNumber | MonitoringPointTrigger->SequenceNumber | integer | int32 |\r\n| isActive | MonitoringPointTrigger->IsActive | boolean | |\r\n| notes | MonitoringPointTrigger->Notes | string | |\r\n| createdOn | MonitoringPointTrigger->CreatedOn | string | date-time |\r\n| modifiedOn | MonitoringPointTrigger->ModifiedOn | string | date-time |\r\n| expressionsValid | MonitoringPointTrigger->ExpressionsValid | boolean | |\r\n", "operationId": "GetMonitoringPointTriggerCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point Trigger collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetTriggerCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Monitoring Point Trigger" ], "summary": "Create a new Monitoring Point Trigger resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | MonitoringPointTrigger->Code | string | |\r\n| description | MonitoringPointTrigger->Description | string | |\r\n| sequenceNumber | MonitoringPointTrigger->SequenceNumber | integer | int32 |\r\n| permissionTreeId | MonitoringPointTrigger->PermissionTree_Id | integer | int64 |\r\n| notes | MonitoringPointTrigger->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateMonitoringPointTrigger", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateTriggerResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Lookups/LookupMonitoringPointTriggerChangePermissionTree": { "get": { "tags": [ "Monitoring Point Trigger" ], "summary": "Lookup the permission set for changing the Monitoring Point Trigger.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupMonitoringPointTriggerChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/TriggerChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Lookups/LookupMonitoringPointTriggerInsertPermissionTree": { "get": { "tags": [ "Monitoring Point Trigger" ], "summary": "Lookup the permission set for creating the Monitoring Point Trigger.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupMonitoringPointTriggerInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointTriggerInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Batch/{ids}": { "get": { "tags": [ "Monitoring Point Trigger" ], "summary": "Get a collection of Monitoring Point Trigger resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | MonitoringPointTrigger->Code | string | |\r\n| isActive | MonitoringPointTrigger->IsActive | boolean | |\r\n| createdByUserId | MonitoringPointTrigger->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MonitoringPointTrigger->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MonitoringPointTrigger->CreatedByUser_FullName | string | |\r\n| createdOn | MonitoringPointTrigger->CreatedOn | string | date-time |\r\n| modifiedByUserId | MonitoringPointTrigger->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MonitoringPointTrigger->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MonitoringPointTrigger->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MonitoringPointTrigger->ModifiedOn | string | date-time |\r\n| version | MonitoringPointTrigger->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointTrigger->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MonitoringPointTrigger->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MonitoringPointTrigger->PermissionTree_Description | string | |\r\n| id | MonitoringPointTrigger->Id | integer | int64 |\r\n| description | MonitoringPointTrigger->Description | string | |\r\n| expressionsValid | MonitoringPointTrigger->ExpressionsValid | boolean | |\r\n| notes | MonitoringPointTrigger->Notes | string | |\r\n| sequenceNumber | MonitoringPointTrigger->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetMonitoringPointTrigger", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Monitoring Point Trigger id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Monitoring Point Trigger collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetMonitoringPointTriggerResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Batch": { "post": { "tags": [ "Monitoring Point Trigger" ], "summary": "Create a new collection of Monitoring Point Trigger resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | MonitoringPointTrigger->Code | string | |\r\n| description | MonitoringPointTrigger->Description | string | |\r\n| sequenceNumber | MonitoringPointTrigger->SequenceNumber | integer | int32 |\r\n| permissionTreeId | MonitoringPointTrigger->PermissionTree_Id | integer | int64 |\r\n| notes | MonitoringPointTrigger->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateMonitoringPointTrigger", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateMonitoringPointTriggerResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Monitoring Point Trigger batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Monitoring Point Trigger" ], "summary": "Update a collection of existing Monitoring Point Trigger resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTrigger->Id | integer | int64 |\r\n| version | MonitoringPointTrigger->Version | integer | int32 |\r\n| code | MonitoringPointTrigger->Code | string | |\r\n| description | MonitoringPointTrigger->Description | string | |\r\n| sequenceNumber | MonitoringPointTrigger->SequenceNumber | integer | int32 |\r\n| notes | MonitoringPointTrigger->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchUpdateMonitoringPointTrigger", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateTriggerResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Monitoring Point Trigger batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Monitoring Point Trigger" ], "summary": "Delete a collection of existing Monitoring Point Trigger resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTrigger->Id | integer | int64 |\r\n| version | MonitoringPointTrigger->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteMonitoringPointTrigger", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteMonitoringPointTriggerResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Monitoring Point Trigger batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/{id}/Active": { "patch": { "tags": [ "Monitoring Point Trigger" ], "summary": "Change the IsActive status for an existing Monitoring Point Trigger resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointTrigger->Version | integer | int32 |\r\n| isActive | MonitoringPointTrigger->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeMonitoringPointTriggerIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Trigger Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeMonitoringPointTriggerIsActiveResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/{id}/PermissionTree": { "patch": { "tags": [ "Monitoring Point Trigger" ], "summary": "Change the PermissionTree for an existing Monitoring Point Trigger resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointTrigger->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointTrigger->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeMonitoringPointTriggerPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Trigger Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeMonitoringPointTriggerPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/Validate": { "post": { "tags": [ "Monitoring Point Trigger" ], "summary": "Validate Monitoring Point Trigger Expression", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| monitoringPointTriggerIds | ValidateMonitoringPointTriggerExpressions->MonitoringPointTriggerIds | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| monitoringPointTriggerIds | Required | True | |\r\n| monitoringPointTriggerIds | Nullable | False | |\r\n\r\n", "operationId": "ValidateMonitoringPointTriggerExpressions", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/ValidateMonitoringPointTriggerExpressionsResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Batch/Active": { "patch": { "tags": [ "Monitoring Point Trigger" ], "summary": "Change the IsActive status for a collection of existing Monitoring Point Trigger resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTrigger->Id | integer | int64 |\r\n| version | MonitoringPointTrigger->Version | integer | int32 |\r\n| isActive | MonitoringPointTrigger->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeMonitoringPointTriggerIsActive", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeMonitoringPointTriggerIsActiveResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Batch/PermissionTree": { "patch": { "tags": [ "Monitoring Point Trigger" ], "summary": "Change the PermissionTree status for a collection of existing Monitoring Point Trigger resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTrigger->Id | integer | int64 |\r\n| version | MonitoringPointTrigger->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointTrigger->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeMonitoringPointTriggerPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeMonitoringPointTriggerPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/{id}": { "get": { "tags": [ "Monitoring Point Trigger Expression" ], "summary": "Get a Monitoring Point Trigger Expression resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| isActive | MonitoringPointTriggerExpression->IsActive | boolean | |\r\n| createdByUserId | MonitoringPointTriggerExpression->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MonitoringPointTriggerExpression->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MonitoringPointTriggerExpression->CreatedByUser_FullName | string | |\r\n| createdOn | MonitoringPointTriggerExpression->CreatedOn | string | date-time |\r\n| modifiedByUserId | MonitoringPointTriggerExpression->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MonitoringPointTriggerExpression->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MonitoringPointTriggerExpression->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MonitoringPointTriggerExpression->ModifiedOn | string | date-time |\r\n| version | MonitoringPointTriggerExpression->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointTriggerExpression->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MonitoringPointTriggerExpression->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MonitoringPointTriggerExpression->PermissionTree_Description | string | |\r\n| id | MonitoringPointTriggerExpression->Id | integer | int64 |\r\n| alarmCancellationType | MonitoringPointTriggerExpression->AlarmCancellationType | string (Allowed values: [ManualCancel, CancelledByExpression, CancelledByWorkOrder]) | enum |\r\n| alwaysRecordResult | MonitoringPointTriggerExpression->AlwaysRecordResult | boolean | |\r\n| assetId | MonitoringPointTriggerExpression->Asset_Id | integer | int64 |\r\n| assetCode | MonitoringPointTriggerExpression->Asset_Code | string | |\r\n| assetDescription | MonitoringPointTriggerExpression->Asset_Description | string | |\r\n| assetRecordType | MonitoringPointTriggerExpression->Asset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| description | MonitoringPointTriggerExpression->Description | string | |\r\n| expression | MonitoringPointTriggerExpression->Expression | string | |\r\n| isValid | MonitoringPointTriggerExpression->IsValid | boolean | |\r\n| isValidErrors | MonitoringPointTriggerExpression->IsValidErrors | array | enum |\r\n| monitoringPointTriggerId | MonitoringPointTriggerExpression->MonitoringPointTrigger_Id | integer | int64 |\r\n| monitoringPointTriggerCode | MonitoringPointTriggerExpression->MonitoringPointTrigger_Code | string | |\r\n| monitoringPointTriggerDescription | MonitoringPointTriggerExpression->MonitoringPointTrigger_Description | string | |\r\n| notes | MonitoringPointTriggerExpression->Notes | string | |\r\n| sequenceNumber | MonitoringPointTriggerExpression->SequenceNumber | integer | int32 |\r\n", "operationId": "GetMonitoringPointTriggerExpression", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Trigger Expression Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Monitoring Point Trigger Expression", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointTriggerExpressionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Monitoring Point Trigger Expression" ], "summary": "Update an existing Monitoring Point Trigger Expression resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointTriggerExpression->Version | integer | int32 |\r\n| description | MonitoringPointTriggerExpression->Description | string | |\r\n| assetId | MonitoringPointTriggerExpression->Asset_Id | integer | int64 |\r\n| sequenceNumber | MonitoringPointTriggerExpression->SequenceNumber | integer | int32 |\r\n| alarmCancellationType | MonitoringPointTriggerExpression->AlarmCancellationType | string (Allowed values: [ManualCancel, CancelledByExpression, CancelledByWorkOrder]) | enum |\r\n| alwaysRecordResult | MonitoringPointTriggerExpression->AlwaysRecordResult | boolean | |\r\n| expression | MonitoringPointTriggerExpression->Expression | string | |\r\n| notes | MonitoringPointTriggerExpression->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| alarmCancellationType | Nullable | False | |\r\n| alwaysRecordResult | Nullable | False | |\r\n| expression | Nullable | False | |\r\n\r\n", "operationId": "UpdateMonitoringPointTriggerExpression", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Trigger Expression Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateMonitoringPointTriggerExpressionResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Monitoring Point Trigger Expression was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Monitoring Point Trigger Expression" ], "summary": "Delete an existing Monitoring Point Trigger Expression resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointTriggerExpression->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteMonitoringPointTriggerExpression", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Trigger Expression Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteMonitoringPointTriggerExpressionResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Monitoring Point Trigger Expression was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions": { "get": { "tags": [ "Monitoring Point Trigger Expression" ], "summary": "Get a collection of Monitoring Point Trigger Expression resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTriggerExpression->Id | integer | int64 |\r\n| version | MonitoringPointTriggerExpression->Version | integer | int32 |\r\n| description | MonitoringPointTriggerExpression->Description | string | |\r\n| sequenceNumber | MonitoringPointTriggerExpression->SequenceNumber | integer | int32 |\r\n| isActive | MonitoringPointTriggerExpression->IsActive | boolean | |\r\n| notes | MonitoringPointTriggerExpression->Notes | string | |\r\n| monitoringPointTriggerId | MonitoringPointTriggerExpression->MonitoringPointTrigger_Id | integer | int64 |\r\n| monitoringPointTriggerCode | MonitoringPointTriggerExpression->MonitoringPointTrigger_Code | string | |\r\n| monitoringPointTriggerDescription | MonitoringPointTriggerExpression->MonitoringPointTrigger_Description | string | |\r\n| expression | MonitoringPointTriggerExpression->Expression | string | |\r\n| assetCode | MonitoringPointTriggerExpression->Asset_Code | string | |\r\n| createdOn | MonitoringPointTriggerExpression->CreatedOn | string | date-time |\r\n| modifiedOn | MonitoringPointTriggerExpression->ModifiedOn | string | date-time |\r\n| isValid | MonitoringPointTriggerExpression->IsValid | boolean | |\r\n| isValidErrors | MonitoringPointTriggerExpression->IsValidErrors | array | enum |\r\n", "operationId": "GetMonitoringPointTriggerExpressionCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point Trigger Expression collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointTriggerExpressionCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Monitoring Point Trigger Expression" ], "summary": "Create a new Monitoring Point Trigger Expression resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| description | MonitoringPointTriggerExpression->Description | string | |\r\n| sequenceNumber | MonitoringPointTriggerExpression->SequenceNumber | integer | int32 |\r\n| assetId | MonitoringPointTriggerExpression->Asset_Id | integer | int64 |\r\n| permissionTreeId | MonitoringPointTriggerExpression->PermissionTree_Id | integer | int64 |\r\n| monitoringPointTriggerId | MonitoringPointTriggerExpression->MonitoringPointTrigger_Id | integer | int64 |\r\n| alarmCancellationType | MonitoringPointTriggerExpression->AlarmCancellationType | string (Allowed values: [ManualCancel, CancelledByExpression, CancelledByWorkOrder]) | enum |\r\n| alwaysRecordResult | MonitoringPointTriggerExpression->AlwaysRecordResult | boolean | |\r\n| expression | MonitoringPointTriggerExpression->Expression | string | |\r\n| notes | MonitoringPointTriggerExpression->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| monitoringPointTriggerId | Required | True | |\r\n| monitoringPointTriggerId | Nullable | False | |\r\n| alarmCancellationType | System Generated | true | If no value specified |\r\n| alarmCancellationType | Nullable | False | |\r\n| alwaysRecordResult | System Generated | true | If no value specified |\r\n| alwaysRecordResult | Nullable | False | |\r\n| expression | Required | True | |\r\n| expression | Nullable | False | |\r\n\r\n", "operationId": "CreateMonitoringPointTriggerExpression", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateMonitoringPointTriggerExpressionResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/{monitoringPointTriggerId}/Expressions": { "get": { "tags": [ "Monitoring Point Trigger Expression" ], "summary": "Get a collection of Monitoring Point Trigger Expression resources for the Monitoring Point Trigger.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTriggerExpression->Id | integer | int64 |\r\n| version | MonitoringPointTriggerExpression->Version | integer | int32 |\r\n| description | MonitoringPointTriggerExpression->Description | string | |\r\n| sequenceNumber | MonitoringPointTriggerExpression->SequenceNumber | integer | int32 |\r\n| isActive | MonitoringPointTriggerExpression->IsActive | boolean | |\r\n| notes | MonitoringPointTriggerExpression->Notes | string | |\r\n| expression | MonitoringPointTriggerExpression->Expression | string | |\r\n| createdOn | MonitoringPointTriggerExpression->CreatedOn | string | date-time |\r\n| modifiedOn | MonitoringPointTriggerExpression->ModifiedOn | string | date-time |\r\n| isValid | MonitoringPointTriggerExpression->IsValid | boolean | |\r\n| isValidErrors | MonitoringPointTriggerExpression->IsValidErrors | array | enum |\r\n", "operationId": "GetMonitoringPointTriggerExpressionForMonitoringPointTriggerCollection", "parameters": [ { "name": "monitoringPointTriggerId", "in": "path", "required": true, "description": "Monitoring Point Trigger Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point Trigger Expression collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointTriggerExpressionForMonitoringPointTriggerCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/Lookups/LookupMonitoringPointTriggerExpressionChangePermissionTree": { "get": { "tags": [ "Monitoring Point Trigger Expression" ], "summary": "Lookup the permission set for changing the Monitoring Point Trigger Expression.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupMonitoringPointTriggerExpressionChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointTriggerExpressionChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/Lookups/LookupMonitoringPointTriggerExpressionInsertPermissionTree": { "get": { "tags": [ "Monitoring Point Trigger Expression" ], "summary": "Lookup the permission set for creating the Monitoring Point Trigger Expression.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupMonitoringPointTriggerExpressionInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointTriggerExpressionInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/Lookups/LookupMonitoringPointTriggerExpressionMonitoringPointTrigger": { "get": { "tags": [ "Monitoring Point Trigger Expression" ], "summary": "Lookup the Monitoring Point Trigger for the Monitoring Point Trigger Expression.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTrigger->Id | integer | int64 |\r\n| code | MonitoringPointTrigger->Code | string | |\r\n| description | MonitoringPointTrigger->Description | string | |\r\n", "operationId": "LookupMonitoringPointTriggerExpressionMonitoringPointTrigger", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point Trigger collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointTriggerExpressionMonitoringPointTriggerLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/Lookups/LookupMonitoringPointTriggerExpressionAsset": { "get": { "tags": [ "Monitoring Point Trigger Expression" ], "summary": "Lookup the Asset for the Monitoring Point Trigger Expression.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | Asset->Id | integer | int64 |\r\n| code | Asset->Code | string | |\r\n| description | Asset->Description | string | |\r\n| siteCode | Asset->Site_Code | string | |\r\n| recordType | Asset->RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n", "operationId": "LookupMonitoringPointTriggerExpressionAsset", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Asset collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointTriggerExpressionRegularAssetLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/Batch/{ids}": { "get": { "tags": [ "Monitoring Point Trigger Expression" ], "summary": "Get a collection of Monitoring Point Trigger Expression resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| isActive | MonitoringPointTriggerExpression->IsActive | boolean | |\r\n| createdByUserId | MonitoringPointTriggerExpression->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MonitoringPointTriggerExpression->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MonitoringPointTriggerExpression->CreatedByUser_FullName | string | |\r\n| createdOn | MonitoringPointTriggerExpression->CreatedOn | string | date-time |\r\n| modifiedByUserId | MonitoringPointTriggerExpression->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MonitoringPointTriggerExpression->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MonitoringPointTriggerExpression->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MonitoringPointTriggerExpression->ModifiedOn | string | date-time |\r\n| version | MonitoringPointTriggerExpression->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointTriggerExpression->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MonitoringPointTriggerExpression->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MonitoringPointTriggerExpression->PermissionTree_Description | string | |\r\n| id | MonitoringPointTriggerExpression->Id | integer | int64 |\r\n| alarmCancellationType | MonitoringPointTriggerExpression->AlarmCancellationType | string (Allowed values: [ManualCancel, CancelledByExpression, CancelledByWorkOrder]) | enum |\r\n| alwaysRecordResult | MonitoringPointTriggerExpression->AlwaysRecordResult | boolean | |\r\n| assetId | MonitoringPointTriggerExpression->Asset_Id | integer | int64 |\r\n| assetCode | MonitoringPointTriggerExpression->Asset_Code | string | |\r\n| assetDescription | MonitoringPointTriggerExpression->Asset_Description | string | |\r\n| assetRecordType | MonitoringPointTriggerExpression->Asset_RecordType | string (Allowed values: [Regular, InPlace, EmptyPlaceholder, LinkedPlaceholder]) | enum |\r\n| description | MonitoringPointTriggerExpression->Description | string | |\r\n| expression | MonitoringPointTriggerExpression->Expression | string | |\r\n| isValid | MonitoringPointTriggerExpression->IsValid | boolean | |\r\n| isValidErrors | MonitoringPointTriggerExpression->IsValidErrors | array | enum |\r\n| monitoringPointTriggerId | MonitoringPointTriggerExpression->MonitoringPointTrigger_Id | integer | int64 |\r\n| monitoringPointTriggerCode | MonitoringPointTriggerExpression->MonitoringPointTrigger_Code | string | |\r\n| monitoringPointTriggerDescription | MonitoringPointTriggerExpression->MonitoringPointTrigger_Description | string | |\r\n| notes | MonitoringPointTriggerExpression->Notes | string | |\r\n| sequenceNumber | MonitoringPointTriggerExpression->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetMonitoringPointTriggerExpression", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Monitoring Point Trigger Expression id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Monitoring Point Trigger Expression collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetMonitoringPointTriggerExpressionResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/Batch": { "post": { "tags": [ "Monitoring Point Trigger Expression" ], "summary": "Create a new collection of Monitoring Point Trigger Expression resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| description | MonitoringPointTriggerExpression->Description | string | |\r\n| sequenceNumber | MonitoringPointTriggerExpression->SequenceNumber | integer | int32 |\r\n| assetId | MonitoringPointTriggerExpression->Asset_Id | integer | int64 |\r\n| permissionTreeId | MonitoringPointTriggerExpression->PermissionTree_Id | integer | int64 |\r\n| monitoringPointTriggerId | MonitoringPointTriggerExpression->MonitoringPointTrigger_Id | integer | int64 |\r\n| alarmCancellationType | MonitoringPointTriggerExpression->AlarmCancellationType | string (Allowed values: [ManualCancel, CancelledByExpression, CancelledByWorkOrder]) | enum |\r\n| alwaysRecordResult | MonitoringPointTriggerExpression->AlwaysRecordResult | boolean | |\r\n| expression | MonitoringPointTriggerExpression->Expression | string | |\r\n| notes | MonitoringPointTriggerExpression->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| monitoringPointTriggerId | Required | True | |\r\n| monitoringPointTriggerId | Nullable | False | |\r\n| alarmCancellationType | System Generated | true | If no value specified |\r\n| alarmCancellationType | Nullable | False | |\r\n| alwaysRecordResult | System Generated | true | If no value specified |\r\n| alwaysRecordResult | Nullable | False | |\r\n| expression | Required | True | |\r\n| expression | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateMonitoringPointTriggerExpression", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateMonitoringPointTriggerExpressionResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Monitoring Point Trigger Expression batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Monitoring Point Trigger Expression" ], "summary": "Update a collection of existing Monitoring Point Trigger Expression resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTriggerExpression->Id | integer | int64 |\r\n| version | MonitoringPointTriggerExpression->Version | integer | int32 |\r\n| description | MonitoringPointTriggerExpression->Description | string | |\r\n| assetId | MonitoringPointTriggerExpression->Asset_Id | integer | int64 |\r\n| sequenceNumber | MonitoringPointTriggerExpression->SequenceNumber | integer | int32 |\r\n| alarmCancellationType | MonitoringPointTriggerExpression->AlarmCancellationType | string (Allowed values: [ManualCancel, CancelledByExpression, CancelledByWorkOrder]) | enum |\r\n| alwaysRecordResult | MonitoringPointTriggerExpression->AlwaysRecordResult | boolean | |\r\n| expression | MonitoringPointTriggerExpression->Expression | string | |\r\n| notes | MonitoringPointTriggerExpression->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| alarmCancellationType | Nullable | False | |\r\n| alwaysRecordResult | Nullable | False | |\r\n| expression | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateMonitoringPointTriggerExpression", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateMonitoringPointTriggerExpressionResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Monitoring Point Trigger Expression batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Monitoring Point Trigger Expression" ], "summary": "Delete a collection of existing Monitoring Point Trigger Expression resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTriggerExpression->Id | integer | int64 |\r\n| version | MonitoringPointTriggerExpression->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteMonitoringPointTriggerExpression", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteMonitoringPointTriggerExpressionResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Monitoring Point Trigger Expression batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/{id}/Active": { "patch": { "tags": [ "Monitoring Point Trigger Expression" ], "summary": "Change the IsActive status for an existing Monitoring Point Trigger Expression resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointTriggerExpression->Version | integer | int32 |\r\n| isActive | MonitoringPointTriggerExpression->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeMonitoringPointTriggerExpressionIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Trigger Expression Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeMonitoringPointTriggerExpressionIsActiveResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/{id}/PermissionTree": { "patch": { "tags": [ "Monitoring Point Trigger Expression" ], "summary": "Change the PermissionTree for an existing Monitoring Point Trigger Expression resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointTriggerExpression->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointTriggerExpression->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeMonitoringPointTriggerExpressionPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Trigger Expression Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeMonitoringPointTriggerExpressionPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/Batch/Active": { "patch": { "tags": [ "Monitoring Point Trigger Expression" ], "summary": "Change the IsActive status for a collection of existing Monitoring Point Trigger Expression resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTriggerExpression->Id | integer | int64 |\r\n| version | MonitoringPointTriggerExpression->Version | integer | int32 |\r\n| isActive | MonitoringPointTriggerExpression->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeMonitoringPointTriggerExpressionIsActive", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeMonitoringPointTriggerExpressionIsActiveResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/Batch/PermissionTree": { "patch": { "tags": [ "Monitoring Point Trigger Expression" ], "summary": "Change the PermissionTree status for a collection of existing Monitoring Point Trigger Expression resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTriggerExpression->Id | integer | int64 |\r\n| version | MonitoringPointTriggerExpression->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointTriggerExpression->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeMonitoringPointTriggerExpressionPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeMonitoringPointTriggerExpressionPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/AlarmTypes/{id}": { "get": { "tags": [ "Monitoring Point Trigger Expression Alarm Type" ], "summary": "Get a Monitoring Point Trigger Expression Alarm Type resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| isActive | MonitoringPointTriggerExpressionAlarmType->IsActive | boolean | |\r\n| createdByUserId | MonitoringPointTriggerExpressionAlarmType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MonitoringPointTriggerExpressionAlarmType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MonitoringPointTriggerExpressionAlarmType->CreatedByUser_FullName | string | |\r\n| createdOn | MonitoringPointTriggerExpressionAlarmType->CreatedOn | string | date-time |\r\n| modifiedByUserId | MonitoringPointTriggerExpressionAlarmType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MonitoringPointTriggerExpressionAlarmType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MonitoringPointTriggerExpressionAlarmType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MonitoringPointTriggerExpressionAlarmType->ModifiedOn | string | date-time |\r\n| version | MonitoringPointTriggerExpressionAlarmType->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointTriggerExpressionAlarmType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MonitoringPointTriggerExpressionAlarmType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MonitoringPointTriggerExpressionAlarmType->PermissionTree_Description | string | |\r\n| id | MonitoringPointTriggerExpressionAlarmType->Id | integer | int64 |\r\n| alarmTypeId | MonitoringPointTriggerExpressionAlarmType->AlarmType_Id | integer | int64 |\r\n| alarmTypeCode | MonitoringPointTriggerExpressionAlarmType->AlarmType_Code | string | |\r\n| alarmTypeDescription | MonitoringPointTriggerExpressionAlarmType->AlarmType_Description | string | |\r\n| monitoringPointTriggerExpressionId | MonitoringPointTriggerExpressionAlarmType->MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionDescription | MonitoringPointTriggerExpressionAlarmType->MonitoringPointTriggerExpression_Description | string | |\r\n| notes | MonitoringPointTriggerExpressionAlarmType->Notes | string | |\r\n| sequenceNumber | MonitoringPointTriggerExpressionAlarmType->SequenceNumber | integer | int32 |\r\n", "operationId": "GetMonitoringPointTriggerExpressionAlarmType", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Trigger Expression Alarm Type Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Monitoring Point Trigger Expression Alarm Type", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointTriggerExpressionAlarmTypeResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Monitoring Point Trigger Expression Alarm Type" ], "summary": "Update an existing Monitoring Point Trigger Expression Alarm Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointTriggerExpressionAlarmType->Version | integer | int32 |\r\n| notes | MonitoringPointTriggerExpressionAlarmType->Notes | string | |\r\n| sequenceNumber | MonitoringPointTriggerExpressionAlarmType->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "UpdateMonitoringPointTriggerExpressionAlarmType", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Trigger Expression Alarm Type Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateMonitoringPointTriggerExpressionAlarmTypeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Monitoring Point Trigger Expression Alarm Type was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Monitoring Point Trigger Expression Alarm Type" ], "summary": "Delete an existing Monitoring Point Trigger Expression Alarm Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointTriggerExpressionAlarmType->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteMonitoringPointTriggerExpressionAlarmType", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Trigger Expression Alarm Type Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteMonitoringPointTriggerExpressionAlarmTypeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Monitoring Point Trigger Expression Alarm Type was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/AlarmTypes": { "get": { "tags": [ "Monitoring Point Trigger Expression Alarm Type" ], "summary": "Get a collection of Monitoring Point Trigger Expression Alarm Type resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTriggerExpressionAlarmType->Id | integer | int64 |\r\n| version | MonitoringPointTriggerExpressionAlarmType->Version | integer | int32 |\r\n| sequenceNumber | MonitoringPointTriggerExpressionAlarmType->SequenceNumber | integer | int32 |\r\n| alarmTypeId | MonitoringPointTriggerExpressionAlarmType->AlarmType_Id | integer | int64 |\r\n| alarmTypeCode | MonitoringPointTriggerExpressionAlarmType->AlarmType_Code | string | |\r\n| alarmTypeDescription | MonitoringPointTriggerExpressionAlarmType->AlarmType_Description | string | |\r\n| monitoringPointTriggerExpressionId | MonitoringPointTriggerExpressionAlarmType->MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionDescription | MonitoringPointTriggerExpressionAlarmType->MonitoringPointTriggerExpression_Description | string | |\r\n| monitoringPointTriggerExpressionMonitoringPointTriggerCode | MonitoringPointTriggerExpressionAlarmType->MonitoringPointTriggerExpression_MonitoringPointTrigger_Code | string | |\r\n", "operationId": "GetMonitoringPointTriggerExpressionAlarmTypeCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point Trigger Expression Alarm Type collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointTriggerExpressionAlarmTypeCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Monitoring Point Trigger Expression Alarm Type" ], "summary": "Create a new Monitoring Point Trigger Expression Alarm Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| monitoringPointTriggerExpressionId | MonitoringPointTriggerExpressionAlarmType->MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| alarmTypeId | MonitoringPointTriggerExpressionAlarmType->AlarmType_Id | integer | int64 |\r\n| sequenceNumber | MonitoringPointTriggerExpressionAlarmType->SequenceNumber | integer | int32 |\r\n| permissionTreeId | MonitoringPointTriggerExpressionAlarmType->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| monitoringPointTriggerExpressionId | Required | True | |\r\n| monitoringPointTriggerExpressionId | Nullable | False | |\r\n| alarmTypeId | Required | True | |\r\n| alarmTypeId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "CreateMonitoringPointTriggerExpressionAlarmType", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateMonitoringPointTriggerExpressionAlarmTypeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/{monitoringPointTriggerExpressionId}/AlarmTypes": { "get": { "tags": [ "Monitoring Point Trigger Expression Alarm Type" ], "summary": "Get a collection of Monitoring Point Trigger Expression Alarm Type for the Monitoring Point Trigger Expression.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTriggerExpressionAlarmType->Id | integer | int64 |\r\n| version | MonitoringPointTriggerExpressionAlarmType->Version | integer | int32 |\r\n| alarmTypeId | MonitoringPointTriggerExpressionAlarmType->AlarmType_Id | integer | int64 |\r\n| alarmTypeCode | MonitoringPointTriggerExpressionAlarmType->AlarmType_Code | string | |\r\n| alarmTypeDescription | MonitoringPointTriggerExpressionAlarmType->AlarmType_Description | string | |\r\n", "operationId": "GetMonitoringPointTriggerExpressionAlarmTypeForMonitoringPointTriggerExpressionCollection", "parameters": [ { "name": "monitoringPointTriggerExpressionId", "in": "path", "required": true, "description": "Monitoring Point Trigger Expression Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point Trigger Expression Alarm Type collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointTriggerExpressionAlarmTypeForMonitoringPointTriggerExpressionCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/AlarmTypes/Lookups/LookupMonitoringPointTriggerExpressionAlarmTypeAlarmType": { "get": { "tags": [ "Monitoring Point Trigger Expression Alarm Type" ], "summary": "Lookup the Alarm Type for the Monitoring Point Trigger Expression Alarm Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AlarmType->Id | integer | int64 |\r\n| code | AlarmType->Code | string | |\r\n| description | AlarmType->Description | string | |\r\n", "operationId": "LookupMonitoringPointTriggerExpressionAlarmTypeAlarmType", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Alarm Type collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointTriggerExpressionAlarmTypeAlarmTypeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/AlarmTypes/Lookups/LookupMonitoringPointTriggerExpressionAlarmTypeChangePermissionTree": { "get": { "tags": [ "Monitoring Point Trigger Expression Alarm Type" ], "summary": "Lookup the permission set for changing the Monitoring Point Trigger Expression Alarm Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupMonitoringPointTriggerExpressionAlarmTypeChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointTriggerExpressionAlarmTypeChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/AlarmTypes/Lookups/LookupMonitoringPointTriggerExpressionAlarmTypeInsertPermissionTree": { "get": { "tags": [ "Monitoring Point Trigger Expression Alarm Type" ], "summary": "Lookup the permission set for creating the Monitoring Point Trigger Expression Alarm Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupMonitoringPointTriggerExpressionAlarmTypeInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointTriggerExpressionAlarmTypeInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/AlarmTypes/Lookups/LookupMonitoringPointTriggerExpressionAlarmTypeMonitoringPointTriggerExpression": { "get": { "tags": [ "Monitoring Point Trigger Expression Alarm Type" ], "summary": "Lookup the Monitoring Point Trigger Expression Alarm Type for the Monitoring Point Trigger Expression Alarm Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTriggerExpression->Id | integer | int64 |\r\n| description | MonitoringPointTriggerExpression->Description | string | |\r\n", "operationId": "LookupMonitoringPointTriggerExpressionAlarmTypeMonitoringPointTriggerExpression", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point Trigger Expression collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointTriggerExpressionAlarmTypeMonitoringPointTriggerExpressionLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/AlarmTypes/Batch/{ids}": { "get": { "tags": [ "Monitoring Point Trigger Expression Alarm Type" ], "summary": "Get a collection of Monitoring Point Trigger Expression Alarm Type resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| isActive | MonitoringPointTriggerExpressionAlarmType->IsActive | boolean | |\r\n| createdByUserId | MonitoringPointTriggerExpressionAlarmType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MonitoringPointTriggerExpressionAlarmType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MonitoringPointTriggerExpressionAlarmType->CreatedByUser_FullName | string | |\r\n| createdOn | MonitoringPointTriggerExpressionAlarmType->CreatedOn | string | date-time |\r\n| modifiedByUserId | MonitoringPointTriggerExpressionAlarmType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MonitoringPointTriggerExpressionAlarmType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MonitoringPointTriggerExpressionAlarmType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MonitoringPointTriggerExpressionAlarmType->ModifiedOn | string | date-time |\r\n| version | MonitoringPointTriggerExpressionAlarmType->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointTriggerExpressionAlarmType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MonitoringPointTriggerExpressionAlarmType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MonitoringPointTriggerExpressionAlarmType->PermissionTree_Description | string | |\r\n| id | MonitoringPointTriggerExpressionAlarmType->Id | integer | int64 |\r\n| alarmTypeId | MonitoringPointTriggerExpressionAlarmType->AlarmType_Id | integer | int64 |\r\n| alarmTypeCode | MonitoringPointTriggerExpressionAlarmType->AlarmType_Code | string | |\r\n| alarmTypeDescription | MonitoringPointTriggerExpressionAlarmType->AlarmType_Description | string | |\r\n| monitoringPointTriggerExpressionId | MonitoringPointTriggerExpressionAlarmType->MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionDescription | MonitoringPointTriggerExpressionAlarmType->MonitoringPointTriggerExpression_Description | string | |\r\n| notes | MonitoringPointTriggerExpressionAlarmType->Notes | string | |\r\n| sequenceNumber | MonitoringPointTriggerExpressionAlarmType->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetMonitoringPointTriggerExpressionAlarmType", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Monitoring Point Trigger Expression Alarm Type id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Monitoring Point Trigger Expression Alarm Type collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetMonitoringPointTriggerExpressionAlarmTypeResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/AlarmTypes/Batch": { "post": { "tags": [ "Monitoring Point Trigger Expression Alarm Type" ], "summary": "Create a new collection of Monitoring Point Trigger Expression Alarm Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| monitoringPointTriggerExpressionId | MonitoringPointTriggerExpressionAlarmType->MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| alarmTypeId | MonitoringPointTriggerExpressionAlarmType->AlarmType_Id | integer | int64 |\r\n| sequenceNumber | MonitoringPointTriggerExpressionAlarmType->SequenceNumber | integer | int32 |\r\n| permissionTreeId | MonitoringPointTriggerExpressionAlarmType->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| monitoringPointTriggerExpressionId | Required | True | |\r\n| monitoringPointTriggerExpressionId | Nullable | False | |\r\n| alarmTypeId | Required | True | |\r\n| alarmTypeId | Nullable | False | |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateMonitoringPointTriggerExpressionAlarmType", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateMonitoringPointTriggerExpressionAlarmTypeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Monitoring Point Trigger Expression Alarm Type batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Monitoring Point Trigger Expression Alarm Type" ], "summary": "Update a collection of existing Monitoring Point Trigger Expression Alarm Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTriggerExpressionAlarmType->Id | integer | int64 |\r\n| version | MonitoringPointTriggerExpressionAlarmType->Version | integer | int32 |\r\n| notes | MonitoringPointTriggerExpressionAlarmType->Notes | string | |\r\n| sequenceNumber | MonitoringPointTriggerExpressionAlarmType->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateMonitoringPointTriggerExpressionAlarmType", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateMonitoringPointTriggerExpressionAlarmTypeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Monitoring Point Trigger Expression Alarm Type batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Monitoring Point Trigger Expression Alarm Type" ], "summary": "Delete a collection of existing Monitoring Point Trigger Expression Alarm Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTriggerExpressionAlarmType->Id | integer | int64 |\r\n| version | MonitoringPointTriggerExpressionAlarmType->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteMonitoringPointTriggerExpressionAlarmType", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteMonitoringPointTriggerExpressionAlarmTypeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Monitoring Point Trigger Expression Alarm Type batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/AlarmTypes/{id}/Active": { "patch": { "tags": [ "Monitoring Point Trigger Expression Alarm Type" ], "summary": "Change the IsActive status for an existing Monitoring Point Trigger Expression Alarm Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointTriggerExpressionAlarmType->Version | integer | int32 |\r\n| isActive | MonitoringPointTriggerExpressionAlarmType->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeMonitoringPointTriggerExpressionAlarmTypeIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Trigger Expression Alarm Type Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeMonitoringPointTriggerExpressionAlarmTypeIsActiveResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/AlarmTypes/{id}/PermissionTree": { "patch": { "tags": [ "Monitoring Point Trigger Expression Alarm Type" ], "summary": "Change the PermissionTree for an existing Monitoring Point Trigger Expression Alarm Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointTriggerExpressionAlarmType->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointTriggerExpressionAlarmType->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeMonitoringPointTriggerExpressionAlarmTypePermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Trigger Expression Alarm Type Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeMonitoringPointTriggerExpressionAlarmTypePermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/AlarmTypes/Batch/Active": { "patch": { "tags": [ "Monitoring Point Trigger Expression Alarm Type" ], "summary": "Change the IsActive status for a collection of existing Monitoring Point Trigger Expression Alarm Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTriggerExpressionAlarmType->Id | integer | int64 |\r\n| version | MonitoringPointTriggerExpressionAlarmType->Version | integer | int32 |\r\n| isActive | MonitoringPointTriggerExpressionAlarmType->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeMonitoringPointTriggerExpressionAlarmTypeIsActive", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeMonitoringPointTriggerExpressionAlarmTypeIsActiveResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/AlarmTypes/Batch/PermissionTree": { "patch": { "tags": [ "Monitoring Point Trigger Expression Alarm Type" ], "summary": "Change the PermissionTree status for a collection of existing Monitoring Point Trigger Expression Alarm Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTriggerExpressionAlarmType->Id | integer | int64 |\r\n| version | MonitoringPointTriggerExpressionAlarmType->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointTriggerExpressionAlarmType->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeMonitoringPointTriggerExpressionAlarmTypePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeMonitoringPointTriggerExpressionAlarmTypePermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/Evaluations": { "get": { "tags": [ "Monitoring Point Trigger Expression Evaluation" ], "summary": "Get a collection of Monitoring Point Trigger Expression Evaluation resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTriggerExpressionEvaluation->Id | integer | int64 |\r\n| executedOn | MonitoringPointTriggerExpressionEvaluation->ExecutedOn | string | date-time |\r\n| status | MonitoringPointTriggerExpressionEvaluation->Status | string (Allowed values: [Unknown, Evaluated, EvaluatedAllFaulted, EvaluatedSomeFaulted, Resubmitted]) | enum |\r\n| monitoringPointCount | MonitoringPointTriggerExpressionEvaluation->MonitoringPointCount | integer | int32 |\r\n| result | MonitoringPointTriggerExpressionEvaluation->Result | object | |\r\n", "operationId": "GetMonitoringPointTriggerExpressionEvaluationCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point Trigger Expression Evaluation collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointTriggerExpressionEvaluationCollectionResourceActionResponse2" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/Evaluations/Failures": { "get": { "tags": [ "Monitoring Point Trigger Expression Evaluation" ], "summary": "Get a collection of Monitoring Point Trigger Expression Evaluation resource failures.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTriggerExpressionEvaluation->Id | integer | int64 |\r\n| executedOn | MonitoringPointTriggerExpressionEvaluation->ExecutedOn | string | date-time |\r\n| status | MonitoringPointTriggerExpressionEvaluation->Status | string (Allowed values: [Unknown, Evaluated, EvaluatedAllFaulted, EvaluatedSomeFaulted, Resubmitted]) | enum |\r\n| monitoringPointCount | MonitoringPointTriggerExpressionEvaluation->MonitoringPointCount | integer | int32 |\r\n| result | MonitoringPointTriggerExpressionEvaluation->Result | object | |\r\n", "operationId": "GetMonitoringPointTriggerExpressionEvaluationFailuresCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point Trigger Expression Evaluation collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointTriggerExpressionEvaluationFailuresCollectionResourceActionResponse2" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/Evaluations/Resubmit": { "post": { "tags": [ "Monitoring Point Trigger Expression Evaluation" ], "summary": "Resubmit a failed Monitoring Point Trigger Expression Evaluation resource", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| evaluationIds | ResubmitEvaluation->EvaluationIds | array | array |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| evaluationIds | Required | True | |\r\n| evaluationIds | Nullable | False | |\r\n\r\n", "operationId": "ResubmitMonitoringPointTriggerExpressionEvaluation", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/ResubmitMonitoringPointTriggerExpressionEvaluationResourceActionRequest2" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/Evaluations/Logs": { "get": { "tags": [ "Monitoring Point Trigger Expression Evaluation Log" ], "summary": "Get a collection of Monitoring Point Trigger Expression Evaluation Log resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTriggerExpressionEvaluationLog->Id | integer | int64 |\r\n| evaluationExecutedOn | MonitoringPointTriggerExpressionEvaluationLog->Evaluation_ExecutedOn | string | date-time |\r\n| evaluationStatus | MonitoringPointTriggerExpressionEvaluationLog->Evaluation_Status | string (Allowed values: [Unknown, Evaluated, EvaluatedAllFaulted, EvaluatedSomeFaulted, Resubmitted]) | enum |\r\n| monitoringPointTriggerExpressionId | MonitoringPointTriggerExpressionEvaluationLog->MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionDescription | MonitoringPointTriggerExpressionEvaluationLog->MonitoringPointTriggerExpression_Description | string | |\r\n| expressionVersion | MonitoringPointTriggerExpressionEvaluationLog->ExpressionVersion | integer | int32 |\r\n| monitoringPointId | MonitoringPointTriggerExpressionEvaluationLog->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | MonitoringPointTriggerExpressionEvaluationLog->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | MonitoringPointTriggerExpressionEvaluationLog->MonitoringPoint_Description | string | |\r\n| processStatus | MonitoringPointTriggerExpressionEvaluationLog->ProcessStatus | string (Allowed values: [AllAlarmTypesEliminated, NoAlarmTypesForExpression, NoTasksUsingExpression, AllTasksEliminated, ProcessAlarmTypes]) | enum |\r\n| executionStatus | MonitoringPointTriggerExpressionEvaluationLog->ExecutionStatus | string (Allowed values: [ExecutionRequired, Executed, SkipExecution, FormulaCompileError, UnhandledException]) | enum |\r\n| executionType | MonitoringPointTriggerExpressionEvaluationLog->ExecutionType | string (Allowed values: [StandaloneTriggerExpression, AssetRegisterTriggerExpression]) | enum |\r\n| expressionTriggered | MonitoringPointTriggerExpressionEvaluationLog->ExpressionTriggered | boolean | |\r\n| detectedAssetCount | MonitoringPointTriggerExpressionEvaluationLog->DetectedAssetCount | integer | int32 |\r\n| configuredAlarmTypeCount | MonitoringPointTriggerExpressionEvaluationLog->ConfiguredAlarmTypeCount | integer | int32 |\r\n| alarmsGenerated | MonitoringPointTriggerExpressionEvaluationLog->AlarmsGenerated | array | array |\r\n| result | MonitoringPointTriggerExpressionEvaluationLog->Result | object | |\r\n", "operationId": "GetMonitoringPointTriggerExpressionEvaluationLogCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point Trigger Expression Evaluation Log collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointTriggerExpressionEvaluationLogCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/Evaluations/{id}/Logs": { "get": { "tags": [ "Monitoring Point Trigger Expression Evaluation Log" ], "summary": "Get a collection of Monitoring Point Trigger Expression Evaluation Log resources for an evaluation.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTriggerExpressionEvaluationLog->Id | integer | int64 |\r\n| evaluationExecutedOn | MonitoringPointTriggerExpressionEvaluationLog->Evaluation_ExecutedOn | string | date-time |\r\n| evaluationStatus | MonitoringPointTriggerExpressionEvaluationLog->Evaluation_Status | string (Allowed values: [Unknown, Evaluated, EvaluatedAllFaulted, EvaluatedSomeFaulted, Resubmitted]) | enum |\r\n| monitoringPointTriggerExpressionId | MonitoringPointTriggerExpressionEvaluationLog->MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionDescription | MonitoringPointTriggerExpressionEvaluationLog->MonitoringPointTriggerExpression_Description | string | |\r\n| expressionVersion | MonitoringPointTriggerExpressionEvaluationLog->ExpressionVersion | integer | int32 |\r\n| monitoringPointId | MonitoringPointTriggerExpressionEvaluationLog->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | MonitoringPointTriggerExpressionEvaluationLog->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | MonitoringPointTriggerExpressionEvaluationLog->MonitoringPoint_Description | string | |\r\n| processStatus | MonitoringPointTriggerExpressionEvaluationLog->ProcessStatus | string (Allowed values: [AllAlarmTypesEliminated, NoAlarmTypesForExpression, NoTasksUsingExpression, AllTasksEliminated, ProcessAlarmTypes]) | enum |\r\n| executionStatus | MonitoringPointTriggerExpressionEvaluationLog->ExecutionStatus | string (Allowed values: [ExecutionRequired, Executed, SkipExecution, FormulaCompileError, UnhandledException]) | enum |\r\n| executionType | MonitoringPointTriggerExpressionEvaluationLog->ExecutionType | string (Allowed values: [StandaloneTriggerExpression, AssetRegisterTriggerExpression]) | enum |\r\n| expressionTriggered | MonitoringPointTriggerExpressionEvaluationLog->ExpressionTriggered | boolean | |\r\n| detectedAssetCount | MonitoringPointTriggerExpressionEvaluationLog->DetectedAssetCount | integer | int32 |\r\n| configuredAlarmTypeCount | MonitoringPointTriggerExpressionEvaluationLog->ConfiguredAlarmTypeCount | integer | int32 |\r\n| alarmsGenerated | MonitoringPointTriggerExpressionEvaluationLog->AlarmsGenerated | array | array |\r\n| result | MonitoringPointTriggerExpressionEvaluationLog->Result | object | |\r\n", "operationId": "GetMonitoringPointTriggerExpressionEvaluationLogForEvaluationCollection", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Trigger Expression Evaluation Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point Trigger Expression Evaluation Log collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointTriggerExpressionEvaluationLogForEvaluationCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/Parameters/{id}": { "get": { "tags": [ "Monitoring Point Trigger Expression Parameter" ], "summary": "Get a Monitoring Point Trigger Expression Parameter resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| isActive | MonitoringPointTriggerExpressionParameter->IsActive | boolean | |\r\n| createdByUserId | MonitoringPointTriggerExpressionParameter->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MonitoringPointTriggerExpressionParameter->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MonitoringPointTriggerExpressionParameter->CreatedByUser_FullName | string | |\r\n| createdOn | MonitoringPointTriggerExpressionParameter->CreatedOn | string | date-time |\r\n| modifiedByUserId | MonitoringPointTriggerExpressionParameter->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MonitoringPointTriggerExpressionParameter->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MonitoringPointTriggerExpressionParameter->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MonitoringPointTriggerExpressionParameter->ModifiedOn | string | date-time |\r\n| version | MonitoringPointTriggerExpressionParameter->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointTriggerExpressionParameter->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MonitoringPointTriggerExpressionParameter->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MonitoringPointTriggerExpressionParameter->PermissionTree_Description | string | |\r\n| id | MonitoringPointTriggerExpressionParameter->Id | integer | int64 |\r\n| entityType | MonitoringPointTriggerExpressionParameter->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| monitoringPointId | MonitoringPointTriggerExpressionParameter->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | MonitoringPointTriggerExpressionParameter->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | MonitoringPointTriggerExpressionParameter->MonitoringPoint_Description | string | |\r\n| monitoringPointTriggerExpressionId | MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionDescription | MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_Description | string | |\r\n| monitoringPointTypeId | MonitoringPointTriggerExpressionParameter->MonitoringPointType_Id | integer | int64 |\r\n| monitoringPointTypeCode | MonitoringPointTriggerExpressionParameter->MonitoringPointType_Code | string | |\r\n| monitoringPointTypeDescription | MonitoringPointTriggerExpressionParameter->MonitoringPointType_Description | string | |\r\n| notes | MonitoringPointTriggerExpressionParameter->Notes | string | |\r\n| parameterName | MonitoringPointTriggerExpressionParameter->ParameterName | string | |\r\n| parameterType | MonitoringPointTriggerExpressionParameter->ParameterType | string (Allowed values: [MonitoringPoint, Static, Entity]) | enum |\r\n| parameterValue | MonitoringPointTriggerExpressionParameter->ParameterValue | object | composite |\r\n| sequenceNumber | MonitoringPointTriggerExpressionParameter->SequenceNumber | integer | int32 |\r\n", "operationId": "GetMonitoringPointTriggerExpressionParameter", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Trigger Expression Parameter Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Monitoring Point Trigger Expression Parameter", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointTriggerExpressionParameterResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Monitoring Point Trigger Expression Parameter" ], "summary": "Update an existing Monitoring Point Trigger Expression Parameter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointTriggerExpressionParameter->Version | integer | int32 |\r\n| entityType | MonitoringPointTriggerExpressionParameter->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| parameterName | MonitoringPointTriggerExpressionParameter->ParameterName | string | |\r\n| parameterValue | MonitoringPointTriggerExpressionParameter->ParameterValue | object | composite |\r\n| monitoringPointId | MonitoringPointTriggerExpressionParameter->MonitoringPoint_Id | integer | int64 |\r\n| sequenceNumber | MonitoringPointTriggerExpressionParameter->SequenceNumber | integer | int32 |\r\n| notes | MonitoringPointTriggerExpressionParameter->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| entityType | Nullable | False | MonitoringPointTriggerExpressionParameter->ParameterType eq 'Entity' |\r\n| entityType | Nullable | True | MonitoringPointTriggerExpressionParameter->ParameterType ne 'Entity' |\r\n| parameterName | Nullable | False | |\r\n| parameterValue | Nullable | False | MonitoringPointTriggerExpressionParameter->ParameterType ne 'MonitoringPoint' |\r\n| parameterValue | Nullable | True | MonitoringPointTriggerExpressionParameter->ParameterType eq 'MonitoringPoint' |\r\n\r\n", "operationId": "UpdateMonitoringPointTriggerExpressionParameter", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Trigger Expression Parameter Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateMonitoringPointTriggerExpressionParameterResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Monitoring Point Trigger Expression Parameter was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Monitoring Point Trigger Expression Parameter" ], "summary": "Delete an existing Monitoring Point Trigger Expression Parameter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointTriggerExpressionParameter->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteMonitoringPointTriggerExpressionParameter", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Trigger Expression Parameter Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteMonitoringPointTriggerExpressionParameterResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Monitoring Point Trigger Expression Parameter was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/Parameters": { "get": { "tags": [ "Monitoring Point Trigger Expression Parameter" ], "summary": "Get a collection of Monitoring Point Trigger Expression Parameter resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTriggerExpressionParameter->Id | integer | int64 |\r\n| version | MonitoringPointTriggerExpressionParameter->Version | integer | int32 |\r\n| monitoringPointTriggerExpressionId | MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionMonitoringPointTriggerId | MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_MonitoringPointTrigger_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionMonitoringPointTriggerCode | MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_MonitoringPointTrigger_Code | string | |\r\n| monitoringPointTriggerExpressionMonitoringPointTriggerDescription | MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_MonitoringPointTrigger_Description | string | |\r\n| monitoringPointTriggerExpressionDescription | MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_Description | string | |\r\n| monitoringPointId | MonitoringPointTriggerExpressionParameter->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | MonitoringPointTriggerExpressionParameter->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | MonitoringPointTriggerExpressionParameter->MonitoringPoint_Description | string | |\r\n| monitoringPointTypeId | MonitoringPointTriggerExpressionParameter->MonitoringPointType_Id | integer | int64 |\r\n| monitoringPointTypeCode | MonitoringPointTriggerExpressionParameter->MonitoringPointType_Code | string | |\r\n| monitoringPointTypeDescription | MonitoringPointTriggerExpressionParameter->MonitoringPointType_Description | string | |\r\n| entityType | MonitoringPointTriggerExpressionParameter->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| parameterName | MonitoringPointTriggerExpressionParameter->ParameterName | string | |\r\n| parameterType | MonitoringPointTriggerExpressionParameter->ParameterType | string (Allowed values: [MonitoringPoint, Static, Entity]) | enum |\r\n| parameterValue | MonitoringPointTriggerExpressionParameter->ParameterValue | object | composite |\r\n| createdOn | MonitoringPointTriggerExpressionParameter->CreatedOn | string | date-time |\r\n| modifiedOn | MonitoringPointTriggerExpressionParameter->ModifiedOn | string | date-time |\r\n", "operationId": "GetMonitoringPointTriggerExpressionParameterCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point Trigger Expression Parameter collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointTriggerExpressionParameterCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Monitoring Point Trigger Expression Parameter" ], "summary": "Create a new Monitoring Point Trigger Expression Parameter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | MonitoringPointTriggerExpressionParameter->PermissionTree_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionId | MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| monitoringPointId | MonitoringPointTriggerExpressionParameter->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointTypeId | MonitoringPointTriggerExpressionParameter->MonitoringPointType_Id | integer | int64 |\r\n| entityType | MonitoringPointTriggerExpressionParameter->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| parameterName | MonitoringPointTriggerExpressionParameter->ParameterName | string | |\r\n| parameterType | MonitoringPointTriggerExpressionParameter->ParameterType | string (Allowed values: [MonitoringPoint, Static, Entity]) | enum |\r\n| parameterValue | MonitoringPointTriggerExpressionParameter->ParameterValue | object | composite |\r\n| sequenceNumber | MonitoringPointTriggerExpressionParameter->SequenceNumber | integer | int32 |\r\n| notes | MonitoringPointTriggerExpressionParameter->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| monitoringPointTriggerExpressionId | Required | True | |\r\n| monitoringPointTriggerExpressionId | Nullable | False | |\r\n| monitoringPointTypeId | Nullable | False | MonitoringPointTriggerExpressionParameter->ParameterType eq 'MonitoringPoint' |\r\n| monitoringPointTypeId | Nullable | True | MonitoringPointTriggerExpressionParameter->ParameterType ne 'MonitoringPoint' |\r\n| entityType | Nullable | False | MonitoringPointTriggerExpressionParameter->ParameterType eq 'Entity' |\r\n| entityType | Nullable | True | MonitoringPointTriggerExpressionParameter->ParameterType ne 'Entity' |\r\n| parameterName | Required | True | |\r\n| parameterName | Nullable | False | |\r\n| parameterType | Required | True | |\r\n| parameterType | Nullable | False | |\r\n| parameterValue | Nullable | False | MonitoringPointTriggerExpressionParameter->ParameterType ne 'MonitoringPoint' |\r\n| parameterValue | Nullable | True | MonitoringPointTriggerExpressionParameter->ParameterType eq 'MonitoringPoint' |\r\n\r\n", "operationId": "CreateMonitoringPointTriggerExpressionParameter", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateMonitoringPointTriggerExpressionParameterResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/{monitoringPointTriggerExpressionId}/Parameters": { "get": { "tags": [ "Monitoring Point Trigger Expression Parameter" ], "summary": "Get a collection of Monitoring Point Trigger Expression Parameter resources for the Monitoring Point Trigger Expression.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTriggerExpressionParameter->Id | integer | int64 |\r\n| version | MonitoringPointTriggerExpressionParameter->Version | integer | int32 |\r\n| entityType | MonitoringPointTriggerExpressionParameter->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| monitoringPointId | MonitoringPointTriggerExpressionParameter->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | MonitoringPointTriggerExpressionParameter->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | MonitoringPointTriggerExpressionParameter->MonitoringPoint_Description | string | |\r\n| monitoringPointTypeId | MonitoringPointTriggerExpressionParameter->MonitoringPointType_Id | integer | int64 |\r\n| monitoringPointTypeCode | MonitoringPointTriggerExpressionParameter->MonitoringPointType_Code | string | |\r\n| monitoringPointTypeDescription | MonitoringPointTriggerExpressionParameter->MonitoringPointType_Description | string | |\r\n| monitoringPointTriggerExpressionId | MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionDescription | MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_Description | string | |\r\n| monitoringPointTriggerExpressionMonitoringPointTriggerId | MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_MonitoringPointTrigger_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionMonitoringPointTriggerCode | MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_MonitoringPointTrigger_Code | string | |\r\n| monitoringPointTriggerExpressionMonitoringPointTriggerDescription | MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_MonitoringPointTrigger_Description | string | |\r\n| parameterName | MonitoringPointTriggerExpressionParameter->ParameterName | string | |\r\n| parameterType | MonitoringPointTriggerExpressionParameter->ParameterType | string (Allowed values: [MonitoringPoint, Static, Entity]) | enum |\r\n| parameterValue | MonitoringPointTriggerExpressionParameter->ParameterValue | object | composite |\r\n", "operationId": "GetMonitoringPointTriggerExpressionParameterForMonitoringPointTriggerExpressionCollection", "parameters": [ { "name": "monitoringPointTriggerExpressionId", "in": "path", "required": true, "description": "Monitoring Point Trigger Expression Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point Trigger Expression Parameter collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointTriggerExpressionParameterForMonitoringPointTriggerExpressionCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/Parameters/Lookups/LookupMonitoringPointTriggerExpressionParameterEntityType": { "get": { "tags": [ "Monitoring Point Trigger Expression Parameter" ], "summary": "Monitoring Point Trigger Expression Parameter", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| entityType | MonitoringPointTriggerExpressionParameterEntityTypeSummary->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n", "operationId": "LookupMonitoringPointTriggerExpressionParameterEntityType", "parameters": [ { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point Trigger Expression Parameter Entity collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointTriggerExpressionParameterEntityTypeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/Parameters/Lookups/LookupMonitoringPointTriggerExpressionParameterInsertPermissionTree": { "get": { "tags": [ "Monitoring Point Trigger Expression Parameter" ], "summary": "Lookup the permission set for creating the Monitoring Point Trigger Expression Parameter.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupMonitoringPointTriggerExpressionParameterInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointTriggerExpressionParameterInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/Parameters/Lookups/LookupMonitoringPointTriggerExpressionParameterMonitoringPoint": { "get": { "tags": [ "Monitoring Point Trigger Expression Parameter" ], "summary": "Lookup the Monitoring Point for the Monitoring Point Trigger Expression Parameter.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPoint->Id | integer | int64 |\r\n| code | MonitoringPoint->Code | string | |\r\n| description | MonitoringPoint->Description | string | |\r\n", "operationId": "LookupMonitoringPointTriggerExpressionParameterMonitoringPoint", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointTriggerExpressionParameterMonitoringPointLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/Parameters/Lookups/LookupMonitoringPointTriggerExpressionParameterMonitoringPointTriggerExpression": { "get": { "tags": [ "Monitoring Point Trigger Expression Parameter" ], "summary": "Lookup the Monitoring Point Trigger Expression for the Monitoring Point Trigger Expression Parameter.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTriggerExpression->Id | integer | int64 |\r\n| description | MonitoringPointTriggerExpression->Description | string | |\r\n", "operationId": "LookupMonitoringPointTriggerExpressionParameterMonitoringPointTriggerExpression", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point Trigger Expression collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/Parameters/Lookups/LookupMonitoringPointTriggerExpressionParameterMonitoringPointType": { "get": { "tags": [ "Monitoring Point Trigger Expression Parameter" ], "summary": "Lookup the Monitoring Point Type for the Monitoring Point Trigger Expression Parameter.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointType->Id | integer | int64 |\r\n| code | MonitoringPointType->Code | string | |\r\n| description | MonitoringPointType->Description | string | |\r\n", "operationId": "LookupMonitoringPointTriggerExpressionParameterMonitoringPointType", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point Type collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointTriggerExpressionParameterMonitoringPointTypeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/Parameters/Batch/{ids}": { "get": { "tags": [ "Monitoring Point Trigger Expression Parameter" ], "summary": "Get a collection of Monitoring Point Trigger Expression Parameter resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| isActive | MonitoringPointTriggerExpressionParameter->IsActive | boolean | |\r\n| createdByUserId | MonitoringPointTriggerExpressionParameter->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MonitoringPointTriggerExpressionParameter->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MonitoringPointTriggerExpressionParameter->CreatedByUser_FullName | string | |\r\n| createdOn | MonitoringPointTriggerExpressionParameter->CreatedOn | string | date-time |\r\n| modifiedByUserId | MonitoringPointTriggerExpressionParameter->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MonitoringPointTriggerExpressionParameter->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MonitoringPointTriggerExpressionParameter->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MonitoringPointTriggerExpressionParameter->ModifiedOn | string | date-time |\r\n| version | MonitoringPointTriggerExpressionParameter->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointTriggerExpressionParameter->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MonitoringPointTriggerExpressionParameter->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MonitoringPointTriggerExpressionParameter->PermissionTree_Description | string | |\r\n| id | MonitoringPointTriggerExpressionParameter->Id | integer | int64 |\r\n| entityType | MonitoringPointTriggerExpressionParameter->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| monitoringPointId | MonitoringPointTriggerExpressionParameter->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointCode | MonitoringPointTriggerExpressionParameter->MonitoringPoint_Code | string | |\r\n| monitoringPointDescription | MonitoringPointTriggerExpressionParameter->MonitoringPoint_Description | string | |\r\n| monitoringPointTriggerExpressionId | MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionDescription | MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_Description | string | |\r\n| monitoringPointTypeId | MonitoringPointTriggerExpressionParameter->MonitoringPointType_Id | integer | int64 |\r\n| monitoringPointTypeCode | MonitoringPointTriggerExpressionParameter->MonitoringPointType_Code | string | |\r\n| monitoringPointTypeDescription | MonitoringPointTriggerExpressionParameter->MonitoringPointType_Description | string | |\r\n| notes | MonitoringPointTriggerExpressionParameter->Notes | string | |\r\n| parameterName | MonitoringPointTriggerExpressionParameter->ParameterName | string | |\r\n| parameterType | MonitoringPointTriggerExpressionParameter->ParameterType | string (Allowed values: [MonitoringPoint, Static, Entity]) | enum |\r\n| parameterValue | MonitoringPointTriggerExpressionParameter->ParameterValue | object | composite |\r\n| sequenceNumber | MonitoringPointTriggerExpressionParameter->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetMonitoringPointTriggerExpressionParameter", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Monitoring Point Trigger Expression Parameter id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Monitoring Point Trigger Expression Parameter collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetMonitoringPointTriggerExpressionParameterResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/Parameters/Batch": { "post": { "tags": [ "Monitoring Point Trigger Expression Parameter" ], "summary": "Create a new collection of Monitoring Point Trigger Expression Parameter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| permissionTreeId | MonitoringPointTriggerExpressionParameter->PermissionTree_Id | integer | int64 |\r\n| monitoringPointTriggerExpressionId | MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_Id | integer | int64 |\r\n| monitoringPointId | MonitoringPointTriggerExpressionParameter->MonitoringPoint_Id | integer | int64 |\r\n| monitoringPointTypeId | MonitoringPointTriggerExpressionParameter->MonitoringPointType_Id | integer | int64 |\r\n| entityType | MonitoringPointTriggerExpressionParameter->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| parameterName | MonitoringPointTriggerExpressionParameter->ParameterName | string | |\r\n| parameterType | MonitoringPointTriggerExpressionParameter->ParameterType | string (Allowed values: [MonitoringPoint, Static, Entity]) | enum |\r\n| parameterValue | MonitoringPointTriggerExpressionParameter->ParameterValue | object | composite |\r\n| sequenceNumber | MonitoringPointTriggerExpressionParameter->SequenceNumber | integer | int32 |\r\n| notes | MonitoringPointTriggerExpressionParameter->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| monitoringPointTriggerExpressionId | Required | True | |\r\n| monitoringPointTriggerExpressionId | Nullable | False | |\r\n| monitoringPointTypeId | Nullable | False | MonitoringPointTriggerExpressionParameter->ParameterType eq 'MonitoringPoint' |\r\n| monitoringPointTypeId | Nullable | True | MonitoringPointTriggerExpressionParameter->ParameterType ne 'MonitoringPoint' |\r\n| entityType | Nullable | False | MonitoringPointTriggerExpressionParameter->ParameterType eq 'Entity' |\r\n| entityType | Nullable | True | MonitoringPointTriggerExpressionParameter->ParameterType ne 'Entity' |\r\n| parameterName | Required | True | |\r\n| parameterName | Nullable | False | |\r\n| parameterType | Required | True | |\r\n| parameterType | Nullable | False | |\r\n| parameterValue | Nullable | False | MonitoringPointTriggerExpressionParameter->ParameterType ne 'MonitoringPoint' |\r\n| parameterValue | Nullable | True | MonitoringPointTriggerExpressionParameter->ParameterType eq 'MonitoringPoint' |\r\n\r\n", "operationId": "BatchCreateMonitoringPointTriggerExpressionParameter", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateMonitoringPointTriggerExpressionParameterResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Monitoring Point Trigger Expression Parameter batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Monitoring Point Trigger Expression Parameter" ], "summary": "Update a collection of existing Monitoring Point Trigger Expression Parameter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTriggerExpressionParameter->Id | integer | int64 |\r\n| version | MonitoringPointTriggerExpressionParameter->Version | integer | int32 |\r\n| entityType | MonitoringPointTriggerExpressionParameter->EntityType | string (Allowed values: [Alarm, NewAlarm, AlarmExpression, AlarmExpressionTask, AlarmAttribute, AlarmDocument, AlarmType, MonitoringPoint, MonitoringPointBoundEvaluationLog, MonitoringPointParameter, MonitoringPointReading, MonitoringPointTrigger, MonitoringPointTriggerExpression, MonitoringPointTriggerExpressionAlarmType, MonitoringPointTriggerExpressionParameter, MonitoringPointTriggerExpressionEvaluation, MonitoringPointTriggerExpressionEvaluationLog, MonitoringPointType, MonitoringPointTypeParameter, MonitoringPointAttribute, MonitoringPointDocument, AuxiliaryAssetTask, AuxiliaryAssetTaskResource, AuxiliaryAssetTaskSpare, AuxiliaryAssetTaskSubTask, RegularAssetComponent, RegularAssetComponentAttribute, RegularAssetComponentDocument, RegularAssetComponentRuleEvaluationFailure, AssetComponent, AssetWarranty, PlaceholderAssetComponent, PlaceholderAssetComponentOptionValue, PlaceholderAssetComponentCondition, PlaceholderAssetMeter, PlaceholderAssetComponentRuleEvaluationFailure, RegularAssetCondition, RegularAssetActiveCondition, AssetFmeca, RegularAssetOptionValue, Asset, RegularAssetAttribute, RegularAssetDocument, RegularAssetFileAttachment, PlaceholderAsset, PlaceholderAssetAttribute, PlaceholderAssetDocument, PlaceholderAssetFileAttachment, PlaceholderAssetRuleEvaluationFailure, PlaceholderAssetResponsibility, PlaceholderAssetCondition, PlaceholderAssetActiveCondition, AssetTask, SetAssetTaskSpareWarehouseEntity, RegularAssetTask, RegularAssetTaskRuleEvaluationFailure, RegularAssetTaskAttribute, RegularAssetTaskAuxiliaryTask, RegularAssetTaskFollowUpTask, RegularAssetTaskFollowUpTaskExpression, RegularAssetTaskSuppressedTask, RegularAssetTaskResource, RegularAssetTaskResourceRuleEvaluationFailure, RegularAssetTaskSpare, RegularAssetTaskSpareRuleEvaluationFailure, RegularAssetTaskSubTask, RegularAssetTaskFileAttachment, AuxiliaryAssetTypeTask, AuxiliaryAssetTypeTaskResource, AuxiliaryAssetTypeTaskSpare, AuxiliaryAssetTypeTaskSubTask, RegularAssetTypeComponent, RegularAssetTypeComponentAttribute, RegularAssetTypeComponentDocument, AssetTypeComponent, PlaceholderAssetTypeComponent, PlaceholderAssetTypeComponentCondition, PlaceholderAssetTypeComponentAttribute, PlaceholderAssetTypeComponentDocument, PlaceholderAssetTypeComponentRuleLink, RegularAssetTypeComponentRuleLink, PlaceholderAssetComponentAttribute, PlaceholderAssetComponentDocument, PlaceholderAssetComponentActiveCondition, AssetTypeFmeca, AssetTypeFunction, AssetFunction, AssetFmecaTask, AssetTypeFmecaTask, AssetTypeFolder, RegularAssetTypeOption, AssetType, PlaceholderAssetType, PlaceholderAssetTypeSpare, PlaceholderAssetTypeAttribute, PlaceholderAssetTypeDocument, PlaceholderAssetTypeResponsibility, PlaceholderAssetTypeRuleLink, RegularAssetTypeTask, RegularAssetTypeTaskAttribute, RegularAssetTypeTaskAuxiliaryTask, RegularAssetTypeTaskCondition, RegularAssetTypeTaskDocument, RegularAssetTypeTaskFollowUpTask, RegularAssetTypeTaskFollowUpTaskExpression, AssetTypeTask, AssetTypeTaskResource, AssetTaskResource, AssetTaskSpare, AssetTypeTaskSpare, RegularAssetTypeTaskResource, RegularAssetTypeTaskRuleLink, RegularAssetTypeTaskSpare, RegularAssetTypeTaskSubTask, RegularAssetTypeTaskSuppressedTask, Condition, ConditionType, Event, FailureCause, FailureCauseType, FailureMechanism, FailureMechanismType, FailureMode, FailureModeType, InPlaceAssetMeter, InPlaceAssetAttribute, InPlaceAssetFileAttachment, InPlaceAssetRuleEvaluationFailure, InPlaceAssetResponsibility, InPlaceAssetSpare, InPlaceAssetType, InPlaceAssetTypeResponsibility, InPlaceAssetTypeRuleLink, InPlaceAssetTypeSpare, InPlaceAsset, Option, OptionCategory, RegularAsset, RegularAssetTaskDocument, RegularAssetMeter, RegularAssetResponsibility, RegularAssetMonitoringPointTrigger, RegularAssetSpare, RegularAssetTaskCondition, RegularAssetType, RegularAssetTypeAttribute, RegularAssetTypeDocument, RegularAssetTypeCondition, PlaceholderAssetTypeCondition, RegularAssetTypeRule, RegularAssetTypeResponsibility, RegularAssetTypeMonitoringPointTrigger, RegularAssetTypeSpare, RepairType, Rule, RuleCategory, RuleOption, StandardTask, StandardTaskSpare, StandardTaskSubTask, StandardTaskResource, StandardTaskAttribute, StandardTaskDocument, TaskImportance, TaskInterval, TaskIntervalType, TaskRollUpPoint, TypeOfWork, RegularAssetTypeTaskSpareRuleLink, InPlaceAssetTypeAttribute, RegularAssetTypeTaskResourceRuleLink, PlaceholderAssetSpare, RegularAssetMonitoringPointTriggerParameter, AssetSpare, AssetTypeSpare, AssetMeter, AssetConsumption, RegularAssetConsumption, PlaceholderAssetConsumption, InPlaceAssetConsumption, WarrantyType, RegularAssetTypeFileAttachment, Meter, MeterAttribute, MeterDocument, MeterReading, PredictedMeterReading, TimeLossCategory, TimeLossReason, TimeLossType, Consumable, AcquisitionStatus, AcquisitionType, DocumentFolder, DocumentRecord, DocumentRecordAttribute, FileAttachment, FileAttachmentCategory, FileAttachmentContentHistory, DocumentRecordFileHistory, Costing, CostingBudget, CostCentre, CostCentreAttribute, CostCentreDocument, CostCentreType, CostElement, CostElementAttribute, CostElementDocument, Currency, BudgetTemplate, BudgetTemplateParameter, FinancialYear, FinancialYearPeriod, GeneralLedger, GeneralLedgerAttribute, GeneralLedgerDocument, CurrencyRate, Budget, BudgetParameter, AddressType, Approval, Attribute, AttributeAllowedValue, Calendar, CalendarDay, CalendarException, CalendarDayHour, Classification, ClassificationAllowedValue, EmailType, Language, OperationalRole, OperationalRoleTemplate, OperationalRoleResource, PhoneNumberType, UserOperationalRole, UserOperationalRoleTemplate, UserOperationalRoleResource, TermsAndCondition, TermsAndConditionVersion, TermsAndConditionOperationalRole, UserTermsAndConditionVersion, Location, LocationAttribute, LocationDocument, LocalisationSet, LocalisationKey, LocalisationTranslation, Phrase, PhraseTranslation, PreconfiguredReason, Site, SiteAttribute, SiteDocument, SiteType, Supplier, SupplierFileAttachment, SupplierAttribute, SupplierDocument, SupplierContactAddress, SupplierContactEmail, SupplierContactPhoneNumber, SupplierResource, SupplierTaxRate, UnitOfMeasurement, SiteResource, SiteContactAddress, SiteContactEmail, SiteContactPhoneNumber, ChangeDataTrigger, ChangeDataTriggerOccurrenceLog, ChangeDataTriggerCriteria, NotificationTemplate, ChangeDataTriggerCriteriaParameter, ChangeDataTriggerNotificationEvent, NotificationTemplateParameter, ChangeDataTriggerNotificationEventAttachment, ChangeDataTriggerNotificationEventAttachmentParameter, RequestType, Category, Commodity, MaterialMaster, MaterialMasterAttribute, MaterialMasterDocument, MaterialMasterBin, MaterialMasterSupplier, MaterialMasterLinkWarehouse, StockItem, StockItemFileAttachment, StockItemAttribute, StockItemDocument, StockItemBin, StockItemSupplier, WarehouseAttribute, Warehouse, WarehouseDocument, Requisition, RequisitionFileAttachment, RequisitionStatus, RequisitionStatusChange, RequisitionStatusAttribute, RequisitionStatusDocument, RequisitionStatusChangeHistory, RequisitionItemTransaction, ApprovalRole, RequisitionAttribute, RequisitionDocument, RequisitionTransaction, RequisitionItem, RequisitionItemFileAttachment, UserSiteApprovalRole, ApprovalWorkflow, ApprovalWorkflowExpression, ApprovalWorkflowExpressionApprovalRole, Competency, Resource, ResourceAttribute, ResourceAddress, ResourceClassification, ResourceCompetency, ResourceDocument, ResourceEmail, ResourcePhoneNumber, ResourceTrade, ResourceTradeCompetency, ResourceTradeFinancialRate, Section, SectionAttribute, SectionDocument, SectionTrade, TradeAttribute, TradeDocument, Trade, TradeCompetency, TradeFinancialRate, ResourceContext, ResourceFileAttachment, AssetImportance, RiskConsequence, RiskConsequenceCategory, RiskModel, RiskModelConsequenceCategory, RiskModelImportance, RiskModelProbability, RiskProbability, WorkOrderImportance, WorkOrderStatus, WorkOrderStatusAttribute, WorkOrderStatusDocument, WorkOrderStatusAllowedChange, WorkOrder, WorkOrderStatusChangeHistory, WorkOrderStatusChange, WorkOrderMerge, WorkOrderSplit, WorkOrderMeter, WorkOrderAttribute, WorkOrderDocument, WorkOrderFileAttachment, WorkOrderTaskFileAttachment, WorkOrderTaskWarranty, WorkOrderTaskSpareFileAttachment, WorkOrderTask, WorkOrderTaskDocument, WorkOrderTaskAdHocCost, WorkOrderMonitoringPoint, WorkOrderTaskMonitoringPoint, WorkOrderTaskSpare, WorkOrderTaskSubTask, WorkOrderTaskResource, WorkOrderTaskResourceUsage, DueTask, DueTaskSuppressor, ProposedWorkOrderBatch, ProposedWorkOrder, ProposedWorkOrderTask, ProposedWorkOrderMeter, WorkOrderMovement, WorkOrderTaskMovement, WorkOrderTaskResourceMovement, WorkOrderTaskSpareMovement, WorkOrderTaskSubTaskMovement, WorkOrderCompleteAllTasksLog, WorkRequest, WorkRequestAttribute, WorkRequestDocument, WorkRequestStatus, WorkRequestStatusChange, WorkRequestStatusChangeHistory, WorkRequestFileAttachment, WorkOrderDowntimeLoss, WorkOrderProgressEvent, WorkOrderProgressEventAllowedChange, WorkOrderProgressLog, WorkOrderWarranty, ServiceLevelAgreementClassification, ServiceLevelAgreement, ServiceLevelAgreementMeasure, WorkOrderServiceLevelAgreement, WorkOrderServiceLevelAgreementMeasure, ServiceLevelAgreementMeasureTrigger, ServiceLevelAgreementMeasureFieldAssignment, PermissionTree, User, UserAttribute, UserDocument, UserAuthentication, SecurityRole, SecurityRolePermission, UserSecurityRole, UserCustomPermission, UserOption, BackgroundTask, BackgroundTaskStep, ScheduledBackgroundTask, ScheduledJob, UserDefinedField, UserDefinedFieldPredefinedValue, SystemOption, SystemOptionPageLimit, SystemOptionWorkOrderStatus, SystemOptionDefaultStandardTask, SystemOptionWorkOrderStatusTypeOfWork, SystemOptionReferenceDataViewPermission, SystemOptionFileAttachmentCategory, SystemOptionFileAttachmentFileType, RecordChange, RecordChangeValue, RecordChangeUser, RecordChangeProperty, NotificationEventOutbox, NotificationEventAttachmentOutbox, NotificationOutbox, NotificationOutboxLog, ChangeDataTriggerCriteriaEvaluation, SystemOptionReportServerEntity, SystemOptionReportServerEntityDefaultReport, TemplateMigrationLog, TemplateMigrationLogIntent, ResourceActionMigrationLog, ImportSchema, ImportFile, UserDefinedQuery, ResourceActionCustomisation, TemplateCustomisation, TemplateResource, ClusterSettings, ClusterIdentityProviderSettings, MessageBrokerHost, MessageBrokerTopic, MessageBrokerTopicConsumer, TenantSettings, TenantChangeDataSubscriptionSettings, TenantIdentityProviderSettings, TenantJobSettings, TenantFileContentStoreLocationSettings, TenantFileContentStoreFileTypeGroupSettings, TenantFileContentStoreFileTypeSettings, ClusterFeatureToggle, TenantFeatureToggle, TenantHealthCheck, TenantMachineHealthCheck, ClusterHealthCheck, ClusterMachineHealthCheck, ClusterCapacitySlot, TenantChangeLogCleanupExpressionSettings, ClusterJobSettings, Ignore]) | enum |\r\n| parameterName | MonitoringPointTriggerExpressionParameter->ParameterName | string | |\r\n| parameterValue | MonitoringPointTriggerExpressionParameter->ParameterValue | object | composite |\r\n| monitoringPointId | MonitoringPointTriggerExpressionParameter->MonitoringPoint_Id | integer | int64 |\r\n| sequenceNumber | MonitoringPointTriggerExpressionParameter->SequenceNumber | integer | int32 |\r\n| notes | MonitoringPointTriggerExpressionParameter->Notes | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| entityType | Nullable | False | MonitoringPointTriggerExpressionParameter->ParameterType eq 'Entity' |\r\n| entityType | Nullable | True | MonitoringPointTriggerExpressionParameter->ParameterType ne 'Entity' |\r\n| parameterName | Nullable | False | |\r\n| parameterValue | Nullable | False | MonitoringPointTriggerExpressionParameter->ParameterType ne 'MonitoringPoint' |\r\n| parameterValue | Nullable | True | MonitoringPointTriggerExpressionParameter->ParameterType eq 'MonitoringPoint' |\r\n\r\n", "operationId": "BatchUpdateMonitoringPointTriggerExpressionParameter", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateMonitoringPointTriggerExpressionParameterResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Monitoring Point Trigger Expression Parameter batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Monitoring Point Trigger Expression Parameter" ], "summary": "Delete a collection of existing Monitoring Point Trigger Expression Parameter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTriggerExpressionParameter->Id | integer | int64 |\r\n| version | MonitoringPointTriggerExpressionParameter->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteMonitoringPointTriggerExpressionParameter", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteMonitoringPointTriggerExpressionParameterResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Monitoring Point Trigger Expression Parameter batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/Parameters/{id}/Active": { "patch": { "tags": [ "Monitoring Point Trigger Expression Parameter" ], "summary": "Change the IsActive status for an existing Monitoring Point Trigger Expression Parameter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointTriggerExpressionParameter->Version | integer | int32 |\r\n| isActive | MonitoringPointTriggerExpressionParameter->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeMonitoringPointTriggerExpressionParameterIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Trigger Expression Parameter Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeMonitoringPointTriggerExpressionParameterIsActiveResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/Parameters/{id}/PermissionTree": { "patch": { "tags": [ "Monitoring Point Trigger Expression Parameter" ], "summary": "Change the PermissionTree for an existing Monitoring Point Trigger Expression Parameter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointTriggerExpressionParameter->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointTriggerExpressionParameter->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeMonitoringPointTriggerExpressionParameterPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Trigger Expression Parameter Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeMonitoringPointTriggerExpressionParameterPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/Parameters/Batch/Active": { "patch": { "tags": [ "Monitoring Point Trigger Expression Parameter" ], "summary": "Change the IsActive status for a collection of existing Monitoring Point Trigger Expression Parameter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTriggerExpressionParameter->Id | integer | int64 |\r\n| version | MonitoringPointTriggerExpressionParameter->Version | integer | int32 |\r\n| isActive | MonitoringPointTriggerExpressionParameter->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeMonitoringPointTriggerExpressionParameterIsActive", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeMonitoringPointTriggerExpressionParameterIsActiveResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTriggers/Expressions/Parameters/Batch/PermissionTree": { "patch": { "tags": [ "Monitoring Point Trigger Expression Parameter" ], "summary": "Change the PermissionTree status for a collection of existing Monitoring Point Trigger Expression Parameter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTriggerExpressionParameter->Id | integer | int64 |\r\n| version | MonitoringPointTriggerExpressionParameter->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointTriggerExpressionParameter->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeMonitoringPointTriggerExpressionParameterPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeMonitoringPointTriggerExpressionParameterPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTypes/{id}": { "get": { "tags": [ "Monitoring Point Type" ], "summary": "Get a Monitoring Point Type resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | MonitoringPointType->Code | string | |\r\n| isActive | MonitoringPointType->IsActive | boolean | |\r\n| createdByUserId | MonitoringPointType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MonitoringPointType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MonitoringPointType->CreatedByUser_FullName | string | |\r\n| createdOn | MonitoringPointType->CreatedOn | string | date-time |\r\n| modifiedByUserId | MonitoringPointType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MonitoringPointType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MonitoringPointType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MonitoringPointType->ModifiedOn | string | date-time |\r\n| version | MonitoringPointType->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MonitoringPointType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MonitoringPointType->PermissionTree_Description | string | |\r\n| id | MonitoringPointType->Id | integer | int64 |\r\n| alarmCancellation | MonitoringPointType->AlarmCancellation | string (Allowed values: [None, Bounds, WorkOrder]) | enum |\r\n| description | MonitoringPointType->Description | string | |\r\n| hasLowerCriticalBound | MonitoringPointType->HasLowerCriticalBound | boolean | |\r\n| hasLowerWarningBound | MonitoringPointType->HasLowerWarningBound | boolean | |\r\n| hasUpperCriticalBound | MonitoringPointType->HasUpperCriticalBound | boolean | |\r\n| hasUpperWarningBound | MonitoringPointType->HasUpperWarningBound | boolean | |\r\n| isCalculated | MonitoringPointType->IsCalculated | boolean | |\r\n| lowerCriticalAlarmTypeId | MonitoringPointType->LowerCriticalAlarmType_Id | integer | int64 |\r\n| lowerCriticalAlarmTypeDescription | MonitoringPointType->LowerCriticalAlarmType_Description | string | |\r\n| lowerCriticalAlarmTypeCode | MonitoringPointType->LowerCriticalAlarmType_Code | string | |\r\n| lowerCriticalBound | MonitoringPointType->LowerCriticalBound | number | decimal |\r\n| lowerCriticalSuppressesLowerWarning | MonitoringPointType->LowerCriticalSuppressesLowerWarning | boolean | |\r\n| lowerWarningAlarmTypeId | MonitoringPointType->LowerWarningAlarmType_Id | integer | int64 |\r\n| lowerWarningAlarmTypeDescription | MonitoringPointType->LowerWarningAlarmType_Description | string | |\r\n| lowerWarningAlarmTypeCode | MonitoringPointType->LowerWarningAlarmType_Code | string | |\r\n| lowerWarningBound | MonitoringPointType->LowerWarningBound | number | decimal |\r\n| notes | MonitoringPointType->Notes | string | |\r\n| readingFormula | MonitoringPointType->ReadingFormula | string | |\r\n| sequenceNumber | MonitoringPointType->SequenceNumber | integer | int32 |\r\n| unitOfMeasurementId | MonitoringPointType->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | MonitoringPointType->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | MonitoringPointType->UnitOfMeasurement_Description | string | |\r\n| upperCriticalAlarmTypeId | MonitoringPointType->UpperCriticalAlarmType_Id | integer | int64 |\r\n| upperCriticalAlarmTypeDescription | MonitoringPointType->UpperCriticalAlarmType_Description | string | |\r\n| upperCriticalAlarmTypeCode | MonitoringPointType->UpperCriticalAlarmType_Code | string | |\r\n| upperCriticalBound | MonitoringPointType->UpperCriticalBound | number | decimal |\r\n| upperCriticalSuppressesUpperWarning | MonitoringPointType->UpperCriticalSuppressesUpperWarning | boolean | |\r\n| upperWarningAlarmTypeId | MonitoringPointType->UpperWarningAlarmType_Id | integer | int64 |\r\n| upperWarningAlarmTypeDescription | MonitoringPointType->UpperWarningAlarmType_Description | string | |\r\n| upperWarningAlarmTypeCode | MonitoringPointType->UpperWarningAlarmType_Code | string | |\r\n| upperWarningBound | MonitoringPointType->UpperWarningBound | number | decimal |\r\n", "operationId": "GetMonitoringPointType", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Type Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Monitoring Point Type", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetMonitorPointTypeResourceActionResponse4" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Monitoring Point Type" ], "summary": "Update an existing Monitoring Point Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointType->Version | integer | int32 |\r\n| code | MonitoringPointType->Code | string | |\r\n| description | MonitoringPointType->Description | string | |\r\n| notes | MonitoringPointType->Notes | string | |\r\n| isCalculated | MonitoringPointType->IsCalculated | boolean | |\r\n| readingFormula | MonitoringPointType->ReadingFormula | string | |\r\n| sequenceNumber | MonitoringPointType->SequenceNumber | integer | int32 |\r\n| alarmCancellation | MonitoringPointType->AlarmCancellation | string (Allowed values: [None, Bounds, WorkOrder]) | enum |\r\n| upperCriticalSuppressesUpperWarning | MonitoringPointType->UpperCriticalSuppressesUpperWarning | boolean | |\r\n| lowerCriticalSuppressesLowerWarning | MonitoringPointType->LowerCriticalSuppressesLowerWarning | boolean | |\r\n| upperCriticalBound | MonitoringPointType->UpperCriticalBound | number | decimal |\r\n| upperWarningBound | MonitoringPointType->UpperWarningBound | number | decimal |\r\n| lowerCriticalBound | MonitoringPointType->LowerCriticalBound | number | decimal |\r\n| lowerWarningBound | MonitoringPointType->LowerWarningBound | number | decimal |\r\n| upperCriticalAlarmTypeId | MonitoringPointType->UpperCriticalAlarmType_Id | integer | int64 |\r\n| upperWarningAlarmTypeId | MonitoringPointType->UpperWarningAlarmType_Id | integer | int64 |\r\n| lowerWarningAlarmTypeId | MonitoringPointType->LowerWarningAlarmType_Id | integer | int64 |\r\n| lowerCriticalAlarmTypeId | MonitoringPointType->LowerCriticalAlarmType_Id | integer | int64 |\r\n| unitOfMeasurementId | MonitoringPointType->UnitOfMeasurement_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| isCalculated | Nullable | False | |\r\n| readingFormula | Nullable | True | MonitoringPointType->IsCalculated eq FALSE |\r\n| readingFormula | Nullable | False | MonitoringPointType->IsCalculated eq TRUE |\r\n| alarmCancellation | Nullable | False | |\r\n| upperCriticalSuppressesUpperWarning | Nullable | False | |\r\n| lowerCriticalSuppressesLowerWarning | Nullable | False | |\r\n| upperCriticalAlarmTypeId | Nullable | True | MonitoringPointType->UpperCriticalBound eq NULL |\r\n| upperWarningAlarmTypeId | Nullable | True | MonitoringPointType->UpperWarningBound eq NULL |\r\n| lowerWarningAlarmTypeId | Nullable | True | MonitoringPointType->LowerWarningBound eq NULL |\r\n| lowerCriticalAlarmTypeId | Nullable | True | MonitoringPointType->LowerCriticalBound eq NULL |\r\n| unitOfMeasurementId | Nullable | False | |\r\n\r\n", "operationId": "UpdateMonitoringPointType", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Type Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateMonitoringPointTypeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Monitoring Point Type was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Monitoring Point Type" ], "summary": "Delete an existing Monitoring Point Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointType->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteMonitoringPointType", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Type Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "input", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteMonitoringPointTypeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Monitoring Point Type was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTypes": { "get": { "tags": [ "Monitoring Point Type" ], "summary": "Get a collection of Monitoring Point Type resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointType->Id | integer | int64 |\r\n| version | MonitoringPointType->Version | integer | int32 |\r\n| code | MonitoringPointType->Code | string | |\r\n| description | MonitoringPointType->Description | string | |\r\n| unitOfMeasurementId | MonitoringPointType->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | MonitoringPointType->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | MonitoringPointType->UnitOfMeasurement_Description | string | |\r\n| isCalculated | MonitoringPointType->IsCalculated | boolean | |\r\n| sequenceNumber | MonitoringPointType->SequenceNumber | integer | int32 |\r\n| notes | MonitoringPointType->Notes | string | |\r\n| upperCriticalBound | MonitoringPointType->UpperCriticalBound | number | decimal |\r\n| upperWarningBound | MonitoringPointType->UpperWarningBound | number | decimal |\r\n| lowerWarningBound | MonitoringPointType->LowerWarningBound | number | decimal |\r\n| lowerCriticalBound | MonitoringPointType->LowerCriticalBound | number | decimal |\r\n| createdOn | MonitoringPointType->CreatedOn | string | date-time |\r\n| modifiedOn | MonitoringPointType->ModifiedOn | string | date-time |\r\n", "operationId": "GetMonitoringPointTypeCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point Type collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointTypeCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Monitoring Point Type" ], "summary": "Create a new Monitoring Point Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | MonitoringPointType->Code | string | |\r\n| description | MonitoringPointType->Description | string | |\r\n| permissionTreeId | MonitoringPointType->PermissionTree_Id | integer | int64 |\r\n| notes | MonitoringPointType->Notes | string | |\r\n| sequenceNumber | MonitoringPointType->SequenceNumber | integer | int32 |\r\n| alarmCancellation | MonitoringPointType->AlarmCancellation | string (Allowed values: [None, Bounds, WorkOrder]) | enum |\r\n| upperCriticalSuppressesUpperWarning | MonitoringPointType->UpperCriticalSuppressesUpperWarning | boolean | |\r\n| lowerCriticalSuppressesLowerWarning | MonitoringPointType->LowerCriticalSuppressesLowerWarning | boolean | |\r\n| upperCriticalBound | MonitoringPointType->UpperCriticalBound | number | decimal |\r\n| upperWarningBound | MonitoringPointType->UpperWarningBound | number | decimal |\r\n| lowerCriticalBound | MonitoringPointType->LowerCriticalBound | number | decimal |\r\n| lowerWarningBound | MonitoringPointType->LowerWarningBound | number | decimal |\r\n| isCalculated | MonitoringPointType->IsCalculated | boolean | |\r\n| upperCriticalAlarmTypeId | MonitoringPointType->UpperCriticalAlarmType_Id | integer | int64 |\r\n| upperWarningAlarmTypeId | MonitoringPointType->UpperWarningAlarmType_Id | integer | int64 |\r\n| lowerWarningAlarmTypeId | MonitoringPointType->LowerWarningAlarmType_Id | integer | int64 |\r\n| lowerCriticalAlarmTypeId | MonitoringPointType->LowerCriticalAlarmType_Id | integer | int64 |\r\n| readingFormula | MonitoringPointType->ReadingFormula | string | |\r\n| unitOfMeasurementId | MonitoringPointType->UnitOfMeasurement_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| alarmCancellation | Nullable | False | |\r\n| upperCriticalSuppressesUpperWarning | Nullable | False | |\r\n| lowerCriticalSuppressesLowerWarning | Nullable | False | |\r\n| isCalculated | Required | True | |\r\n| isCalculated | Nullable | False | |\r\n| upperCriticalAlarmTypeId | Nullable | True | MonitoringPointType->UpperCriticalBound eq NULL |\r\n| upperWarningAlarmTypeId | Nullable | True | MonitoringPointType->UpperWarningBound eq NULL |\r\n| lowerWarningAlarmTypeId | Nullable | True | MonitoringPointType->LowerWarningBound eq NULL |\r\n| lowerCriticalAlarmTypeId | Nullable | True | MonitoringPointType->LowerCriticalBound eq NULL |\r\n| readingFormula | Nullable | True | MonitoringPointType->IsCalculated eq FALSE |\r\n| readingFormula | Nullable | False | MonitoringPointType->IsCalculated eq TRUE |\r\n| unitOfMeasurementId | Required | True | |\r\n| unitOfMeasurementId | Nullable | False | |\r\n\r\n", "operationId": "CreateMonitoringPointType", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateMonitoringPointTypeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTypes/Lookups/LookupMonitoringPointTypeChangePermissionTree": { "get": { "tags": [ "Monitoring Point Type" ], "summary": "Lookup the permission set for changing the Monitoring Point Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupMonitoringPointTypeChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointTypeChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTypes/Lookups/LookupMonitoringPointTypeInsertPermissionTree": { "get": { "tags": [ "Monitoring Point Type" ], "summary": "Lookup the permission set for creating the Monitoring Point Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupMonitoringPointTypeInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointTypeInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTypes/Lookups/LookupMonitoringPointTypeLowerCriticalAlarmType": { "get": { "tags": [ "Monitoring Point Type" ], "summary": "Lookup the Alarm Type for the Monitoring Point Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AlarmType->Id | integer | int64 |\r\n| code | AlarmType->Code | string | |\r\n| description | AlarmType->Description | string | |\r\n", "operationId": "LookupMonitoringPointTypeLowerCriticalAlarmType", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Alarm Type collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointTypeLowerCriticalAlarmTypeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTypes/Lookups/LookupMonitoringPointTypeLowerWarningAlarmType": { "get": { "tags": [ "Monitoring Point Type" ], "summary": "Lookup the Alarm Type for the Monitoring Point Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AlarmType->Id | integer | int64 |\r\n| code | AlarmType->Code | string | |\r\n| description | AlarmType->Description | string | |\r\n", "operationId": "LookupMonitoringPointTypeLowerWarningAlarmType", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Alarm Type collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointTypeLowerWarningAlarmTypeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTypes/Lookups/LookupMonitoringPointTypeUnitOfMeasurement": { "get": { "tags": [ "Monitoring Point Type" ], "summary": "Lookup the Unit Of Measurement for the Monitoring Point Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | UnitOfMeasurement->Id | integer | int64 |\r\n| code | UnitOfMeasurement->Code | string | |\r\n| description | UnitOfMeasurement->Description | string | |\r\n", "operationId": "LookupMonitoringPointTypeUnitOfMeasurement", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Unit Of Measurement collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointTypeUnitOfMeasurementLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTypes/Lookups/LookupMonitoringPointTypeUpperCriticalAlarmType": { "get": { "tags": [ "Monitoring Point Type" ], "summary": "Lookup the Alarm Type for the Monitoring Point Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AlarmType->Id | integer | int64 |\r\n| code | AlarmType->Code | string | |\r\n| description | AlarmType->Description | string | |\r\n", "operationId": "LookupMonitoringPointTypeUpperCriticalAlarmType", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Alarm Type collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointTypeUpperCriticalAlarmTypeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTypes/Lookups/LookupMonitoringPointTypeUpperWarningAlarmType": { "get": { "tags": [ "Monitoring Point Type" ], "summary": "Lookup the Alarm Type for the Monitoring Point Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | AlarmType->Id | integer | int64 |\r\n| code | AlarmType->Code | string | |\r\n| description | AlarmType->Description | string | |\r\n", "operationId": "LookupMonitoringPointTypeUpperWarningAlarmType", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Alarm Type collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointTypeUpperWarningAlarmTypeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTypes/Batch/{ids}": { "get": { "tags": [ "Monitoring Point Type" ], "summary": "Get a collection of Monitoring Point Type resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | MonitoringPointType->Code | string | |\r\n| isActive | MonitoringPointType->IsActive | boolean | |\r\n| createdByUserId | MonitoringPointType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MonitoringPointType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MonitoringPointType->CreatedByUser_FullName | string | |\r\n| createdOn | MonitoringPointType->CreatedOn | string | date-time |\r\n| modifiedByUserId | MonitoringPointType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MonitoringPointType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MonitoringPointType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MonitoringPointType->ModifiedOn | string | date-time |\r\n| version | MonitoringPointType->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MonitoringPointType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MonitoringPointType->PermissionTree_Description | string | |\r\n| id | MonitoringPointType->Id | integer | int64 |\r\n| alarmCancellation | MonitoringPointType->AlarmCancellation | string (Allowed values: [None, Bounds, WorkOrder]) | enum |\r\n| description | MonitoringPointType->Description | string | |\r\n| hasLowerCriticalBound | MonitoringPointType->HasLowerCriticalBound | boolean | |\r\n| hasLowerWarningBound | MonitoringPointType->HasLowerWarningBound | boolean | |\r\n| hasUpperCriticalBound | MonitoringPointType->HasUpperCriticalBound | boolean | |\r\n| hasUpperWarningBound | MonitoringPointType->HasUpperWarningBound | boolean | |\r\n| isCalculated | MonitoringPointType->IsCalculated | boolean | |\r\n| lowerCriticalAlarmTypeId | MonitoringPointType->LowerCriticalAlarmType_Id | integer | int64 |\r\n| lowerCriticalAlarmTypeDescription | MonitoringPointType->LowerCriticalAlarmType_Description | string | |\r\n| lowerCriticalAlarmTypeCode | MonitoringPointType->LowerCriticalAlarmType_Code | string | |\r\n| lowerCriticalBound | MonitoringPointType->LowerCriticalBound | number | decimal |\r\n| lowerCriticalSuppressesLowerWarning | MonitoringPointType->LowerCriticalSuppressesLowerWarning | boolean | |\r\n| lowerWarningAlarmTypeId | MonitoringPointType->LowerWarningAlarmType_Id | integer | int64 |\r\n| lowerWarningAlarmTypeDescription | MonitoringPointType->LowerWarningAlarmType_Description | string | |\r\n| lowerWarningAlarmTypeCode | MonitoringPointType->LowerWarningAlarmType_Code | string | |\r\n| lowerWarningBound | MonitoringPointType->LowerWarningBound | number | decimal |\r\n| notes | MonitoringPointType->Notes | string | |\r\n| readingFormula | MonitoringPointType->ReadingFormula | string | |\r\n| sequenceNumber | MonitoringPointType->SequenceNumber | integer | int32 |\r\n| unitOfMeasurementId | MonitoringPointType->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | MonitoringPointType->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | MonitoringPointType->UnitOfMeasurement_Description | string | |\r\n| upperCriticalAlarmTypeId | MonitoringPointType->UpperCriticalAlarmType_Id | integer | int64 |\r\n| upperCriticalAlarmTypeDescription | MonitoringPointType->UpperCriticalAlarmType_Description | string | |\r\n| upperCriticalAlarmTypeCode | MonitoringPointType->UpperCriticalAlarmType_Code | string | |\r\n| upperCriticalBound | MonitoringPointType->UpperCriticalBound | number | decimal |\r\n| upperCriticalSuppressesUpperWarning | MonitoringPointType->UpperCriticalSuppressesUpperWarning | boolean | |\r\n| upperWarningAlarmTypeId | MonitoringPointType->UpperWarningAlarmType_Id | integer | int64 |\r\n| upperWarningAlarmTypeDescription | MonitoringPointType->UpperWarningAlarmType_Description | string | |\r\n| upperWarningAlarmTypeCode | MonitoringPointType->UpperWarningAlarmType_Code | string | |\r\n| upperWarningBound | MonitoringPointType->UpperWarningBound | number | decimal |\r\n", "operationId": "BatchGetMonitoringPointType", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Monitoring Point Type id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Monitoring Point Type collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetMonitoringPointTypesResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTypes/Batch": { "post": { "tags": [ "Monitoring Point Type" ], "summary": "Create a new collection of Monitoring Point Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| code | MonitoringPointType->Code | string | |\r\n| description | MonitoringPointType->Description | string | |\r\n| permissionTreeId | MonitoringPointType->PermissionTree_Id | integer | int64 |\r\n| notes | MonitoringPointType->Notes | string | |\r\n| sequenceNumber | MonitoringPointType->SequenceNumber | integer | int32 |\r\n| alarmCancellation | MonitoringPointType->AlarmCancellation | string (Allowed values: [None, Bounds, WorkOrder]) | enum |\r\n| upperCriticalSuppressesUpperWarning | MonitoringPointType->UpperCriticalSuppressesUpperWarning | boolean | |\r\n| lowerCriticalSuppressesLowerWarning | MonitoringPointType->LowerCriticalSuppressesLowerWarning | boolean | |\r\n| upperCriticalBound | MonitoringPointType->UpperCriticalBound | number | decimal |\r\n| upperWarningBound | MonitoringPointType->UpperWarningBound | number | decimal |\r\n| lowerCriticalBound | MonitoringPointType->LowerCriticalBound | number | decimal |\r\n| lowerWarningBound | MonitoringPointType->LowerWarningBound | number | decimal |\r\n| isCalculated | MonitoringPointType->IsCalculated | boolean | |\r\n| readingFormula | MonitoringPointType->ReadingFormula | string | |\r\n| upperCriticalAlarmTypeId | MonitoringPointType->UpperCriticalAlarmType_Id | integer | int64 |\r\n| upperWarningAlarmTypeId | MonitoringPointType->UpperWarningAlarmType_Id | integer | int64 |\r\n| lowerWarningAlarmTypeId | MonitoringPointType->LowerWarningAlarmType_Id | integer | int64 |\r\n| lowerCriticalAlarmTypeId | MonitoringPointType->LowerCriticalAlarmType_Id | integer | int64 |\r\n| unitOfMeasurementId | MonitoringPointType->UnitOfMeasurement_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| code | Required | True | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Required | True | |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n| alarmCancellation | Nullable | False | |\r\n| upperCriticalSuppressesUpperWarning | Nullable | False | |\r\n| lowerCriticalSuppressesLowerWarning | Nullable | False | |\r\n| isCalculated | Required | True | |\r\n| isCalculated | Nullable | False | |\r\n| readingFormula | Nullable | True | MonitoringPointType->IsCalculated eq FALSE |\r\n| readingFormula | Nullable | False | MonitoringPointType->IsCalculated eq TRUE |\r\n| upperCriticalAlarmTypeId | Nullable | True | MonitoringPointType->UpperCriticalBound eq NULL |\r\n| upperWarningAlarmTypeId | Nullable | True | MonitoringPointType->UpperWarningBound eq NULL |\r\n| lowerWarningAlarmTypeId | Nullable | True | MonitoringPointType->LowerWarningBound eq NULL |\r\n| lowerCriticalAlarmTypeId | Nullable | True | MonitoringPointType->LowerCriticalBound eq NULL |\r\n| unitOfMeasurementId | Required | True | |\r\n| unitOfMeasurementId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateMonitoringPointType", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateMonitoringPointTypeRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Monitoring Point Type batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Monitoring Point Type" ], "summary": "Update a collection of existing Monitoring Point Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointType->Id | integer | int64 |\r\n| version | MonitoringPointType->Version | integer | int32 |\r\n| code | MonitoringPointType->Code | string | |\r\n| description | MonitoringPointType->Description | string | |\r\n| unitOfMeasurementId | MonitoringPointType->UnitOfMeasurement_Id | integer | int64 |\r\n| notes | MonitoringPointType->Notes | string | |\r\n| sequenceNumber | MonitoringPointType->SequenceNumber | integer | int32 |\r\n| alarmCancellation | MonitoringPointType->AlarmCancellation | string (Allowed values: [None, Bounds, WorkOrder]) | enum |\r\n| upperCriticalSuppressesUpperWarning | MonitoringPointType->UpperCriticalSuppressesUpperWarning | boolean | |\r\n| lowerCriticalSuppressesLowerWarning | MonitoringPointType->LowerCriticalSuppressesLowerWarning | boolean | |\r\n| upperCriticalBound | MonitoringPointType->UpperCriticalBound | number | decimal |\r\n| upperWarningBound | MonitoringPointType->UpperWarningBound | number | decimal |\r\n| lowerCriticalBound | MonitoringPointType->LowerCriticalBound | number | decimal |\r\n| lowerWarningBound | MonitoringPointType->LowerWarningBound | number | decimal |\r\n| isCalculated | MonitoringPointType->IsCalculated | boolean | |\r\n| upperCriticalAlarmTypeId | MonitoringPointType->UpperCriticalAlarmType_Id | integer | int64 |\r\n| upperWarningAlarmTypeId | MonitoringPointType->UpperWarningAlarmType_Id | integer | int64 |\r\n| lowerWarningAlarmTypeId | MonitoringPointType->LowerWarningAlarmType_Id | integer | int64 |\r\n| lowerCriticalAlarmTypeId | MonitoringPointType->LowerCriticalAlarmType_Id | integer | int64 |\r\n| readingFormula | MonitoringPointType->ReadingFormula | string | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| code | Nullable | False | |\r\n| code | Min Length | >= 1 chars| |\r\n| code | Max Length | <= 50 chars| |\r\n| description | Nullable | False | |\r\n| description | Min Length | >= 1 chars| |\r\n| description | Max Length | <= 100 chars| |\r\n| unitOfMeasurementId | Nullable | False | |\r\n| alarmCancellation | Nullable | False | |\r\n| upperCriticalSuppressesUpperWarning | Nullable | False | |\r\n| lowerCriticalSuppressesLowerWarning | Nullable | False | |\r\n| isCalculated | Nullable | False | |\r\n| upperCriticalAlarmTypeId | Nullable | True | MonitoringPointType->UpperCriticalBound eq NULL |\r\n| upperWarningAlarmTypeId | Nullable | True | MonitoringPointType->UpperWarningBound eq NULL |\r\n| lowerWarningAlarmTypeId | Nullable | True | MonitoringPointType->LowerWarningBound eq NULL |\r\n| lowerCriticalAlarmTypeId | Nullable | True | MonitoringPointType->LowerCriticalBound eq NULL |\r\n| readingFormula | Nullable | True | MonitoringPointType->IsCalculated eq FALSE |\r\n| readingFormula | Nullable | False | MonitoringPointType->IsCalculated eq TRUE |\r\n\r\n", "operationId": "BatchUpdateMonitoringPointType", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateMonitoringPointTypeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Monitoring Point Type batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Monitoring Point Type" ], "summary": "Delete a collection of existing Monitoring Point Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointType->Id | integer | int64 |\r\n| version | MonitoringPointType->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteMonitoringPointType", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteMonitoringPointTypeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Monitoring Point Type batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTypes/{id}/Active": { "patch": { "tags": [ "Monitoring Point Type" ], "summary": "Change the IsActive status for an existing Monitoring Point Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointType->Version | integer | int32 |\r\n| isActive | MonitoringPointType->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "ChangeMonitoringPointTypeIsActive", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Type Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeMonitoringPointTypeIsActiveResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTypes/{id}/PermissionTree": { "patch": { "tags": [ "Monitoring Point Type" ], "summary": "Change the PermissionTree for an existing Monitoring Point Type resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointType->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointType->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeMonitoringPointTypePermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Type Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeMonitoringPointTypePermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTypes/Batch/Active": { "patch": { "tags": [ "Monitoring Point Type" ], "summary": "Change the IsActive status for a collection of existing Monitoring Point Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointType->Id | integer | int64 |\r\n| version | MonitoringPointType->Version | integer | int32 |\r\n| isActive | MonitoringPointType->IsActive | boolean | |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| isActive | Required | True | |\r\n| isActive | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeMonitoringPointTypeIsActive", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeMonitoringPointTypeIsActiveResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTypes/Batch/PermissionTree": { "patch": { "tags": [ "Monitoring Point Type" ], "summary": "Change the PermissionTree status for a collection of existing Monitoring Point Type resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointType->Id | integer | int64 |\r\n| version | MonitoringPointType->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointType->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeMonitoringPointTypePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeMonitoringPointTypePermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTypes/Parameters/{id}": { "get": { "tags": [ "Monitoring Point Type Parameter" ], "summary": "Get a Monitoring Point Type Parameter resource.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | MonitoringPointTypeParameter->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MonitoringPointTypeParameter->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MonitoringPointTypeParameter->CreatedByUser_FullName | string | |\r\n| createdOn | MonitoringPointTypeParameter->CreatedOn | string | date-time |\r\n| modifiedByUserId | MonitoringPointTypeParameter->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MonitoringPointTypeParameter->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MonitoringPointTypeParameter->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MonitoringPointTypeParameter->ModifiedOn | string | date-time |\r\n| version | MonitoringPointTypeParameter->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointTypeParameter->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MonitoringPointTypeParameter->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MonitoringPointTypeParameter->PermissionTree_Description | string | |\r\n| id | MonitoringPointTypeParameter->Id | integer | int64 |\r\n| monitoringPointTypeId | MonitoringPointTypeParameter->MonitoringPointType_Id | integer | int64 |\r\n| monitoringPointTypeCode | MonitoringPointTypeParameter->MonitoringPointType_Code | string | |\r\n| monitoringPointTypeDescription | MonitoringPointTypeParameter->MonitoringPointType_Description | string | |\r\n| parameterName | MonitoringPointTypeParameter->ParameterName | string | |\r\n| parameterValue | MonitoringPointTypeParameter->ParameterValue | string | |\r\n| notes | MonitoringPointTypeParameter->Notes | string | |\r\n| sequenceNumber | MonitoringPointTypeParameter->SequenceNumber | integer | int32 |\r\n", "operationId": "GetMonitoringPointTypeParameter", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Type Parameter Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Monitoring Point Type Parameter", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointTypeParameterResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Monitoring Point Type Parameter" ], "summary": "Update an existing Monitoring Point Type Parameter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointTypeParameter->Version | integer | int32 |\r\n| parameterName | MonitoringPointTypeParameter->ParameterName | string | |\r\n| parameterValue | MonitoringPointTypeParameter->ParameterValue | string | |\r\n| notes | MonitoringPointTypeParameter->Notes | string | |\r\n| sequenceNumber | MonitoringPointTypeParameter->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| parameterName | Nullable | False | |\r\n| parameterName | Min Length | >= 1 chars| |\r\n| parameterName | Max Length | <= 50 chars| |\r\n| parameterValue | Nullable | False | |\r\n| parameterValue | Min Length | >= 1 chars| |\r\n| parameterValue | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "UpdateMonitoringPointTypeParameter", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Type Parameter Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/UpdateMonitoringPointTypeParameterResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Monitoring Point Type Parameter was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Monitoring Point Type Parameter" ], "summary": "Delete an existing Monitoring Point Type Parameter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointTypeParameter->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "DeleteMonitoringPointTypeParameter", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Type Parameter Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "delete", "description": "Request Body content", "content": { "application/vnd.onkey.entitydelete+json": { "schema": { "$ref": "#/components/schemas/DeleteMonitoringPointTypeParameterResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - Monitoring Point Type Parameter was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTypes/Parameters": { "get": { "tags": [ "Monitoring Point Type Parameter" ], "summary": "Get a collection of Monitoring Point Type Parameter resources.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTypeParameter->Id | integer | int64 |\r\n| version | MonitoringPointTypeParameter->Version | integer | int32 |\r\n| parameterName | MonitoringPointTypeParameter->ParameterName | string | |\r\n| parameterValue | MonitoringPointTypeParameter->ParameterValue | string | |\r\n| monitoringPointTypeId | MonitoringPointTypeParameter->MonitoringPointType_Id | integer | int64 |\r\n| monitoringPointTypeCode | MonitoringPointTypeParameter->MonitoringPointType_Code | string | |\r\n| monitoringPointTypeDescription | MonitoringPointTypeParameter->MonitoringPointType_Description | string | |\r\n| createdOn | MonitoringPointTypeParameter->CreatedOn | string | date-time |\r\n| modifiedOn | MonitoringPointTypeParameter->ModifiedOn | string | date-time |\r\n", "operationId": "GetMonitoringPointTypeParameterCollection", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point Type Parameter collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointTypeParameterCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "post": { "tags": [ "Monitoring Point Type Parameter" ], "summary": "Create a new Monitoring Point Type Parameter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| parameterName | MonitoringPointTypeParameter->ParameterName | string | |\r\n| parameterValue | MonitoringPointTypeParameter->ParameterValue | string | |\r\n| permissionTreeId | MonitoringPointTypeParameter->PermissionTree_Id | integer | int64 |\r\n| monitoringPointTypeId | MonitoringPointTypeParameter->MonitoringPointType_Id | integer | int64 |\r\n| notes | MonitoringPointTypeParameter->Notes | string | |\r\n| sequenceNumber | MonitoringPointTypeParameter->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| parameterName | Required | True | |\r\n| parameterName | Nullable | False | |\r\n| parameterName | Min Length | >= 1 chars| |\r\n| parameterName | Max Length | <= 50 chars| |\r\n| parameterValue | Required | True | |\r\n| parameterValue | Nullable | False | |\r\n| parameterValue | Min Length | >= 1 chars| |\r\n| parameterValue | Max Length | <= 100 chars| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| monitoringPointTypeId | Required | True | |\r\n| monitoringPointTypeId | Nullable | False | |\r\n\r\n", "operationId": "CreateMonitoringPointTypeParameter", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "post", "description": "Request Body content", "content": { "application/vnd.onkey.entity+json": { "schema": { "$ref": "#/components/schemas/CreateMonitoringPointTypeParameterResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "$ref": "#/components/responses/created", "description": "" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTypes/{monitoringPointTypeId}/Parameters": { "get": { "tags": [ "Monitoring Point Type Parameter" ], "summary": "Get a collection of Monitoring Point Type Parameter resources for the Monitoring Point Type.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTypeParameter->Id | integer | int64 |\r\n| version | MonitoringPointTypeParameter->Version | integer | int32 |\r\n| parameterName | MonitoringPointTypeParameter->ParameterName | string | |\r\n| parameterValue | MonitoringPointTypeParameter->ParameterValue | string | |\r\n| createdOn | MonitoringPointTypeParameter->CreatedOn | string | date-time |\r\n| modifiedOn | MonitoringPointTypeParameter->ModifiedOn | string | date-time |\r\n", "operationId": "GetMonitoringPointTypeParameterForMonitoringPointTypeCollection", "parameters": [ { "name": "monitoringPointTypeId", "in": "path", "required": true, "description": "Monitoring Point Type Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point Type Parameter collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/GetMonitoringPointTypeParameterForMonitoringPointTypeCollectionResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTypes/Parameters/Lookups/LookupMonitoringPointTypeParameterChangePermissionTree": { "get": { "tags": [ "Monitoring Point Type Parameter" ], "summary": "Lookup the permission set for changing the Monitoring Point Type Parameter.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupMonitoringPointTypeParameterChangePermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointTypeParameterChangePermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTypes/Parameters/Lookups/LookupMonitoringPointTypeParameterInsertPermissionTree": { "get": { "tags": [ "Monitoring Point Type Parameter" ], "summary": "Lookup the permission set for creating the Monitoring Point Type Parameter.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | PermissionTree->Id | integer | int64 |\r\n| code | PermissionTree->Code | string | |\r\n| description | PermissionTree->Description | string | |\r\n| idPermissionTreeMatrixIdTreeLevel | PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel | integer | int32 |\r\n| parentPermissionTreeId | PermissionTree->ParentPermissionTree_Id | integer | int64 |\r\n", "operationId": "LookupMonitoringPointTypeParameterInsertPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointTypeParameterInsertPermissionTreeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTypes/Parameters/Lookups/LookupMonitoringPointTypeParameterMonitoringPointType": { "get": { "tags": [ "Monitoring Point Type Parameter" ], "summary": "Lookup the Monitoring Point Type for the Monitoring Point Type Parameter.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointType->Id | integer | int64 |\r\n| code | MonitoringPointType->Code | string | |\r\n| description | MonitoringPointType->Description | string | |\r\n", "operationId": "LookupMonitoringPointTypeParameterMonitoringPointType", "parameters": [ { "$ref": "#/components/parameters/Select" }, { "$ref": "#/components/parameters/Filter" }, { "$ref": "#/components/parameters/Param" }, { "$ref": "#/components/parameters/Top" }, { "$ref": "#/components/parameters/Skip" }, { "$ref": "#/components/parameters/OrderBy" } ], "responses": { "200": { "description": "Success response - body contains pageable Monitoring Point Type collection", "content": { "application/vnd.onkey.entitycollectionpage+json": { "schema": { "$ref": "#/components/schemas/MonitoringPointTypeParameterMonitoringPointTypeLookupResourceActionResponse" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTypes/Parameters/Batch/{ids}": { "get": { "tags": [ "Monitoring Point Type Parameter" ], "summary": "Get a collection of Monitoring Point Type Parameter resources for the set of id's.", "description": "### Response Body\r\n#### Payload\r\n\r\nThe response body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| createdByUserId | MonitoringPointTypeParameter->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MonitoringPointTypeParameter->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MonitoringPointTypeParameter->CreatedByUser_FullName | string | |\r\n| createdOn | MonitoringPointTypeParameter->CreatedOn | string | date-time |\r\n| modifiedByUserId | MonitoringPointTypeParameter->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MonitoringPointTypeParameter->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MonitoringPointTypeParameter->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MonitoringPointTypeParameter->ModifiedOn | string | date-time |\r\n| version | MonitoringPointTypeParameter->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointTypeParameter->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MonitoringPointTypeParameter->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MonitoringPointTypeParameter->PermissionTree_Description | string | |\r\n| id | MonitoringPointTypeParameter->Id | integer | int64 |\r\n| monitoringPointTypeId | MonitoringPointTypeParameter->MonitoringPointType_Id | integer | int64 |\r\n| monitoringPointTypeCode | MonitoringPointTypeParameter->MonitoringPointType_Code | string | |\r\n| monitoringPointTypeDescription | MonitoringPointTypeParameter->MonitoringPointType_Description | string | |\r\n| parameterName | MonitoringPointTypeParameter->ParameterName | string | |\r\n| parameterValue | MonitoringPointTypeParameter->ParameterValue | string | |\r\n| notes | MonitoringPointTypeParameter->Notes | string | |\r\n| sequenceNumber | MonitoringPointTypeParameter->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetMonitoringPointTypeParameter", "parameters": [ { "name": "ids", "in": "path", "style": "simple", "required": true, "description": "A comma separated list of Monitoring Point Type Parameter id's (eg. 1585760985950002,1585760985950003)", "schema": { "type": "array", "nullable": true, "items": { "type": "integer", "format": "int64" } }, "x-position": 1 }, { "$ref": "#/components/parameters/Select" } ], "responses": { "200": { "description": "Success response - body contains Monitoring Point Type Parameter collection", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchGetMonitoringPointTypeParameterResourceAction" } } } }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTypes/Parameters/Batch": { "post": { "tags": [ "Monitoring Point Type Parameter" ], "summary": "Create a new collection of Monitoring Point Type Parameter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| parameterName | MonitoringPointTypeParameter->ParameterName | string | |\r\n| parameterValue | MonitoringPointTypeParameter->ParameterValue | string | |\r\n| permissionTreeId | MonitoringPointTypeParameter->PermissionTree_Id | integer | int64 |\r\n| monitoringPointTypeId | MonitoringPointTypeParameter->MonitoringPointType_Id | integer | int64 |\r\n| notes | MonitoringPointTypeParameter->Notes | string | |\r\n| sequenceNumber | MonitoringPointTypeParameter->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| parameterName | Required | True | |\r\n| parameterName | Nullable | False | |\r\n| parameterName | Min Length | >= 1 chars| |\r\n| parameterName | Max Length | <= 50 chars| |\r\n| parameterValue | Required | True | |\r\n| parameterValue | Nullable | False | |\r\n| parameterValue | Min Length | >= 1 chars| |\r\n| parameterValue | Max Length | <= 100 chars| |\r\n| permissionTreeId | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| monitoringPointTypeId | Required | True | |\r\n| monitoringPointTypeId | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateMonitoringPointTypeParameter", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "posts", "description": "Request Body content", "content": { "application/vnd.onkey.entitycollection+json": { "schema": { "$ref": "#/components/schemas/BatchCreateMonitoringPointTypeParameterResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "201": { "description": "Success response - Monitoring Point Type Parameter batch was successfully created" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "patch": { "tags": [ "Monitoring Point Type Parameter" ], "summary": "Update a collection of existing Monitoring Point Type Parameter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTypeParameter->Id | integer | int64 |\r\n| version | MonitoringPointTypeParameter->Version | integer | int32 |\r\n| parameterName | MonitoringPointTypeParameter->ParameterName | string | |\r\n| parameterValue | MonitoringPointTypeParameter->ParameterValue | string | |\r\n| notes | MonitoringPointTypeParameter->Notes | string | |\r\n| sequenceNumber | MonitoringPointTypeParameter->SequenceNumber | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| parameterName | Nullable | False | |\r\n| parameterName | Min Length | >= 1 chars| |\r\n| parameterName | Max Length | <= 50 chars| |\r\n| parameterValue | Nullable | False | |\r\n| parameterValue | Min Length | >= 1 chars| |\r\n| parameterValue | Max Length | <= 100 chars| |\r\n\r\n", "operationId": "BatchUpdateMonitoringPointTypeParameter", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchUpdateMonitoringPointTypeParameterResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Monitoring Point Type Parameter batch was successfully updated" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } }, "delete": { "tags": [ "Monitoring Point Type Parameter" ], "summary": "Delete a collection of existing Monitoring Point Type Parameter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTypeParameter->Id | integer | int64 |\r\n| version | MonitoringPointTypeParameter->Version | integer | int32 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n\r\n", "operationId": "BatchDeleteMonitoringPointTypeParameter", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "deletes", "description": "Request Body content", "content": { "application/vnd.onkey.entitydeletecollection+json": { "schema": { "$ref": "#/components/schemas/BatchDeleteMonitoringPointTypeParameterResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - Monitoring Point Type Parameter batch was successfully deleted" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTypes/Parameters/{id}/PermissionTree": { "patch": { "tags": [ "Monitoring Point Type Parameter" ], "summary": "Change the PermissionTree for an existing Monitoring Point Type Parameter resource.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| version | MonitoringPointTypeParameter->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointTypeParameter->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "ChangeMonitoringPointTypeParameterPermissionTree", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Monitoring Point Type Parameter Id", "schema": { "type": "integer", "format": "int64" }, "x-position": 1 }, { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" } ], "requestBody": { "x-name": "patch", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatch+json": { "schema": { "$ref": "#/components/schemas/ChangeMonitoringPointTypeParameterPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } }, "/Modules/AHM/MonitoringPointTypes/Parameters/Batch/PermissionTree": { "patch": { "tags": [ "Monitoring Point Type Parameter" ], "summary": "Change the PermissionTree status for a collection of existing Monitoring Point Type Parameter resources.", "description": "### Request Body\r\n#### Payload\r\n\r\nThe request body can contain the following properties:\r\n\r\n| Name | Path | Type | Format |\r\n| ---- | ---- | ---- | ---- |\r\n| id | MonitoringPointTypeParameter->Id | integer | int64 |\r\n| version | MonitoringPointTypeParameter->Version | integer | int32 |\r\n| permissionTreeId | MonitoringPointTypeParameter->PermissionTree_Id | integer | int64 |\r\n\r\n#### Business Rules\r\n\r\nThe following business rules apply to the properties:\r\n\r\n| Property | Rule | Value | Condition |\r\n| ---- | :----: | :----: | :----: |\r\n| id | Required | True | |\r\n| id | Nullable | False | |\r\n| version | Required | True | |\r\n| version | Nullable | False | |\r\n| permissionTreeId | Required | True | |\r\n| permissionTreeId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeMonitoringPointTypeParameterPermissionTree", "parameters": [ { "$ref": "#/components/parameters/Async" }, { "$ref": "#/components/parameters/AsyncDescription" }, { "$ref": "#/components/parameters/Schedule" }, { "$ref": "#/components/parameters/ExecutionMode" } ], "requestBody": { "x-name": "patches", "description": "Request Body content", "content": { "application/vnd.onkey.entitypatchcollection+json": { "schema": { "$ref": "#/components/schemas/BatchChangeMonitoringPointTypeParameterPermissionTreeResourceActionRequest" } } }, "required": true, "x-position": 1 }, "responses": { "204": { "description": "Success response - operation was successfully executed" }, "202": { "$ref": "#/components/responses/accepted", "description": "" }, "default": { "$ref": "#/components/responses/default", "description": "" } } } } }, "components": { "schemas": { "OperationExecutionMode": { "type": "string", "description": "", "x-enumNames": [ "AllOrNone", "PerRecord" ], "enum": [ "AllOrNone", "PerRecord" ] }, "SeverityType": { "type": "string", "description": "", "nullable": false, "x-enumNames": [ "Error", "Warning", "Information" ], "enum": [ "error", "warning", "information" ] }, "NotificationItemSchema": { "title": "NotificationItemSchema", "type": "object", "additionalProperties": false, "properties": { "code": { "title": "code", "type": "string", "description": "Unique code for message", "nullable": false }, "message": { "title": "message", "type": "string", "nullable": false }, "objectId": { "title": "objectId", "type": "string", "description": "Optional id of record to which the message applies", "nullable": true }, "objectType": { "title": "objectType", "type": "string", "format": "enum", "nullable": true, "x-formatSpecifier": "EntityType" }, "properties": { "title": "properties", "type": "array", "description": "Collection of properties referenced by the message using property path syntax", "nullable": true, "example": [ "Asset->Code" ], "items": { "type": "string" } }, "severity": { "$ref": "#/components/schemas/SeverityType" }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Optional provided unique external record identifier to echo back with message", "nullable": true } } }, "NotificationSchema": { "title": "NotificationSchema", "type": "object", "additionalProperties": false, "properties": { "messages": { "title": "messages", "type": "array", "description": "Collection of messages", "nullable": false, "items": { "$ref": "#/components/schemas/NotificationItemSchema" } } } }, "EntityPermissionViolationSchema": { "type": "object", "additionalProperties": false, "required": [ "permissionTreeId" ], "properties": { "permissionId": { "type": "integer", "format": "int64" }, "permissionTreeId": { "type": "integer", "format": "int64", "nullable": true }, "propertyPaths": { "type": "array", "items": { "type": "string" } } } }, "EntityPhraseTranslationSchema": { "type": "object", "additionalProperties": false, "required": [ "translation" ], "properties": { "phrase": { "type": "string" }, "translation": { "type": "string", "nullable": true }, "propertyPaths": { "type": "array", "items": { "type": "string" } } } }, "Link": { "type": "object", "additionalProperties": false, "required": [ "href", "method" ], "properties": { "doc": { "type": "string", "description": "Documentation endpoint that describes the link", "nullable": true }, "href": { "type": "string", "description": "Endpoint to invoke link", "minLength": 1 }, "mapping": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "method": { "type": "string", "description": "HTTP method used for link", "minLength": 1 }, "module": { "type": "string", "description": "Module used by link", "nullable": true }, "rel": { "type": "string", "nullable": true }, "resource": { "type": "string", "description": "Resource used by link", "nullable": true }, "resourceAction": { "type": "string", "description": "Resource Action used by link", "nullable": true }, "title": { "type": "string", "description": "Title", "nullable": true }, "type": { "description": "Type of link", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ResourceLinkType" } ] } } }, "LinkMapping": { "type": "object", "additionalProperties": false, "required": [ "source" ], "properties": { "source": { "type": "string" }, "target": { "type": "string", "nullable": true } } }, "ResourceLinkType": { "type": "string", "description": "", "x-enumNames": [ "Association", "PrimaryAction", "CustomAction", "Collection", "Detail", "Lookup", "Documentation", "Navigation", "Specification" ], "enum": [ "association", "primaryAction", "customAction", "collection", "detail", "lookup", "documentation", "navigation", "specification" ] }, "GetMonitorPointTypeResourceActionResponse": { "title": "GetMonitorPointTypeResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetMonitorPointTypeResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Alarm->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "Alarm->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "Alarm->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Alarm->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Alarm->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "Alarm->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "Alarm->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Alarm->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Alarm->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "Alarm->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "Alarm->PermissionTree_Description" }, "alarmTypeId": { "title": "alarmTypeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Alarm->AlarmType_Id" }, "alarmTypeCode": { "title": "alarmTypeCode", "type": "string", "nullable": true, "x-propertyPath": "Alarm->AlarmType_Code" }, "alarmTypeDescription": { "title": "alarmTypeDescription", "type": "string", "nullable": true, "x-propertyPath": "Alarm->AlarmType_Description" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Alarm->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "nullable": true, "x-propertyPath": "Alarm->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "nullable": true, "x-propertyPath": "Alarm->Asset_Description" }, "assetRecordType": { "title": "assetRecordType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "Alarm->Asset_RecordType", "x-formatSpecifier": "AssetRecordType" }, "classification": { "title": "classification", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Alarm->Classification", "x-formatSpecifier": "AlarmClassification" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Alarm->Description" }, "exceededBound": { "title": "exceededBound", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "Alarm->ExceededBound", "x-formatSpecifier": "ExceededBound" }, "monitoringPointId": { "title": "monitoringPointId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Alarm->MonitoringPoint_Id" }, "monitoringPointCode": { "title": "monitoringPointCode", "type": "string", "nullable": true, "x-propertyPath": "Alarm->MonitoringPoint_Code" }, "monitoringPointDescription": { "title": "monitoringPointDescription", "type": "string", "nullable": true, "x-propertyPath": "Alarm->MonitoringPoint_Description" }, "monitoringPointIsCalculated": { "title": "monitoringPointIsCalculated", "type": "boolean", "nullable": true, "x-propertyPath": "Alarm->MonitoringPoint_IsCalculated" }, "monitoringPointMonitoringPointTypeId": { "title": "monitoringPointMonitoringPointTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Alarm->MonitoringPoint_MonitoringPointType_Id" }, "monitoringPointMonitoringPointTypeCode": { "title": "monitoringPointMonitoringPointTypeCode", "type": "string", "nullable": true, "x-propertyPath": "Alarm->MonitoringPoint_MonitoringPointType_Code" }, "monitoringPointMonitoringPointTypeDescription": { "title": "monitoringPointMonitoringPointTypeDescription", "type": "string", "nullable": true, "x-propertyPath": "Alarm->MonitoringPoint_MonitoringPointType_Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Alarm->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Alarm->SequenceNumber" }, "source": { "title": "source", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Alarm->Source", "x-formatSpecifier": "AlarmSource" }, "status": { "title": "status", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "Alarm->Status", "x-formatSpecifier": "AlarmStatus" }, "workOrderGenerated": { "title": "workOrderGenerated", "type": "boolean", "nullable": false, "x-propertyPath": "Alarm->WorkOrderGenerated" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetAlarmCollectionResourceActionResponse": { "title": "GetAlarmCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAlarmCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetAlarmCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Alarm->Description" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Alarm->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "nullable": true, "x-propertyPath": "Alarm->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "nullable": true, "x-propertyPath": "Alarm->Asset_Description" }, "alarmTypeId": { "title": "alarmTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Alarm->AlarmType_Id" }, "alarmTypeCode": { "title": "alarmTypeCode", "type": "string", "nullable": false, "x-propertyPath": "Alarm->AlarmType_Code" }, "alarmTypeDescription": { "title": "alarmTypeDescription", "type": "string", "nullable": false, "x-propertyPath": "Alarm->AlarmType_Description" }, "workOrderGenerated": { "title": "workOrderGenerated", "type": "boolean", "nullable": false, "x-propertyPath": "Alarm->WorkOrderGenerated" }, "status": { "title": "status", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "Alarm->Status", "x-formatSpecifier": "AlarmStatus" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Alarm->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Alarm->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Alarm->ModifiedOn" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "Alarm->SequenceNumber" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "AlarmAlarmTypeLookupResourceActionResponse": { "title": "AlarmAlarmTypeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AlarmAlarmTypeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "AlarmAlarmTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "AlarmType->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "AlarmType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "AlarmAssetLookupResourceActionResponse": { "title": "AlarmAssetLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AlarmAssetLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "AlarmAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": true, "x-propertyPath": "Asset->Code" }, "description": { "title": "description", "type": "string", "nullable": true, "x-propertyPath": "Asset->Description" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "Asset->RecordType", "x-formatSpecifier": "AssetRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "AlarmChangePermissionTreeLookupResourceActionResponse": { "title": "AlarmChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AlarmChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "AlarmChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "AlarmInsertPermissionTreeLookupResourceActionResponse": { "title": "AlarmInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AlarmInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "AlarmInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateAlarmResourceActionRequest": { "title": "CreateAlarmResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateAlarmResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "alarmTypeId", "description", "permissionTreeId" ], "properties": { "alarmTypeId": { "title": "alarmTypeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Alarm->AlarmType_Id" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Alarm->Asset_Id" }, "classification": { "title": "classification", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Alarm->Classification", "x-formatSpecifier": "AlarmClassification" }, "description": { "title": "description", "type": "string", "maxLength": 500, "minLength": 1, "nullable": false, "x-propertyPath": "Alarm->Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Alarm->PermissionTree_Id" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "Alarm->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "PatchOperationType": { "type": "string", "description": "", "nullable": true, "x-enumNames": [ "Replace", "Add", "Remove" ], "enum": [ "replace", "add", "remove" ] }, "EntityPatchOperationSchema": { "type": "object", "additionalProperties": false, "required": [ "path", "value" ], "properties": { "op": { "title": "op", "description": "Type of operation to apply", "example": "replace", "$ref": "#/components/schemas/PatchOperationType" }, "path": { "title": "path", "type": "string", "description": "Property path for the property being updated", "nullable": false, "example": "Asset->Code" }, "value": { "title": "value", "type": "object", "description": "Value for the property being updated", "nullable": true, "example": "BOILER", "additionalProperties": false } } }, "UpdateAlarmResourceActionRequest": { "title": "UpdateAlarmResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "assetId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Alarm->Asset_Id" }, { "title": "alarmTypeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Alarm->AlarmType_Id" }, { "title": "classification", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Alarm->Classification", "x-formatSpecifier": "AlarmClassification" }, { "title": "description", "type": "string", "maxLength": 500, "minLength": 1, "nullable": false, "x-propertyPath": "Alarm->Description" }, { "title": "notes", "type": "string", "readOnly": true, "nullable": true, "x-propertyPath": "Alarm->Notes", "x-ReadOnlyExpression": "Alarm->Status EQ 'Cancelled' OR Alarm->Status EQ 'ClosedBySystem' OR Alarm->Status EQ 'Closed'" } ] } } }, "BatchGetAlarmsResourceAction": { "title": "BatchGetAlarmsResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Alarm entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Alarm entities", "items": { "$ref": "#/components/schemas/GetMonitorPointTypeResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateAlarmRequest": { "title": "BatchCreateAlarmRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateAlarmResourceActionRequest" } }, "BatchUpdateAlarmResourceActionRequest": { "title": "BatchUpdateAlarmResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateAlarmResourceActionRequest" } }, "ChangeAlarmPermissionTreeResourceActionRequest": { "title": "ChangeAlarmPermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "Alarm->PermissionTree_Id" } ] } } }, "ChangeAlarmStatusResourceActionRequest": { "title": "ChangeAlarmStatusResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "status", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "ChangeAlarmStatus->Status", "x-formatSpecifier": "AlarmStatus" } ] } } }, "BatchChangeAlarmPermissionTreeResourceActionRequest": { "title": "BatchChangeAlarmPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeAlarmPermissionTreeResourceActionRequest" } }, "BatchChangeAlarmStatusResourceActionRequest": { "title": "BatchChangeAlarmStatusResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeAlarmStatusResourceActionRequest" } }, "DynamicValueSchema": { "title": "DynamicValueSchema", "type": "object", "additionalProperties": false, "properties": { "type": { "title": "type", "type": "string", "format": "enum", "nullable": false, "x-formatSpecifier": "DynamicValueType", "x-enumNames": [ "String", "Email", "Integer", "Long", "Float", "Currency", "DateTime", "Date", "Time", "Duration", "Boolean" ] }, "value": { "title": "value", "type": "object", "additionalProperties": false } } }, "GetAlarmAttributeResourceActionResponse": { "title": "GetAlarmAttributeResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetAlarmAttributeResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "alarmId": { "title": "alarmId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "AlarmAttribute->Alarm_Id" }, "alarmDescription": { "title": "alarmDescription", "type": "string", "nullable": true, "x-propertyPath": "AlarmAttribute->Alarm_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "AlarmAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "AlarmAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AlarmAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": true, "x-propertyPath": "AlarmAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "AlarmAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "AlarmAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AlarmAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "AlarmAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "AlarmAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "AlarmAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "AlarmAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "nullable": true, "x-propertyPath": "AlarmAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "nullable": true, "x-propertyPath": "AlarmAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "nullable": true, "x-propertyPath": "AlarmAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "AlarmAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "AlarmAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "AlarmAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "AlarmAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "AlarmAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "AlarmAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "AlarmAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "AlarmAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "AlarmAttribute->Value", "x-formatSpecifier": "DynamicValue" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetAlarmAttributeCollectionForAlarmResourceActionResponse": { "title": "GetAlarmAttributeCollectionForAlarmResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAlarmAttributeCollectionForAlarmResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetAlarmAttributeCollectionForAlarmResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "AlarmAttribute->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "nullable": false, "x-propertyPath": "AlarmAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "nullable": false, "x-propertyPath": "AlarmAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "AlarmAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "AlarmAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "AlarmAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "AlarmAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "AlarmAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AlarmAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AlarmAttribute->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetAlarmAttributeCollectionResourceActionResponse": { "title": "GetAlarmAttributeCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAlarmAttributeCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetAlarmAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "alarmId": { "title": "alarmId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmAttribute->Alarm_Id" }, "alarmDescription": { "title": "alarmDescription", "type": "string", "nullable": false, "x-propertyPath": "AlarmAttribute->Alarm_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "AlarmAttribute->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "nullable": false, "x-propertyPath": "AlarmAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "nullable": false, "x-propertyPath": "AlarmAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "AlarmAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "AlarmAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "AlarmAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "AlarmAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "AlarmAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AlarmAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AlarmAttribute->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "AlarmAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "AlarmAttributeAttributeAllowedValueLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AlarmAttributeAttributeAllowedValueLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "AlarmAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "nullable": true, "x-propertyPath": "AttributeAllowedValue->Description" }, "value": { "title": "value", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "AttributeAllowedValue->Value", "x-formatSpecifier": "DynamicValue" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "AlarmAttributeAttributeLookupResourceActionResponse": { "title": "AlarmAttributeAttributeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AlarmAttributeAttributeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "AlarmAttributeAttributeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Attribute->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Attribute->Description" }, "allowAnyValue": { "title": "allowAnyValue", "type": "boolean", "nullable": false, "x-propertyPath": "Attribute->AllowAnyValue" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Attribute->DataType", "x-formatSpecifier": "DynamicValueType" }, "defaultValue": { "title": "defaultValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultValue", "x-formatSpecifier": "DynamicValue", "x-NullExpression": "Attribute->AllowAnyValue eq false" }, "defaultAllowedValueId": { "title": "defaultAllowedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Id" }, "defaultAllowedValueValue": { "title": "defaultAllowedValueValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "defaultAllowedValueDescription": { "title": "defaultAllowedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Description" }, "explanation": { "title": "explanation", "type": "string", "nullable": true, "x-propertyPath": "Attribute->Explanation" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "AlarmAttributeChangePermissionTreeLookupResourceActionResponse": { "title": "AlarmAttributeChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AlarmAttributeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "AlarmAttributeChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "AlarmAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "AlarmAttributeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AlarmAttributeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "AlarmAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "AlarmAttributeAlarmLookupResourceActionResponse": { "title": "AlarmAttributeAlarmLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AlarmAttributeAlarmLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "AlarmAttributeAlarmLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Alarm->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateAlarmAttributeResourceActionRequest": { "title": "CreateAlarmAttributeResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateAlarmAttributeResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "alarmId", "attributeId" ], "properties": { "alarmId": { "title": "alarmId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "AlarmAttribute->Alarm_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "AlarmAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "AlarmAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "AlarmAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "AlarmAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "AlarmAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateAlarmAttributeResourceActionRequest": { "title": "UpdateAlarmAttributeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "value", "format": "composite", "nullable": true, "x-propertyPath": "AlarmAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "AlarmAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "AlarmAttribute->Notes" } ] } } }, "DeleteAlarmAttributeResourceActionRequest": { "title": "DeleteAlarmAttributeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetAlarmAttributeResourceAction": { "title": "BatchGetAlarmAttributeResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Alarm Attribute entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Alarm Attribute entities", "items": { "$ref": "#/components/schemas/GetAlarmAttributeResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateAlarmAttributeResourceActionRequest": { "title": "BatchCreateAlarmAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateAlarmAttributeResourceActionRequest" } }, "BatchUpdateAlarmAttributeResourceActionRequest": { "title": "BatchUpdateAlarmAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateAlarmAttributeResourceActionRequest" } }, "BatchDeleteAlarmAttributeResourceActionRequest": { "title": "BatchDeleteAlarmAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteAlarmAttributeResourceActionRequest" } }, "ChangeAlarmAttributeIsActiveResourceActionRequest": { "title": "ChangeAlarmAttributeIsActiveResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "AlarmAttribute->IsActive" } ] } } }, "ChangeAlarmAttributePermissionTreeResourceActionRequest": { "title": "ChangeAlarmAttributePermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "AlarmAttribute->PermissionTree_Id" } ] } } }, "BatchChangeAlarmAttributePermissionTreeResourceActionRequest": { "title": "BatchChangeAlarmAttributePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeAlarmAttributePermissionTreeResourceActionRequest" } }, "BatchChangeAlarmAttributeIsActiveResourceActionRequest": { "title": "BatchChangeAlarmAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeAlarmAttributeIsActiveResourceActionRequest" } }, "GetAlarmDocumentResourceActionResponse": { "title": "GetAlarmDocumentResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetAlarmDocumentResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "alarmId": { "title": "alarmId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "AlarmDocument->Alarm_Id" }, "alarmDescription": { "title": "alarmDescription", "type": "string", "nullable": true, "x-propertyPath": "AlarmDocument->Alarm_Description" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": true, "x-propertyPath": "AlarmDocument->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmDocument->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "AlarmDocument->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "AlarmDocument->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AlarmDocument->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmDocument->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "AlarmDocument->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "AlarmDocument->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AlarmDocument->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "AlarmDocument->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "AlarmDocument->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "AlarmDocument->PermissionTree_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "AlarmDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "nullable": true, "x-propertyPath": "AlarmDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "nullable": true, "x-propertyPath": "AlarmDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "nullable": true, "x-propertyPath": "AlarmDocument->DocumentRecord_FileLocation" }, "documentRecordFileInfoId": { "title": "documentRecordFileInfoId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmDocument->DocumentRecord_FileInfoId" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "nullable": true, "x-propertyPath": "AlarmDocument->DocumentRecord_FileFullName" }, "documentRecordContentId": { "title": "documentRecordContentId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmDocument->DocumentRecord_Content_Id" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "AlarmDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeId": { "title": "documentRecordFileTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmDocument->DocumentRecord_FileType_Id" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "AlarmDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "AlarmDocument->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "AlarmDocument->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetAlarmDocumentCollectionForAlarmResourceActionResponse": { "title": "GetAlarmDocumentCollectionForAlarmResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAlarmDocumentCollectionForAlarmResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetAlarmDocumentCollectionForAlarmResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "AlarmDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "nullable": false, "x-propertyPath": "AlarmDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "nullable": false, "x-propertyPath": "AlarmDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "nullable": true, "x-propertyPath": "AlarmDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "nullable": true, "x-propertyPath": "AlarmDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "AlarmDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "AlarmDocument->DocumentRecord_FileType_Extension" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetAlarmDocumentCollectionResourceActionResponse": { "title": "GetAlarmDocumentCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAlarmDocumentCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetAlarmDocumentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "alarmId": { "title": "alarmId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmDocument->Alarm_Id" }, "alarmDescription": { "title": "alarmDescription", "type": "string", "nullable": false, "x-propertyPath": "AlarmDocument->Alarm_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "AlarmDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "nullable": false, "x-propertyPath": "AlarmDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "nullable": false, "x-propertyPath": "AlarmDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "nullable": true, "x-propertyPath": "AlarmDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "nullable": true, "x-propertyPath": "AlarmDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "AlarmDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "AlarmDocument->DocumentRecord_FileType_Extension" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "AlarmDocumentAlarmLookupResourceActionResponse": { "title": "AlarmDocumentAlarmLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AlarmDocumentAlarmLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "AlarmDocumentAlarmLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Alarm->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "AlarmDocumentChangePermissionTreeLookupResourceActionResponse": { "title": "AlarmDocumentChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AlarmDocumentChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "AlarmDocumentChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "AlarmDocumentDocumentLookupResourceActionResponse": { "title": "AlarmDocumentDocumentLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AlarmDocumentDocumentLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "AlarmDocumentDocumentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "DocumentRecord->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "DocumentRecord->Description" }, "fileLocation": { "title": "fileLocation", "type": "string", "nullable": true, "x-propertyPath": "DocumentRecord->FileLocation" }, "fileFullName": { "title": "fileFullName", "type": "string", "nullable": true, "x-propertyPath": "DocumentRecord->FileFullName" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "AlarmDocumentInsertPermissionTreeLookupResourceActionResponse": { "title": "AlarmDocumentInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AlarmDocumentInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "AlarmDocumentInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateAlarmDocumentResourceActionRequest": { "title": "CreateAlarmDocumentResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateAlarmDocumentResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "alarmId", "documentRecordId" ], "properties": { "alarmId": { "title": "alarmId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "AlarmDocument->Alarm_Id" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "AlarmDocument->DocumentRecord_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "AlarmDocument->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "AlarmDocument->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "AlarmDocument->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateAlarmDocumentResourceActionRequest": { "title": "UpdateAlarmDocumentResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "AlarmDocument->SequenceNumber" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "AlarmDocument->Notes" } ] } } }, "DeleteAlarmDocumentResourceActionRequest": { "title": "DeleteAlarmDocumentResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetAlarmDocumentResourceAction": { "title": "BatchGetAlarmDocumentResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Alarm Document entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Alarm Document entities", "items": { "$ref": "#/components/schemas/GetAlarmDocumentResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateAlarmDocumentResourceActionRequest": { "title": "BatchCreateAlarmDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateAlarmDocumentResourceActionRequest" } }, "BatchUpdateAlarmDocumentResourceActionRequest": { "title": "BatchUpdateAlarmDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateAlarmDocumentResourceActionRequest" } }, "BatchDeleteAlarmDocumentResourceActionRequest": { "title": "BatchDeleteAlarmDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteAlarmDocumentResourceActionRequest" } }, "ChangeAlarmDocumentIsActiveResourceActionRequest": { "title": "ChangeAlarmDocumentIsActiveResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "AlarmDocument->IsActive" } ] } } }, "ChangeAlarmDocumentPermissionTreeResourceActionRequest": { "title": "ChangeAlarmDocumentPermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "AlarmDocument->PermissionTree_Id" } ] } } }, "BatchChangeAlarmDocumentPermissionTreeResourceActionRequest": { "title": "BatchChangeAlarmDocumentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeAlarmDocumentPermissionTreeResourceActionRequest" } }, "BatchChangeAlarmDocumentIsActiveResourceActionRequest": { "title": "BatchChangeAlarmDocumentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeAlarmDocumentIsActiveResourceActionRequest" } }, "GetMonitorPointTypeResourceActionResponse2": { "title": "GetMonitorPointTypeResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetMonitorPointTypeResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmExpression->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "AlarmExpression->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "AlarmExpression->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AlarmExpression->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmExpression->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "AlarmExpression->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "AlarmExpression->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AlarmExpression->ModifiedOn" }, "alarmId": { "title": "alarmId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "AlarmExpression->Alarm_Id" }, "alarmDescription": { "title": "alarmDescription", "type": "string", "nullable": true, "x-propertyPath": "AlarmExpression->Alarm_Description" }, "monitoringPointTriggerExpressionId": { "title": "monitoringPointTriggerExpressionId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "AlarmExpression->MonitoringPointTriggerExpression_Id" }, "monitoringPointTriggerExpressionDescription": { "title": "monitoringPointTriggerExpressionDescription", "type": "string", "nullable": true, "x-propertyPath": "AlarmExpression->MonitoringPointTriggerExpression_Description" }, "monitoringPointTriggerExpressionExpression": { "title": "monitoringPointTriggerExpressionExpression", "type": "string", "nullable": true, "x-propertyPath": "AlarmExpression->MonitoringPointTriggerExpression_Expression" }, "status": { "title": "status", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "AlarmExpression->Status", "x-formatSpecifier": "AlarmDetailStatus" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetAlarmExpressionCollectionResourceActionResponse": { "title": "GetAlarmExpressionCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAlarmExpressionCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetAlarmExpressionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "alarmDescription": { "title": "alarmDescription", "type": "string", "nullable": false, "x-propertyPath": "AlarmExpression->Alarm_Description" }, "status": { "title": "status", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "AlarmExpression->Status", "x-formatSpecifier": "AlarmDetailStatus" }, "monitoringPointTriggerExpressionDescription": { "title": "monitoringPointTriggerExpressionDescription", "type": "string", "nullable": false, "x-propertyPath": "AlarmExpression->MonitoringPointTriggerExpression_Description" }, "monitoringPointTriggerExpressionExpression": { "title": "monitoringPointTriggerExpressionExpression", "type": "string", "nullable": false, "x-propertyPath": "AlarmExpression->MonitoringPointTriggerExpression_Expression" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetAlarmExpressionForAlarmCollectionResourceActionResponse": { "title": "GetAlarmExpressionForAlarmCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAlarmExpressionForAlarmCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetAlarmExpressionForAlarmCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "monitoringPointTriggerExpressionDescription": { "title": "monitoringPointTriggerExpressionDescription", "type": "string", "nullable": false, "x-propertyPath": "AlarmExpression->MonitoringPointTriggerExpression_Description" }, "monitoringPointTriggerExpressionExpression": { "title": "monitoringPointTriggerExpressionExpression", "type": "string", "nullable": false, "x-propertyPath": "AlarmExpression->MonitoringPointTriggerExpression_Expression" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "BatchGetAlarmExpressionResourceAction": { "title": "BatchGetAlarmExpressionResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Alarm Expression entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Alarm Expression entities", "items": { "$ref": "#/components/schemas/GetMonitorPointTypeResourceActionResponse2" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetMonitorPointTypeResourceActionResponse3": { "title": "GetMonitorPointTypeResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetMonitorPointTypeResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmExpressionTask->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "AlarmExpressionTask->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "AlarmExpressionTask->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AlarmExpressionTask->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmExpressionTask->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "AlarmExpressionTask->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "AlarmExpressionTask->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AlarmExpressionTask->ModifiedOn" }, "alarmExpressionId": { "title": "alarmExpressionId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "AlarmExpressionTask->AlarmExpression_Id" }, "alarmExpressionAlarmId": { "title": "alarmExpressionAlarmId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmExpressionTask->AlarmExpression_Alarm_Id" }, "alarmExpressionAlarmDescription": { "title": "alarmExpressionAlarmDescription", "type": "string", "nullable": true, "x-propertyPath": "AlarmExpressionTask->AlarmExpression_Alarm_Description" }, "alarmExpressionMonitoringPointTriggerExpressionId": { "title": "alarmExpressionMonitoringPointTriggerExpressionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmExpressionTask->AlarmExpression_MonitoringPointTriggerExpression_Id" }, "alarmExpressionMonitoringPointTriggerExpressionDescription": { "title": "alarmExpressionMonitoringPointTriggerExpressionDescription", "type": "string", "nullable": true, "x-propertyPath": "AlarmExpressionTask->AlarmExpression_MonitoringPointTriggerExpression_Description" }, "alarmExpressionMonitoringPointTriggerExpressionExpression": { "title": "alarmExpressionMonitoringPointTriggerExpressionExpression", "type": "string", "nullable": true, "x-propertyPath": "AlarmExpressionTask->AlarmExpression_MonitoringPointTriggerExpression_Expression" }, "regularAssetTaskId": { "title": "regularAssetTaskId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "AlarmExpressionTask->RegularAssetTask_Id" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "nullable": true, "x-propertyPath": "AlarmExpressionTask->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "nullable": true, "x-propertyPath": "AlarmExpressionTask->RegularAssetTask_Description" }, "regularAssetTaskRecordType": { "title": "regularAssetTaskRecordType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "AlarmExpressionTask->RegularAssetTask_RecordType", "x-formatSpecifier": "AssetTaskRecordType" }, "regularAssetTaskAssetId": { "title": "regularAssetTaskAssetId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmExpressionTask->RegularAssetTask_Asset_Id" }, "regularAssetTaskAssetCode": { "title": "regularAssetTaskAssetCode", "type": "string", "nullable": true, "x-propertyPath": "AlarmExpressionTask->RegularAssetTask_Asset_Code" }, "regularAssetTaskAssetDescription": { "title": "regularAssetTaskAssetDescription", "type": "string", "nullable": true, "x-propertyPath": "AlarmExpressionTask->RegularAssetTask_Asset_Description" }, "regularAssetTaskAssetRecordType": { "title": "regularAssetTaskAssetRecordType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "AlarmExpressionTask->RegularAssetTask_Asset_RecordType", "x-formatSpecifier": "AssetRecordType" }, "regularAssetTaskComponentId": { "title": "regularAssetTaskComponentId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmExpressionTask->RegularAssetTask_Component_Id" }, "regularAssetTaskComponentCode": { "title": "regularAssetTaskComponentCode", "type": "string", "nullable": true, "x-propertyPath": "AlarmExpressionTask->RegularAssetTask_Component_Code" }, "regularAssetTaskComponentDescription": { "title": "regularAssetTaskComponentDescription", "type": "string", "nullable": true, "x-propertyPath": "AlarmExpressionTask->RegularAssetTask_Component_Description" }, "regularAssetTaskComponentRecordType": { "title": "regularAssetTaskComponentRecordType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "AlarmExpressionTask->RegularAssetTask_Component_RecordType", "x-formatSpecifier": "AssetComponentRecordType" }, "regularAssetTaskSiteId": { "title": "regularAssetTaskSiteId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmExpressionTask->RegularAssetTask_Site_Id" }, "regularAssetTaskSiteCode": { "title": "regularAssetTaskSiteCode", "type": "string", "nullable": true, "x-propertyPath": "AlarmExpressionTask->RegularAssetTask_Site_Code" }, "regularAssetTaskSiteDescription": { "title": "regularAssetTaskSiteDescription", "type": "string", "nullable": true, "x-propertyPath": "AlarmExpressionTask->RegularAssetTask_Site_Description" }, "status": { "title": "status", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "AlarmExpressionTask->Status", "x-formatSpecifier": "AlarmDetailStatus" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetAlarmExpressionTaskForAlarmExpressionCollectionResourceActionResponse": { "title": "GetAlarmExpressionTaskForAlarmExpressionCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAlarmExpressionTaskForAlarmExpressionCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetAlarmExpressionTaskForAlarmExpressionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "alarmExpressionAlarmId": { "title": "alarmExpressionAlarmId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmExpressionTask->AlarmExpression_Alarm_Id" }, "alarmExpressionAlarmDescription": { "title": "alarmExpressionAlarmDescription", "type": "string", "nullable": false, "x-propertyPath": "AlarmExpressionTask->AlarmExpression_Alarm_Description" }, "alarmExpressionMonitoringPointTriggerExpressionDescription": { "title": "alarmExpressionMonitoringPointTriggerExpressionDescription", "type": "string", "nullable": false, "x-propertyPath": "AlarmExpressionTask->AlarmExpression_MonitoringPointTriggerExpression_Description" }, "alarmExpressionMonitoringPointTriggerExpressionExpression": { "title": "alarmExpressionMonitoringPointTriggerExpressionExpression", "type": "string", "nullable": false, "x-propertyPath": "AlarmExpressionTask->AlarmExpression_MonitoringPointTriggerExpression_Expression" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "nullable": false, "x-propertyPath": "AlarmExpressionTask->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "nullable": false, "x-propertyPath": "AlarmExpressionTask->RegularAssetTask_Description" }, "regularAssetTaskAssetCode": { "title": "regularAssetTaskAssetCode", "type": "string", "nullable": true, "x-propertyPath": "AlarmExpressionTask->RegularAssetTask_Asset_Code" }, "regularAssetTaskComponentCode": { "title": "regularAssetTaskComponentCode", "type": "string", "nullable": true, "x-propertyPath": "AlarmExpressionTask->RegularAssetTask_Component_Code" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetAlarmExpressionTaskCollectionResourceActionResponse": { "title": "GetAlarmExpressionTaskCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAlarmExpressionTaskCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetAlarmExpressionTaskCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "alarmExpressionAlarmDescription": { "title": "alarmExpressionAlarmDescription", "type": "string", "nullable": false, "x-propertyPath": "AlarmExpressionTask->AlarmExpression_Alarm_Description" }, "alarmExpressionMonitoringPointTriggerExpressionDescription": { "title": "alarmExpressionMonitoringPointTriggerExpressionDescription", "type": "string", "nullable": false, "x-propertyPath": "AlarmExpressionTask->AlarmExpression_MonitoringPointTriggerExpression_Description" }, "alarmExpressionMonitoringPointTriggerExpressionExpression": { "title": "alarmExpressionMonitoringPointTriggerExpressionExpression", "type": "string", "nullable": false, "x-propertyPath": "AlarmExpressionTask->AlarmExpression_MonitoringPointTriggerExpression_Expression" }, "status": { "title": "status", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "AlarmExpressionTask->Status", "x-formatSpecifier": "AlarmDetailStatus" }, "regularAssetTaskCode": { "title": "regularAssetTaskCode", "type": "string", "nullable": false, "x-propertyPath": "AlarmExpressionTask->RegularAssetTask_Code" }, "regularAssetTaskDescription": { "title": "regularAssetTaskDescription", "type": "string", "nullable": false, "x-propertyPath": "AlarmExpressionTask->RegularAssetTask_Description" }, "regularAssetTaskAssetCode": { "title": "regularAssetTaskAssetCode", "type": "string", "nullable": true, "x-propertyPath": "AlarmExpressionTask->RegularAssetTask_Asset_Code" }, "regularAssetTaskComponentCode": { "title": "regularAssetTaskComponentCode", "type": "string", "nullable": true, "x-propertyPath": "AlarmExpressionTask->RegularAssetTask_Component_Code" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "BatchGetAlarmExpressionTaskResourceAction": { "title": "BatchGetAlarmExpressionTaskResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Alarm Expression Task entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Alarm Expression Task entities", "items": { "$ref": "#/components/schemas/GetMonitorPointTypeResourceActionResponse3" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetAlarmTypeResourceActionResponse": { "title": "GetAlarmTypeResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetAlarmTypeResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "AlarmType->Code" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "AlarmType->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmType->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "AlarmType->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "AlarmType->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AlarmType->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmType->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "AlarmType->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "AlarmType->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AlarmType->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "AlarmType->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "AlarmType->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "AlarmType->PermissionTree_Description" }, "autoCreateWorkOrder": { "title": "autoCreateWorkOrder", "type": "boolean", "nullable": true, "x-propertyPath": "AlarmType->AutoCreateWorkOrder" }, "defaultWorkOrderSectionId": { "title": "defaultWorkOrderSectionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmType->DefaultWorkOrderSection_Id" }, "defaultWorkOrderSectionCode": { "title": "defaultWorkOrderSectionCode", "type": "string", "nullable": true, "x-propertyPath": "AlarmType->DefaultWorkOrderSection_Code" }, "defaultWorkOrderSectionDescription": { "title": "defaultWorkOrderSectionDescription", "type": "string", "nullable": true, "x-propertyPath": "AlarmType->DefaultWorkOrderSection_Description" }, "defaultWorkOrderStaffMemberId": { "title": "defaultWorkOrderStaffMemberId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmType->DefaultWorkOrderStaffMember_Id" }, "defaultWorkOrderStaffMemberCode": { "title": "defaultWorkOrderStaffMemberCode", "type": "string", "nullable": true, "x-propertyPath": "AlarmType->DefaultWorkOrderStaffMember_Code" }, "defaultWorkOrderStaffMemberDescription": { "title": "defaultWorkOrderStaffMemberDescription", "type": "string", "nullable": true, "x-propertyPath": "AlarmType->DefaultWorkOrderStaffMember_Description" }, "defaultWorkOrderStaffMemberContactDetailId": { "title": "defaultWorkOrderStaffMemberContactDetailId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmType->DefaultWorkOrderStaffMember_ContactDetailId" }, "defaultWorkOrderStaffMemberContactDetailFullName": { "title": "defaultWorkOrderStaffMemberContactDetailFullName", "type": "string", "nullable": true, "x-propertyPath": "AlarmType->DefaultWorkOrderStaffMember_ContactDetailFullName" }, "defaultWorkOrderStatusId": { "title": "defaultWorkOrderStatusId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmType->DefaultWorkOrderStatus_Id" }, "defaultWorkOrderStatusCode": { "title": "defaultWorkOrderStatusCode", "type": "string", "nullable": true, "x-propertyPath": "AlarmType->DefaultWorkOrderStatus_Code" }, "defaultWorkOrderStatusDescription": { "title": "defaultWorkOrderStatusDescription", "type": "string", "nullable": true, "x-propertyPath": "AlarmType->DefaultWorkOrderStatus_Description" }, "defaultWorkOrderTradeId": { "title": "defaultWorkOrderTradeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmType->DefaultWorkOrderTrade_Id" }, "defaultWorkOrderTradeCode": { "title": "defaultWorkOrderTradeCode", "type": "string", "nullable": true, "x-propertyPath": "AlarmType->DefaultWorkOrderTrade_Code" }, "defaultWorkOrderTradeDescription": { "title": "defaultWorkOrderTradeDescription", "type": "string", "nullable": true, "x-propertyPath": "AlarmType->DefaultWorkOrderTrade_Description" }, "defaultWorkOrderTypeOfWorkId": { "title": "defaultWorkOrderTypeOfWorkId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmType->DefaultWorkOrderTypeOfWork_Id" }, "defaultWorkOrderTypeOfWorkCode": { "title": "defaultWorkOrderTypeOfWorkCode", "type": "string", "nullable": true, "x-propertyPath": "AlarmType->DefaultWorkOrderTypeOfWork_Code" }, "defaultWorkOrderTypeOfWorkDescription": { "title": "defaultWorkOrderTypeOfWorkDescription", "type": "string", "nullable": true, "x-propertyPath": "AlarmType->DefaultWorkOrderTypeOfWork_Description" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "AlarmType->Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "AlarmType->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "AlarmType->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetAlarmTypeCollectionResourceActionResponse": { "title": "GetAlarmTypeCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetAlarmTypeCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetAlarmTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "AlarmType->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "AlarmType->Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "AlarmType->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "AlarmType->SequenceNumber" }, "defaultWorkOrderTypeOfWorkId": { "title": "defaultWorkOrderTypeOfWorkId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmType->DefaultWorkOrderTypeOfWork_Id" }, "defaultWorkOrderTypeOfWorkCode": { "title": "defaultWorkOrderTypeOfWorkCode", "type": "string", "nullable": false, "x-propertyPath": "AlarmType->DefaultWorkOrderTypeOfWork_Code" }, "defaultWorkOrderTypeOfWorkDescription": { "title": "defaultWorkOrderTypeOfWorkDescription", "type": "string", "nullable": false, "x-propertyPath": "AlarmType->DefaultWorkOrderTypeOfWork_Description" }, "defaultWorkOrderStatusId": { "title": "defaultWorkOrderStatusId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmType->DefaultWorkOrderStatus_Id" }, "defaultWorkOrderStatusCode": { "title": "defaultWorkOrderStatusCode", "type": "string", "nullable": false, "x-propertyPath": "AlarmType->DefaultWorkOrderStatus_Code" }, "defaultWorkOrderStatusDescription": { "title": "defaultWorkOrderStatusDescription", "type": "string", "nullable": false, "x-propertyPath": "AlarmType->DefaultWorkOrderStatus_Description" }, "defaultWorkOrderSectionId": { "title": "defaultWorkOrderSectionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmType->DefaultWorkOrderSection_Id" }, "defaultWorkOrderSectionCode": { "title": "defaultWorkOrderSectionCode", "type": "string", "nullable": false, "x-propertyPath": "AlarmType->DefaultWorkOrderSection_Code" }, "defaultWorkOrderSectionDescription": { "title": "defaultWorkOrderSectionDescription", "type": "string", "nullable": false, "x-propertyPath": "AlarmType->DefaultWorkOrderSection_Description" }, "defaultWorkOrderTradeId": { "title": "defaultWorkOrderTradeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmType->DefaultWorkOrderTrade_Id" }, "defaultWorkOrderTradeCode": { "title": "defaultWorkOrderTradeCode", "type": "string", "nullable": false, "x-propertyPath": "AlarmType->DefaultWorkOrderTrade_Code" }, "defaultWorkOrderTradeDescription": { "title": "defaultWorkOrderTradeDescription", "type": "string", "nullable": false, "x-propertyPath": "AlarmType->DefaultWorkOrderTrade_Description" }, "defaultWorkOrderStaffMemberId": { "title": "defaultWorkOrderStaffMemberId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmType->DefaultWorkOrderStaffMember_Id" }, "defaultWorkOrderStaffMemberCode": { "title": "defaultWorkOrderStaffMemberCode", "type": "string", "nullable": false, "x-propertyPath": "AlarmType->DefaultWorkOrderStaffMember_Code" }, "defaultWorkOrderStaffMemberDescription": { "title": "defaultWorkOrderStaffMemberDescription", "type": "string", "nullable": true, "x-propertyPath": "AlarmType->DefaultWorkOrderStaffMember_Description" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "AlarmType->IsActive" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AlarmType->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "AlarmType->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "AlarmTypeChangePermissionTreeLookupResourceActionResponse": { "title": "AlarmTypeChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AlarmTypeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "AlarmTypeChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "AlarmTypeDefaultWorkOrderStaffMemberLookupResourceActionResponse": { "title": "AlarmTypeDefaultWorkOrderStaffMemberLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AlarmTypeDefaultWorkOrderStaffMemberLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "AlarmTypeDefaultWorkOrderStaffMemberLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Resource->Code" }, "contactDetailFirstName": { "title": "contactDetailFirstName", "type": "string", "nullable": true, "x-propertyPath": "Resource->ContactDetailFirstName" }, "contactDetailLastName": { "title": "contactDetailLastName", "type": "string", "nullable": true, "x-propertyPath": "Resource->ContactDetailLastName" }, "contactDetailFullName": { "title": "contactDetailFullName", "type": "string", "nullable": true, "x-propertyPath": "Resource->ContactDetailFullName" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "AlarmTypeDefaultWorkOrderTradeLookupResourceActionResponse": { "title": "AlarmTypeDefaultWorkOrderTradeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AlarmTypeDefaultWorkOrderTradeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "AlarmTypeDefaultWorkOrderTradeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Trade->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Trade->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "AlarmTypeInsertPermissionTreeLookupResourceActionResponse": { "title": "AlarmTypeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AlarmTypeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "AlarmTypeInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "AlarmTypeSectionLookupResourceActionResponse": { "title": "AlarmTypeSectionLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AlarmTypeSectionLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "AlarmTypeSectionLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Section->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Section->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "AlarmTypeTypeOfWorkLookupResourceActionResponse": { "title": "AlarmTypeTypeOfWorkLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AlarmTypeTypeOfWorkLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "AlarmTypeTypeOfWorkLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "TypeOfWork->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "TypeOfWork->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "AlarmTypeWorkOrderStatusLookupResourceActionResponse": { "title": "AlarmTypeWorkOrderStatusLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "AlarmTypeWorkOrderStatusLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "AlarmTypeWorkOrderStatusLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "WorkOrderStatus->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "WorkOrderStatus->Description" }, "baseStatus": { "title": "baseStatus", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "WorkOrderStatus->BaseStatus", "x-formatSpecifier": "WorkOrderStatusBaseStatus" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateAlarmTypeResourceActionRequest": { "title": "CreateAlarmTypeResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateAlarmTypeResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "code", "description", "permissionTreeId" ], "properties": { "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "AlarmType->Code" }, "description": { "title": "description", "type": "string", "maxLength": 500, "minLength": 1, "nullable": false, "x-propertyPath": "AlarmType->Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "AlarmType->PermissionTree_Id" }, "autoCreateWorkOrder": { "title": "autoCreateWorkOrder", "type": "boolean", "nullable": true, "x-propertyPath": "AlarmType->AutoCreateWorkOrder" }, "defaultWorkOrderStatusId": { "title": "defaultWorkOrderStatusId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmType->DefaultWorkOrderStatus_Id" }, "defaultWorkOrderSectionId": { "title": "defaultWorkOrderSectionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmType->DefaultWorkOrderSection_Id" }, "defaultWorkOrderStaffMemberId": { "title": "defaultWorkOrderStaffMemberId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmType->DefaultWorkOrderStaffMember_Id" }, "defaultWorkOrderTradeId": { "title": "defaultWorkOrderTradeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmType->DefaultWorkOrderTrade_Id" }, "defaultWorkOrderTypeOfWorkId": { "title": "defaultWorkOrderTypeOfWorkId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmType->DefaultWorkOrderTypeOfWork_Id" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "AlarmType->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "AlarmType->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateAlarmTypeResourceActionRequest": { "title": "UpdateAlarmTypeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "AlarmType->Code" }, { "title": "description", "type": "string", "maxLength": 500, "minLength": 1, "nullable": false, "x-propertyPath": "AlarmType->Description" }, { "title": "autoCreateWorkOrder", "type": "boolean", "nullable": true, "x-propertyPath": "AlarmType->AutoCreateWorkOrder" }, { "title": "defaultWorkOrderStatusId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmType->DefaultWorkOrderStatus_Id" }, { "title": "defaultWorkOrderSectionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmType->DefaultWorkOrderSection_Id" }, { "title": "defaultWorkOrderStaffMemberId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmType->DefaultWorkOrderStaffMember_Id" }, { "title": "defaultWorkOrderTradeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmType->DefaultWorkOrderTrade_Id" }, { "title": "defaultWorkOrderTypeOfWorkId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "AlarmType->DefaultWorkOrderTypeOfWork_Id" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "AlarmType->Notes" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "AlarmType->SequenceNumber" } ] } } }, "DeleteAlarmTypeResourceActionRequest": { "title": "DeleteAlarmTypeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetAlarmTypesResourceAction": { "title": "BatchGetAlarmTypesResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Alarm Type entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Alarm Type entities", "items": { "$ref": "#/components/schemas/GetAlarmTypeResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateAlarmTypeRequest": { "title": "BatchCreateAlarmTypeRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateAlarmTypeResourceActionRequest" } }, "BatchUpdateAlarmTypeResourceActionRequest": { "title": "BatchUpdateAlarmTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateAlarmTypeResourceActionRequest" } }, "BatchDeleteAlarmTypeResourceActionRequest": { "title": "BatchDeleteAlarmTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteAlarmTypeResourceActionRequest" } }, "ChangeAlarmTypeIsActiveResourceActionRequest": { "title": "ChangeAlarmTypeIsActiveResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "AlarmType->IsActive" } ] } } }, "ChangeAlarmTypePermissionTreeResourceActionRequest": { "title": "ChangeAlarmTypePermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "AlarmType->PermissionTree_Id" } ] } } }, "BatchChangeAlarmTypeIsActiveResourceActionRequest": { "title": "BatchChangeAlarmTypeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeAlarmTypeIsActiveResourceActionRequest" } }, "BatchChangeAlarmTypePermissionTreeResourceActionRequest": { "title": "BatchChangeAlarmTypePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeAlarmTypePermissionTreeResourceActionRequest" } }, "GetMonitoringPointResourceActionResponse": { "title": "GetMonitoringPointResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetMonitoringPointResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPoint->Code" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPoint->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPoint->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPoint->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPoint->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPoint->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPoint->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPoint->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPoint->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPoint->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPoint->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPoint->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPoint->PermissionTree_Description" }, "alarmCancellation": { "title": "alarmCancellation", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "MonitoringPoint->AlarmCancellation", "x-formatSpecifier": "AlarmCancellation" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPoint->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPoint->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPoint->Asset_Description" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPoint->Description" }, "isCalculated": { "title": "isCalculated", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPoint->IsCalculated" }, "lowerCriticalAlarmTypeId": { "title": "lowerCriticalAlarmTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPoint->LowerCriticalAlarmType_Id" }, "lowerCriticalAlarmTypeDescription": { "title": "lowerCriticalAlarmTypeDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPoint->LowerCriticalAlarmType_Description" }, "lowerCriticalAlarmTypeCode": { "title": "lowerCriticalAlarmTypeCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPoint->LowerCriticalAlarmType_Code" }, "lowerCriticalBound": { "title": "lowerCriticalBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPoint->LowerCriticalBound" }, "lowerCriticalSuppressesLowerWarning": { "title": "lowerCriticalSuppressesLowerWarning", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPoint->LowerCriticalSuppressesLowerWarning" }, "lowerWarningAlarmTypeId": { "title": "lowerWarningAlarmTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPoint->LowerWarningAlarmType_Id" }, "lowerWarningAlarmTypeDescription": { "title": "lowerWarningAlarmTypeDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPoint->LowerWarningAlarmType_Description" }, "lowerWarningAlarmTypeCode": { "title": "lowerWarningAlarmTypeCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPoint->LowerWarningAlarmType_Code" }, "lowerWarningBound": { "title": "lowerWarningBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPoint->LowerWarningBound" }, "monitoringPointTypeId": { "title": "monitoringPointTypeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPoint->MonitoringPointType_Id" }, "monitoringPointTypeCode": { "title": "monitoringPointTypeCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPoint->MonitoringPointType_Code" }, "monitoringPointTypeDescription": { "title": "monitoringPointTypeDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPoint->MonitoringPointType_Description" }, "monitoringPointTypeHasLowerCriticalBound": { "title": "monitoringPointTypeHasLowerCriticalBound", "type": "boolean", "nullable": true, "x-propertyPath": "MonitoringPoint->MonitoringPointType_HasLowerCriticalBound" }, "monitoringPointTypeHasLowerWarningBound": { "title": "monitoringPointTypeHasLowerWarningBound", "type": "boolean", "nullable": true, "x-propertyPath": "MonitoringPoint->MonitoringPointType_HasLowerWarningBound" }, "monitoringPointTypeHasUpperCriticalBound": { "title": "monitoringPointTypeHasUpperCriticalBound", "type": "boolean", "nullable": true, "x-propertyPath": "MonitoringPoint->MonitoringPointType_HasUpperCriticalBound" }, "monitoringPointTypeHasUpperWarningBound": { "title": "monitoringPointTypeHasUpperWarningBound", "type": "boolean", "nullable": true, "x-propertyPath": "MonitoringPoint->MonitoringPointType_HasUpperWarningBound" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPoint->Notes" }, "readingFormula": { "title": "readingFormula", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPoint->ReadingFormula", "x-NullExpression": "MonitoringPoint->IsCalculated eq FALSE" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPoint->SequenceNumber" }, "serialNumber": { "title": "serialNumber", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPoint->SerialNumber" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPoint->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPoint->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPoint->UnitOfMeasurement_Description" }, "upperCriticalAlarmTypeId": { "title": "upperCriticalAlarmTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPoint->UpperCriticalAlarmType_Id" }, "upperCriticalAlarmTypeDescription": { "title": "upperCriticalAlarmTypeDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPoint->UpperCriticalAlarmType_Description" }, "upperCriticalAlarmTypeCode": { "title": "upperCriticalAlarmTypeCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPoint->UpperCriticalAlarmType_Code" }, "upperCriticalBound": { "title": "upperCriticalBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPoint->UpperCriticalBound" }, "upperCriticalSuppressesUpperWarning": { "title": "upperCriticalSuppressesUpperWarning", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPoint->UpperCriticalSuppressesUpperWarning" }, "upperWarningAlarmTypeId": { "title": "upperWarningAlarmTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPoint->UpperWarningAlarmType_Id" }, "upperWarningAlarmTypeDescription": { "title": "upperWarningAlarmTypeDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPoint->UpperWarningAlarmType_Description" }, "upperWarningAlarmTypeCode": { "title": "upperWarningAlarmTypeCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPoint->UpperWarningAlarmType_Code" }, "upperWarningBound": { "title": "upperWarningBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPoint->UpperWarningBound" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetMonitoringPointCollectionResourceActionResponse": { "title": "GetMonitoringPointCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMonitoringPointCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMonitoringPointCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPoint->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPoint->Description" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPoint->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPoint->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPoint->UnitOfMeasurement_Description" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPoint->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPoint->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPoint->Asset_Description" }, "monitoringPointTypeId": { "title": "monitoringPointTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPoint->MonitoringPointType_Id" }, "monitoringPointTypeCode": { "title": "monitoringPointTypeCode", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPoint->MonitoringPointType_Code" }, "monitoringPointTypeDescription": { "title": "monitoringPointTypeDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPoint->MonitoringPointType_Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPoint->Notes" }, "isCalculated": { "title": "isCalculated", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPoint->IsCalculated" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPoint->SequenceNumber" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPoint->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPoint->ModifiedOn" }, "upperCriticalBound": { "title": "upperCriticalBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPoint->UpperCriticalBound" }, "upperWarningBound": { "title": "upperWarningBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPoint->UpperWarningBound" }, "lowerWarningBound": { "title": "lowerWarningBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPoint->LowerWarningBound" }, "lowerCriticalBound": { "title": "lowerCriticalBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPoint->LowerCriticalBound" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointAssetLookupResourceActionResponse": { "title": "MonitoringPointAssetLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointAssetLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "RegularAsset->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "RegularAsset->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointChangePermissionTreeLookupResourceActionResponse": { "title": "MonitoringPointChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointInsertPermissionTreeLookupResourceActionResponse": { "title": "MonitoringPointInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointLowerCriticalAlarmTypeLookupResourceActionResponse": { "title": "MonitoringPointLowerCriticalAlarmTypeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointLowerCriticalAlarmTypeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointLowerCriticalAlarmTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "AlarmType->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "AlarmType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointLowerWarningAlarmTypeLookupResourceActionResponse": { "title": "MonitoringPointLowerWarningAlarmTypeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointLowerWarningAlarmTypeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointLowerWarningAlarmTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "AlarmType->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "AlarmType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointMonitoringPointTypeLookupResourceActionResponse": { "title": "MonitoringPointMonitoringPointTypeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointMonitoringPointTypeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointMonitoringPointTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointType->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointType->Description" }, "lowerCriticalBound": { "title": "lowerCriticalBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPointType->LowerCriticalBound" }, "lowerWarningBound": { "title": "lowerWarningBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPointType->LowerWarningBound" }, "upperCriticalBound": { "title": "upperCriticalBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPointType->UpperCriticalBound" }, "upperWarningBound": { "title": "upperWarningBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPointType->UpperWarningBound" }, "hasLowerCriticalBound": { "title": "hasLowerCriticalBound", "type": "boolean", "nullable": true, "x-propertyPath": "MonitoringPointType->HasLowerCriticalBound" }, "hasLowerWarningBound": { "title": "hasLowerWarningBound", "type": "boolean", "nullable": true, "x-propertyPath": "MonitoringPointType->HasLowerWarningBound" }, "hasUpperCriticalBound": { "title": "hasUpperCriticalBound", "type": "boolean", "nullable": true, "x-propertyPath": "MonitoringPointType->HasUpperCriticalBound" }, "hasUpperWarningBound": { "title": "hasUpperWarningBound", "type": "boolean", "nullable": true, "x-propertyPath": "MonitoringPointType->HasUpperWarningBound" }, "alarmCancellation": { "title": "alarmCancellation", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "MonitoringPointType->AlarmCancellation", "x-formatSpecifier": "AlarmCancellation" }, "upperCriticalSuppressesUpperWarning": { "title": "upperCriticalSuppressesUpperWarning", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPointType->UpperCriticalSuppressesUpperWarning" }, "lowerCriticalSuppressesLowerWarning": { "title": "lowerCriticalSuppressesLowerWarning", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPointType->LowerCriticalSuppressesLowerWarning" }, "upperCriticalAlarmTypeId": { "title": "upperCriticalAlarmTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointType->UpperCriticalAlarmType_Id" }, "upperCriticalAlarmTypeCode": { "title": "upperCriticalAlarmTypeCode", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointType->UpperCriticalAlarmType_Code" }, "upperCriticalAlarmTypeDescription": { "title": "upperCriticalAlarmTypeDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointType->UpperCriticalAlarmType_Description" }, "upperWarningAlarmTypeId": { "title": "upperWarningAlarmTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointType->UpperWarningAlarmType_Id" }, "upperWarningAlarmTypeCode": { "title": "upperWarningAlarmTypeCode", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointType->UpperWarningAlarmType_Code" }, "upperWarningAlarmTypeDescription": { "title": "upperWarningAlarmTypeDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointType->UpperWarningAlarmType_Description" }, "lowerWarningAlarmTypeId": { "title": "lowerWarningAlarmTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointType->LowerWarningAlarmType_Id" }, "lowerWarningAlarmTypeCode": { "title": "lowerWarningAlarmTypeCode", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointType->LowerWarningAlarmType_Code" }, "lowerWarningAlarmTypeDescription": { "title": "lowerWarningAlarmTypeDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointType->LowerWarningAlarmType_Description" }, "lowerCriticalAlarmTypeId": { "title": "lowerCriticalAlarmTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointType->LowerCriticalAlarmType_Id" }, "lowerCriticalAlarmTypeCode": { "title": "lowerCriticalAlarmTypeCode", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointType->LowerCriticalAlarmType_Code" }, "lowerCriticalAlarmTypeDescription": { "title": "lowerCriticalAlarmTypeDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointType->LowerCriticalAlarmType_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointUnitOfMeasurementLookupResourceActionResponse": { "title": "MonitoringPointUnitOfMeasurementLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointUnitOfMeasurementLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointUnitOfMeasurementLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "UnitOfMeasurement->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "UnitOfMeasurement->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointUpperCriticalAlarmTypeLookupResourceActionResponse": { "title": "MonitoringPointUpperCriticalAlarmTypeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointUpperCriticalAlarmTypeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointUpperCriticalAlarmTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "AlarmType->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "AlarmType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointUpperWarningAlarmTypeLookupResourceActionResponse": { "title": "MonitoringPointUpperWarningAlarmTypeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointUpperWarningAlarmTypeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointUpperWarningAlarmTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "AlarmType->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "AlarmType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateMonitoringPointResourceActionRequest": { "title": "CreateMonitoringPointResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateMonitoringPointResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "permissionTreeId", "monitoringPointTypeId" ], "properties": { "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "MonitoringPoint->Code", "x-systemGenerated": true }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "nullable": false, "x-propertyPath": "MonitoringPoint->Description", "x-systemGenerated": true }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPoint->PermissionTree_Id" }, "serialNumber": { "title": "serialNumber", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPoint->SerialNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPoint->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPoint->SequenceNumber" }, "alarmCancellation": { "title": "alarmCancellation", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "MonitoringPoint->AlarmCancellation", "x-formatSpecifier": "AlarmCancellation" }, "upperCriticalSuppressesUpperWarning": { "title": "upperCriticalSuppressesUpperWarning", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPoint->UpperCriticalSuppressesUpperWarning" }, "lowerCriticalSuppressesLowerWarning": { "title": "lowerCriticalSuppressesLowerWarning", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPoint->LowerCriticalSuppressesLowerWarning" }, "upperCriticalBound": { "title": "upperCriticalBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPoint->UpperCriticalBound" }, "upperWarningBound": { "title": "upperWarningBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPoint->UpperWarningBound" }, "lowerCriticalBound": { "title": "lowerCriticalBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPoint->LowerCriticalBound" }, "lowerWarningBound": { "title": "lowerWarningBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPoint->LowerWarningBound" }, "isCalculated": { "title": "isCalculated", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPoint->IsCalculated" }, "readingFormula": { "title": "readingFormula", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPoint->ReadingFormula", "x-NullExpression": "MonitoringPoint->IsCalculated eq FALSE" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPoint->Asset_Id" }, "monitoringPointTypeId": { "title": "monitoringPointTypeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPoint->MonitoringPointType_Id" }, "upperCriticalAlarmTypeId": { "title": "upperCriticalAlarmTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPoint->UpperCriticalAlarmType_Id" }, "upperWarningAlarmTypeId": { "title": "upperWarningAlarmTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPoint->UpperWarningAlarmType_Id" }, "lowerWarningAlarmTypeId": { "title": "lowerWarningAlarmTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPoint->LowerWarningAlarmType_Id" }, "lowerCriticalAlarmTypeId": { "title": "lowerCriticalAlarmTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPoint->LowerCriticalAlarmType_Id" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPoint->UnitOfMeasurement_Id", "x-systemGenerated": true } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateMonitoringPointResourceActionRequest": { "title": "UpdateMonitoringPointResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "MonitoringPoint->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "nullable": false, "x-propertyPath": "MonitoringPoint->Description" }, { "title": "serialNumber", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPoint->SerialNumber" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPoint->Notes" }, { "title": "isCalculated", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPoint->IsCalculated" }, { "title": "readingFormula", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPoint->ReadingFormula", "x-NullExpression": "MonitoringPoint->IsCalculated eq FALSE" }, { "title": "serialNumber", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPoint->SerialNumber" }, { "title": "alarmCancellation", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "MonitoringPoint->AlarmCancellation", "x-formatSpecifier": "AlarmCancellation" }, { "title": "upperCriticalSuppressesUpperWarning", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPoint->UpperCriticalSuppressesUpperWarning" }, { "title": "lowerCriticalSuppressesLowerWarning", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPoint->LowerCriticalSuppressesLowerWarning" }, { "title": "upperCriticalBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPoint->UpperCriticalBound" }, { "title": "upperWarningBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPoint->UpperWarningBound" }, { "title": "lowerCriticalBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPoint->LowerCriticalBound" }, { "title": "lowerWarningBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPoint->LowerWarningBound" }, { "title": "assetId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPoint->Asset_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPoint->SequenceNumber" }, { "title": "monitoringPointTypeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPoint->MonitoringPointType_Id" }, { "title": "upperCriticalAlarmTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPoint->UpperCriticalAlarmType_Id" }, { "title": "upperWarningAlarmTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPoint->UpperWarningAlarmType_Id" }, { "title": "lowerWarningAlarmTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPoint->LowerWarningAlarmType_Id" }, { "title": "lowerCriticalAlarmTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPoint->LowerCriticalAlarmType_Id" }, { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPoint->UnitOfMeasurement_Id" } ] } } }, "DeleteMonitoringPointResourceActionRequest": { "title": "DeleteMonitoringPointResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetMonitoringPointResourceAction": { "title": "BatchGetMonitoringPointResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Monitoring Point entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Monitoring Point entities", "items": { "$ref": "#/components/schemas/GetMonitoringPointResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateMonitoringPointResourceActionRequest": { "title": "BatchCreateMonitoringPointResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateMonitoringPointResourceActionRequest" } }, "BatchUpdateMonitoringPointResourceActionRequest": { "title": "BatchUpdateMonitoringPointResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateMonitoringPointResourceActionRequest" } }, "BatchDeleteMonitoringPointResourceActionRequest": { "title": "BatchDeleteMonitoringPointResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteMonitoringPointResourceActionRequest" } }, "ChangeMonitoringPointIsActiveResourceActionRequest": { "title": "ChangeMonitoringPointIsActiveResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPoint->IsActive" } ] } } }, "ChangeMonitoringPointPermissionTreeResourceActionRequest": { "title": "ChangeMonitoringPointPermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPoint->PermissionTree_Id" } ] } } }, "BatchChangeMonitoringPointIsActiveResourceActionRequest": { "title": "BatchChangeMonitoringPointIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeMonitoringPointIsActiveResourceActionRequest" } }, "BatchChangeMonitoringPointPermissionTreeResourceActionRequest": { "title": "BatchChangeMonitoringPointPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeMonitoringPointPermissionTreeResourceActionRequest" } }, "GetMonitoringPointAttributeResourceActionResponse": { "title": "GetMonitoringPointAttributeResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetMonitoringPointAttributeResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "monitoringPointId": { "title": "monitoringPointId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointAttribute->MonitoringPoint_Id" }, "monitoringPointCode": { "title": "monitoringPointCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->MonitoringPoint_Code" }, "monitoringPointDescription": { "title": "monitoringPointDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->MonitoringPoint_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "MonitoringPointAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "MonitoringPointAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "MonitoringPointAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "MonitoringPointAttribute->Value", "x-formatSpecifier": "DynamicValue" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetMonitoringPointAttributeCollectionForMonitoringPointResourceActionResponse": { "title": "GetMonitoringPointAttributeCollectionForMonitoringPointResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMonitoringPointAttributeCollectionForMonitoringPointResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMonitoringPointAttributeCollectionForMonitoringPointResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "MonitoringPointAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "MonitoringPointAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "MonitoringPointAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointAttribute->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetMonitoringPointAttributeCollectionResourceActionResponse": { "title": "GetMonitoringPointAttributeCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMonitoringPointAttributeCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMonitoringPointAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "monitoringPointId": { "title": "monitoringPointId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->MonitoringPoint_Id" }, "monitoringPointCode": { "title": "monitoringPointCode", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointAttribute->MonitoringPoint_Code" }, "monitoringPointDescription": { "title": "monitoringPointDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointAttribute->MonitoringPoint_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "MonitoringPointAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "MonitoringPointAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "MonitoringPointAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointAttribute->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "MonitoringPointAttributeAttributeAllowedValueLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointAttributeAttributeAllowedValueLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "nullable": true, "x-propertyPath": "AttributeAllowedValue->Description" }, "value": { "title": "value", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "AttributeAllowedValue->Value", "x-formatSpecifier": "DynamicValue" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointAttributeAttributeLookupResourceActionResponse": { "title": "MonitoringPointAttributeAttributeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointAttributeAttributeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointAttributeAttributeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "Attribute->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "Attribute->Description" }, "allowAnyValue": { "title": "allowAnyValue", "type": "boolean", "nullable": false, "x-propertyPath": "Attribute->AllowAnyValue" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "Attribute->DataType", "x-formatSpecifier": "DynamicValueType" }, "defaultValue": { "title": "defaultValue", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultValue", "x-formatSpecifier": "DynamicValue", "x-NullExpression": "Attribute->AllowAnyValue eq false" }, "defaultAllowedValueId": { "title": "defaultAllowedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Id" }, "defaultAllowedValueValue": { "title": "defaultAllowedValueValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "defaultAllowedValueDescription": { "title": "defaultAllowedValueDescription", "type": "string", "nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Description" }, "explanation": { "title": "explanation", "type": "string", "nullable": true, "x-propertyPath": "Attribute->Explanation" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointAttributeChangePermissionTreeLookupResourceActionResponse": { "title": "MonitoringPointAttributeChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointAttributeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointAttributeChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "MonitoringPointAttributeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointAttributeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointAttributeMonitoringPointLookupResourceActionResponse": { "title": "MonitoringPointAttributeMonitoringPointLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointAttributeMonitoringPointLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointAttributeMonitoringPointLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPoint->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPoint->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateMonitoringPointAttributeResourceActionRequest": { "title": "CreateMonitoringPointAttributeResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateMonitoringPointAttributeResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "monitoringPointId", "attributeId" ], "properties": { "monitoringPointId": { "title": "monitoringPointId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointAttribute->MonitoringPoint_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "nullable": true, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "MonitoringPointAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateMonitoringPointAttributeResourceActionRequest": { "title": "UpdateMonitoringPointAttributeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "value", "format": "composite", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointAttribute->Notes" } ] } } }, "DeleteMonitoringPointAttributeResourceActionRequest": { "title": "DeleteMonitoringPointAttributeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetMonitoringPointAttributeResourceAction": { "title": "BatchGetMonitoringPointAttributeResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Monitoring Point Attribute entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Monitoring Point Attribute entities", "items": { "$ref": "#/components/schemas/GetMonitoringPointAttributeResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateMonitoringPointAttributeResourceActionRequest": { "title": "BatchCreateMonitoringPointAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateMonitoringPointAttributeResourceActionRequest" } }, "BatchUpdateMonitoringPointAttributeResourceActionRequest": { "title": "BatchUpdateMonitoringPointAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateMonitoringPointAttributeResourceActionRequest" } }, "BatchDeleteMonitoringPointAttributeResourceActionRequest": { "title": "BatchDeleteMonitoringPointAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteMonitoringPointAttributeResourceActionRequest" } }, "ChangeMonitoringPointAttributeIsActiveResourceActionRequest": { "title": "ChangeMonitoringPointAttributeIsActiveResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPointAttribute->IsActive" } ] } } }, "ChangeMonitoringPointAttributePermissionTreeResourceActionRequest": { "title": "ChangeMonitoringPointAttributePermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointAttribute->PermissionTree_Id" } ] } } }, "BatchChangeMonitoringPointAttributePermissionTreeResourceActionRequest": { "title": "BatchChangeMonitoringPointAttributePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeMonitoringPointAttributePermissionTreeResourceActionRequest" } }, "BatchChangeMonitoringPointAttributeIsActiveResourceActionRequest": { "title": "BatchChangeMonitoringPointAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeMonitoringPointAttributeIsActiveResourceActionRequest" } }, "GetMonitoringPointTriggerExpressionEvaluationCollectionResourceActionResponse": { "title": "GetMonitoringPointTriggerExpressionEvaluationCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMonitoringPointTriggerExpressionEvaluationCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMonitoringPointTriggerExpressionEvaluationCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "monitoringPointId": { "title": "monitoringPointId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointBoundEvaluationLog->MonitoringPoint_Id" }, "monitoringPointCode": { "title": "monitoringPointCode", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointBoundEvaluationLog->MonitoringPoint_Code" }, "monitoringPointDescription": { "title": "monitoringPointDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointBoundEvaluationLog->MonitoringPoint_Description" }, "executedOn": { "title": "executedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointBoundEvaluationLog->ExecutedOn" }, "processStatus": { "title": "processStatus", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MonitoringPointBoundEvaluationLog->ProcessStatus", "x-formatSpecifier": "MonitoringPointBoundExecutionContextProcessStatus" }, "executionStatus": { "title": "executionStatus", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MonitoringPointBoundEvaluationLog->ExecutionStatus", "x-formatSpecifier": "MonitoringPointBoundExecutionContextExecutionStatus" }, "executionType": { "title": "executionType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MonitoringPointBoundEvaluationLog->ExecutionType", "x-formatSpecifier": "MonitoringPointBoundExecutionType" }, "warningTriggered": { "title": "warningTriggered", "type": "boolean", "nullable": true, "x-propertyPath": "MonitoringPointBoundEvaluationLog->WarningTriggered" }, "criticalTriggered": { "title": "criticalTriggered", "type": "boolean", "nullable": true, "x-propertyPath": "MonitoringPointBoundEvaluationLog->CriticalTriggered" }, "alarmsGenerated": { "title": "alarmsGenerated", "type": "array", "format": "array", "nullable": true, "items": { "type": "integer" }, "x-propertyPath": "MonitoringPointBoundEvaluationLog->AlarmsGenerated", "x-formatSpecifier": "Int64" }, "notification": { "title": "notification", "nullable": true, "$ref": "#/components/schemas/NotificationSchema", "x-propertyPath": "MonitoringPointBoundEvaluationLog->Notification" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetMonitoringPointTriggerExpressionEvaluationFailuresCollectionResourceActionResponse": { "title": "GetMonitoringPointTriggerExpressionEvaluationFailuresCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMonitoringPointTriggerExpressionEvaluationFailuresCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMonitoringPointTriggerExpressionEvaluationFailuresCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "monitoringPointId": { "title": "monitoringPointId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointBoundEvaluationLog->MonitoringPoint_Id" }, "monitoringPointCode": { "title": "monitoringPointCode", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointBoundEvaluationLog->MonitoringPoint_Code" }, "monitoringPointDescription": { "title": "monitoringPointDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointBoundEvaluationLog->MonitoringPoint_Description" }, "executedOn": { "title": "executedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointBoundEvaluationLog->ExecutedOn" }, "processStatus": { "title": "processStatus", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MonitoringPointBoundEvaluationLog->ProcessStatus", "x-formatSpecifier": "MonitoringPointBoundExecutionContextProcessStatus" }, "executionStatus": { "title": "executionStatus", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MonitoringPointBoundEvaluationLog->ExecutionStatus", "x-formatSpecifier": "MonitoringPointBoundExecutionContextExecutionStatus" }, "notification": { "title": "notification", "nullable": true, "$ref": "#/components/schemas/NotificationSchema", "x-propertyPath": "MonitoringPointBoundEvaluationLog->Notification" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "ResubmitMonitoringPointTriggerExpressionEvaluationResourceActionRequest": { "title": "ResubmitMonitoringPointTriggerExpressionEvaluationResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "ResubmitMonitoringPointTriggerExpressionEvaluationResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "evaluationIds" ], "properties": { "evaluationIds": { "title": "evaluationIds", "type": "array", "format": "array", "nullable": false, "items": { "type": "integer" }, "x-propertyPath": "ResubmitEvaluation->EvaluationIds", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "GetMonitoringPointDocumentResourceActionResponse": { "title": "GetMonitoringPointDocumentResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetMonitoringPointDocumentResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "monitoringPointId": { "title": "monitoringPointId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointDocument->MonitoringPoint_Id" }, "monitoringPointCode": { "title": "monitoringPointCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointDocument->MonitoringPoint_Code" }, "monitoringPointDescription": { "title": "monitoringPointDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointDocument->MonitoringPoint_Description" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": true, "x-propertyPath": "MonitoringPointDocument->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointDocument->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointDocument->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointDocument->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointDocument->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointDocument->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointDocument->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointDocument->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointDocument->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointDocument->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointDocument->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointDocument->PermissionTree_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointDocument->DocumentRecord_FileLocation" }, "documentRecordFileInfoId": { "title": "documentRecordFileInfoId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointDocument->DocumentRecord_FileInfoId" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointDocument->DocumentRecord_FileFullName" }, "documentRecordContentId": { "title": "documentRecordContentId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointDocument->DocumentRecord_Content_Id" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPointDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeId": { "title": "documentRecordFileTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointDocument->DocumentRecord_FileType_Id" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointDocument->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointDocument->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetMonitoringPointDocumentCollectionForMonitoringPointResourceActionResponse": { "title": "GetMonitoringPointDocumentCollectionForMonitoringPointResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMonitoringPointDocumentCollectionForMonitoringPointResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMonitoringPointDocumentCollectionForMonitoringPointResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPointDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointDocument->DocumentRecord_FileType_Extension" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetMonitoringPointDocumentCollectionResourceActionResponse": { "title": "GetMonitoringPointDocumentCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMonitoringPointDocumentCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMonitoringPointDocumentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "monitoringPointId": { "title": "monitoringPointId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointDocument->MonitoringPoint_Id" }, "monitoringPointCode": { "title": "monitoringPointCode", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointDocument->MonitoringPoint_Code" }, "monitoringPointDescription": { "title": "monitoringPointDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointDocument->MonitoringPoint_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPointDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointDocument->DocumentRecord_FileType_Extension" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointDocumentChangePermissionTreeLookupResourceActionResponse": { "title": "MonitoringPointDocumentChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointDocumentChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointDocumentChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointDocumentDocumentLookupResourceActionResponse": { "title": "MonitoringPointDocumentDocumentLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointDocumentDocumentLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointDocumentDocumentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "DocumentRecord->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "DocumentRecord->Description" }, "fileLocation": { "title": "fileLocation", "type": "string", "nullable": true, "x-propertyPath": "DocumentRecord->FileLocation" }, "fileFullName": { "title": "fileFullName", "type": "string", "nullable": true, "x-propertyPath": "DocumentRecord->FileFullName" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointDocumentInsertPermissionTreeLookupResourceActionResponse": { "title": "MonitoringPointDocumentInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointDocumentInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointDocumentInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointDocumentMonitoringPointLookupResourceActionResponse": { "title": "MonitoringPointDocumentMonitoringPointLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointDocumentMonitoringPointLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointDocumentMonitoringPointLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPoint->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPoint->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateMonitoringPointDocumentResourceActionRequest": { "title": "CreateMonitoringPointDocumentResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateMonitoringPointDocumentResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "monitoringPointId", "documentRecordId" ], "properties": { "monitoringPointId": { "title": "monitoringPointId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointDocument->MonitoringPoint_Id" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointDocument->DocumentRecord_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointDocument->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointDocument->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointDocument->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateMonitoringPointDocumentResourceActionRequest": { "title": "UpdateMonitoringPointDocumentResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointDocument->SequenceNumber" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointDocument->Notes" } ] } } }, "DeleteMonitoringPointDocumentResourceActionRequest": { "title": "DeleteMonitoringPointDocumentResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetMonitoringPointDocumentResourceAction": { "title": "BatchGetMonitoringPointDocumentResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Monitoring Point Document entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Monitoring Point Document entities", "items": { "$ref": "#/components/schemas/GetMonitoringPointDocumentResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateMonitoringPointDocumentResourceActionRequest": { "title": "BatchCreateMonitoringPointDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateMonitoringPointDocumentResourceActionRequest" } }, "BatchUpdateMonitoringPointDocumentResourceActionRequest": { "title": "BatchUpdateMonitoringPointDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateMonitoringPointDocumentResourceActionRequest" } }, "BatchDeleteMonitoringPointDocumentResourceActionRequest": { "title": "BatchDeleteMonitoringPointDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteMonitoringPointDocumentResourceActionRequest" } }, "ChangeMonitoringPointDocumentIsActiveResourceActionRequest": { "title": "ChangeMonitoringPointDocumentIsActiveResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPointDocument->IsActive" } ] } } }, "ChangeMonitoringPointDocumentPermissionTreeResourceActionRequest": { "title": "ChangeMonitoringPointDocumentPermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointDocument->PermissionTree_Id" } ] } } }, "BatchChangeMonitoringPointDocumentPermissionTreeResourceActionRequest": { "title": "BatchChangeMonitoringPointDocumentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeMonitoringPointDocumentPermissionTreeResourceActionRequest" } }, "BatchChangeMonitoringPointDocumentIsActiveResourceActionRequest": { "title": "BatchChangeMonitoringPointDocumentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeMonitoringPointDocumentIsActiveResourceActionRequest" } }, "GetMonitoringPointParameterResourceActionResponse": { "title": "GetMonitoringPointParameterResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetMonitoringPointParameterResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "nullable": true, "x-propertyPath": "MonitoringPointParameter->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointParameter->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointParameter->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointParameter->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointParameter->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointParameter->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointParameter->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointParameter->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointParameter->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointParameter->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointParameter->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointParameter->PermissionTree_Description" }, "monitoringPointId": { "title": "monitoringPointId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointParameter->MonitoringPoint_Id" }, "monitoringPointCode": { "title": "monitoringPointCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointParameter->MonitoringPoint_Code" }, "monitoringPointDescription": { "title": "monitoringPointDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointParameter->MonitoringPoint_Description" }, "parameterName": { "title": "parameterName", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointParameter->ParameterName" }, "parameterValue": { "title": "parameterValue", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointParameter->ParameterValue" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetMonitoringPointParameterCollectionResourceActionResponse": { "title": "GetMonitoringPointParameterCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMonitoringPointParameterCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMonitoringPointParameterCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "parameterName": { "title": "parameterName", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointParameter->ParameterName" }, "parameterValue": { "title": "parameterValue", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointParameter->ParameterValue" }, "monitoringPointId": { "title": "monitoringPointId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointParameter->MonitoringPoint_Id" }, "monitoringPointCode": { "title": "monitoringPointCode", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointParameter->MonitoringPoint_Code" }, "monitoringPointDescription": { "title": "monitoringPointDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointParameter->MonitoringPoint_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointParameter->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointParameter->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetMonitoringPointParameterForMonitoringPointCollectionResourceActionResponse": { "title": "GetMonitoringPointParameterForMonitoringPointCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMonitoringPointParameterForMonitoringPointCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMonitoringPointParameterForMonitoringPointCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "parameterName": { "title": "parameterName", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointParameter->ParameterName" }, "parameterValue": { "title": "parameterValue", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointParameter->ParameterValue" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointParameter->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointParameter->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointParameterChangePermissionTreeLookupResourceActionResponse": { "title": "MonitoringPointParameterChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointParameterChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointParameterChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointParameterInsertPermissionTreeLookupResourceActionResponse": { "title": "MonitoringPointParameterInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointParameterInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointParameterInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointParameterMonitoringPointLookupResourceActionResponse": { "title": "MonitoringPointParameterMonitoringPointLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointParameterMonitoringPointLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointParameterMonitoringPointLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPoint->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPoint->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateMonitoringPointParameterResourceActionRequest": { "title": "CreateMonitoringPointParameterResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateMonitoringPointParameterResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "parameterName", "parameterValue", "monitoringPointId" ], "properties": { "parameterName": { "title": "parameterName", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "MonitoringPointParameter->ParameterName" }, "parameterValue": { "title": "parameterValue", "type": "string", "maxLength": 100, "minLength": 1, "nullable": false, "x-propertyPath": "MonitoringPointParameter->ParameterValue" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointParameter->PermissionTree_Id", "x-systemGenerated": true }, "monitoringPointId": { "title": "monitoringPointId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointParameter->MonitoringPoint_Id" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateMonitoringPointParameterResourceActionRequest": { "title": "UpdateMonitoringPointParameterResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "parameterName", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "MonitoringPointParameter->ParameterName" }, { "title": "parameterValue", "type": "string", "maxLength": 100, "minLength": 1, "nullable": false, "x-propertyPath": "MonitoringPointParameter->ParameterValue" } ] } } }, "DeleteMonitoringPointParameterResourceActionRequest": { "title": "DeleteMonitoringPointParameterResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetMonitoringPointParameterResourceAction": { "title": "BatchGetMonitoringPointParameterResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Monitoring Point Parameter entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Monitoring Point Parameter entities", "items": { "$ref": "#/components/schemas/GetMonitoringPointParameterResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateMonitoringPointParameterResourceActionRequest": { "title": "BatchCreateMonitoringPointParameterResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateMonitoringPointParameterResourceActionRequest" } }, "BatchUpdateMonitoringPointParameterResourceActionRequest": { "title": "BatchUpdateMonitoringPointParameterResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateMonitoringPointParameterResourceActionRequest" } }, "BatchDeleteMonitoringPointParameterResourceActionRequest": { "title": "BatchDeleteMonitoringPointParameterResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteMonitoringPointParameterResourceActionRequest" } }, "ChangeMonitoringPointParameterIsActiveResourceActionRequest": { "title": "ChangeMonitoringPointParameterIsActiveResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPointParameter->IsActive" } ] } } }, "ChangeMonitoringPointParameterPermissionTreeResourceActionRequest": { "title": "ChangeMonitoringPointParameterPermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointParameter->PermissionTree_Id" } ] } } }, "BatchChangeMonitoringPointParameterIsActiveResourceActionRequest": { "title": "BatchChangeMonitoringPointParameterIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeMonitoringPointParameterIsActiveResourceActionRequest" } }, "BatchChangeMonitoringPointParameterPermissionTreeResourceActionRequest": { "title": "BatchChangeMonitoringPointParameterPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeMonitoringPointParameterPermissionTreeResourceActionRequest" } }, "GeoJsonObject": { "type": "object", "discriminator": { "propertyName": "type" }, "additionalProperties": false, "required": [ "type" ], "properties": { "type": { "title": "type", "type": "string", "format": "enum", "nullable": false, "x-formatSpecifier": "GeoJsonObjectType", "x-enumNames": [ "Point", "MultiPoint", "LineString", "MultiLineString", "Polygon", "MultiPolygon", "GeometryCollection", "Feature", "FeatureCollection" ] }, "bbox": { "title": "bbox", "type": "array", "additionalProperties": false, "items": { "type": "number" } } }, "externalDocs": { "url": "https://tools.ietf.org/html/rfc7946#section-3" } }, "Feature": { "allOf": [ { "$ref": "#/components/schemas/GeoJsonObject" }, { "type": "object", "additionalProperties": false, "required": [ "geometry", "properties" ], "properties": { "geometry": { "additionalProperties": false, "allOf": [ { "nullable": true, "additionalProperties": false }, { "$ref": "#/components/schemas/Geometry" } ] }, "properties": { "type": "object", "nullable": true, "additionalProperties": false }, "id": { "additionalProperties": false, "oneOf": [ { "type": "number" }, { "type": "string" } ] } } } ], "externalDocs": { "url": "https://tools.ietf.org/html/rfc7946#section-3.2" } }, "FeatureCollection": { "allOf": [ { "$ref": "#/components/schemas/GeoJsonObject" }, { "type": "object", "additionalProperties": false, "required": [ "features" ], "properties": { "features": { "type": "array", "items": { "$ref": "#/components/schemas/Feature" } } } } ], "externalDocs": { "url": "https://tools.ietf.org/html/rfc7946#section-3.3" } }, "LinearRing": { "type": "array", "minItems": 4, "additionalProperties": false, "items": { "$ref": "#/components/schemas/Position" }, "externalDocs": { "url": "https://tools.ietf.org/html/rfc7946#section-3.1.6" } }, "LineStringCoordinates": { "type": "array", "minItems": 2, "additionalProperties": false, "items": { "$ref": "#/components/schemas/Position" }, "externalDocs": { "url": "https://tools.ietf.org/html/rfc7946#section-3.1.4" } }, "Position": { "type": "array", "maxItems": 3, "minItems": 2, "additionalProperties": false, "items": { "type": "number" }, "externalDocs": { "url": "https://tools.ietf.org/html/rfc7946#section-3.1.1" } }, "GeometryElement": { "allOf": [ { "$ref": "#/components/schemas/Geometry" }, { "type": "object", "discriminator": { "propertyName": "type" }, "additionalProperties": false, "required": [ "type" ], "properties": { "type": { "title": "type", "type": "string", "format": "enum", "nullable": false, "x-formatSpecifier": "GeometryElementType", "x-enumNames": [ "Point", "MultiPoint", "LineString", "MultiLineString", "Polygon", "MultiPolygon" ] } } } ], "externalDocs": { "url": "https://tools.ietf.org/html/rfc7946#section-3.1" } }, "GeometryCollection": { "allOf": [ { "$ref": "#/components/schemas/Geometry" }, { "type": "object", "additionalProperties": false, "required": [ "geometries" ], "properties": { "geometries": { "type": "array", "additionalProperties": false, "items": { "$ref": "#/components/schemas/GeometryElement" } } } } ], "externalDocs": { "url": "https://tools.ietf.org/html/rfc7946#section-3.1.8" } }, "Geometry": { "allOf": [ { "$ref": "#/components/schemas/GeoJsonObject" }, { "type": "object", "discriminator": { "propertyName": "type" }, "additionalProperties": false, "required": [ "type" ], "properties": { "type": { "title": "type", "type": "string", "format": "enum", "nullable": false, "x-formatSpecifier": "GeometryType", "x-enumNames": [ "Point", "MultiPoint", "LineString", "MultiLineString", "Polygon", "MultiPolygon", "GeometryCollection" ] } } } ], "externalDocs": { "url": "https://tools.ietf.org/html/rfc7946#section-3.1" } }, "Point": { "allOf": [ { "$ref": "#/components/schemas/GeometryElement" }, { "type": "object", "additionalProperties": false, "required": [ "coordinates" ], "properties": { "coordinates": { "$ref": "#/components/schemas/Position" } } } ], "externalDocs": { "url": "https://tools.ietf.org/html/rfc7946#section-3.1.2" } }, "MultiPoint": { "allOf": [ { "$ref": "#/components/schemas/GeometryElement" }, { "type": "object", "additionalProperties": false, "required": [ "coordinates" ], "properties": { "coordinates": { "type": "array", "additionalProperties": false, "items": { "$ref": "#/components/schemas/Position" } } } } ], "externalDocs": { "url": "https://tools.ietf.org/html/rfc7946#section-3.1.3" } }, "LineString": { "allOf": [ { "$ref": "#/components/schemas/GeometryElement" }, { "type": "object", "additionalProperties": false, "required": [ "coordinates" ], "properties": { "coordinates": { "$ref": "#/components/schemas/LineStringCoordinates" } } } ], "externalDocs": { "url": "https://tools.ietf.org/html/rfc7946#section-3.1.4" } }, "MultiLineString": { "allOf": [ { "$ref": "#/components/schemas/GeometryElement" }, { "type": "object", "additionalProperties": false, "required": [ "coordinates" ], "properties": { "coordinates": { "type": "array", "items": { "$ref": "#/components/schemas/LineStringCoordinates" } } } } ], "externalDocs": { "url": "https://tools.ietf.org/html/rfc7946#section-3.1.5" } }, "Polygon": { "allOf": [ { "$ref": "#/components/schemas/GeometryElement" }, { "type": "object", "additionalProperties": false, "required": [ "coordinates" ], "properties": { "coordinates": { "type": "array", "additionalProperties": false, "items": { "$ref": "#/components/schemas/LinearRing" } } } } ], "externalDocs": { "url": "https://tools.ietf.org/html/rfc7946#section-3.1.6" } }, "MultiPolygon": { "allOf": [ { "$ref": "#/components/schemas/GeometryElement" }, { "type": "object", "additionalProperties": false, "required": [ "coordinates" ], "properties": { "coordinates": { "type": "array", "additionalProperties": false, "items": { "type": "array", "items": { "$ref": "#/components/schemas/LinearRing" } } } } } ], "externalDocs": { "url": "https://tools.ietf.org/html/rfc7946#section-3.1.7" } }, "GetMonitoringPointReadingResourceActionResponse": { "title": "GetMonitoringPointReadingResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetMonitoringPointReadingResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointReading->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointReading->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointReading->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointReading->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointReading->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointReading->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointReading->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointReading->ModifiedOn" }, "geographicId": { "title": "geographicId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointReading->GeographicId" }, "geographicEndPosition": { "title": "geographicEndPosition", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPointReading->GeographicEndPosition" }, "geographicEntityType": { "title": "geographicEntityType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MonitoringPointReading->GeographicEntityType", "x-formatSpecifier": "EntityType" }, "geographicLength": { "title": "geographicLength", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPointReading->GeographicLength" }, "geographicLocation": { "title": "geographicLocation", "nullable": true, "$ref": "#/components/schemas/Geometry", "x-propertyPath": "MonitoringPointReading->GeographicLocation" }, "geographicNotes": { "title": "geographicNotes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointReading->GeographicNotes" }, "geographicReferenceEntityId": { "title": "geographicReferenceEntityId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointReading->GeographicReferenceEntityId" }, "geographicReferenceEntityType": { "title": "geographicReferenceEntityType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "MonitoringPointReading->GeographicReferenceEntityType", "x-formatSpecifier": "EntityType" }, "geographicStartPosition": { "title": "geographicStartPosition", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPointReading->GeographicStartPosition" }, "geographicUnitOfMeasurementId": { "title": "geographicUnitOfMeasurementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointReading->GeographicUnitOfMeasurement_Id" }, "geographicUnitOfMeasurementDescription": { "title": "geographicUnitOfMeasurementDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointReading->GeographicUnitOfMeasurement_Description" }, "geographicUnitOfMeasurementCode": { "title": "geographicUnitOfMeasurementCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointReading->GeographicUnitOfMeasurement_Code" }, "monitoringPointId": { "title": "monitoringPointId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointReading->MonitoringPoint_Id" }, "monitoringPointCode": { "title": "monitoringPointCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointReading->MonitoringPoint_Code" }, "monitoringPointDescription": { "title": "monitoringPointDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointReading->MonitoringPoint_Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointReading->Notes" }, "reading": { "title": "reading", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "MonitoringPointReading->Reading" }, "readingOn": { "title": "readingOn", "type": "string", "format": "date-time", "nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointReading->ReadingOn" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetMonitoringPointReadingCollectionResourceActionResponse": { "title": "GetMonitoringPointReadingCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMonitoringPointReadingCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMonitoringPointReadingCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointReading->Notes" }, "monitoringPointId": { "title": "monitoringPointId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointReading->MonitoringPoint_Id" }, "monitoringPointCode": { "title": "monitoringPointCode", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointReading->MonitoringPoint_Code" }, "monitoringPointDescription": { "title": "monitoringPointDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointReading->MonitoringPoint_Description" }, "monitoringPointUnitOfMeasurementId": { "title": "monitoringPointUnitOfMeasurementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointReading->MonitoringPoint_UnitOfMeasurement_Id" }, "monitoringPointUnitOfMeasurementCode": { "title": "monitoringPointUnitOfMeasurementCode", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointReading->MonitoringPoint_UnitOfMeasurement_Code" }, "monitoringPointUnitOfMeasurementDescription": { "title": "monitoringPointUnitOfMeasurementDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointReading->MonitoringPoint_UnitOfMeasurement_Description" }, "reading": { "title": "reading", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "MonitoringPointReading->Reading" }, "readingOn": { "title": "readingOn", "type": "string", "format": "date-time", "nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointReading->ReadingOn" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointReading->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointReading->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetMonitoringPointReadingForMonitoringPointCollectionResourceActionResponse": { "title": "GetMonitoringPointReadingForMonitoringPointCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMonitoringPointReadingForMonitoringPointCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMonitoringPointReadingForMonitoringPointCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointReading->Notes" }, "reading": { "title": "reading", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "MonitoringPointReading->Reading" }, "readingOn": { "title": "readingOn", "type": "string", "format": "date-time", "nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointReading->ReadingOn" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointReading->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointReading->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointReadingMonitoringPointLookupResourceActionResponse": { "title": "MonitoringPointReadingMonitoringPointLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointReadingMonitoringPointLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointReadingMonitoringPointLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPoint->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPoint->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateMonitoringPointReadingResourceActionRequest": { "title": "CreateMonitoringPointReadingResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateMonitoringPointReadingResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "monitoringPointId" ], "properties": { "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointReading->Notes" }, "monitoringPointId": { "title": "monitoringPointId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointReading->MonitoringPoint_Id" }, "reading": { "title": "reading", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "MonitoringPointReading->Reading" }, "readingOn": { "title": "readingOn", "type": "string", "format": "date-time", "nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointReading->ReadingOn" }, "geographicLocation": { "title": "geographicLocation", "nullable": true, "$ref": "#/components/schemas/Geometry", "x-propertyPath": "MonitoringPointReading->GeographicLocation" }, "geographicStartPosition": { "title": "geographicStartPosition", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPointReading->GeographicStartPosition" }, "geographicEndPosition": { "title": "geographicEndPosition", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPointReading->GeographicEndPosition" }, "geographicLength": { "title": "geographicLength", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPointReading->GeographicLength" }, "geographicUnitOfMeasurementId": { "title": "geographicUnitOfMeasurementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointReading->GeographicUnitOfMeasurement_Id" }, "geographicNotes": { "title": "geographicNotes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointReading->GeographicNotes" }, "geographicReferenceEntityType": { "title": "geographicReferenceEntityType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "MonitoringPointReading->GeographicReferenceEntityType", "x-formatSpecifier": "EntityType" }, "geographicReferenceEntityId": { "title": "geographicReferenceEntityId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointReading->GeographicReferenceEntityId" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateMonitoringPointReadingResourceActionRequest": { "title": "UpdateMonitoringPointReadingResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointReading->Notes" }, { "title": "reading", "type": "number", "format": "decimal", "nullable": false, "x-propertyPath": "MonitoringPointReading->Reading" }, { "title": "readingOn", "type": "string", "format": "date-time", "nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointReading->ReadingOn" }, { "title": "geographicLocation", "nullable": true, "x-propertyPath": "MonitoringPointReading->GeographicLocation" }, { "title": "geographicStartPosition", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPointReading->GeographicStartPosition" }, { "title": "geographicEndPosition", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPointReading->GeographicEndPosition" }, { "title": "geographicLength", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPointReading->GeographicLength" }, { "title": "geographicUnitOfMeasurementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointReading->GeographicUnitOfMeasurement_Id" }, { "title": "geographicNotes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointReading->GeographicNotes" }, { "title": "geographicReferenceEntityType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "MonitoringPointReading->GeographicReferenceEntityType", "x-formatSpecifier": "EntityType" }, { "title": "geographicReferenceEntityId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointReading->GeographicReferenceEntityId" } ] } } }, "DeleteMonitoringPointReadingResourceActionRequest": { "title": "DeleteMonitoringPointReadingResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetMonitoringPointReadingResourceAction": { "title": "BatchGetMonitoringPointReadingResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Monitoring Point Reading entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Monitoring Point Reading entities", "items": { "$ref": "#/components/schemas/GetMonitoringPointReadingResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateMonitoringPointReadingResourceActionRequest": { "title": "BatchCreateMonitoringPointReadingResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateMonitoringPointReadingResourceActionRequest" } }, "BatchUpdateMonitoringPointReadingResourceActionRequest": { "title": "BatchUpdateMonitoringPointReadingResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateMonitoringPointReadingResourceActionRequest" } }, "BatchDeleteMonitoringPointReadingResourceActionRequest": { "title": "BatchDeleteMonitoringPointReadingResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteMonitoringPointReadingResourceActionRequest" } }, "GetMonitoringPointTriggerResourceActionResponse": { "title": "GetMonitoringPointTriggerResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetMonitoringPointTriggerResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTrigger->Code" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPointTrigger->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointTrigger->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTrigger->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTrigger->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointTrigger->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointTrigger->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTrigger->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTrigger->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointTrigger->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointTrigger->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTrigger->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTrigger->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTrigger->Description" }, "expressionsValid": { "title": "expressionsValid", "type": "boolean", "nullable": true, "x-propertyPath": "MonitoringPointTrigger->ExpressionsValid" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTrigger->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointTrigger->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetTriggerCollectionResourceActionResponse": { "title": "GetTriggerCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTriggerCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetTriggerCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTrigger->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTrigger->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointTrigger->SequenceNumber" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPointTrigger->IsActive" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTrigger->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointTrigger->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointTrigger->ModifiedOn" }, "expressionsValid": { "title": "expressionsValid", "type": "boolean", "nullable": true, "x-propertyPath": "MonitoringPointTrigger->ExpressionsValid" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "TriggerChangePermissionTreeLookupResourceActionResponse": { "title": "TriggerChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "TriggerChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "TriggerChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointTriggerInsertPermissionTreeLookupResourceActionResponse": { "title": "MonitoringPointTriggerInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointTriggerInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointTriggerInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateTriggerResourceActionRequest": { "title": "CreateTriggerResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateTriggerResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "code", "description", "permissionTreeId" ], "properties": { "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "MonitoringPointTrigger->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "nullable": false, "x-propertyPath": "MonitoringPointTrigger->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointTrigger->SequenceNumber" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointTrigger->PermissionTree_Id" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTrigger->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateMonitoringPointTriggerResourceActionRequest": { "title": "UpdateMonitoringPointTriggerResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "MonitoringPointTrigger->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "nullable": false, "x-propertyPath": "MonitoringPointTrigger->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointTrigger->SequenceNumber" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTrigger->Notes" } ] } } }, "DeleteTriggerResourceActionRequest": { "title": "DeleteTriggerResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetMonitoringPointTriggerResourceAction": { "title": "BatchGetMonitoringPointTriggerResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Monitoring Point Trigger entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Monitoring Point Trigger entities", "items": { "$ref": "#/components/schemas/GetMonitoringPointTriggerResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateMonitoringPointTriggerResourceActionRequest": { "title": "BatchCreateMonitoringPointTriggerResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateTriggerResourceActionRequest" } }, "BatchUpdateTriggerResourceActionRequest": { "title": "BatchUpdateTriggerResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateMonitoringPointTriggerResourceActionRequest" } }, "BatchDeleteMonitoringPointTriggerResourceActionRequest": { "title": "BatchDeleteMonitoringPointTriggerResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteTriggerResourceActionRequest" } }, "ChangeMonitoringPointTriggerIsActiveResourceActionRequest": { "title": "ChangeMonitoringPointTriggerIsActiveResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPointTrigger->IsActive" } ] } } }, "ChangeMonitoringPointTriggerPermissionTreeResourceActionRequest": { "title": "ChangeMonitoringPointTriggerPermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointTrigger->PermissionTree_Id" } ] } } }, "ValidateMonitoringPointTriggerExpressionsResourceActionRequest": { "title": "ValidateMonitoringPointTriggerExpressionsResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "ValidateMonitoringPointTriggerExpressionsResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "monitoringPointTriggerIds" ], "properties": { "monitoringPointTriggerIds": { "title": "monitoringPointTriggerIds", "type": "array", "format": "array", "nullable": false, "items": { "type": "integer" }, "x-propertyPath": "ValidateMonitoringPointTriggerExpressions->MonitoringPointTriggerIds", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "BatchChangeMonitoringPointTriggerIsActiveResourceActionRequest": { "title": "BatchChangeMonitoringPointTriggerIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeMonitoringPointTriggerIsActiveResourceActionRequest" } }, "BatchChangeMonitoringPointTriggerPermissionTreeResourceActionRequest": { "title": "BatchChangeMonitoringPointTriggerPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeMonitoringPointTriggerPermissionTreeResourceActionRequest" } }, "GetMonitoringPointTriggerExpressionResourceActionResponse": { "title": "GetMonitoringPointTriggerExpressionResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetMonitoringPointTriggerExpressionResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpression->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpression->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpression->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpression->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointTriggerExpression->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpression->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpression->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpression->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointTriggerExpression->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpression->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpression->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpression->PermissionTree_Description" }, "alarmCancellationType": { "title": "alarmCancellationType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpression->AlarmCancellationType", "x-formatSpecifier": "ExpressionAlarmCancellationType" }, "alwaysRecordResult": { "title": "alwaysRecordResult", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpression->AlwaysRecordResult" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpression->Asset_Id" }, "assetCode": { "title": "assetCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpression->Asset_Code" }, "assetDescription": { "title": "assetDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpression->Asset_Description" }, "assetRecordType": { "title": "assetRecordType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpression->Asset_RecordType", "x-formatSpecifier": "AssetRecordType" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpression->Description" }, "expression": { "title": "expression", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpression->Expression" }, "isValid": { "title": "isValid", "type": "boolean", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpression->IsValid" }, "isValidErrors": { "title": "isValidErrors", "type": "array", "format": "enum", "nullable": true, "items": { "type": "string", "format": "enum", "x-formatSpecifier": "IsValidFailReason" }, "x-propertyPath": "MonitoringPointTriggerExpression->IsValidErrors", "x-formatSpecifier": "IsValidFailReason" }, "monitoringPointTriggerId": { "title": "monitoringPointTriggerId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpression->MonitoringPointTrigger_Id" }, "monitoringPointTriggerCode": { "title": "monitoringPointTriggerCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpression->MonitoringPointTrigger_Code" }, "monitoringPointTriggerDescription": { "title": "monitoringPointTriggerDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpression->MonitoringPointTrigger_Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpression->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpression->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetMonitoringPointTriggerExpressionCollectionResourceActionResponse": { "title": "GetMonitoringPointTriggerExpressionCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMonitoringPointTriggerExpressionCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMonitoringPointTriggerExpressionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpression->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpression->SequenceNumber" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpression->IsActive" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpression->Notes" }, "monitoringPointTriggerId": { "title": "monitoringPointTriggerId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpression->MonitoringPointTrigger_Id" }, "monitoringPointTriggerCode": { "title": "monitoringPointTriggerCode", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpression->MonitoringPointTrigger_Code" }, "monitoringPointTriggerDescription": { "title": "monitoringPointTriggerDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpression->MonitoringPointTrigger_Description" }, "expression": { "title": "expression", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpression->Expression" }, "assetCode": { "title": "assetCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpression->Asset_Code" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointTriggerExpression->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointTriggerExpression->ModifiedOn" }, "isValid": { "title": "isValid", "type": "boolean", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpression->IsValid" }, "isValidErrors": { "title": "isValidErrors", "type": "array", "format": "enum", "nullable": true, "items": { "type": "string", "format": "enum", "x-formatSpecifier": "IsValidFailReason" }, "x-propertyPath": "MonitoringPointTriggerExpression->IsValidErrors", "x-formatSpecifier": "IsValidFailReason" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetMonitoringPointTriggerExpressionForMonitoringPointTriggerCollectionResourceActionResponse": { "title": "GetMonitoringPointTriggerExpressionForMonitoringPointTriggerCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMonitoringPointTriggerExpressionForMonitoringPointTriggerCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMonitoringPointTriggerExpressionForMonitoringPointTriggerCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpression->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpression->SequenceNumber" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpression->IsActive" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpression->Notes" }, "expression": { "title": "expression", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpression->Expression" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointTriggerExpression->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointTriggerExpression->ModifiedOn" }, "isValid": { "title": "isValid", "type": "boolean", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpression->IsValid" }, "isValidErrors": { "title": "isValidErrors", "type": "array", "format": "enum", "nullable": true, "items": { "type": "string", "format": "enum", "x-formatSpecifier": "IsValidFailReason" }, "x-propertyPath": "MonitoringPointTriggerExpression->IsValidErrors", "x-formatSpecifier": "IsValidFailReason" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointTriggerExpressionChangePermissionTreeLookupResourceActionResponse": { "title": "MonitoringPointTriggerExpressionChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointTriggerExpressionChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointTriggerExpressionChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointTriggerExpressionInsertPermissionTreeLookupResourceActionResponse": { "title": "MonitoringPointTriggerExpressionInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointTriggerExpressionInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointTriggerExpressionInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointTriggerExpressionMonitoringPointTriggerLookupResourceActionResponse": { "title": "MonitoringPointTriggerExpressionMonitoringPointTriggerLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointTriggerExpressionMonitoringPointTriggerLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointTriggerExpressionMonitoringPointTriggerLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTrigger->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTrigger->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointTriggerExpressionRegularAssetLookupResourceActionResponse": { "title": "MonitoringPointTriggerExpressionRegularAssetLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointTriggerExpressionRegularAssetLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointTriggerExpressionRegularAssetLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": true, "x-propertyPath": "Asset->Code" }, "description": { "title": "description", "type": "string", "nullable": true, "x-propertyPath": "Asset->Description" }, "siteCode": { "title": "siteCode", "type": "string", "nullable": false, "x-propertyPath": "Asset->Site_Code" }, "recordType": { "title": "recordType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "Asset->RecordType", "x-formatSpecifier": "AssetRecordType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateMonitoringPointTriggerExpressionResourceActionRequest": { "title": "CreateMonitoringPointTriggerExpressionResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateMonitoringPointTriggerExpressionResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "description", "monitoringPointTriggerId", "expression" ], "properties": { "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpression->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpression->SequenceNumber" }, "assetId": { "title": "assetId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpression->Asset_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpression->PermissionTree_Id", "x-systemGenerated": true }, "monitoringPointTriggerId": { "title": "monitoringPointTriggerId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpression->MonitoringPointTrigger_Id" }, "alarmCancellationType": { "title": "alarmCancellationType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpression->AlarmCancellationType", "x-systemGenerated": true, "x-formatSpecifier": "ExpressionAlarmCancellationType" }, "alwaysRecordResult": { "title": "alwaysRecordResult", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpression->AlwaysRecordResult", "x-systemGenerated": true }, "expression": { "title": "expression", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpression->Expression" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpression->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateMonitoringPointTriggerExpressionResourceActionRequest": { "title": "UpdateMonitoringPointTriggerExpressionResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpression->Description" }, { "title": "assetId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpression->Asset_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpression->SequenceNumber" }, { "title": "alarmCancellationType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpression->AlarmCancellationType", "x-formatSpecifier": "ExpressionAlarmCancellationType" }, { "title": "alwaysRecordResult", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpression->AlwaysRecordResult" }, { "title": "expression", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpression->Expression" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpression->Notes" } ] } } }, "DeleteMonitoringPointTriggerExpressionResourceActionRequest": { "title": "DeleteMonitoringPointTriggerExpressionResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetMonitoringPointTriggerExpressionResourceAction": { "title": "BatchGetMonitoringPointTriggerExpressionResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Monitoring Point Trigger Expression entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Monitoring Point Trigger Expression entities", "items": { "$ref": "#/components/schemas/GetMonitoringPointTriggerExpressionResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateMonitoringPointTriggerExpressionResourceActionRequest": { "title": "BatchCreateMonitoringPointTriggerExpressionResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateMonitoringPointTriggerExpressionResourceActionRequest" } }, "BatchUpdateMonitoringPointTriggerExpressionResourceActionRequest": { "title": "BatchUpdateMonitoringPointTriggerExpressionResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateMonitoringPointTriggerExpressionResourceActionRequest" } }, "BatchDeleteMonitoringPointTriggerExpressionResourceActionRequest": { "title": "BatchDeleteMonitoringPointTriggerExpressionResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteMonitoringPointTriggerExpressionResourceActionRequest" } }, "ChangeMonitoringPointTriggerExpressionIsActiveResourceActionRequest": { "title": "ChangeMonitoringPointTriggerExpressionIsActiveResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpression->IsActive" } ] } } }, "ChangeMonitoringPointTriggerExpressionPermissionTreeResourceActionRequest": { "title": "ChangeMonitoringPointTriggerExpressionPermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpression->PermissionTree_Id" } ] } } }, "BatchChangeMonitoringPointTriggerExpressionIsActiveResourceActionRequest": { "title": "BatchChangeMonitoringPointTriggerExpressionIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeMonitoringPointTriggerExpressionIsActiveResourceActionRequest" } }, "BatchChangeMonitoringPointTriggerExpressionPermissionTreeResourceActionRequest": { "title": "BatchChangeMonitoringPointTriggerExpressionPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeMonitoringPointTriggerExpressionPermissionTreeResourceActionRequest" } }, "GetMonitoringPointTriggerExpressionAlarmTypeResourceActionResponse": { "title": "GetMonitoringPointTriggerExpressionAlarmTypeResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetMonitoringPointTriggerExpressionAlarmTypeResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->PermissionTree_Description" }, "alarmTypeId": { "title": "alarmTypeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->AlarmType_Id" }, "alarmTypeCode": { "title": "alarmTypeCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->AlarmType_Code" }, "alarmTypeDescription": { "title": "alarmTypeDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->AlarmType_Description" }, "monitoringPointTriggerExpressionId": { "title": "monitoringPointTriggerExpressionId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->MonitoringPointTriggerExpression_Id" }, "monitoringPointTriggerExpressionDescription": { "title": "monitoringPointTriggerExpressionDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->MonitoringPointTriggerExpression_Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetMonitoringPointTriggerExpressionAlarmTypeCollectionResourceActionResponse": { "title": "GetMonitoringPointTriggerExpressionAlarmTypeCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMonitoringPointTriggerExpressionAlarmTypeCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMonitoringPointTriggerExpressionAlarmTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->SequenceNumber" }, "alarmTypeId": { "title": "alarmTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->AlarmType_Id" }, "alarmTypeCode": { "title": "alarmTypeCode", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->AlarmType_Code" }, "alarmTypeDescription": { "title": "alarmTypeDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->AlarmType_Description" }, "monitoringPointTriggerExpressionId": { "title": "monitoringPointTriggerExpressionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->MonitoringPointTriggerExpression_Id" }, "monitoringPointTriggerExpressionDescription": { "title": "monitoringPointTriggerExpressionDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->MonitoringPointTriggerExpression_Description" }, "monitoringPointTriggerExpressionMonitoringPointTriggerCode": { "title": "monitoringPointTriggerExpressionMonitoringPointTriggerCode", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->MonitoringPointTriggerExpression_MonitoringPointTrigger_Code" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetMonitoringPointTriggerExpressionAlarmTypeForMonitoringPointTriggerExpressionCollectionResourceActionResponse": { "title": "GetMonitoringPointTriggerExpressionAlarmTypeForMonitoringPointTriggerExpressionCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMonitoringPointTriggerExpressionAlarmTypeForMonitoringPointTriggerExpressionCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMonitoringPointTriggerExpressionAlarmTypeForMonitoringPointTriggerExpressionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "alarmTypeId": { "title": "alarmTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->AlarmType_Id" }, "alarmTypeCode": { "title": "alarmTypeCode", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->AlarmType_Code" }, "alarmTypeDescription": { "title": "alarmTypeDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->AlarmType_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointTriggerExpressionAlarmTypeAlarmTypeLookupResourceActionResponse": { "title": "MonitoringPointTriggerExpressionAlarmTypeAlarmTypeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointTriggerExpressionAlarmTypeAlarmTypeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointTriggerExpressionAlarmTypeAlarmTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "AlarmType->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "AlarmType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointTriggerExpressionAlarmTypeChangePermissionTreeLookupResourceActionResponse": { "title": "MonitoringPointTriggerExpressionAlarmTypeChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointTriggerExpressionAlarmTypeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointTriggerExpressionAlarmTypeChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointTriggerExpressionAlarmTypeInsertPermissionTreeLookupResourceActionResponse": { "title": "MonitoringPointTriggerExpressionAlarmTypeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointTriggerExpressionAlarmTypeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointTriggerExpressionAlarmTypeInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointTriggerExpressionAlarmTypeMonitoringPointTriggerExpressionLookupResourceActionResponse": { "title": "MonitoringPointTriggerExpressionAlarmTypeMonitoringPointTriggerExpressionLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointTriggerExpressionAlarmTypeMonitoringPointTriggerExpressionLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointTriggerExpressionAlarmTypeMonitoringPointTriggerExpressionLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpression->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateMonitoringPointTriggerExpressionAlarmTypeResourceActionRequest": { "title": "CreateMonitoringPointTriggerExpressionAlarmTypeResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateMonitoringPointTriggerExpressionAlarmTypeResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "monitoringPointTriggerExpressionId", "alarmTypeId" ], "properties": { "monitoringPointTriggerExpressionId": { "title": "monitoringPointTriggerExpressionId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->MonitoringPointTriggerExpression_Id" }, "alarmTypeId": { "title": "alarmTypeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->AlarmType_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->SequenceNumber" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->PermissionTree_Id", "x-systemGenerated": true } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateMonitoringPointTriggerExpressionAlarmTypeResourceActionRequest": { "title": "UpdateMonitoringPointTriggerExpressionAlarmTypeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->Notes" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->SequenceNumber" } ] } } }, "DeleteMonitoringPointTriggerExpressionAlarmTypeResourceActionRequest": { "title": "DeleteMonitoringPointTriggerExpressionAlarmTypeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetMonitoringPointTriggerExpressionAlarmTypeResourceAction": { "title": "BatchGetMonitoringPointTriggerExpressionAlarmTypeResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Monitoring Point Trigger Expression Alarm Type entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Monitoring Point Trigger Expression Alarm Type entities", "items": { "$ref": "#/components/schemas/GetMonitoringPointTriggerExpressionAlarmTypeResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateMonitoringPointTriggerExpressionAlarmTypeResourceActionRequest": { "title": "BatchCreateMonitoringPointTriggerExpressionAlarmTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateMonitoringPointTriggerExpressionAlarmTypeResourceActionRequest" } }, "BatchUpdateMonitoringPointTriggerExpressionAlarmTypeResourceActionRequest": { "title": "BatchUpdateMonitoringPointTriggerExpressionAlarmTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateMonitoringPointTriggerExpressionAlarmTypeResourceActionRequest" } }, "BatchDeleteMonitoringPointTriggerExpressionAlarmTypeResourceActionRequest": { "title": "BatchDeleteMonitoringPointTriggerExpressionAlarmTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteMonitoringPointTriggerExpressionAlarmTypeResourceActionRequest" } }, "ChangeMonitoringPointTriggerExpressionAlarmTypeIsActiveResourceActionRequest": { "title": "ChangeMonitoringPointTriggerExpressionAlarmTypeIsActiveResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->IsActive" } ] } } }, "ChangeMonitoringPointTriggerExpressionAlarmTypePermissionTreeResourceActionRequest": { "title": "ChangeMonitoringPointTriggerExpressionAlarmTypePermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionAlarmType->PermissionTree_Id" } ] } } }, "BatchChangeMonitoringPointTriggerExpressionAlarmTypeIsActiveResourceActionRequest": { "title": "BatchChangeMonitoringPointTriggerExpressionAlarmTypeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeMonitoringPointTriggerExpressionAlarmTypeIsActiveResourceActionRequest" } }, "BatchChangeMonitoringPointTriggerExpressionAlarmTypePermissionTreeResourceActionRequest": { "title": "BatchChangeMonitoringPointTriggerExpressionAlarmTypePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeMonitoringPointTriggerExpressionAlarmTypePermissionTreeResourceActionRequest" } }, "GetMonitoringPointTriggerExpressionEvaluationCollectionResourceActionResponse2": { "title": "GetMonitoringPointTriggerExpressionEvaluationCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMonitoringPointTriggerExpressionEvaluationCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMonitoringPointTriggerExpressionEvaluationCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "executedOn": { "title": "executedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointTriggerExpressionEvaluation->ExecutedOn" }, "status": { "title": "status", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionEvaluation->Status", "x-formatSpecifier": "MonitoringPointTriggerExpressionEvaluationStatus" }, "monitoringPointCount": { "title": "monitoringPointCount", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionEvaluation->MonitoringPointCount" }, "result": { "title": "result", "nullable": true, "$ref": "#/components/schemas/NotificationSchema", "x-propertyPath": "MonitoringPointTriggerExpressionEvaluation->Result" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetMonitoringPointTriggerExpressionEvaluationFailuresCollectionResourceActionResponse2": { "title": "GetMonitoringPointTriggerExpressionEvaluationFailuresCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMonitoringPointTriggerExpressionEvaluationFailuresCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMonitoringPointTriggerExpressionEvaluationFailuresCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "executedOn": { "title": "executedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointTriggerExpressionEvaluation->ExecutedOn" }, "status": { "title": "status", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionEvaluation->Status", "x-formatSpecifier": "MonitoringPointTriggerExpressionEvaluationStatus" }, "monitoringPointCount": { "title": "monitoringPointCount", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionEvaluation->MonitoringPointCount" }, "result": { "title": "result", "nullable": true, "$ref": "#/components/schemas/NotificationSchema", "x-propertyPath": "MonitoringPointTriggerExpressionEvaluation->Result" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "ResubmitMonitoringPointTriggerExpressionEvaluationResourceActionRequest2": { "title": "ResubmitMonitoringPointTriggerExpressionEvaluationResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "ResubmitMonitoringPointTriggerExpressionEvaluationResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "evaluationIds" ], "properties": { "evaluationIds": { "title": "evaluationIds", "type": "array", "format": "array", "nullable": false, "items": { "type": "integer" }, "x-propertyPath": "ResubmitEvaluation->EvaluationIds", "x-formatSpecifier": "Int64" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "GetMonitoringPointTriggerExpressionEvaluationLogCollectionResourceActionResponse": { "title": "GetMonitoringPointTriggerExpressionEvaluationLogCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMonitoringPointTriggerExpressionEvaluationLogCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMonitoringPointTriggerExpressionEvaluationLogCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "evaluationExecutedOn": { "title": "evaluationExecutedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointTriggerExpressionEvaluationLog->Evaluation_ExecutedOn" }, "evaluationStatus": { "title": "evaluationStatus", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionEvaluationLog->Evaluation_Status", "x-formatSpecifier": "MonitoringPointTriggerExpressionEvaluationStatus" }, "monitoringPointTriggerExpressionId": { "title": "monitoringPointTriggerExpressionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionEvaluationLog->MonitoringPointTriggerExpression_Id" }, "monitoringPointTriggerExpressionDescription": { "title": "monitoringPointTriggerExpressionDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionEvaluationLog->MonitoringPointTriggerExpression_Description" }, "expressionVersion": { "title": "expressionVersion", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionEvaluationLog->ExpressionVersion" }, "monitoringPointId": { "title": "monitoringPointId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionEvaluationLog->MonitoringPoint_Id" }, "monitoringPointCode": { "title": "monitoringPointCode", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionEvaluationLog->MonitoringPoint_Code" }, "monitoringPointDescription": { "title": "monitoringPointDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionEvaluationLog->MonitoringPoint_Description" }, "processStatus": { "title": "processStatus", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionEvaluationLog->ProcessStatus", "x-formatSpecifier": "TriggerExpressionExecutionContextProcessStatus" }, "executionStatus": { "title": "executionStatus", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionEvaluationLog->ExecutionStatus", "x-formatSpecifier": "TriggerExpressionExecutionContextExecutionStatus" }, "executionType": { "title": "executionType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionEvaluationLog->ExecutionType", "x-formatSpecifier": "MonitoringPointTriggerExpressionExecutionType" }, "expressionTriggered": { "title": "expressionTriggered", "type": "boolean", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionEvaluationLog->ExpressionTriggered" }, "detectedAssetCount": { "title": "detectedAssetCount", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionEvaluationLog->DetectedAssetCount" }, "configuredAlarmTypeCount": { "title": "configuredAlarmTypeCount", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionEvaluationLog->ConfiguredAlarmTypeCount" }, "alarmsGenerated": { "title": "alarmsGenerated", "type": "array", "format": "array", "nullable": true, "items": { "type": "integer" }, "x-propertyPath": "MonitoringPointTriggerExpressionEvaluationLog->AlarmsGenerated", "x-formatSpecifier": "Int64" }, "result": { "title": "result", "nullable": true, "$ref": "#/components/schemas/NotificationSchema", "x-propertyPath": "MonitoringPointTriggerExpressionEvaluationLog->Result" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetMonitoringPointTriggerExpressionEvaluationLogForEvaluationCollectionResourceActionResponse": { "title": "GetMonitoringPointTriggerExpressionEvaluationLogForEvaluationCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMonitoringPointTriggerExpressionEvaluationLogForEvaluationCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMonitoringPointTriggerExpressionEvaluationLogForEvaluationCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "evaluationExecutedOn": { "title": "evaluationExecutedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointTriggerExpressionEvaluationLog->Evaluation_ExecutedOn" }, "evaluationStatus": { "title": "evaluationStatus", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionEvaluationLog->Evaluation_Status", "x-formatSpecifier": "MonitoringPointTriggerExpressionEvaluationStatus" }, "monitoringPointTriggerExpressionId": { "title": "monitoringPointTriggerExpressionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionEvaluationLog->MonitoringPointTriggerExpression_Id" }, "monitoringPointTriggerExpressionDescription": { "title": "monitoringPointTriggerExpressionDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionEvaluationLog->MonitoringPointTriggerExpression_Description" }, "expressionVersion": { "title": "expressionVersion", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionEvaluationLog->ExpressionVersion" }, "monitoringPointId": { "title": "monitoringPointId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionEvaluationLog->MonitoringPoint_Id" }, "monitoringPointCode": { "title": "monitoringPointCode", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionEvaluationLog->MonitoringPoint_Code" }, "monitoringPointDescription": { "title": "monitoringPointDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionEvaluationLog->MonitoringPoint_Description" }, "processStatus": { "title": "processStatus", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionEvaluationLog->ProcessStatus", "x-formatSpecifier": "TriggerExpressionExecutionContextProcessStatus" }, "executionStatus": { "title": "executionStatus", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionEvaluationLog->ExecutionStatus", "x-formatSpecifier": "TriggerExpressionExecutionContextExecutionStatus" }, "executionType": { "title": "executionType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionEvaluationLog->ExecutionType", "x-formatSpecifier": "MonitoringPointTriggerExpressionExecutionType" }, "expressionTriggered": { "title": "expressionTriggered", "type": "boolean", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionEvaluationLog->ExpressionTriggered" }, "detectedAssetCount": { "title": "detectedAssetCount", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionEvaluationLog->DetectedAssetCount" }, "configuredAlarmTypeCount": { "title": "configuredAlarmTypeCount", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionEvaluationLog->ConfiguredAlarmTypeCount" }, "alarmsGenerated": { "title": "alarmsGenerated", "type": "array", "format": "array", "nullable": true, "items": { "type": "integer" }, "x-propertyPath": "MonitoringPointTriggerExpressionEvaluationLog->AlarmsGenerated", "x-formatSpecifier": "Int64" }, "result": { "title": "result", "nullable": true, "$ref": "#/components/schemas/NotificationSchema", "x-propertyPath": "MonitoringPointTriggerExpressionEvaluationLog->Result" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetMonitoringPointTriggerExpressionParameterResourceActionResponse": { "title": "GetMonitoringPointTriggerExpressionParameterResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetMonitoringPointTriggerExpressionParameterResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "isActive": { "title": "isActive", "type": "boolean", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointTriggerExpressionParameter->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointTriggerExpressionParameter->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->PermissionTree_Description" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->EntityType", "x-formatSpecifier": "EntityType", "x-NullExpression": "MonitoringPointTriggerExpressionParameter->ParameterType eq 'Entity'" }, "monitoringPointId": { "title": "monitoringPointId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPoint_Id" }, "monitoringPointCode": { "title": "monitoringPointCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPoint_Code" }, "monitoringPointDescription": { "title": "monitoringPointDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPoint_Description" }, "monitoringPointTriggerExpressionId": { "title": "monitoringPointTriggerExpressionId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_Id" }, "monitoringPointTriggerExpressionDescription": { "title": "monitoringPointTriggerExpressionDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_Description" }, "monitoringPointTypeId": { "title": "monitoringPointTypeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPointType_Id", "x-NullExpression": "MonitoringPointTriggerExpressionParameter->ParameterType eq 'MonitoringPoint'" }, "monitoringPointTypeCode": { "title": "monitoringPointTypeCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPointType_Code" }, "monitoringPointTypeDescription": { "title": "monitoringPointTypeDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPointType_Description" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->Notes" }, "parameterName": { "title": "parameterName", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->ParameterName" }, "parameterType": { "title": "parameterType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->ParameterType", "x-formatSpecifier": "MonitoringPointTriggerExpressionParameterType" }, "parameterValue": { "title": "parameterValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "MonitoringPointTriggerExpressionParameter->ParameterValue", "x-formatSpecifier": "DynamicValue", "x-NullExpression": "MonitoringPointTriggerExpressionParameter->ParameterType ne 'MonitoringPoint'" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetMonitoringPointTriggerExpressionParameterCollectionResourceActionResponse": { "title": "GetMonitoringPointTriggerExpressionParameterCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMonitoringPointTriggerExpressionParameterCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMonitoringPointTriggerExpressionParameterCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "monitoringPointTriggerExpressionId": { "title": "monitoringPointTriggerExpressionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_Id" }, "monitoringPointTriggerExpressionMonitoringPointTriggerId": { "title": "monitoringPointTriggerExpressionMonitoringPointTriggerId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_MonitoringPointTrigger_Id" }, "monitoringPointTriggerExpressionMonitoringPointTriggerCode": { "title": "monitoringPointTriggerExpressionMonitoringPointTriggerCode", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_MonitoringPointTrigger_Code" }, "monitoringPointTriggerExpressionMonitoringPointTriggerDescription": { "title": "monitoringPointTriggerExpressionMonitoringPointTriggerDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_MonitoringPointTrigger_Description" }, "monitoringPointTriggerExpressionDescription": { "title": "monitoringPointTriggerExpressionDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_Description" }, "monitoringPointId": { "title": "monitoringPointId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPoint_Id" }, "monitoringPointCode": { "title": "monitoringPointCode", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPoint_Code" }, "monitoringPointDescription": { "title": "monitoringPointDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPoint_Description" }, "monitoringPointTypeId": { "title": "monitoringPointTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPointType_Id" }, "monitoringPointTypeCode": { "title": "monitoringPointTypeCode", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPointType_Code" }, "monitoringPointTypeDescription": { "title": "monitoringPointTypeDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPointType_Description" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->EntityType", "x-formatSpecifier": "EntityType", "x-NullExpression": "MonitoringPointTriggerExpressionParameter->ParameterType eq 'Entity'" }, "parameterName": { "title": "parameterName", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->ParameterName" }, "parameterType": { "title": "parameterType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->ParameterType", "x-formatSpecifier": "MonitoringPointTriggerExpressionParameterType" }, "parameterValue": { "title": "parameterValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "MonitoringPointTriggerExpressionParameter->ParameterValue", "x-formatSpecifier": "DynamicValue", "x-NullExpression": "MonitoringPointTriggerExpressionParameter->ParameterType ne 'MonitoringPoint'" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointTriggerExpressionParameter->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointTriggerExpressionParameter->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetMonitoringPointTriggerExpressionParameterForMonitoringPointTriggerExpressionCollectionResourceActionResponse": { "title": "GetMonitoringPointTriggerExpressionParameterForMonitoringPointTriggerExpressionCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMonitoringPointTriggerExpressionParameterForMonitoringPointTriggerExpressionCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMonitoringPointTriggerExpressionParameterForMonitoringPointTriggerExpressionCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "entityType": { "title": "entityType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->EntityType", "x-formatSpecifier": "EntityType", "x-NullExpression": "MonitoringPointTriggerExpressionParameter->ParameterType eq 'Entity'" }, "monitoringPointId": { "title": "monitoringPointId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPoint_Id" }, "monitoringPointCode": { "title": "monitoringPointCode", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPoint_Code" }, "monitoringPointDescription": { "title": "monitoringPointDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPoint_Description" }, "monitoringPointTypeId": { "title": "monitoringPointTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPointType_Id" }, "monitoringPointTypeCode": { "title": "monitoringPointTypeCode", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPointType_Code" }, "monitoringPointTypeDescription": { "title": "monitoringPointTypeDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPointType_Description" }, "monitoringPointTriggerExpressionId": { "title": "monitoringPointTriggerExpressionId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_Id" }, "monitoringPointTriggerExpressionDescription": { "title": "monitoringPointTriggerExpressionDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_Description" }, "monitoringPointTriggerExpressionMonitoringPointTriggerId": { "title": "monitoringPointTriggerExpressionMonitoringPointTriggerId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_MonitoringPointTrigger_Id" }, "monitoringPointTriggerExpressionMonitoringPointTriggerCode": { "title": "monitoringPointTriggerExpressionMonitoringPointTriggerCode", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_MonitoringPointTrigger_Code" }, "monitoringPointTriggerExpressionMonitoringPointTriggerDescription": { "title": "monitoringPointTriggerExpressionMonitoringPointTriggerDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_MonitoringPointTrigger_Description" }, "parameterName": { "title": "parameterName", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->ParameterName" }, "parameterType": { "title": "parameterType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->ParameterType", "x-formatSpecifier": "MonitoringPointTriggerExpressionParameterType" }, "parameterValue": { "title": "parameterValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "MonitoringPointTriggerExpressionParameter->ParameterValue", "x-formatSpecifier": "DynamicValue", "x-NullExpression": "MonitoringPointTriggerExpressionParameter->ParameterType ne 'MonitoringPoint'" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointTriggerExpressionParameterEntityTypeLookupResourceActionResponse": { "title": "MonitoringPointTriggerExpressionParameterEntityTypeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointTriggerExpressionParameterEntityTypeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointTriggerExpressionParameterEntityTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "entityType": { "title": "entityType", "type": "string", "format": "enum", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameterEntityTypeSummary->EntityType", "x-formatSpecifier": "EntityType" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointTriggerExpressionParameterInsertPermissionTreeLookupResourceActionResponse": { "title": "MonitoringPointTriggerExpressionParameterInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointTriggerExpressionParameterInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointTriggerExpressionParameterInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointTriggerExpressionParameterMonitoringPointLookupResourceActionResponse": { "title": "MonitoringPointTriggerExpressionParameterMonitoringPointLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointTriggerExpressionParameterMonitoringPointLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointTriggerExpressionParameterMonitoringPointLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPoint->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPoint->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionLookupResourceActionResponse": { "title": "MonitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointTriggerExpressionParameterMonitoringPointTriggerExpressionLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpression->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointTriggerExpressionParameterMonitoringPointTypeLookupResourceActionResponse": { "title": "MonitoringPointTriggerExpressionParameterMonitoringPointTypeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointTriggerExpressionParameterMonitoringPointTypeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointTriggerExpressionParameterMonitoringPointTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointType->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateMonitoringPointTriggerExpressionParameterResourceActionRequest": { "title": "CreateMonitoringPointTriggerExpressionParameterResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateMonitoringPointTriggerExpressionParameterResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "monitoringPointTriggerExpressionId", "parameterName", "parameterType" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->PermissionTree_Id", "x-systemGenerated": true }, "monitoringPointTriggerExpressionId": { "title": "monitoringPointTriggerExpressionId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPointTriggerExpression_Id" }, "monitoringPointId": { "title": "monitoringPointId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPoint_Id" }, "monitoringPointTypeId": { "title": "monitoringPointTypeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPointType_Id", "x-NullExpression": "MonitoringPointTriggerExpressionParameter->ParameterType eq 'MonitoringPoint'" }, "entityType": { "title": "entityType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->EntityType", "x-formatSpecifier": "EntityType", "x-NullExpression": "MonitoringPointTriggerExpressionParameter->ParameterType eq 'Entity'" }, "parameterName": { "title": "parameterName", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->ParameterName" }, "parameterType": { "title": "parameterType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->ParameterType", "x-formatSpecifier": "MonitoringPointTriggerExpressionParameterType" }, "parameterValue": { "title": "parameterValue", "format": "composite", "nullable": false, "$ref": "#/components/schemas/DynamicValueSchema", "x-propertyPath": "MonitoringPointTriggerExpressionParameter->ParameterValue", "x-formatSpecifier": "DynamicValue", "x-NullExpression": "MonitoringPointTriggerExpressionParameter->ParameterType ne 'MonitoringPoint'" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateMonitoringPointTriggerExpressionParameterResourceActionRequest": { "title": "UpdateMonitoringPointTriggerExpressionParameterResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "entityType", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->EntityType", "x-formatSpecifier": "EntityType", "x-NullExpression": "MonitoringPointTriggerExpressionParameter->ParameterType eq 'Entity'" }, { "title": "parameterName", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->ParameterName" }, { "title": "parameterValue", "format": "composite", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->ParameterValue", "x-formatSpecifier": "DynamicValue", "x-NullExpression": "MonitoringPointTriggerExpressionParameter->ParameterType ne 'MonitoringPoint'" }, { "title": "monitoringPointId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->MonitoringPoint_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->SequenceNumber" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->Notes" } ] } } }, "DeleteMonitoringPointTriggerExpressionParameterResourceActionRequest": { "title": "DeleteMonitoringPointTriggerExpressionParameterResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetMonitoringPointTriggerExpressionParameterResourceAction": { "title": "BatchGetMonitoringPointTriggerExpressionParameterResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Monitoring Point Trigger Expression Parameter entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Monitoring Point Trigger Expression Parameter entities", "items": { "$ref": "#/components/schemas/GetMonitoringPointTriggerExpressionParameterResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateMonitoringPointTriggerExpressionParameterResourceActionRequest": { "title": "BatchCreateMonitoringPointTriggerExpressionParameterResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateMonitoringPointTriggerExpressionParameterResourceActionRequest" } }, "BatchUpdateMonitoringPointTriggerExpressionParameterResourceActionRequest": { "title": "BatchUpdateMonitoringPointTriggerExpressionParameterResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateMonitoringPointTriggerExpressionParameterResourceActionRequest" } }, "BatchDeleteMonitoringPointTriggerExpressionParameterResourceActionRequest": { "title": "BatchDeleteMonitoringPointTriggerExpressionParameterResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteMonitoringPointTriggerExpressionParameterResourceActionRequest" } }, "ChangeMonitoringPointTriggerExpressionParameterIsActiveResourceActionRequest": { "title": "ChangeMonitoringPointTriggerExpressionParameterIsActiveResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->IsActive" } ] } } }, "ChangeMonitoringPointTriggerExpressionParameterPermissionTreeResourceActionRequest": { "title": "ChangeMonitoringPointTriggerExpressionParameterPermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointTriggerExpressionParameter->PermissionTree_Id" } ] } } }, "BatchChangeMonitoringPointTriggerExpressionParameterIsActiveResourceActionRequest": { "title": "BatchChangeMonitoringPointTriggerExpressionParameterIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeMonitoringPointTriggerExpressionParameterIsActiveResourceActionRequest" } }, "BatchChangeMonitoringPointTriggerExpressionParameterPermissionTreeResourceActionRequest": { "title": "BatchChangeMonitoringPointTriggerExpressionParameterPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeMonitoringPointTriggerExpressionParameterPermissionTreeResourceActionRequest" } }, "GetMonitorPointTypeResourceActionResponse4": { "title": "GetMonitorPointTypeResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetMonitorPointTypeResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointType->Code" }, "isActive": { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPointType->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointType->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointType->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointType->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointType->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointType->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointType->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointType->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointType->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointType->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointType->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointType->PermissionTree_Description" }, "alarmCancellation": { "title": "alarmCancellation", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "MonitoringPointType->AlarmCancellation", "x-formatSpecifier": "AlarmCancellation" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointType->Description" }, "hasLowerCriticalBound": { "title": "hasLowerCriticalBound", "type": "boolean", "nullable": true, "x-propertyPath": "MonitoringPointType->HasLowerCriticalBound" }, "hasLowerWarningBound": { "title": "hasLowerWarningBound", "type": "boolean", "nullable": true, "x-propertyPath": "MonitoringPointType->HasLowerWarningBound" }, "hasUpperCriticalBound": { "title": "hasUpperCriticalBound", "type": "boolean", "nullable": true, "x-propertyPath": "MonitoringPointType->HasUpperCriticalBound" }, "hasUpperWarningBound": { "title": "hasUpperWarningBound", "type": "boolean", "nullable": true, "x-propertyPath": "MonitoringPointType->HasUpperWarningBound" }, "isCalculated": { "title": "isCalculated", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPointType->IsCalculated" }, "lowerCriticalAlarmTypeId": { "title": "lowerCriticalAlarmTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointType->LowerCriticalAlarmType_Id", "x-NullExpression": "MonitoringPointType->LowerCriticalBound eq NULL" }, "lowerCriticalAlarmTypeDescription": { "title": "lowerCriticalAlarmTypeDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointType->LowerCriticalAlarmType_Description" }, "lowerCriticalAlarmTypeCode": { "title": "lowerCriticalAlarmTypeCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointType->LowerCriticalAlarmType_Code" }, "lowerCriticalBound": { "title": "lowerCriticalBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPointType->LowerCriticalBound" }, "lowerCriticalSuppressesLowerWarning": { "title": "lowerCriticalSuppressesLowerWarning", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPointType->LowerCriticalSuppressesLowerWarning" }, "lowerWarningAlarmTypeId": { "title": "lowerWarningAlarmTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointType->LowerWarningAlarmType_Id", "x-NullExpression": "MonitoringPointType->LowerWarningBound eq NULL" }, "lowerWarningAlarmTypeDescription": { "title": "lowerWarningAlarmTypeDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointType->LowerWarningAlarmType_Description" }, "lowerWarningAlarmTypeCode": { "title": "lowerWarningAlarmTypeCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointType->LowerWarningAlarmType_Code" }, "lowerWarningBound": { "title": "lowerWarningBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPointType->LowerWarningBound" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointType->Notes" }, "readingFormula": { "title": "readingFormula", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointType->ReadingFormula", "x-NullExpression": "MonitoringPointType->IsCalculated eq FALSE" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointType->SequenceNumber" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointType->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointType->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointType->UnitOfMeasurement_Description" }, "upperCriticalAlarmTypeId": { "title": "upperCriticalAlarmTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointType->UpperCriticalAlarmType_Id", "x-NullExpression": "MonitoringPointType->UpperCriticalBound eq NULL" }, "upperCriticalAlarmTypeDescription": { "title": "upperCriticalAlarmTypeDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointType->UpperCriticalAlarmType_Description" }, "upperCriticalAlarmTypeCode": { "title": "upperCriticalAlarmTypeCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointType->UpperCriticalAlarmType_Code" }, "upperCriticalBound": { "title": "upperCriticalBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPointType->UpperCriticalBound" }, "upperCriticalSuppressesUpperWarning": { "title": "upperCriticalSuppressesUpperWarning", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPointType->UpperCriticalSuppressesUpperWarning" }, "upperWarningAlarmTypeId": { "title": "upperWarningAlarmTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointType->UpperWarningAlarmType_Id", "x-NullExpression": "MonitoringPointType->UpperWarningBound eq NULL" }, "upperWarningAlarmTypeDescription": { "title": "upperWarningAlarmTypeDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointType->UpperWarningAlarmType_Description" }, "upperWarningAlarmTypeCode": { "title": "upperWarningAlarmTypeCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointType->UpperWarningAlarmType_Code" }, "upperWarningBound": { "title": "upperWarningBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPointType->UpperWarningBound" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetMonitoringPointTypeCollectionResourceActionResponse": { "title": "GetMonitoringPointTypeCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMonitoringPointTypeCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMonitoringPointTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointType->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointType->Description" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointType->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointType->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointType->UnitOfMeasurement_Description" }, "isCalculated": { "title": "isCalculated", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPointType->IsCalculated" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointType->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointType->Notes" }, "upperCriticalBound": { "title": "upperCriticalBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPointType->UpperCriticalBound" }, "upperWarningBound": { "title": "upperWarningBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPointType->UpperWarningBound" }, "lowerWarningBound": { "title": "lowerWarningBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPointType->LowerWarningBound" }, "lowerCriticalBound": { "title": "lowerCriticalBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPointType->LowerCriticalBound" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointType->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointType->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointTypeChangePermissionTreeLookupResourceActionResponse": { "title": "MonitoringPointTypeChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointTypeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointTypeChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointTypeInsertPermissionTreeLookupResourceActionResponse": { "title": "MonitoringPointTypeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointTypeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointTypeInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointTypeLowerCriticalAlarmTypeLookupResourceActionResponse": { "title": "MonitoringPointTypeLowerCriticalAlarmTypeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointTypeLowerCriticalAlarmTypeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointTypeLowerCriticalAlarmTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "AlarmType->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "AlarmType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointTypeLowerWarningAlarmTypeLookupResourceActionResponse": { "title": "MonitoringPointTypeLowerWarningAlarmTypeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointTypeLowerWarningAlarmTypeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointTypeLowerWarningAlarmTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "AlarmType->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "AlarmType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointTypeUnitOfMeasurementLookupResourceActionResponse": { "title": "MonitoringPointTypeUnitOfMeasurementLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointTypeUnitOfMeasurementLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointTypeUnitOfMeasurementLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "UnitOfMeasurement->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "UnitOfMeasurement->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointTypeUpperCriticalAlarmTypeLookupResourceActionResponse": { "title": "MonitoringPointTypeUpperCriticalAlarmTypeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointTypeUpperCriticalAlarmTypeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointTypeUpperCriticalAlarmTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "AlarmType->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "AlarmType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointTypeUpperWarningAlarmTypeLookupResourceActionResponse": { "title": "MonitoringPointTypeUpperWarningAlarmTypeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointTypeUpperWarningAlarmTypeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointTypeUpperWarningAlarmTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "AlarmType->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "AlarmType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateMonitoringPointTypeResourceActionRequest": { "title": "CreateMonitoringPointTypeResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateMonitoringPointTypeResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "code", "description", "permissionTreeId", "isCalculated", "unitOfMeasurementId" ], "properties": { "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "MonitoringPointType->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "nullable": false, "x-propertyPath": "MonitoringPointType->Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointType->PermissionTree_Id" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointType->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointType->SequenceNumber" }, "alarmCancellation": { "title": "alarmCancellation", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "MonitoringPointType->AlarmCancellation", "x-formatSpecifier": "AlarmCancellation" }, "upperCriticalSuppressesUpperWarning": { "title": "upperCriticalSuppressesUpperWarning", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPointType->UpperCriticalSuppressesUpperWarning" }, "lowerCriticalSuppressesLowerWarning": { "title": "lowerCriticalSuppressesLowerWarning", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPointType->LowerCriticalSuppressesLowerWarning" }, "upperCriticalBound": { "title": "upperCriticalBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPointType->UpperCriticalBound" }, "upperWarningBound": { "title": "upperWarningBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPointType->UpperWarningBound" }, "lowerCriticalBound": { "title": "lowerCriticalBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPointType->LowerCriticalBound" }, "lowerWarningBound": { "title": "lowerWarningBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPointType->LowerWarningBound" }, "isCalculated": { "title": "isCalculated", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPointType->IsCalculated" }, "upperCriticalAlarmTypeId": { "title": "upperCriticalAlarmTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointType->UpperCriticalAlarmType_Id", "x-NullExpression": "MonitoringPointType->UpperCriticalBound eq NULL" }, "upperWarningAlarmTypeId": { "title": "upperWarningAlarmTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointType->UpperWarningAlarmType_Id", "x-NullExpression": "MonitoringPointType->UpperWarningBound eq NULL" }, "lowerWarningAlarmTypeId": { "title": "lowerWarningAlarmTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointType->LowerWarningAlarmType_Id", "x-NullExpression": "MonitoringPointType->LowerWarningBound eq NULL" }, "lowerCriticalAlarmTypeId": { "title": "lowerCriticalAlarmTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointType->LowerCriticalAlarmType_Id", "x-NullExpression": "MonitoringPointType->LowerCriticalBound eq NULL" }, "readingFormula": { "title": "readingFormula", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointType->ReadingFormula", "x-NullExpression": "MonitoringPointType->IsCalculated eq FALSE" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointType->UnitOfMeasurement_Id" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateMonitoringPointTypeResourceActionRequest": { "title": "UpdateMonitoringPointTypeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "MonitoringPointType->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "nullable": false, "x-propertyPath": "MonitoringPointType->Description" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointType->Notes" }, { "title": "isCalculated", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPointType->IsCalculated" }, { "title": "readingFormula", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointType->ReadingFormula", "x-NullExpression": "MonitoringPointType->IsCalculated eq FALSE" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointType->SequenceNumber" }, { "title": "alarmCancellation", "type": "string", "format": "enum", "nullable": false, "x-propertyPath": "MonitoringPointType->AlarmCancellation", "x-formatSpecifier": "AlarmCancellation" }, { "title": "upperCriticalSuppressesUpperWarning", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPointType->UpperCriticalSuppressesUpperWarning" }, { "title": "lowerCriticalSuppressesLowerWarning", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPointType->LowerCriticalSuppressesLowerWarning" }, { "title": "upperCriticalBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPointType->UpperCriticalBound" }, { "title": "upperWarningBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPointType->UpperWarningBound" }, { "title": "lowerCriticalBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPointType->LowerCriticalBound" }, { "title": "lowerWarningBound", "type": "number", "format": "decimal", "nullable": true, "x-propertyPath": "MonitoringPointType->LowerWarningBound" }, { "title": "upperCriticalAlarmTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointType->UpperCriticalAlarmType_Id", "x-NullExpression": "MonitoringPointType->UpperCriticalBound eq NULL" }, { "title": "upperWarningAlarmTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointType->UpperWarningAlarmType_Id", "x-NullExpression": "MonitoringPointType->UpperWarningBound eq NULL" }, { "title": "lowerWarningAlarmTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointType->LowerWarningAlarmType_Id", "x-NullExpression": "MonitoringPointType->LowerWarningBound eq NULL" }, { "title": "lowerCriticalAlarmTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointType->LowerCriticalAlarmType_Id", "x-NullExpression": "MonitoringPointType->LowerCriticalBound eq NULL" }, { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointType->UnitOfMeasurement_Id" } ] } } }, "DeleteMonitoringPointTypeResourceActionRequest": { "title": "DeleteMonitoringPointTypeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetMonitoringPointTypesResourceAction": { "title": "BatchGetMonitoringPointTypesResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Monitoring Point Type entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Monitoring Point Type entities", "items": { "$ref": "#/components/schemas/GetMonitorPointTypeResourceActionResponse4" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateMonitoringPointTypeRequest": { "title": "BatchCreateMonitoringPointTypeRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateMonitoringPointTypeResourceActionRequest" } }, "BatchUpdateMonitoringPointTypeResourceActionRequest": { "title": "BatchUpdateMonitoringPointTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateMonitoringPointTypeResourceActionRequest" } }, "BatchDeleteMonitoringPointTypeResourceActionRequest": { "title": "BatchDeleteMonitoringPointTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteMonitoringPointTypeResourceActionRequest" } }, "ChangeMonitoringPointTypeIsActiveResourceActionRequest": { "title": "ChangeMonitoringPointTypeIsActiveResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "nullable": false, "x-propertyPath": "MonitoringPointType->IsActive" } ] } } }, "ChangeMonitoringPointTypePermissionTreeResourceActionRequest": { "title": "ChangeMonitoringPointTypePermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointType->PermissionTree_Id" } ] } } }, "BatchChangeMonitoringPointTypeIsActiveResourceActionRequest": { "title": "BatchChangeMonitoringPointTypeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeMonitoringPointTypeIsActiveResourceActionRequest" } }, "BatchChangeMonitoringPointTypePermissionTreeResourceActionRequest": { "title": "BatchChangeMonitoringPointTypePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeMonitoringPointTypePermissionTreeResourceActionRequest" } }, "GetMonitoringPointTypeParameterResourceActionResponse": { "title": "GetMonitoringPointTypeParameterResourceActionResponse", "type": "object", "additionalProperties": false, "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "nullable": false, "example": 1 }, "properties": { "title": "GetMonitoringPointTypeParameterResourceActionResponseProperties", "type": "object", "nullable": false, "additionalProperties": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointTypeParameter->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTypeParameter->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTypeParameter->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointTypeParameter->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointTypeParameter->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTypeParameter->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTypeParameter->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointTypeParameter->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointTypeParameter->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTypeParameter->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTypeParameter->PermissionTree_Description" }, "monitoringPointTypeId": { "title": "monitoringPointTypeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointTypeParameter->MonitoringPointType_Id" }, "monitoringPointTypeCode": { "title": "monitoringPointTypeCode", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTypeParameter->MonitoringPointType_Code" }, "monitoringPointTypeDescription": { "title": "monitoringPointTypeDescription", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTypeParameter->MonitoringPointType_Description" }, "parameterName": { "title": "parameterName", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTypeParameter->ParameterName" }, "parameterValue": { "title": "parameterValue", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTypeParameter->ParameterValue" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTypeParameter->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointTypeParameter->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "GetMonitoringPointTypeParameterCollectionResourceActionResponse": { "title": "GetMonitoringPointTypeParameterCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMonitoringPointTypeParameterCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMonitoringPointTypeParameterCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "parameterName": { "title": "parameterName", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTypeParameter->ParameterName" }, "parameterValue": { "title": "parameterValue", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTypeParameter->ParameterValue" }, "monitoringPointTypeId": { "title": "monitoringPointTypeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "MonitoringPointTypeParameter->MonitoringPointType_Id" }, "monitoringPointTypeCode": { "title": "monitoringPointTypeCode", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTypeParameter->MonitoringPointType_Code" }, "monitoringPointTypeDescription": { "title": "monitoringPointTypeDescription", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTypeParameter->MonitoringPointType_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointTypeParameter->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointTypeParameter->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "GetMonitoringPointTypeParameterForMonitoringPointTypeCollectionResourceActionResponse": { "title": "GetMonitoringPointTypeParameterForMonitoringPointTypeCollectionResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMonitoringPointTypeParameterForMonitoringPointTypeCollectionResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "GetMonitoringPointTypeParameterForMonitoringPointTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "parameterName": { "title": "parameterName", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTypeParameter->ParameterName" }, "parameterValue": { "title": "parameterValue", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointTypeParameter->ParameterValue" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointTypeParameter->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MonitoringPointTypeParameter->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointTypeParameterChangePermissionTreeLookupResourceActionResponse": { "title": "MonitoringPointTypeParameterChangePermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointTypeParameterChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointTypeParameterChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointTypeParameterInsertPermissionTreeLookupResourceActionResponse": { "title": "MonitoringPointTypeParameterInsertPermissionTreeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointTypeParameterInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointTypeParameterInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "MonitoringPointTypeParameterMonitoringPointTypeLookupResourceActionResponse": { "title": "MonitoringPointTypeParameterMonitoringPointTypeLookupResourceActionResponse", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "self": { "$ref": "#/components/schemas/Link" }, "next": { "$ref": "#/components/schemas/Link" }, "prev": { "$ref": "#/components/schemas/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MonitoringPointTypeParameterMonitoringPointTypeLookupResourceActionResponseItem", "type": "object", "additionalProperties": false, "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "description": "Id of the entity", "format": "int64", "example": 5000001018 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity", "format": "int32", "nullable": true, "example": 2 }, "properties": { "title": "MonitoringPointTypeParameterMonitoringPointTypeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointType->Code" }, "description": { "title": "description", "type": "string", "nullable": false, "x-propertyPath": "MonitoringPointType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "nullable": true, "items": { "$ref": "#/components/schemas/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } } } }, "CreateMonitoringPointTypeParameterResourceActionRequest": { "title": "CreateMonitoringPointTypeParameterResourceActionRequest", "type": "object", "additionalProperties": false, "properties": { "properties": { "title": "CreateMonitoringPointTypeParameterResourceActionRequestProperties", "type": "object", "nullable": false, "additionalProperties": false, "required": [ "parameterName", "parameterValue", "monitoringPointTypeId" ], "properties": { "parameterName": { "title": "parameterName", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "MonitoringPointTypeParameter->ParameterName" }, "parameterValue": { "title": "parameterValue", "type": "string", "maxLength": 100, "minLength": 1, "nullable": false, "x-propertyPath": "MonitoringPointTypeParameter->ParameterValue" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointTypeParameter->PermissionTree_Id", "x-systemGenerated": true }, "monitoringPointTypeId": { "title": "monitoringPointTypeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointTypeParameter->MonitoringPointType_Id" }, "notes": { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTypeParameter->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointTypeParameter->SequenceNumber" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "nullable": true } } }, "UpdateMonitoringPointTypeParameterResourceActionRequest": { "title": "UpdateMonitoringPointTypeParameterResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "parameterName", "type": "string", "maxLength": 50, "minLength": 1, "nullable": false, "x-propertyPath": "MonitoringPointTypeParameter->ParameterName" }, { "title": "parameterValue", "type": "string", "maxLength": 100, "minLength": 1, "nullable": false, "x-propertyPath": "MonitoringPointTypeParameter->ParameterValue" }, { "title": "notes", "type": "string", "nullable": true, "x-propertyPath": "MonitoringPointTypeParameter->Notes" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "nullable": true, "x-propertyPath": "MonitoringPointTypeParameter->SequenceNumber" } ] } } }, "DeleteMonitoringPointTypeParameterResourceActionRequest": { "title": "DeleteMonitoringPointTypeParameterResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to delete. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetMonitoringPointTypeParameterResourceAction": { "title": "BatchGetMonitoringPointTypeParameterResourceAction", "type": "object", "additionalProperties": false, "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Monitoring Point Type Parameter entities in the collection", "format": "int32", "nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Monitoring Point Type Parameter entities", "items": { "$ref": "#/components/schemas/GetMonitoringPointTypeParameterResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/components/schemas/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "nullable": true, "items": { "$ref": "#/components/schemas/NotificationSchema" } }, "self": { "$ref": "#/components/schemas/Link" } } }, "BatchCreateMonitoringPointTypeParameterResourceActionRequest": { "title": "BatchCreateMonitoringPointTypeParameterResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/CreateMonitoringPointTypeParameterResourceActionRequest" } }, "BatchUpdateMonitoringPointTypeParameterResourceActionRequest": { "title": "BatchUpdateMonitoringPointTypeParameterResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/UpdateMonitoringPointTypeParameterResourceActionRequest" } }, "BatchDeleteMonitoringPointTypeParameterResourceActionRequest": { "title": "BatchDeleteMonitoringPointTypeParameterResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/DeleteMonitoringPointTypeParameterResourceActionRequest" } }, "ChangeMonitoringPointTypeParameterPermissionTreeResourceActionRequest": { "title": "ChangeMonitoringPointTypeParameterPermissionTreeResourceActionRequest", "type": "object", "additionalProperties": false, "required": [ "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch. Only required for batch operations as non-batch operations specify the id in the url.", "format": "int64", "nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 }, "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entity", "items": { "$ref": "#/components/schemas/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "nullable": false, "x-propertyPath": "MonitoringPointTypeParameter->PermissionTree_Id" } ] } } }, "BatchChangeMonitoringPointTypeParameterPermissionTreeResourceActionRequest": { "title": "BatchChangeMonitoringPointTypeParameterPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/components/schemas/ChangeMonitoringPointTypeParameterPermissionTreeResourceActionRequest" } } }, "responses": { "default": { "description": "Error response - operation failed" }, "created": { "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "description": "Id of the resource created", "schema": { "type": "integer", "format": "Int64" }, "example": 1582413583401002 }, "OnKey-Resource-Location": { "description": "Uri to fetch the created resource", "schema": { "type": "string" }, "example": "/api/tenants/{client}/{connection}/Modules/GEN/Languages/1582413583401002" } } }, "accepted": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "description": "Request id for the Background Task created", "schema": { "type": "integer", "format": "Int64" }, "example": 1582413583401002 }, "OnKey-Request-Location": { "description": "URI to poll for the asynchronous execution status of the request", "schema": { "type": "string" }, "example": "/api/tenants/{client}/{connection}/Modules/System/BackgroundTasks/1582413583401002" } } }, "scheduled": { "description": "Request was successfully scheduled for asynchronous execution using a Scheduled Background Task", "headers": { "OnKey-Resource-Id": { "description": "Id of the Scheduled Background Task resource created", "schema": { "type": "integer", "format": "Int64" }, "example": 1582413583401002 }, "OnKey-Resource-Location": { "description": "Uri to fetch the Scheduled Background Task resource", "schema": { "type": "string" }, "example": "/api/tenants/{client}/{connection}/Modules/System/ScheduledBackgroundTasks/1582413583401002" }, "OnKey-Job-Id": { "description": "Job id of the job schedule created", "schema": { "type": "string", "format": "Uuid" }, "example": "cc4820be-e990-4161-85ff-eec4bbde2acb" }, "OnKey-Job-Schedule-Location": { "description": "URI to fetch the job schedule for the asynchronous execution of the request", "schema": { "type": "string" }, "example": "/api/tenants/{client}/{connection}/Modules/System/Jobs/cc4820be-e990-4161-85ff-eec4bbde2acb/Schedule" } } } }, "parameters": { "ExecutionMode": { "name": "mode", "in": "query", "description": "Execution mode to use for executing the batch operation", "schema": { "$ref": "#/components/schemas/OperationExecutionMode" } }, "Async": { "name": "async", "in": "query", "description": "Enqueue the operation asynchronously using a Background Task.", "schema": { "type": "boolean" } }, "AsyncDescription": { "name": "description", "in": "query", "description": "Optional description for the asynchronous execution of the Background Task.", "schema": { "type": "string", "nullable": true } }, "Schedule": { "name": "schedule", "in": "query", "description": "Optional cron expression to schedule the asynchronous execution of the Background Task.", "schema": { "type": "string", "nullable": true } }, "ScheduleFrom": { "name": "from", "in": "query", "description": "Optional future date at which a recurring schedule for the asynchronous execution of the Background Task should start. If no value is provided the current UTC date and time is used.", "schema": { "type": "string", "nullable": true } }, "Filter": { "name": "$filter", "in": "query", "description": "Filter expression to apply on the resource to limit the response data returned, e.g. $filter=id gt 0 and code startswith 'ABCD'", "schema": { "type": "string", "nullable": true } }, "OrderBy": { "name": "$orderby", "in": "query", "description": "Comma separated list of the data properties on the resource to order the response data returned, e.g. $orderby=id DESC,code ASC", "schema": { "type": "string", "nullable": true } }, "Param": { "name": "$param", "in": "query", "description": "Comma separated list of key/value pairs to parameterise `$filter` expressions to limit the response data returned, e.g. $param=@code:'JUMA'", "schema": { "type": "string", "nullable": true } }, "Select": { "name": "$select", "in": "query", "description": "Comma separated list of the data properties on the resource to return, e.g. $select=id,code,description", "schema": { "type": "string", "nullable": true } }, "Skip": { "name": "$skip", "in": "query", "description": "Number of items to skip. Use in combination with `$top` to page through the response data returned, e.g. $skip=20", "schema": { "type": "string", "nullable": true } }, "Top": { "name": "$top", "in": "query", "description": "Number of items to return in the response data, e.g. $top=20", "schema": { "type": "string", "nullable": true } } }, "securitySchemes": { "Bearer": { "type": "http", "description": "Use the JWT access token received by authenticating with your configured On Key Identity Provider", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [ { "Bearer": [] } ], "tags": [ { "name": "Alarm" }, { "name": "Alarm Attribute" }, { "name": "Alarm Document" }, { "name": "Alarm Expression" }, { "name": "Alarm Expression Task" }, { "name": "Alarm Type" }, { "name": "Monitoring Point" }, { "name": "Monitoring Point Attribute" }, { "name": "Monitoring Point Bound Evaluation Log" }, { "name": "Monitoring Point Document" }, { "name": "Monitoring Point Parameter" }, { "name": "Monitoring Point Reading" }, { "name": "Monitoring Point Trigger" }, { "name": "Monitoring Point Trigger Expression" }, { "name": "Monitoring Point Trigger Expression Alarm Type" }, { "name": "Monitoring Point Trigger Expression Evaluation" }, { "name": "Monitoring Point Trigger Expression Evaluation Log" }, { "name": "Monitoring Point Trigger Expression Parameter" }, { "name": "Monitoring Point Type" }, { "name": "Monitoring Point Type Parameter" } ], "x-tagGroups": [ { "name": "AHM", "tags": [ "Alarm", "Alarm Attribute", "Alarm Document", "Alarm Expression", "Alarm Expression Task", "Alarm Type", "Monitoring Point", "Monitoring Point Attribute", "Monitoring Point Bound Evaluation Log", "Monitoring Point Document", "Monitoring Point Parameter", "Monitoring Point Reading", "Monitoring Point Trigger", "Monitoring Point Trigger Expression", "Monitoring Point Trigger Expression Alarm Type", "Monitoring Point Trigger Expression Evaluation", "Monitoring Point Trigger Expression Evaluation Log", "Monitoring Point Trigger Expression Parameter", "Monitoring Point Type", "Monitoring Point Type Parameter" ] } ] }