{ "x-generator": "On Key REST API Docs Generator", "swagger": "2.0", "info": { "title": "On Key AOM 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" }, "host": ":443", "basePath": "/api/tenants/{client}/{connection}", "schemes": [ "https" ], "consumes": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.entitypatch+json", "application/vnd.onkey.entitydelete+json", "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.entitypatchcollection+json", "application/vnd.onkey.entitydeletecollection+json", "application/vnd.onkey.entitymatchupdatecollection+json" ], "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json", "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.entitycollection+json" ], "paths": { "/Modules/AOM/Consumables/{id}": { "get": { "tags": [ "Consumable" ], "summary": "Get a Consumable 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 | Consumable->Code | string | |\r\n| isActive | Consumable->IsActive | boolean | |\r\n| createdByUserId | Consumable->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Consumable->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Consumable->CreatedByUser_FullName | string | |\r\n| createdOn | Consumable->CreatedOn | string | date-time |\r\n| modifiedByUserId | Consumable->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Consumable->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Consumable->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Consumable->ModifiedOn | string | date-time |\r\n| version | Consumable->Version | integer | int32 |\r\n| permissionTreeId | Consumable->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Consumable->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Consumable->PermissionTree_Description | string | |\r\n| siteId | Consumable->Site_Id | integer | int64 |\r\n| siteCode | Consumable->Site_Code | string | |\r\n| siteDescription | Consumable->Site_Description | string | |\r\n| id | Consumable->Id | integer | int64 |\r\n| currencyId | Consumable->Currency_Id | integer | int64 |\r\n| currencyCode | Consumable->Currency_Code | string | |\r\n| currencyDescription | Consumable->Currency_Description | string | |\r\n| description | Consumable->Description | string | |\r\n| notes | Consumable->Notes | string | |\r\n| unitOfMeasurementId | Consumable->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | Consumable->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | Consumable->UnitOfMeasurement_Description | string | |\r\n| unitPrice | Consumable->UnitPrice | number | decimal |\r\n", "operationId": "GetConsumable", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Consumable Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Consumable", "schema": { "$ref": "#/definitions/GetConsumableResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Consumable" ], "summary": "Update an existing Consumable 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 | Consumable->Version | integer | int32 |\r\n| code | Consumable->Code | string | |\r\n| currencyId | Consumable->Currency_Id | integer | int64 |\r\n| description | Consumable->Description | string | |\r\n| notes | Consumable->Notes | string | |\r\n| siteId | Consumable->Site_Id | integer | int64 |\r\n| unitOfMeasurementId | Consumable->UnitOfMeasurement_Id | integer | int64 |\r\n| unitPrice | Consumable->UnitPrice | number | decimal |\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| unitPrice | Min Value | >= 0| |\r\n\r\n", "operationId": "UpdateConsumable", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Consumable Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateConsumableResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Consumable was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Consumable" ], "summary": "Delete an existing Consumable 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 | Consumable->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": "DeleteConsumable", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Consumable Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteConsumableResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Consumable was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Consumables": { "get": { "tags": [ "Consumable" ], "summary": "Get a collection of Consumable 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 | Consumable->Version | integer | int32 |\r\n| id | Consumable->Id | integer | int64 |\r\n| code | Consumable->Code | string | |\r\n| currencyId | Consumable->Currency_Id | integer | int64 |\r\n| currencyCode | Consumable->Currency_Code | string | |\r\n| currencyDescription | Consumable->Currency_Description | string | |\r\n| description | Consumable->Description | string | |\r\n| isActive | Consumable->IsActive | boolean | |\r\n| siteId | Consumable->Site_Id | integer | int64 |\r\n| siteCode | Consumable->Site_Code | string | |\r\n| siteDescription | Consumable->Site_Description | string | |\r\n| unitPrice | Consumable->UnitPrice | number | decimal |\r\n| unitOfMeasurementId | Consumable->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | Consumable->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | Consumable->UnitOfMeasurement_Description | string | |\r\n| notes | Consumable->Notes | string | |\r\n| createdOn | Consumable->CreatedOn | string | date-time |\r\n| modifiedOn | Consumable->ModifiedOn | string | date-time |\r\n", "operationId": "GetConsumableCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Consumable collection", "schema": { "$ref": "#/definitions/GetConsumableCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Consumable" ], "summary": "Create a new Consumable 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 | Consumable->Code | string | |\r\n| currencyId | Consumable->Currency_Id | integer | int64 |\r\n| description | Consumable->Description | string | |\r\n| notes | Consumable->Notes | string | |\r\n| permissionTreeId | Consumable->PermissionTree_Id | integer | int64 |\r\n| siteId | Consumable->Site_Id | integer | int64 |\r\n| unitOfMeasurementId | Consumable->UnitOfMeasurement_Id | integer | int64 |\r\n| unitPrice | Consumable->UnitPrice | number | decimal |\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| unitPrice | Min Value | >= 0| |\r\n\r\n", "operationId": "CreateConsumable", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateConsumableResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Consumables/Lookups/LookupConsumableChangePermissionTree": { "get": { "tags": [ "Consumable" ], "summary": "Lookup the permission set for changing the Consumable.", "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": "LookupConsumableChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/ConsumableChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Consumables/Lookups/LookupConsumableCurrency": { "get": { "tags": [ "Consumable" ], "summary": "Lookup Currency for the Consumable", "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 | Currency->Id | integer | int64 |\r\n| code | Currency->Code | string | |\r\n| description | Currency->Description | string | |\r\n", "operationId": "LookupConsumableCurrency", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Currency collection", "schema": { "$ref": "#/definitions/ConsumableCurrencyLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Consumables/Lookups/LookupConsumableInsertPermissionTree": { "get": { "tags": [ "Consumable" ], "summary": "Lookup the permission set for creating the Consumable.", "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": "LookupConsumableInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/ConsumableInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Consumables/Lookups/LookupConsumableSite": { "get": { "tags": [ "Consumable" ], "summary": "Lookup the Site for the Consumable.", "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 | Site->Id | integer | int64 |\r\n| code | Site->Code | string | |\r\n| description | Site->Description | string | |\r\n| currencyId | Site->Currency_Id | integer | int64 |\r\n| currencyCode | Site->Currency_Code | string | |\r\n| currencyDescription | Site->Currency_Description | string | |\r\n", "operationId": "LookupConsumableSite", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Site collection", "schema": { "$ref": "#/definitions/ConsumableSiteLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Consumables/Lookups/LookupConsumableUnitOfMeasurement": { "get": { "tags": [ "Consumable" ], "summary": "Lookup the Unit Of Measurement for the Consumable.", "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": "LookupConsumableUnitOfMeasurement", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Unit Of Measurement collection", "schema": { "$ref": "#/definitions/ConsumableUnitOfMeasurementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Consumables/Batch/{ids}": { "get": { "tags": [ "Consumable" ], "summary": "Get a collection of Consumable 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 | Consumable->Code | string | |\r\n| isActive | Consumable->IsActive | boolean | |\r\n| createdByUserId | Consumable->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Consumable->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Consumable->CreatedByUser_FullName | string | |\r\n| createdOn | Consumable->CreatedOn | string | date-time |\r\n| modifiedByUserId | Consumable->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Consumable->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Consumable->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Consumable->ModifiedOn | string | date-time |\r\n| version | Consumable->Version | integer | int32 |\r\n| permissionTreeId | Consumable->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Consumable->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Consumable->PermissionTree_Description | string | |\r\n| siteId | Consumable->Site_Id | integer | int64 |\r\n| siteCode | Consumable->Site_Code | string | |\r\n| siteDescription | Consumable->Site_Description | string | |\r\n| id | Consumable->Id | integer | int64 |\r\n| currencyId | Consumable->Currency_Id | integer | int64 |\r\n| currencyCode | Consumable->Currency_Code | string | |\r\n| currencyDescription | Consumable->Currency_Description | string | |\r\n| description | Consumable->Description | string | |\r\n| notes | Consumable->Notes | string | |\r\n| unitOfMeasurementId | Consumable->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | Consumable->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | Consumable->UnitOfMeasurement_Description | string | |\r\n| unitPrice | Consumable->UnitPrice | number | decimal |\r\n", "operationId": "BatchGetConsumable", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Consumable id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Consumable collection", "schema": { "$ref": "#/definitions/BatchGetConsumableResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Consumables/Batch": { "post": { "tags": [ "Consumable" ], "summary": "Create a new collection of Consumable 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 | Consumable->Code | string | |\r\n| currencyId | Consumable->Currency_Id | integer | int64 |\r\n| description | Consumable->Description | string | |\r\n| notes | Consumable->Notes | string | |\r\n| permissionTreeId | Consumable->PermissionTree_Id | integer | int64 |\r\n| siteId | Consumable->Site_Id | integer | int64 |\r\n| unitOfMeasurementId | Consumable->UnitOfMeasurement_Id | integer | int64 |\r\n| unitPrice | Consumable->UnitPrice | number | decimal |\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| unitPrice | Min Value | >= 0| |\r\n\r\n", "operationId": "BatchCreateConsumable", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateConsumableResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Consumable batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Consumable" ], "summary": "Update a collection of existing Consumable 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 | Consumable->Id | integer | int64 |\r\n| version | Consumable->Version | integer | int32 |\r\n| code | Consumable->Code | string | |\r\n| currencyId | Consumable->Currency_Id | integer | int64 |\r\n| description | Consumable->Description | string | |\r\n| notes | Consumable->Notes | string | |\r\n| siteId | Consumable->Site_Id | integer | int64 |\r\n| unitOfMeasurementId | Consumable->UnitOfMeasurement_Id | integer | int64 |\r\n| unitPrice | Consumable->UnitPrice | number | decimal |\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| unitPrice | Min Value | >= 0| |\r\n\r\n", "operationId": "BatchUpdateConsumable", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateConsumableResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Consumable batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Consumable" ], "summary": "Delete a collection of existing Consumable 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 | Consumable->Id | integer | int64 |\r\n| version | Consumable->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": "BatchDeleteConsumable", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteConsumableResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Consumable batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Consumables/{id}/Active": { "patch": { "tags": [ "Consumable" ], "summary": "Change the IsActive status for an existing Consumable 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 | Consumable->Version | integer | int32 |\r\n| isActive | Consumable->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": "ChangeConsumableIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Consumable Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeConsumableIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Consumables/{id}/PermissionTree": { "patch": { "tags": [ "Consumable" ], "summary": "Change the PermissionTree for an existing Consumable 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 | Consumable->Version | integer | int32 |\r\n| permissionTreeId | Consumable->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": "ChangeConsumablePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Consumable Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeConsumablePermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Consumables/Batch/Active": { "patch": { "tags": [ "Consumable" ], "summary": "Change the IsActive status for a collection of existing Consumable 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 | Consumable->Id | integer | int64 |\r\n| version | Consumable->Version | integer | int32 |\r\n| isActive | Consumable->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": "BatchChangeConsumableIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeConsumableIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Consumables/Batch/PermissionTree": { "patch": { "tags": [ "Consumable" ], "summary": "Change the PermissionTree status for a collection of existing Consumable 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 | Consumable->Id | integer | int64 |\r\n| version | Consumable->Version | integer | int32 |\r\n| permissionTreeId | Consumable->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": "BatchChangeConsumablePermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeConsumablePermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/{id}": { "get": { "tags": [ "Meter" ], "summary": "Get a Meter 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 | Meter->Code | string | |\r\n| isActive | Meter->IsActive | boolean | |\r\n| createdByUserId | Meter->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Meter->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Meter->CreatedByUser_FullName | string | |\r\n| createdOn | Meter->CreatedOn | string | date-time |\r\n| modifiedByUserId | Meter->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Meter->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Meter->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Meter->ModifiedOn | string | date-time |\r\n| version | Meter->Version | integer | int32 |\r\n| permissionTreeId | Meter->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Meter->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Meter->PermissionTree_Description | string | |\r\n| siteId | Meter->Site_Id | integer | int64 |\r\n| siteCode | Meter->Site_Code | string | |\r\n| siteDescription | Meter->Site_Description | string | |\r\n| id | Meter->Id | integer | int64 |\r\n| automaticallyUpdateAverageDailyRate | Meter->AutomaticallyUpdateAverageDailyRate | boolean | |\r\n| autoResetValue | Meter->AutoResetValue | number | decimal |\r\n| averageDailyRate | Meter->AverageDailyRate | number | decimal |\r\n| averageDailyRateCalculationQuantity | Meter->AverageDailyRateCalculationQuantity | integer | int32 |\r\n| averageDailyRateCalculationUnit | Meter->AverageDailyRateCalculationUnit | string (Allowed values: [ReadingCount, Hours, Days, Weeks, Months, Years]) | enum |\r\n| averageDailyRateMaximumValue | Meter->AverageDailyRateMaximumValue | number | decimal |\r\n| averageDailyRateVariancePercentage | Meter->AverageDailyRateVariancePercentage | number | decimal |\r\n| cumulativeReading | Meter->CumulativeReading | number | decimal |\r\n| description | Meter->Description | string | |\r\n| isPaused | Meter->IsPaused | boolean | |\r\n| lastReading | Meter->LastReading | number | decimal |\r\n| lastReadOn | Meter->LastReadOn | string | date-time |\r\n| lastResetOn | Meter->LastResetOn | string | date-time |\r\n| lastResetReading | Meter->LastResetReading | number | decimal |\r\n| notes | Meter->Notes | string | |\r\n| pmrStatus | Meter->PmrStatus | string (Allowed values: [LatestMeterReadingNotValid, NotUsedByTask, MeterIsInActive, AdrIsZero, Generated, GenerationRequired]) | enum |\r\n| pmrStatusChangedOn | Meter->PmrStatusChangedOn | string | date-time |\r\n| unitOfMeasurementId | Meter->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | Meter->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | Meter->UnitOfMeasurement_Description | string | |\r\n| validateAverageDailyRateMaximumValue | Meter->ValidateAverageDailyRateMaximumValue | boolean | |\r\n| validateAverageDailyRateVariancePercentage | Meter->ValidateAverageDailyRateVariancePercentage | string (Allowed values: [SystemOption, Yes, No]) | enum |\r\n| validateReadings | Meter->ValidateReadings | boolean | |\r\n", "operationId": "GetMeter", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Meter Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Meter", "schema": { "$ref": "#/definitions/GetMeterResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Meter" ], "summary": "Update an existing Meter 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 | Meter->Version | integer | int32 |\r\n| code | Meter->Code | string | |\r\n| description | Meter->Description | string | |\r\n| unitOfMeasurementId | Meter->UnitOfMeasurement_Id | integer | int64 |\r\n| autoResetValue | Meter->AutoResetValue | number | decimal |\r\n| automaticallyUpdateAverageDailyRate | Meter->AutomaticallyUpdateAverageDailyRate | boolean | |\r\n| averageDailyRateCalculationQuantity | Meter->AverageDailyRateCalculationQuantity | integer | int32 |\r\n| averageDailyRateCalculationUnit | Meter->AverageDailyRateCalculationUnit | string (Allowed values: [ReadingCount, Hours, Days, Weeks, Months, Years]) | enum |\r\n| averageDailyRate | Meter->AverageDailyRate | number | decimal |\r\n| siteId | Meter->Site_Id | integer | int64 |\r\n| validateReadings | Meter->ValidateReadings | boolean | |\r\n| validateAverageDailyRateVariancePercentage | Meter->ValidateAverageDailyRateVariancePercentage | string (Allowed values: [SystemOption, Yes, No]) | enum |\r\n| averageDailyRateVariancePercentage | Meter->AverageDailyRateVariancePercentage | number | decimal |\r\n| validateAverageDailyRateMaximumValue | Meter->ValidateAverageDailyRateMaximumValue | boolean | |\r\n| averageDailyRateMaximumValue | Meter->AverageDailyRateMaximumValue | number | decimal |\r\n| notes | Meter->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| unitOfMeasurementId | Nullable | False | |\r\n| autoResetValue | Nullable | True | |\r\n| automaticallyUpdateAverageDailyRate | Nullable | False | |\r\n| averageDailyRate | Min Value | >= 0| |\r\n| validateAverageDailyRateVariancePercentage | Nullable | False | |\r\n| averageDailyRateVariancePercentage | Nullable | False | Meter->ValidateAverageDailyRateVariancePercentage eq 'Yes' |\r\n| validateAverageDailyRateMaximumValue | Nullable | False | |\r\n| averageDailyRateMaximumValue | Nullable | False | Meter->ValidateAverageDailyRateMaximumValue eq true |\r\n\r\n", "operationId": "UpdateMeter", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Meter Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateMeterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Meter was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Meter" ], "summary": "Delete an existing Meter 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 | Meter->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": "DeleteMeter", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Meter Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteMeterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Meter was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters": { "get": { "tags": [ "Meter" ], "summary": "Get a collection of Meter 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 | Meter->Version | integer | int32 |\r\n| id | Meter->Id | integer | int64 |\r\n| code | Meter->Code | string | |\r\n| description | Meter->Description | string | |\r\n| isActive | Meter->IsActive | boolean | |\r\n| isPaused | Meter->IsPaused | boolean | |\r\n| autoResetValue | Meter->AutoResetValue | number | decimal |\r\n| automaticallyUpdateAverageDailyRate | Meter->AutomaticallyUpdateAverageDailyRate | boolean | |\r\n| averageDailyRateCalculationQuantity | Meter->AverageDailyRateCalculationQuantity | integer | int32 |\r\n| averageDailyRateCalculationUnit | Meter->AverageDailyRateCalculationUnit | string (Allowed values: [ReadingCount, Hours, Days, Weeks, Months, Years]) | enum |\r\n| averageDailyRate | Meter->AverageDailyRate | number | decimal |\r\n| notes | Meter->Notes | string | |\r\n| siteId | Meter->Site_Id | integer | int64 |\r\n| siteCode | Meter->Site_Code | string | |\r\n| siteDescription | Meter->Site_Description | string | |\r\n| unitOfMeasurementId | Meter->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | Meter->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | Meter->UnitOfMeasurement_Description | string | |\r\n| createdOn | Meter->CreatedOn | string | date-time |\r\n| modifiedOn | Meter->ModifiedOn | string | date-time |\r\n", "operationId": "GetMeterCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Meter collection", "schema": { "$ref": "#/definitions/GetMeterCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Meter" ], "summary": "Create a new Meter 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| autoResetValue | Meter->AutoResetValue | number | decimal |\r\n| automaticallyUpdateAverageDailyRate | Meter->AutomaticallyUpdateAverageDailyRate | boolean | |\r\n| averageDailyRateCalculationQuantity | Meter->AverageDailyRateCalculationQuantity | integer | int32 |\r\n| averageDailyRateCalculationUnit | Meter->AverageDailyRateCalculationUnit | string (Allowed values: [ReadingCount, Hours, Days, Weeks, Months, Years]) | enum |\r\n| averageDailyRateMaximumValue | Meter->AverageDailyRateMaximumValue | number | decimal |\r\n| averageDailyRateVariancePercentage | Meter->AverageDailyRateVariancePercentage | number | decimal |\r\n| code | Meter->Code | string | |\r\n| description | Meter->Description | string | |\r\n| isPaused | Meter->IsPaused | boolean | |\r\n| notes | Meter->Notes | string | |\r\n| permissionTreeId | Meter->PermissionTree_Id | integer | int64 |\r\n| siteId | Meter->Site_Id | integer | int64 |\r\n| unitOfMeasurementId | Meter->UnitOfMeasurement_Id | integer | int64 |\r\n| validateAverageDailyRateMaximumValue | Meter->ValidateAverageDailyRateMaximumValue | boolean | |\r\n| validateAverageDailyRateVariancePercentage | Meter->ValidateAverageDailyRateVariancePercentage | string (Allowed values: [SystemOption, Yes, No]) | enum |\r\n| validateReadings | Meter->ValidateReadings | 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| autoResetValue | Nullable | True | |\r\n| automaticallyUpdateAverageDailyRate | Nullable | False | |\r\n| averageDailyRateMaximumValue | Nullable | False | Meter->ValidateAverageDailyRateMaximumValue eq true |\r\n| averageDailyRateVariancePercentage | Nullable | False | Meter->ValidateAverageDailyRateVariancePercentage eq 'Yes' |\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 | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| unitOfMeasurementId | Required | True | |\r\n| unitOfMeasurementId | Nullable | False | |\r\n| validateAverageDailyRateMaximumValue | Nullable | False | |\r\n| validateAverageDailyRateVariancePercentage | Nullable | False | |\r\n\r\n", "operationId": "CreateMeter", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateMeterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Lookups/LookupMeterChangePermissionTree": { "get": { "tags": [ "Meter" ], "summary": "Lookup the permission set for changing the Meter.", "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": "LookupMeterChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/MeterChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Lookups/LookupMeterInsertPermissionTree": { "get": { "tags": [ "Meter" ], "summary": "Lookup the permission set for creating the Meter.", "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": "LookupMeterInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/MeterInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Lookups/LookupMeterSite": { "get": { "tags": [ "Meter" ], "summary": "Lookup the Site for the Meter.", "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 | Site->Id | integer | int64 |\r\n| code | Site->Code | string | |\r\n| description | Site->Description | string | |\r\n", "operationId": "LookupMeterSite", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Site collection", "schema": { "$ref": "#/definitions/MeterSiteLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Lookups/LookupMeterUnitOfMeasurement": { "get": { "tags": [ "Meter" ], "summary": "Lookup the Unit Of Measurement for the Meter.", "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": "LookupMeterUnitOfMeasurement", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Unit Of Measurement collection", "schema": { "$ref": "#/definitions/MeterUnitOfMeasurementLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Batch/{ids}": { "get": { "tags": [ "Meter" ], "summary": "Get a collection of Meter 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 | Meter->Code | string | |\r\n| isActive | Meter->IsActive | boolean | |\r\n| createdByUserId | Meter->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | Meter->CreatedByUser_Code | string | |\r\n| createdByUserFullName | Meter->CreatedByUser_FullName | string | |\r\n| createdOn | Meter->CreatedOn | string | date-time |\r\n| modifiedByUserId | Meter->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | Meter->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | Meter->ModifiedByUser_FullName | string | |\r\n| modifiedOn | Meter->ModifiedOn | string | date-time |\r\n| version | Meter->Version | integer | int32 |\r\n| permissionTreeId | Meter->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | Meter->PermissionTree_Code | string | |\r\n| permissionTreeDescription | Meter->PermissionTree_Description | string | |\r\n| siteId | Meter->Site_Id | integer | int64 |\r\n| siteCode | Meter->Site_Code | string | |\r\n| siteDescription | Meter->Site_Description | string | |\r\n| id | Meter->Id | integer | int64 |\r\n| automaticallyUpdateAverageDailyRate | Meter->AutomaticallyUpdateAverageDailyRate | boolean | |\r\n| autoResetValue | Meter->AutoResetValue | number | decimal |\r\n| averageDailyRate | Meter->AverageDailyRate | number | decimal |\r\n| averageDailyRateCalculationQuantity | Meter->AverageDailyRateCalculationQuantity | integer | int32 |\r\n| averageDailyRateCalculationUnit | Meter->AverageDailyRateCalculationUnit | string (Allowed values: [ReadingCount, Hours, Days, Weeks, Months, Years]) | enum |\r\n| averageDailyRateMaximumValue | Meter->AverageDailyRateMaximumValue | number | decimal |\r\n| averageDailyRateVariancePercentage | Meter->AverageDailyRateVariancePercentage | number | decimal |\r\n| cumulativeReading | Meter->CumulativeReading | number | decimal |\r\n| description | Meter->Description | string | |\r\n| isPaused | Meter->IsPaused | boolean | |\r\n| lastReading | Meter->LastReading | number | decimal |\r\n| lastReadOn | Meter->LastReadOn | string | date-time |\r\n| lastResetOn | Meter->LastResetOn | string | date-time |\r\n| lastResetReading | Meter->LastResetReading | number | decimal |\r\n| notes | Meter->Notes | string | |\r\n| pmrStatus | Meter->PmrStatus | string (Allowed values: [LatestMeterReadingNotValid, NotUsedByTask, MeterIsInActive, AdrIsZero, Generated, GenerationRequired]) | enum |\r\n| pmrStatusChangedOn | Meter->PmrStatusChangedOn | string | date-time |\r\n| unitOfMeasurementId | Meter->UnitOfMeasurement_Id | integer | int64 |\r\n| unitOfMeasurementCode | Meter->UnitOfMeasurement_Code | string | |\r\n| unitOfMeasurementDescription | Meter->UnitOfMeasurement_Description | string | |\r\n| validateAverageDailyRateMaximumValue | Meter->ValidateAverageDailyRateMaximumValue | boolean | |\r\n| validateAverageDailyRateVariancePercentage | Meter->ValidateAverageDailyRateVariancePercentage | string (Allowed values: [SystemOption, Yes, No]) | enum |\r\n| validateReadings | Meter->ValidateReadings | boolean | |\r\n", "operationId": "BatchGetMeter", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Meter id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Meter collection", "schema": { "$ref": "#/definitions/BatchGetMeterResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Batch": { "post": { "tags": [ "Meter" ], "summary": "Create a new collection of Meter 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| autoResetValue | Meter->AutoResetValue | number | decimal |\r\n| automaticallyUpdateAverageDailyRate | Meter->AutomaticallyUpdateAverageDailyRate | boolean | |\r\n| averageDailyRateCalculationQuantity | Meter->AverageDailyRateCalculationQuantity | integer | int32 |\r\n| averageDailyRateCalculationUnit | Meter->AverageDailyRateCalculationUnit | string (Allowed values: [ReadingCount, Hours, Days, Weeks, Months, Years]) | enum |\r\n| averageDailyRateMaximumValue | Meter->AverageDailyRateMaximumValue | number | decimal |\r\n| averageDailyRateVariancePercentage | Meter->AverageDailyRateVariancePercentage | number | decimal |\r\n| code | Meter->Code | string | |\r\n| description | Meter->Description | string | |\r\n| isPaused | Meter->IsPaused | boolean | |\r\n| notes | Meter->Notes | string | |\r\n| permissionTreeId | Meter->PermissionTree_Id | integer | int64 |\r\n| siteId | Meter->Site_Id | integer | int64 |\r\n| unitOfMeasurementId | Meter->UnitOfMeasurement_Id | integer | int64 |\r\n| validateAverageDailyRateMaximumValue | Meter->ValidateAverageDailyRateMaximumValue | boolean | |\r\n| validateAverageDailyRateVariancePercentage | Meter->ValidateAverageDailyRateVariancePercentage | string (Allowed values: [SystemOption, Yes, No]) | enum |\r\n| validateReadings | Meter->ValidateReadings | 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| autoResetValue | Nullable | True | |\r\n| automaticallyUpdateAverageDailyRate | Nullable | False | |\r\n| averageDailyRateMaximumValue | Nullable | False | Meter->ValidateAverageDailyRateMaximumValue eq true |\r\n| averageDailyRateVariancePercentage | Nullable | False | Meter->ValidateAverageDailyRateVariancePercentage eq 'Yes' |\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 | System Generated | true | If no value specified |\r\n| permissionTreeId | Nullable | False | |\r\n| unitOfMeasurementId | Required | True | |\r\n| unitOfMeasurementId | Nullable | False | |\r\n| validateAverageDailyRateMaximumValue | Nullable | False | |\r\n| validateAverageDailyRateVariancePercentage | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateMeter", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateMeterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Meter batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Meter" ], "summary": "Update a collection of existing Meter 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 | Meter->Id | integer | int64 |\r\n| version | Meter->Version | integer | int32 |\r\n| code | Meter->Code | string | |\r\n| description | Meter->Description | string | |\r\n| unitOfMeasurementId | Meter->UnitOfMeasurement_Id | integer | int64 |\r\n| isPaused | Meter->IsPaused | boolean | |\r\n| autoResetValue | Meter->AutoResetValue | number | decimal |\r\n| automaticallyUpdateAverageDailyRate | Meter->AutomaticallyUpdateAverageDailyRate | boolean | |\r\n| averageDailyRateCalculationQuantity | Meter->AverageDailyRateCalculationQuantity | integer | int32 |\r\n| averageDailyRateCalculationUnit | Meter->AverageDailyRateCalculationUnit | string (Allowed values: [ReadingCount, Hours, Days, Weeks, Months, Years]) | enum |\r\n| averageDailyRate | Meter->AverageDailyRate | number | decimal |\r\n| siteId | Meter->Site_Id | integer | int64 |\r\n| validateReadings | Meter->ValidateReadings | boolean | |\r\n| validateAverageDailyRateVariancePercentage | Meter->ValidateAverageDailyRateVariancePercentage | string (Allowed values: [SystemOption, Yes, No]) | enum |\r\n| averageDailyRateVariancePercentage | Meter->AverageDailyRateVariancePercentage | number | decimal |\r\n| validateAverageDailyRateMaximumValue | Meter->ValidateAverageDailyRateMaximumValue | boolean | |\r\n| averageDailyRateMaximumValue | Meter->AverageDailyRateMaximumValue | number | decimal |\r\n| notes | Meter->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| unitOfMeasurementId | Nullable | False | |\r\n| autoResetValue | Nullable | True | |\r\n| automaticallyUpdateAverageDailyRate | Nullable | False | |\r\n| averageDailyRate | Min Value | >= 0| |\r\n| validateAverageDailyRateVariancePercentage | Nullable | False | |\r\n| averageDailyRateVariancePercentage | Nullable | False | Meter->ValidateAverageDailyRateVariancePercentage eq 'Yes' |\r\n| validateAverageDailyRateMaximumValue | Nullable | False | |\r\n| averageDailyRateMaximumValue | Nullable | False | Meter->ValidateAverageDailyRateMaximumValue eq true |\r\n\r\n", "operationId": "BatchUpdateMeter", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateMeterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Meter batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Meter" ], "summary": "Delete a collection of existing Meter 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 | Meter->Id | integer | int64 |\r\n| version | Meter->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": "BatchDeleteMeter", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteMeterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Meter batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/AverageDailyRate/Batch": { "patch": { "tags": [ "Meter" ], "summary": "Batch Change the Average Daily Rate for the Meter.", "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 | ChangeMeterAverageDailyRate->Id | integer | int64 |\r\n| version | ChangeMeterAverageDailyRate->Version | integer | int32 |\r\n| averageDailyRate | ChangeMeterAverageDailyRate->AverageDailyRate | number | decimal |\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| averageDailyRate | Required | True | |\r\n| averageDailyRate | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeMeterAverageDailyRate", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeMeterAverageDailyRateResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Batch/{meterIds}/GeneratePredictedMeterReadings": { "post": { "tags": [ "Meter" ], "summary": "Batch Generate Predicted Meter Readings for Meters", "description": "", "operationId": "BatchGeneratePredictedMeterReadings", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "meterIds", "in": "path", "required": true, "description": "A comma separated list of Meter id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Pause/Batch": { "patch": { "tags": [ "Meter" ], "summary": "Batch Pause the Meter.", "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 | ResumePauseMeter->Id | integer | int64 |\r\n| version | ResumePauseMeter->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": "BatchPauseMeter", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchPauseMeterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Resume/Batch": { "patch": { "tags": [ "Meter" ], "summary": "Batch Resume the Meter.", "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 | ResumePauseMeter->Id | integer | int64 |\r\n| version | ResumePauseMeter->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": "BatchResumeMeter", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchResumeMeterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/{id}/CalculateAverageDailyRate": { "patch": { "tags": [ "Meter" ], "summary": "Calculate the Average Daily Rate for the Meter 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| useConfiguredCalculationUnitAndQuantity | CalculateAverageDailyRate->UseConfiguredCalculationUnitAndQuantity | boolean | |\r\n| averageDailyRateCalculationQuantity | CalculateAverageDailyRate->AverageDailyRateCalculationQuantity | integer | int32 |\r\n| averageDailyRateCalculationUnit | CalculateAverageDailyRate->AverageDailyRateCalculationUnit | string (Allowed values: [ReadingCount, Hours, Days, Weeks, Months, Years]) | 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| useConfiguredCalculationUnitAndQuantity | Required | True | |\r\n| useConfiguredCalculationUnitAndQuantity | Nullable | False | |\r\n\r\n\n### 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| averageDailyRate | CalculateAverageDailyRateResult->AverageDailyRate | number | decimal |\r\n", "operationId": "CalculateAverageDailyRate", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Meter Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CalculateAverageDailyRateResourceActionRequest" } } ], "responses": { "204": { "x-nullable": true, "description": "Success response - body contains Meter", "schema": { "$ref": "#/definitions/CalculateAverageDailyRateResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/{id}/AverageDailyRate": { "patch": { "tags": [ "Meter" ], "summary": "Change the Average Daily Rate for the Meter.", "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 | Meter->Version | integer | int32 |\r\n| averageDailyRate | Meter->AverageDailyRate | number | decimal |\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| averageDailyRate | Required | True | |\r\n| averageDailyRate | Nullable | False | |\r\n| averageDailyRate | Min Value | >= 0| |\r\n\r\n", "operationId": "ChangeMeterAverageDailyRate", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Meter Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeMeterAverageDailyRateResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/{id}/Active": { "patch": { "tags": [ "Meter" ], "summary": "Change the IsActive status for an existing Meter 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 | Meter->Version | integer | int32 |\r\n| isActive | Meter->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": "ChangeMeterIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Meter Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeMeterIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/{id}/PermissionTree": { "patch": { "tags": [ "Meter" ], "summary": "Change the PermissionTree for an existing Meter 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 | Meter->Version | integer | int32 |\r\n| permissionTreeId | Meter->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": "ChangeMeterPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Meter Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeMeterPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/{id}/Site": { "patch": { "tags": [ "Meter" ], "summary": "Change the Site status for an existing Meter 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 | Meter->Version | integer | int32 |\r\n| siteId | Meter->Site_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| siteId | Required | True | |\r\n| siteId | Nullable | False | |\r\n\r\n", "operationId": "ChangeMeterSite", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Meter Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeMeterSiteResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/{id}/Readings": { "delete": { "tags": [ "Meter" ], "summary": "Delete the Meter Readings for the Meter.", "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 | Meter->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": "DeleteReadings", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Meter Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteAllMeterReadingsResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "get": { "tags": [ "Meter Reading" ], "summary": "Get a collection of Meter Reading resources for the Meter.", "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 | MeterReading->Version | integer | int32 |\r\n| id | MeterReading->Id | integer | int64 |\r\n| reading | MeterReading->Reading | number | decimal |\r\n| cumulativeReading | MeterReading->CumulativeReading | number | decimal |\r\n| resetValue | MeterReading->ResetValue | number | decimal |\r\n| resetType | MeterReading->ResetType | string (Allowed values: [Manual, Automatic]) | enum |\r\n| readingOn | MeterReading->ReadingOn | string | date-time |\r\n| isAssetConsumptionReading | MeterReading->IsAssetConsumptionReading | boolean | |\r\n| locationId | MeterReading->Location_Id | integer | int64 |\r\n| locationCode | MeterReading->Location_Code | string | |\r\n| locationDescription | MeterReading->Location_Description | string | |\r\n| siteId | MeterReading->Site_Id | integer | int64 |\r\n| siteCode | MeterReading->Site_Code | string | |\r\n| siteDescription | MeterReading->Site_Description | string | |\r\n", "operationId": "GetMeterReadingForMeterCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Meter Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Meter Reading collection", "schema": { "$ref": "#/definitions/GetMeterReadingForMeterCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/GeneratePredictedMeterReadings/{id}": { "post": { "tags": [ "Meter" ], "summary": "Generate Predicted Meter Readings.", "description": "", "operationId": "GeneratePredictedMeterReadings", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Meter Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/{id}/ManualMeterReset": { "post": { "tags": [ "Meter" ], "summary": "Execute a manual Meter reset.", "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 | ManualMeterReset->Version | integer | int32 |\r\n| lastReading | ManualMeterReset->LastReading | number | decimal |\r\n| firstReading | ManualMeterReset->FirstReading | number | decimal |\r\n| resetDate | ManualMeterReset->ResetDate | string | date-time |\r\n| useLatestReadingAsLastReading | ManualMeterReset->UseLatestReadingAsLastReading | 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| version | Min Value | > 0| |\r\n| lastReading | Min Value | >= 0| |\r\n| firstReading | Nullable | False | |\r\n| firstReading | Min Value | >= 0| |\r\n| resetDate | Required | True | |\r\n| resetDate | Nullable | False | |\r\n| useLatestReadingAsLastReading | Nullable | False | |\r\n\r\n", "operationId": "ManualMeterReset", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Meter Id", "format": "int64", "x-nullable": false }, { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ManualMeterResetResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/{id}/Pause": { "patch": { "tags": [ "Meter" ], "summary": "Pause the Meter.", "description": "", "operationId": "PauseMeter", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Meter Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/{id}/Resume": { "patch": { "tags": [ "Meter" ], "summary": "Resume the Meter.", "description": "", "operationId": "ResumeMeter", "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Meter Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Batch/Active": { "patch": { "tags": [ "Meter" ], "summary": "Change the IsActive status for a collection of existing Meter 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 | Meter->Id | integer | int64 |\r\n| version | Meter->Version | integer | int32 |\r\n| isActive | Meter->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": "BatchChangeMeterIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeMeterIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Batch/PermissionTree": { "patch": { "tags": [ "Meter" ], "summary": "Change the PermissionTree status for a collection of existing Meter 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 | Meter->Id | integer | int64 |\r\n| version | Meter->Version | integer | int32 |\r\n| permissionTreeId | Meter->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": "BatchChangeMeterPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeMeterPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Batch/Site": { "patch": { "tags": [ "Meter" ], "summary": "Change the Site status for a collection of existing Meter 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 | Meter->Id | integer | int64 |\r\n| version | Meter->Version | integer | int32 |\r\n| siteId | Meter->Site_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| siteId | Required | True | |\r\n| siteId | Nullable | False | |\r\n\r\n", "operationId": "BatchChangeMeterSite", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeMeterSiteResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/MatchBatch": { "patch": { "tags": [ "Meter" ], "summary": "Update a collection of existing Meter resources to have the same value(s).", "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 | Meter->Id | integer | int64 |\r\n| version | Meter->Version | integer | int32 |\r\n| unitOfMeasurementId | Meter->UnitOfMeasurement_Id | integer | int64 |\r\n| siteId | Meter->Site_Id | integer | int64 |\r\n| autoResetValue | Meter->AutoResetValue | number | decimal |\r\n| automaticallyUpdateAverageDailyRate | Meter->AutomaticallyUpdateAverageDailyRate | boolean | |\r\n| notes | Meter->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| unitOfMeasurementId | Nullable | False | |\r\n| autoResetValue | Nullable | True | |\r\n| automaticallyUpdateAverageDailyRate | Nullable | False | |\r\n\r\n", "operationId": "MatchUpdateMeter", "consumes": [ "application/vnd.onkey.entitymatchupdatecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "matchUpdate", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/MatchUpdateMeterResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Meter batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Attributes/{id}": { "get": { "tags": [ "Meter Attribute" ], "summary": "Get a Meter 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| meterId | MeterAttribute->Meter_Id | integer | int64 |\r\n| meterCode | MeterAttribute->Meter_Code | string | |\r\n| meterDescription | MeterAttribute->Meter_Description | string | |\r\n| createdByUserId | MeterAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MeterAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MeterAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | MeterAttribute->CreatedOn | string | date-time |\r\n| isActive | MeterAttribute->IsActive | boolean | |\r\n| modifiedByUserId | MeterAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MeterAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MeterAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MeterAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | MeterAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MeterAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MeterAttribute->PermissionTree_Description | string | |\r\n| version | MeterAttribute->Version | integer | int32 |\r\n| id | MeterAttribute->Id | integer | int64 |\r\n| attributeId | MeterAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | MeterAttribute->Attribute_Code | string | |\r\n| attributeDescription | MeterAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | MeterAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | MeterAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | MeterAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | MeterAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | MeterAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | MeterAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | MeterAttribute->Notes | string | |\r\n| predefinedValueId | MeterAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | MeterAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | MeterAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | MeterAttribute->SequenceNumber | integer | int32 |\r\n| value | MeterAttribute->Value | object | composite |\r\n", "operationId": "GetMeterAttribute", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Meter Attribute Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Meter Attribute", "schema": { "$ref": "#/definitions/GetMeterAttributeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Meter Attribute" ], "summary": "Update an existing Meter 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 | MeterAttribute->Version | integer | int32 |\r\n| value | MeterAttribute->Value | object | composite |\r\n| predefinedValueId | MeterAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | MeterAttribute->SequenceNumber | integer | int32 |\r\n| notes | MeterAttribute->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": "UpdateMeterAttribute", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Meter Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateMeterAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Meter Attribute was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Meter Attribute" ], "summary": "Delete an existing Meter 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 | MeterAttribute->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": "DeleteMeterAttribute", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Meter Attribute Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteMeterAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Meter Attribute was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/{meterId}/Attributes": { "get": { "tags": [ "Meter Attribute" ], "summary": "Get a collection of Meter Attribute resources for the Meter.", "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 | MeterAttribute->Id | integer | int64 |\r\n| version | MeterAttribute->Version | integer | int32 |\r\n| sequenceNumber | MeterAttribute->SequenceNumber | integer | int32 |\r\n| attributeId | MeterAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | MeterAttribute->Attribute_Code | string | |\r\n| attributeDescription | MeterAttribute->Attribute_Description | string | |\r\n| attributeDataType | MeterAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | MeterAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | MeterAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | MeterAttribute->PredefinedValue_Value | object | composite |\r\n| value | MeterAttribute->Value | object | composite |\r\n| notes | MeterAttribute->Notes | string | |\r\n| createdOn | MeterAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | MeterAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetMeterAttributeCollectionForMeter", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "meterId", "in": "path", "required": true, "description": "Meter Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Meter Attribute collection", "schema": { "$ref": "#/definitions/GetMeterAttributeCollectionForMeterResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Attributes": { "get": { "tags": [ "Meter Attribute" ], "summary": "Get a collection of Meter 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 | MeterAttribute->Id | integer | int64 |\r\n| version | MeterAttribute->Version | integer | int32 |\r\n| meterId | MeterAttribute->Meter_Id | integer | int64 |\r\n| meterCode | MeterAttribute->Meter_Code | string | |\r\n| meterDescription | MeterAttribute->Meter_Description | string | |\r\n| sequenceNumber | MeterAttribute->SequenceNumber | integer | int32 |\r\n| attributeId | MeterAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | MeterAttribute->Attribute_Code | string | |\r\n| attributeDescription | MeterAttribute->Attribute_Description | string | |\r\n| attributeDataType | MeterAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| predefinedValueId | MeterAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | MeterAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | MeterAttribute->PredefinedValue_Value | object | composite |\r\n| value | MeterAttribute->Value | object | composite |\r\n| notes | MeterAttribute->Notes | string | |\r\n| createdOn | MeterAttribute->CreatedOn | string | date-time |\r\n| modifiedOn | MeterAttribute->ModifiedOn | string | date-time |\r\n", "operationId": "GetMeterAttributeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Meter Attribute collection", "schema": { "$ref": "#/definitions/GetMeterAttributeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Meter Attribute" ], "summary": "Create a new Meter 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| meterId | MeterAttribute->Meter_Id | integer | int64 |\r\n| attributeId | MeterAttribute->Attribute_Id | integer | int64 |\r\n| value | MeterAttribute->Value | object | composite |\r\n| predefinedValueId | MeterAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | MeterAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | MeterAttribute->SequenceNumber | integer | int32 |\r\n| notes | MeterAttribute->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| meterId | Required | True | |\r\n| meterId | 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": "CreateMeterAttribute", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateMeterAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Attributes/Lookups/LookupMeterAttributeAllowedValue": { "get": { "tags": [ "Meter Attribute" ], "summary": "Lookup the Attribute Allowed Value for the Meter 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": "LookupMeterAttributeAllowedValue", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Attribute Allowed Value collection", "schema": { "$ref": "#/definitions/MeterAttributeAttributeAllowedValueLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Attributes/Lookups/LookupMeterAttribute": { "get": { "tags": [ "Meter Attribute" ], "summary": "Meter 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": "LookupMeterAttribute", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Attribute collection", "schema": { "$ref": "#/definitions/MeterAttributeAttributeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Attributes/Lookups/LookupMeterAttributeChangePermissionTree": { "get": { "tags": [ "Meter Attribute" ], "summary": "Lookup the permission set for changing the Meter 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": "LookupMeterAttributeChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/MeterAttributeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Attributes/Lookups/LookupMeterAttributeInsertPermissionTree": { "get": { "tags": [ "Meter Attribute" ], "summary": "Lookup the permission set for creating the Meter 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": "LookupMeterAttributeInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/MeterAttributeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Attributes/Lookups/LookupMeterAttributeMeter": { "get": { "tags": [ "Meter Attribute" ], "summary": "Lookup the Meter Attribute for the Meter 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 | Meter->Id | integer | int64 |\r\n| code | Meter->Code | string | |\r\n| description | Meter->Description | string | |\r\n", "operationId": "LookupMeterAttributeMeter", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Meter collection", "schema": { "$ref": "#/definitions/MeterAttributeMeterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Attributes/Batch/{ids}": { "get": { "tags": [ "Meter Attribute" ], "summary": "Get a collection of Meter 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| meterId | MeterAttribute->Meter_Id | integer | int64 |\r\n| meterCode | MeterAttribute->Meter_Code | string | |\r\n| meterDescription | MeterAttribute->Meter_Description | string | |\r\n| createdByUserId | MeterAttribute->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MeterAttribute->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MeterAttribute->CreatedByUser_FullName | string | |\r\n| createdOn | MeterAttribute->CreatedOn | string | date-time |\r\n| isActive | MeterAttribute->IsActive | boolean | |\r\n| modifiedByUserId | MeterAttribute->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MeterAttribute->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MeterAttribute->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MeterAttribute->ModifiedOn | string | date-time |\r\n| permissionTreeId | MeterAttribute->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MeterAttribute->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MeterAttribute->PermissionTree_Description | string | |\r\n| version | MeterAttribute->Version | integer | int32 |\r\n| id | MeterAttribute->Id | integer | int64 |\r\n| attributeId | MeterAttribute->Attribute_Id | integer | int64 |\r\n| attributeCode | MeterAttribute->Attribute_Code | string | |\r\n| attributeDescription | MeterAttribute->Attribute_Description | string | |\r\n| attributeAllowAnyValue | MeterAttribute->Attribute_AllowAnyValue | boolean | |\r\n| attributeDataType | MeterAttribute->Attribute_DataType | string (Allowed values: [String, Email, Integer, Long, Float, Currency, DateTime, Date, Time, Duration, Boolean]) | enum |\r\n| attributeDefaultValue | MeterAttribute->Attribute_DefaultValue | object | composite |\r\n| attributeDefaultAllowedValueId | MeterAttribute->Attribute_DefaultAllowedValue_Id | integer | int64 |\r\n| attributeDefaultAllowedValueDescription | MeterAttribute->Attribute_DefaultAllowedValue_Description | string | |\r\n| attributeDefaultAllowedValueValue | MeterAttribute->Attribute_DefaultAllowedValue_Value | object | composite |\r\n| notes | MeterAttribute->Notes | string | |\r\n| predefinedValueId | MeterAttribute->PredefinedValue_Id | integer | int64 |\r\n| predefinedValueDescription | MeterAttribute->PredefinedValue_Description | string | |\r\n| predefinedValueValue | MeterAttribute->PredefinedValue_Value | object | composite |\r\n| sequenceNumber | MeterAttribute->SequenceNumber | integer | int32 |\r\n| value | MeterAttribute->Value | object | composite |\r\n", "operationId": "BatchGetMeterAttribute", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Meter Attribute id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Meter Attribute collection", "schema": { "$ref": "#/definitions/BatchGetMeterAttributeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Attributes/Batch": { "post": { "tags": [ "Meter Attribute" ], "summary": "Create a new collection of Meter 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| meterId | MeterAttribute->Meter_Id | integer | int64 |\r\n| attributeId | MeterAttribute->Attribute_Id | integer | int64 |\r\n| value | MeterAttribute->Value | object | composite |\r\n| predefinedValueId | MeterAttribute->PredefinedValue_Id | integer | int64 |\r\n| permissionTreeId | MeterAttribute->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | MeterAttribute->SequenceNumber | integer | int32 |\r\n| notes | MeterAttribute->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| meterId | Required | True | |\r\n| meterId | 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": "BatchCreateMeterAttribute", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateMeterAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Meter Attribute batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Meter Attribute" ], "summary": "Update a collection of existing Meter 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 | MeterAttribute->Id | integer | int64 |\r\n| version | MeterAttribute->Version | integer | int32 |\r\n| value | MeterAttribute->Value | object | composite |\r\n| predefinedValueId | MeterAttribute->PredefinedValue_Id | integer | int64 |\r\n| sequenceNumber | MeterAttribute->SequenceNumber | integer | int32 |\r\n| notes | MeterAttribute->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": "BatchUpdateMeterAttribute", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateMeterAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Meter Attribute batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Meter Attribute" ], "summary": "Delete a collection of existing Meter 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 | MeterAttribute->Id | integer | int64 |\r\n| version | MeterAttribute->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": "BatchDeleteMeterAttribute", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteMeterAttributeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Meter Attribute batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Attributes/{id}/Active": { "patch": { "tags": [ "Meter Attribute" ], "summary": "Change the IsActive status for an existing Meter 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 | MeterAttribute->Version | integer | int32 |\r\n| isActive | MeterAttribute->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": "ChangeMeterAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Meter Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeMeterAttributeIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Attributes/{id}/PermissionTree": { "patch": { "tags": [ "Meter Attribute" ], "summary": "Change the PermissionTree for an existing Meter 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 | MeterAttribute->Version | integer | int32 |\r\n| permissionTreeId | MeterAttribute->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": "ChangeMeterAttributePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Meter Attribute Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeMeterAttributePermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Attributes/Batch/PermissionTree": { "patch": { "tags": [ "Meter Attribute" ], "summary": "Change the PermissionTree status for a collection of existing Meter 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 | MeterAttribute->Id | integer | int64 |\r\n| version | MeterAttribute->Version | integer | int32 |\r\n| permissionTreeId | MeterAttribute->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": "BatchChangeMeterAttributePermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeMeterAttributePermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Attributes/Batch/Active": { "patch": { "tags": [ "Meter Attribute" ], "summary": "Change the IsActive status for a collection of existing Meter 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 | MeterAttribute->Id | integer | int64 |\r\n| version | MeterAttribute->Version | integer | int32 |\r\n| isActive | MeterAttribute->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": "BatchChangeMeterAttributeIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeMeterAttributeIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Documents/{id}": { "get": { "tags": [ "Meter Document" ], "summary": "Get a Meter 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| meterId | MeterDocument->Meter_Id | integer | int64 |\r\n| meterCode | MeterDocument->Meter_Code | string | |\r\n| meterDescription | MeterDocument->Meter_Description | string | |\r\n| isActive | MeterDocument->IsActive | boolean | |\r\n| createdByUserId | MeterDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MeterDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MeterDocument->CreatedByUser_FullName | string | |\r\n| createdOn | MeterDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | MeterDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MeterDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MeterDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MeterDocument->ModifiedOn | string | date-time |\r\n| version | MeterDocument->Version | integer | int32 |\r\n| permissionTreeId | MeterDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MeterDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MeterDocument->PermissionTree_Description | string | |\r\n| id | MeterDocument->Id | integer | int64 |\r\n| documentRecordId | MeterDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | MeterDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | MeterDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | MeterDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | MeterDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | MeterDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | MeterDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | MeterDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | MeterDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | MeterDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | MeterDocument->Notes | string | |\r\n| sequenceNumber | MeterDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "GetMeterDocument", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Meter Document Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Meter Document", "schema": { "$ref": "#/definitions/GetMeterDocumentResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Meter Document" ], "summary": "Update an existing Meter 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 | MeterDocument->Version | integer | int32 |\r\n| sequenceNumber | MeterDocument->SequenceNumber | integer | int32 |\r\n| notes | MeterDocument->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": "UpdateMeterDocument", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Meter Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateMeterDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Meter Document was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Meter Document" ], "summary": "Delete an existing Meter 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 | MeterDocument->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": "DeleteMeterDocument", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Meter Document Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteMeterDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Meter Document was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/{id}/Documents": { "get": { "tags": [ "Meter Document" ], "summary": "Get a collection of Meter Document resources for the Meter.", "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 | MeterDocument->Id | integer | int64 |\r\n| version | MeterDocument->Version | integer | int32 |\r\n| sequenceNumber | MeterDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | MeterDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | MeterDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | MeterDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | MeterDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | MeterDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | MeterDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | MeterDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetMeterDocumentCollectionForMeter", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Meter Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Meter Document collection", "schema": { "$ref": "#/definitions/GetMeterDocumentCollectionForMeterResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Documents": { "get": { "tags": [ "Meter Document" ], "summary": "Get a collection of Meter 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 | MeterDocument->Id | integer | int64 |\r\n| version | MeterDocument->Version | integer | int32 |\r\n| meterId | MeterDocument->Meter_Id | integer | int64 |\r\n| meterCode | MeterDocument->Meter_Code | string | |\r\n| meterDescription | MeterDocument->Meter_Description | string | |\r\n| sequenceNumber | MeterDocument->SequenceNumber | integer | int32 |\r\n| documentRecordId | MeterDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | MeterDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | MeterDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | MeterDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileFullName | MeterDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentSizeInMb | MeterDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeExtension | MeterDocument->DocumentRecord_FileType_Extension | string | |\r\n", "operationId": "GetMeterDocumentCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Meter Document collection", "schema": { "$ref": "#/definitions/GetMeterDocumentCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Meter Document" ], "summary": "Create a new Meter 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| meterId | MeterDocument->Meter_Id | integer | int64 |\r\n| documentRecordId | MeterDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | MeterDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | MeterDocument->SequenceNumber | integer | int32 |\r\n| notes | MeterDocument->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| meterId | Required | True | |\r\n| meterId | 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": "CreateMeterDocument", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateMeterDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Documents/Lookups/LookupMeterDocumentChangePermissionTree": { "get": { "tags": [ "Meter Document" ], "summary": "Lookup the permission set for changing the Meter 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": "LookupMeterDocumentChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/MeterDocumentChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Documents/Lookups/LookupMeterDocument": { "get": { "tags": [ "Meter Document" ], "summary": "Meter 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| documentFolderDescription | DocumentRecord->DocumentFolder_Description | string | |\r\n| fileLocation | DocumentRecord->FileLocation | string | |\r\n| fileFullName | DocumentRecord->FileFullName | string | |\r\n", "operationId": "LookupMeterDocument", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Document Record collection", "schema": { "$ref": "#/definitions/MeterDocumentDocumentLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Documents/Lookups/LookupMeterDocumentInsertPermissionTree": { "get": { "tags": [ "Meter Document" ], "summary": "Lookup the permission set for creating the Meter 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": "LookupMeterDocumentInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/MeterDocumentInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Documents/Lookups/LookupMeterDocumentMeter": { "get": { "tags": [ "Meter Document" ], "summary": "Lookup the Meter Document for the Meter 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 | Meter->Id | integer | int64 |\r\n| code | Meter->Code | string | |\r\n| description | Meter->Description | string | |\r\n", "operationId": "LookupMeterDocumentMeter", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Meter collection", "schema": { "$ref": "#/definitions/MeterDocumentMeterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Documents/Batch/{ids}": { "get": { "tags": [ "Meter Document" ], "summary": "Get a collection of Meter 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| meterId | MeterDocument->Meter_Id | integer | int64 |\r\n| meterCode | MeterDocument->Meter_Code | string | |\r\n| meterDescription | MeterDocument->Meter_Description | string | |\r\n| isActive | MeterDocument->IsActive | boolean | |\r\n| createdByUserId | MeterDocument->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MeterDocument->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MeterDocument->CreatedByUser_FullName | string | |\r\n| createdOn | MeterDocument->CreatedOn | string | date-time |\r\n| modifiedByUserId | MeterDocument->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MeterDocument->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MeterDocument->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MeterDocument->ModifiedOn | string | date-time |\r\n| version | MeterDocument->Version | integer | int32 |\r\n| permissionTreeId | MeterDocument->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | MeterDocument->PermissionTree_Code | string | |\r\n| permissionTreeDescription | MeterDocument->PermissionTree_Description | string | |\r\n| id | MeterDocument->Id | integer | int64 |\r\n| documentRecordId | MeterDocument->DocumentRecord_Id | integer | int64 |\r\n| documentRecordCode | MeterDocument->DocumentRecord_Code | string | |\r\n| documentRecordDescription | MeterDocument->DocumentRecord_Description | string | |\r\n| documentRecordFileLocation | MeterDocument->DocumentRecord_FileLocation | string | |\r\n| documentRecordFileInfoId | MeterDocument->DocumentRecord_FileInfoId | integer | int64 |\r\n| documentRecordFileFullName | MeterDocument->DocumentRecord_FileFullName | string | |\r\n| documentRecordContentId | MeterDocument->DocumentRecord_Content_Id | integer | int64 |\r\n| documentRecordContentSizeInMb | MeterDocument->DocumentRecord_Content_SizeInMb | number | decimal |\r\n| documentRecordFileTypeId | MeterDocument->DocumentRecord_FileType_Id | integer | int64 |\r\n| documentRecordFileTypeExtension | MeterDocument->DocumentRecord_FileType_Extension | string | |\r\n| notes | MeterDocument->Notes | string | |\r\n| sequenceNumber | MeterDocument->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetMeterDocument", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Meter Document id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Meter Document collection", "schema": { "$ref": "#/definitions/BatchGetMeterDocumentResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Documents/Batch": { "post": { "tags": [ "Meter Document" ], "summary": "Create a new collection of Meter 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| meterId | MeterDocument->Meter_Id | integer | int64 |\r\n| documentRecordId | MeterDocument->DocumentRecord_Id | integer | int64 |\r\n| permissionTreeId | MeterDocument->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | MeterDocument->SequenceNumber | integer | int32 |\r\n| notes | MeterDocument->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| meterId | Required | True | |\r\n| meterId | 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": "BatchCreateMeterDocument", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateMeterDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Meter Document batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Meter Document" ], "summary": "Update a collection of existing Meter 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 | MeterDocument->Id | integer | int64 |\r\n| version | MeterDocument->Version | integer | int32 |\r\n| sequenceNumber | MeterDocument->SequenceNumber | integer | int32 |\r\n| notes | MeterDocument->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": "BatchUpdateMeterDocument", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateMeterDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Meter Document batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Meter Document" ], "summary": "Delete a collection of existing Meter 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 | MeterDocument->Id | integer | int64 |\r\n| version | MeterDocument->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": "BatchDeleteMeterDocument", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteMeterDocumentResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Meter Document batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Documents/{id}/Active": { "patch": { "tags": [ "Meter Document" ], "summary": "Change the IsActive status for an existing Meter 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 | MeterDocument->Version | integer | int32 |\r\n| isActive | MeterDocument->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": "ChangeMeterDocumentIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Meter Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeMeterDocumentIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Documents/{id}/PermissionTree": { "patch": { "tags": [ "Meter Document" ], "summary": "Change the PermissionTree for an existing Meter 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 | MeterDocument->Version | integer | int32 |\r\n| permissionTreeId | MeterDocument->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": "ChangeMeterDocumentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Meter Document Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeMeterDocumentPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Documents/Batch/PermissionTree": { "patch": { "tags": [ "Meter Document" ], "summary": "Change the PermissionTree status for a collection of existing Meter 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 | MeterDocument->Id | integer | int64 |\r\n| version | MeterDocument->Version | integer | int32 |\r\n| permissionTreeId | MeterDocument->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": "BatchChangeMeterDocumentPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeMeterDocumentPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Documents/Batch/Active": { "patch": { "tags": [ "Meter Document" ], "summary": "Change the IsActive status for a collection of existing Meter 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 | MeterDocument->Id | integer | int64 |\r\n| version | MeterDocument->Version | integer | int32 |\r\n| isActive | MeterDocument->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": "BatchChangeMeterDocumentIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeMeterDocumentIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Readings/{id}": { "get": { "tags": [ "Meter Reading" ], "summary": "Get a Meter 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 | MeterReading->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MeterReading->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MeterReading->CreatedByUser_FullName | string | |\r\n| createdOn | MeterReading->CreatedOn | string | date-time |\r\n| modifiedByUserId | MeterReading->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MeterReading->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MeterReading->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MeterReading->ModifiedOn | string | date-time |\r\n| version | MeterReading->Version | integer | int32 |\r\n| id | MeterReading->Id | integer | int64 |\r\n| cumulativeReading | MeterReading->CumulativeReading | number | decimal |\r\n| isAssetConsumptionReading | MeterReading->IsAssetConsumptionReading | boolean | |\r\n| locationId | MeterReading->Location_Id | integer | int64 |\r\n| locationCode | MeterReading->Location_Code | string | |\r\n| locationDescription | MeterReading->Location_Description | string | |\r\n| meterId | MeterReading->Meter_Id | integer | int64 |\r\n| meterCode | MeterReading->Meter_Code | string | |\r\n| meterDescription | MeterReading->Meter_Description | string | |\r\n| notes | MeterReading->Notes | string | |\r\n| reading | MeterReading->Reading | number | decimal |\r\n| readingOn | MeterReading->ReadingOn | string | date-time |\r\n| resetType | MeterReading->ResetType | string (Allowed values: [Manual, Automatic]) | enum |\r\n| resetValue | MeterReading->ResetValue | number | decimal |\r\n| siteId | MeterReading->Site_Id | integer | int64 |\r\n| siteCode | MeterReading->Site_Code | string | |\r\n| siteDescription | MeterReading->Site_Description | string | |\r\n", "operationId": "GetMeterReading", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Meter Reading Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Meter Reading", "schema": { "$ref": "#/definitions/GetMeterReadingResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Meter Reading" ], "summary": "Update an existing Meter 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 | MeterReading->Version | integer | int32 |\r\n| reading | MeterReading->Reading | number | decimal |\r\n| readingOn | MeterReading->ReadingOn | string | date-time |\r\n| notes | MeterReading->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| reading | Nullable | False | |\r\n| reading | Min Value | >= 0| |\r\n| readingOn | Nullable | False | |\r\n\r\n", "operationId": "UpdateMeterReading", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Meter Reading Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateMeterReadingResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Meter Reading was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Meter Reading" ], "summary": "Delete an existing Meter 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 | MeterReading->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": "DeleteMeterReading", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Meter Reading Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteMeterReadingResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Meter Reading was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Readings": { "get": { "tags": [ "Meter Reading" ], "summary": "Get a collection of Meter 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| version | MeterReading->Version | integer | int32 |\r\n| id | MeterReading->Id | integer | int64 |\r\n| meterId | MeterReading->Meter_Id | integer | int64 |\r\n| meterCode | MeterReading->Meter_Code | string | |\r\n| meterDescription | MeterReading->Meter_Description | string | |\r\n| reading | MeterReading->Reading | number | decimal |\r\n| cumulativeReading | MeterReading->CumulativeReading | number | decimal |\r\n| resetValue | MeterReading->ResetValue | number | decimal |\r\n| resetType | MeterReading->ResetType | string (Allowed values: [Manual, Automatic]) | enum |\r\n| readingOn | MeterReading->ReadingOn | string | date-time |\r\n| isAssetConsumptionReading | MeterReading->IsAssetConsumptionReading | boolean | |\r\n| locationId | MeterReading->Location_Id | integer | int64 |\r\n| locationCode | MeterReading->Location_Code | string | |\r\n| locationDescription | MeterReading->Location_Description | string | |\r\n| siteId | MeterReading->Site_Id | integer | int64 |\r\n| siteCode | MeterReading->Site_Code | string | |\r\n| siteDescription | MeterReading->Site_Description | string | |\r\n", "operationId": "GetMeterReadingCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Meter Reading collection", "schema": { "$ref": "#/definitions/GetMeterReadingCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Meter Reading" ], "summary": "Create a new Meter 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| locationId | MeterReading->Location_Id | integer | int64 |\r\n| meterId | MeterReading->Meter_Id | integer | int64 |\r\n| reading | MeterReading->Reading | number | decimal |\r\n| readingOn | MeterReading->ReadingOn | string | date-time |\r\n| notes | MeterReading->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| meterId | Required | True | |\r\n| meterId | Nullable | False | |\r\n| reading | Required | True | |\r\n| reading | Nullable | False | |\r\n| reading | Min Value | >= 0| |\r\n| readingOn | Required | True | |\r\n| readingOn | Nullable | False | |\r\n\r\n", "operationId": "CreateMeterReading", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateMeterReadingResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Readings/Lookups/LookupMeterReadingLocation": { "get": { "tags": [ "Meter Reading" ], "summary": "Lookup the Location for the Meter 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 | Location->Id | integer | int64 |\r\n| code | Location->Code | string | |\r\n| description | Location->Description | string | |\r\n", "operationId": "LookupMeterReadingLocation", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Location collection", "schema": { "$ref": "#/definitions/MeterReadingLocationLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Readings/Lookups/LookupMeterReadingMeter": { "get": { "tags": [ "Meter Reading" ], "summary": "Lookup the Meter for the Meter 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 | Meter->Id | integer | int64 |\r\n| code | Meter->Code | string | |\r\n| description | Meter->Description | string | |\r\n| siteId | Meter->Site_Id | integer | int64 |\r\n| siteCode | Meter->Site_Code | string | |\r\n| siteDescription | Meter->Site_Description | string | |\r\n", "operationId": "LookupMeterReadingMeter", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Meter collection", "schema": { "$ref": "#/definitions/MeterReadingMeterLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Readings/Batch/{ids}": { "get": { "tags": [ "Meter Reading" ], "summary": "Get a collection of Meter 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 | MeterReading->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | MeterReading->CreatedByUser_Code | string | |\r\n| createdByUserFullName | MeterReading->CreatedByUser_FullName | string | |\r\n| createdOn | MeterReading->CreatedOn | string | date-time |\r\n| modifiedByUserId | MeterReading->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | MeterReading->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | MeterReading->ModifiedByUser_FullName | string | |\r\n| modifiedOn | MeterReading->ModifiedOn | string | date-time |\r\n| version | MeterReading->Version | integer | int32 |\r\n| id | MeterReading->Id | integer | int64 |\r\n| cumulativeReading | MeterReading->CumulativeReading | number | decimal |\r\n| isAssetConsumptionReading | MeterReading->IsAssetConsumptionReading | boolean | |\r\n| locationId | MeterReading->Location_Id | integer | int64 |\r\n| locationCode | MeterReading->Location_Code | string | |\r\n| locationDescription | MeterReading->Location_Description | string | |\r\n| meterId | MeterReading->Meter_Id | integer | int64 |\r\n| meterCode | MeterReading->Meter_Code | string | |\r\n| meterDescription | MeterReading->Meter_Description | string | |\r\n| notes | MeterReading->Notes | string | |\r\n| reading | MeterReading->Reading | number | decimal |\r\n| readingOn | MeterReading->ReadingOn | string | date-time |\r\n| resetType | MeterReading->ResetType | string (Allowed values: [Manual, Automatic]) | enum |\r\n| resetValue | MeterReading->ResetValue | number | decimal |\r\n| siteId | MeterReading->Site_Id | integer | int64 |\r\n| siteCode | MeterReading->Site_Code | string | |\r\n| siteDescription | MeterReading->Site_Description | string | |\r\n", "operationId": "BatchGetMeterReading", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Meter Reading id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Meter Reading collection", "schema": { "$ref": "#/definitions/BatchGetMeterReadingResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Readings/Batch": { "post": { "tags": [ "Meter Reading" ], "summary": "Create a new collection of Meter 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| locationId | MeterReading->Location_Id | integer | int64 |\r\n| meterId | MeterReading->Meter_Id | integer | int64 |\r\n| reading | MeterReading->Reading | number | decimal |\r\n| readingOn | MeterReading->ReadingOn | string | date-time |\r\n| notes | MeterReading->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| meterId | Required | True | |\r\n| meterId | Nullable | False | |\r\n| reading | Required | True | |\r\n| reading | Nullable | False | |\r\n| reading | Min Value | >= 0| |\r\n| readingOn | Required | True | |\r\n| readingOn | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateMeterReading", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateMeterReadingResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Meter Reading batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Meter Reading" ], "summary": "Update a collection of existing Meter 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 | MeterReading->Id | integer | int64 |\r\n| version | MeterReading->Version | integer | int32 |\r\n| reading | MeterReading->Reading | number | decimal |\r\n| readingOn | MeterReading->ReadingOn | string | date-time |\r\n| notes | MeterReading->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| reading | Nullable | False | |\r\n| reading | Min Value | >= 0| |\r\n| readingOn | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateMeterReading", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateMeterReadingResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Meter Reading batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Meter Reading" ], "summary": "Delete a collection of existing Meter 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 | MeterReading->Id | integer | int64 |\r\n| version | MeterReading->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": "BatchDeleteMeterReading", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteMeterReadingResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Meter Reading batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/Readings/ValidateMeterAdr": { "post": { "tags": [ "Meter Reading" ], "summary": "Validate whether the Meter Reading will cause the Meter's AverageDailyRate to exceed the allowed configured values.", "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| meterId | ValidateMeterAdrEntity->Meter_Id | integer | int64 |\r\n| readingValue | ValidateMeterAdrEntity->ReadingValue | number | decimal |\r\n| readingOn | ValidateMeterAdrEntity->ReadingOn | string | date-time |\r\n| meterReadingId | ValidateMeterAdrEntity->MeterReading_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\r\n", "operationId": "ValidateMeterReadingMeterAdr", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ValidateMeterReadingMeterAdrResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/PredictedMeterReadings/{id}": { "get": { "tags": [ "Predicted Meter Reading" ], "summary": "Get a Predicted Meter 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 | PredictedMeterReading->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PredictedMeterReading->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PredictedMeterReading->CreatedByUser_FullName | string | |\r\n| createdOn | PredictedMeterReading->CreatedOn | string | date-time |\r\n| version | PredictedMeterReading->Version | integer | int32 |\r\n| id | PredictedMeterReading->Id | integer | int64 |\r\n| meterId | PredictedMeterReading->Meter_Id | integer | int64 |\r\n| meterCode | PredictedMeterReading->Meter_Code | string | |\r\n| reading | PredictedMeterReading->Reading | number | decimal |\r\n| readingOn | PredictedMeterReading->ReadingOn | string | date |\r\n", "operationId": "GetPredictedMeterReading", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Predicted Meter Reading Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Predicted Meter Reading", "schema": { "$ref": "#/definitions/GetPredictedMeterReadingResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/PredictedMeterReadings": { "get": { "tags": [ "Predicted Meter Reading" ], "summary": "Get a collection of Predicted Meter 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 | PredictedMeterReading->Id | integer | int64 |\r\n| meterId | PredictedMeterReading->Meter_Id | integer | int64 |\r\n| meterCode | PredictedMeterReading->Meter_Code | string | |\r\n| reading | PredictedMeterReading->Reading | number | decimal |\r\n| readingOn | PredictedMeterReading->ReadingOn | string | date |\r\n", "operationId": "GetPredictedMeterReadingCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Predicted Meter Reading collection", "schema": { "$ref": "#/definitions/GetPredictedMeterReadingCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Predicted Meter Reading" ], "summary": "Create a new Predicted Meter 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| meterId | PredictedMeterReading->Meter_Id | integer | int64 |\r\n| reading | PredictedMeterReading->Reading | number | decimal |\r\n| readingOn | PredictedMeterReading->ReadingOn | string | date |\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| meterId | Required | True | |\r\n| meterId | Nullable | False | |\r\n| reading | Nullable | False | |\r\n| reading | Min Value | >= 0| |\r\n| readingOn | Nullable | False | |\r\n\r\n", "operationId": "CreatePredictedMeterReading", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreatePredictedMeterReadingResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/PredictedMeterReadings/{meterId}/PredictedMeterReadings": { "get": { "tags": [ "Predicted Meter Reading" ], "summary": "Get a collection of Predicted Meter Reading resources for the Meter.", "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 | PredictedMeterReading->Id | integer | int64 |\r\n| reading | PredictedMeterReading->Reading | number | decimal |\r\n| readingOn | PredictedMeterReading->ReadingOn | string | date |\r\n", "operationId": "GetPredictedMeterReadingForMeterCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "meterId", "in": "path", "required": true, "description": "Meter Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Predicted Meter Reading collection", "schema": { "$ref": "#/definitions/GetPredictedMeterReadingForMeterCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/PredictedMeterReadings/Batch/{ids}": { "get": { "tags": [ "Predicted Meter Reading" ], "summary": "Get a collection of Predicted Meter 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 | PredictedMeterReading->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | PredictedMeterReading->CreatedByUser_Code | string | |\r\n| createdByUserFullName | PredictedMeterReading->CreatedByUser_FullName | string | |\r\n| createdOn | PredictedMeterReading->CreatedOn | string | date-time |\r\n| version | PredictedMeterReading->Version | integer | int32 |\r\n| id | PredictedMeterReading->Id | integer | int64 |\r\n| meterId | PredictedMeterReading->Meter_Id | integer | int64 |\r\n| meterCode | PredictedMeterReading->Meter_Code | string | |\r\n| reading | PredictedMeterReading->Reading | number | decimal |\r\n| readingOn | PredictedMeterReading->ReadingOn | string | date |\r\n", "operationId": "BatchGetPredictedMeterReading", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Predicted Meter Reading id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Predicted Meter Reading collection", "schema": { "$ref": "#/definitions/BatchGetPredictedMeterReadingResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/Meters/PredictedMeterReadings/Batch": { "post": { "tags": [ "Predicted Meter Reading" ], "summary": "Create a new collection of Predicted Meter 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| meterId | PredictedMeterReading->Meter_Id | integer | int64 |\r\n| reading | PredictedMeterReading->Reading | number | decimal |\r\n| readingOn | PredictedMeterReading->ReadingOn | string | date |\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| meterId | Required | True | |\r\n| meterId | Nullable | False | |\r\n| reading | Nullable | False | |\r\n| reading | Min Value | >= 0| |\r\n| readingOn | Nullable | False | |\r\n\r\n", "operationId": "BatchCreatePredictedMeterReading", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreatePredictedMeterReadingResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Predicted Meter Reading batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/TimeLossCategories/{id}": { "get": { "tags": [ "Time Loss Category" ], "summary": "Get a Time Loss Category 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 | TimeLossCategory->Code | string | |\r\n| createdByUserId | TimeLossCategory->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | TimeLossCategory->CreatedByUser_Code | string | |\r\n| createdByUserFullName | TimeLossCategory->CreatedByUser_FullName | string | |\r\n| createdOn | TimeLossCategory->CreatedOn | string | date-time |\r\n| isActive | TimeLossCategory->IsActive | boolean | |\r\n| modifiedByUserId | TimeLossCategory->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | TimeLossCategory->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | TimeLossCategory->ModifiedByUser_FullName | string | |\r\n| modifiedOn | TimeLossCategory->ModifiedOn | string | date-time |\r\n| permissionTreeId | TimeLossCategory->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | TimeLossCategory->PermissionTree_Code | string | |\r\n| permissionTreeDescription | TimeLossCategory->PermissionTree_Description | string | |\r\n| version | TimeLossCategory->Version | integer | int32 |\r\n| id | TimeLossCategory->Id | integer | int64 |\r\n| description | TimeLossCategory->Description | string | |\r\n| notes | TimeLossCategory->Notes | string | |\r\n| sequenceNumber | TimeLossCategory->SequenceNumber | integer | int32 |\r\n", "operationId": "GetTimeLossCategory", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Time Loss Category Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Time Loss Category", "schema": { "$ref": "#/definitions/GetTimeLossCategoryResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Time Loss Category" ], "summary": "Update an existing Time Loss Category 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 | TimeLossCategory->Version | integer | int32 |\r\n| code | TimeLossCategory->Code | string | |\r\n| description | TimeLossCategory->Description | string | |\r\n| sequenceNumber | TimeLossCategory->SequenceNumber | integer | int32 |\r\n| notes | TimeLossCategory->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": "UpdateTimeLossCategory", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Time Loss Category Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateTimeLossCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Time Loss Category was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Time Loss Category" ], "summary": "Delete an existing Time Loss Category 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 | TimeLossCategory->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": "DeleteTimeLossCategory", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Time Loss Category Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteTimeLossCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Time Loss Category was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/TimeLossCategories": { "get": { "tags": [ "Time Loss Category" ], "summary": "Get a collection of Time Loss Category 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 | TimeLossCategory->Version | integer | int32 |\r\n| id | TimeLossCategory->Id | integer | int64 |\r\n| code | TimeLossCategory->Code | string | |\r\n| description | TimeLossCategory->Description | string | |\r\n| sequenceNumber | TimeLossCategory->SequenceNumber | integer | int32 |\r\n| notes | TimeLossCategory->Notes | string | |\r\n| createdOn | TimeLossCategory->CreatedOn | string | date-time |\r\n| modifiedOn | TimeLossCategory->ModifiedOn | string | date-time |\r\n", "operationId": "GetTimeLossCategoryCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Time Loss Category collection", "schema": { "$ref": "#/definitions/GetTimeLossCategoryCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Time Loss Category" ], "summary": "Create a new Time Loss Category 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 | TimeLossCategory->PermissionTree_Id | integer | int64 |\r\n| code | TimeLossCategory->Code | string | |\r\n| description | TimeLossCategory->Description | string | |\r\n| sequenceNumber | TimeLossCategory->SequenceNumber | integer | int32 |\r\n| notes | TimeLossCategory->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 | Required | True | |\r\n| permissionTreeId | Nullable | False | |\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\r\n", "operationId": "CreateTimeLossCategory", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateTimeLossCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/TimeLossCategories/Lookups/LookupTimeLossCategoryChangePermissionTree": { "get": { "tags": [ "Time Loss Category" ], "summary": "Lookup the permission set for changing the Time Loss Category.", "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": "LookupTimeLossCategoryChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/TimeLossCategoryChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/TimeLossCategories/Lookups/LookupTimeLossCategoryInsertPermissionTree": { "get": { "tags": [ "Time Loss Category" ], "summary": "Lookup the permission set for creating the Time Loss Category.", "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": "LookupTimeLossCategoryInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/TimeLossCategoryInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/TimeLossCategories/Batch/{ids}": { "get": { "tags": [ "Time Loss Category" ], "summary": "Get a collection of Time Loss Category 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 | TimeLossCategory->Code | string | |\r\n| createdByUserId | TimeLossCategory->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | TimeLossCategory->CreatedByUser_Code | string | |\r\n| createdByUserFullName | TimeLossCategory->CreatedByUser_FullName | string | |\r\n| createdOn | TimeLossCategory->CreatedOn | string | date-time |\r\n| isActive | TimeLossCategory->IsActive | boolean | |\r\n| modifiedByUserId | TimeLossCategory->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | TimeLossCategory->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | TimeLossCategory->ModifiedByUser_FullName | string | |\r\n| modifiedOn | TimeLossCategory->ModifiedOn | string | date-time |\r\n| permissionTreeId | TimeLossCategory->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | TimeLossCategory->PermissionTree_Code | string | |\r\n| permissionTreeDescription | TimeLossCategory->PermissionTree_Description | string | |\r\n| version | TimeLossCategory->Version | integer | int32 |\r\n| id | TimeLossCategory->Id | integer | int64 |\r\n| description | TimeLossCategory->Description | string | |\r\n| notes | TimeLossCategory->Notes | string | |\r\n| sequenceNumber | TimeLossCategory->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetTimeLossCategory", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Time Loss Category id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Time Loss Category collection", "schema": { "$ref": "#/definitions/BatchGetTimeLossCategoryResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/TimeLossCategories/Batch": { "post": { "tags": [ "Time Loss Category" ], "summary": "Create a new collection of Time Loss Category 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 | TimeLossCategory->PermissionTree_Id | integer | int64 |\r\n| code | TimeLossCategory->Code | string | |\r\n| description | TimeLossCategory->Description | string | |\r\n| sequenceNumber | TimeLossCategory->SequenceNumber | integer | int32 |\r\n| notes | TimeLossCategory->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 | Required | True | |\r\n| permissionTreeId | Nullable | False | |\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\r\n", "operationId": "BatchCreateTimeLossCategory", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateTimeLossCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Time Loss Category batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Time Loss Category" ], "summary": "Update a collection of existing Time Loss Category 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 | TimeLossCategory->Id | integer | int64 |\r\n| version | TimeLossCategory->Version | integer | int32 |\r\n| code | TimeLossCategory->Code | string | |\r\n| description | TimeLossCategory->Description | string | |\r\n| sequenceNumber | TimeLossCategory->SequenceNumber | integer | int32 |\r\n| notes | TimeLossCategory->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": "BatchUpdateTimeLossCategory", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateTimeLossCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Time Loss Category batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Time Loss Category" ], "summary": "Delete a collection of existing Time Loss Category 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 | TimeLossCategory->Id | integer | int64 |\r\n| version | TimeLossCategory->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": "BatchDeleteTimeLossCategory", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteTimeLossCategoryResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Time Loss Category batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/TimeLossCategories/{id}/Active": { "patch": { "tags": [ "Time Loss Category" ], "summary": "Change the IsActive status for an existing Time Loss Category 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 | TimeLossCategory->Version | integer | int32 |\r\n| isActive | TimeLossCategory->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": "ChangeTimeLossCategoryIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Time Loss Category Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeTimeLossCategoryIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/TimeLossCategories/{id}/PermissionTree": { "patch": { "tags": [ "Time Loss Category" ], "summary": "Change the PermissionTree for an existing Time Loss Category 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 | TimeLossCategory->Version | integer | int32 |\r\n| permissionTreeId | TimeLossCategory->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": "ChangeTimeLossCategoryPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Time Loss Category Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeTimeLossCategoryPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/TimeLossCategories/Batch/Active": { "patch": { "tags": [ "Time Loss Category" ], "summary": "Change the IsActive status for a collection of existing Time Loss Category 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 | TimeLossCategory->Id | integer | int64 |\r\n| version | TimeLossCategory->Version | integer | int32 |\r\n| isActive | TimeLossCategory->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": "BatchChangeTimeLossCategoryIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeTimeLossCategoryIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/TimeLossCategories/Batch/PermissionTree": { "patch": { "tags": [ "Time Loss Category" ], "summary": "Change the PermissionTree status for a collection of existing Time Loss Category 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 | TimeLossCategory->Id | integer | int64 |\r\n| version | TimeLossCategory->Version | integer | int32 |\r\n| permissionTreeId | TimeLossCategory->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": "BatchChangeTimeLossCategoryPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeTimeLossCategoryPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/TimeLossReasons/{id}": { "get": { "tags": [ "Time Loss Reason" ], "summary": "Get a Time Loss Reason 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 | TimeLossReason->Code | string | |\r\n| isActive | TimeLossReason->IsActive | boolean | |\r\n| createdByUserId | TimeLossReason->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | TimeLossReason->CreatedByUser_Code | string | |\r\n| createdByUserFullName | TimeLossReason->CreatedByUser_FullName | string | |\r\n| createdOn | TimeLossReason->CreatedOn | string | date-time |\r\n| modifiedByUserId | TimeLossReason->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | TimeLossReason->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | TimeLossReason->ModifiedByUser_FullName | string | |\r\n| modifiedOn | TimeLossReason->ModifiedOn | string | date-time |\r\n| version | TimeLossReason->Version | integer | int32 |\r\n| permissionTreeId | TimeLossReason->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | TimeLossReason->PermissionTree_Code | string | |\r\n| permissionTreeDescription | TimeLossReason->PermissionTree_Description | string | |\r\n| id | TimeLossReason->Id | integer | int64 |\r\n| allowedDuration | TimeLossReason->AllowedDuration | string | duration |\r\n| classification | TimeLossReason->Classification | string (Allowed values: [Utilization, Availability, Quality, Performance]) | enum |\r\n| description | TimeLossReason->Description | string | |\r\n| notes | TimeLossReason->Notes | string | |\r\n| sequenceNumber | TimeLossReason->SequenceNumber | integer | int32 |\r\n| timeLossCategoryId | TimeLossReason->TimeLossCategory_Id | integer | int64 |\r\n| timeLossCategoryCode | TimeLossReason->TimeLossCategory_Code | string | |\r\n| timeLossCategoryDescription | TimeLossReason->TimeLossCategory_Description | string | |\r\n| timeLossTypeId | TimeLossReason->TimeLossType_Id | integer | int64 |\r\n| timeLossTypeCode | TimeLossReason->TimeLossType_Code | string | |\r\n| timeLossTypeDescription | TimeLossReason->TimeLossType_Description | string | |\r\n", "operationId": "GetTimeLossReason", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Time Loss Reason Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Time Loss Reason", "schema": { "$ref": "#/definitions/GetTimeLossReasonResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Time Loss Reason" ], "summary": "Update an existing Time Loss Reason 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 | TimeLossReason->Version | integer | int32 |\r\n| code | TimeLossReason->Code | string | |\r\n| description | TimeLossReason->Description | string | |\r\n| sequenceNumber | TimeLossReason->SequenceNumber | integer | int32 |\r\n| classification | TimeLossReason->Classification | string (Allowed values: [Utilization, Availability, Quality, Performance]) | enum |\r\n| timeLossCategoryId | TimeLossReason->TimeLossCategory_Id | integer | int64 |\r\n| timeLossTypeId | TimeLossReason->TimeLossType_Id | integer | int64 |\r\n| allowedDuration | TimeLossReason->AllowedDuration | string | duration |\r\n| notes | TimeLossReason->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| classification | Nullable | False | |\r\n| timeLossCategoryId | Nullable | False | |\r\n| timeLossTypeId | Nullable | False | |\r\n| allowedDuration | Nullable | False | |\r\n\r\n", "operationId": "UpdateTimeLossReason", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Time Loss Reason Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateTimeLossReasonResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Time Loss Reason was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Time Loss Reason" ], "summary": "Delete an existing Time Loss Reason 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 | TimeLossReason->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": "DeleteTimeLossReason", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Time Loss Reason Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteTimeLossReasonResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Time Loss Reason was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/TimeLossReasons": { "get": { "tags": [ "Time Loss Reason" ], "summary": "Get a collection of Time Loss Reason 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 | TimeLossReason->Version | integer | int32 |\r\n| id | TimeLossReason->Id | integer | int64 |\r\n| code | TimeLossReason->Code | string | |\r\n| description | TimeLossReason->Description | string | |\r\n| isActive | TimeLossReason->IsActive | boolean | |\r\n| sequenceNumber | TimeLossReason->SequenceNumber | integer | int32 |\r\n| classification | TimeLossReason->Classification | string (Allowed values: [Utilization, Availability, Quality, Performance]) | enum |\r\n| allowedDuration | TimeLossReason->AllowedDuration | string | duration |\r\n| timeLossCategoryId | TimeLossReason->TimeLossCategory_Id | integer | int64 |\r\n| timeLossCategoryCode | TimeLossReason->TimeLossCategory_Code | string | |\r\n| timeLossCategoryDescription | TimeLossReason->TimeLossCategory_Description | string | |\r\n| timeLossTypeId | TimeLossReason->TimeLossType_Id | integer | int64 |\r\n| timeLossTypeCode | TimeLossReason->TimeLossType_Code | string | |\r\n| timeLossTypeDescription | TimeLossReason->TimeLossType_Description | string | |\r\n| createdOn | TimeLossReason->CreatedOn | string | date-time |\r\n| modifiedOn | TimeLossReason->ModifiedOn | string | date-time |\r\n", "operationId": "GetTimeLossReasonCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Time Loss Reason collection", "schema": { "$ref": "#/definitions/GetTimeLossReasonCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Time Loss Reason" ], "summary": "Create a new Time Loss Reason 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 | TimeLossReason->Code | string | |\r\n| description | TimeLossReason->Description | string | |\r\n| permissionTreeId | TimeLossReason->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | TimeLossReason->SequenceNumber | integer | int32 |\r\n| classification | TimeLossReason->Classification | string (Allowed values: [Utilization, Availability, Quality, Performance]) | enum |\r\n| timeLossCategoryId | TimeLossReason->TimeLossCategory_Id | integer | int64 |\r\n| timeLossTypeId | TimeLossReason->TimeLossType_Id | integer | int64 |\r\n| allowedDuration | TimeLossReason->AllowedDuration | string | duration |\r\n| notes | TimeLossReason->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| classification | Required | True | |\r\n| classification | Nullable | False | |\r\n| timeLossCategoryId | Required | True | |\r\n| timeLossCategoryId | Nullable | False | |\r\n| timeLossTypeId | Required | True | |\r\n| timeLossTypeId | Nullable | False | |\r\n| allowedDuration | Required | True | |\r\n| allowedDuration | Nullable | False | |\r\n\r\n", "operationId": "CreateTimeLossReason", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateTimeLossReasonResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/TimeLossReasons/Lookups/LookupTimeLossReasonChangePermissionTree": { "get": { "tags": [ "Time Loss Reason" ], "summary": "Lookup the permission set for changing the Time Loss Reason.", "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": "LookupTimeLossReasonChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/TimeLossReasonChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/TimeLossReasons/Lookups/LookupTimeLossReasonInsertPermissionTree": { "get": { "tags": [ "Time Loss Reason" ], "summary": "Lookup the permission set for creating the Time Loss Reason.", "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": "LookupTimeLossReasonInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/TimeLossReasonInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/TimeLossReasons/Lookups/LookupTimeLossReasonCategory": { "get": { "tags": [ "Time Loss Reason" ], "summary": "Lookup the Time Loss Category for the Time Loss Reason.", "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 | TimeLossCategory->Id | integer | int64 |\r\n| code | TimeLossCategory->Code | string | |\r\n| description | TimeLossCategory->Description | string | |\r\n", "operationId": "LookupTimeLossReasonCategory", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Time Loss Category collection", "schema": { "$ref": "#/definitions/TimeLossReasonCategoryLookupResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/TimeLossReasons/Lookups/LookupTimeLossReasonType": { "get": { "tags": [ "Time Loss Reason" ], "summary": "Lookup the Time Loss Type for the Time Loss Reason.", "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 | TimeLossType->Id | integer | int64 |\r\n| code | TimeLossType->Code | string | |\r\n| description | TimeLossType->Description | string | |\r\n", "operationId": "LookupTimeLossReasonType", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Time Loss Type collection", "schema": { "$ref": "#/definitions/TimeLossReasonTypeLookupResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/TimeLossReasons/Batch/{ids}": { "get": { "tags": [ "Time Loss Reason" ], "summary": "Get a collection of Time Loss Reason 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 | TimeLossReason->Code | string | |\r\n| isActive | TimeLossReason->IsActive | boolean | |\r\n| createdByUserId | TimeLossReason->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | TimeLossReason->CreatedByUser_Code | string | |\r\n| createdByUserFullName | TimeLossReason->CreatedByUser_FullName | string | |\r\n| createdOn | TimeLossReason->CreatedOn | string | date-time |\r\n| modifiedByUserId | TimeLossReason->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | TimeLossReason->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | TimeLossReason->ModifiedByUser_FullName | string | |\r\n| modifiedOn | TimeLossReason->ModifiedOn | string | date-time |\r\n| version | TimeLossReason->Version | integer | int32 |\r\n| permissionTreeId | TimeLossReason->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | TimeLossReason->PermissionTree_Code | string | |\r\n| permissionTreeDescription | TimeLossReason->PermissionTree_Description | string | |\r\n| id | TimeLossReason->Id | integer | int64 |\r\n| allowedDuration | TimeLossReason->AllowedDuration | string | duration |\r\n| classification | TimeLossReason->Classification | string (Allowed values: [Utilization, Availability, Quality, Performance]) | enum |\r\n| description | TimeLossReason->Description | string | |\r\n| notes | TimeLossReason->Notes | string | |\r\n| sequenceNumber | TimeLossReason->SequenceNumber | integer | int32 |\r\n| timeLossCategoryId | TimeLossReason->TimeLossCategory_Id | integer | int64 |\r\n| timeLossCategoryCode | TimeLossReason->TimeLossCategory_Code | string | |\r\n| timeLossCategoryDescription | TimeLossReason->TimeLossCategory_Description | string | |\r\n| timeLossTypeId | TimeLossReason->TimeLossType_Id | integer | int64 |\r\n| timeLossTypeCode | TimeLossReason->TimeLossType_Code | string | |\r\n| timeLossTypeDescription | TimeLossReason->TimeLossType_Description | string | |\r\n", "operationId": "BatchGetTimeLossReason", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Time Loss Reason id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Time Loss Reason collection", "schema": { "$ref": "#/definitions/BatchGetTimeLossReasonResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/TimeLossReasons/Batch": { "post": { "tags": [ "Time Loss Reason" ], "summary": "Create a new collection of Time Loss Reason 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 | TimeLossReason->Code | string | |\r\n| description | TimeLossReason->Description | string | |\r\n| permissionTreeId | TimeLossReason->PermissionTree_Id | integer | int64 |\r\n| sequenceNumber | TimeLossReason->SequenceNumber | integer | int32 |\r\n| classification | TimeLossReason->Classification | string (Allowed values: [Utilization, Availability, Quality, Performance]) | enum |\r\n| timeLossCategoryId | TimeLossReason->TimeLossCategory_Id | integer | int64 |\r\n| timeLossTypeId | TimeLossReason->TimeLossType_Id | integer | int64 |\r\n| allowedDuration | TimeLossReason->AllowedDuration | string | duration |\r\n| notes | TimeLossReason->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| classification | Required | True | |\r\n| classification | Nullable | False | |\r\n| timeLossCategoryId | Required | True | |\r\n| timeLossCategoryId | Nullable | False | |\r\n| timeLossTypeId | Required | True | |\r\n| timeLossTypeId | Nullable | False | |\r\n| allowedDuration | Required | True | |\r\n| allowedDuration | Nullable | False | |\r\n\r\n", "operationId": "BatchCreateTimeLossReason", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateTimeLossReasonResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Time Loss Reason batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Time Loss Reason" ], "summary": "Update a collection of existing Time Loss Reason 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 | TimeLossReason->Id | integer | int64 |\r\n| version | TimeLossReason->Version | integer | int32 |\r\n| code | TimeLossReason->Code | string | |\r\n| description | TimeLossReason->Description | string | |\r\n| sequenceNumber | TimeLossReason->SequenceNumber | integer | int32 |\r\n| classification | TimeLossReason->Classification | string (Allowed values: [Utilization, Availability, Quality, Performance]) | enum |\r\n| timeLossCategoryId | TimeLossReason->TimeLossCategory_Id | integer | int64 |\r\n| timeLossTypeId | TimeLossReason->TimeLossType_Id | integer | int64 |\r\n| allowedDuration | TimeLossReason->AllowedDuration | string | duration |\r\n| notes | TimeLossReason->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| classification | Nullable | False | |\r\n| timeLossCategoryId | Nullable | False | |\r\n| timeLossTypeId | Nullable | False | |\r\n| allowedDuration | Nullable | False | |\r\n\r\n", "operationId": "BatchUpdateTimeLossReason", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateTimeLossReasonResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Time Loss Reason batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Time Loss Reason" ], "summary": "Delete a collection of existing Time Loss Reason 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 | TimeLossReason->Id | integer | int64 |\r\n| version | TimeLossReason->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": "BatchDeleteTimeLossReason", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteTimeLossReasonResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Time Loss Reason batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/TimeLossReasons/{id}/Active": { "patch": { "tags": [ "Time Loss Reason" ], "summary": "Change the IsActive status for an existing Time Loss Reason 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 | TimeLossReason->Version | integer | int32 |\r\n| isActive | TimeLossReason->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": "ChangeTimeLossReasonIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Time Loss Reason Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeTimeLossReasonIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/TimeLossReasons/{id}/PermissionTree": { "patch": { "tags": [ "Time Loss Reason" ], "summary": "Change the PermissionTree for an existing Time Loss Reason 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 | TimeLossReason->Version | integer | int32 |\r\n| permissionTreeId | TimeLossReason->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": "ChangeTimeLossReasonPermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Time Loss Reason Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeTimeLossReasonPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/TimeLossReasons/Batch/Active": { "patch": { "tags": [ "Time Loss Reason" ], "summary": "Change the IsActive status for a collection of existing Time Loss Reason 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 | TimeLossReason->Id | integer | int64 |\r\n| version | TimeLossReason->Version | integer | int32 |\r\n| isActive | TimeLossReason->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": "BatchChangeTimeLossReasonIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeTimeLossReasonIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/TimeLossReasons/Batch/PermissionTree": { "patch": { "tags": [ "Time Loss Reason" ], "summary": "Change the PermissionTree status for a collection of existing Time Loss Reason 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 | TimeLossReason->Id | integer | int64 |\r\n| version | TimeLossReason->Version | integer | int32 |\r\n| permissionTreeId | TimeLossReason->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": "BatchChangeTimeLossReasonPermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeTimeLossReasonPermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/TimeLossTypes/{id}": { "get": { "tags": [ "Time Loss Type" ], "summary": "Get a Time Loss 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 | TimeLossType->Code | string | |\r\n| createdByUserId | TimeLossType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | TimeLossType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | TimeLossType->CreatedByUser_FullName | string | |\r\n| createdOn | TimeLossType->CreatedOn | string | date-time |\r\n| isActive | TimeLossType->IsActive | boolean | |\r\n| modifiedByUserId | TimeLossType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | TimeLossType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | TimeLossType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | TimeLossType->ModifiedOn | string | date-time |\r\n| permissionTreeId | TimeLossType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | TimeLossType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | TimeLossType->PermissionTree_Description | string | |\r\n| version | TimeLossType->Version | integer | int32 |\r\n| id | TimeLossType->Id | integer | int64 |\r\n| description | TimeLossType->Description | string | |\r\n| notes | TimeLossType->Notes | string | |\r\n| sequenceNumber | TimeLossType->SequenceNumber | integer | int32 |\r\n", "operationId": "GetTimeLossType", "produces": [ "application/vnd.onkey.entity+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Time Loss Type Id", "format": "int64", "x-nullable": false }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Time Loss Type", "schema": { "$ref": "#/definitions/GetTimeLossTypeResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Time Loss Type" ], "summary": "Update an existing Time Loss 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 | TimeLossType->Version | integer | int32 |\r\n| code | TimeLossType->Code | string | |\r\n| description | TimeLossType->Description | string | |\r\n| sequenceNumber | TimeLossType->SequenceNumber | integer | int32 |\r\n| notes | TimeLossType->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": "UpdateTimeLossType", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Time Loss Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/UpdateTimeLossTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Time Loss Type was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Time Loss Type" ], "summary": "Delete an existing Time Loss 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 | TimeLossType->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": "DeleteTimeLossType", "consumes": [ "application/vnd.onkey.entitydelete+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Time Loss Type Id", "format": "int64", "x-nullable": false }, { "name": "delete", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/DeleteTimeLossTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Time Loss Type was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/TimeLossTypes": { "get": { "tags": [ "Time Loss Type" ], "summary": "Get a collection of Time Loss 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 | TimeLossType->Version | integer | int32 |\r\n| id | TimeLossType->Id | integer | int64 |\r\n| code | TimeLossType->Code | string | |\r\n| description | TimeLossType->Description | string | |\r\n| sequenceNumber | TimeLossType->SequenceNumber | integer | int32 |\r\n| notes | TimeLossType->Notes | string | |\r\n| createdOn | TimeLossType->CreatedOn | string | date-time |\r\n| modifiedOn | TimeLossType->ModifiedOn | string | date-time |\r\n", "operationId": "GetTimeLossTypeCollection", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable Time Loss Type collection", "schema": { "$ref": "#/definitions/GetTimeLossTypeCollectionResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "post": { "tags": [ "Time Loss Type" ], "summary": "Create a new Time Loss 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| permissionTreeId | TimeLossType->PermissionTree_Id | integer | int64 |\r\n| code | TimeLossType->Code | string | |\r\n| description | TimeLossType->Description | string | |\r\n| sequenceNumber | TimeLossType->SequenceNumber | integer | int32 |\r\n| notes | TimeLossType->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 | Required | True | |\r\n| permissionTreeId | Nullable | False | |\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\r\n", "operationId": "CreateTimeLossType", "consumes": [ "application/vnd.onkey.entity+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "post", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/CreateTimeLossTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/TimeLossTypes/Lookups/LookupTimeLossTypeChangePermissionTree": { "get": { "tags": [ "Time Loss Type" ], "summary": "Lookup the permission set for changing the Time Loss 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": "LookupTimeLossTypeChangePermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/TimeLossTypeChangePermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/TimeLossTypes/Lookups/LookupTimeLossTypeInsertPermissionTree": { "get": { "tags": [ "Time Loss Type" ], "summary": "Lookup the permission set for creating the Time Loss 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": "LookupTimeLossTypeInsertPermissionTree", "produces": [ "application/vnd.onkey.entitycollectionpage+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "$ref": "#/parameters/Select" }, { "$ref": "#/parameters/Filter" }, { "$ref": "#/parameters/Param" }, { "$ref": "#/parameters/Top" }, { "$ref": "#/parameters/Skip" }, { "$ref": "#/parameters/OrderBy" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains pageable collection", "schema": { "$ref": "#/definitions/TimeLossTypeInsertPermissionTreeLookupResourceActionResponse" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/TimeLossTypes/Batch/{ids}": { "get": { "tags": [ "Time Loss Type" ], "summary": "Get a collection of Time Loss 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 | TimeLossType->Code | string | |\r\n| createdByUserId | TimeLossType->CreatedByUser_Id | integer | int64 |\r\n| createdByUserCode | TimeLossType->CreatedByUser_Code | string | |\r\n| createdByUserFullName | TimeLossType->CreatedByUser_FullName | string | |\r\n| createdOn | TimeLossType->CreatedOn | string | date-time |\r\n| isActive | TimeLossType->IsActive | boolean | |\r\n| modifiedByUserId | TimeLossType->ModifiedByUser_Id | integer | int64 |\r\n| modifiedByUserCode | TimeLossType->ModifiedByUser_Code | string | |\r\n| modifiedByUserFullName | TimeLossType->ModifiedByUser_FullName | string | |\r\n| modifiedOn | TimeLossType->ModifiedOn | string | date-time |\r\n| permissionTreeId | TimeLossType->PermissionTree_Id | integer | int64 |\r\n| permissionTreeCode | TimeLossType->PermissionTree_Code | string | |\r\n| permissionTreeDescription | TimeLossType->PermissionTree_Description | string | |\r\n| version | TimeLossType->Version | integer | int32 |\r\n| id | TimeLossType->Id | integer | int64 |\r\n| description | TimeLossType->Description | string | |\r\n| notes | TimeLossType->Notes | string | |\r\n| sequenceNumber | TimeLossType->SequenceNumber | integer | int32 |\r\n", "operationId": "BatchGetTimeLossType", "produces": [ "application/vnd.onkey.entitycollection+json", "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "array", "name": "ids", "in": "path", "required": true, "description": "A comma separated list of Time Loss Type id's (eg. 1585760985950002,1585760985950003)", "collectionFormat": "csv", "x-nullable": false, "items": { "type": "integer", "format": "int64" } }, { "$ref": "#/parameters/Select" } ], "responses": { "200": { "x-nullable": true, "description": "Success response - body contains Time Loss Type collection", "schema": { "$ref": "#/definitions/BatchGetTimeLossTypeResourceAction" } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/TimeLossTypes/Batch": { "post": { "tags": [ "Time Loss Type" ], "summary": "Create a new collection of Time Loss 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| permissionTreeId | TimeLossType->PermissionTree_Id | integer | int64 |\r\n| code | TimeLossType->Code | string | |\r\n| description | TimeLossType->Description | string | |\r\n| sequenceNumber | TimeLossType->SequenceNumber | integer | int32 |\r\n| notes | TimeLossType->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 | Required | True | |\r\n| permissionTreeId | Nullable | False | |\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\r\n", "operationId": "BatchCreateTimeLossType", "consumes": [ "application/vnd.onkey.entitycollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "posts", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchCreateTimeLossTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "201": { "x-nullable": true, "description": "Success response - Time Loss Type batch was successfully created" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "patch": { "tags": [ "Time Loss Type" ], "summary": "Update a collection of existing Time Loss 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 | TimeLossType->Id | integer | int64 |\r\n| version | TimeLossType->Version | integer | int32 |\r\n| code | TimeLossType->Code | string | |\r\n| description | TimeLossType->Description | string | |\r\n| sequenceNumber | TimeLossType->SequenceNumber | integer | int32 |\r\n| notes | TimeLossType->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": "BatchUpdateTimeLossType", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchUpdateTimeLossTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Time Loss Type batch was successfully updated" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } }, "delete": { "tags": [ "Time Loss Type" ], "summary": "Delete a collection of existing Time Loss 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 | TimeLossType->Id | integer | int64 |\r\n| version | TimeLossType->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": "BatchDeleteTimeLossType", "consumes": [ "application/vnd.onkey.entitydeletecollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "deletes", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchDeleteTimeLossTypeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - Time Loss Type batch was successfully deleted" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/TimeLossTypes/{id}/Active": { "patch": { "tags": [ "Time Loss Type" ], "summary": "Change the IsActive status for an existing Time Loss 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 | TimeLossType->Version | integer | int32 |\r\n| isActive | TimeLossType->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": "ChangeTimeLossTypeIsActive", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Time Loss Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeTimeLossTypeIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/TimeLossTypes/{id}/PermissionTree": { "patch": { "tags": [ "Time Loss Type" ], "summary": "Change the PermissionTree for an existing Time Loss 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 | TimeLossType->Version | integer | int32 |\r\n| permissionTreeId | TimeLossType->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": "ChangeTimeLossTypePermissionTree", "consumes": [ "application/vnd.onkey.entitypatch+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "type": "integer", "name": "id", "in": "path", "required": true, "description": "Time Loss Type Id", "format": "int64", "x-nullable": false }, { "name": "patch", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/ChangeTimeLossTypePermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/TimeLossTypes/Batch/Active": { "patch": { "tags": [ "Time Loss Type" ], "summary": "Change the IsActive status for a collection of existing Time Loss 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 | TimeLossType->Id | integer | int64 |\r\n| version | TimeLossType->Version | integer | int32 |\r\n| isActive | TimeLossType->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": "BatchChangeTimeLossTypeIsActive", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeTimeLossTypeIsActiveResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } }, "/Modules/AOM/TimeLossTypes/Batch/PermissionTree": { "patch": { "tags": [ "Time Loss Type" ], "summary": "Change the PermissionTree status for a collection of existing Time Loss 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 | TimeLossType->Id | integer | int64 |\r\n| version | TimeLossType->Version | integer | int32 |\r\n| permissionTreeId | TimeLossType->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": "BatchChangeTimeLossTypePermissionTree", "consumes": [ "application/vnd.onkey.entitypatchcollection+json" ], "produces": [ "application/vnd.onkey.notification+json" ], "parameters": [ { "name": "patches", "in": "body", "required": true, "description": "Request Body content", "schema": { "$ref": "#/definitions/BatchChangeTimeLossTypePermissionTreeResourceActionRequest" } }, { "$ref": "#/parameters/Async" }, { "$ref": "#/parameters/AsyncDescription" }, { "$ref": "#/parameters/Schedule" }, { "$ref": "#/parameters/ExecutionMode" } ], "responses": { "204": { "x-nullable": true, "description": "Success response - operation was successfully executed" }, "202": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "default": { "x-nullable": true, "description": "Error response - operation failed" } } } } }, "definitions": { "OperationExecutionMode": { "type": "string", "description": "", "x-enumNames": [ "AllOrNone", "PerRecord" ], "enum": [ "AllOrNone", "PerRecord" ] }, "SeverityType": { "type": "string", "description": "", "x-nullable": false, "x-enumNames": [ "Error", "Warning", "Information" ], "enum": [ "error", "warning", "information" ] }, "NotificationItemSchema": { "title": "NotificationItemSchema", "type": "object", "properties": { "code": { "title": "code", "type": "string", "description": "Unique code for message", "x-nullable": false }, "message": { "title": "message", "type": "string", "x-nullable": false }, "objectId": { "title": "objectId", "type": "string", "description": "Optional id of record to which the message applies", "x-nullable": true }, "objectType": { "title": "objectType", "type": "string", "format": "enum", "x-nullable": true, "x-formatSpecifier": "EntityType" }, "properties": { "title": "properties", "type": "array", "description": "Collection of properties referenced by the message using property path syntax", "x-nullable": true, "example": [ "Asset->Code" ], "items": { "type": "string" } }, "severity": { "$ref": "#/definitions/SeverityType" }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Optional provided unique external record identifier to echo back with message", "x-nullable": true } } }, "NotificationSchema": { "title": "NotificationSchema", "type": "object", "properties": { "messages": { "title": "messages", "type": "array", "description": "Collection of messages", "x-nullable": false, "items": { "$ref": "#/definitions/NotificationItemSchema" } } } }, "EntityPermissionViolationSchema": { "type": "object", "required": [ "permissionId", "permissionTreeId", "propertyPaths" ], "properties": { "permissionId": { "type": "integer", "format": "int64" }, "permissionTreeId": { "type": "integer", "format": "int64" }, "propertyPaths": { "type": "array", "items": { "type": "string" } } } }, "EntityPhraseTranslationSchema": { "type": "object", "required": [ "phrase", "translation", "propertyPaths" ], "properties": { "phrase": { "type": "string" }, "translation": { "type": "string" }, "propertyPaths": { "type": "array", "items": { "type": "string" } } } }, "Link": { "type": "object", "required": [ "href", "method" ], "properties": { "doc": { "type": "string", "description": "Documentation endpoint that describes the link" }, "href": { "type": "string", "description": "Endpoint to invoke link", "minLength": 1 }, "mapping": { "type": "array", "items": { "$ref": "#/definitions/LinkMapping" } }, "method": { "type": "string", "description": "HTTP method used for link", "minLength": 1 }, "module": { "type": "string", "description": "Module used by link" }, "rel": { "type": "string" }, "resource": { "type": "string", "description": "Resource used by link" }, "resourceAction": { "type": "string", "description": "Resource Action used by link" }, "title": { "type": "string", "description": "Title" }, "type": { "description": "Type of link", "$ref": "#/definitions/ResourceLinkType" } } }, "LinkMapping": { "type": "object", "required": [ "source" ], "properties": { "source": { "type": "string" }, "target": { "type": "string" } } }, "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" ] }, "GetConsumableResourceActionResponse": { "title": "GetConsumableResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetConsumableResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Consumable->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "Consumable->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Consumable->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Consumable->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Consumable->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Consumable->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Consumable->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Consumable->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Consumable->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Consumable->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Consumable->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "Consumable->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Consumable->PermissionTree_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Consumable->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": true, "x-propertyPath": "Consumable->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Consumable->Site_Description" }, "currencyId": { "title": "currencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Consumable->Currency_Id" }, "currencyCode": { "title": "currencyCode", "type": "string", "x-nullable": true, "x-propertyPath": "Consumable->Currency_Code" }, "currencyDescription": { "title": "currencyDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Consumable->Currency_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Consumable->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Consumable->Notes" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Consumable->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "Consumable->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Consumable->UnitOfMeasurement_Description" }, "unitPrice": { "title": "unitPrice", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Consumable->UnitPrice" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetConsumableCollectionResourceActionResponse": { "title": "GetConsumableCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetConsumableCollectionResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "GetConsumableCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Consumable->Code" }, "currencyId": { "title": "currencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Consumable->Currency_Id" }, "currencyCode": { "title": "currencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "Consumable->Currency_Code" }, "currencyDescription": { "title": "currencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Consumable->Currency_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Consumable->Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "Consumable->IsActive" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Consumable->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "Consumable->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Consumable->Site_Description" }, "unitPrice": { "title": "unitPrice", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Consumable->UnitPrice" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Consumable->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "Consumable->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Consumable->UnitOfMeasurement_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Consumable->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Consumable->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Consumable->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "ConsumableChangePermissionTreeLookupResourceActionResponse": { "title": "ConsumableChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "ConsumableChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "ConsumableChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "ConsumableCurrencyLookupResourceActionResponse": { "title": "ConsumableCurrencyLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "ConsumableCurrencyLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "ConsumableCurrencyLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Currency->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Currency->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "ConsumableInsertPermissionTreeLookupResourceActionResponse": { "title": "ConsumableInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "ConsumableInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "ConsumableInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "ConsumableSiteLookupResourceActionResponse": { "title": "ConsumableSiteLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "ConsumableSiteLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "ConsumableSiteLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Description" }, "currencyId": { "title": "currencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Site->Currency_Id" }, "currencyCode": { "title": "currencyCode", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Currency_Code" }, "currencyDescription": { "title": "currencyDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Currency_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "ConsumableUnitOfMeasurementLookupResourceActionResponse": { "title": "ConsumableUnitOfMeasurementLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "ConsumableUnitOfMeasurementLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "ConsumableUnitOfMeasurementLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateConsumableResourceActionRequest": { "title": "CreateConsumableResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateConsumableResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "code", "description", "permissionTreeId" ], "properties": { "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "Consumable->Code" }, "currencyId": { "title": "currencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Consumable->Currency_Id" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "Consumable->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Consumable->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Consumable->PermissionTree_Id" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Consumable->Site_Id" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Consumable->UnitOfMeasurement_Id" }, "unitPrice": { "title": "unitPrice", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": true, "x-propertyPath": "Consumable->UnitPrice" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "PatchOperationType": { "type": "string", "description": "", "x-nullable": true, "x-enumNames": [ "Replace", "Add", "Remove" ], "enum": [ "replace", "add", "remove" ] }, "EntityPatchOperationSchema": { "type": "object", "required": [ "path", "value" ], "properties": { "op": { "title": "op", "description": "Type of operation to apply", "example": "replace", "$ref": "#/definitions/PatchOperationType" }, "path": { "title": "path", "type": "string", "description": "Property path for the property being updated", "x-nullable": false, "example": "Asset->Code" }, "value": { "title": "value", "type": "object", "description": "Value for the property being updated", "x-nullable": true, "example": "BOILER" } } }, "UpdateConsumableResourceActionRequest": { "title": "UpdateConsumableResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "Consumable->Code" }, { "title": "currencyId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Consumable->Currency_Id" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "Consumable->Description" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Consumable->Notes" }, { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Consumable->Site_Id" }, { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Consumable->UnitOfMeasurement_Id" }, { "title": "unitPrice", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": true, "x-propertyPath": "Consumable->UnitPrice" } ] } } }, "DeleteConsumableResourceActionRequest": { "title": "DeleteConsumableResourceActionRequest", "type": "object", "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", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetConsumableResourceAction": { "title": "BatchGetConsumableResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Consumable entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Consumable entities", "items": { "$ref": "#/definitions/GetConsumableResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateConsumableResourceActionRequest": { "title": "BatchCreateConsumableResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateConsumableResourceActionRequest" } }, "BatchUpdateConsumableResourceActionRequest": { "title": "BatchUpdateConsumableResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateConsumableResourceActionRequest" } }, "BatchDeleteConsumableResourceActionRequest": { "title": "BatchDeleteConsumableResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteConsumableResourceActionRequest" } }, "ChangeConsumableIsActiveResourceActionRequest": { "title": "ChangeConsumableIsActiveResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "Consumable->IsActive" } ] } } }, "ChangeConsumablePermissionTreeResourceActionRequest": { "title": "ChangeConsumablePermissionTreeResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Consumable->PermissionTree_Id" } ] } } }, "BatchChangeConsumableIsActiveResourceActionRequest": { "title": "BatchChangeConsumableIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeConsumableIsActiveResourceActionRequest" } }, "BatchChangeConsumablePermissionTreeResourceActionRequest": { "title": "BatchChangeConsumablePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeConsumablePermissionTreeResourceActionRequest" } }, "GetMeterResourceActionResponse": { "title": "GetMeterResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetMeterResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "Meter->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Meter->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Meter->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Meter->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Meter->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Meter->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "Meter->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "Meter->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Meter->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Meter->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "Meter->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Meter->PermissionTree_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Meter->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": true, "x-propertyPath": "Meter->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Meter->Site_Description" }, "automaticallyUpdateAverageDailyRate": { "title": "automaticallyUpdateAverageDailyRate", "type": "boolean", "x-nullable": false, "x-propertyPath": "Meter->AutomaticallyUpdateAverageDailyRate" }, "autoResetValue": { "title": "autoResetValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Meter->AutoResetValue" }, "averageDailyRate": { "title": "averageDailyRate", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Meter->AverageDailyRate" }, "averageDailyRateCalculationQuantity": { "title": "averageDailyRateCalculationQuantity", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Meter->AverageDailyRateCalculationQuantity" }, "averageDailyRateCalculationUnit": { "title": "averageDailyRateCalculationUnit", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Meter->AverageDailyRateCalculationUnit", "x-formatSpecifier": "AverageDailyRateCalculationUnit" }, "averageDailyRateMaximumValue": { "title": "averageDailyRateMaximumValue", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Meter->AverageDailyRateMaximumValue", "x-NullExpression": "Meter->ValidateAverageDailyRateMaximumValue eq true" }, "averageDailyRateVariancePercentage": { "title": "averageDailyRateVariancePercentage", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Meter->AverageDailyRateVariancePercentage", "x-NullExpression": "Meter->ValidateAverageDailyRateVariancePercentage eq 'Yes'" }, "cumulativeReading": { "title": "cumulativeReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Meter->CumulativeReading" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Description" }, "isPaused": { "title": "isPaused", "type": "boolean", "x-nullable": true, "x-propertyPath": "Meter->IsPaused" }, "lastReading": { "title": "lastReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Meter->LastReading" }, "lastReadOn": { "title": "lastReadOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Meter->LastReadOn" }, "lastResetOn": { "title": "lastResetOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Meter->LastResetOn" }, "lastResetReading": { "title": "lastResetReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Meter->LastResetReading" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Meter->Notes" }, "pmrStatus": { "title": "pmrStatus", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Meter->PmrStatus", "x-formatSpecifier": "MeterPmrStatus" }, "pmrStatusChangedOn": { "title": "pmrStatusChangedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Meter->PmrStatusChangedOn" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Meter->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": true, "x-propertyPath": "Meter->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Meter->UnitOfMeasurement_Description" }, "validateAverageDailyRateMaximumValue": { "title": "validateAverageDailyRateMaximumValue", "type": "boolean", "x-nullable": false, "x-propertyPath": "Meter->ValidateAverageDailyRateMaximumValue" }, "validateAverageDailyRateVariancePercentage": { "title": "validateAverageDailyRateVariancePercentage", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Meter->ValidateAverageDailyRateVariancePercentage", "x-formatSpecifier": "AdrVariancePercentageValidationOption" }, "validateReadings": { "title": "validateReadings", "type": "boolean", "x-nullable": true, "x-propertyPath": "Meter->ValidateReadings" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetMeterCollectionResourceActionResponse": { "title": "GetMeterCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMeterCollectionResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "GetMeterCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "Meter->IsActive" }, "isPaused": { "title": "isPaused", "type": "boolean", "x-nullable": true, "x-propertyPath": "Meter->IsPaused" }, "autoResetValue": { "title": "autoResetValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Meter->AutoResetValue" }, "automaticallyUpdateAverageDailyRate": { "title": "automaticallyUpdateAverageDailyRate", "type": "boolean", "x-nullable": false, "x-propertyPath": "Meter->AutomaticallyUpdateAverageDailyRate" }, "averageDailyRateCalculationQuantity": { "title": "averageDailyRateCalculationQuantity", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Meter->AverageDailyRateCalculationQuantity" }, "averageDailyRateCalculationUnit": { "title": "averageDailyRateCalculationUnit", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Meter->AverageDailyRateCalculationUnit", "x-formatSpecifier": "AverageDailyRateCalculationUnit" }, "averageDailyRate": { "title": "averageDailyRate", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Meter->AverageDailyRate" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Meter->Notes" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Meter->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Site_Description" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Meter->UnitOfMeasurement_Id" }, "unitOfMeasurementCode": { "title": "unitOfMeasurementCode", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->UnitOfMeasurement_Code" }, "unitOfMeasurementDescription": { "title": "unitOfMeasurementDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->UnitOfMeasurement_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Meter->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "Meter->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "MeterChangePermissionTreeLookupResourceActionResponse": { "title": "MeterChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MeterChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "MeterChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "MeterInsertPermissionTreeLookupResourceActionResponse": { "title": "MeterInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MeterInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "MeterInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "MeterSiteLookupResourceActionResponse": { "title": "MeterSiteLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MeterSiteLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "MeterSiteLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Site->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "MeterUnitOfMeasurementLookupResourceActionResponse": { "title": "MeterUnitOfMeasurementLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MeterUnitOfMeasurementLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "MeterUnitOfMeasurementLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "UnitOfMeasurement->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateMeterResourceActionRequest": { "title": "CreateMeterResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateMeterResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "code", "description", "unitOfMeasurementId" ], "properties": { "autoResetValue": { "title": "autoResetValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Meter->AutoResetValue" }, "automaticallyUpdateAverageDailyRate": { "title": "automaticallyUpdateAverageDailyRate", "type": "boolean", "x-nullable": false, "x-propertyPath": "Meter->AutomaticallyUpdateAverageDailyRate" }, "averageDailyRateCalculationQuantity": { "title": "averageDailyRateCalculationQuantity", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Meter->AverageDailyRateCalculationQuantity" }, "averageDailyRateCalculationUnit": { "title": "averageDailyRateCalculationUnit", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Meter->AverageDailyRateCalculationUnit", "x-formatSpecifier": "AverageDailyRateCalculationUnit" }, "averageDailyRateMaximumValue": { "title": "averageDailyRateMaximumValue", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Meter->AverageDailyRateMaximumValue", "x-NullExpression": "Meter->ValidateAverageDailyRateMaximumValue eq true" }, "averageDailyRateVariancePercentage": { "title": "averageDailyRateVariancePercentage", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Meter->AverageDailyRateVariancePercentage", "x-NullExpression": "Meter->ValidateAverageDailyRateVariancePercentage eq 'Yes'" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "Meter->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "Meter->Description" }, "isPaused": { "title": "isPaused", "type": "boolean", "x-nullable": true, "x-propertyPath": "Meter->IsPaused" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Meter->Notes" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Meter->PermissionTree_Id", "x-systemGenerated": true }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Meter->Site_Id" }, "unitOfMeasurementId": { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Meter->UnitOfMeasurement_Id" }, "validateAverageDailyRateMaximumValue": { "title": "validateAverageDailyRateMaximumValue", "type": "boolean", "x-nullable": false, "x-propertyPath": "Meter->ValidateAverageDailyRateMaximumValue" }, "validateAverageDailyRateVariancePercentage": { "title": "validateAverageDailyRateVariancePercentage", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Meter->ValidateAverageDailyRateVariancePercentage", "x-formatSpecifier": "AdrVariancePercentageValidationOption" }, "validateReadings": { "title": "validateReadings", "type": "boolean", "x-nullable": true, "x-propertyPath": "Meter->ValidateReadings" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateMeterResourceActionRequest": { "title": "UpdateMeterResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "Meter->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "Meter->Description" }, { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Meter->UnitOfMeasurement_Id" }, { "title": "autoResetValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Meter->AutoResetValue" }, { "title": "automaticallyUpdateAverageDailyRate", "type": "boolean", "x-nullable": false, "x-propertyPath": "Meter->AutomaticallyUpdateAverageDailyRate" }, { "title": "averageDailyRateCalculationQuantity", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "Meter->AverageDailyRateCalculationQuantity" }, { "title": "averageDailyRateCalculationUnit", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "Meter->AverageDailyRateCalculationUnit", "x-formatSpecifier": "AverageDailyRateCalculationUnit" }, { "title": "averageDailyRate", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": true, "x-propertyPath": "Meter->AverageDailyRate" }, { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Meter->Site_Id" }, { "title": "validateReadings", "type": "boolean", "x-nullable": true, "x-propertyPath": "Meter->ValidateReadings" }, { "title": "validateAverageDailyRateVariancePercentage", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Meter->ValidateAverageDailyRateVariancePercentage", "x-formatSpecifier": "AdrVariancePercentageValidationOption" }, { "title": "averageDailyRateVariancePercentage", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Meter->AverageDailyRateVariancePercentage", "x-NullExpression": "Meter->ValidateAverageDailyRateVariancePercentage eq 'Yes'" }, { "title": "validateAverageDailyRateMaximumValue", "type": "boolean", "x-nullable": false, "x-propertyPath": "Meter->ValidateAverageDailyRateMaximumValue" }, { "title": "averageDailyRateMaximumValue", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "Meter->AverageDailyRateMaximumValue", "x-NullExpression": "Meter->ValidateAverageDailyRateMaximumValue eq true" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Meter->Notes" } ] } } }, "DeleteMeterResourceActionRequest": { "title": "DeleteMeterResourceActionRequest", "type": "object", "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", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetMeterResourceAction": { "title": "BatchGetMeterResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Meter entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Meter entities", "items": { "$ref": "#/definitions/GetMeterResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateMeterResourceActionRequest": { "title": "BatchCreateMeterResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateMeterResourceActionRequest" } }, "BatchUpdateMeterResourceActionRequest": { "title": "BatchUpdateMeterResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateMeterResourceActionRequest" } }, "BatchDeleteMeterResourceActionRequest": { "title": "BatchDeleteMeterResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteMeterResourceActionRequest" } }, "ChangeMeterAverageDailyRateResourceActionRequest": { "title": "ChangeMeterAverageDailyRateResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "averageDailyRate", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "Meter->AverageDailyRate" } ] } } }, "BatchChangeMeterAverageDailyRateResourceActionRequest": { "title": "BatchChangeMeterAverageDailyRateResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeMeterAverageDailyRateResourceActionRequest" } }, "PauseMeterResourceActionRequest": { "title": "PauseMeterResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" } } } }, "BatchPauseMeterResourceActionRequest": { "title": "BatchPauseMeterResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/PauseMeterResourceActionRequest" } }, "ResumeMeterResourceActionRequest": { "title": "ResumeMeterResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" } } } }, "BatchResumeMeterResourceActionRequest": { "title": "BatchResumeMeterResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ResumeMeterResourceActionRequest" } }, "CalculateAverageDailyRateResourceActionRequest": { "title": "CalculateAverageDailyRateResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "useConfiguredCalculationUnitAndQuantity", "type": "boolean", "x-nullable": false, "x-propertyPath": "CalculateAverageDailyRate->UseConfiguredCalculationUnitAndQuantity" }, { "title": "averageDailyRateCalculationQuantity", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "CalculateAverageDailyRate->AverageDailyRateCalculationQuantity" }, { "title": "averageDailyRateCalculationUnit", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "CalculateAverageDailyRate->AverageDailyRateCalculationUnit", "x-formatSpecifier": "AverageDailyRateCalculationUnit" } ] } } }, "CalculateAverageDailyRateResourceActionResponse": { "title": "CalculateAverageDailyRateResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "CalculateAverageDailyRateResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "averageDailyRate": { "title": "averageDailyRate", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "CalculateAverageDailyRateResult->AverageDailyRate" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "ChangeMeterIsActiveResourceActionRequest": { "title": "ChangeMeterIsActiveResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "Meter->IsActive" } ] } } }, "ChangeMeterPermissionTreeResourceActionRequest": { "title": "ChangeMeterPermissionTreeResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Meter->PermissionTree_Id" } ] } } }, "ChangeMeterSiteResourceActionRequest": { "title": "ChangeMeterSiteResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Meter->Site_Id" } ] } } }, "DeleteAllMeterReadingsResourceActionRequest": { "title": "DeleteAllMeterReadingsResourceActionRequest", "type": "object", "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", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "ManualMeterResetResourceActionRequest": { "title": "ManualMeterResetResourceActionRequest", "type": "object", "properties": { "properties": { "title": "ManualMeterResetResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "resetDate" ], "properties": { "lastReading": { "title": "lastReading", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": true, "x-propertyPath": "ManualMeterReset->LastReading" }, "firstReading": { "title": "firstReading", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "ManualMeterReset->FirstReading" }, "resetDate": { "title": "resetDate", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ManualMeterReset->ResetDate" }, "useLatestReadingAsLastReading": { "title": "useLatestReadingAsLastReading", "type": "boolean", "x-nullable": false, "x-propertyPath": "ManualMeterReset->UseLatestReadingAsLastReading" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchChangeMeterIsActiveResourceActionRequest": { "title": "BatchChangeMeterIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeMeterIsActiveResourceActionRequest" } }, "BatchChangeMeterPermissionTreeResourceActionRequest": { "title": "BatchChangeMeterPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeMeterPermissionTreeResourceActionRequest" } }, "BatchChangeMeterSiteResourceActionRequest": { "title": "BatchChangeMeterSiteResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeMeterSiteResourceActionRequest" } }, "EntityMatchRecordSchema": { "type": "object", "required": [ "id", "version" ], "properties": { "id": { "title": "id", "type": "integer", "description": "Id of the entity to patch.", "format": "int64", "example": 14324399978 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to patch", "format": "int32", "example": 1 } } }, "MatchUpdateMeterResourceActionRequest": { "title": "MatchUpdateMeterResourceActionRequest", "type": "object", "properties": { "operations": { "title": "operations", "type": "array", "description": "Collection of patch operations to apply to the entities", "items": { "$ref": "#/definitions/EntityPatchOperationSchema" } }, "records": { "title": "records", "type": "array", "description": "Collection of entities to apply the patch operations to", "items": { "$ref": "#/definitions/EntityMatchRecordSchema" }, "x-matchupdateproperties": [ { "title": "unitOfMeasurementId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "Meter->UnitOfMeasurement_Id" }, { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Meter->Site_Id" }, { "title": "autoResetValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "Meter->AutoResetValue" }, { "title": "automaticallyUpdateAverageDailyRate", "type": "boolean", "x-nullable": false, "x-propertyPath": "Meter->AutomaticallyUpdateAverageDailyRate" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "Meter->Notes" } ] } } }, "DynamicValueSchema": { "title": "DynamicValueSchema", "type": "object", "properties": { "type": { "title": "type", "type": "string", "format": "enum", "x-nullable": false, "x-formatSpecifier": "DynamicValueType", "x-enumNames": [ "String", "Email", "Integer", "Long", "Float", "Currency", "DateTime", "Date", "Time", "Duration", "Boolean" ] }, "value": { "title": "value", "type": "object" } } }, "GetMeterAttributeResourceActionResponse": { "title": "GetMeterAttributeResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetMeterAttributeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "MeterAttribute->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": true, "x-propertyPath": "MeterAttribute->Meter_Code" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "MeterAttribute->Meter_Description" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MeterAttribute->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "MeterAttribute->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "MeterAttribute->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MeterAttribute->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "MeterAttribute->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MeterAttribute->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "MeterAttribute->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "MeterAttribute->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MeterAttribute->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "MeterAttribute->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "MeterAttribute->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "MeterAttribute->PermissionTree_Description" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "MeterAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": true, "x-propertyPath": "MeterAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "MeterAttribute->Attribute_Description" }, "attributeAllowAnyValue": { "title": "attributeAllowAnyValue", "type": "boolean", "x-nullable": true, "x-propertyPath": "MeterAttribute->Attribute_AllowAnyValue" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "MeterAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "attributeDefaultValue": { "title": "attributeDefaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "MeterAttribute->Attribute_DefaultValue", "x-formatSpecifier": "DynamicValue" }, "attributeDefaultAllowedValueId": { "title": "attributeDefaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MeterAttribute->Attribute_DefaultAllowedValue_Id" }, "attributeDefaultAllowedValueDescription": { "title": "attributeDefaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "MeterAttribute->Attribute_DefaultAllowedValue_Description" }, "attributeDefaultAllowedValueValue": { "title": "attributeDefaultAllowedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "MeterAttribute->Attribute_DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "MeterAttribute->Notes" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MeterAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "MeterAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "MeterAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "MeterAttribute->SequenceNumber" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "MeterAttribute->Value", "x-formatSpecifier": "DynamicValue" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetMeterAttributeCollectionForMeterResourceActionResponse": { "title": "GetMeterAttributeCollectionForMeterResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMeterAttributeCollectionForMeterResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "GetMeterAttributeCollectionForMeterResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "MeterAttribute->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MeterAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "MeterAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "MeterAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "MeterAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MeterAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "MeterAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "MeterAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "MeterAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "MeterAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MeterAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MeterAttribute->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetMeterAttributeCollectionResourceActionResponse": { "title": "GetMeterAttributeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMeterAttributeCollectionResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "GetMeterAttributeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MeterAttribute->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": false, "x-propertyPath": "MeterAttribute->Meter_Code" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "MeterAttribute->Meter_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "MeterAttribute->SequenceNumber" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MeterAttribute->Attribute_Id" }, "attributeCode": { "title": "attributeCode", "type": "string", "x-nullable": false, "x-propertyPath": "MeterAttribute->Attribute_Code" }, "attributeDescription": { "title": "attributeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "MeterAttribute->Attribute_Description" }, "attributeDataType": { "title": "attributeDataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "MeterAttribute->Attribute_DataType", "x-formatSpecifier": "DynamicValueType" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MeterAttribute->PredefinedValue_Id" }, "predefinedValueDescription": { "title": "predefinedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "MeterAttribute->PredefinedValue_Description" }, "predefinedValueValue": { "title": "predefinedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "MeterAttribute->PredefinedValue_Value", "x-formatSpecifier": "DynamicValue" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "MeterAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "MeterAttribute->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MeterAttribute->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MeterAttribute->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "MeterAttributeAttributeAllowedValueLookupResourceActionResponse": { "title": "MeterAttributeAttributeAllowedValueLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MeterAttributeAttributeAllowedValueLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "MeterAttributeAttributeAllowedValueLookupResourceActionResponseItemProperties", "type": "object", "properties": { "description": { "title": "description", "type": "string", "x-nullable": true, "x-propertyPath": "AttributeAllowedValue->Description" }, "value": { "title": "value", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "AttributeAllowedValue->Value", "x-formatSpecifier": "DynamicValue" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "MeterAttributeAttributeLookupResourceActionResponse": { "title": "MeterAttributeAttributeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MeterAttributeAttributeLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "MeterAttributeAttributeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Attribute->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Attribute->Description" }, "allowAnyValue": { "title": "allowAnyValue", "type": "boolean", "x-nullable": false, "x-propertyPath": "Attribute->AllowAnyValue" }, "dataType": { "title": "dataType", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "Attribute->DataType", "x-formatSpecifier": "DynamicValueType" }, "defaultValue": { "title": "defaultValue", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultValue", "x-formatSpecifier": "DynamicValue", "x-NullExpression": "Attribute->AllowAnyValue eq false" }, "defaultAllowedValueId": { "title": "defaultAllowedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Id" }, "defaultAllowedValueValue": { "title": "defaultAllowedValueValue", "format": "composite", "x-nullable": false, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "Attribute->DefaultAllowedValue_Value", "x-formatSpecifier": "DynamicValue" }, "defaultAllowedValueDescription": { "title": "defaultAllowedValueDescription", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->DefaultAllowedValue_Description" }, "explanation": { "title": "explanation", "type": "string", "x-nullable": true, "x-propertyPath": "Attribute->Explanation" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "MeterAttributeChangePermissionTreeLookupResourceActionResponse": { "title": "MeterAttributeChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MeterAttributeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "MeterAttributeChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "MeterAttributeInsertPermissionTreeLookupResourceActionResponse": { "title": "MeterAttributeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MeterAttributeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "MeterAttributeInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "MeterAttributeMeterLookupResourceActionResponse": { "title": "MeterAttributeMeterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MeterAttributeMeterLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "MeterAttributeMeterLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateMeterAttributeResourceActionRequest": { "title": "CreateMeterAttributeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateMeterAttributeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "meterId", "attributeId" ], "properties": { "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "MeterAttribute->Meter_Id" }, "attributeId": { "title": "attributeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "MeterAttribute->Attribute_Id" }, "value": { "title": "value", "format": "composite", "x-nullable": true, "$ref": "#/definitions/DynamicValueSchema", "x-propertyPath": "MeterAttribute->Value", "x-formatSpecifier": "DynamicValue" }, "predefinedValueId": { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MeterAttribute->PredefinedValue_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "MeterAttribute->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "MeterAttribute->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "MeterAttribute->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateMeterAttributeResourceActionRequest": { "title": "UpdateMeterAttributeResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "value", "format": "composite", "x-nullable": true, "x-propertyPath": "MeterAttribute->Value", "x-formatSpecifier": "DynamicValue" }, { "title": "predefinedValueId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MeterAttribute->PredefinedValue_Id" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "MeterAttribute->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "MeterAttribute->Notes" } ] } } }, "DeleteMeterAttributeResourceActionRequest": { "title": "DeleteMeterAttributeResourceActionRequest", "type": "object", "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", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetMeterAttributeResourceAction": { "title": "BatchGetMeterAttributeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Meter Attribute entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Meter Attribute entities", "items": { "$ref": "#/definitions/GetMeterAttributeResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateMeterAttributeResourceActionRequest": { "title": "BatchCreateMeterAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateMeterAttributeResourceActionRequest" } }, "BatchUpdateMeterAttributeResourceActionRequest": { "title": "BatchUpdateMeterAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateMeterAttributeResourceActionRequest" } }, "BatchDeleteMeterAttributeResourceActionRequest": { "title": "BatchDeleteMeterAttributeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteMeterAttributeResourceActionRequest" } }, "ChangeMeterAttributeIsActiveResourceActionRequest": { "title": "ChangeMeterAttributeIsActiveResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "MeterAttribute->IsActive" } ] } } }, "ChangeMeterAttributePermissionTreeResourceActionRequest": { "title": "ChangeMeterAttributePermissionTreeResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "MeterAttribute->PermissionTree_Id" } ] } } }, "BatchChangeMeterAttributePermissionTreeResourceActionRequest": { "title": "BatchChangeMeterAttributePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeMeterAttributePermissionTreeResourceActionRequest" } }, "BatchChangeMeterAttributeIsActiveResourceActionRequest": { "title": "BatchChangeMeterAttributeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeMeterAttributeIsActiveResourceActionRequest" } }, "GetMeterDocumentResourceActionResponse": { "title": "GetMeterDocumentResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetMeterDocumentResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "MeterDocument->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": true, "x-propertyPath": "MeterDocument->Meter_Code" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "MeterDocument->Meter_Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": true, "x-propertyPath": "MeterDocument->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MeterDocument->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "MeterDocument->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "MeterDocument->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MeterDocument->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MeterDocument->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "MeterDocument->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "MeterDocument->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MeterDocument->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "MeterDocument->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "MeterDocument->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "MeterDocument->PermissionTree_Description" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "MeterDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": true, "x-propertyPath": "MeterDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": true, "x-propertyPath": "MeterDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "MeterDocument->DocumentRecord_FileLocation" }, "documentRecordFileInfoId": { "title": "documentRecordFileInfoId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MeterDocument->DocumentRecord_FileInfoId" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "MeterDocument->DocumentRecord_FileFullName" }, "documentRecordContentId": { "title": "documentRecordContentId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MeterDocument->DocumentRecord_Content_Id" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "MeterDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeId": { "title": "documentRecordFileTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MeterDocument->DocumentRecord_FileType_Id" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "MeterDocument->DocumentRecord_FileType_Extension" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "MeterDocument->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "MeterDocument->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetMeterDocumentCollectionForMeterResourceActionResponse": { "title": "GetMeterDocumentCollectionForMeterResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMeterDocumentCollectionForMeterResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "GetMeterDocumentCollectionForMeterResourceActionResponseItemProperties", "type": "object", "properties": { "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "MeterDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MeterDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "MeterDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "MeterDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "MeterDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "MeterDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "MeterDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "MeterDocument->DocumentRecord_FileType_Extension" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetMeterDocumentCollectionResourceActionResponse": { "title": "GetMeterDocumentCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMeterDocumentCollectionResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "GetMeterDocumentCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MeterDocument->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": false, "x-propertyPath": "MeterDocument->Meter_Code" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "MeterDocument->Meter_Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "MeterDocument->SequenceNumber" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MeterDocument->DocumentRecord_Id" }, "documentRecordCode": { "title": "documentRecordCode", "type": "string", "x-nullable": false, "x-propertyPath": "MeterDocument->DocumentRecord_Code" }, "documentRecordDescription": { "title": "documentRecordDescription", "type": "string", "x-nullable": false, "x-propertyPath": "MeterDocument->DocumentRecord_Description" }, "documentRecordFileLocation": { "title": "documentRecordFileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "MeterDocument->DocumentRecord_FileLocation" }, "documentRecordFileFullName": { "title": "documentRecordFileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "MeterDocument->DocumentRecord_FileFullName" }, "documentRecordContentSizeInMb": { "title": "documentRecordContentSizeInMb", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "MeterDocument->DocumentRecord_Content_SizeInMb" }, "documentRecordFileTypeExtension": { "title": "documentRecordFileTypeExtension", "type": "string", "x-nullable": true, "x-propertyPath": "MeterDocument->DocumentRecord_FileType_Extension" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "MeterDocumentChangePermissionTreeLookupResourceActionResponse": { "title": "MeterDocumentChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MeterDocumentChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "MeterDocumentChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "MeterDocumentDocumentLookupResourceActionResponse": { "title": "MeterDocumentDocumentLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MeterDocumentDocumentLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "MeterDocumentDocumentLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->Description" }, "documentFolderDescription": { "title": "documentFolderDescription", "type": "string", "x-nullable": false, "x-propertyPath": "DocumentRecord->DocumentFolder_Description" }, "fileLocation": { "title": "fileLocation", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->FileLocation" }, "fileFullName": { "title": "fileFullName", "type": "string", "x-nullable": true, "x-propertyPath": "DocumentRecord->FileFullName" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "MeterDocumentInsertPermissionTreeLookupResourceActionResponse": { "title": "MeterDocumentInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MeterDocumentInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "MeterDocumentInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "MeterDocumentMeterLookupResourceActionResponse": { "title": "MeterDocumentMeterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MeterDocumentMeterLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "MeterDocumentMeterLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateMeterDocumentResourceActionRequest": { "title": "CreateMeterDocumentResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateMeterDocumentResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "meterId", "documentRecordId" ], "properties": { "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "MeterDocument->Meter_Id" }, "documentRecordId": { "title": "documentRecordId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "MeterDocument->DocumentRecord_Id" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "MeterDocument->PermissionTree_Id", "x-systemGenerated": true }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "MeterDocument->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "MeterDocument->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateMeterDocumentResourceActionRequest": { "title": "UpdateMeterDocumentResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "MeterDocument->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "MeterDocument->Notes" } ] } } }, "DeleteMeterDocumentResourceActionRequest": { "title": "DeleteMeterDocumentResourceActionRequest", "type": "object", "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", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetMeterDocumentResourceAction": { "title": "BatchGetMeterDocumentResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Meter Document entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Meter Document entities", "items": { "$ref": "#/definitions/GetMeterDocumentResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateMeterDocumentResourceActionRequest": { "title": "BatchCreateMeterDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateMeterDocumentResourceActionRequest" } }, "BatchUpdateMeterDocumentResourceActionRequest": { "title": "BatchUpdateMeterDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateMeterDocumentResourceActionRequest" } }, "BatchDeleteMeterDocumentResourceActionRequest": { "title": "BatchDeleteMeterDocumentResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteMeterDocumentResourceActionRequest" } }, "ChangeMeterDocumentIsActiveResourceActionRequest": { "title": "ChangeMeterDocumentIsActiveResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "MeterDocument->IsActive" } ] } } }, "ChangeMeterDocumentPermissionTreeResourceActionRequest": { "title": "ChangeMeterDocumentPermissionTreeResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "MeterDocument->PermissionTree_Id" } ] } } }, "BatchChangeMeterDocumentPermissionTreeResourceActionRequest": { "title": "BatchChangeMeterDocumentPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeMeterDocumentPermissionTreeResourceActionRequest" } }, "BatchChangeMeterDocumentIsActiveResourceActionRequest": { "title": "BatchChangeMeterDocumentIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeMeterDocumentIsActiveResourceActionRequest" } }, "GetMeterReadingResourceActionResponse": { "title": "GetMeterReadingResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetMeterReadingResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MeterReading->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "MeterReading->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "MeterReading->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MeterReading->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MeterReading->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "MeterReading->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "MeterReading->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MeterReading->ModifiedOn" }, "cumulativeReading": { "title": "cumulativeReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "MeterReading->CumulativeReading" }, "isAssetConsumptionReading": { "title": "isAssetConsumptionReading", "type": "boolean", "x-nullable": true, "x-propertyPath": "MeterReading->IsAssetConsumptionReading" }, "locationId": { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MeterReading->Location_Id" }, "locationCode": { "title": "locationCode", "type": "string", "x-nullable": true, "x-propertyPath": "MeterReading->Location_Code" }, "locationDescription": { "title": "locationDescription", "type": "string", "x-nullable": true, "x-propertyPath": "MeterReading->Location_Description" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "MeterReading->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": true, "x-propertyPath": "MeterReading->Meter_Code" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": true, "x-propertyPath": "MeterReading->Meter_Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "MeterReading->Notes" }, "reading": { "title": "reading", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "MeterReading->Reading" }, "readingOn": { "title": "readingOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MeterReading->ReadingOn" }, "resetType": { "title": "resetType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "MeterReading->ResetType", "x-formatSpecifier": "MeterReadingResetType" }, "resetValue": { "title": "resetValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "MeterReading->ResetValue" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MeterReading->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": true, "x-propertyPath": "MeterReading->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": true, "x-propertyPath": "MeterReading->Site_Description" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetMeterReadingCollectionResourceActionResponse": { "title": "GetMeterReadingCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMeterReadingCollectionResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "GetMeterReadingCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MeterReading->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": false, "x-propertyPath": "MeterReading->Meter_Code" }, "meterDescription": { "title": "meterDescription", "type": "string", "x-nullable": false, "x-propertyPath": "MeterReading->Meter_Description" }, "reading": { "title": "reading", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "MeterReading->Reading" }, "cumulativeReading": { "title": "cumulativeReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "MeterReading->CumulativeReading" }, "resetValue": { "title": "resetValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "MeterReading->ResetValue" }, "resetType": { "title": "resetType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "MeterReading->ResetType", "x-formatSpecifier": "MeterReadingResetType" }, "readingOn": { "title": "readingOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MeterReading->ReadingOn" }, "isAssetConsumptionReading": { "title": "isAssetConsumptionReading", "type": "boolean", "x-nullable": true, "x-propertyPath": "MeterReading->IsAssetConsumptionReading" }, "locationId": { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MeterReading->Location_Id" }, "locationCode": { "title": "locationCode", "type": "string", "x-nullable": false, "x-propertyPath": "MeterReading->Location_Code" }, "locationDescription": { "title": "locationDescription", "type": "string", "x-nullable": false, "x-propertyPath": "MeterReading->Location_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MeterReading->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "MeterReading->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "MeterReading->Site_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetMeterReadingForMeterCollectionResourceActionResponse": { "title": "GetMeterReadingForMeterCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetMeterReadingForMeterCollectionResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "GetMeterReadingForMeterCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "reading": { "title": "reading", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "MeterReading->Reading" }, "cumulativeReading": { "title": "cumulativeReading", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "MeterReading->CumulativeReading" }, "resetValue": { "title": "resetValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "MeterReading->ResetValue" }, "resetType": { "title": "resetType", "type": "string", "format": "enum", "x-nullable": true, "x-propertyPath": "MeterReading->ResetType", "x-formatSpecifier": "MeterReadingResetType" }, "readingOn": { "title": "readingOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MeterReading->ReadingOn" }, "isAssetConsumptionReading": { "title": "isAssetConsumptionReading", "type": "boolean", "x-nullable": true, "x-propertyPath": "MeterReading->IsAssetConsumptionReading" }, "locationId": { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MeterReading->Location_Id" }, "locationCode": { "title": "locationCode", "type": "string", "x-nullable": false, "x-propertyPath": "MeterReading->Location_Code" }, "locationDescription": { "title": "locationDescription", "type": "string", "x-nullable": false, "x-propertyPath": "MeterReading->Location_Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MeterReading->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "MeterReading->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "MeterReading->Site_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "MeterReadingLocationLookupResourceActionResponse": { "title": "MeterReadingLocationLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MeterReadingLocationLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "MeterReadingLocationLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Location->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Location->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "MeterReadingMeterLookupResourceActionResponse": { "title": "MeterReadingMeterLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "MeterReadingMeterLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "MeterReadingMeterLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Description" }, "siteId": { "title": "siteId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "Meter->Site_Id" }, "siteCode": { "title": "siteCode", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Site_Code" }, "siteDescription": { "title": "siteDescription", "type": "string", "x-nullable": false, "x-propertyPath": "Meter->Site_Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateMeterReadingResourceActionRequest": { "title": "CreateMeterReadingResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateMeterReadingResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "meterId", "reading", "readingOn" ], "properties": { "locationId": { "title": "locationId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "MeterReading->Location_Id" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "MeterReading->Meter_Id" }, "reading": { "title": "reading", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "MeterReading->Reading" }, "readingOn": { "title": "readingOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MeterReading->ReadingOn" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "MeterReading->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateMeterReadingResourceActionRequest": { "title": "UpdateMeterReadingResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "reading", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "MeterReading->Reading" }, { "title": "readingOn", "type": "string", "format": "date-time", "x-nullable": false, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "MeterReading->ReadingOn" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "MeterReading->Notes" } ] } } }, "DeleteMeterReadingResourceActionRequest": { "title": "DeleteMeterReadingResourceActionRequest", "type": "object", "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", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetMeterReadingResourceAction": { "title": "BatchGetMeterReadingResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Meter Reading entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Meter Reading entities", "items": { "$ref": "#/definitions/GetMeterReadingResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateMeterReadingResourceActionRequest": { "title": "BatchCreateMeterReadingResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateMeterReadingResourceActionRequest" } }, "BatchUpdateMeterReadingResourceActionRequest": { "title": "BatchUpdateMeterReadingResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateMeterReadingResourceActionRequest" } }, "BatchDeleteMeterReadingResourceActionRequest": { "title": "BatchDeleteMeterReadingResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteMeterReadingResourceActionRequest" } }, "ValidateMeterReadingMeterAdrResourceActionRequest": { "title": "ValidateMeterReadingMeterAdrResourceActionRequest", "type": "object", "properties": { "properties": { "title": "ValidateMeterReadingMeterAdrResourceActionRequestProperties", "type": "object", "x-nullable": false, "properties": { "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ValidateMeterAdrEntity->Meter_Id" }, "readingValue": { "title": "readingValue", "type": "number", "format": "decimal", "x-nullable": true, "x-propertyPath": "ValidateMeterAdrEntity->ReadingValue" }, "readingOn": { "title": "readingOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "ValidateMeterAdrEntity->ReadingOn" }, "meterReadingId": { "title": "meterReadingId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "ValidateMeterAdrEntity->MeterReading_Id" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "GetPredictedMeterReadingResourceActionResponse": { "title": "GetPredictedMeterReadingResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetPredictedMeterReadingResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PredictedMeterReading->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "PredictedMeterReading->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "PredictedMeterReading->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "PredictedMeterReading->CreatedOn" }, "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PredictedMeterReading->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": true, "x-propertyPath": "PredictedMeterReading->Meter_Code" }, "reading": { "title": "reading", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PredictedMeterReading->Reading" }, "readingOn": { "title": "readingOn", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "PredictedMeterReading->ReadingOn" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetPredictedMeterReadingCollectionResourceActionResponse": { "title": "GetPredictedMeterReadingCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPredictedMeterReadingCollectionResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPredictedMeterReadingCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PredictedMeterReading->Meter_Id" }, "meterCode": { "title": "meterCode", "type": "string", "x-nullable": false, "x-propertyPath": "PredictedMeterReading->Meter_Code" }, "reading": { "title": "reading", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PredictedMeterReading->Reading" }, "readingOn": { "title": "readingOn", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "PredictedMeterReading->ReadingOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "GetPredictedMeterReadingForMeterCollectionResourceActionResponse": { "title": "GetPredictedMeterReadingForMeterCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetPredictedMeterReadingForMeterCollectionResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "GetPredictedMeterReadingForMeterCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "reading": { "title": "reading", "type": "number", "format": "decimal", "x-nullable": false, "x-propertyPath": "PredictedMeterReading->Reading" }, "readingOn": { "title": "readingOn", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "PredictedMeterReading->ReadingOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreatePredictedMeterReadingResourceActionRequest": { "title": "CreatePredictedMeterReadingResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreatePredictedMeterReadingResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "meterId" ], "properties": { "meterId": { "title": "meterId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "PredictedMeterReading->Meter_Id" }, "reading": { "title": "reading", "type": "number", "format": "decimal", "minimum": 0.0, "x-nullable": false, "x-propertyPath": "PredictedMeterReading->Reading" }, "readingOn": { "title": "readingOn", "type": "string", "format": "date", "x-nullable": false, "example": "2005-04-20", "x-propertyPath": "PredictedMeterReading->ReadingOn" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "BatchGetPredictedMeterReadingResourceAction": { "title": "BatchGetPredictedMeterReadingResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Predicted Meter Reading entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Predicted Meter Reading entities", "items": { "$ref": "#/definitions/GetPredictedMeterReadingResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreatePredictedMeterReadingResourceActionRequest": { "title": "BatchCreatePredictedMeterReadingResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreatePredictedMeterReadingResourceActionRequest" } }, "GetTimeLossCategoryResourceActionResponse": { "title": "GetTimeLossCategoryResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetTimeLossCategoryResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TimeLossCategory->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TimeLossCategory->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "TimeLossCategory->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "TimeLossCategory->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TimeLossCategory->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "TimeLossCategory->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TimeLossCategory->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "TimeLossCategory->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "TimeLossCategory->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TimeLossCategory->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TimeLossCategory->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "TimeLossCategory->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "TimeLossCategory->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TimeLossCategory->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TimeLossCategory->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TimeLossCategory->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetTimeLossCategoryCollectionResourceActionResponse": { "title": "GetTimeLossCategoryCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTimeLossCategoryCollectionResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTimeLossCategoryCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TimeLossCategory->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TimeLossCategory->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TimeLossCategory->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TimeLossCategory->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TimeLossCategory->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TimeLossCategory->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "TimeLossCategoryChangePermissionTreeLookupResourceActionResponse": { "title": "TimeLossCategoryChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "TimeLossCategoryChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "TimeLossCategoryChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "TimeLossCategoryInsertPermissionTreeLookupResourceActionResponse": { "title": "TimeLossCategoryInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "TimeLossCategoryInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "TimeLossCategoryInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateTimeLossCategoryResourceActionRequest": { "title": "CreateTimeLossCategoryResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateTimeLossCategoryResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TimeLossCategory->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "TimeLossCategory->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "TimeLossCategory->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TimeLossCategory->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TimeLossCategory->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateTimeLossCategoryResourceActionRequest": { "title": "UpdateTimeLossCategoryResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "TimeLossCategory->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "TimeLossCategory->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TimeLossCategory->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TimeLossCategory->Notes" } ] } } }, "DeleteTimeLossCategoryResourceActionRequest": { "title": "DeleteTimeLossCategoryResourceActionRequest", "type": "object", "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", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetTimeLossCategoryResourceAction": { "title": "BatchGetTimeLossCategoryResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Time Loss Category entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Time Loss Category entities", "items": { "$ref": "#/definitions/GetTimeLossCategoryResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateTimeLossCategoryResourceActionRequest": { "title": "BatchCreateTimeLossCategoryResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateTimeLossCategoryResourceActionRequest" } }, "BatchUpdateTimeLossCategoryResourceActionRequest": { "title": "BatchUpdateTimeLossCategoryResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateTimeLossCategoryResourceActionRequest" } }, "BatchDeleteTimeLossCategoryResourceActionRequest": { "title": "BatchDeleteTimeLossCategoryResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteTimeLossCategoryResourceActionRequest" } }, "ChangeTimeLossCategoryIsActiveResourceActionRequest": { "title": "ChangeTimeLossCategoryIsActiveResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "TimeLossCategory->IsActive" } ] } } }, "ChangeTimeLossCategoryPermissionTreeResourceActionRequest": { "title": "ChangeTimeLossCategoryPermissionTreeResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TimeLossCategory->PermissionTree_Id" } ] } } }, "BatchChangeTimeLossCategoryIsActiveResourceActionRequest": { "title": "BatchChangeTimeLossCategoryIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeTimeLossCategoryIsActiveResourceActionRequest" } }, "BatchChangeTimeLossCategoryPermissionTreeResourceActionRequest": { "title": "BatchChangeTimeLossCategoryPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeTimeLossCategoryPermissionTreeResourceActionRequest" } }, "GetTimeLossReasonResourceActionResponse": { "title": "GetTimeLossReasonResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetTimeLossReasonResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TimeLossReason->Code" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "TimeLossReason->IsActive" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TimeLossReason->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "TimeLossReason->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "TimeLossReason->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TimeLossReason->CreatedOn" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TimeLossReason->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "TimeLossReason->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "TimeLossReason->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TimeLossReason->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TimeLossReason->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "TimeLossReason->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "TimeLossReason->PermissionTree_Description" }, "allowedDuration": { "title": "allowedDuration", "type": "string", "format": "duration", "x-nullable": false, "example": "P4DT12H30M5S", "x-propertyPath": "TimeLossReason->AllowedDuration" }, "classification": { "title": "classification", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "TimeLossReason->Classification", "x-formatSpecifier": "TimeLossReasonClassification" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TimeLossReason->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TimeLossReason->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TimeLossReason->SequenceNumber" }, "timeLossCategoryId": { "title": "timeLossCategoryId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TimeLossReason->TimeLossCategory_Id" }, "timeLossCategoryCode": { "title": "timeLossCategoryCode", "type": "string", "x-nullable": true, "x-propertyPath": "TimeLossReason->TimeLossCategory_Code" }, "timeLossCategoryDescription": { "title": "timeLossCategoryDescription", "type": "string", "x-nullable": true, "x-propertyPath": "TimeLossReason->TimeLossCategory_Description" }, "timeLossTypeId": { "title": "timeLossTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TimeLossReason->TimeLossType_Id" }, "timeLossTypeCode": { "title": "timeLossTypeCode", "type": "string", "x-nullable": true, "x-propertyPath": "TimeLossReason->TimeLossType_Code" }, "timeLossTypeDescription": { "title": "timeLossTypeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "TimeLossReason->TimeLossType_Description" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetTimeLossReasonCollectionResourceActionResponse": { "title": "GetTimeLossReasonCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTimeLossReasonCollectionResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTimeLossReasonCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TimeLossReason->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TimeLossReason->Description" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "TimeLossReason->IsActive" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TimeLossReason->SequenceNumber" }, "classification": { "title": "classification", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "TimeLossReason->Classification", "x-formatSpecifier": "TimeLossReasonClassification" }, "allowedDuration": { "title": "allowedDuration", "type": "string", "format": "duration", "x-nullable": false, "example": "P4DT12H30M5S", "x-propertyPath": "TimeLossReason->AllowedDuration" }, "timeLossCategoryId": { "title": "timeLossCategoryId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TimeLossReason->TimeLossCategory_Id" }, "timeLossCategoryCode": { "title": "timeLossCategoryCode", "type": "string", "x-nullable": false, "x-propertyPath": "TimeLossReason->TimeLossCategory_Code" }, "timeLossCategoryDescription": { "title": "timeLossCategoryDescription", "type": "string", "x-nullable": false, "x-propertyPath": "TimeLossReason->TimeLossCategory_Description" }, "timeLossTypeId": { "title": "timeLossTypeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TimeLossReason->TimeLossType_Id" }, "timeLossTypeCode": { "title": "timeLossTypeCode", "type": "string", "x-nullable": false, "x-propertyPath": "TimeLossReason->TimeLossType_Code" }, "timeLossTypeDescription": { "title": "timeLossTypeDescription", "type": "string", "x-nullable": false, "x-propertyPath": "TimeLossReason->TimeLossType_Description" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TimeLossReason->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TimeLossReason->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "TimeLossReasonChangePermissionTreeLookupResourceActionResponse": { "title": "TimeLossReasonChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "TimeLossReasonChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "TimeLossReasonChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "TimeLossReasonInsertPermissionTreeLookupResourceActionResponse": { "title": "TimeLossReasonInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "TimeLossReasonInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "TimeLossReasonInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "TimeLossReasonCategoryLookupResponse": { "title": "TimeLossReasonCategoryLookupResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "TimeLossReasonCategoryLookupResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "TimeLossReasonCategoryLookupResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TimeLossCategory->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TimeLossCategory->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "TimeLossReasonTypeLookupResponse": { "title": "TimeLossReasonTypeLookupResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "TimeLossReasonTypeLookupResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "TimeLossReasonTypeLookupResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TimeLossType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TimeLossType->Description" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateTimeLossReasonResourceActionRequest": { "title": "CreateTimeLossReasonResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateTimeLossReasonResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "code", "description", "permissionTreeId", "classification", "timeLossCategoryId", "timeLossTypeId", "allowedDuration" ], "properties": { "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "TimeLossReason->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "TimeLossReason->Description" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TimeLossReason->PermissionTree_Id" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TimeLossReason->SequenceNumber" }, "classification": { "title": "classification", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "TimeLossReason->Classification", "x-formatSpecifier": "TimeLossReasonClassification" }, "timeLossCategoryId": { "title": "timeLossCategoryId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TimeLossReason->TimeLossCategory_Id" }, "timeLossTypeId": { "title": "timeLossTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TimeLossReason->TimeLossType_Id" }, "allowedDuration": { "title": "allowedDuration", "type": "string", "format": "duration", "x-nullable": false, "example": "P4DT12H30M5S", "x-propertyPath": "TimeLossReason->AllowedDuration" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TimeLossReason->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateTimeLossReasonResourceActionRequest": { "title": "UpdateTimeLossReasonResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "TimeLossReason->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "TimeLossReason->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TimeLossReason->SequenceNumber" }, { "title": "classification", "type": "string", "format": "enum", "x-nullable": false, "x-propertyPath": "TimeLossReason->Classification", "x-formatSpecifier": "TimeLossReasonClassification" }, { "title": "timeLossCategoryId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TimeLossReason->TimeLossCategory_Id" }, { "title": "timeLossTypeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TimeLossReason->TimeLossType_Id" }, { "title": "allowedDuration", "type": "string", "format": "duration", "x-nullable": false, "example": "P4DT12H30M5S", "x-propertyPath": "TimeLossReason->AllowedDuration" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TimeLossReason->Notes" } ] } } }, "DeleteTimeLossReasonResourceActionRequest": { "title": "DeleteTimeLossReasonResourceActionRequest", "type": "object", "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", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetTimeLossReasonResourceAction": { "title": "BatchGetTimeLossReasonResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Time Loss Reason entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Time Loss Reason entities", "items": { "$ref": "#/definitions/GetTimeLossReasonResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateTimeLossReasonResourceActionRequest": { "title": "BatchCreateTimeLossReasonResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateTimeLossReasonResourceActionRequest" } }, "BatchUpdateTimeLossReasonResourceActionRequest": { "title": "BatchUpdateTimeLossReasonResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateTimeLossReasonResourceActionRequest" } }, "BatchDeleteTimeLossReasonResourceActionRequest": { "title": "BatchDeleteTimeLossReasonResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteTimeLossReasonResourceActionRequest" } }, "ChangeTimeLossReasonIsActiveResourceActionRequest": { "title": "ChangeTimeLossReasonIsActiveResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "TimeLossReason->IsActive" } ] } } }, "ChangeTimeLossReasonPermissionTreeResourceActionRequest": { "title": "ChangeTimeLossReasonPermissionTreeResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TimeLossReason->PermissionTree_Id" } ] } } }, "BatchChangeTimeLossReasonIsActiveResourceActionRequest": { "title": "BatchChangeTimeLossReasonIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeTimeLossReasonIsActiveResourceActionRequest" } }, "BatchChangeTimeLossReasonPermissionTreeResourceActionRequest": { "title": "BatchChangeTimeLossReasonPermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeTimeLossReasonPermissionTreeResourceActionRequest" } }, "GetTimeLossTypeResourceActionResponse": { "title": "GetTimeLossTypeResourceActionResponse", "type": "object", "required": [ "properties" ], "properties": { "class": { "title": "class", "type": "string" }, "id": { "title": "id", "type": "integer", "format": "int64", "x-nullable": false, "example": 13243893 }, "version": { "title": "version", "type": "integer", "format": "int32", "x-nullable": false, "example": 1 }, "properties": { "title": "GetTimeLossTypeResourceActionResponseProperties", "type": "object", "x-nullable": false, "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TimeLossType->Code" }, "createdByUserId": { "title": "createdByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TimeLossType->CreatedByUser_Id" }, "createdByUserCode": { "title": "createdByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "TimeLossType->CreatedByUser_Code" }, "createdByUserFullName": { "title": "createdByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "TimeLossType->CreatedByUser_FullName" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TimeLossType->CreatedOn" }, "isActive": { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "TimeLossType->IsActive" }, "modifiedByUserId": { "title": "modifiedByUserId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "TimeLossType->ModifiedByUser_Id" }, "modifiedByUserCode": { "title": "modifiedByUserCode", "type": "string", "x-nullable": true, "x-propertyPath": "TimeLossType->ModifiedByUser_Code" }, "modifiedByUserFullName": { "title": "modifiedByUserFullName", "type": "string", "x-nullable": true, "x-propertyPath": "TimeLossType->ModifiedByUser_FullName" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TimeLossType->ModifiedOn" }, "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TimeLossType->PermissionTree_Id" }, "permissionTreeCode": { "title": "permissionTreeCode", "type": "string", "x-nullable": true, "x-propertyPath": "TimeLossType->PermissionTree_Code" }, "permissionTreeDescription": { "title": "permissionTreeDescription", "type": "string", "x-nullable": true, "x-propertyPath": "TimeLossType->PermissionTree_Description" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TimeLossType->Description" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TimeLossType->Notes" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TimeLossType->SequenceNumber" } } }, "permissionViolations": { "title": "permissionViolations", "type": "array", "description": "Permissions violations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPermissionViolationSchema" } }, "translations": { "title": "translations", "type": "array", "description": "Custom translations for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/EntityPhraseTranslationSchema" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "self": { "$ref": "#/definitions/Link" } } }, "GetTimeLossTypeCollectionResourceActionResponse": { "title": "GetTimeLossTypeCollectionResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "GetTimeLossTypeCollectionResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "GetTimeLossTypeCollectionResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "TimeLossType->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "TimeLossType->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TimeLossType->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TimeLossType->Notes" }, "createdOn": { "title": "createdOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TimeLossType->CreatedOn" }, "modifiedOn": { "title": "modifiedOn", "type": "string", "format": "date-time", "x-nullable": true, "example": "2005-04-20T11:52:23.0000000Z", "x-propertyPath": "TimeLossType->ModifiedOn" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "TimeLossTypeChangePermissionTreeLookupResourceActionResponse": { "title": "TimeLossTypeChangePermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "TimeLossTypeChangePermissionTreeLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "TimeLossTypeChangePermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "TimeLossTypeInsertPermissionTreeLookupResourceActionResponse": { "title": "TimeLossTypeInsertPermissionTreeLookupResourceActionResponse", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "self": { "$ref": "#/definitions/Link" }, "next": { "$ref": "#/definitions/Link" }, "prev": { "$ref": "#/definitions/Link" }, "items": { "title": "items", "type": "array", "description": "Pageable collection of entities", "items": { "title": "TimeLossTypeInsertPermissionTreeLookupResourceActionResponseItem", "type": "object", "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", "x-nullable": true, "example": 2 }, "properties": { "title": "TimeLossTypeInsertPermissionTreeLookupResourceActionResponseItemProperties", "type": "object", "properties": { "code": { "title": "code", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Code" }, "description": { "title": "description", "type": "string", "x-nullable": false, "x-propertyPath": "PermissionTree->Description" }, "idPermissionTreeMatrixIdTreeLevel": { "title": "idPermissionTreeMatrixIdTreeLevel", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "PermissionTree->*Id.PermissionTreeMatrix.Id_TreeLevel" }, "parentPermissionTreeId": { "title": "parentPermissionTreeId", "type": "integer", "format": "int64", "x-nullable": true, "x-propertyPath": "PermissionTree->ParentPermissionTree_Id" } } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } } }, "mapping": { "title": "mapping", "type": "array", "description": "Collection of source to target property mappings", "x-nullable": true, "items": { "$ref": "#/definitions/LinkMapping" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } } } }, "CreateTimeLossTypeResourceActionRequest": { "title": "CreateTimeLossTypeResourceActionRequest", "type": "object", "properties": { "properties": { "title": "CreateTimeLossTypeResourceActionRequestProperties", "type": "object", "x-nullable": false, "required": [ "permissionTreeId", "code", "description" ], "properties": { "permissionTreeId": { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TimeLossType->PermissionTree_Id" }, "code": { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "TimeLossType->Code" }, "description": { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "TimeLossType->Description" }, "sequenceNumber": { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TimeLossType->SequenceNumber" }, "notes": { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TimeLossType->Notes" } } }, "userObjectId": { "title": "userObjectId", "type": "string", "description": "Only required for batch operations", "x-nullable": true } } }, "UpdateTimeLossTypeResourceActionRequest": { "title": "UpdateTimeLossTypeResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "code", "type": "string", "maxLength": 50, "minLength": 1, "x-nullable": false, "x-propertyPath": "TimeLossType->Code" }, { "title": "description", "type": "string", "maxLength": 100, "minLength": 1, "x-nullable": false, "x-propertyPath": "TimeLossType->Description" }, { "title": "sequenceNumber", "type": "integer", "format": "int32", "x-nullable": true, "x-propertyPath": "TimeLossType->SequenceNumber" }, { "title": "notes", "type": "string", "x-nullable": true, "x-propertyPath": "TimeLossType->Notes" } ] } } }, "DeleteTimeLossTypeResourceActionRequest": { "title": "DeleteTimeLossTypeResourceActionRequest", "type": "object", "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", "x-nullable": true, "example": 1 }, "version": { "title": "version", "type": "integer", "description": "Version of the entity to delete", "format": "int32", "example": 1 } } }, "BatchGetTimeLossTypeResourceAction": { "title": "BatchGetTimeLossTypeResourceAction", "type": "object", "properties": { "count": { "title": "count", "type": "integer", "description": "Number of Time Loss Type entities in the collection", "format": "int32", "x-nullable": false, "example": 2 }, "items": { "title": "items", "type": "array", "description": "Collection of Time Loss Type entities", "items": { "$ref": "#/definitions/GetTimeLossTypeResourceActionResponse" } }, "links": { "title": "links", "type": "array", "description": "Collection of hypermedia links", "items": { "$ref": "#/definitions/Link" } }, "messages": { "title": "messages", "type": "array", "description": "Messages for the entity data", "x-nullable": true, "items": { "$ref": "#/definitions/NotificationSchema" } }, "self": { "$ref": "#/definitions/Link" } } }, "BatchCreateTimeLossTypeResourceActionRequest": { "title": "BatchCreateTimeLossTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/CreateTimeLossTypeResourceActionRequest" } }, "BatchUpdateTimeLossTypeResourceActionRequest": { "title": "BatchUpdateTimeLossTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/UpdateTimeLossTypeResourceActionRequest" } }, "BatchDeleteTimeLossTypeResourceActionRequest": { "title": "BatchDeleteTimeLossTypeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/DeleteTimeLossTypeResourceActionRequest" } }, "ChangeTimeLossTypeIsActiveResourceActionRequest": { "title": "ChangeTimeLossTypeIsActiveResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "isActive", "type": "boolean", "x-nullable": false, "x-propertyPath": "TimeLossType->IsActive" } ] } } }, "ChangeTimeLossTypePermissionTreeResourceActionRequest": { "title": "ChangeTimeLossTypePermissionTreeResourceActionRequest", "type": "object", "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", "x-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": "#/definitions/EntityPatchOperationSchema" }, "x-patchproperties": [ { "title": "permissionTreeId", "type": "integer", "format": "int64", "x-nullable": false, "x-propertyPath": "TimeLossType->PermissionTree_Id" } ] } } }, "BatchChangeTimeLossTypeIsActiveResourceActionRequest": { "title": "BatchChangeTimeLossTypeIsActiveResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeTimeLossTypeIsActiveResourceActionRequest" } }, "BatchChangeTimeLossTypePermissionTreeResourceActionRequest": { "title": "BatchChangeTimeLossTypePermissionTreeResourceActionRequest", "type": "array", "items": { "$ref": "#/definitions/ChangeTimeLossTypePermissionTreeResourceActionRequest" } } }, "parameters": { "ExecutionMode": { "type": "string", "name": "mode", "in": "query", "description": "Execution mode to use for executing the batch operation", "enum": [ "AllOrNone", "PerRecord" ] }, "Async": { "type": "boolean", "name": "async", "in": "query", "description": "Enqueue the operation asynchronously using a Background Task." }, "AsyncDescription": { "type": "string", "name": "description", "in": "query", "description": "Optional description for the asynchronous execution of the Background Task." }, "Schedule": { "type": "string", "name": "schedule", "in": "query", "description": "Optional cron expression to schedule the asynchronous execution of the Background Task." }, "ScheduleFrom": { "type": "string", "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." }, "Filter": { "type": "string", "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'" }, "OrderBy": { "type": "string", "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" }, "Param": { "type": "string", "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'" }, "Select": { "type": "string", "name": "$select", "in": "query", "description": "Comma separated list of the data properties on the resource to return, e.g. $select=id,code,description" }, "Skip": { "type": "string", "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" }, "Top": { "type": "string", "name": "$top", "in": "query", "description": "Number of items to return in the response data, e.g. $top=20" } }, "responses": { "default": { "x-nullable": true, "description": "Error response - operation failed" }, "created": { "x-nullable": true, "description": "Success response - resource was successfully created", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the created resource" } } }, "accepted": { "description": "Request was successfully registered for asynchronous execution using a Background Task", "headers": { "OnKey-Request-Id": { "type": "integer", "description": "Request id for the Background Task created", "format": "Int64" }, "OnKey-Request-Location": { "type": "string", "description": "URI to poll for the asynchronous execution status of the request" } } }, "scheduled": { "description": "Request was successfully scheduled for asynchronous execution using a Scheduled Background Task", "headers": { "OnKey-Resource-Id": { "type": "integer", "description": "Id of the Scheduled Background Task resource created", "format": "Int64" }, "OnKey-Resource-Location": { "type": "string", "description": "Uri to fetch the Scheduled Background Task resource" }, "OnKey-Job-Id": { "type": "string", "description": "Job id of the job schedule created", "format": "Uuid" }, "OnKey-Job-Schedule-Location": { "type": "string", "description": "URI to fetch the job schedule for the asynchronous execution of the request" } } } }, "securityDefinitions": { "Bearer": { "type": "basic", "description": "Use the JWT access token received by authenticating with your configured On Key Identity Provider" } }, "security": [ { "Bearer": [] } ], "tags": [ { "name": "Consumable" }, { "name": "Meter" }, { "name": "Meter Attribute" }, { "name": "Meter Document" }, { "name": "Meter Reading" }, { "name": "Predicted Meter Reading" }, { "name": "Time Loss Category" }, { "name": "Time Loss Reason" }, { "name": "Time Loss Type" } ], "x-tagGroups": [ { "name": "AOM", "tags": [ "Consumable", "Meter", "Meter Attribute", "Meter Document", "Meter Reading", "Predicted Meter Reading", "Time Loss Category", "Time Loss Reason", "Time Loss Type" ] } ] }